gocardless_pro 4.3.0 → 4.4.1

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

data/lib/gocardless_pro/resources/outbound_payment_import_entry.rb

@@ -0,0 +1,77 @@
+#
+# 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_entry resource returned from the API
+
+    # Import Entries are the individual rows of an outbound payment import,
+    # representing each payment to be created.
+    class OutboundPaymentImportEntry
+      attr_reader :amount
+      attr_reader :created_at
+      attr_reader :id
+      attr_reader :metadata
+      attr_reader :processed_at
+      attr_reader :reference
+      attr_reader :scheme
+      attr_reader :validation_errors
+      attr_reader :verification_result
+
+      # Initialize a outbound_payment_import_entry resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @amount = object['amount']
+        @created_at = object['created_at']
+        @id = object['id']
+        @links = object['links']
+        @metadata = object['metadata']
+        @processed_at = object['processed_at']
+        @reference = object['reference']
+        @scheme = object['scheme']
+        @validation_errors = object['validation_errors']
+        @verification_result = object['verification_result']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @outbound_payment_import_entry_links ||= Links.new(@links)
+      end
+
+      # Provides the outbound_payment_import_entry resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def outbound_payment
+          @links['outbound_payment']
+        end
+
+        def outbound_payment_import
+          @links['outbound_payment_import']
+        end
+
+        def recipient_bank_account
+          @links['recipient_bank_account']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/payer_authorisation.rb

@@ -10,14 +10,13 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a payer_authorisation resource returned from the API
 
-    # <p class="restricted-notice">
+    #
     #   Don't use Payer Authorisations for new integrations.
-    #   It is deprecated in favour of
-    #   <a
-    # href="https://developer.gocardless.com/getting-started/billing-requests/overview/">
-    #   Billing Requests</a>. Use Billing Requests to build any future
-    # integrations.
-    # </p>
+    # It is deprecated in favour of
+    #
+    #   Billing Requests
+    # (https://developer.gocardless.com/getting-started/billing-requests/overview/).
+    # Use Billing Requests to build any future integrations.
     #
     # Payer Authorisation resource acts as a wrapper for creating customer, bank
     # account and mandate details in a single request.
@@ -26,48 +25,45 @@ module GoCardlessPro
     #
     # The process to use the Payer Authorisation API is as follows:
     #
-    #   1. Create a Payer Authorisation, either empty or with already available
+    # 1. Create a Payer Authorisation, either empty or with already available
     # information
-    #   2. Update the authorisation with additional information or fix any
+    # 2. Update the authorisation with additional information or fix any
     # mistakes
-    #   3. Submit the authorisation, after the payer has reviewed their
+    # 3. Submit the authorisation, after the payer has reviewed their
     # information
-    #   4. [coming soon] Redirect the payer to the verification mechanisms from
+    # 4. [coming soon] Redirect the payer to the verification mechanisms from
     # the response of the Submit request (this will be introduced as a
     # non-breaking change)
-    #   5. Confirm the authorisation to indicate that the resources can be
-    # created
+    # 5. Confirm the authorisation to indicate that the resources can be created
     #
     # After the Payer Authorisation is confirmed, resources will eventually be
     # created as it's an asynchronous process.
     #
     # To retrieve the status and ID of the linked resources you can do one of
     # the following:
-    # <ol>
-    #   <li> Listen to <code>  payer_authorisation_completed </code>  <a
-    # href="#appendix-webhooks"> webhook</a> (recommended)</li>
-    #   <li> Poll the GET <a
-    # href="#payer-authorisations-get-a-single-payer-authorisation">
-    # endpoint</a></li>
-    #   <li> Poll the GET events API
-    # <code>https://api.gocardless.com/events?payer_authorisation={id}&action=completed</code>
-    # </li>
-    # </ol>
     #
-    # <p class="notice">
+    # 1.  Listen to   payer_authorisation_completed    webhook
+    # (https://developer.gocardless.com/api-reference/#appendix-webhooks)
+    # (recommended)
+    # 2.  Poll the GET  endpoint
+    # (https://developer.gocardless.com/api-reference/#payer-authorisations-get-a-single-payer-authorisation)
+    # 3.  Poll the GET events API
+    # https://api.gocardless.com/events?payer_authorisation={id}&action=completed
+    #
+    #
     #   Note that the `create` and `update` endpoints behave differently than
-    #   other existing `create` and `update` endpoints. The Payer Authorisation
-    # is still saved if incomplete data is provided.
-    #   We return the list of incomplete data in the `incomplete_fields` along
+    # other existing `create` and `update` endpoints. The Payer Authorisation is
+    # still saved if incomplete data is provided.
+    # We return the list of incomplete data in the `incomplete_fields` along
     # with the resources in the body of the response.
-    #   The bank account details(account_number, bank_code & branch_code) must
-    # be sent together rather than splitting across different request for both
+    # The bank account details(account_number, bank_code & branch_code) must be
+    # sent together rather than splitting across different request for both
     # `create` and `update` endpoints.
-    #   <br><br>
+    #
+    #
     #   The API is designed to be flexible and allows you to collect information
     # in multiple steps without storing any sensitive data in the browser or in
     # your servers.
-    # </p>
     class PayerAuthorisation
       attr_reader :bank_account
       attr_reader :created_at

data/lib/gocardless_pro/resources/payment.rb

@@ -10,13 +10,16 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a payment resource returned from the API
 
-    # Payment objects represent payments from a
-    # [customer](#core-endpoints-customers) to a
-    # [creditor](#core-endpoints-creditors), taken against a Direct Debit
-    # [mandate](#core-endpoints-mandates).
+    # Payment objects represent payments from a customer
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-customers)
+    # to a creditor
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-creditors),
+    # taken against a Direct Debit mandate
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates).
     #
-    # GoCardless will notify you via a [webhook](#appendix-webhooks) whenever
-    # the state of a payment changes.
+    # GoCardless will notify you via a webhook
+    # (https://developer.gocardless.com/api-reference/#appendix-webhooks)
+    # whenever the state of a payment changes.
     class Payment
       attr_reader :amount
       attr_reader :amount_refunded

data/lib/gocardless_pro/resources/payment_account.rb

@@ -11,7 +11,8 @@ module GoCardlessPro
     # Represents an instance of a payment_account resource returned from the API
 
     # Access the details of bank accounts provided for you by GoCardless that
-    # are used to fund [Outbound Payments](#core-endpoints-outbound-payments).
+    # are used to fund Outbound Payments
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-outbound-payments).
     class PaymentAccount
       attr_reader :account_balance
       attr_reader :account_holder_name

data/lib/gocardless_pro/resources/payment_account_transaction.rb

@@ -12,7 +12,8 @@ module GoCardlessPro
 
     # Payment account transactions represent movements of funds on a given
     # payment account. The payment account is provisioned by GoCardless and is
-    # used to fund [outbound payments](#core-endpoints-outbound-payments).
+    # used to fund outbound payments
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-outbound-payments).
     class PaymentAccountTransaction
       attr_reader :amount
       attr_reader :balance_after_transaction

data/lib/gocardless_pro/resources/payout.rb

@@ -10,12 +10,13 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a payout resource returned from the API
 
-    # Payouts represent transfers from GoCardless to a
-    # [creditor](#core-endpoints-creditors). Each payout contains the funds
-    # collected from one or many [payments](#core-endpoints-payments). All the
-    # payments in a payout will have been collected in the same currency.
-    # Payouts are created automatically after a payment has been successfully
-    # collected.
+    # Payouts represent transfers from GoCardless to a creditor
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-creditors).
+    # Each payout contains the funds collected from one or many payments
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-payments).
+    # All the payments in a payout will have been collected in the same
+    # currency. Payouts are created automatically after a payment has been
+    # successfully collected.
     class Payout
       attr_reader :amount
       attr_reader :arrival_date

data/lib/gocardless_pro/resources/payout_item.rb

@@ -30,8 +30,7 @@ module GoCardlessPro
     # retrieved for payouts
     # created in the last 6 months. Requests for older payouts will return an
     # HTTP status
-    # <code>410 Gone</code>.
-    #
+    # 410 Gone.
     class PayoutItem
       attr_reader :amount
       attr_reader :taxes

data/lib/gocardless_pro/resources/redirect_flow.rb

@@ -10,38 +10,49 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a redirect_flow resource returned from the API
 
-    # <p class="deprecated-notice"><strong>Deprecated</strong>: Redirect Flows
-    # are legacy APIs and cannot be used by new integrators.
-    #     The [Billing Request flow](#billing-requests) API should be used for
-    # your payment flows.</p>
+    # Deprecated: Redirect Flows are legacy APIs and cannot be used by new
+    # integrators.
+    # The Billing Request flow
+    # (https://developer.gocardless.com/api-reference/#billing-requests) API
+    # should be used for your payment flows.
     #
-    # Redirect flows enable you to use GoCardless' [hosted payment
-    # pages](https://pay-sandbox.gocardless.com/AL000000AKFPFF) to set up
-    # mandates with your customers. These pages are fully compliant and have
-    # been translated into Danish, Dutch, French, German, Italian, Norwegian,
+    # Redirect flows enable you to use GoCardless' hosted payment pages
+    # (https://pay-sandbox.gocardless.com/AL000000AKFPFF) to set up mandates
+    # with your customers. These pages are fully compliant and have been
+    # translated into Danish, Dutch, French, German, Italian, Norwegian,
     # Portuguese, Slovak, Spanish and Swedish.
     #
     # The overall flow is:
     #
-    # 1. You [create](#redirect-flows-create-a-redirect-flow) a redirect flow
-    # for your customer, and redirect them to the returned redirect url, e.g.
-    # `https://pay.gocardless.com/flow/RE123`.
-    #
-    # 2. Your customer supplies their name, email, address, and bank account
+    # 1.
+    # You create
+    # (https://developer.gocardless.com/api-reference/#redirect-flows-create-a-redirect-flow)
+    # a redirect flow for your customer, and redirect them to the returned
+    # redirect url, e.g. `https://pay.gocardless.com/flow/RE123`.
+    # 2.
+    # Your customer supplies their name, email, address, and bank account
     # details, and submits the form. This securely stores their details, and
     # redirects them back to your `success_redirect_url` with
     # `redirect_flow_id=RE123` in the querystring.
+    # 3.
+    # You complete
+    # (https://developer.gocardless.com/api-reference/#redirect-flows-complete-a-redirect-flow)
+    # the redirect flow, which creates a customer
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-customers),
+    # customer bank account
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts),
+    # and mandate
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates),
+    # and returns the ID of the mandate. You may wish to create a subscription
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-subscriptions)
+    # or payment
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-payments)
+    # at this point.
     #
-    # 3. You [complete](#redirect-flows-complete-a-redirect-flow) the redirect
-    # flow, which creates a [customer](#core-endpoints-customers), [customer
-    # bank account](#core-endpoints-customer-bank-accounts), and
-    # [mandate](#core-endpoints-mandates), and returns the ID of the mandate.
-    # You may wish to create a [subscription](#core-endpoints-subscriptions) or
-    # [payment](#core-endpoints-payments) at this point.
-    #
-    # Once you have [completed](#redirect-flows-complete-a-redirect-flow) the
-    # redirect flow via the API, you should display a confirmation page to your
-    # customer, confirming that their Direct Debit has been set up. You can
+    # Once you have completed
+    # (https://developer.gocardless.com/api-reference/#redirect-flows-complete-a-redirect-flow)
+    # the redirect flow via the API, you should display a confirmation page to
+    # your customer, confirming that their Direct Debit has been set up. You can
     # build your own page, or redirect to the one we provide in the
     # `confirmation_url` attribute of the redirect flow.
     #

data/lib/gocardless_pro/resources/refund.rb

@@ -10,13 +10,15 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a refund resource returned from the API
 
-    # Refund objects represent (partial) refunds of a
-    # [payment](#core-endpoints-payments) back to the
-    # [customer](#core-endpoints-customers).
+    # Refund objects represent (partial) refunds of a payment
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-payments)
+    # back to the customer
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-customers).
     #
-    # GoCardless will notify you via a [webhook](#appendix-webhooks) whenever a
-    # refund is created, and will update the `amount_refunded` property of the
-    # payment.
+    # GoCardless will notify you via a webhook
+    # (https://developer.gocardless.com/api-reference/#appendix-webhooks)
+    # whenever a refund is created, and will update the `amount_refunded`
+    # property of the payment.
     class Refund
       attr_reader :amount
       attr_reader :created_at

data/lib/gocardless_pro/resources/scheme_identifier.rb

@@ -13,7 +13,6 @@ module GoCardlessPro
     # This represents a scheme identifier (e.g. a SUN in Bacs or a CID in SEPA).
     # Scheme identifiers are used to specify the beneficiary name that appears
     # on customers' bank statements.
-    #
     class SchemeIdentifier
       attr_reader :address_line1
       attr_reader :address_line2

data/lib/gocardless_pro/resources/subscription.rb

@@ -10,21 +10,24 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a subscription resource returned from the API
 
-    # Subscriptions create [payments](#core-endpoints-payments) according to a
-    # schedule.
+    # Subscriptions create payments
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-payments)
+    # according to a schedule.
     #
-    # ### Recurrence Rules
+    # Recurrence Rules
     #
     # The following rules apply when specifying recurrence:
     #
     # - If `day_of_month` and `start_date` are not provided `start_date` will be
-    # the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date` and
-    # the subscription will then recur based on the `interval` & `interval_unit`
+    # the mandate
+    # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)'s
+    # `next_possible_charge_date` and the subscription will then recur based on
+    # the `interval` & `interval_unit`
     # - If `month` or `day_of_month` are present the following validations
     # apply:
     #
-    # | __interval_unit__ | __month__                                      |
-    # __day_of_month__                           |
+    # | interval_unit | month                                      |
+    # day_of_month                           |
     # | :---------------- | :--------------------------------------------- |
     # :----------------------------------------- |
     # | yearly            | optional (required if `day_of_month` provided) |
@@ -36,8 +39,8 @@ module GoCardlessPro
     #
     # Examples:
     #
-    # | __interval_unit__ | __interval__ | __month__ | __day_of_month__ | valid?
-    #                                             |
+    # | interval_unit | interval | month | day_of_month | valid?
+    #                             |
     # | :---------------- | :----------- | :-------- | :--------------- |
     # :------------------------------------------------- |
     # | yearly            | 1            | january   | -1               | valid
@@ -57,16 +60,16 @@ module GoCardlessPro
     # | weekly            | 2            | october   | 10               |
     # invalid - `month` and `day_of_month` must be blank |
     #
-    # ### Rolling dates
+    # Rolling dates
     #
     # When a charge date falls on a non-business day, one of two things will
     # happen:
     #
     # - if the recurrence rule specified `-1` as the `day_of_month`, the charge
-    # date will be rolled __backwards__ to the previous business day (i.e., the
-    # last working day of the month).
-    # - otherwise the charge date will be rolled __forwards__ to the next
-    # business day.
+    # date will be rolled backwards to the previous business day (i.e., the last
+    # working day of the month).
+    # - otherwise the charge date will be rolled forwards to the next business
+    # day.
     class Subscription
       attr_reader :amount
       attr_reader :app_fee

data/lib/gocardless_pro/resources/tax_rate.rb

@@ -12,8 +12,8 @@ module GoCardlessPro
 
     # Tax rates from tax authority.
     #
-    # We also maintain a [static list of the tax rates for each
-    # jurisdiction](#appendix-tax-rates).
+    # We also maintain a static list of the tax rates for each jurisdiction
+    # (https://developer.gocardless.com/api-reference/#appendix-tax-rates).
     class TaxRate
       attr_reader :end_date
       attr_reader :id

data/lib/gocardless_pro/resources/verification_detail.rb

@@ -13,24 +13,26 @@ module GoCardlessPro
     # Verification details represent any information needed by GoCardless to
     # verify a creditor.
     #
-    # <p class="restricted-notice"><strong>Restricted</strong>:
-    #   These endpoints are restricted to customers who want to collect their
+    # Restricted:
+    # These endpoints are restricted to customers who want to collect their
     # merchant's
-    #   verification details and pass them to GoCardless via our API. Please
-    # [get in
-    #   touch](mailto:help@gocardless.com) if you wish to enable this feature on
+    # verification details and pass them to GoCardless via our API. Please get
+    # in
+    # touch (mailto:help@gocardless.com) if you wish to enable this feature on
     # your
-    #   account.</p>
+    # account.
     class VerificationDetail
       attr_reader :address_line1
       attr_reader :address_line2
       attr_reader :address_line3
       attr_reader :city
       attr_reader :company_number
+      attr_reader :country_code
       attr_reader :description
       attr_reader :directors
       attr_reader :name
       attr_reader :postal_code
+      attr_reader :region
 
       # Initialize a verification_detail resource instance
       # @param object [Hash] an object returned from the API
@@ -42,11 +44,13 @@ module GoCardlessPro
         @address_line3 = object['address_line3']
         @city = object['city']
         @company_number = object['company_number']
+        @country_code = object['country_code']
         @description = object['description']
         @directors = object['directors']
         @links = object['links']
         @name = object['name']
         @postal_code = object['postal_code']
+        @region = object['region']
         @response = response
       end
 

data/lib/gocardless_pro/services/balances_service.rb

@@ -10,8 +10,10 @@ module GoCardlessPro
   module Services
     # Service for making requests to the Balance endpoints
     class BalancesService < BaseService
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of balances
-      # for a given creditor. This endpoint is rate limited to 60 requests per minute.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of balances for a given creditor. This endpoint is rate limited to 60
+      # requests per minute.
       # Example URL: /balances
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -45,7 +47,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/bank_account_details_service.rb

@@ -13,9 +13,9 @@ module GoCardlessPro
       # Returns bank account details in the flattened JSON Web Encryption format
       # described in RFC 7516.
       #
-      # You must specify a `Gc-Key-Id` header when using this endpoint. See [Public
-      # Key
-      # Setup](https://developer.gocardless.com/gc-embed/bank-details-access#public_key_setup)
+      # You must specify a `Gc-Key-Id` header when using this endpoint. See Public Key
+      # Setup
+      # (https://developer.gocardless.com/gc-embed/bank-details-access#public_key_setup)
       # for more details.
       # Example URL: /bank_account_details/:identity
       #
@@ -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/bank_account_holder_verifications_service.rb

@@ -74,7 +74,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/bank_authorisations_service.rb

@@ -70,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