Merge pull request #37 from gocardless/template-changes

Template changes
gocardless · May 30, 2024 · 1326ccb · 1326ccb
2 parents f3b8118 + e2c049f
commit 1326ccb
Show file tree

Hide file tree

Showing 72 changed files with 609 additions and 232 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ toolchain will resolve and fetch the gocardless-pro-go module automatically.
 Alternatively, you can also explicitly `go get` the package into a project:
 
 ```
-go get -u github.com/gocardless/gocardless-pro-go@v3.9.0
+go get -u github.com/gocardless/gocardless-pro-go@v3.10.0
 ```
 
 ## Initializing the client

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-3.9.0
+3.10.0
diff --git a/bank_authorisation_service.go b/bank_authorisation_service.go
@@ -97,7 +97,7 @@ func (s *BankAuthorisationServiceImpl) Create(ctx context.Context, p BankAuthori
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -179,7 +179,7 @@ func (s *BankAuthorisationServiceImpl) Get(ctx context.Context, identity string,
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 
 	for key, value := range o.headers {

diff --git a/bank_details_lookup_service.go b/bank_details_lookup_service.go
@@ -36,17 +36,24 @@ type BankDetailsLookupService interface {
 
 // BankDetailsLookupCreateParams parameters
 type BankDetailsLookupCreateParams struct {
-	AccountNumber string `url:"account_number,omitempty" json:"account_number,omitempty"`
-	BankCode      string `url:"bank_code,omitempty" json:"bank_code,omitempty"`
-	BranchCode    string `url:"branch_code,omitempty" json:"branch_code,omitempty"`
-	CountryCode   string `url:"country_code,omitempty" json:"country_code,omitempty"`
-	Iban          string `url:"iban,omitempty" json:"iban,omitempty"`
+	AccountHolderName string `url:"account_holder_name,omitempty" json:"account_holder_name,omitempty"`
+	AccountNumber     string `url:"account_number,omitempty" json:"account_number,omitempty"`
+	BankCode          string `url:"bank_code,omitempty" json:"bank_code,omitempty"`
+	BranchCode        string `url:"branch_code,omitempty" json:"branch_code,omitempty"`
+	CountryCode       string `url:"country_code,omitempty" json:"country_code,omitempty"`
+	Iban              string `url:"iban,omitempty" json:"iban,omitempty"`
 }
 
 // Create
 // Performs a bank details lookup. As part of the lookup, a modulus check and
 // reachability check are performed.
 //
+// For UK-based bank accounts, where an account holder name is provided (and an
+// account number, a sort code or an iban
+// are already present), we verify that the account holder name and bank account
+// number match the details held by
+// the relevant bank.
+//
 // If your request returns an [error](#api-usage-errors) or the
 // `available_debit_schemes`
 // attribute is an empty array, you will not be able to collect payments from
@@ -106,7 +113,7 @@ func (s *BankDetailsLookupServiceImpl) Create(ctx context.Context, p BankDetails
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)

diff --git a/billing_request_flow_service.go b/billing_request_flow_service.go
@@ -155,7 +155,7 @@ func (s *BillingRequestFlowServiceImpl) Create(ctx context.Context, p BillingReq
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -255,7 +255,7 @@ func (s *BillingRequestFlowServiceImpl) Initialise(ctx context.Context, identity
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)

diff --git a/billing_request_service.go b/billing_request_service.go
@@ -103,13 +103,14 @@ type BillingRequestPaymentRequestLinks struct {
 }
 
 type BillingRequestPaymentRequest struct {
-	Amount      int                                `url:"amount,omitempty" json:"amount,omitempty"`
-	AppFee      int                                `url:"app_fee,omitempty" json:"app_fee,omitempty"`
-	Currency    string                             `url:"currency,omitempty" json:"currency,omitempty"`
-	Description string                             `url:"description,omitempty" json:"description,omitempty"`
-	Links       *BillingRequestPaymentRequestLinks `url:"links,omitempty" json:"links,omitempty"`
-	Metadata    map[string]interface{}             `url:"metadata,omitempty" json:"metadata,omitempty"`
-	Scheme      string                             `url:"scheme,omitempty" json:"scheme,omitempty"`
+	Amount          int                                `url:"amount,omitempty" json:"amount,omitempty"`
+	AppFee          int                                `url:"app_fee,omitempty" json:"app_fee,omitempty"`
+	Currency        string                             `url:"currency,omitempty" json:"currency,omitempty"`
+	Description     string                             `url:"description,omitempty" json:"description,omitempty"`
+	FundsSettlement string                             `url:"funds_settlement,omitempty" json:"funds_settlement,omitempty"`
+	Links           *BillingRequestPaymentRequestLinks `url:"links,omitempty" json:"links,omitempty"`
+	Metadata        map[string]interface{}             `url:"metadata,omitempty" json:"metadata,omitempty"`
+	Scheme          string                             `url:"scheme,omitempty" json:"scheme,omitempty"`
 }
 
 type BillingRequestResourcesCustomer struct {
@@ -227,12 +228,13 @@ type BillingRequestCreateParamsMandateRequest struct {
 }
 
 type BillingRequestCreateParamsPaymentRequest struct {
-	Amount      int                    `url:"amount,omitempty" json:"amount,omitempty"`
-	AppFee      int                    `url:"app_fee,omitempty" json:"app_fee,omitempty"`
-	Currency    string                 `url:"currency,omitempty" json:"currency,omitempty"`
-	Description string                 `url:"description,omitempty" json:"description,omitempty"`
-	Metadata    map[string]interface{} `url:"metadata,omitempty" json:"metadata,omitempty"`
-	Scheme      string                 `url:"scheme,omitempty" json:"scheme,omitempty"`
+	Amount          int                    `url:"amount,omitempty" json:"amount,omitempty"`
+	AppFee          int                    `url:"app_fee,omitempty" json:"app_fee,omitempty"`
+	Currency        string                 `url:"currency,omitempty" json:"currency,omitempty"`
+	Description     string                 `url:"description,omitempty" json:"description,omitempty"`
+	FundsSettlement string                 `url:"funds_settlement,omitempty" json:"funds_settlement,omitempty"`
+	Metadata        map[string]interface{} `url:"metadata,omitempty" json:"metadata,omitempty"`
+	Scheme          string                 `url:"scheme,omitempty" json:"scheme,omitempty"`
 }
 
 // BillingRequestCreateParams parameters
@@ -284,7 +286,7 @@ func (s *BillingRequestServiceImpl) Create(ctx context.Context, p BillingRequest
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -416,7 +418,7 @@ func (s *BillingRequestServiceImpl) CollectCustomerDetails(ctx context.Context,
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -502,6 +504,12 @@ type BillingRequestCollectBankAccountParams struct {
 // Direct Debit. If a bank account is discovered to be closed or invalid, the
 // customer is requested to adjust the account number/routing number and
 // succeed in this check to continue with the flow.
+//
+// _BACS scheme_ [Payer Name
+// Verification](https://hub.gocardless.com/s/article/Introduction-to-Payer-Name-Verification?language=en_GB)
+// is enabled by default for UK based bank accounts, meaning we verify the
+// account holder name and bank account
+// number match the details held by the relevant bank.
 func (s *BillingRequestServiceImpl) CollectBankAccount(ctx context.Context, identity string, p BillingRequestCollectBankAccountParams, opts ...RequestOption) (*BillingRequest, error) {
 	uri, err := url.Parse(fmt.Sprintf(s.config.Endpoint()+"/billing_requests/%v/actions/collect_bank_account",
 		identity))
@@ -541,7 +549,7 @@ func (s *BillingRequestServiceImpl) CollectBankAccount(ctx context.Context, iden
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -643,7 +651,7 @@ func (s *BillingRequestServiceImpl) ConfirmPayerDetails(ctx context.Context, ide
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -743,7 +751,7 @@ func (s *BillingRequestServiceImpl) Fulfil(ctx context.Context, identity string,
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -843,7 +851,7 @@ func (s *BillingRequestServiceImpl) Cancel(ctx context.Context, identity string,
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -956,7 +964,7 @@ func (s *BillingRequestServiceImpl) List(ctx context.Context, p BillingRequestLi
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 
 	for key, value := range o.headers {
@@ -1065,7 +1073,7 @@ func (c *BillingRequestListPagingIterator) Value(ctx context.Context) (*BillingR
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 
 	for key, value := range o.headers {
@@ -1157,7 +1165,7 @@ func (s *BillingRequestServiceImpl) Get(ctx context.Context, identity string, op
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 
 	for key, value := range o.headers {
@@ -1260,7 +1268,7 @@ func (s *BillingRequestServiceImpl) Notify(ctx context.Context, identity string,
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -1359,7 +1367,7 @@ func (s *BillingRequestServiceImpl) Fallback(ctx context.Context, identity strin
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -1465,7 +1473,7 @@ func (s *BillingRequestServiceImpl) ChooseCurrency(ctx context.Context, identity
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -1565,7 +1573,7 @@ func (s *BillingRequestServiceImpl) SelectInstitution(ctx context.Context, ident
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)

diff --git a/billing_request_template_service.go b/billing_request_template_service.go
@@ -109,7 +109,7 @@ func (s *BillingRequestTemplateServiceImpl) List(ctx context.Context, p BillingR
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 
 	for key, value := range o.headers {
@@ -218,7 +218,7 @@ func (c *BillingRequestTemplateListPagingIterator) Value(ctx context.Context) (*
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 
 	for key, value := range o.headers {
@@ -310,7 +310,7 @@ func (s *BillingRequestTemplateServiceImpl) Get(ctx context.Context, identity st
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 
 	for key, value := range o.headers {
@@ -422,7 +422,7 @@ func (s *BillingRequestTemplateServiceImpl) Create(ctx context.Context, p Billin
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)
@@ -534,7 +534,7 @@ func (s *BillingRequestTemplateServiceImpl) Update(ctx context.Context, identity
 	req.Header.Set("Authorization", "Bearer "+s.config.Token())
 	req.Header.Set("GoCardless-Version", "2015-07-06")
 	req.Header.Set("GoCardless-Client-Library", "gocardless-pro-go")
-	req.Header.Set("GoCardless-Client-Version", "3.9.0")
+	req.Header.Set("GoCardless-Client-Version", "3.10.0")
 	req.Header.Set("User-Agent", userAgent)
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Idempotency-Key", o.idempotencyKey)