gocardless_pro 4.2.0 → 4.4.1

data/lib/gocardless_pro/services/customers_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::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 = {})
@@ -81,7 +82,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/customers/: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('/customers/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -123,15 +124,14 @@ 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".
       # @param options [Hash] parameters as a hash, under a params key.
       def remove(identity, options = {})
         path = sub_url('/customers/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = false
@@ -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 = {})
@@ -46,7 +52,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/events/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -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

@@ -17,7 +17,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/exports/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -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

@@ -0,0 +1,56 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
+#
+
+module GoCardlessPro
+  module Services
+    # Service for making requests to the FundsAvailability endpoints
+    class FundsAvailabilitiesService < BaseService
+      # Checks if the payer's current balance is sufficient to cover the amount
+      # the merchant wants to charge within the consent parameters defined on the
+      # mandate.
+      # Example URL: /funds_availability/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "MD". Note that this prefix may not
+      # apply to mandates created before 2016.
+      # @param options [Hash] parameters as a hash, under a params key.
+      def check(identity, options = {})
+        path = sub_url('/funds_availability/:identity', {
+                         'identity' => identity,
+                       })
+
+        options[:retry_failures] = false
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::FundsAvailability.new(unenvelope_body(response.body), response)
+      end
+
+      private
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        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
+      def envelope_key
+        'funds_availability'
+      end
+    end
+  end
+end

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`).
@@ -49,7 +49,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
@@ -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
@@ -97,7 +98,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
@@ -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 = {})
@@ -147,7 +149,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/instalment_schedules/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -166,7 +168,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/instalment_schedules/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -193,7 +195,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/instalment_schedules/:identity/actions/cancel', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -211,7 +213,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
@@ -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

@@ -47,7 +47,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def list_for_billing_request(identity, options = {})
         path = sub_url('/billing_requests/:identity/institutions', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = false
@@ -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 = {})
@@ -35,7 +37,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
@@ -56,7 +58,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/mandate_imports/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -85,7 +87,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def submit(identity, options = {})
         path = sub_url('/mandate_imports/:identity/actions/submit', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -103,7 +105,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
@@ -130,7 +132,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/mandate_imports/:identity/actions/cancel', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -148,7 +150,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
@@ -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

data/lib/gocardless_pro/services/mandates_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::Mandate.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # mandates.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your mandates.
       # Example URL: /mandates
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -82,7 +83,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/mandates/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -102,7 +103,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/mandates/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -131,7 +132,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/mandates/:identity/actions/cancel', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -149,7 +150,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
@@ -163,12 +164,12 @@ module GoCardlessPro
         Resources::Mandate.new(unenvelope_body(response.body), response)
       end
 
-      # <a name="mandate_not_inactive"></a>Reinstates a cancelled or expired mandate
-      # to the banks. You will receive a `resubmission_requested` webhook, but after
-      # that reinstating the mandate follows the same process as its initial creation,
-      # so you will receive a `submitted` webhook, followed by a `reinstated` or
-      # `failed` webhook up to two working days later. Any metadata supplied to this
-      # endpoint will be stored on the `resubmission_requested` event it causes.
+      # Reinstates a cancelled or expired mandate to the banks. You will receive a
+      # `resubmission_requested` webhook, but after that reinstating the mandate
+      # follows the same process as its initial creation, so you will receive a
+      # `submitted` webhook, followed by a `reinstated` or `failed` webhook up to two
+      # working days later. Any metadata supplied to this endpoint will be stored on
+      # the `resubmission_requested` event it causes.
       #
       # This will fail with a `mandate_not_inactive` error if the mandate is already
       # being submitted, or is active.
@@ -181,7 +182,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def reinstate(identity, options = {})
         path = sub_url('/mandates/:identity/actions/reinstate', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -199,7 +200,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
@@ -219,7 +220,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/negative_balance_limits_service.rb

@@ -10,8 +10,9 @@ module GoCardlessPro
   module Services
     # Service for making requests to the NegativeBalanceLimit endpoints
     class NegativeBalanceLimitsService < BaseService
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of negative
-      # balance limits.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of negative balance limits.
       # Example URL: /negative_balance_limits
       # @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