gocardless_pro 4.2.0 → 4.4.1

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 = {})
@@ -33,7 +32,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -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.
       #
@@ -63,7 +62,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def collect_customer_details(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/collect_customer_details', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -81,7 +80,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -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.
@@ -124,7 +123,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def collect_bank_account(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/collect_bank_account', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -142,7 +141,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -165,7 +164,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def confirm_payer_details(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/confirm_payer_details', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -183,7 +182,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -205,7 +204,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def fulfil(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/fulfil', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -223,7 +222,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -245,7 +244,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/cancel', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -263,7 +262,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -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 = {})
@@ -313,7 +313,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/billing_requests/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -329,15 +329,14 @@ 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".
       # @param options [Hash] parameters as a hash, under a params key.
       def notify(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/notify', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -355,7 +354,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -377,7 +376,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def fallback(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/fallback', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -395,7 +394,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -422,7 +421,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def choose_currency(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/choose_currency', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -440,7 +439,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -461,7 +460,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def select_institution(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/select_institution', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -479,7 +478,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -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

@@ -31,7 +31,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -52,7 +52,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/blocks/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -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 = {})
@@ -100,7 +101,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def disable(identity, options = {})
         path = sub_url('/blocks/:identity/actions/disable', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -118,7 +119,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -139,7 +140,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def enable(identity, options = {})
         path = sub_url('/blocks/:identity/actions/enable', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -157,7 +158,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -195,7 +196,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -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

@@ -31,7 +31,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -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 = {})
@@ -81,7 +82,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/creditor_bank_accounts/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -107,7 +108,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def disable(identity, options = {})
         path = sub_url('/creditor_bank_accounts/:identity/actions/disable', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -125,7 +126,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -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

@@ -31,7 +31,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -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 = {})
@@ -81,7 +82,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/creditors/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -101,7 +102,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/creditors/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -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 = {})
@@ -43,7 +46,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -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 = {})
@@ -93,7 +97,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/customer_bank_accounts/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -113,7 +117,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/customer_bank_accounts/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -142,7 +146,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def disable(identity, options = {})
         path = sub_url('/customer_bank_accounts/:identity/actions/disable', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -160,7 +164,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -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,14 +17,13 @@ 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.
       # @param options [Hash] parameters as a hash, under a params key.
       def handle(identity, options = {})
         path = sub_url('/customer_notifications/:identity/actions/handle', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -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