gocardless_pro 4.3.0 → 4.4.1

data/lib/gocardless_pro/services/bank_details_lookups_service.rb

@@ -19,23 +19,25 @@ module GoCardlessPro
       # number match the details held by
       # the relevant bank.
       #
-      # If your request returns an [error](#api-usage-errors) or the
+      # If your request returns an error
+      # (https://developer.gocardless.com/api-reference/#api-usage-errors) or the
       # `available_debit_schemes`
       # attribute is an empty array, you will not be able to collect payments from the
       # specified bank account. GoCardless may be able to collect payments from an
       # account
       # even if no `bic` is returned.
       #
-      # Bank account details may be supplied using [local
-      # details](#appendix-local-bank-details) or an IBAN.
+      # Bank account details may be supplied using local details
+      # (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
+      # or an IBAN.
       #
-      # _ACH scheme_ For compliance reasons, an extra validation step is done using
+      # ACH scheme For compliance reasons, an extra validation step is done using
       # a third-party provider to make sure the customer's bank account can accept
       # Direct Debit. If a bank account is discovered to be closed or invalid, the
       # customer is requested to adjust the account number/routing number and
       # succeed in this check to continue with the flow.
       #
-      # _Note:_ Usage of this endpoint is monitored. If your organisation relies on
+      # Note: Usage of this endpoint is monitored. If your organisation relies on
       # GoCardless for
       # modulus or reachability checking but not for payment collection, please get in
       # touch.
@@ -63,7 +65,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/billing_request_flows_service.rb

@@ -60,7 +60,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/billing_request_templates_service.rb

@@ -10,8 +10,9 @@ module GoCardlessPro
   module Services
     # Service for making requests to the BillingRequestTemplate endpoints
     class BillingRequestTemplatesService < BaseService
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # Billing Request Templates.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your Billing Request Templates.
       # Example URL: /billing_request_templates
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -123,7 +124,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/billing_request_with_actions_service.rb

@@ -40,7 +40,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/billing_requests_service.rb

@@ -10,9 +10,8 @@ module GoCardlessPro
   module Services
     # Service for making requests to the BillingRequest endpoints
     class BillingRequestsService < BaseService
-      # <p class="notice"><strong>Important</strong>: All properties associated with
-      # `subscription_request` and `instalment_schedule_request` are only supported
-      # for ACH and PAD schemes.</p>
+      # Important: All properties associated with `subscription_request` and
+      # `instalment_schedule_request` are only supported for ACH and PAD schemes.
       # Example URL: /billing_requests
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -47,7 +46,7 @@ module GoCardlessPro
         Resources::BillingRequest.new(unenvelope_body(response.body), response)
       end
 
-      # If the billing request has a pending <code>collect_customer_details</code>
+      # If the billing request has a pending collect_customer_details
       # action, this endpoint can be used to collect the details in order to
       # complete it.
       #
@@ -96,7 +95,7 @@ module GoCardlessPro
       end
 
       # If the billing request has a pending
-      # <code>collect_bank_account</code> action, this endpoint can be
+      # collect_bank_account action, this endpoint can be
       # used to collect the details in order to complete it.
       #
       # The endpoint takes the same payload as Customer Bank Accounts, but check
@@ -107,14 +106,14 @@ module GoCardlessPro
       # the payload along with the
       # country_code.
       #
-      # _ACH scheme_ For compliance reasons, an extra validation step is done using
+      # ACH scheme For compliance reasons, an extra validation step is done using
       # a third-party provider to make sure the customer's bank account can accept
       # Direct Debit. If a bank account is discovered to be closed or invalid, the
       # customer is requested to adjust the account number/routing number and
       # succeed in this check to continue with the flow.
       #
-      # _BACS scheme_ [Payer Name
-      # Verification](https://hub.gocardless.com/s/article/Introduction-to-Payer-Name-Verification?language=en_GB)
+      # BACS scheme Payer Name Verification
+      # (https://hub.gocardless.com/s/article/Introduction-to-Payer-Name-Verification?language=en_GB)
       # is enabled by default for UK based bank accounts, meaning we verify the
       # account holder name and bank account
       # number match the details held by the relevant bank.
@@ -277,8 +276,9 @@ module GoCardlessPro
         Resources::BillingRequest.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # billing requests.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your billing requests.
       # Example URL: /billing_requests
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -329,8 +329,7 @@ module GoCardlessPro
       # it.
       # Currently, the customer can only be notified by email.
       #
-      # This endpoint is currently supported only for Instant Bank Pay Billing
-      # Requests.
+      # This endpoint is currently supported only for Pay by Bank Billing Requests.
       # Example URL: /billing_requests/:identity/actions/notify
       #
       # @param identity       # Unique identifier, beginning with "BRQ".
@@ -499,7 +498,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/blocks_service.rb

@@ -64,8 +64,9 @@ module GoCardlessPro
         Resources::Block.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # blocks.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your blocks.
       # Example URL: /blocks
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -217,7 +218,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/creditor_bank_accounts_service.rb

@@ -45,8 +45,9 @@ module GoCardlessPro
         Resources::CreditorBankAccount.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # creditor bank accounts.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your creditor bank accounts.
       # Example URL: /creditor_bank_accounts
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -145,7 +146,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/creditors_service.rb

@@ -45,8 +45,9 @@ module GoCardlessPro
         Resources::Creditor.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # creditors.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your creditors.
       # Example URL: /creditors
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -123,7 +124,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/currency_exchange_rates_service.rb

@@ -10,8 +10,9 @@ module GoCardlessPro
   module Services
     # Service for making requests to the CurrencyExchangeRate endpoints
     class CurrencyExchangeRatesService < BaseService
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of all
-      # exchange rates.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of all exchange rates.
       # Example URL: /currency_exchange_rates
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -45,7 +46,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/customer_bank_accounts_service.rb

@@ -14,15 +14,18 @@ module GoCardlessPro
       #
       # There are three different ways to supply bank account details:
       #
-      # - [Local details](#appendix-local-bank-details)
-      #
-      # - IBAN
-      #
-      # - [Customer Bank Account
-      # Tokens](#javascript-flow-create-a-customer-bank-account-token)
+      # -
+      # Local details
+      # (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
+      # -
+      # IBAN
+      # -
+      # Customer Bank Account Tokens
+      # (https://developer.gocardless.com/api-reference/#javascript-flow-create-a-customer-bank-account-token)
       #
       # For more information on the different fields required in each country, see
-      # [local bank details](#appendix-local-bank-details).
+      # local bank details
+      # (https://developer.gocardless.com/api-reference/#appendix-local-bank-details).
       # Example URL: /customer_bank_accounts
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -57,8 +60,9 @@ module GoCardlessPro
         Resources::CustomerBankAccount.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your bank
-      # accounts.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your bank accounts.
       # Example URL: /customer_bank_accounts
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -180,7 +184,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/customer_notifications_service.rb

@@ -17,7 +17,6 @@ module GoCardlessPro
       # passed,
       # this endpoint will return an `already_actioned` error and you should not take
       # further action. This endpoint takes no additional parameters.
-      #
       # Example URL: /customer_notifications/:identity/actions/handle
       #
       # @param identity       # The id of the notification.
@@ -46,7 +45,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/customers_service.rb

@@ -45,8 +45,9 @@ module GoCardlessPro
         Resources::Customer.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # customers.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your customers.
       # Example URL: /customers
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -123,8 +124,7 @@ module GoCardlessPro
       # customer by
       # ID.
       #
-      # <p class="restricted-notice"><strong>The action of removing a customer cannot
-      # be reversed, so please use with care.</strong></p>
+      # The action of removing a customer cannot be reversed, so please use with care.
       # Example URL: /customers/:identity
       #
       # @param identity       # Unique identifier, beginning with "CU".
@@ -149,7 +149,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/events_service.rb

@@ -10,8 +10,14 @@ module GoCardlessPro
   module Services
     # Service for making requests to the Event endpoints
     class EventsService < BaseService
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # events.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your events.
+      #
+      # Important: This endpoint will no longer return events older than 18 months,
+      # including when filtering by resource. This takes effect no sooner than 1
+      # August 2026 in sandbox environments, and no sooner than 1 October 2026 in live
+      # environments.
       # Example URL: /events
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -64,7 +70,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/exports_service.rb

@@ -63,7 +63,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/funds_availabilities_service.rb

@@ -38,7 +38,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/instalment_schedules_service.rb

@@ -14,8 +14,8 @@ module GoCardlessPro
       # This
       # API is recommended if you know the specific dates you wish to charge.
       # Otherwise,
-      # please check out the [scheduling
-      # version](#instalment-schedules-create-with-schedule).
+      # please check out the scheduling version
+      # (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-schedule).
       #
       # The `instalments` property is an array of payment properties (`amount` and
       # `charge_date`).
@@ -67,8 +67,9 @@ module GoCardlessPro
       # This
       # API is recommended if you wish to use the GoCardless scheduling logic. For
       # finer
-      # control over the individual dates, please check out the [alternative
-      # version](#instalment-schedules-create-with-dates).
+      # control over the individual dates, please check out the alternative
+      # version
+      # (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-dates).
       #
       # It can take quite a while to create the associated payments, so the API will
       # return
@@ -111,8 +112,9 @@ module GoCardlessPro
         Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # instalment schedules.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your instalment schedules.
       # Example URL: /instalment_schedules
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -231,7 +233,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/institutions_service.rb

@@ -67,7 +67,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/logos_service.rb

@@ -15,8 +15,8 @@ module GoCardlessPro
       #
       # We support JPG and PNG formats. Your logo will be scaled to a maximum of 300px
       # by 40px. For more guidance on how to upload logos that will look
-      # great across your customer payment page and notification emails see
-      # [here](https://developer.gocardless.com/gc-embed/setting-up-branding#tips_for_uploading_your_logo).
+      # great across your customer payment page and notification emails see here
+      # (https://developer.gocardless.com/gc-embed/setting-up-branding#tips_for_uploading_your_logo).
       # Example URL: /branding/logos
       # @param options [Hash] parameters as a hash, under a params key.
       def create_for_creditor(options = {})
@@ -41,7 +41,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/mandate_import_entries_service.rb

@@ -10,8 +10,9 @@ module GoCardlessPro
   module Services
     # Service for making requests to the MandateImportEntry endpoints
     class MandateImportEntriesService < BaseService
-      # For an existing [mandate import](#core-endpoints-mandate-imports), this
-      # endpoint can
+      # For an existing mandate import
+      # (https://developer.gocardless.com/api-reference/#core-endpoints-mandate-imports),
+      # this endpoint can
       # be used to add individual mandates to be imported into GoCardless.
       #
       # You can add no more than 30,000 rows to a single mandate import.
@@ -43,7 +44,6 @@ module GoCardlessPro
       # in your system (using the `record_identifier` that you provided when creating
       # the
       # mandate import).
-      #
       # Example URL: /mandate_import_entries
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -77,7 +77,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/mandate_imports_service.rb

@@ -14,7 +14,9 @@ module GoCardlessPro
       # this endpoint merely signals the start of the import process. Once you've
       # finished
       # adding entries to an import, you should
-      # [submit](#mandate-imports-submit-a-mandate-import) it.
+      # submit
+      # (https://developer.gocardless.com/api-reference/#mandate-imports-submit-a-mandate-import)
+      # it.
       # Example URL: /mandate_imports
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -168,7 +170,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/mandate_pdfs_service.rb

@@ -13,14 +13,14 @@ module GoCardlessPro
       # Generates a PDF mandate and returns its temporary URL.
       #
       # Customer and bank account details can be left blank (for a blank mandate),
-      # provided manually, or inferred from the ID of an existing
-      # [mandate](#core-endpoints-mandates).
+      # provided manually, or inferred from the ID of an existing mandate
+      # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates).
       #
       # By default, we'll generate PDF mandates in English.
       #
       # To generate a PDF mandate in another language, set the `Accept-Language`
-      # header when creating the PDF mandate to the relevant [ISO
-      # 639-1](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code
+      # header when creating the PDF mandate to the relevant ISO 639-1
+      # (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code
       # supported for the scheme.
       #
       # | Scheme           | Supported languages
@@ -77,7 +77,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under