gocardless_pro 4.2.0 → 4.4.1

data/lib/gocardless_pro/resources/customer_bank_account.rb

@@ -10,10 +10,12 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a customer_bank_account resource returned from the API
 
-    # Customer Bank Accounts hold the bank details of a
-    # [customer](#core-endpoints-customers). They always belong to a
-    # [customer](#core-endpoints-customers), and may be linked to several Direct
-    # Debit [mandates](#core-endpoints-mandates).
+    # Customer Bank Accounts hold the bank details of a customer
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-customers).
+    # They always belong to a customer
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-customers),
+    # and may be linked to several Direct Debit mandates
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates).
     #
     # Note that customer bank accounts must be unique, and so you will encounter
     # a `bank_account_exists` error if you try to create a duplicate bank
@@ -21,15 +23,25 @@ module GoCardlessPro
     # instead, the ID of which will be provided as
     # `links[customer_bank_account]` in the error response.
     #
-    # _Note:_ To ensure the customer's bank accounts are valid, verify them
-    # first
+    # Note: To ensure the customer's bank accounts are valid, verify them first
     # using
-    #
-    # [bank_details_lookups](#bank-details-lookups-perform-a-bank-details-lookup),
+    # bank_details_lookups
+    # (https://developer.gocardless.com/api-reference/#bank-details-lookups-perform-a-bank-details-lookup),
     # before proceeding with creating the accounts
     class CustomerBankAccount
-      attr_reader :account_holder_name, :account_number_ending, :account_type, :bank_account_token, :bank_name,
-                  :country_code, :created_at, :currency, :enabled, :id, :metadata
+      attr_reader :account_holder_name
+      attr_reader :account_number_ending
+      attr_reader :account_type
+      attr_reader :bank_account_token
+      attr_reader :bank_name
+      attr_reader :country_code
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :enabled
+      attr_reader :id
+      attr_reader :metadata
+      attr_reader :payer_name_verification_result
+      attr_reader :trusted_recipient
 
       # Initialize a customer_bank_account resource instance
       # @param object [Hash] an object returned from the API
@@ -48,6 +60,8 @@ module GoCardlessPro
         @id = object['id']
         @links = object['links']
         @metadata = object['metadata']
+        @payer_name_verification_result = object['payer_name_verification_result']
+        @trusted_recipient = object['trusted_recipient']
         @response = response
       end
 

data/lib/gocardless_pro/resources/customer_notification.rb

@@ -20,12 +20,15 @@ module GoCardlessPro
     # actioned in some
     # way, it is no longer visible using this API.
     #
-    # <p class="restricted-notice"><strong>Restricted</strong>: This API is
-    # currently only available for approved integrators - please <a
-    # href="mailto:help@gocardless.com">get in touch</a> if you would like to
-    # use this API.</p>
+    # Restricted: This API is currently only available for approved integrators
+    # - please get in touch (mailto:help@gocardless.com) if you would like to
+    # use this API.
     class CustomerNotification
-      attr_reader :action_taken, :action_taken_at, :action_taken_by, :id, :type
+      attr_reader :action_taken
+      attr_reader :action_taken_at
+      attr_reader :action_taken_by
+      attr_reader :id
+      attr_reader :type
 
       # Initialize a customer_notification resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/event.rb

@@ -14,11 +14,25 @@ module GoCardlessPro
     # has been updated, for example a payment which has been collected, or a
     # mandate which has been transferred. Event creation is an asynchronous
     # process, so it can take some time between an action occurring and its
-    # corresponding event getting included in API responses. See
-    # [here](#event-actions) for a complete list of event types.
+    # corresponding event getting included in API responses. See here
+    # (https://developer.gocardless.com/api-reference/#event-types) for a
+    # complete list of event types.
+    #
+    # Important: Events older than 18 months will be archived and no longer
+    # accessible via the API or exports. Archival will begin no sooner than 1
+    # August 2026 in sandbox environments, and no sooner than 1 October 2026 in
+    # live environments. Events within the 18-month window are unaffected. If
+    # you need archived data, contact GoCardless support.
     class Event
-      attr_reader :action, :created_at, :customer_notifications, :details, :id, :metadata, :resource_metadata,
-                  :resource_type
+      attr_reader :action
+      attr_reader :created_at
+      attr_reader :customer_notifications
+      attr_reader :details
+      attr_reader :id
+      attr_reader :metadata
+      attr_reader :resource_metadata
+      attr_reader :resource_type
+      attr_reader :source
 
       # Initialize a event resource instance
       # @param object [Hash] an object returned from the API
@@ -34,6 +48,7 @@ module GoCardlessPro
         @metadata = object['metadata']
         @resource_metadata = object['resource_metadata']
         @resource_type = object['resource_type']
+        @source = object['source']
         @response = response
       end
 
@@ -88,6 +103,10 @@ module GoCardlessPro
           @links['mandate']
         end
 
+        def mandate_request
+          @links['mandate_request']
+        end
+
         def mandate_request_mandate
           @links['mandate_request_mandate']
         end
@@ -104,6 +123,10 @@ module GoCardlessPro
           @links['organisation']
         end
 
+        def outbound_payment
+          @links['outbound_payment']
+        end
+
         def parent_event
           @links['parent_event']
         end
@@ -116,6 +139,10 @@ module GoCardlessPro
           @links['payment']
         end
 
+        def payment_account_transaction
+          @links['payment_account_transaction']
+        end
+
         def payment_request_payment
           @links['payment_request_payment']
         end

data/lib/gocardless_pro/resources/export.rb

@@ -12,7 +12,12 @@ module GoCardlessPro
 
     # File-based exports of data
     class Export
-      attr_reader :created_at, :currency, :download_url, :export_type, :id
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :download_url
+      attr_reader :error_message
+      attr_reader :export_type
+      attr_reader :id
 
       # Initialize a export resource instance
       # @param object [Hash] an object returned from the API
@@ -22,6 +27,7 @@ module GoCardlessPro
         @created_at = object['created_at']
         @currency = object['currency']
         @download_url = object['download_url']
+        @error_message = object['error_message']
         @export_type = object['export_type']
         @id = object['id']
         @response = response

data/lib/gocardless_pro/resources/funds_availability.rb

@@ -0,0 +1,38 @@
+#
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
+#
+
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Represents an instance of a funds_availability resource returned from the API
+
+    # 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.
+    class FundsAvailability
+      attr_reader :available
+
+      # Initialize a funds_availability resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @available = object['available']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the funds_availability resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/instalment_schedule.rb

@@ -26,9 +26,15 @@ module GoCardlessPro
     #
     # Customers will receive a single notification about the complete schedule
     # of collection.
-    #
     class InstalmentSchedule
-      attr_reader :created_at, :currency, :id, :metadata, :name, :payment_errors, :status, :total_amount
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :id
+      attr_reader :metadata
+      attr_reader :name
+      attr_reader :payment_errors
+      attr_reader :status
+      attr_reader :total_amount
 
       # Initialize a instalment_schedule resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/institution.rb

@@ -10,14 +10,21 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a institution resource returned from the API
 
-    # Institutions that are supported when creating [Bank
-    # Authorisations](#billing-requests-bank-authorisations) for a particular
-    # country or purpose.
+    # Institutions that are supported when creating Bank Authorisations
+    # (https://developer.gocardless.com/api-reference/#billing-requests-bank-authorisations)
+    # for a particular country or purpose.
     #
     # Not all institutions support both Payment Initiation (PIS) and Account
     # Information (AIS) services.
     class Institution
-      attr_reader :autocompletes_collect_bank_account, :country_code, :icon_url, :id, :limits, :logo_url, :name, :status
+      attr_reader :autocompletes_collect_bank_account
+      attr_reader :country_code
+      attr_reader :icon_url
+      attr_reader :id
+      attr_reader :limits
+      attr_reader :logo_url
+      attr_reader :name
+      attr_reader :status
 
       # Initialize a institution resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/logo.rb

@@ -11,7 +11,8 @@ module GoCardlessPro
     # Represents an instance of a logo resource returned from the API
 
     # Logos are image uploads that, when associated with a creditor, are shown
-    # on the [billing request flow](#billing-requests-billing-request-flows)
+    # on the billing request flow
+    # (https://developer.gocardless.com/api-reference/#billing-requests-billing-request-flows)
     # payment pages.
     class Logo
       attr_reader :id

data/lib/gocardless_pro/resources/mandate.rb

@@ -10,14 +10,28 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a mandate resource returned from the API
 
-    # Mandates represent the Direct Debit mandate with a
-    # [customer](#core-endpoints-customers).
+    # Mandates represent the Direct Debit mandate with a customer
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-customers).
     #
-    # GoCardless will notify you via a [webhook](#appendix-webhooks) whenever
-    # the status of a mandate changes.
+    # GoCardless will notify you via a webhook
+    # (https://developer.gocardless.com/api-reference/#appendix-webhooks)
+    # whenever the status of a mandate changes.
     class Mandate
-      attr_reader :authorisation_source, :consent_parameters, :consent_type, :created_at, :funds_settlement, :id,
-                  :metadata, :next_possible_charge_date, :next_possible_standard_ach_charge_date, :payments_require_approval, :reference, :scheme, :status, :verified_at
+      attr_reader :authorisation_source
+      attr_reader :consent_parameters
+      attr_reader :consent_type
+      attr_reader :created_at
+      attr_reader :funds_settlement
+      attr_reader :id
+      attr_reader :mandate_type
+      attr_reader :metadata
+      attr_reader :next_possible_charge_date
+      attr_reader :next_possible_standard_ach_charge_date
+      attr_reader :payments_require_approval
+      attr_reader :reference
+      attr_reader :scheme
+      attr_reader :status
+      attr_reader :verified_at
 
       # Initialize a mandate resource instance
       # @param object [Hash] an object returned from the API
@@ -31,6 +45,7 @@ module GoCardlessPro
         @funds_settlement = object['funds_settlement']
         @id = object['id']
         @links = object['links']
+        @mandate_type = object['mandate_type']
         @metadata = object['metadata']
         @next_possible_charge_date = object['next_possible_charge_date']
         @next_possible_standard_ach_charge_date = object['next_possible_standard_ach_charge_date']

data/lib/gocardless_pro/resources/mandate_import.rb

@@ -16,16 +16,19 @@ module GoCardlessPro
     #
     # The process is as follows:
     #
-    #   1. [Create a mandate
-    # import](#mandate-imports-create-a-new-mandate-import)
-    #   2. [Add entries](#mandate-import-entries-add-a-mandate-import-entry) to
+    # 1. Create a mandate import
+    # (https://developer.gocardless.com/api-reference/#mandate-imports-create-a-new-mandate-import)
+    # 2. Add entries
+    # (https://developer.gocardless.com/api-reference/#mandate-import-entries-add-a-mandate-import-entry)
+    # to the import
+    # 3. Submit
+    # (https://developer.gocardless.com/api-reference/#mandate-imports-submit-a-mandate-import)
     # the import
-    #   3. [Submit](#mandate-imports-submit-a-mandate-import) the import
-    #   4. Wait until a member of the GoCardless team approves the import, at
+    # 4. Wait until a member of the GoCardless team approves the import, at
     # which point the mandates will be created
-    #   5. [Link up the
-    # mandates](#mandate-import-entries-list-all-mandate-import-entries) in your
-    # system
+    # 5. Link up the mandates
+    # (https://developer.gocardless.com/api-reference/#mandate-import-entries-list-all-mandate-import-entries)
+    # in your system
     #
     # When you add entries to your mandate import, they are not turned into
     # actual mandates
@@ -36,24 +39,28 @@ module GoCardlessPro
     #
     # We will issue a `mandate_created` webhook for each entry, which will be
     # the same as the webhooks
-    # triggered when [ creating a mandate ](#mandates-create-a-mandate) using
-    # the mandates API. Once these
+    # triggered when  creating a mandate
+    # (https://developer.gocardless.com/api-reference/#mandates-create-a-mandate)
+    # using the mandates API. Once these
     # webhooks start arriving, any reconciliation can now be accomplished by
-    # [checking the current status](#mandate-imports-get-a-mandate-import) of
-    # the mandate import and
-    # [linking up the mandates to your
-    # system](#mandate-import-entries-list-all-mandate-import-entries).
+    # checking the current status
+    # (https://developer.gocardless.com/api-reference/#mandate-imports-get-a-mandate-import)
+    # of the mandate import and
+    # linking up the mandates to your system
+    # (https://developer.gocardless.com/api-reference/#mandate-import-entries-list-all-mandate-import-entries).
     #
-    # <p class="notice">Note that all Mandate Imports have an upper limit of
-    # 30,000 entries, so we recommend you split your import into several smaller
-    # imports if you're planning to exceed this threshold.</p>
+    # Note that all Mandate Imports have an upper limit of 30,000 entries, so we
+    # recommend you split your import into several smaller imports if you're
+    # planning to exceed this threshold.
     #
-    # <p class="restricted-notice"><strong>Restricted</strong>: This API is
-    # currently only available for approved integrators - please <a
-    # href="mailto:help@gocardless.com">get in touch</a> if you would like to
-    # use this API.</p>
+    # Restricted: This API is currently only available for approved integrators
+    # - please get in touch (mailto:help@gocardless.com) if you would like to
+    # use this API.
     class MandateImport
-      attr_reader :created_at, :id, :scheme, :status
+      attr_reader :created_at
+      attr_reader :id
+      attr_reader :scheme
+      attr_reader :status
 
       # Initialize a mandate_import resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/mandate_import_entry.rb

@@ -10,38 +10,37 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a mandate_import_entry resource returned from the API
 
-    # Mandate Import Entries are added to a [Mandate
-    # Import](#core-endpoints-mandate-imports).
+    # Mandate Import Entries are added to a Mandate Import
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-mandate-imports).
     # Each entry corresponds to one mandate to be imported into GoCardless.
     #
     # To import a mandate you will need:
-    # <ol>
-    #   <li>Identifying information about the customer (name/company and
-    # address)</li>
-    #   <li>Bank account details, consisting of an account holder name and
-    #      either an IBAN or <a href="#appendix-local-bank-details">local bank
-    # details</a></li>
-    #   <li>Amendment details (SEPA only)</li>
-    # </ol>
+    #
+    # 1. Identifying information about the customer (name/company and address)
+    # 2. Bank account details, consisting of an account holder name and
+    # either an IBAN or local bank details
+    # (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
+    # 3. Amendment details (SEPA only)
     #
     # We suggest you provide a `record_identifier` (which is unique within the
     # context of a
     # single mandate import) to help you to identify mandates that have been
     # created once the
     # import has been processed by GoCardless. You can
-    # [list the mandate import
-    # entries](#mandate-import-entries-list-all-mandate-import-entries),
+    # list the mandate import entries
+    # (https://developer.gocardless.com/api-reference/#mandate-import-entries-list-all-mandate-import-entries),
     # match them up in your system using the `record_identifier`, and look at
     # the `links`
     # fields to find the mandate, customer and customer bank account that have
     # been imported.
     #
-    # <p class="restricted-notice"><strong>Restricted</strong>: This API is
-    # currently only available for approved integrators - please <a
-    # href="mailto:help@gocardless.com">get in touch</a> if you would like to
-    # use this API.</p>
+    # Restricted: This API is currently only available for approved integrators
+    # - please get in touch (mailto:help@gocardless.com) if you would like to
+    # use this API.
     class MandateImportEntry
-      attr_reader :created_at, :processing_errors, :record_identifier
+      attr_reader :created_at
+      attr_reader :processing_errors
+      attr_reader :record_identifier
 
       # Initialize a mandate_import_entry resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/mandate_pdf.rb

@@ -10,11 +10,12 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a mandate_pdf resource returned from the API
 
-    # Mandate PDFs allow you to easily display [scheme-rules
-    # compliant](#appendix-compliance-requirements) Direct Debit mandates to
-    # your customers.
+    # Mandate PDFs allow you to easily display scheme-rules compliant
+    # (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)
+    # Direct Debit mandates to your customers.
     class MandatePdf
-      attr_reader :expires_at, :url
+      attr_reader :expires_at
+      attr_reader :url
 
       # Initialize a mandate_pdf resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/negative_balance_limit.rb

@@ -14,9 +14,11 @@ module GoCardlessPro
     # which refunds are not permitted. The default limit is zero — refunds are
     # not permitted if the creditor has a negative balance. The limit can be
     # changed on a per-creditor basis.
-    #
     class NegativeBalanceLimit
-      attr_reader :balance_limit, :created_at, :currency, :id
+      attr_reader :balance_limit
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :id
 
       # Initialize a negative_balance_limit resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/outbound_payment.rb

@@ -10,21 +10,38 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a outbound_payment resource returned from the API
 
-    # Outbound Payments represent payments sent from
-    # [creditors](#core-endpoints-creditors).
+    # Outbound Payments represent payments sent from creditors
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-creditors).
     #
-    # GoCardless will notify you via a [webhook](#appendix-webhooks) when the
-    # status of the outbound payment [changes](#event-actions-outbound-payment).
+    # GoCardless will notify you via a webhook
+    # (https://developer.gocardless.com/api-reference/#appendix-webhooks) when
+    # the status of the outbound payment changes
+    # (https://developer.gocardless.com/api-reference/#event-types-outbound-payment).
     #
-    # <p class="restricted-notice"><strong>Restricted</strong>: Outbound
-    # Payments are currently in Early Access and available only to a limited
-    # list of organisations. If you are interested in using this feature, please
-    # stay tuned for our public launch announcement. We are actively testing and
-    # refining our API to ensure it meets your needs and provides the best
-    # experience.</p>
+    # ####Rate limiting
+    #
+    # Two rate limits apply to the Outbound Payments APIs:
+    #
+    # - All POST Outbound Payment endpoints (create, withdraw, approve, cancel
+    # and etc.) share a single rate-limit group of 300 requests per minute. As
+    # initiating a payment typically requires two API calls (one to create the
+    # payment and one to approve it), this allows you to add approximately 150
+    # outbound payments per minute.
+    # - All remaining Outbound Payment endpoints are limited to 500 requests per
+    # minute.
     class OutboundPayment
-      attr_reader :amount, :created_at, :currency, :description, :execution_date, :id, :is_withdrawal, :metadata,
-                  :reference, :scheme, :status, :verifications
+      attr_reader :amount
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :description
+      attr_reader :execution_date
+      attr_reader :id
+      attr_reader :is_withdrawal
+      attr_reader :metadata
+      attr_reader :reference
+      attr_reader :scheme
+      attr_reader :status
+      attr_reader :verifications
 
       # Initialize a outbound_payment resource instance
       # @param object [Hash] an object returned from the API
@@ -74,6 +91,10 @@ module GoCardlessPro
           @links['customer']
         end
 
+        def outbound_payment_import
+          @links['outbound_payment_import']
+        end
+
         def recipient_bank_account
           @links['recipient_bank_account']
         end

data/lib/gocardless_pro/resources/outbound_payment_import.rb

@@ -0,0 +1,81 @@
+#
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
+#
+
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Represents an instance of a outbound_payment_import resource returned from the API
+
+    # Outbound Payment Imports allow you to create multiple payments via a
+    # single API call.
+    #
+    # The Workflow:
+    #
+    # 1. Create the outbound payment import.
+    # 2. Retrieve an authorisation link from the response.
+    # 3. Redirect the user to the link to authorise the import.
+    # 4. Once the user authorises the import, the individual outbound payments
+    # are automatically submitted.
+    #
+    # Import entries are not processed as actual payments until they are
+    # reviewed and authorised in GoCardless Dashboard.
+    # Upon approval, a unique outbound payment is generated for every entry in
+    # the import.
+    #
+    # Outbound Payment Imports are capped at 1000 entries. If you expect to
+    # exceed this limit, please create multiple smaller imports.
+    class OutboundPaymentImport
+      attr_reader :amount_sum
+      attr_reader :authorisation_url
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :entry_counts
+      attr_reader :id
+      attr_reader :status
+
+      # Initialize a outbound_payment_import resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @amount_sum = object['amount_sum']
+        @authorisation_url = object['authorisation_url']
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @entry_counts = object['entry_counts']
+        @id = object['id']
+        @links = object['links']
+        @status = object['status']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @outbound_payment_import_links ||= Links.new(@links)
+      end
+
+      # Provides the outbound_payment_import resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def creditor
+          @links['creditor']
+        end
+      end
+    end
+  end
+end