diff --git a/lib/Resources/Balance.php b/lib/Resources/Balance.php index 4233ba10..d24d446a 100644 --- a/lib/Resources/Balance.php +++ b/lib/Resources/Balance.php @@ -23,42 +23,42 @@ class Balance extends BaseResource protected $model_name = "Balance"; /** - * The total amount in the balance, defined as the sum of all debits - * subtracted from the sum of all credits, - * in the lowest denomination for the currency (e.g. pence in GBP, cents in - * EUR). + * The total amount in the balance, defined as the sum of all debits + * subtracted from the sum of all credits, + * in the lowest denomination for the currency (e.g. pence in GBP, cents in + * EUR). */ protected $amount; /** - * Type of the balance. Could be one of - * + * Type of the balance. Could be one of + * */ protected $balance_type; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and - * "USD" are supported. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" + * are supported. */ protected $currency; /** - * Dynamic [timestamp](#api-usage-dates-and-times) recording when this - * resource was last updated. + * Dynamic [timestamp](#api-usage-dates-and-times) recording when this + * resource was last updated. */ protected $last_updated_at; diff --git a/lib/Resources/BankAccountDetail.php b/lib/Resources/BankAccountDetail.php index afcb9f31..e881dd4f 100644 --- a/lib/Resources/BankAccountDetail.php +++ b/lib/Resources/BankAccountDetail.php @@ -23,36 +23,35 @@ class BankAccountDetail extends BaseResource protected $model_name = "BankAccountDetail"; /** - * Base64 URL encoded encrypted payload, in this case bank details. + * Base64 URL encoded encrypted payload, in this case bank details. */ protected $ciphertext; /** - * Base64 URL encoded symmetric content encryption key, encrypted with the - * asymmetric key from your JWKS. + * Base64 URL encoded symmetric content encryption key, encrypted with the + * asymmetric key from your JWKS. */ protected $encrypted_key; /** - * Base64 URL encoded initialization vector, used during content - * encryption. + * Base64 URL encoded initialization vector, used during content encryption. */ protected $iv; /** - * Base64 URL encoded JWE header values, containing the following keys: + * Base64 URL encoded JWE header values, containing the following keys: * - * - `alg`: the asymmetric encryption type used to encrypt symmetric key, - * e.g: `RSA-OAEP`. - * - `enc`: the content encryption type, e.g: `A256GCM`. - * - `kid`: the ID of an RSA-2048 public key, from your JWKS, used to - * encrypt the AES key. + * - `alg`: the asymmetric encryption type used to encrypt symmetric key, + * e.g: `RSA-OAEP`. + * - `enc`: the content encryption type, e.g: `A256GCM`. + * - `kid`: the ID of an RSA-2048 public key, from your JWKS, used to + * encrypt the AES key. */ protected $protected; /** - * Base64 URL encoded authentication tag, used to verify payload integrity - * during decryption. + * Base64 URL encoded authentication tag, used to verify payload integrity + * during decryption. */ protected $tag; } diff --git a/lib/Resources/BankAccountHolderVerification.php b/lib/Resources/BankAccountHolderVerification.php index cf8541a8..b2322264 100644 --- a/lib/Resources/BankAccountHolderVerification.php +++ b/lib/Resources/BankAccountHolderVerification.php @@ -23,48 +23,48 @@ class BankAccountHolderVerification extends BaseResource protected $model_name = "BankAccountHolderVerification"; /** - * The actual account name returned by the recipient's bank, populated only - * in the case of a partial match. + * The actual account name returned by the recipient's bank, populated only + * in the case of a partial match. */ protected $actual_account_name; /** - * The unique identifier for the bank account holder verification resource, - * e.g. "BAHV123". + * The unique identifier for the bank account holder verification resource, + * e.g. "BAHV123". */ protected $id; /** - * Result of the verification, could be one of - * + * Result of the verification, could be one of + * */ protected $result; /** - * The status of the bank account holder verification. - * + * The status of the bank account holder verification. + * * */ protected $status; /** - * Type of the verification that has been performed - * eg. [Confirmation of - * Payee](https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/) + * Type of the verification that has been performed + * eg. [Confirmation of + * Payee](https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/) */ protected $type; } diff --git a/lib/Resources/BankAuthorisation.php b/lib/Resources/BankAuthorisation.php index 5f6dbdb9..dcb91a7a 100644 --- a/lib/Resources/BankAuthorisation.php +++ b/lib/Resources/BankAuthorisation.php @@ -28,35 +28,35 @@ class BankAuthorisation extends BaseResource protected $model_name = "BankAuthorisation"; /** - * Type of authorisation, can be either 'mandate' or 'payment'. + * Type of authorisation, can be either 'mandate' or 'payment'. */ protected $authorisation_type; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when the user - * has been authorised. + * Fixed [timestamp](#api-usage-dates-and-times), recording when the user + * has been authorised. */ protected $authorised_at; /** - * Timestamp when the flow was created + * Timestamp when the flow was created */ protected $created_at; /** - * Timestamp when the url will expire. Each authorisation url currently - * lasts for 15 minutes, but this can vary by bank. + * Timestamp when the url will expire. Each authorisation url currently + * lasts for 15 minutes, but this can vary by bank. */ protected $expires_at; /** - * Unique identifier, beginning with "BAU". + * Unique identifier, beginning with "BAU". */ protected $id; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when the - * authorisation URL has been visited. + * Fixed [timestamp](#api-usage-dates-and-times), recording when the + * authorisation URL has been visited. */ protected $last_visited_at; @@ -66,41 +66,41 @@ class BankAuthorisation extends BaseResource protected $links; /** - * URL to a QR code PNG image of the bank authorisation url. - * This QR code can be used as an alternative to providing the `url` to the - * payer to allow them to authorise with their mobile devices. + * URL to a QR code PNG image of the bank authorisation url. + * This QR code can be used as an alternative to providing the `url` to the + * payer to allow them to authorise with their mobile devices. */ protected $qr_code_url; /** - * URL that the payer can be redirected to after authorising the payment. + * URL that the payer can be redirected to after authorising the payment. * - * On completion of bank authorisation, the query parameter of either - * `outcome=success` or `outcome=failure` will be - * appended to the `redirect_uri` to indicate the result of the bank - * authorisation. If the bank authorisation is - * expired, the query parameter `outcome=timeout` will be appended to the - * `redirect_uri`, in which case you should - * prompt the user to try the bank authorisation step again. + * On completion of bank authorisation, the query parameter of either + * `outcome=success` or `outcome=failure` will be + * appended to the `redirect_uri` to indicate the result of the bank + * authorisation. If the bank authorisation is + * expired, the query parameter `outcome=timeout` will be appended to the + * `redirect_uri`, in which case you should + * prompt the user to try the bank authorisation step again. * - * Please note: bank authorisations can still fail despite an - * `outcome=success` on the `redirect_uri`. It is therefore recommended to - * wait for the relevant bank authorisation event, such as - * [`BANK_AUTHORISATION_AUTHORISED`](#billing-request-bankauthorisationauthorised), - * [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied), - * or - * [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed) - * in order to show the correct outcome to the user. + * Please note: bank authorisations can still fail despite an + * `outcome=success` on the `redirect_uri`. It is therefore recommended to + * wait for the relevant bank authorisation event, such as + * [`BANK_AUTHORISATION_AUTHORISED`](#billing-request-bankauthorisationauthorised), + * [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied), + * or + * [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed) + * in order to show the correct outcome to the user. * - * The BillingRequestFlow ID will also be appended to the `redirect_uri` as - * query parameter `id=BRF123`. + * The BillingRequestFlow ID will also be appended to the `redirect_uri` as + * query parameter `id=BRF123`. * - * Defaults to `https://pay.gocardless.com/billing/static/thankyou`. + * Defaults to `https://pay.gocardless.com/billing/static/thankyou`. */ protected $redirect_uri; /** - * URL for an oauth flow that will allow the user to authorise the payment + * URL for an oauth flow that will allow the user to authorise the payment */ protected $url; } diff --git a/lib/Resources/BankDetailsLookup.php b/lib/Resources/BankDetailsLookup.php index 7ec5d5a5..e047c578 100644 --- a/lib/Resources/BankDetailsLookup.php +++ b/lib/Resources/BankDetailsLookup.php @@ -21,23 +21,23 @@ class BankDetailsLookup extends BaseResource protected $model_name = "BankDetailsLookup"; /** - * Array of [schemes](#mandates_scheme) supported for this bank account. - * This will be an empty array if the bank account is not reachable by any - * schemes. + * Array of [schemes](#mandates_scheme) supported for this bank account. + * This will be an empty array if the bank account is not reachable by any + * schemes. */ protected $available_debit_schemes; /** - * The name of the bank with which the account is held (if available). + * The name of the bank with which the account is held (if available). */ protected $bank_name; /** - * ISO 9362 SWIFT BIC of the bank with which the account is held. + * ISO 9362 SWIFT BIC of the bank with which the account is held. * - *

Even if no BIC is returned for an account, GoCardless - * may still be able to collect payments from it - you should refer to the - * `available_debit_schemes` attribute to determine reachability.

+ *

Even if no BIC is returned for an account, GoCardless + * may still be able to collect payments from it - you should refer to the + * `available_debit_schemes` attribute to determine reachability.

*/ protected $bic; } diff --git a/lib/Resources/BillingRequest.php b/lib/Resources/BillingRequest.php index 9f96b918..e501b534 100644 --- a/lib/Resources/BillingRequest.php +++ b/lib/Resources/BillingRequest.php @@ -34,42 +34,42 @@ class BillingRequest extends BaseResource protected $model_name = "BillingRequest"; /** - * List of actions that can be performed before this billing request can be - * fulfilled. + * List of actions that can be performed before this billing request can be + * fulfilled. */ protected $actions; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * (Optional) If true, this billing request can fallback from instant - * payment to direct debit. - * Should not be set if GoCardless payment intelligence feature is used. + * (Optional) If true, this billing request can fallback from instant + * payment to direct debit. + * Should not be set if GoCardless payment intelligence feature is used. * - * See [Billing Requests: Retain customers with - * Fallbacks](https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/) - * for more information. + * See [Billing Requests: Retain customers with + * Fallbacks](https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/) + * for more information. */ protected $fallback_enabled; /** - * True if the billing request was completed with direct debit. + * True if the billing request was completed with direct debit. */ protected $fallback_occurred; /** - * Unique identifier, beginning with "BRQ". + * Unique identifier, beginning with "BRQ". */ protected $id; /** - * Request for an instalment schedule. Has to contain either - * `instalments_with_schedule` object or an array of - * `instalments_with_dates` objects + * Request for an instalment schedule. Has to contain either + * `instalments_with_schedule` object or an array of + * `instalments_with_dates` objects */ protected $instalment_schedule_request; @@ -79,47 +79,47 @@ class BillingRequest extends BaseResource protected $links; /** - * Request for a mandate + * Request for a mandate */ protected $mandate_request; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. */ protected $metadata; /** - * Specifies the context or scenario in which the payment is being made. - * Defines whether the payment is for advance/arrears billing, point of - * sale transactions, ecommerce, or account transfers. This helps banks and - * payment processors understand the payment scenario and apply appropriate - * processing rules and risk controls. + * Specifies the context or scenario in which the payment is being made. + * Defines whether the payment is for advance/arrears billing, point of sale + * transactions, ecommerce, or account transfers. This helps banks and + * payment processors understand the payment scenario and apply appropriate + * processing rules and risk controls. */ protected $payment_context_code; /** - * Specifies the underlying purpose of the payment. Defines the specific - * reason or type of service/goods the payment relates to, improving - * straight-through processing and compliance. - * See [VRP Commercial Payment Purpose - * Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) - * for the complete list of valid codes. + * Specifies the underlying purpose of the payment. Defines the specific + * reason or type of service/goods the payment relates to, improving + * straight-through processing and compliance. + * See [VRP Commercial Payment Purpose + * Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) + * for the complete list of valid codes. */ protected $payment_purpose_code; /** - * Request for a one-off strongly authorised payment + * Request for a one-off strongly authorised payment */ protected $payment_request; /** - * Specifies the high-level purpose/category of a mandate and/or payment - * using a set of pre-defined categories. Provides context on the nature - * and reason for the payment to facilitate processing and compliance. - * See [Billing Request Purpose - * Codes](https://developer.gocardless.com/billing-request-purpose-codes/) - * for the complete list of valid codes. + * Specifies the high-level purpose/category of a mandate and/or payment + * using a set of pre-defined categories. Provides context on the nature and + * reason for the payment to facilitate processing and compliance. + * See [Billing Request Purpose + * Codes](https://developer.gocardless.com/billing-request-purpose-codes/) + * for the complete list of valid codes. */ protected $purpose_code; @@ -129,22 +129,22 @@ class BillingRequest extends BaseResource protected $resources; /** - * One of: - * + * One of: + * */ protected $status; /** - * Request for a subscription + * Request for a subscription */ protected $subscription_request; } diff --git a/lib/Resources/BillingRequestFlow.php b/lib/Resources/BillingRequestFlow.php index 796f533d..8d3d13e1 100644 --- a/lib/Resources/BillingRequestFlow.php +++ b/lib/Resources/BillingRequestFlow.php @@ -37,49 +37,49 @@ class BillingRequestFlow extends BaseResource protected $model_name = "BillingRequestFlow"; /** - * URL for a GC-controlled flow which will allow the payer to fulfil the - * billing request + * URL for a GC-controlled flow which will allow the payer to fulfil the + * billing request */ protected $authorisation_url; /** - * (Experimental feature) Fulfil the Billing Request on completion of the - * flow (true by default). Disabling the auto_fulfil is not allowed - * currently. + * (Experimental feature) Fulfil the Billing Request on completion of the + * flow (true by default). Disabling the auto_fulfil is not allowed + * currently. */ protected $auto_fulfil; /** - * Timestamp when the flow was created + * Timestamp when the flow was created */ protected $created_at; /** - * Identifies whether a Billing Request belongs to a specific customer + * Identifies whether a Billing Request belongs to a specific customer */ protected $customer_details_captured; /** - * URL that the payer can be taken to if there isn't a way to progress - * ahead in flow, for example if the customer searches for a bank that - * doesn't exist or isn't supported on the scheme. + * URL that the payer can be taken to if there isn't a way to progress ahead + * in flow, for example if the customer searches for a bank that doesn't + * exist or isn't supported on the scheme. */ protected $exit_uri; /** - * Timestamp when the flow will expire. Each flow currently lasts for 7 - * days. + * Timestamp when the flow will expire. Each flow currently lasts for 7 + * days. */ protected $expires_at; /** - * Unique identifier, beginning with "BRF". + * Unique identifier, beginning with "BRF". */ protected $id; /** - * Sets the default language of the Billing Request Flow and the customer. - * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + * Sets the default language of the Billing Request Flow and the customer. + * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. */ protected $language; @@ -89,85 +89,85 @@ class BillingRequestFlow extends BaseResource protected $links; /** - * If true, the payer will not be able to change their bank account within - * the flow. If the bank_account details are collected as part of - * bank_authorisation then GC will set this value to true mid flow. + * If true, the payer will not be able to change their bank account within + * the flow. If the bank_account details are collected as part of + * bank_authorisation then GC will set this value to true mid flow. * - * You can only lock bank account if these have already been completed as a - * part of the billing request. + * You can only lock bank account if these have already been completed as a + * part of the billing request. * */ protected $lock_bank_account; /** - * If true, the payer will not be able to change their currency/scheme - * manually within the flow. Note that this only applies to the mandate - * only flows - currency/scheme can never be changed when there is a - * specified subscription or payment. + * If true, the payer will not be able to change their currency/scheme + * manually within the flow. Note that this only applies to the mandate only + * flows - currency/scheme can never be changed when there is a specified + * subscription or payment. */ protected $lock_currency; /** - * If true, the payer will not be able to edit their customer details - * within the flow. If the customer details are collected as part of - * bank_authorisation then GC will set this value to true mid flow. + * If true, the payer will not be able to edit their customer details within + * the flow. If the customer details are collected as part of + * bank_authorisation then GC will set this value to true mid flow. * - * You can only lock customer details if these have already been completed - * as a part of the billing request. + * You can only lock customer details if these have already been completed + * as a part of the billing request. * */ protected $lock_customer_details; /** - * Bank account information used to prefill the payment page so your - * customer doesn't have to re-type details you already hold about them. It - * will be stored unvalidated and the customer will be able to review and - * amend it before completing the form. + * Bank account information used to prefill the payment page so your + * customer doesn't have to re-type details you already hold about them. It + * will be stored unvalidated and the customer will be able to review and + * amend it before completing the form. */ protected $prefilled_bank_account; /** - * Customer information used to prefill the payment page so your customer - * doesn't have to re-type details you already hold about them. It will be - * stored unvalidated and the customer will be able to review and amend it - * before completing the form. + * Customer information used to prefill the payment page so your customer + * doesn't have to re-type details you already hold about them. It will be + * stored unvalidated and the customer will be able to review and amend it + * before completing the form. */ protected $prefilled_customer; /** - * URL that the payer can be redirected to after completing the request - * flow. + * URL that the payer can be redirected to after completing the request + * flow. */ protected $redirect_uri; /** - * Session token populated when responding to the initialise action + * Session token populated when responding to the initialise action */ protected $session_token; /** - * If true, the payer will be able to see redirect action buttons on Thank - * You page. These action buttons will provide a way to connect back to the - * billing request flow app if opened within a mobile app. For successful - * flow, the button will take the payer back the billing request flow where - * they will see the success screen. For failure, button will take the - * payer to url being provided against exit_uri field. + * If true, the payer will be able to see redirect action buttons on Thank + * You page. These action buttons will provide a way to connect back to the + * billing request flow app if opened within a mobile app. For successful + * flow, the button will take the payer back the billing request flow where + * they will see the success screen. For failure, button will take the payer + * to url being provided against exit_uri field. */ protected $show_redirect_buttons; /** - * If true, the payer will be able to see a redirect action button on the - * Success page. This action button will provide a way to redirect the - * payer to the given redirect_uri. This functionality is helpful when - * merchants do not want payers to be automatically redirected or on - * Android devices, where automatic redirections are not possible. + * If true, the payer will be able to see a redirect action button on the + * Success page. This action button will provide a way to redirect the payer + * to the given redirect_uri. This functionality is helpful when merchants + * do not want payers to be automatically redirected or on Android devices, + * where automatic redirections are not possible. */ protected $show_success_redirect_button; /** - * If true, the payer will not be redirected to the success screen after - * completing the flow. A redirect_uri needs to be provided for this - * parameter to be taken into account. + * If true, the payer will not be redirected to the success screen after + * completing the flow. A redirect_uri needs to be provided for this + * parameter to be taken into account. */ protected $skip_success_screen; } diff --git a/lib/Resources/BillingRequestTemplate.php b/lib/Resources/BillingRequestTemplate.php index 503e8870..720d173a 100644 --- a/lib/Resources/BillingRequestTemplate.php +++ b/lib/Resources/BillingRequestTemplate.php @@ -36,145 +36,143 @@ class BillingRequestTemplate extends BaseResource protected $model_name = "BillingRequestTemplate"; /** - * Permanent URL that customers can visit to allow them to complete a flow - * based on this template, before being returned to the `redirect_uri`. + * Permanent URL that customers can visit to allow them to complete a flow + * based on this template, before being returned to the `redirect_uri`. */ protected $authorisation_url; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * Unique identifier, beginning with "BRT". + * Unique identifier, beginning with "BRT". */ protected $id; /** - * Constraints that will apply to the mandate_request. (Optional) - * Specifically required for PayTo and VRP. + * Constraints that will apply to the mandate_request. (Optional) + * Specifically required for PayTo and VRP. */ protected $mandate_request_constraints; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. */ protected $mandate_request_currency; /** - * A human-readable description of the payment and/or mandate. This will be - * displayed to the payer when authorising the billing request. + * A human-readable description of the payment and/or mandate. This will be + * displayed to the payer when authorising the billing request. * */ protected $mandate_request_description; /** - * Key-value store of custom data that will be applied to the mandate - * created when this request is fulfilled. Up to 3 keys are permitted, with - * key names up to 50 characters and values up to 500 characters. + * Key-value store of custom data that will be applied to the mandate + * created when this request is fulfilled. Up to 3 keys are permitted, with + * key names up to 50 characters and values up to 500 characters. */ protected $mandate_request_metadata; /** - * A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", - * "becs_nz", "betalingsservice", "faster_payments", "pad", "pay_to" and - * "sepa_core" are supported. Optional for mandate only requests - if left - * blank, the payer will be able to select the currency/scheme to pay with - * from a list of your available schemes. + * A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", + * "becs_nz", "betalingsservice", "faster_payments", "pad", "pay_to" and + * "sepa_core" are supported. Optional for mandate only requests - if left + * blank, the payer will be able to select the currency/scheme to pay with + * from a list of your available schemes. */ protected $mandate_request_scheme; /** - * Verification preference for the mandate. One of: - * + * Verification preference for the mandate. One of: + * * - * By default, all Billing Requests use the `recommended` verification - * preference. It uses GoCardless payment intelligence solution to - * determine if a payer is fraudulent or not. The verification mechanism is - * based on the response and the payer may be asked to verify themselves. - * If the feature is not available, `recommended` behaves like `minimum`. + * By default, all Billing Requests use the `recommended` verification + * preference. It uses GoCardless payment intelligence solution to determine + * if a payer is fraudulent or not. The verification mechanism is based on + * the response and the payer may be asked to verify themselves. If the + * feature is not available, `recommended` behaves like `minimum`. * - * If you never wish to take advantage of our reduced risk products and - * Verified Mandates as they are released in new schemes, please use the - * `minimum` verification preference. + * If you never wish to take advantage of our reduced risk products and + * Verified Mandates as they are released in new schemes, please use the + * `minimum` verification preference. * - * See [Billing Requests: Creating Verified - * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) - * for more information. + * See [Billing Requests: Creating Verified + * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) + * for more information. */ protected $mandate_request_verify; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. */ protected $metadata; /** - * Name for the template. Provides a friendly human name for the template, - * as it is shown in the dashboard. Must not exceed 255 characters. + * Name for the template. Provides a friendly human name for the template, + * as it is shown in the dashboard. Must not exceed 255 characters. */ protected $name; /** - * Amount in full. + * Amount in full. */ protected $payment_request_amount; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and - * for `EUR` with your customers in supported Eurozone countries only. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and + * for `EUR` with your customers in supported Eurozone countries only. */ protected $payment_request_currency; /** - * A human-readable description of the payment and/or mandate. This will be - * displayed to the payer when authorising the billing request. + * A human-readable description of the payment and/or mandate. This will be + * displayed to the payer when authorising the billing request. * */ protected $payment_request_description; /** - * Key-value store of custom data that will be applied to the payment - * created when this request is fulfilled. Up to 3 keys are permitted, with - * key names up to 50 characters and values up to 500 characters. + * Key-value store of custom data that will be applied to the payment + * created when this request is fulfilled. Up to 3 keys are permitted, with + * key names up to 50 characters and values up to 500 characters. */ protected $payment_request_metadata; /** - * (Optional) A scheme used for Open Banking payments. Currently - * `faster_payments` is supported in the UK (GBP) and - * `sepa_credit_transfer` and `sepa_instant_credit_transfer` are supported - * in supported Eurozone countries (EUR). For Eurozone countries, - * `sepa_credit_transfer` is used as the default. Please be aware that - * `sepa_instant_credit_transfer` may incur an additional fee for your - * customer. + * (Optional) A scheme used for Open Banking payments. Currently + * `faster_payments` is supported in the UK (GBP) and `sepa_credit_transfer` + * and `sepa_instant_credit_transfer` are supported in supported Eurozone + * countries (EUR). For Eurozone countries, `sepa_credit_transfer` is used + * as the default. Please be aware that `sepa_instant_credit_transfer` may + * incur an additional fee for your customer. */ protected $payment_request_scheme; /** - * URL that the payer can be redirected to after completing the request - * flow. + * URL that the payer can be redirected to after completing the request + * flow. */ protected $redirect_uri; /** - * Dynamic [timestamp](#api-usage-dates-and-times) recording when this - * resource was last updated. + * Dynamic [timestamp](#api-usage-dates-and-times) recording when this + * resource was last updated. */ protected $updated_at; } diff --git a/lib/Resources/BillingRequestWithAction.php b/lib/Resources/BillingRequestWithAction.php index 71d35853..8ddf7fe1 100644 --- a/lib/Resources/BillingRequestWithAction.php +++ b/lib/Resources/BillingRequestWithAction.php @@ -20,32 +20,31 @@ class BillingRequestWithAction extends BaseResource protected $model_name = "BillingRequestWithAction"; /** - * Bank Authorisations can be used to authorise Billing Requests. - * Authorisations - * are created against a specific bank, usually the bank that provides the - * payer's - * account. + * Bank Authorisations can be used to authorise Billing Requests. + * Authorisations + * are created against a specific bank, usually the bank that provides the + * payer's + * account. * - * Creation of Bank Authorisations is only permitted from GoCardless hosted - * UIs - * (see Billing Request Flows) to ensure we meet regulatory requirements - * for - * checkout flows. + * Creation of Bank Authorisations is only permitted from GoCardless hosted + * UIs + * (see Billing Request Flows) to ensure we meet regulatory requirements for + * checkout flows. */ protected $bank_authorisations; /** - * Billing Requests help create resources that require input or action - * from a customer. An example of required input might be additional - * customer billing details, while an action would be asking a customer to - * authorise a payment using their mobile banking app. + * Billing Requests help create resources that require input or action from + * a customer. An example of required input might be additional customer + * billing details, while an action would be asking a customer to authorise + * a payment using their mobile banking app. * - * See [Billing Requests: - * Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/) - * for how-to's, explanations and tutorials.

Important: All properties associated - * with `subscription_request` and `instalment_schedule_request` are only - * supported for ACH and PAD schemes.

+ * See [Billing Requests: + * Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/) + * for how-to's, explanations and tutorials.

Important: All properties associated with + * `subscription_request` and `instalment_schedule_request` are only + * supported for ACH and PAD schemes.

*/ protected $billing_requests; } diff --git a/lib/Resources/Block.php b/lib/Resources/Block.php index fbd41eec..c91b5eac 100644 --- a/lib/Resources/Block.php +++ b/lib/Resources/Block.php @@ -26,68 +26,68 @@ class Block extends BaseResource protected $model_name = "Block"; /** - * Shows if the block is active or disabled. Only active blocks will be - * used when deciding - * if a mandate should be blocked. + * Shows if the block is active or disabled. Only active blocks will be used + * when deciding + * if a mandate should be blocked. */ protected $active; /** - * Type of entity we will seek to match against when blocking the mandate. - * This - * can currently be one of 'email', 'email_domain', 'bank_account', or - * 'bank_name'. + * Type of entity we will seek to match against when blocking the mandate. + * This + * can currently be one of 'email', 'email_domain', 'bank_account', or + * 'bank_name'. */ protected $block_type; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * Unique identifier, beginning with "BLC". + * Unique identifier, beginning with "BLC". */ protected $id; /** - * This field is required if the reason_type is other. It should be a - * description of - * the reason for why you wish to block this payer and why it does not - * align with the - * given reason_types. This is intended to help us improve our knowledge of - * types of - * fraud. + * This field is required if the reason_type is other. It should be a + * description of + * the reason for why you wish to block this payer and why it does not align + * with the + * given reason_types. This is intended to help us improve our knowledge of + * types of + * fraud. */ protected $reason_description; /** - * The reason you wish to block this payer, can currently be one of - * 'identity_fraud', - * 'no_intent_to_pay', 'unfair_chargeback'. If the reason isn't captured by - * one of the - * above then 'other' can be selected but you must provide a reason - * description. + * The reason you wish to block this payer, can currently be one of + * 'identity_fraud', + * 'no_intent_to_pay', 'unfair_chargeback'. If the reason isn't captured by + * one of the + * above then 'other' can be selected but you must provide a reason + * description. */ protected $reason_type; /** - * This field is a reference to the value you wish to block. This may be - * the raw value - * (in the case of emails or email domains) or the ID of the resource (in - * the case of - * bank accounts and bank names). This means in order to block a specific - * bank account - * (even if you wish to block generically by name) it must already have - * been created as - * a resource. + * This field is a reference to the value you wish to block. This may be the + * raw value + * (in the case of emails or email domains) or the ID of the resource (in + * the case of + * bank accounts and bank names). This means in order to block a specific + * bank account + * (even if you wish to block generically by name) it must already have been + * created as + * a resource. */ protected $resource_reference; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was updated. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was updated. */ protected $updated_at; } diff --git a/lib/Resources/Creditor.php b/lib/Resources/Creditor.php index 6cdb752a..0c9fb1d4 100644 --- a/lib/Resources/Creditor.php +++ b/lib/Resources/Creditor.php @@ -39,78 +39,78 @@ class Creditor extends BaseResource protected $model_name = "Creditor"; /** - * The first line of the creditor's address. + * The first line of the creditor's address. */ protected $address_line1; /** - * The second line of the creditor's address. + * The second line of the creditor's address. */ protected $address_line2; /** - * The third line of the creditor's address. + * The third line of the creditor's address. */ protected $address_line3; /** - * Prefix for the bank reference of payouts sent to this creditor. For - * instance, if - * the creditor's `bank_reference_prefix` was `ACME`, the bank reference of - * a payout - * sent to that creditor could be `ACME-8G7Q8`. + * Prefix for the bank reference of payouts sent to this creditor. For + * instance, if + * the creditor's `bank_reference_prefix` was `ACME`, the bank reference of + * a payout + * sent to that creditor could be `ACME-8G7Q8`. * - * This prefix is also used for refunds in EUR and GBP. + * This prefix is also used for refunds in EUR and GBP. * */ protected $bank_reference_prefix; /** - * Boolean indicating whether the creditor is permitted to create refunds. + * Boolean indicating whether the creditor is permitted to create refunds. */ protected $can_create_refunds; /** - * The city of the creditor's address. + * The city of the creditor's address. */ protected $city; /** - * [ISO 3166-1 alpha-2 - * code.](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + * [ISO 3166-1 alpha-2 + * code.](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) */ protected $country_code; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * The type of business of the creditor. Currently, `individual`, - * `company`, `charity`, `partnership`, and `trust` are supported. + * The type of business of the creditor. Currently, `individual`, `company`, + * `charity`, `partnership`, and `trust` are supported. */ protected $creditor_type; /** - * Boolean value indicating whether creditor has the [Custom Payment - * Pages](https://hub.gocardless.com/s/article/Custom-payment-pages) - * functionality enabled. + * Boolean value indicating whether creditor has the [Custom Payment + * Pages](https://hub.gocardless.com/s/article/Custom-payment-pages) + * functionality enabled. */ protected $custom_payment_pages_enabled; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for - * the currency in which amounts will be paid out (after foreign exchange). - * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are - * supported. Present only if payouts will be (or were) made via foreign - * exchange. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for + * the currency in which amounts will be paid out (after foreign exchange). + * Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + * supported. Present only if payouts will be (or were) made via foreign + * exchange. */ protected $fx_payout_currency; /** - * Unique identifier, beginning with "CR". + * Unique identifier, beginning with "CR". */ protected $id; @@ -120,71 +120,71 @@ class Creditor extends BaseResource protected $links; /** - * URL for the creditor's logo, which may be shown on their payment pages. + * URL for the creditor's logo, which may be shown on their payment pages. */ protected $logo_url; /** - * Boolean value indicating whether creditor has the [Mandate - * Imports](#core-endpoints-mandate-imports) functionality enabled. + * Boolean value indicating whether creditor has the [Mandate + * Imports](#core-endpoints-mandate-imports) functionality enabled. */ protected $mandate_imports_enabled; /** - * Boolean value indicating whether the organisation is responsible for - * sending all customer notifications (note this is separate from the - * functionality described - * [here](/getting-started/api/handling-customer-notifications/)). If you - * are a partner app, and this value is true, you should not send - * notifications on behalf of this organisation. + * Boolean value indicating whether the organisation is responsible for + * sending all customer notifications (note this is separate from the + * functionality described + * [here](/getting-started/api/handling-customer-notifications/)). If you + * are a partner app, and this value is true, you should not send + * notifications on behalf of this organisation. */ protected $merchant_responsible_for_notifications; /** - * The creditor's trading name. + * The creditor's trading name. */ protected $name; /** - * The creditor's postal code. + * The creditor's postal code. */ protected $postal_code; /** - * The creditor's address region, county or department. + * The creditor's address region, county or department. */ protected $region; /** - * An array of the scheme identifiers this creditor can create mandates - * against. + * An array of the scheme identifiers this creditor can create mandates + * against. * - * The support address, `phone_number` and `email` fields are for customers - * to contact the merchant for support purposes. They must be displayed on - * the payment page, please see our [compliance - * requirements](#appendix-compliance-requirements) for more details. + * The support address, `phone_number` and `email` fields are for customers + * to contact the merchant for support purposes. They must be displayed on + * the payment page, please see our [compliance + * requirements](#appendix-compliance-requirements) for more details. */ protected $scheme_identifiers; /** - * The creditor's verification status, indicating whether they can yet - * receive payouts. For more details on handling verification as a partner, - * see our ["Helping your users get verified" - * guide](/getting-started/partners/helping-your-users-get-verified/). One - * of: - * + * The creditor's verification status, indicating whether they can yet + * receive payouts. For more details on handling verification as a partner, + * see our ["Helping your users get verified" + * guide](/getting-started/partners/helping-your-users-get-verified/). One + * of: + * */ protected $verification_status; } diff --git a/lib/Resources/CreditorBankAccount.php b/lib/Resources/CreditorBankAccount.php index 5377da73..37572186 100644 --- a/lib/Resources/CreditorBankAccount.php +++ b/lib/Resources/CreditorBankAccount.php @@ -30,59 +30,59 @@ class CreditorBankAccount extends BaseResource protected $model_name = "CreditorBankAccount"; /** - * Name of the account holder, as known by the bank. Usually this is the - * same as the name stored with the linked - * [creditor](#core-endpoints-creditors). This field will be - * transliterated, upcased and truncated to 18 characters. + * Name of the account holder, as known by the bank. Usually this is the + * same as the name stored with the linked + * [creditor](#core-endpoints-creditors). This field will be transliterated, + * upcased and truncated to 18 characters. */ protected $account_holder_name; /** - * The last few digits of the account number. Currently 4 digits for NZD - * bank accounts and 2 digits for other currencies. + * The last few digits of the account number. Currently 4 digits for NZD + * bank accounts and 2 digits for other currencies. */ protected $account_number_ending; /** - * Bank account type. Required for USD-denominated bank accounts. Must not - * be provided for bank accounts in other currencies. See [local - * details](#local-bank-details-united-states) for more information. + * Bank account type. Required for USD-denominated bank accounts. Must not + * be provided for bank accounts in other currencies. See [local + * details](#local-bank-details-united-states) for more information. */ protected $account_type; /** - * Name of bank, taken from the bank details. + * Name of bank, taken from the bank details. */ protected $bank_name; /** - * [ISO 3166-1 alpha-2 - * code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). - * Defaults to the country code of the `iban` if supplied, otherwise is - * required. + * [ISO 3166-1 alpha-2 + * code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + * Defaults to the country code of the `iban` if supplied, otherwise is + * required. */ protected $country_code; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and - * "USD" are supported. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" + * are supported. */ protected $currency; /** - * Boolean value showing whether the bank account is enabled or disabled. + * Boolean value showing whether the bank account is enabled or disabled. */ protected $enabled; /** - * Unique identifier, beginning with "BA". + * Unique identifier, beginning with "BA". */ protected $id; @@ -92,14 +92,14 @@ class CreditorBankAccount extends BaseResource protected $links; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. */ protected $metadata; /** - * Verification status of the Bank Account. Can be one of `pending`, - * `in_review` or `successful` + * Verification status of the Bank Account. Can be one of `pending`, + * `in_review` or `successful` */ protected $verification_status; } diff --git a/lib/Resources/CurrencyExchangeRate.php b/lib/Resources/CurrencyExchangeRate.php index 57807836..73b777eb 100644 --- a/lib/Resources/CurrencyExchangeRate.php +++ b/lib/Resources/CurrencyExchangeRate.php @@ -22,23 +22,23 @@ class CurrencyExchangeRate extends BaseResource protected $model_name = "CurrencyExchangeRate"; /** - * The exchange rate from the source to target currencies provided with up - * to 10 decimal places. + * The exchange rate from the source to target currencies provided with up + * to 10 decimal places. */ protected $rate; /** - * Source currency + * Source currency */ protected $source; /** - * Target currency + * Target currency */ protected $target; /** - * Time at which the rate was retrieved from the provider. + * Time at which the rate was retrieved from the provider. */ protected $time; } diff --git a/lib/Resources/Customer.php b/lib/Resources/Customer.php index 721455cf..b03a762a 100644 --- a/lib/Resources/Customer.php +++ b/lib/Resources/Customer.php @@ -36,114 +36,114 @@ class Customer extends BaseResource protected $model_name = "Customer"; /** - * The first line of the customer's address. + * The first line of the customer's address. */ protected $address_line1; /** - * The second line of the customer's address. + * The second line of the customer's address. */ protected $address_line2; /** - * The third line of the customer's address. + * The third line of the customer's address. */ protected $address_line3; /** - * The city of the customer's address. + * The city of the customer's address. */ protected $city; /** - * Customer's company name. Required unless a `given_name` and - * `family_name` are provided. For Canadian customers, the use of a - * `company_name` value will mean that any mandate created from this - * customer will be considered to be a "Business PAD" (otherwise, any - * mandate will be considered to be a "Personal PAD"). + * Customer's company name. Required unless a `given_name` and `family_name` + * are provided. For Canadian customers, the use of a `company_name` value + * will mean that any mandate created from this customer will be considered + * to be a "Business PAD" (otherwise, any mandate will be considered to be a + * "Personal PAD"). */ protected $company_name; /** - * [ISO 3166-1 alpha-2 - * code.](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + * [ISO 3166-1 alpha-2 + * code.](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) */ protected $country_code; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * For Danish customers only. The civic/company number (CPR or CVR) of the - * customer. Must be supplied if the customer's bank account is denominated - * in Danish krone (DKK). + * For Danish customers only. The civic/company number (CPR or CVR) of the + * customer. Must be supplied if the customer's bank account is denominated + * in Danish krone (DKK). */ protected $danish_identity_number; /** - * Customer's email address. Required in most cases, as this allows - * GoCardless to send notifications to this customer. + * Customer's email address. Required in most cases, as this allows + * GoCardless to send notifications to this customer. */ protected $email; /** - * Customer's surname. Required unless a `company_name` is provided. + * Customer's surname. Required unless a `company_name` is provided. */ protected $family_name; /** - * Customer's first name. Required unless a `company_name` is provided. + * Customer's first name. Required unless a `company_name` is provided. */ protected $given_name; /** - * Unique identifier, beginning with "CU". + * Unique identifier, beginning with "CU". */ protected $id; /** - * [ISO 639-1](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. - * Used as the language for notification emails sent by GoCardless if your - * organisation does not send its own (see [compliance - * requirements](#appendix-compliance-requirements)). Currently only "en", - * "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are - * supported. If this is not provided, the language will be chosen based on - * the `country_code` (if supplied) or default to "en". + * [ISO 639-1](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + * Used as the language for notification emails sent by GoCardless if your + * organisation does not send its own (see [compliance + * requirements](#appendix-compliance-requirements)). Currently only "en", + * "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. + * If this is not provided, the language will be chosen based on the + * `country_code` (if supplied) or default to "en". */ protected $language; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. */ protected $metadata; /** - * [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, - * including country code. + * [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, + * including country code. */ protected $phone_number; /** - * The customer's postal code. + * The customer's postal code. */ protected $postal_code; /** - * The customer's address region, county or department. For US customers a - * 2 letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) - * state code is required (e.g. `CA` for California). + * The customer's address region, county or department. For US customers a 2 + * letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state + * code is required (e.g. `CA` for California). */ protected $region; /** - * For Swedish customers only. The civic/company number (personnummer, - * samordningsnummer, or organisationsnummer) of the customer. Must be - * supplied if the customer's bank account is denominated in Swedish krona - * (SEK). This field cannot be changed once it has been set. + * For Swedish customers only. The civic/company number (personnummer, + * samordningsnummer, or organisationsnummer) of the customer. Must be + * supplied if the customer's bank account is denominated in Swedish krona + * (SEK). This field cannot be changed once it has been set. */ protected $swedish_identity_number; } diff --git a/lib/Resources/CustomerBankAccount.php b/lib/Resources/CustomerBankAccount.php index 33185807..d7a08902 100644 --- a/lib/Resources/CustomerBankAccount.php +++ b/lib/Resources/CustomerBankAccount.php @@ -30,68 +30,67 @@ class CustomerBankAccount extends BaseResource protected $model_name = "CustomerBankAccount"; /** - * Name of the account holder, as known by the bank. The full name provided - * when the customer is created is stored and is available via the API, but - * is transliterated, upcased, and truncated to 18 characters in bank - * submissions. This field is required unless the request includes a - * [customer bank account - * token](#javascript-flow-customer-bank-account-tokens). + * Name of the account holder, as known by the bank. The full name provided + * when the customer is created is stored and is available via the API, but + * is transliterated, upcased, and truncated to 18 characters in bank + * submissions. This field is required unless the request includes a + * [customer bank account + * token](#javascript-flow-customer-bank-account-tokens). */ protected $account_holder_name; /** - * The last few digits of the account number. Currently 4 digits for NZD - * bank accounts and 2 digits for other currencies. + * The last few digits of the account number. Currently 4 digits for NZD + * bank accounts and 2 digits for other currencies. */ protected $account_number_ending; /** - * Bank account type. Required for USD-denominated bank accounts. Must not - * be provided for bank accounts in other currencies. See [local - * details](#local-bank-details-united-states) for more information. + * Bank account type. Required for USD-denominated bank accounts. Must not + * be provided for bank accounts in other currencies. See [local + * details](#local-bank-details-united-states) for more information. */ protected $account_type; /** - * A token to uniquely refer to a set of bank account details. This feature - * is still in early access and is only available for certain - * organisations. + * A token to uniquely refer to a set of bank account details. This feature + * is still in early access and is only available for certain organisations. */ protected $bank_account_token; /** - * Name of bank, taken from the bank details. + * Name of bank, taken from the bank details. */ protected $bank_name; /** - * [ISO 3166-1 alpha-2 - * code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). - * Defaults to the country code of the `iban` if supplied, otherwise is - * required. + * [ISO 3166-1 alpha-2 + * code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + * Defaults to the country code of the `iban` if supplied, otherwise is + * required. */ protected $country_code; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and - * "USD" are supported. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" + * are supported. */ protected $currency; /** - * Boolean value showing whether the bank account is enabled or disabled. + * Boolean value showing whether the bank account is enabled or disabled. */ protected $enabled; /** - * Unique identifier, beginning with "BA". + * Unique identifier, beginning with "BA". */ protected $id; @@ -101,8 +100,8 @@ class CustomerBankAccount extends BaseResource protected $links; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. */ protected $metadata; } diff --git a/lib/Resources/CustomerNotification.php b/lib/Resources/CustomerNotification.php index 3b591070..6a3dbcf5 100644 --- a/lib/Resources/CustomerNotification.php +++ b/lib/Resources/CustomerNotification.php @@ -24,27 +24,27 @@ class CustomerNotification extends BaseResource protected $model_name = "CustomerNotification"; /** - * The action that was taken on the notification. Currently this can only - * be `handled`, - * which means the integrator sent the notification themselves. + * The action that was taken on the notification. Currently this can only be + * `handled`, + * which means the integrator sent the notification themselves. * */ protected $action_taken; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * action was taken. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * action was taken. */ protected $action_taken_at; /** - * A string identifying the integrator who was able to handle this - * notification. + * A string identifying the integrator who was able to handle this + * notification. */ protected $action_taken_by; /** - * The id of the notification. + * The id of the notification. */ protected $id; @@ -54,18 +54,18 @@ class CustomerNotification extends BaseResource protected $links; /** - * The type of notification the customer shall receive. - * One of: - * + * The type of notification the customer shall receive. + * One of: + * */ protected $type; } diff --git a/lib/Resources/Event.php b/lib/Resources/Event.php index 9050af43..4f1feb01 100644 --- a/lib/Resources/Event.php +++ b/lib/Resources/Event.php @@ -28,23 +28,23 @@ class Event extends BaseResource protected $model_name = "Event"; /** - * What has happened to the resource. See [Event Types](#event-types) for - * the possible actions. + * What has happened to the resource. See [Event Types](#event-types) for + * the possible actions. */ protected $action; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * Present only in webhooks when an integrator is authorised to send their - * own - * notifications. See - * [here](/getting-started/api/handling-customer-notifications/) - * for further information. + * Present only in webhooks when an integrator is authorised to send their + * own + * notifications. See + * [here](/getting-started/api/handling-customer-notifications/) + * for further information. * */ protected $customer_notifications; @@ -55,7 +55,7 @@ class Event extends BaseResource protected $details; /** - * Unique identifier, beginning with "EV". + * Unique identifier, beginning with "EV". */ protected $id; @@ -65,46 +65,46 @@ class Event extends BaseResource protected $links; /** - * The metadata that was passed when making the API request that triggered - * the event - * (for instance, cancelling a mandate). + * The metadata that was passed when making the API request that triggered + * the event + * (for instance, cancelling a mandate). * - * This field will only be populated if the `details[origin]` field is - * `api` otherwise it will be an empty object. + * This field will only be populated if the `details[origin]` field is `api` + * otherwise it will be an empty object. * */ protected $metadata; /** - * The metadata of the resource that the event is for. For example, this - * field will have the same - * value of the `mandate[metadata]` field on the response you would receive - * from performing a GET request on a mandate. + * The metadata of the resource that the event is for. For example, this + * field will have the same + * value of the `mandate[metadata]` field on the response you would receive + * from performing a GET request on a mandate. * */ protected $resource_metadata; /** - * The resource type for this event. One of: - * + * The resource type for this event. One of: + * */ protected $resource_type; /** - * Audit information about the source of the event. + * Audit information about the source of the event. */ protected $source; } diff --git a/lib/Resources/Export.php b/lib/Resources/Export.php index 390267f5..0f853998 100644 --- a/lib/Resources/Export.php +++ b/lib/Resources/Export.php @@ -23,28 +23,28 @@ class Export extends BaseResource protected $model_name = "Export"; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * The currency of the export (if applicable) + * The currency of the export (if applicable) */ protected $currency; /** - * Download url for the export file. Subject to expiry. + * Download url for the export file. Subject to expiry. */ protected $download_url; /** - * The type of the export + * The type of the export */ protected $export_type; /** - * Unique identifier, beginning with "EX". + * Unique identifier, beginning with "EX". */ protected $id; } diff --git a/lib/Resources/FundsAvailability.php b/lib/Resources/FundsAvailability.php index 694614d4..aeb169db 100644 --- a/lib/Resources/FundsAvailability.php +++ b/lib/Resources/FundsAvailability.php @@ -19,7 +19,7 @@ class FundsAvailability extends BaseResource protected $model_name = "FundsAvailability"; /** - * Indicates if the amount is available + * Indicates if the amount is available */ protected $available; } diff --git a/lib/Resources/InstalmentSchedule.php b/lib/Resources/InstalmentSchedule.php index 36eae5df..8a2a4b2f 100644 --- a/lib/Resources/InstalmentSchedule.php +++ b/lib/Resources/InstalmentSchedule.php @@ -27,74 +27,74 @@ class InstalmentSchedule extends BaseResource protected $model_name = "InstalmentSchedule"; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and - * "USD" are supported. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" + * are supported. */ protected $currency; /** - * Unique identifier, beginning with "IS". + * Unique identifier, beginning with "IS". */ protected $id; /** - * Links to associated objects + * Links to associated objects */ protected $links; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. */ protected $metadata; /** - * Name of the instalment schedule, up to 100 chars. This name will also be - * copied to the payments of the instalment schedule if you use - * schedule-based creation. + * Name of the instalment schedule, up to 100 chars. This name will also be + * copied to the payments of the instalment schedule if you use + * schedule-based creation. */ protected $name; /** - * If the status is `creation_failed`, this property will be populated with - * validation - * failures from the individual payments, arranged by the index of the - * payment that - * failed. + * If the status is `creation_failed`, this property will be populated with + * validation + * failures from the individual payments, arranged by the index of the + * payment that + * failed. * */ protected $payment_errors; /** - * One of: - * + * One of: + * */ protected $status; /** - * The total amount of the instalment schedule, defined as the sum of all - * individual - * payments, in the lowest denomination for the currency (e.g. pence in - * GBP, cents in - * EUR). If the requested payment amounts do not sum up correctly, a - * validation error - * will be returned. + * The total amount of the instalment schedule, defined as the sum of all + * individual + * payments, in the lowest denomination for the currency (e.g. pence in GBP, + * cents in + * EUR). If the requested payment amounts do not sum up correctly, a + * validation error + * will be returned. */ protected $total_amount; } diff --git a/lib/Resources/Institution.php b/lib/Resources/Institution.php index 9e3d2019..7f0d0af4 100644 --- a/lib/Resources/Institution.php +++ b/lib/Resources/Institution.php @@ -26,48 +26,48 @@ class Institution extends BaseResource protected $model_name = "Institution"; /** - * Flag to show if selecting this institution in the select_institution - * action can auto-complete the collect_bank_account action. The bank can - * return the payer's bank account details to GoCardless. + * Flag to show if selecting this institution in the select_institution + * action can auto-complete the collect_bank_account action. The bank can + * return the payer's bank account details to GoCardless. */ protected $autocompletes_collect_bank_account; /** - * [ISO - * 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) - * alpha-2 code. The country code of the institution. If nothing is - * provided, institutions with the country code 'GB' are returned by - * default. + * [ISO + * 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + * alpha-2 code. The country code of the institution. If nothing is + * provided, institutions with the country code 'GB' are returned by + * default. */ protected $country_code; /** - * A URL pointing to the icon for this institution + * A URL pointing to the icon for this institution */ protected $icon_url; /** - * The unique identifier for this institution + * The unique identifier for this institution */ protected $id; /** - * Defines individual limits for business and personal accounts. + * Defines individual limits for business and personal accounts. */ protected $limits; /** - * A URL pointing to the logo for this institution + * A URL pointing to the logo for this institution */ protected $logo_url; /** - * A human readable name for this institution + * A human readable name for this institution */ protected $name; /** - * The status of the institution + * The status of the institution */ protected $status; } diff --git a/lib/Resources/Logo.php b/lib/Resources/Logo.php index 2b6f3476..70760b4c 100644 --- a/lib/Resources/Logo.php +++ b/lib/Resources/Logo.php @@ -19,7 +19,7 @@ class Logo extends BaseResource protected $model_name = "Logo"; /** - * Unique identifier, beginning with "LO". + * Unique identifier, beginning with "LO". */ protected $id; } diff --git a/lib/Resources/Mandate.php b/lib/Resources/Mandate.php index 7890fb09..3f36153e 100644 --- a/lib/Resources/Mandate.php +++ b/lib/Resources/Mandate.php @@ -33,54 +33,54 @@ class Mandate extends BaseResource protected $model_name = "Mandate"; /** - * This field is ACH specific, sometimes referred to as [SEC - * code](https://www.moderntreasury.com/learn/sec-codes). + * This field is ACH specific, sometimes referred to as [SEC + * code](https://www.moderntreasury.com/learn/sec-codes). * - * This is the way that the payer gives authorisation to the merchant. - * web: Authorisation is Internet Initiated or via Mobile Entry (maps to - * SEC code: WEB) - * telephone: Authorisation is provided orally over telephone (maps to - * SEC code: TEL) - * paper: Authorisation is provided in writing and signed, or similarly - * authenticated (maps to SEC code: PPD) + * This is the way that the payer gives authorisation to the merchant. + * web: Authorisation is Internet Initiated or via Mobile Entry (maps to + * SEC code: WEB) + * telephone: Authorisation is provided orally over telephone (maps to SEC + * code: TEL) + * paper: Authorisation is provided in writing and signed, or similarly + * authenticated (maps to SEC code: PPD) * */ protected $authorisation_source; /** - * (Optional) Payto and VRP Scheme specific information + * (Optional) Payto and VRP Scheme specific information */ protected $consent_parameters; /** - * (Optional) Specifies the type of authorisation agreed between the payer - * and merchant. It can be set to one-off, recurring or standing for ACH, - * or single, recurring and sporadic for PAD. + * (Optional) Specifies the type of authorisation agreed between the payer + * and merchant. It can be set to one-off, recurring or standing for ACH, or + * single, recurring and sporadic for PAD. */ protected $consent_type; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * This field will decide how GoCardless handles settlement of funds from - * the customer. + * This field will decide how GoCardless handles settlement of funds from + * the customer. * - * - `managed` will be moved through GoCardless' account, batched, and - * payed out. - * - `direct` will be a direct transfer from the payer's account to the - * merchant where - * invoicing will be handled separately. + * - `managed` will be moved through GoCardless' account, batched, and payed + * out. + * - `direct` will be a direct transfer from the payer's account to the + * merchant where + * invoicing will be handled separately. * */ protected $funds_settlement; /** - * Unique identifier, beginning with "MD". Note that this prefix may not - * apply to mandates created before 2016. + * Unique identifier, beginning with "MD". Note that this prefix may not + * apply to mandates created before 2016. */ protected $id; @@ -90,74 +90,73 @@ class Mandate extends BaseResource protected $links; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. */ protected $metadata; /** - * The earliest date that can be used as a `charge_date` on any newly - * created payment for this mandate. This value will change over time. + * The earliest date that can be used as a `charge_date` on any newly + * created payment for this mandate. This value will change over time. */ protected $next_possible_charge_date; /** - * If this is an an ACH mandate, the earliest date that can be used as a - * `charge_date` on any newly created payment to be charged through - * standard - * ACH, rather than Faster ACH. This value will change over time. + * If this is an an ACH mandate, the earliest date that can be used as a + * `charge_date` on any newly created payment to be charged through standard + * ACH, rather than Faster ACH. This value will change over time. * - * It is only present in the API response for ACH mandates. + * It is only present in the API response for ACH mandates. */ protected $next_possible_standard_ach_charge_date; /** - * Boolean value showing whether payments and subscriptions under this - * mandate require approval via an automated email before being processed. + * Boolean value showing whether payments and subscriptions under this + * mandate require approval via an automated email before being processed. */ protected $payments_require_approval; /** - * Unique reference. Different schemes have different length and [character - * set](#appendix-character-sets) requirements. GoCardless will generate a - * unique reference satisfying the different scheme requirements if this - * field is left blank. + * Unique reference. Different schemes have different length and [character + * set](#appendix-character-sets) requirements. GoCardless will generate a + * unique reference satisfying the different scheme requirements if this + * field is left blank. */ protected $reference; /** - * Bank payment scheme to which this mandate - * and associated payments are submitted. Can be supplied or automatically - * detected from the customer's bank account. + * Bank payment scheme to which this mandate + * and associated payments are submitted. Can be supplied or automatically + * detected from the customer's bank account. */ protected $scheme; /** - * One of: - * + * One of: + * */ protected $status; /** - * [Timestamp](#api-usage-dates-and-times) recording when this mandate was - * verified. + * [Timestamp](#api-usage-dates-and-times) recording when this mandate was + * verified. */ protected $verified_at; } diff --git a/lib/Resources/MandateImport.php b/lib/Resources/MandateImport.php index 62ac4311..5e608938 100644 --- a/lib/Resources/MandateImport.php +++ b/lib/Resources/MandateImport.php @@ -23,43 +23,42 @@ class MandateImport extends BaseResource protected $model_name = "MandateImport"; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * Unique identifier, beginning with "IM". + * Unique identifier, beginning with "IM". */ protected $id; /** - * Related resources + * Related resources */ protected $links; /** - * The scheme of the mandates to be imported.
All mandates in a single - * mandate - * import must be for the same scheme. + * The scheme of the mandates to be imported.
All mandates in a single + * mandate + * import must be for the same scheme. */ protected $scheme; /** - * The status of the mandate import. - * + * The status of the mandate import. + * */ protected $status; } diff --git a/lib/Resources/MandateImportEntry.php b/lib/Resources/MandateImportEntry.php index 10d06b27..2144a067 100644 --- a/lib/Resources/MandateImportEntry.php +++ b/lib/Resources/MandateImportEntry.php @@ -22,27 +22,27 @@ class MandateImportEntry extends BaseResource protected $model_name = "MandateImportEntry"; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * Related resources + * Related resources */ protected $links; /** - * Per-resource processing errors + * Per-resource processing errors */ protected $processing_errors; /** - * A unique identifier for this entry, which you can use (once the import - * has been - * processed by GoCardless) to identify the records that have been created. - * Limited - * to 255 characters. + * A unique identifier for this entry, which you can use (once the import + * has been + * processed by GoCardless) to identify the records that have been created. + * Limited + * to 255 characters. * */ protected $record_identifier; diff --git a/lib/Resources/MandatePdf.php b/lib/Resources/MandatePdf.php index a19f533c..4061a8a1 100644 --- a/lib/Resources/MandatePdf.php +++ b/lib/Resources/MandatePdf.php @@ -20,15 +20,15 @@ class MandatePdf extends BaseResource protected $model_name = "MandatePdf"; /** - * The date and time at which the `url` will expire (10 minutes after the - * original request). + * The date and time at which the `url` will expire (10 minutes after the + * original request). */ protected $expires_at; /** - * The URL at which this mandate PDF can be viewed until it expires at the - * date and time specified by `expires_at`. You should not store this URL - * or rely on its structure remaining the same. + * The URL at which this mandate PDF can be viewed until it expires at the + * date and time specified by `expires_at`. You should not store this URL or + * rely on its structure remaining the same. */ protected $url; } diff --git a/lib/Resources/NegativeBalanceLimit.php b/lib/Resources/NegativeBalanceLimit.php index fd294d05..8579c615 100644 --- a/lib/Resources/NegativeBalanceLimit.php +++ b/lib/Resources/NegativeBalanceLimit.php @@ -23,25 +23,25 @@ class NegativeBalanceLimit extends BaseResource protected $model_name = "NegativeBalanceLimit"; /** - * The limit amount in pence (e.g. 10000 for a -100 GBP limit). + * The limit amount in pence (e.g. 10000 for a -100 GBP limit). */ protected $balance_limit; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this limit - * was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this limit + * was created. */ protected $created_at; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and - * "USD" are supported. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" + * are supported. */ protected $currency; /** - * Unique identifier, beginning with "NBL". + * Unique identifier, beginning with "NBL". */ protected $id; diff --git a/lib/Resources/OutboundPayment.php b/lib/Resources/OutboundPayment.php index aa1018db..227c193a 100644 --- a/lib/Resources/OutboundPayment.php +++ b/lib/Resources/OutboundPayment.php @@ -31,42 +31,42 @@ class OutboundPayment extends BaseResource protected $model_name = "OutboundPayment"; /** - * Amount, in the lowest denomination for the currency (e.g. pence in GBP, - * cents in EUR). + * Amount, in the lowest denomination for the currency (e.g. pence in GBP, + * cents in EUR). */ protected $amount; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when the - * outbound payment was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when the + * outbound payment was created. */ protected $created_at; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency. - * Currently only "GBP" is supported. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency. + * Currently only "GBP" is supported. */ protected $currency; /** - * A human-readable description of the outbound payment + * A human-readable description of the outbound payment */ protected $description; /** - * A future date on which the outbound payment should be sent. - * If not specified, the payment will be sent as soon as possible. + * A future date on which the outbound payment should be sent. + * If not specified, the payment will be sent as soon as possible. */ protected $execution_date; /** - * Unique identifier of the outbound payment. + * Unique identifier of the outbound payment. */ protected $id; /** - * Indicates whether the outbound payment is a withdrawal to your verified - * business bank account. + * Indicates whether the outbound payment is a withdrawal to your verified + * business bank account. */ protected $is_withdrawal; @@ -76,53 +76,52 @@ class OutboundPayment extends BaseResource protected $links; /** - * Key-value store of custom data. Up to 3 keys are permitted, with - * key names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with + * key names up to 50 characters and values up to 500 characters. */ protected $metadata; /** - * An optional reference that will appear on your customer's bank - * statement. - * The character limit for this reference is dependent on the scheme.
- * Faster Payments - 18 characters, including: - * "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 &-./"
+ * An optional reference that will appear on your customer's bank statement. + * The character limit for this reference is dependent on the scheme.
+ * Faster Payments - 18 characters, including: + * "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 &-./"
*/ protected $reference; /** - * Bank payment scheme to process the outbound payment. Currently only - * "faster_payments" (GBP) is supported. + * Bank payment scheme to process the outbound payment. Currently only + * "faster_payments" (GBP) is supported. */ protected $scheme; /** - * One of: - * + * One of: + * */ protected $status; /** - * Contains details of the verifications performed for the outbound payment + * Contains details of the verifications performed for the outbound payment */ protected $verifications; } diff --git a/lib/Resources/PayerAuthorisation.php b/lib/Resources/PayerAuthorisation.php index 034a835b..b9e0c2ac 100644 --- a/lib/Resources/PayerAuthorisation.php +++ b/lib/Resources/PayerAuthorisation.php @@ -26,59 +26,59 @@ class PayerAuthorisation extends BaseResource protected $model_name = "PayerAuthorisation"; /** - * All details required for the creation of a - * [Customer Bank Account](#core-endpoints-customer-bank-accounts). + * All details required for the creation of a + * [Customer Bank Account](#core-endpoints-customer-bank-accounts). */ protected $bank_account; /** - * [Timestamp](#api-usage-dates-and-times), recording when this Payer - * Authorisation was created. + * [Timestamp](#api-usage-dates-and-times), recording when this Payer + * Authorisation was created. */ protected $created_at; /** - * All details required for the creation of a - * [Customer](#core-endpoints-customers). + * All details required for the creation of a + * [Customer](#core-endpoints-customers). */ protected $customer; /** - * Unique identifier, beginning with "PA". + * Unique identifier, beginning with "PA". */ protected $id; /** - * An array of fields which are missing and is required to set up the - * mandate. + * An array of fields which are missing and is required to set up the + * mandate. */ protected $incomplete_fields; /** - * IDs of the created resources. Available after the Payer Authorisation is - * completed. + * IDs of the created resources. Available after the Payer Authorisation is + * completed. */ protected $links; /** - * All details required for the creation of a - * [Mandate](#core-endpoints-mandates). + * All details required for the creation of a + * [Mandate](#core-endpoints-mandates). */ protected $mandate; /** - * One of: - * + * One of: + * */ protected $status; } diff --git a/lib/Resources/PayerTheme.php b/lib/Resources/PayerTheme.php index 89bcc5e0..38412ed0 100644 --- a/lib/Resources/PayerTheme.php +++ b/lib/Resources/PayerTheme.php @@ -19,7 +19,7 @@ class PayerTheme extends BaseResource protected $model_name = "PayerTheme"; /** - * Unique identifier, beginning with "PTH". + * Unique identifier, beginning with "PTH". */ protected $id; } diff --git a/lib/Resources/Payment.php b/lib/Resources/Payment.php index 3f3fbd25..bea12d1f 100644 --- a/lib/Resources/Payment.php +++ b/lib/Resources/Payment.php @@ -33,52 +33,52 @@ class Payment extends BaseResource protected $model_name = "Payment"; /** - * Amount, in the lowest denomination for the currency (e.g. pence in GBP, - * cents in EUR). + * Amount, in the lowest denomination for the currency (e.g. pence in GBP, + * cents in EUR). */ protected $amount; /** - * Amount [refunded](#core-endpoints-refunds), in the lowest denomination - * for the currency (e.g. pence in GBP, cents in EUR). + * Amount [refunded](#core-endpoints-refunds), in the lowest denomination + * for the currency (e.g. pence in GBP, cents in EUR). */ protected $amount_refunded; /** - * A future date on which the payment should be collected. If not - * specified, the payment will be collected as soon as possible. If the - * value is before the [mandate](#core-endpoints-mandates)'s - * `next_possible_charge_date` creation will fail. If the value is not a - * working day it will be rolled forwards to the next available one. + * A future date on which the payment should be collected. If not specified, + * the payment will be collected as soon as possible. If the value is before + * the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date` + * creation will fail. If the value is not a working day it will be rolled + * forwards to the next available one. */ protected $charge_date; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and - * "USD" are supported. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" + * are supported. */ protected $currency; /** - * A human-readable description of the payment. This will be included in - * the notification email GoCardless sends to your customer if your - * organisation does not send its own notifications (see [compliance - * requirements](#appendix-compliance-requirements)). + * A human-readable description of the payment. This will be included in the + * notification email GoCardless sends to your customer if your organisation + * does not send its own notifications (see [compliance + * requirements](#appendix-compliance-requirements)). */ protected $description; /** - * This field indicates whether the ACH payment is processed through Faster - * ACH or standard ACH. + * This field indicates whether the ACH payment is processed through Faster + * ACH or standard ACH. * - * It is only present in the API response for ACH payments. + * It is only present in the API response for ACH payments. */ protected $faster_ach; @@ -88,7 +88,7 @@ class Payment extends BaseResource protected $fx; /** - * Unique identifier, beginning with "PM". + * Unique identifier, beginning with "PM". */ protected $id; @@ -98,68 +98,68 @@ class Payment extends BaseResource protected $links; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. */ protected $metadata; /** - * An optional reference that will appear on your customer's bank - * statement. The character limit for this reference is dependent on the - * scheme.
ACH - 10 characters
- * Autogiro - 11 characters
Bacs - - * 10 characters
BECS - 30 characters
- * BECS NZ - 12 characters
- * Betalingsservice - 30 characters
Faster - * Payments - 18 characters
PAD - scheme - * doesn't offer references
PayTo - 18 characters
SEPA - 140 characters
Note that this reference - * must be unique (for each merchant) for the BECS scheme as it is a scheme - * requirement.

Restricted: - * You can only specify a payment reference for Bacs payments (that is, - * when collecting from the UK) if you're on the GoCardless Plus, Pro or Enterprise - * packages.

Restricted: You can not - * specify a payment reference for Faster Payments.

+ * An optional reference that will appear on your customer's bank statement. + * The character limit for this reference is dependent on the scheme.
+ * ACH - 10 characters
Autogiro - 11 + * characters
Bacs - 10 characters
+ * BECS - 30 characters
BECS NZ - 12 + * characters
Betalingsservice - 30 characters
+ * Faster Payments - 18 characters
+ * PAD - scheme doesn't offer references
+ * PayTo - 18 characters
SEPA - 140 + * characters
Note that this reference must be unique (for each + * merchant) for the BECS scheme as it is a scheme requirement.

Restricted: You can only + * specify a payment reference for Bacs payments (that is, when collecting + * from the UK) if you're on the GoCardless Plus, Pro or Enterprise + * packages.

Restricted: You can not + * specify a payment reference for Faster Payments.

*/ protected $reference; /** - * On failure, automatically retry the payment using [intelligent - * retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - * retries, Success+ needs to be enabled in [GoCardless - * dashboard](https://manage.gocardless.com/success-plus).

+ * On failure, automatically retry the payment using [intelligent + * retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent + * retries, Success+ needs to be enabled in [GoCardless + * dashboard](https://manage.gocardless.com/success-plus).

*/ protected $retry_if_possible; /** - * A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", - * "becs_nz", "betalingsservice", "faster_payments", "pad", "pay_to" and - * "sepa_core" are supported. + * A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", + * "becs_nz", "betalingsservice", "faster_payments", "pad", "pay_to" and + * "sepa_core" are supported. */ protected $scheme; /** - * One of: - * + * One of: + * */ protected $status; } diff --git a/lib/Resources/PaymentAccount.php b/lib/Resources/PaymentAccount.php index 3c3d9b63..217d99cd 100644 --- a/lib/Resources/PaymentAccount.php +++ b/lib/Resources/PaymentAccount.php @@ -25,40 +25,40 @@ class PaymentAccount extends BaseResource protected $model_name = "PaymentAccount"; /** - * Current balance on a payment account in the lowest denomination for the - * currency (e.g. pence in GBP, cents in EUR). - * It is time-sensitive as it is ever changing. + * Current balance on a payment account in the lowest denomination for the + * currency (e.g. pence in GBP, cents in EUR). + * It is time-sensitive as it is ever changing. */ protected $account_balance; /** - * Name of the account holder, as known by the bank. Usually this is the - * same as the name stored with the linked - * [creditor](#core-endpoints-creditors). This field will be - * transliterated, upcased and truncated to 18 characters. + * Name of the account holder, as known by the bank. Usually this is the + * same as the name stored with the linked + * [creditor](#core-endpoints-creditors). This field will be transliterated, + * upcased and truncated to 18 characters. */ protected $account_holder_name; /** - * The last few digits of the account number. Currently 4 digits for NZD - * bank accounts and 2 digits for other currencies. + * The last few digits of the account number. Currently 4 digits for NZD + * bank accounts and 2 digits for other currencies. */ protected $account_number_ending; /** - * Name of bank, taken from the bank details. + * Name of bank, taken from the bank details. */ protected $bank_name; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and - * "USD" are supported. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" + * are supported. */ protected $currency; /** - * Unique identifier, beginning with "BA". + * Unique identifier, beginning with "BA". */ protected $id; diff --git a/lib/Resources/PaymentAccountTransaction.php b/lib/Resources/PaymentAccountTransaction.php index 9e3821a5..b5f8bcae 100644 --- a/lib/Resources/PaymentAccountTransaction.php +++ b/lib/Resources/PaymentAccountTransaction.php @@ -28,42 +28,42 @@ class PaymentAccountTransaction extends BaseResource protected $model_name = "PaymentAccountTransaction"; /** - * Amount, in the lowest denomination for the currency (e.g. pence in GBP, - * cents in EUR). + * Amount, in the lowest denomination for the currency (e.g. pence in GBP, + * cents in EUR). */ protected $amount; /** - * Balance after transaction, in the lowest denomination for the currency - * (e.g. pence in GBP, cents in EUR). + * Balance after transaction, in the lowest denomination for the currency + * (e.g. pence in GBP, cents in EUR). */ protected $balance_after_transaction; /** - * The name of the counterparty of the transaction. The counterparty is the - * recipient for a credit, or the sender for a debit. + * The name of the counterparty of the transaction. The counterparty is the + * recipient for a credit, or the sender for a debit. */ protected $counterparty_name; /** - * The currency of the transaction. + * The currency of the transaction. */ protected $currency; /** - * The description of the transaction, if available + * The description of the transaction, if available */ protected $description; /** - * The direction of the transaction. Debits mean money leaving the account - * (e.g. outbound payment), while credits signify money coming in (e.g. - * manual top-up). + * The direction of the transaction. Debits mean money leaving the account + * (e.g. outbound payment), while credits signify money coming in (e.g. + * manual top-up). */ protected $direction; /** - * The unique ID of the payment account transaction. + * The unique ID of the payment account transaction. */ protected $id; @@ -73,13 +73,13 @@ class PaymentAccountTransaction extends BaseResource protected $links; /** - * The reference of the transaction. This is typically supplied by the - * sender. + * The reference of the transaction. This is typically supplied by the + * sender. */ protected $reference; /** - * The date of when the transaction occurred. + * The date of when the transaction occurred. */ protected $value_date; } diff --git a/lib/Resources/Payout.php b/lib/Resources/Payout.php index 890f105f..127645eb 100644 --- a/lib/Resources/Payout.php +++ b/lib/Resources/Payout.php @@ -31,49 +31,49 @@ class Payout extends BaseResource protected $model_name = "Payout"; /** - * Amount in minor unit (e.g. pence in GBP, cents in EUR). + * Amount in minor unit (e.g. pence in GBP, cents in EUR). */ protected $amount; /** - * Date the payout is due to arrive in the creditor's bank account. - * One of: - * + * Date the payout is due to arrive in the creditor's bank account. + * One of: + * * */ protected $arrival_date; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and - * "USD" are supported. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" + * are supported. */ protected $currency; /** - * Fees that have already been deducted from the payout amount in minor - * unit (e.g. pence in GBP, cents in EUR), inclusive of tax if applicable. - *
- * For each `late_failure_settled` or `chargeback_settled` action, we - * refund the transaction fees in a payout. This means that a payout can - * have a negative `deducted_fees` value. - *
- * This field is calculated as `(GoCardless fees + app fees + surcharge - * fees) - (refunded fees)` - *
- * If the merchant is invoiced for fees separately from the payout, then - * `deducted_fees` will be 0. + * Fees that have already been deducted from the payout amount in minor unit + * (e.g. pence in GBP, cents in EUR), inclusive of tax if applicable. + *
+ * For each `late_failure_settled` or `chargeback_settled` action, we refund + * the transaction fees in a payout. This means that a payout can have a + * negative `deducted_fees` value. + *
+ * This field is calculated as `(GoCardless fees + app fees + surcharge + * fees) - (refunded fees)` + *
+ * If the merchant is invoiced for fees separately from the payout, then + * `deducted_fees` will be 0. */ protected $deducted_fees; @@ -83,7 +83,7 @@ class Payout extends BaseResource protected $fx; /** - * Unique identifier, beginning with "PO". + * Unique identifier, beginning with "PO". */ protected $id; @@ -93,41 +93,40 @@ class Payout extends BaseResource protected $links; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. _Note:_ This - * should not be used for storing PII data. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. _Note:_ This + * should not be used for storing PII data. */ protected $metadata; /** - * Whether a payout contains merchant revenue or partner fees. + * Whether a payout contains merchant revenue or partner fees. */ protected $payout_type; /** - * Reference which appears on the creditor's bank statement. + * Reference which appears on the creditor's bank statement. */ protected $reference; /** - * One of: - * + * One of: + * */ protected $status; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for - * the currency in which tax is paid out to the tax authorities of your tax - * jurisdiction. Currently “EUR”, “GBP”, for French or British merchants, - * this will be `null` if tax is not applicable beta + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for + * the currency in which tax is paid out to the tax authorities of your tax + * jurisdiction. Currently “EUR”, “GBP”, for French or British merchants, + * this will be `null` if tax is not applicable beta */ protected $tax_currency; } diff --git a/lib/Resources/PayoutItem.php b/lib/Resources/PayoutItem.php index b76b8f55..8b24e152 100644 --- a/lib/Resources/PayoutItem.php +++ b/lib/Resources/PayoutItem.php @@ -22,16 +22,16 @@ class PayoutItem extends BaseResource protected $model_name = "PayoutItem"; /** - * The positive (credit) or negative (debit) value of the item, in - * fractional currency; - * the lowest denomination for the currency (e.g. pence in GBP, cents in - * EUR), to one decimal place. - *

For accuracy, we store some of our fees to greater - * precision than we can actually pay out (for example, a GoCardless fee we - * record might come to 0.5 pence, but it is not possible to send a payout - * via bank transfer including a half penny).

To calculate the final - * amount of the payout, we sum all of the items and then round to the - * nearest currency unit.

+ * The positive (credit) or negative (debit) value of the item, in + * fractional currency; + * the lowest denomination for the currency (e.g. pence in GBP, cents in + * EUR), to one decimal place. + *

For accuracy, we store some of our fees to greater + * precision than we can actually pay out (for example, a GoCardless fee we + * record might come to 0.5 pence, but it is not possible to send a payout + * via bank transfer including a half penny).

To calculate the final + * amount of the payout, we sum all of the items and then round to the + * nearest currency unit.

*/ protected $amount; @@ -41,43 +41,42 @@ class PayoutItem extends BaseResource protected $links; /** - * An array of tax items beta + * An array of tax items beta * - * _Note_: VAT applies to transaction and surcharge fees for merchants - * operating in the UK and France. + * _Note_: VAT applies to transaction and surcharge fees for merchants + * operating in the UK and France. */ protected $taxes; /** - * The type of the credit (positive) or debit (negative) item in the payout - * (inclusive of VAT if applicable). One of: - * + * The type of the credit (positive) or debit (negative) item in the payout + * (inclusive of VAT if applicable). One of: + * * */ protected $type; diff --git a/lib/Resources/RedirectFlow.php b/lib/Resources/RedirectFlow.php index 45af48ff..25728c87 100644 --- a/lib/Resources/RedirectFlow.php +++ b/lib/Resources/RedirectFlow.php @@ -29,32 +29,32 @@ class RedirectFlow extends BaseResource protected $model_name = "RedirectFlow"; /** - * The URL of a confirmation page, which you may optionally redirect the - * customer to rather than use your own page, that confirms in their chosen - * language that their Direct Debit has been set up successfully. Only - * returned once the customer has set up their mandate via the payment - * pages and the redirect flow has been - * [completed](#redirect-flows-complete-a-redirect-flow), and only - * available for 15 minutes from when you complete the redirect flow. The - * structure of this URL may change at any time, so you should read it - * directly from the API response. + * The URL of a confirmation page, which you may optionally redirect the + * customer to rather than use your own page, that confirms in their chosen + * language that their Direct Debit has been set up successfully. Only + * returned once the customer has set up their mandate via the payment pages + * and the redirect flow has been + * [completed](#redirect-flows-complete-a-redirect-flow), and only available + * for 15 minutes from when you complete the redirect flow. The structure of + * this URL may change at any time, so you should read it directly from the + * API response. */ protected $confirmation_url; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * A description of the item the customer is paying for. This will be shown - * on the hosted payment pages. + * A description of the item the customer is paying for. This will be shown + * on the hosted payment pages. */ protected $description; /** - * Unique identifier, beginning with "RE". + * Unique identifier, beginning with "RE". */ protected $id; @@ -64,42 +64,42 @@ class RedirectFlow extends BaseResource protected $links; /** - * Mandate reference generated by GoCardless or submitted by an integrator. + * Mandate reference generated by GoCardless or submitted by an integrator. */ protected $mandate_reference; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. _Note:_ This - * should not be used for storing PII data. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. _Note:_ This + * should not be used for storing PII data. */ protected $metadata; /** - * The URL of the hosted payment pages for this redirect flow. This is the - * URL you should redirect your customer to. + * The URL of the hosted payment pages for this redirect flow. This is the + * URL you should redirect your customer to. */ protected $redirect_url; /** - * The Direct Debit scheme of the mandate. If specified, the payment pages - * will only allow the set-up of a mandate for the specified scheme. It is - * recommended that you leave this blank so the most appropriate scheme is - * picked based on the customer's bank account. + * The Direct Debit scheme of the mandate. If specified, the payment pages + * will only allow the set-up of a mandate for the specified scheme. It is + * recommended that you leave this blank so the most appropriate scheme is + * picked based on the customer's bank account. */ protected $scheme; /** - * The customer's session ID must be provided when the redirect flow is set - * up and again when it is completed. This allows integrators to ensure - * that the user who was originally sent to the GoCardless payment pages is - * the one who has completed them. + * The customer's session ID must be provided when the redirect flow is set + * up and again when it is completed. This allows integrators to ensure that + * the user who was originally sent to the GoCardless payment pages is the + * one who has completed them. */ protected $session_token; /** - * The URL to redirect to upon successful mandate setup. You must use a URL - * beginning `https` in the live environment. + * The URL to redirect to upon successful mandate setup. You must use a URL + * beginning `https` in the live environment. */ protected $success_redirect_url; } diff --git a/lib/Resources/Refund.php b/lib/Resources/Refund.php index 8b54940f..4c5467f2 100644 --- a/lib/Resources/Refund.php +++ b/lib/Resources/Refund.php @@ -27,20 +27,20 @@ class Refund extends BaseResource protected $model_name = "Refund"; /** - * Amount in minor unit (e.g. pence in GBP, cents in EUR). + * Amount in minor unit (e.g. pence in GBP, cents in EUR). */ protected $amount; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. This is set to the currency of the refund's - * [payment](#core-endpoints-payments). + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. This is set to the currency of the refund's + * [payment](#core-endpoints-payments). */ protected $currency; @@ -50,7 +50,7 @@ class Refund extends BaseResource protected $fx; /** - * Unique identifier, beginning with "RF". + * Unique identifier, beginning with "RF". */ protected $id; @@ -60,46 +60,46 @@ class Refund extends BaseResource protected $links; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. */ protected $metadata; /** - * An optional reference that will appear on your customer's bank - * statement. The character limit for this reference is dependent on the - * scheme.
ACH - 10 characters
- * Autogiro - 11 characters
Bacs - - * 10 characters
BECS - 30 characters
- * BECS NZ - 12 characters
- * Betalingsservice - 30 characters
Faster - * Payments - 18 characters
PAD - scheme - * doesn't offer references
PayTo - 18 characters
SEPA - 140 characters
Note that this reference - * must be unique (for each merchant) for the BECS scheme as it is a scheme - * requirement.

Restricted: - * You can only specify a payment reference for Bacs payments (that is, - * when collecting from the UK) if you're on the GoCardless Plus, Pro or Enterprise - * packages.

Restricted: You can not - * specify a payment reference for Faster Payments.

+ * An optional reference that will appear on your customer's bank statement. + * The character limit for this reference is dependent on the scheme.
+ * ACH - 10 characters
Autogiro - 11 + * characters
Bacs - 10 characters
+ * BECS - 30 characters
BECS NZ - 12 + * characters
Betalingsservice - 30 characters
+ * Faster Payments - 18 characters
+ * PAD - scheme doesn't offer references
+ * PayTo - 18 characters
SEPA - 140 + * characters
Note that this reference must be unique (for each + * merchant) for the BECS scheme as it is a scheme requirement.

Restricted: You can only + * specify a payment reference for Bacs payments (that is, when collecting + * from the UK) if you're on the GoCardless Plus, Pro or Enterprise + * packages.

Restricted: You can not + * specify a payment reference for Faster Payments.

*/ protected $reference; /** - * One of: - * + * One of: + * */ protected $status; } diff --git a/lib/Resources/ScenarioSimulator.php b/lib/Resources/ScenarioSimulator.php index 61e0d7fb..0a0cb229 100644 --- a/lib/Resources/ScenarioSimulator.php +++ b/lib/Resources/ScenarioSimulator.php @@ -19,137 +19,135 @@ class ScenarioSimulator extends BaseResource protected $model_name = "ScenarioSimulator"; /** - * The unique identifier of the simulator, used to initiate simulations. - * One of: - * + * The unique identifier of the simulator, used to initiate simulations. One + * of: + * */ protected $id; } diff --git a/lib/Resources/SchemeIdentifier.php b/lib/Resources/SchemeIdentifier.php index 3e9a08c0..69b56715 100644 --- a/lib/Resources/SchemeIdentifier.php +++ b/lib/Resources/SchemeIdentifier.php @@ -36,103 +36,103 @@ class SchemeIdentifier extends BaseResource protected $model_name = "SchemeIdentifier"; /** - * The first line of the scheme identifier's support address. + * The first line of the scheme identifier's support address. */ protected $address_line1; /** - * The second line of the scheme identifier's support address. + * The second line of the scheme identifier's support address. */ protected $address_line2; /** - * The third line of the scheme identifier's support address. + * The third line of the scheme identifier's support address. */ protected $address_line3; /** - * Whether a custom reference can be submitted for mandates using this - * scheme identifier. + * Whether a custom reference can be submitted for mandates using this + * scheme identifier. */ protected $can_specify_mandate_reference; /** - * The city of the scheme identifier's support address. + * The city of the scheme identifier's support address. */ protected $city; /** - * [ISO 3166-1 alpha-2 - * code.](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + * [ISO 3166-1 alpha-2 + * code.](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) */ protected $country_code; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * The currency of the scheme identifier. + * The currency of the scheme identifier. */ protected $currency; /** - * Scheme identifier's support email address. + * Scheme identifier's support email address. */ protected $email; /** - * Unique identifier, usually beginning with "SU". + * Unique identifier, usually beginning with "SU". */ protected $id; /** - * The minimum interval, in working days, between the sending of a - * pre-notification to the customer, and the charge date of a payment using - * this scheme identifier. + * The minimum interval, in working days, between the sending of a + * pre-notification to the customer, and the charge date of a payment using + * this scheme identifier. * - * By default, GoCardless sends these notifications automatically. Please - * see our [compliance requirements](#appendix-compliance-requirements) for - * more details. + * By default, GoCardless sends these notifications automatically. Please + * see our [compliance requirements](#appendix-compliance-requirements) for + * more details. */ protected $minimum_advance_notice; /** - * The name which appears on customers' bank statements. This should - * usually be the merchant's trading name. + * The name which appears on customers' bank statements. This should usually + * be the merchant's trading name. */ protected $name; /** - * Scheme identifier's support phone number. + * Scheme identifier's support phone number. */ protected $phone_number; /** - * The scheme identifier's support postal code. + * The scheme identifier's support postal code. */ protected $postal_code; /** - * The scheme-unique identifier against which payments are submitted. + * The scheme-unique identifier against which payments are submitted. */ protected $reference; /** - * The scheme identifier's support address region, county or department. + * The scheme identifier's support address region, county or department. */ protected $region; /** - * The scheme which this scheme identifier applies to. + * The scheme which this scheme identifier applies to. */ protected $scheme; /** - * The status of the scheme identifier. Only `active` scheme identifiers - * will be applied to a creditor and used against payments. + * The status of the scheme identifier. Only `active` scheme identifiers + * will be applied to a creditor and used against payments. */ protected $status; } diff --git a/lib/Resources/Subscription.php b/lib/Resources/Subscription.php index 67e35a42..fda79cac 100644 --- a/lib/Resources/Subscription.php +++ b/lib/Resources/Subscription.php @@ -39,77 +39,77 @@ class Subscription extends BaseResource protected $model_name = "Subscription"; /** - * Amount in the lowest denomination for the currency (e.g. pence in GBP, - * cents in EUR). + * Amount in the lowest denomination for the currency (e.g. pence in GBP, + * cents in EUR). */ protected $amount; /** - * The amount to be deducted from each payment as an app fee, to be paid to - * the partner integration which created the subscription, in the lowest - * denomination for the currency (e.g. pence in GBP, cents in EUR). + * The amount to be deducted from each payment as an app fee, to be paid to + * the partner integration which created the subscription, in the lowest + * denomination for the currency (e.g. pence in GBP, cents in EUR). */ protected $app_fee; /** - * The total number of payments that should be taken by this subscription. + * The total number of payments that should be taken by this subscription. */ protected $count; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and - * "USD" are supported. + * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" + * are supported. */ protected $currency; /** - * As per RFC 2445. The day of the month to charge customers on. `1`-`28` - * or `-1` to indicate the last day of the month. + * As per RFC 2445. The day of the month to charge customers on. `1`-`28` or + * `-1` to indicate the last day of the month. */ protected $day_of_month; /** - * The earliest date that will be used as a `charge_date` on payments - * created for this subscription if it is resumed. Only present for - * `paused` subscriptions. - * This value will change over time. + * The earliest date that will be used as a `charge_date` on payments + * created for this subscription if it is resumed. Only present for `paused` + * subscriptions. + * This value will change over time. */ protected $earliest_charge_date_after_resume; /** - * Date on or after which no further payments should be created. - *
- * If this field is blank and `count` is not specified, the subscription - * will continue forever. - *
- *

Deprecated: This field - * will be removed in a future API version. Use `count` to specify a number - * of payments instead.

+ * Date on or after which no further payments should be created. + *
+ * If this field is blank and `count` is not specified, the subscription + * will continue forever. + *
+ *

Deprecated: This field will + * be removed in a future API version. Use `count` to specify a number of + * payments instead.

*/ protected $end_date; /** - * Unique identifier, beginning with "SB". + * Unique identifier, beginning with "SB". */ protected $id; /** - * Number of `interval_units` between customer charge dates. Must be - * greater than or equal to `1`. Must result in at least one charge date - * per year. Defaults to `1`. + * Number of `interval_units` between customer charge dates. Must be greater + * than or equal to `1`. Must result in at least one charge date per year. + * Defaults to `1`. */ protected $interval; /** - * The unit of time between customer charge dates. One of `weekly`, - * `monthly` or `yearly`. + * The unit of time between customer charge dates. One of `weekly`, + * `monthly` or `yearly`. */ protected $interval_unit; @@ -119,84 +119,84 @@ class Subscription extends BaseResource protected $links; /** - * Key-value store of custom data. Up to 3 keys are permitted, with key - * names up to 50 characters and values up to 500 characters. + * Key-value store of custom data. Up to 3 keys are permitted, with key + * names up to 50 characters and values up to 500 characters. */ protected $metadata; /** - * Name of the month on which to charge a customer. Must be lowercase. Only - * applies - * when the interval_unit is `yearly`. + * Name of the month on which to charge a customer. Must be lowercase. Only + * applies + * when the interval_unit is `yearly`. * */ protected $month; /** - * Optional name for the subscription. This will be set as the description - * on each payment created. Must not exceed 255 characters. + * Optional name for the subscription. This will be set as the description + * on each payment created. Must not exceed 255 characters. */ protected $name; /** - * Whether the parent plan of this subscription is paused. + * Whether the parent plan of this subscription is paused. */ protected $parent_plan_paused; /** - * An optional payment reference. This will be set as the reference on each - * payment - * created and will appear on your customer's bank statement. See the - * documentation for - * the [create payment endpoint](#payments-create-a-payment) for more - * details. - *
- *

Restricted: You need your - * own Service User Number to specify a payment reference for Bacs - * payments.

+ * An optional payment reference. This will be set as the reference on each + * payment + * created and will appear on your customer's bank statement. See the + * documentation for + * the [create payment endpoint](#payments-create-a-payment) for more + * details. + *
+ *

Restricted: You need your + * own Service User Number to specify a payment reference for Bacs + * payments.

*/ protected $payment_reference; /** - * On failure, automatically retry payments using [intelligent - * retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - * retries, Success+ needs to be enabled in [GoCardless - * dashboard](https://manage.gocardless.com/success-plus).

+ * On failure, automatically retry payments using [intelligent + * retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent + * retries, Success+ needs to be enabled in [GoCardless + * dashboard](https://manage.gocardless.com/success-plus).

*/ protected $retry_if_possible; /** - * The date on which the first payment should be charged. Must be on or - * after the [mandate](#core-endpoints-mandates)'s - * `next_possible_charge_date`. When left blank and `month` or - * `day_of_month` are provided, this will be set to the date of the first - * payment. If created without `month` or `day_of_month` this will be set - * as the mandate's `next_possible_charge_date` + * The date on which the first payment should be charged. Must be on or + * after the [mandate](#core-endpoints-mandates)'s + * `next_possible_charge_date`. When left blank and `month` or + * `day_of_month` are provided, this will be set to the date of the first + * payment. If created without `month` or `day_of_month` this will be set as + * the mandate's `next_possible_charge_date` */ protected $start_date; /** - * One of: - * + * One of: + * */ protected $status; /** - * Up to 10 upcoming payments with their amounts and charge dates. + * Up to 10 upcoming payments with their amounts and charge dates. */ protected $upcoming_payments; } diff --git a/lib/Resources/TaxRate.php b/lib/Resources/TaxRate.php index 7b3e65c7..7c1b40ff 100644 --- a/lib/Resources/TaxRate.php +++ b/lib/Resources/TaxRate.php @@ -24,34 +24,34 @@ class TaxRate extends BaseResource protected $model_name = "TaxRate"; /** - * Date at which GoCardless stopped applying the tax rate for the - * jurisdiction. + * Date at which GoCardless stopped applying the tax rate for the + * jurisdiction. */ protected $end_date; /** - * The unique identifier created by the jurisdiction, tax type and version + * The unique identifier created by the jurisdiction, tax type and version */ protected $id; /** - * The jurisdiction this tax rate applies to + * The jurisdiction this tax rate applies to */ protected $jurisdiction; /** - * The percentage of tax that is applied onto of GoCardless fees + * The percentage of tax that is applied onto of GoCardless fees */ protected $percentage; /** - * Date at which GoCardless started applying the tax rate in the - * jurisdiction. + * Date at which GoCardless started applying the tax rate in the + * jurisdiction. */ protected $start_date; /** - * The type of tax applied by this rate + * The type of tax applied by this rate */ protected $type; } diff --git a/lib/Resources/TransferredMandate.php b/lib/Resources/TransferredMandate.php index 7436b7d4..f304d51e 100644 --- a/lib/Resources/TransferredMandate.php +++ b/lib/Resources/TransferredMandate.php @@ -22,15 +22,15 @@ class TransferredMandate extends BaseResource protected $model_name = "TransferredMandate"; /** - * Encrypted customer bank account details, containing: - * `iban`, `account_holder_name`, `swift_bank_code`, `swift_branch_code`, - * `swift_account_number` + * Encrypted customer bank account details, containing: + * `iban`, `account_holder_name`, `swift_bank_code`, `swift_branch_code`, + * `swift_account_number` */ protected $encrypted_customer_bank_details; /** - * Random AES-256 key used to encrypt bank account details, itself - * encrypted with your public key. + * Random AES-256 key used to encrypt bank account details, itself encrypted + * with your public key. */ protected $encrypted_decryption_key; @@ -40,8 +40,8 @@ class TransferredMandate extends BaseResource protected $links; /** - * The ID of an RSA-2048 public key, from your JWKS, used to encrypt the - * AES key. + * The ID of an RSA-2048 public key, from your JWKS, used to encrypt the AES + * key. */ protected $public_key_id; } diff --git a/lib/Resources/VerificationDetail.php b/lib/Resources/VerificationDetail.php index 9801cf10..94ec5816 100644 --- a/lib/Resources/VerificationDetail.php +++ b/lib/Resources/VerificationDetail.php @@ -28,37 +28,37 @@ class VerificationDetail extends BaseResource protected $model_name = "VerificationDetail"; /** - * The first line of the company's address. + * The first line of the company's address. */ protected $address_line1; /** - * The second line of the company's address. + * The second line of the company's address. */ protected $address_line2; /** - * The third line of the company's address. + * The third line of the company's address. */ protected $address_line3; /** - * The city of the company's address. + * The city of the company's address. */ protected $city; /** - * The company's registration number. + * The company's registration number. */ protected $company_number; /** - * A summary describing what the company does. + * A summary describing what the company does. */ protected $description; /** - * The company's directors. + * The company's directors. */ protected $directors; @@ -68,12 +68,12 @@ class VerificationDetail extends BaseResource protected $links; /** - * The company's legal name. + * The company's legal name. */ protected $name; /** - * The company's postal code. + * The company's postal code. */ protected $postal_code; } diff --git a/lib/Resources/Webhook.php b/lib/Resources/Webhook.php index a86c343c..56766a41 100644 --- a/lib/Resources/Webhook.php +++ b/lib/Resources/Webhook.php @@ -31,68 +31,68 @@ class Webhook extends BaseResource protected $model_name = "Webhook"; /** - * Fixed [timestamp](#api-usage-dates-and-times), recording when this - * resource was created. + * Fixed [timestamp](#api-usage-dates-and-times), recording when this + * resource was created. */ protected $created_at; /** - * Unique identifier, beginning with "WB". + * Unique identifier, beginning with "WB". */ protected $id; /** - * Boolean value showing whether this was a demo webhook for testing + * Boolean value showing whether this was a demo webhook for testing */ protected $is_test; /** - * The body of the request sent to the webhook URL + * The body of the request sent to the webhook URL */ protected $request_body; /** - * The request headers sent with the webhook + * The request headers sent with the webhook */ protected $request_headers; /** - * The body of the response from the webhook URL + * The body of the response from the webhook URL */ protected $response_body; /** - * Boolean value indicating the webhook response body was truncated + * Boolean value indicating the webhook response body was truncated */ protected $response_body_truncated; /** - * The response code from the webhook request + * The response code from the webhook request */ protected $response_code; /** - * The headers sent with the response from the webhook URL + * The headers sent with the response from the webhook URL */ protected $response_headers; /** - * Boolean indicating the content of response headers was truncated + * Boolean indicating the content of response headers was truncated */ protected $response_headers_content_truncated; /** - * Boolean indicating the number of response headers was truncated + * Boolean indicating the number of response headers was truncated */ protected $response_headers_count_truncated; /** - * Boolean indicating whether the request was successful or failed + * Boolean indicating whether the request was successful or failed */ protected $successful; /** - * URL the webhook was POST-ed to + * URL the webhook was POST-ed to */ protected $url; } diff --git a/lib/Services/BalancesService.php b/lib/Services/BalancesService.php index 0573c7bd..6fc2a59b 100644 --- a/lib/Services/BalancesService.php +++ b/lib/Services/BalancesService.php @@ -27,7 +27,7 @@ class BalancesService extends BaseService /** - * List balances + * List balances * * Example URL: /balances * @@ -50,7 +50,7 @@ protected function _doList($params = array()) } /** - * List balances + * List balances * * Example URL: /balances * diff --git a/lib/Services/BankAccountDetailsService.php b/lib/Services/BankAccountDetailsService.php index 9c51068d..be874508 100644 --- a/lib/Services/BankAccountDetailsService.php +++ b/lib/Services/BankAccountDetailsService.php @@ -25,11 +25,11 @@ class BankAccountDetailsService extends BaseService /** - * Get encrypted bank details + * Get encrypted bank details * * Example URL: /bank_account_details/:identity * - * @param string $identity Unique identifier, beginning with "BA". + * @param string $identity Unique identifier, beginning with "BA". * @param array $params An associative array for any params * @return BankAccountDetail **/ diff --git a/lib/Services/BankAccountHolderVerificationsService.php b/lib/Services/BankAccountHolderVerificationsService.php index 0b14ddb6..ba56b1c2 100644 --- a/lib/Services/BankAccountHolderVerificationsService.php +++ b/lib/Services/BankAccountHolderVerificationsService.php @@ -25,7 +25,7 @@ class BankAccountHolderVerificationsService extends BaseService /** - * Create a bank account holder verification. + * Create a bank account holder verification. * * Example URL: /bank_account_holder_verifications * @@ -60,12 +60,12 @@ public function create($params = array()) } /** - * Get a bank account holder verification. + * Get a bank account holder verification. * * Example URL: /bank_account_holder_verifications/:identity * - * @param string $identity The unique identifier for the bank account holder - verification resource, e.g. "BAHV123". + * @param string $identity The unique identifier for the bank account holder + verification resource, e.g. "BAHV123". * @param array $params An associative array for any params * @return BankAccountHolderVerification **/ diff --git a/lib/Services/BankAuthorisationsService.php b/lib/Services/BankAuthorisationsService.php index 46e6741c..9b389c35 100644 --- a/lib/Services/BankAuthorisationsService.php +++ b/lib/Services/BankAuthorisationsService.php @@ -25,7 +25,7 @@ class BankAuthorisationsService extends BaseService /** - * Create a Bank Authorisation + * Create a Bank Authorisation * * Example URL: /bank_authorisations * @@ -60,11 +60,11 @@ public function create($params = array()) } /** - * Get a Bank Authorisation + * Get a Bank Authorisation * * Example URL: /bank_authorisations/:identity * - * @param string $identity Unique identifier, beginning with "BAU". + * @param string $identity Unique identifier, beginning with "BAU". * @param array $params An associative array for any params * @return BankAuthorisation **/ diff --git a/lib/Services/BankDetailsLookupsService.php b/lib/Services/BankDetailsLookupsService.php index 9d684f60..8047d60b 100644 --- a/lib/Services/BankDetailsLookupsService.php +++ b/lib/Services/BankDetailsLookupsService.php @@ -25,7 +25,7 @@ class BankDetailsLookupsService extends BaseService /** - * Perform a bank details lookup + * Perform a bank details lookup * * Example URL: /bank_details_lookups * diff --git a/lib/Services/BillingRequestFlowsService.php b/lib/Services/BillingRequestFlowsService.php index 39a02b90..42f62029 100644 --- a/lib/Services/BillingRequestFlowsService.php +++ b/lib/Services/BillingRequestFlowsService.php @@ -25,7 +25,7 @@ class BillingRequestFlowsService extends BaseService /** - * Create a Billing Request Flow + * Create a Billing Request Flow * * Example URL: /billing_request_flows * @@ -49,11 +49,11 @@ public function create($params = array()) } /** - * Initialise a Billing Request Flow + * Initialise a Billing Request Flow * * Example URL: /billing_request_flows/:identity/actions/initialise * - * @param string $identity Unique identifier, beginning with "BRF". + * @param string $identity Unique identifier, beginning with "BRF". * @param array $params An associative array for any params * @return BillingRequestFlow **/ diff --git a/lib/Services/BillingRequestTemplatesService.php b/lib/Services/BillingRequestTemplatesService.php index 388098aa..f6e7fde0 100644 --- a/lib/Services/BillingRequestTemplatesService.php +++ b/lib/Services/BillingRequestTemplatesService.php @@ -27,7 +27,7 @@ class BillingRequestTemplatesService extends BaseService /** - * List Billing Request Templates + * List Billing Request Templates * * Example URL: /billing_request_templates * @@ -50,11 +50,11 @@ protected function _doList($params = array()) } /** - * Get a single Billing Request Template + * Get a single Billing Request Template * * Example URL: /billing_request_templates/:identity * - * @param string $identity Unique identifier, beginning with "BRT". + * @param string $identity Unique identifier, beginning with "BRT". * @param array $params An associative array for any params * @return BillingRequestTemplate **/ @@ -80,7 +80,7 @@ public function get($identity, $params = array()) } /** - * Create a Billing Request Template + * Create a Billing Request Template * * Example URL: /billing_request_templates * @@ -115,11 +115,11 @@ public function create($params = array()) } /** - * Update a Billing Request Template + * Update a Billing Request Template * * Example URL: /billing_request_templates/:identity * - * @param string $identity Unique identifier, beginning with "BRT". + * @param string $identity Unique identifier, beginning with "BRT". * @param array $params An associative array for any params * @return BillingRequestTemplate **/ @@ -146,7 +146,7 @@ public function update($identity, $params = array()) } /** - * List Billing Request Templates + * List Billing Request Templates * * Example URL: /billing_request_templates * diff --git a/lib/Services/BillingRequestWithActionsService.php b/lib/Services/BillingRequestWithActionsService.php index 537acb51..b9efd8da 100644 --- a/lib/Services/BillingRequestWithActionsService.php +++ b/lib/Services/BillingRequestWithActionsService.php @@ -25,7 +25,7 @@ class BillingRequestWithActionsService extends BaseService /** - * Create a Billing Request with Actions + * Create a Billing Request with Actions * * Example URL: /billing_requests/create_with_actions * diff --git a/lib/Services/BillingRequestsService.php b/lib/Services/BillingRequestsService.php index c543f9f0..11a1b276 100644 --- a/lib/Services/BillingRequestsService.php +++ b/lib/Services/BillingRequestsService.php @@ -27,7 +27,7 @@ class BillingRequestsService extends BaseService /** - * Create a Billing Request + * Create a Billing Request * * Example URL: /billing_requests * @@ -62,11 +62,11 @@ public function create($params = array()) } /** - * Collect customer details + * Collect customer details * * Example URL: /billing_requests/:identity/actions/collect_customer_details * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return BillingRequest **/ @@ -104,11 +104,11 @@ public function collectCustomerDetails($identity, $params = array()) } /** - * Collect bank account details + * Collect bank account details * * Example URL: /billing_requests/:identity/actions/collect_bank_account * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return BillingRequest **/ @@ -146,11 +146,11 @@ public function collectBankAccount($identity, $params = array()) } /** - * Confirm the payer details + * Confirm the payer details * * Example URL: /billing_requests/:identity/actions/confirm_payer_details * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return BillingRequest **/ @@ -188,11 +188,11 @@ public function confirmPayerDetails($identity, $params = array()) } /** - * Fulfil a Billing Request + * Fulfil a Billing Request * * Example URL: /billing_requests/:identity/actions/fulfil * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return BillingRequest **/ @@ -230,11 +230,11 @@ public function fulfil($identity, $params = array()) } /** - * Cancel a Billing Request + * Cancel a Billing Request * * Example URL: /billing_requests/:identity/actions/cancel * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return BillingRequest **/ @@ -272,7 +272,7 @@ public function cancel($identity, $params = array()) } /** - * List Billing Requests + * List Billing Requests * * Example URL: /billing_requests * @@ -295,11 +295,11 @@ protected function _doList($params = array()) } /** - * Get a single Billing Request + * Get a single Billing Request * * Example URL: /billing_requests/:identity * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return BillingRequest **/ @@ -325,11 +325,11 @@ public function get($identity, $params = array()) } /** - * Notify the customer + * Notify the customer * * Example URL: /billing_requests/:identity/actions/notify * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return BillingRequest **/ @@ -367,11 +367,11 @@ public function notify($identity, $params = array()) } /** - * Trigger fallback + * Trigger fallback * * Example URL: /billing_requests/:identity/actions/fallback * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return BillingRequest **/ @@ -409,11 +409,11 @@ public function fallback($identity, $params = array()) } /** - * Change currency + * Change currency * * Example URL: /billing_requests/:identity/actions/choose_currency * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return BillingRequest **/ @@ -451,11 +451,11 @@ public function chooseCurrency($identity, $params = array()) } /** - * Select institution for a Billing Request + * Select institution for a Billing Request * * Example URL: /billing_requests/:identity/actions/select_institution * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return BillingRequest **/ @@ -493,7 +493,7 @@ public function selectInstitution($identity, $params = array()) } /** - * List Billing Requests + * List Billing Requests * * Example URL: /billing_requests * diff --git a/lib/Services/BlocksService.php b/lib/Services/BlocksService.php index c5b59ae4..fb24d1bd 100644 --- a/lib/Services/BlocksService.php +++ b/lib/Services/BlocksService.php @@ -27,7 +27,7 @@ class BlocksService extends BaseService /** - * Create a block + * Create a block * * Example URL: /blocks * @@ -62,11 +62,11 @@ public function create($params = array()) } /** - * Get a single block + * Get a single block * * Example URL: /blocks/:identity * - * @param string $identity Unique identifier, beginning with "BLC". + * @param string $identity Unique identifier, beginning with "BLC". * @param array $params An associative array for any params * @return Block **/ @@ -92,7 +92,7 @@ public function get($identity, $params = array()) } /** - * List multiple blocks + * List multiple blocks * * Example URL: /blocks * @@ -115,11 +115,11 @@ protected function _doList($params = array()) } /** - * Disable a block + * Disable a block * * Example URL: /blocks/:identity/actions/disable * - * @param string $identity Unique identifier, beginning with "BLC". + * @param string $identity Unique identifier, beginning with "BLC". * @param array $params An associative array for any params * @return Block **/ @@ -157,11 +157,11 @@ public function disable($identity, $params = array()) } /** - * Enable a block + * Enable a block * * Example URL: /blocks/:identity/actions/enable * - * @param string $identity Unique identifier, beginning with "BLC". + * @param string $identity Unique identifier, beginning with "BLC". * @param array $params An associative array for any params * @return Block **/ @@ -199,7 +199,7 @@ public function enable($identity, $params = array()) } /** - * Create blocks by reference + * Create blocks by reference * * Example URL: /blocks/block_by_ref * @@ -234,7 +234,7 @@ public function blockByRef($params = array()) } /** - * List multiple blocks + * List multiple blocks * * Example URL: /blocks * diff --git a/lib/Services/CreditorBankAccountsService.php b/lib/Services/CreditorBankAccountsService.php index 9ca649ee..aae52dc0 100644 --- a/lib/Services/CreditorBankAccountsService.php +++ b/lib/Services/CreditorBankAccountsService.php @@ -27,7 +27,7 @@ class CreditorBankAccountsService extends BaseService /** - * Create a creditor bank account + * Create a creditor bank account * * Example URL: /creditor_bank_accounts * @@ -62,7 +62,7 @@ public function create($params = array()) } /** - * List creditor bank accounts + * List creditor bank accounts * * Example URL: /creditor_bank_accounts * @@ -85,11 +85,11 @@ protected function _doList($params = array()) } /** - * Get a single creditor bank account + * Get a single creditor bank account * * Example URL: /creditor_bank_accounts/:identity * - * @param string $identity Unique identifier, beginning with "BA". + * @param string $identity Unique identifier, beginning with "BA". * @param array $params An associative array for any params * @return CreditorBankAccount **/ @@ -115,11 +115,11 @@ public function get($identity, $params = array()) } /** - * Disable a creditor bank account + * Disable a creditor bank account * * Example URL: /creditor_bank_accounts/:identity/actions/disable * - * @param string $identity Unique identifier, beginning with "BA". + * @param string $identity Unique identifier, beginning with "BA". * @param array $params An associative array for any params * @return CreditorBankAccount **/ @@ -157,7 +157,7 @@ public function disable($identity, $params = array()) } /** - * List creditor bank accounts + * List creditor bank accounts * * Example URL: /creditor_bank_accounts * diff --git a/lib/Services/CreditorsService.php b/lib/Services/CreditorsService.php index 80cfa724..508290dd 100644 --- a/lib/Services/CreditorsService.php +++ b/lib/Services/CreditorsService.php @@ -27,7 +27,7 @@ class CreditorsService extends BaseService /** - * Create a creditor + * Create a creditor * * Example URL: /creditors * @@ -62,7 +62,7 @@ public function create($params = array()) } /** - * List creditors + * List creditors * * Example URL: /creditors * @@ -85,11 +85,11 @@ protected function _doList($params = array()) } /** - * Get a single creditor + * Get a single creditor * * Example URL: /creditors/:identity * - * @param string $identity Unique identifier, beginning with "CR". + * @param string $identity Unique identifier, beginning with "CR". * @param array $params An associative array for any params * @return Creditor **/ @@ -115,11 +115,11 @@ public function get($identity, $params = array()) } /** - * Update a creditor + * Update a creditor * * Example URL: /creditors/:identity * - * @param string $identity Unique identifier, beginning with "CR". + * @param string $identity Unique identifier, beginning with "CR". * @param array $params An associative array for any params * @return Creditor **/ @@ -146,7 +146,7 @@ public function update($identity, $params = array()) } /** - * List creditors + * List creditors * * Example URL: /creditors * diff --git a/lib/Services/CurrencyExchangeRatesService.php b/lib/Services/CurrencyExchangeRatesService.php index bfb4d0a4..3f036d54 100644 --- a/lib/Services/CurrencyExchangeRatesService.php +++ b/lib/Services/CurrencyExchangeRatesService.php @@ -27,7 +27,7 @@ class CurrencyExchangeRatesService extends BaseService /** - * List exchange rates + * List exchange rates * * Example URL: /currency_exchange_rates * @@ -50,7 +50,7 @@ protected function _doList($params = array()) } /** - * List exchange rates + * List exchange rates * * Example URL: /currency_exchange_rates * diff --git a/lib/Services/CustomerBankAccountsService.php b/lib/Services/CustomerBankAccountsService.php index 59b3361e..334274ca 100644 --- a/lib/Services/CustomerBankAccountsService.php +++ b/lib/Services/CustomerBankAccountsService.php @@ -27,7 +27,7 @@ class CustomerBankAccountsService extends BaseService /** - * Create a customer bank account + * Create a customer bank account * * Example URL: /customer_bank_accounts * @@ -62,7 +62,7 @@ public function create($params = array()) } /** - * List customer bank accounts + * List customer bank accounts * * Example URL: /customer_bank_accounts * @@ -85,11 +85,11 @@ protected function _doList($params = array()) } /** - * Get a single customer bank account + * Get a single customer bank account * * Example URL: /customer_bank_accounts/:identity * - * @param string $identity Unique identifier, beginning with "BA". + * @param string $identity Unique identifier, beginning with "BA". * @param array $params An associative array for any params * @return CustomerBankAccount **/ @@ -115,11 +115,11 @@ public function get($identity, $params = array()) } /** - * Update a customer bank account + * Update a customer bank account * * Example URL: /customer_bank_accounts/:identity * - * @param string $identity Unique identifier, beginning with "BA". + * @param string $identity Unique identifier, beginning with "BA". * @param array $params An associative array for any params * @return CustomerBankAccount **/ @@ -146,11 +146,11 @@ public function update($identity, $params = array()) } /** - * Disable a customer bank account + * Disable a customer bank account * * Example URL: /customer_bank_accounts/:identity/actions/disable * - * @param string $identity Unique identifier, beginning with "BA". + * @param string $identity Unique identifier, beginning with "BA". * @param array $params An associative array for any params * @return CustomerBankAccount **/ @@ -188,7 +188,7 @@ public function disable($identity, $params = array()) } /** - * List customer bank accounts + * List customer bank accounts * * Example URL: /customer_bank_accounts * diff --git a/lib/Services/CustomerNotificationsService.php b/lib/Services/CustomerNotificationsService.php index 77b6940b..bd6a12b9 100644 --- a/lib/Services/CustomerNotificationsService.php +++ b/lib/Services/CustomerNotificationsService.php @@ -25,11 +25,11 @@ class CustomerNotificationsService extends BaseService /** - * Handle a notification + * Handle a notification * * Example URL: /customer_notifications/:identity/actions/handle * - * @param string $identity The id of the notification. + * @param string $identity The id of the notification. * @param array $params An associative array for any params * @return CustomerNotification **/ diff --git a/lib/Services/CustomersService.php b/lib/Services/CustomersService.php index 64c05d8e..31fcd019 100644 --- a/lib/Services/CustomersService.php +++ b/lib/Services/CustomersService.php @@ -27,7 +27,7 @@ class CustomersService extends BaseService /** - * Create a customer + * Create a customer * * Example URL: /customers * @@ -62,7 +62,7 @@ public function create($params = array()) } /** - * List customers + * List customers * * Example URL: /customers * @@ -85,11 +85,11 @@ protected function _doList($params = array()) } /** - * Get a single customer + * Get a single customer * * Example URL: /customers/:identity * - * @param string $identity Unique identifier, beginning with "CU". + * @param string $identity Unique identifier, beginning with "CU". * @param array $params An associative array for any params * @return Customer **/ @@ -115,11 +115,11 @@ public function get($identity, $params = array()) } /** - * Update a customer + * Update a customer * * Example URL: /customers/:identity * - * @param string $identity Unique identifier, beginning with "CU". + * @param string $identity Unique identifier, beginning with "CU". * @param array $params An associative array for any params * @return Customer **/ @@ -146,11 +146,11 @@ public function update($identity, $params = array()) } /** - * Remove a customer + * Remove a customer * * Example URL: /customers/:identity * - * @param string $identity Unique identifier, beginning with "CU". + * @param string $identity Unique identifier, beginning with "CU". * @param array $params An associative array for any params * @return Customer **/ @@ -176,7 +176,7 @@ public function remove($identity, $params = array()) } /** - * List customers + * List customers * * Example URL: /customers * diff --git a/lib/Services/EventsService.php b/lib/Services/EventsService.php index 8f6fa144..9a0e3fcf 100644 --- a/lib/Services/EventsService.php +++ b/lib/Services/EventsService.php @@ -27,7 +27,7 @@ class EventsService extends BaseService /** - * List events + * List events * * Example URL: /events * @@ -50,11 +50,11 @@ protected function _doList($params = array()) } /** - * Get a single event + * Get a single event * * Example URL: /events/:identity * - * @param string $identity Unique identifier, beginning with "EV". + * @param string $identity Unique identifier, beginning with "EV". * @param array $params An associative array for any params * @return Event **/ @@ -80,7 +80,7 @@ public function get($identity, $params = array()) } /** - * List events + * List events * * Example URL: /events * diff --git a/lib/Services/ExportsService.php b/lib/Services/ExportsService.php index 689f6ec2..3a760c43 100644 --- a/lib/Services/ExportsService.php +++ b/lib/Services/ExportsService.php @@ -27,11 +27,11 @@ class ExportsService extends BaseService /** - * Get a single export + * Get a single export * * Example URL: /exports/:identity * - * @param string $identity Unique identifier, beginning with "EX". + * @param string $identity Unique identifier, beginning with "EX". * @param array $params An associative array for any params * @return Export **/ @@ -57,7 +57,7 @@ public function get($identity, $params = array()) } /** - * List exports + * List exports * * Example URL: /exports * @@ -80,7 +80,7 @@ protected function _doList($params = array()) } /** - * List exports + * List exports * * Example URL: /exports * diff --git a/lib/Services/FundsAvailabilitiesService.php b/lib/Services/FundsAvailabilitiesService.php index bd971319..75cf4399 100644 --- a/lib/Services/FundsAvailabilitiesService.php +++ b/lib/Services/FundsAvailabilitiesService.php @@ -25,12 +25,12 @@ class FundsAvailabilitiesService extends BaseService /** - * Funds availability + * Funds availability * * Example URL: /funds_availability/:identity * - * @param string $identity Unique identifier, beginning with "MD". Note that this - prefix may not apply to mandates created before 2016. + * @param string $identity Unique identifier, beginning with "MD". Note that this + prefix may not apply to mandates created before 2016. * @param array $params An associative array for any params * @return FundsAvailability **/ diff --git a/lib/Services/InstalmentSchedulesService.php b/lib/Services/InstalmentSchedulesService.php index 75984df9..9f50d0ef 100644 --- a/lib/Services/InstalmentSchedulesService.php +++ b/lib/Services/InstalmentSchedulesService.php @@ -27,7 +27,7 @@ class InstalmentSchedulesService extends BaseService /** - * Create (with dates) + * Create (with dates) * * Example URL: /instalment_schedules * @@ -62,7 +62,7 @@ public function createWithDates($params = array()) } /** - * Create (with schedule) + * Create (with schedule) * * Example URL: /instalment_schedules * @@ -97,7 +97,7 @@ public function createWithSchedule($params = array()) } /** - * List instalment schedules + * List instalment schedules * * Example URL: /instalment_schedules * @@ -120,11 +120,11 @@ protected function _doList($params = array()) } /** - * Get a single instalment schedule + * Get a single instalment schedule * * Example URL: /instalment_schedules/:identity * - * @param string $identity Unique identifier, beginning with "IS". + * @param string $identity Unique identifier, beginning with "IS". * @param array $params An associative array for any params * @return InstalmentSchedule **/ @@ -150,11 +150,11 @@ public function get($identity, $params = array()) } /** - * Update an instalment schedule + * Update an instalment schedule * * Example URL: /instalment_schedules/:identity * - * @param string $identity Unique identifier, beginning with "IS". + * @param string $identity Unique identifier, beginning with "IS". * @param array $params An associative array for any params * @return InstalmentSchedule **/ @@ -181,11 +181,11 @@ public function update($identity, $params = array()) } /** - * Cancel an instalment schedule + * Cancel an instalment schedule * * Example URL: /instalment_schedules/:identity/actions/cancel * - * @param string $identity Unique identifier, beginning with "IS". + * @param string $identity Unique identifier, beginning with "IS". * @param array $params An associative array for any params * @return InstalmentSchedule **/ @@ -223,7 +223,7 @@ public function cancel($identity, $params = array()) } /** - * List instalment schedules + * List instalment schedules * * Example URL: /instalment_schedules * diff --git a/lib/Services/InstitutionsService.php b/lib/Services/InstitutionsService.php index 7e995f79..824fd01b 100644 --- a/lib/Services/InstitutionsService.php +++ b/lib/Services/InstitutionsService.php @@ -27,7 +27,7 @@ class InstitutionsService extends BaseService /** - * List Institutions + * List Institutions * * Example URL: /institutions * @@ -50,11 +50,11 @@ protected function _doList($params = array()) } /** - * List institutions for Billing Request + * List institutions for Billing Request * * Example URL: /billing_requests/:identity/institutions * - * @param string $identity Unique identifier, beginning with "BRQ". + * @param string $identity Unique identifier, beginning with "BRQ". * @param array $params An associative array for any params * @return ListResponse **/ @@ -80,7 +80,7 @@ public function listForBillingRequest($identity, $params = array()) } /** - * List Institutions + * List Institutions * * Example URL: /institutions * diff --git a/lib/Services/LogosService.php b/lib/Services/LogosService.php index a5b82116..60a180ee 100644 --- a/lib/Services/LogosService.php +++ b/lib/Services/LogosService.php @@ -25,7 +25,7 @@ class LogosService extends BaseService /** - * Create a logo associated with a creditor + * Create a logo associated with a creditor * * Example URL: /branding/logos * diff --git a/lib/Services/MandateImportEntriesService.php b/lib/Services/MandateImportEntriesService.php index 316b5746..eabcace4 100644 --- a/lib/Services/MandateImportEntriesService.php +++ b/lib/Services/MandateImportEntriesService.php @@ -27,7 +27,7 @@ class MandateImportEntriesService extends BaseService /** - * Add a mandate import entry + * Add a mandate import entry * * Example URL: /mandate_import_entries * @@ -51,7 +51,7 @@ public function create($params = array()) } /** - * List all mandate import entries + * List all mandate import entries * * Example URL: /mandate_import_entries * @@ -74,7 +74,7 @@ protected function _doList($params = array()) } /** - * List all mandate import entries + * List all mandate import entries * * Example URL: /mandate_import_entries * diff --git a/lib/Services/MandateImportsService.php b/lib/Services/MandateImportsService.php index 77579ce9..369a6f30 100644 --- a/lib/Services/MandateImportsService.php +++ b/lib/Services/MandateImportsService.php @@ -25,7 +25,7 @@ class MandateImportsService extends BaseService /** - * Create a new mandate import + * Create a new mandate import * * Example URL: /mandate_imports * @@ -60,11 +60,11 @@ public function create($params = array()) } /** - * Get a mandate import + * Get a mandate import * * Example URL: /mandate_imports/:identity * - * @param string $identity Unique identifier, beginning with "IM". + * @param string $identity Unique identifier, beginning with "IM". * @param array $params An associative array for any params * @return MandateImport **/ @@ -90,11 +90,11 @@ public function get($identity, $params = array()) } /** - * Submit a mandate import + * Submit a mandate import * * Example URL: /mandate_imports/:identity/actions/submit * - * @param string $identity Unique identifier, beginning with "IM". + * @param string $identity Unique identifier, beginning with "IM". * @param array $params An associative array for any params * @return MandateImport **/ @@ -132,11 +132,11 @@ public function submit($identity, $params = array()) } /** - * Cancel a mandate import + * Cancel a mandate import * * Example URL: /mandate_imports/:identity/actions/cancel * - * @param string $identity Unique identifier, beginning with "IM". + * @param string $identity Unique identifier, beginning with "IM". * @param array $params An associative array for any params * @return MandateImport **/ diff --git a/lib/Services/MandatePdfsService.php b/lib/Services/MandatePdfsService.php index 57a2417e..672d42f0 100644 --- a/lib/Services/MandatePdfsService.php +++ b/lib/Services/MandatePdfsService.php @@ -25,7 +25,7 @@ class MandatePdfsService extends BaseService /** - * Create a mandate PDF + * Create a mandate PDF * * Example URL: /mandate_pdfs * diff --git a/lib/Services/MandatesService.php b/lib/Services/MandatesService.php index b1f53d08..84bfc077 100644 --- a/lib/Services/MandatesService.php +++ b/lib/Services/MandatesService.php @@ -27,7 +27,7 @@ class MandatesService extends BaseService /** - * Create a mandate + * Create a mandate * * Example URL: /mandates * @@ -62,7 +62,7 @@ public function create($params = array()) } /** - * List mandates + * List mandates * * Example URL: /mandates * @@ -85,12 +85,12 @@ protected function _doList($params = array()) } /** - * Get a single mandate + * Get a single mandate * * Example URL: /mandates/:identity * - * @param string $identity Unique identifier, beginning with "MD". Note that this - prefix may not apply to mandates created before 2016. + * @param string $identity Unique identifier, beginning with "MD". Note that this + prefix may not apply to mandates created before 2016. * @param array $params An associative array for any params * @return Mandate **/ @@ -116,12 +116,12 @@ public function get($identity, $params = array()) } /** - * Update a mandate + * Update a mandate * * Example URL: /mandates/:identity * - * @param string $identity Unique identifier, beginning with "MD". Note that this - prefix may not apply to mandates created before 2016. + * @param string $identity Unique identifier, beginning with "MD". Note that this + prefix may not apply to mandates created before 2016. * @param array $params An associative array for any params * @return Mandate **/ @@ -148,12 +148,12 @@ public function update($identity, $params = array()) } /** - * Cancel a mandate + * Cancel a mandate * * Example URL: /mandates/:identity/actions/cancel * - * @param string $identity Unique identifier, beginning with "MD". Note that this - prefix may not apply to mandates created before 2016. + * @param string $identity Unique identifier, beginning with "MD". Note that this + prefix may not apply to mandates created before 2016. * @param array $params An associative array for any params * @return Mandate **/ @@ -191,12 +191,12 @@ public function cancel($identity, $params = array()) } /** - * Reinstate a mandate + * Reinstate a mandate * * Example URL: /mandates/:identity/actions/reinstate * - * @param string $identity Unique identifier, beginning with "MD". Note that this - prefix may not apply to mandates created before 2016. + * @param string $identity Unique identifier, beginning with "MD". Note that this + prefix may not apply to mandates created before 2016. * @param array $params An associative array for any params * @return Mandate **/ @@ -234,7 +234,7 @@ public function reinstate($identity, $params = array()) } /** - * List mandates + * List mandates * * Example URL: /mandates * diff --git a/lib/Services/NegativeBalanceLimitsService.php b/lib/Services/NegativeBalanceLimitsService.php index 6bebb1d7..e254c0bf 100644 --- a/lib/Services/NegativeBalanceLimitsService.php +++ b/lib/Services/NegativeBalanceLimitsService.php @@ -27,7 +27,7 @@ class NegativeBalanceLimitsService extends BaseService /** - * List negative balance limits + * List negative balance limits * * Example URL: /negative_balance_limits * @@ -50,7 +50,7 @@ protected function _doList($params = array()) } /** - * List negative balance limits + * List negative balance limits * * Example URL: /negative_balance_limits * diff --git a/lib/Services/OutboundPaymentsService.php b/lib/Services/OutboundPaymentsService.php index 5855d8da..e85fb516 100644 --- a/lib/Services/OutboundPaymentsService.php +++ b/lib/Services/OutboundPaymentsService.php @@ -27,7 +27,7 @@ class OutboundPaymentsService extends BaseService /** - * Create an outbound payment + * Create an outbound payment * * Example URL: /outbound_payments * @@ -62,7 +62,7 @@ public function create($params = array()) } /** - * Create a withdrawal outbound payment + * Create a withdrawal outbound payment * * Example URL: /outbound_payments/withdrawal * @@ -97,11 +97,11 @@ public function withdraw($params = array()) } /** - * Cancel an outbound payment + * Cancel an outbound payment * * Example URL: /outbound_payments/:identity/actions/cancel * - * @param string $identity Unique identifier of the outbound payment. + * @param string $identity Unique identifier of the outbound payment. * @param array $params An associative array for any params * @return OutboundPayment **/ @@ -139,11 +139,11 @@ public function cancel($identity, $params = array()) } /** - * Approve an outbound payment + * Approve an outbound payment * * Example URL: /outbound_payments/:identity/actions/approve * - * @param string $identity Unique identifier of the outbound payment. + * @param string $identity Unique identifier of the outbound payment. * @param array $params An associative array for any params * @return OutboundPayment **/ @@ -181,11 +181,11 @@ public function approve($identity, $params = array()) } /** - * Get an outbound payment + * Get an outbound payment * * Example URL: /outbound_payments/:identity * - * @param string $identity Unique identifier of the outbound payment. + * @param string $identity Unique identifier of the outbound payment. * @param array $params An associative array for any params * @return OutboundPayment **/ @@ -211,7 +211,7 @@ public function get($identity, $params = array()) } /** - * List outbound payments + * List outbound payments * * Example URL: /outbound_payments * @@ -234,11 +234,11 @@ protected function _doList($params = array()) } /** - * Update an outbound payment + * Update an outbound payment * * Example URL: /outbound_payments/:identity * - * @param string $identity Unique identifier of the outbound payment. + * @param string $identity Unique identifier of the outbound payment. * @param array $params An associative array for any params * @return OutboundPayment **/ @@ -265,7 +265,7 @@ public function update($identity, $params = array()) } /** - * Outbound payment statistics + * Outbound payment statistics * * Example URL: /outbound_payments/stats * @@ -288,7 +288,7 @@ public function stats($params = array()) } /** - * List outbound payments + * List outbound payments * * Example URL: /outbound_payments * diff --git a/lib/Services/PayerAuthorisationsService.php b/lib/Services/PayerAuthorisationsService.php index 5ad65713..29798961 100644 --- a/lib/Services/PayerAuthorisationsService.php +++ b/lib/Services/PayerAuthorisationsService.php @@ -25,11 +25,11 @@ class PayerAuthorisationsService extends BaseService /** - * Get a single Payer Authorisation + * Get a single Payer Authorisation * * Example URL: /payer_authorisations/:identity * - * @param string $identity Unique identifier, beginning with "PA". + * @param string $identity Unique identifier, beginning with "PA". * @param array $params An associative array for any params * @return PayerAuthorisation **/ @@ -55,7 +55,7 @@ public function get($identity, $params = array()) } /** - * Create a Payer Authorisation + * Create a Payer Authorisation * * Example URL: /payer_authorisations * @@ -90,11 +90,11 @@ public function create($params = array()) } /** - * Update a Payer Authorisation + * Update a Payer Authorisation * * Example URL: /payer_authorisations/:identity * - * @param string $identity Unique identifier, beginning with "PA". + * @param string $identity Unique identifier, beginning with "PA". * @param array $params An associative array for any params * @return PayerAuthorisation **/ @@ -121,11 +121,11 @@ public function update($identity, $params = array()) } /** - * Submit a Payer Authorisation + * Submit a Payer Authorisation * * Example URL: /payer_authorisations/:identity/actions/submit * - * @param string $identity Unique identifier, beginning with "PA". + * @param string $identity Unique identifier, beginning with "PA". * @param array $params An associative array for any params * @return PayerAuthorisation **/ @@ -163,11 +163,11 @@ public function submit($identity, $params = array()) } /** - * Confirm a Payer Authorisation + * Confirm a Payer Authorisation * * Example URL: /payer_authorisations/:identity/actions/confirm * - * @param string $identity Unique identifier, beginning with "PA". + * @param string $identity Unique identifier, beginning with "PA". * @param array $params An associative array for any params * @return PayerAuthorisation **/ diff --git a/lib/Services/PayerThemesService.php b/lib/Services/PayerThemesService.php index 3330ad88..00d66a95 100644 --- a/lib/Services/PayerThemesService.php +++ b/lib/Services/PayerThemesService.php @@ -25,7 +25,7 @@ class PayerThemesService extends BaseService /** - * Create a payer theme associated with a creditor + * Create a payer theme associated with a creditor * * Example URL: /branding/payer_themes * diff --git a/lib/Services/PaymentAccountTransactionsService.php b/lib/Services/PaymentAccountTransactionsService.php index 0995f551..46504709 100644 --- a/lib/Services/PaymentAccountTransactionsService.php +++ b/lib/Services/PaymentAccountTransactionsService.php @@ -27,13 +27,13 @@ class PaymentAccountTransactionsService extends BaseService /** - * List payment account transactions + * List payment account transactions * * Example URL: /payment_accounts/:identity/transactions * - * @param string $identity The unique ID of the [bank - account](#core-endpoints-creditor-bank-accounts) which - happens to be the payment account. + * @param string $identity The unique ID of the [bank + account](#core-endpoints-creditor-bank-accounts) which + happens to be the payment account. * @param array $params An associative array for any params * @return ListResponse **/ @@ -59,7 +59,7 @@ protected function _doList($identity, $params = array()) } /** - * List payment account transactions + * List payment account transactions * * Example URL: /payment_accounts/:identity/transactions * diff --git a/lib/Services/PaymentAccountsService.php b/lib/Services/PaymentAccountsService.php index 41f1866d..3f98bbb7 100644 --- a/lib/Services/PaymentAccountsService.php +++ b/lib/Services/PaymentAccountsService.php @@ -27,11 +27,11 @@ class PaymentAccountsService extends BaseService /** - * Get a single payment account details + * Get a single payment account details * * Example URL: /payment_accounts/:identity * - * @param string $identity Unique identifier, beginning with "BA". + * @param string $identity Unique identifier, beginning with "BA". * @param array $params An associative array for any params * @return PaymentAccount **/ @@ -57,7 +57,7 @@ public function get($identity, $params = array()) } /** - * List payment accounts + * List payment accounts * * Example URL: /payment_accounts * @@ -80,7 +80,7 @@ protected function _doList($params = array()) } /** - * List payment accounts + * List payment accounts * * Example URL: /payment_accounts * diff --git a/lib/Services/PaymentsService.php b/lib/Services/PaymentsService.php index 7e7048a5..a4bd2c9b 100644 --- a/lib/Services/PaymentsService.php +++ b/lib/Services/PaymentsService.php @@ -27,7 +27,7 @@ class PaymentsService extends BaseService /** - * Create a payment + * Create a payment * * Example URL: /payments * @@ -62,7 +62,7 @@ public function create($params = array()) } /** - * List payments + * List payments * * Example URL: /payments * @@ -85,11 +85,11 @@ protected function _doList($params = array()) } /** - * Get a single payment + * Get a single payment * * Example URL: /payments/:identity * - * @param string $identity Unique identifier, beginning with "PM". + * @param string $identity Unique identifier, beginning with "PM". * @param array $params An associative array for any params * @return Payment **/ @@ -115,11 +115,11 @@ public function get($identity, $params = array()) } /** - * Update a payment + * Update a payment * * Example URL: /payments/:identity * - * @param string $identity Unique identifier, beginning with "PM". + * @param string $identity Unique identifier, beginning with "PM". * @param array $params An associative array for any params * @return Payment **/ @@ -146,11 +146,11 @@ public function update($identity, $params = array()) } /** - * Cancel a payment + * Cancel a payment * * Example URL: /payments/:identity/actions/cancel * - * @param string $identity Unique identifier, beginning with "PM". + * @param string $identity Unique identifier, beginning with "PM". * @param array $params An associative array for any params * @return Payment **/ @@ -188,11 +188,11 @@ public function cancel($identity, $params = array()) } /** - * Retry a payment + * Retry a payment * * Example URL: /payments/:identity/actions/retry * - * @param string $identity Unique identifier, beginning with "PM". + * @param string $identity Unique identifier, beginning with "PM". * @param array $params An associative array for any params * @return Payment **/ @@ -230,7 +230,7 @@ public function retry($identity, $params = array()) } /** - * List payments + * List payments * * Example URL: /payments * diff --git a/lib/Services/PayoutItemsService.php b/lib/Services/PayoutItemsService.php index 3d8f56fa..3f88c2b8 100644 --- a/lib/Services/PayoutItemsService.php +++ b/lib/Services/PayoutItemsService.php @@ -27,7 +27,7 @@ class PayoutItemsService extends BaseService /** - * Get all payout items in a single payout + * Get all payout items in a single payout * * Example URL: /payout_items * @@ -50,7 +50,7 @@ protected function _doList($params = array()) } /** - * Get all payout items in a single payout + * Get all payout items in a single payout * * Example URL: /payout_items * diff --git a/lib/Services/PayoutsService.php b/lib/Services/PayoutsService.php index f0f9f811..d2de57d4 100644 --- a/lib/Services/PayoutsService.php +++ b/lib/Services/PayoutsService.php @@ -27,7 +27,7 @@ class PayoutsService extends BaseService /** - * List payouts + * List payouts * * Example URL: /payouts * @@ -50,11 +50,11 @@ protected function _doList($params = array()) } /** - * Get a single payout + * Get a single payout * * Example URL: /payouts/:identity * - * @param string $identity Unique identifier, beginning with "PO". + * @param string $identity Unique identifier, beginning with "PO". * @param array $params An associative array for any params * @return Payout **/ @@ -80,11 +80,11 @@ public function get($identity, $params = array()) } /** - * Update a payout + * Update a payout * * Example URL: /payouts/:identity * - * @param string $identity Unique identifier, beginning with "PO". + * @param string $identity Unique identifier, beginning with "PO". * @param array $params An associative array for any params * @return Payout **/ @@ -111,7 +111,7 @@ public function update($identity, $params = array()) } /** - * List payouts + * List payouts * * Example URL: /payouts * diff --git a/lib/Services/RedirectFlowsService.php b/lib/Services/RedirectFlowsService.php index a719dda5..d29c8995 100644 --- a/lib/Services/RedirectFlowsService.php +++ b/lib/Services/RedirectFlowsService.php @@ -25,7 +25,7 @@ class RedirectFlowsService extends BaseService /** - * Create a redirect flow + * Create a redirect flow * * Example URL: /redirect_flows * @@ -60,11 +60,11 @@ public function create($params = array()) } /** - * Get a single redirect flow + * Get a single redirect flow * * Example URL: /redirect_flows/:identity * - * @param string $identity Unique identifier, beginning with "RE". + * @param string $identity Unique identifier, beginning with "RE". * @param array $params An associative array for any params * @return RedirectFlow **/ @@ -90,11 +90,11 @@ public function get($identity, $params = array()) } /** - * Complete a redirect flow + * Complete a redirect flow * * Example URL: /redirect_flows/:identity/actions/complete * - * @param string $identity Unique identifier, beginning with "RE". + * @param string $identity Unique identifier, beginning with "RE". * @param array $params An associative array for any params * @return RedirectFlow **/ diff --git a/lib/Services/RefundsService.php b/lib/Services/RefundsService.php index b593cc3a..0f5e6e8c 100644 --- a/lib/Services/RefundsService.php +++ b/lib/Services/RefundsService.php @@ -27,7 +27,7 @@ class RefundsService extends BaseService /** - * Create a refund + * Create a refund * * Example URL: /refunds * @@ -62,7 +62,7 @@ public function create($params = array()) } /** - * List refunds + * List refunds * * Example URL: /refunds * @@ -85,11 +85,11 @@ protected function _doList($params = array()) } /** - * Get a single refund + * Get a single refund * * Example URL: /refunds/:identity * - * @param string $identity Unique identifier, beginning with "RF". + * @param string $identity Unique identifier, beginning with "RF". * @param array $params An associative array for any params * @return Refund **/ @@ -115,11 +115,11 @@ public function get($identity, $params = array()) } /** - * Update a refund + * Update a refund * * Example URL: /refunds/:identity * - * @param string $identity Unique identifier, beginning with "RF". + * @param string $identity Unique identifier, beginning with "RF". * @param array $params An associative array for any params * @return Refund **/ @@ -146,7 +146,7 @@ public function update($identity, $params = array()) } /** - * List refunds + * List refunds * * Example URL: /refunds * diff --git a/lib/Services/ScenarioSimulatorsService.php b/lib/Services/ScenarioSimulatorsService.php index ebcf1fd7..834449d5 100644 --- a/lib/Services/ScenarioSimulatorsService.php +++ b/lib/Services/ScenarioSimulatorsService.php @@ -25,171 +25,168 @@ class ScenarioSimulatorsService extends BaseService /** - * Simulate a scenario + * Simulate a scenario * * Example URL: /scenario_simulators/:identity/actions/run * - * @param string $identity The unique identifier of the simulator, used to initiate - simulations. One of: -
    -
  • `creditor_verification_status_action_required`: Sets a - creditor's `verification status` to `action required`, - meaning that the creditor must provide further information - to GoCardless in order to verify their account to receive - payouts.
    • -
  • `creditor_verification_status_in_review`: Sets a - creditor's `verification status` to `in review`, meaning - that the creditor has provided all of the information - requested by GoCardless to verify their account, and is - now awaiting review.
    • -
  • `creditor_verification_status_successful`: Sets a - creditor's `verification status` to `successful`, meaning - that the creditor is fully verified and can receive - payouts.
    • -
  • `payment_confirmed`: Transitions a payment through to - `confirmed`. It must start in the `pending_submission` - state, and its mandate must be in the `activated` state - (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in - which cases the mandate may be `pending_submission`, since - their mandates are submitted with their first - payment).
    • -
  • `payment_paid_out`: Transitions a payment through to - `paid_out`, having been collected successfully and paid - out to you. It must start in the `pending_submission` - state, and its mandate must be in the `activated` state - (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in - which cases the mandate may be `pending_submission`, since - their mandates are submitted with their first - payment).
    • -
  • `payment_failed`: Transitions a payment through to - `failed`. It must start in the `pending_submission` state, - and its mandate must be in the `activated` state (unless - it is a payment for ACH, BECS, BECS_NZ or SEPA, in which - cases the mandate may be `pending_submission`, since their - mandates are submitted with their first payment).
    • -
  • `payment_charged_back`: Behaves the same as the - `payout_paid_out` simulator, except that the payment is - transitioned to `charged_back` after it is paid out, - having been charged back by the customer.
    • -
  • `payment_chargeback_settled`: Behaves the same as the - `payment_charged_back` simulator, except that the charged - back payment is additionally included as a debit item in a - payout, thereby settling the charged back payment.
    • -
  • `payment_late_failure`: Transitions a payment through - to `late_failure`, having been apparently collected - successfully beforehand. It must start in either the - `pending_submission` or `paid_out` state, and its mandate - must be in the `activated` state (unless it is a payment - for ACH, BECS, BECS_NZ or SEPA, in which cases the mandate - may be `pending_submission`, since their mandates are - submitted with their first payment). Not compatible with - Autogiro mandates.
    • -
  • `payment_late_failure_settled`: Behaves the same as - the `payment_late_failure` simulator, except that the late - failure is additionally included as a debit item in a - payout, thereby settling the late failure.
    • -
  • `payment_submitted`: Transitions a payment to - `submitted`, without proceeding any further. It must start - in the `pending_submission` state.
    • -
  • `mandate_activated`: Transitions a mandate through to - `activated`, having been submitted to the banks and set up - successfully. It must start in the `pending_submission` - state. Not compatible with ACH, BECS, BECS_NZ and SEPA - mandates, which are submitted and activated with their - first payment.
    • -
  • `mandate_customer_approval_granted`: Transitions a - mandate through to `pending_submission`, as if the - customer approved the mandate creation. It must start in - the `pending_customer_approval` state. Compatible only - with Bacs and SEPA mandates, which support customer - signatures on the mandate. All payments associated with - the mandate will be transitioned to `pending_submission`. - All subscriptions associated with the mandate will become - `active`.
    • -
  • `mandate_customer_approval_skipped`: Transitions a - mandate through to `pending_submission`, as if the - customer skipped the mandate approval during the mandate - creation process. It must start in the - `pending_customer_approval` state. Compatible only with - Bacs and SEPA mandates, which support customer signatures - on the mandate. All payments associated with the mandate - will be transitioned to `pending_submission`. All - subscriptions associated with the mandate will become - `active`.
    • -
  • `mandate_failed`: Transitions a mandate through to - `failed`, having been submitted to the banks but found to - be invalid (for example due to invalid bank details). It - must start in the `pending_submission` or `submitted` - states. Not compatible with SEPA mandates, which are - submitted with their first payment.
    • -
  • `mandate_expired`: Transitions a mandate through to - `expired`, having been submitted to the banks, set up - successfully and then expired because no collection - attempts were made against it for longer than the scheme's - dormancy period (13 months for Bacs, 3 years for SEPA, 15 - months for ACH, Betalingsservice, and BECS). It must start - in the `pending_submission` state. Not compatible with - Autogiro, BECS NZ, and PAD mandates, which do not - expire.
    • -
  • `mandate_transferred`: Transitions a mandate through - to `transferred`, having been submitted to the banks, set - up successfully and then moved to a new bank account due. - It must start in the `pending_submission` state. Only - compatible with Bacs and SEPA mandates.
    • -
  • `mandate_transferred_with_resubmission`: Transitions a - mandate through `transferred` and resubmits it to the - banks, can be caused be the UK's Current Account Switching - Service (CASS) or when a customer contacts GoCardless to - change their bank details. It must start in the - `pending_submission` state. Only compatible with Bacs - mandates.
    • -
  • `mandate_suspended_by_payer`: Transitions a mandate to - `suspended_by_payer`, as if payer has suspended the - mandate after it has been setup successfully. It must - start in the `activated` state. Only compatible with - PAY_TO mandates.
    • -
  • `refund_paid`: Transitions a refund to `paid`. It must - start in either the `pending_submission` or `submitted` - state.
    • -
  • `refund_settled`: Transitions a refund to `paid`, if - it's not already, then generates a payout that includes - the refund, thereby settling the funds. It must start in - one of `pending_submission`, `submitted` or `paid` - states.
    • -
  • `refund_bounced`: Transitions a refund to `bounced`. - It must start in either the `pending_submission`, - `submitted`, or `paid` state.
    • -
  • `refund_returned`: Transitions a refund to - `refund_returned`. The refund must start in - `pending_submission`.
    • -
  • `payout_bounced`: Transitions a payout to `bounced`. - It must start in the `paid` state.
    • -
  • `billing_request_fulfilled`: Authorises the billing - request, and then fulfils it. The billing request must be - in the `pending` state, with all actions completed except - for `bank_authorisation`. Only billing requests with a - `payment_request` are supported.
    • -
  • `billing_request_fulfilled_and_payment_failed`: - Authorises the billing request, fulfils it, and moves the - associated payment to `failed`. The billing request must - be in the `pending` state, with all actions completed - except for `bank_authorisation`. Only billing requests - with a `payment_request` are supported.
    • + * @param string $identity The unique identifier of the simulator, used to initiate + simulations. One of: +
      +
    • `creditor_verification_status_action_required`: Sets a + creditor's `verification status` to `action required`, + meaning that the creditor must provide further information + to GoCardless in order to verify their account to receive + payouts.
      • +
    • `creditor_verification_status_in_review`: Sets a + creditor's `verification status` to `in review`, meaning + that the creditor has provided all of the information + requested by GoCardless to verify their account, and is now + awaiting review.
      • +
    • `creditor_verification_status_successful`: Sets a + creditor's `verification status` to `successful`, meaning + that the creditor is fully verified and can receive + payouts.
      • +
    • `payment_confirmed`: Transitions a payment through to + `confirmed`. It must start in the `pending_submission` + state, and its mandate must be in the `activated` state + (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in + which cases the mandate may be `pending_submission`, since + their mandates are submitted with their first + payment).
      • +
    • `payment_paid_out`: Transitions a payment through to + `paid_out`, having been collected successfully and paid out + to you. It must start in the `pending_submission` state, + and its mandate must be in the `activated` state (unless it + is a payment for ACH, BECS, BECS_NZ or SEPA, in which cases + the mandate may be `pending_submission`, since their + mandates are submitted with their first payment).
      • +
    • `payment_failed`: Transitions a payment through to + `failed`. It must start in the `pending_submission` state, + and its mandate must be in the `activated` state (unless it + is a payment for ACH, BECS, BECS_NZ or SEPA, in which cases + the mandate may be `pending_submission`, since their + mandates are submitted with their first payment).
      • +
    • `payment_charged_back`: Behaves the same as the + `payout_paid_out` simulator, except that the payment is + transitioned to `charged_back` after it is paid out, having + been charged back by the customer.
      • +
    • `payment_chargeback_settled`: Behaves the same as the + `payment_charged_back` simulator, except that the charged + back payment is additionally included as a debit item in a + payout, thereby settling the charged back payment.
      • +
    • `payment_late_failure`: Transitions a payment through + to `late_failure`, having been apparently collected + successfully beforehand. It must start in either the + `pending_submission` or `paid_out` state, and its mandate + must be in the `activated` state (unless it is a payment + for ACH, BECS, BECS_NZ or SEPA, in which cases the mandate + may be `pending_submission`, since their mandates are + submitted with their first payment). Not compatible with + Autogiro mandates.
      • +
    • `payment_late_failure_settled`: Behaves the same as the + `payment_late_failure` simulator, except that the late + failure is additionally included as a debit item in a + payout, thereby settling the late failure.
      • +
    • `payment_submitted`: Transitions a payment to + `submitted`, without proceeding any further. It must start + in the `pending_submission` state.
      • +
    • `mandate_activated`: Transitions a mandate through to + `activated`, having been submitted to the banks and set up + successfully. It must start in the `pending_submission` + state. Not compatible with ACH, BECS, BECS_NZ and SEPA + mandates, which are submitted and activated with their + first payment.
      • +
    • `mandate_customer_approval_granted`: Transitions a + mandate through to `pending_submission`, as if the customer + approved the mandate creation. It must start in the + `pending_customer_approval` state. Compatible only with + Bacs and SEPA mandates, which support customer signatures + on the mandate. All payments associated with the mandate + will be transitioned to `pending_submission`. All + subscriptions associated with the mandate will become + `active`.
      • +
    • `mandate_customer_approval_skipped`: Transitions a + mandate through to `pending_submission`, as if the customer + skipped the mandate approval during the mandate creation + process. It must start in the `pending_customer_approval` + state. Compatible only with Bacs and SEPA mandates, which + support customer signatures on the mandate. All payments + associated with the mandate will be transitioned to + `pending_submission`. All subscriptions associated with the + mandate will become `active`.
      • +
    • `mandate_failed`: Transitions a mandate through to + `failed`, having been submitted to the banks but found to + be invalid (for example due to invalid bank details). It + must start in the `pending_submission` or `submitted` + states. Not compatible with SEPA mandates, which are + submitted with their first payment.
      • +
    • `mandate_expired`: Transitions a mandate through to + `expired`, having been submitted to the banks, set up + successfully and then expired because no collection + attempts were made against it for longer than the scheme's + dormancy period (13 months for Bacs, 3 years for SEPA, 15 + months for ACH, Betalingsservice, and BECS). It must start + in the `pending_submission` state. Not compatible with + Autogiro, BECS NZ, and PAD mandates, which do not + expire.
      • +
    • `mandate_transferred`: Transitions a mandate through to + `transferred`, having been submitted to the banks, set up + successfully and then moved to a new bank account due. It + must start in the `pending_submission` state. Only + compatible with Bacs and SEPA mandates.
      • +
    • `mandate_transferred_with_resubmission`: Transitions a + mandate through `transferred` and resubmits it to the + banks, can be caused be the UK's Current Account Switching + Service (CASS) or when a customer contacts GoCardless to + change their bank details. It must start in the + `pending_submission` state. Only compatible with Bacs + mandates.
      • +
    • `mandate_suspended_by_payer`: Transitions a mandate to + `suspended_by_payer`, as if payer has suspended the mandate + after it has been setup successfully. It must start in the + `activated` state. Only compatible with PAY_TO + mandates.
      • +
    • `refund_paid`: Transitions a refund to `paid`. It must + start in either the `pending_submission` or `submitted` + state.
      • +
    • `refund_settled`: Transitions a refund to `paid`, if + it's not already, then generates a payout that includes the + refund, thereby settling the funds. It must start in one of + `pending_submission`, `submitted` or `paid` states.
      • +
    • `refund_bounced`: Transitions a refund to `bounced`. It + must start in either the `pending_submission`, `submitted`, + or `paid` state.
      • +
    • `refund_returned`: Transitions a refund to + `refund_returned`. The refund must start in + `pending_submission`.
      • +
    • `payout_bounced`: Transitions a payout to `bounced`. It + must start in the `paid` state.
      • +
    • `billing_request_fulfilled`: Authorises the billing + request, and then fulfils it. The billing request must be + in the `pending` state, with all actions completed except + for `bank_authorisation`. Only billing requests with a + `payment_request` are supported.
      • +
    • `billing_request_fulfilled_and_payment_failed`: + Authorises the billing request, fulfils it, and moves the + associated payment to `failed`. The billing request must be + in the `pending` state, with all actions completed except + for `bank_authorisation`. Only billing requests with a + `payment_request` are supported.
      • -
    • `billing_request_fulfilled_and_payment_confirmed_to_failed`: - Authorises the billing request, fulfils it, moves the - associated payment to `confirmed` and then moves it to - `failed`. The billing request must be in the `pending` - state, with all actions completed except for - `bank_authorisation`. Only billing requests with a - `payment_request` are supported.
      • -
    • `billing_request_fulfilled_and_payment_paid_out`: - Authorises the billing request, fulfils it, and moves the - associated payment to `paid_out`. The billing request must - be in the `pending` state, with all actions completed - except for `bank_authorisation`. Only billing requests - with a `payment_request` are supported.
      • -
    +
  • `billing_request_fulfilled_and_payment_confirmed_to_failed`: + Authorises the billing request, fulfils it, moves the + associated payment to `confirmed` and then moves it to + `failed`. The billing request must be in the `pending` + state, with all actions completed except for + `bank_authorisation`. Only billing requests with a + `payment_request` are supported.
    • +
  • `billing_request_fulfilled_and_payment_paid_out`: + Authorises the billing request, fulfils it, and moves the + associated payment to `paid_out`. The billing request must + be in the `pending` state, with all actions completed + except for `bank_authorisation`. Only billing requests with + a `payment_request` are supported.
    • +
* @param array $params An associative array for any params * @return ScenarioSimulator **/ diff --git a/lib/Services/SchemeIdentifiersService.php b/lib/Services/SchemeIdentifiersService.php index 16279538..3e33f886 100644 --- a/lib/Services/SchemeIdentifiersService.php +++ b/lib/Services/SchemeIdentifiersService.php @@ -27,7 +27,7 @@ class SchemeIdentifiersService extends BaseService /** - * Create a scheme identifier + * Create a scheme identifier * * Example URL: /scheme_identifiers * @@ -62,7 +62,7 @@ public function create($params = array()) } /** - * List scheme identifiers + * List scheme identifiers * * Example URL: /scheme_identifiers * @@ -85,11 +85,11 @@ protected function _doList($params = array()) } /** - * Get a single scheme identifier + * Get a single scheme identifier * * Example URL: /scheme_identifiers/:identity * - * @param string $identity Unique identifier, usually beginning with "SU". + * @param string $identity Unique identifier, usually beginning with "SU". * @param array $params An associative array for any params * @return SchemeIdentifier **/ @@ -115,7 +115,7 @@ public function get($identity, $params = array()) } /** - * List scheme identifiers + * List scheme identifiers * * Example URL: /scheme_identifiers * diff --git a/lib/Services/SubscriptionsService.php b/lib/Services/SubscriptionsService.php index bcb3cef9..e4f5beb9 100644 --- a/lib/Services/SubscriptionsService.php +++ b/lib/Services/SubscriptionsService.php @@ -27,7 +27,7 @@ class SubscriptionsService extends BaseService /** - * Create a subscription + * Create a subscription * * Example URL: /subscriptions * @@ -62,7 +62,7 @@ public function create($params = array()) } /** - * List subscriptions + * List subscriptions * * Example URL: /subscriptions * @@ -85,11 +85,11 @@ protected function _doList($params = array()) } /** - * Get a single subscription + * Get a single subscription * * Example URL: /subscriptions/:identity * - * @param string $identity Unique identifier, beginning with "SB". + * @param string $identity Unique identifier, beginning with "SB". * @param array $params An associative array for any params * @return Subscription **/ @@ -115,11 +115,11 @@ public function get($identity, $params = array()) } /** - * Update a subscription + * Update a subscription * * Example URL: /subscriptions/:identity * - * @param string $identity Unique identifier, beginning with "SB". + * @param string $identity Unique identifier, beginning with "SB". * @param array $params An associative array for any params * @return Subscription **/ @@ -146,11 +146,11 @@ public function update($identity, $params = array()) } /** - * Pause a subscription + * Pause a subscription * * Example URL: /subscriptions/:identity/actions/pause * - * @param string $identity Unique identifier, beginning with "SB". + * @param string $identity Unique identifier, beginning with "SB". * @param array $params An associative array for any params * @return Subscription **/ @@ -188,11 +188,11 @@ public function pause($identity, $params = array()) } /** - * Resume a subscription + * Resume a subscription * * Example URL: /subscriptions/:identity/actions/resume * - * @param string $identity Unique identifier, beginning with "SB". + * @param string $identity Unique identifier, beginning with "SB". * @param array $params An associative array for any params * @return Subscription **/ @@ -230,11 +230,11 @@ public function resume($identity, $params = array()) } /** - * Cancel a subscription + * Cancel a subscription * * Example URL: /subscriptions/:identity/actions/cancel * - * @param string $identity Unique identifier, beginning with "SB". + * @param string $identity Unique identifier, beginning with "SB". * @param array $params An associative array for any params * @return Subscription **/ @@ -272,7 +272,7 @@ public function cancel($identity, $params = array()) } /** - * List subscriptions + * List subscriptions * * Example URL: /subscriptions * diff --git a/lib/Services/TaxRatesService.php b/lib/Services/TaxRatesService.php index acaf06f2..028bce41 100644 --- a/lib/Services/TaxRatesService.php +++ b/lib/Services/TaxRatesService.php @@ -27,7 +27,7 @@ class TaxRatesService extends BaseService /** - * List tax rates + * List tax rates * * Example URL: /tax_rates * @@ -50,12 +50,12 @@ protected function _doList($params = array()) } /** - * Get a single tax rate + * Get a single tax rate * * Example URL: /tax_rates/:identity * - * @param string $identity The unique identifier created by the jurisdiction, tax - type and version + * @param string $identity The unique identifier created by the jurisdiction, tax type + and version * @param array $params An associative array for any params * @return TaxRate **/ @@ -81,7 +81,7 @@ public function get($identity, $params = array()) } /** - * List tax rates + * List tax rates * * Example URL: /tax_rates * diff --git a/lib/Services/TransferredMandatesService.php b/lib/Services/TransferredMandatesService.php index a5066ff7..6cf90d09 100644 --- a/lib/Services/TransferredMandatesService.php +++ b/lib/Services/TransferredMandatesService.php @@ -25,12 +25,12 @@ class TransferredMandatesService extends BaseService /** - * Get updated customer bank details + * Get updated customer bank details * * Example URL: /transferred_mandates/:identity * - * @param string $identity Unique identifier, beginning with "MD". Note that this - prefix may not apply to mandates created before 2016. + * @param string $identity Unique identifier, beginning with "MD". Note that this + prefix may not apply to mandates created before 2016. * @param array $params An associative array for any params * @return TransferredMandate **/ diff --git a/lib/Services/VerificationDetailsService.php b/lib/Services/VerificationDetailsService.php index 9282d2c8..70044868 100644 --- a/lib/Services/VerificationDetailsService.php +++ b/lib/Services/VerificationDetailsService.php @@ -27,7 +27,7 @@ class VerificationDetailsService extends BaseService /** - * Create a verification detail + * Create a verification detail * * Example URL: /verification_details * @@ -51,7 +51,7 @@ public function create($params = array()) } /** - * List verification details + * List verification details * * Example URL: /verification_details * @@ -74,7 +74,7 @@ protected function _doList($params = array()) } /** - * List verification details + * List verification details * * Example URL: /verification_details * diff --git a/lib/Services/WebhooksService.php b/lib/Services/WebhooksService.php index 7074c605..d59f3b32 100644 --- a/lib/Services/WebhooksService.php +++ b/lib/Services/WebhooksService.php @@ -27,7 +27,7 @@ class WebhooksService extends BaseService /** - * List webhooks + * List webhooks * * Example URL: /webhooks * @@ -50,11 +50,11 @@ protected function _doList($params = array()) } /** - * Get a single webhook + * Get a single webhook * * Example URL: /webhooks/:identity * - * @param string $identity Unique identifier, beginning with "WB". + * @param string $identity Unique identifier, beginning with "WB". * @param array $params An associative array for any params * @return Webhook **/ @@ -80,11 +80,11 @@ public function get($identity, $params = array()) } /** - * Retry a webhook + * Retry a webhook * * Example URL: /webhooks/:identity/actions/retry * - * @param string $identity Unique identifier, beginning with "WB". + * @param string $identity Unique identifier, beginning with "WB". * @param array $params An associative array for any params * @return Webhook **/ @@ -122,7 +122,7 @@ public function retry($identity, $params = array()) } /** - * List webhooks + * List webhooks * * Example URL: /webhooks *