Changes from gocardless/client-library-templates

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
-     *  <ul>
-     *  <li>pending_payments_submitted: Payments we have submitted to the scheme
-     *  but not yet confirmed. This does not exactly correspond to <i>Pending
-     *  payments</i> in the dashboard, because this balance does not include
-     *  payments that are pending submission.</li>
-     *  <li>confirmed_funds: Payments that have been confirmed minus fees and
-     *  unclaimed debits for refunds, failures and chargebacks. These funds have
-     *  not yet been moved into a payout.</li>
-     *  <li>pending_payouts: Confirmed payments that have been moved into a
-     *  payout. This is the total due to be paid into your bank account in the
-     *  next payout run (payouts happen once every business day).
-     *  pending_payouts will only be non-zero while we are generating and
-     *  submitting the payouts to our partner bank.</li>
-     *  </ul>
+     * Type of the balance. Could be one of
+     * <ul>
+     * <li>pending_payments_submitted: Payments we have submitted to the scheme
+     * but not yet confirmed. This does not exactly correspond to <i>Pending
+     * payments</i> in the dashboard, because this balance does not include
+     * payments that are pending submission.</li>
+     * <li>confirmed_funds: Payments that have been confirmed minus fees and
+     * unclaimed debits for refunds, failures and chargebacks. These funds have
+     * not yet been moved into a payout.</li>
+     * <li>pending_payouts: Confirmed payments that have been moved into a
+     * payout. This is the total due to be paid into your bank account in the
+     * next payout run (payouts happen once every business day).
+     * pending_payouts will only be non-zero while we are generating and
+     * submitting the payouts to our partner bank.</li>
+     * </ul>
      */
     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;
 

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;
 }

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
-     *  <ul>
-     *    <li>`full_match`: The verification has confirmed that the account name
-     *  exactly matches the details provided.</li>
-     *    <li>`partial_match`:  The verification has confirmed that the account
-     *  name is similar but does not match to the details provided. </li>
-     *    <li>`no_match`: The verification concludes the provided name does not
-     *  match the account details.</li>
-     *    <li>`unable_to_match`: The verification could not be performed due to
-     *  recipient bank issues or technical issues </li>
-     *  </ul>
+     * Result of the verification, could be one of
+     * <ul>
+     *   <li>`full_match`: The verification has confirmed that the account name
+     * exactly matches the details provided.</li>
+     *   <li>`partial_match`:  The verification has confirmed that the account
+     * name is similar but does not match to the details provided. </li>
+     *   <li>`no_match`: The verification concludes the provided name does not
+     * match the account details.</li>
+     *   <li>`unable_to_match`: The verification could not be performed due to
+     * recipient bank issues or technical issues </li>
+     * </ul>
      */
     protected $result;
 
     /**
-     *  The status of the bank account holder verification.
-     *  <ul>
-     *    <li>`pending`: We have triggered the verification, but the result has
-     *  not come back yet.</li>
-     *    <li>`completed`: The verification is complete and is ready to be
-     *  used.</li>
-     *  </ul>
+     * The status of the bank account holder verification.
+     * <ul>
+     *   <li>`pending`: We have triggered the verification, but the result has
+     * not come back yet.</li>
+     *   <li>`completed`: The verification is complete and is ready to be
+     * used.</li>
+     * </ul>
      *
      */
     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;
 }

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;
 }

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.
      *
-     *  <p class="notice">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.</p>
+     * <p class="notice">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.</p>
      */
     protected $bic;
 }