gocardless_pro 4.1.0 → 4.3.0

data/lib/gocardless_pro/resources/mandate.rb

@@ -16,8 +16,20 @@ module GoCardlessPro
     # GoCardless will notify you via a [webhook](#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 :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

data/lib/gocardless_pro/resources/mandate_import.rb

@@ -53,7 +53,10 @@ module GoCardlessPro
     # href="mailto:help@gocardless.com">get in touch</a> if you would like to
     # use this API.</p>
     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

@@ -41,7 +41,9 @@ module GoCardlessPro
     # href="mailto:help@gocardless.com">get in touch</a> if you would like to
     # use this API.</p>
     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

@@ -14,7 +14,8 @@ module GoCardlessPro
     # compliant](#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

@@ -16,7 +16,10 @@ module GoCardlessPro
     # 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

@@ -14,17 +14,31 @@ module GoCardlessPro
     # [creditors](#core-endpoints-creditors).
     #
     # GoCardless will notify you via a [webhook](#appendix-webhooks) when the
-    # status of the outbound payment [changes](#event-actions-outbound-payment).
+    # status of the outbound payment [changes](#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

data/lib/gocardless_pro/resources/payer_authorisation.rb

@@ -69,7 +69,13 @@ module GoCardlessPro
     # your servers.
     # </p>
     class PayerAuthorisation
-      attr_reader :bank_account, :created_at, :customer, :id, :incomplete_fields, :mandate, :status
+      attr_reader :bank_account
+      attr_reader :created_at
+      attr_reader :customer
+      attr_reader :id
+      attr_reader :incomplete_fields
+      attr_reader :mandate
+      attr_reader :status
 
       # Initialize a payer_authorisation resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/payment.rb

@@ -18,8 +18,20 @@ module GoCardlessPro
     # GoCardless will notify you via a [webhook](#appendix-webhooks) whenever
     # the state of a payment changes.
     class Payment
-      attr_reader :amount, :amount_refunded, :charge_date, :created_at, :currency, :description, :faster_ach, :fx, :id,
-                  :metadata, :reference, :retry_if_possible, :status
+      attr_reader :amount
+      attr_reader :amount_refunded
+      attr_reader :charge_date
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :description
+      attr_reader :faster_ach
+      attr_reader :fx
+      attr_reader :id
+      attr_reader :metadata
+      attr_reader :reference
+      attr_reader :retry_if_possible
+      attr_reader :scheme
+      attr_reader :status
 
       # Initialize a payment resource instance
       # @param object [Hash] an object returned from the API
@@ -39,6 +51,7 @@ module GoCardlessPro
         @metadata = object['metadata']
         @reference = object['reference']
         @retry_if_possible = object['retry_if_possible']
+        @scheme = object['scheme']
         @status = object['status']
         @response = response
       end

data/lib/gocardless_pro/resources/payment_account.rb

@@ -0,0 +1,63 @@
+#
+# 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 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).
+    class PaymentAccount
+      attr_reader :account_balance
+      attr_reader :account_holder_name
+      attr_reader :account_number_ending
+      attr_reader :bank_name
+      attr_reader :currency
+      attr_reader :id
+
+      # Initialize a payment_account resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @account_balance = object['account_balance']
+        @account_holder_name = object['account_holder_name']
+        @account_number_ending = object['account_number_ending']
+        @bank_name = object['bank_name']
+        @currency = object['currency']
+        @id = object['id']
+        @links = object['links']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @payment_account_links ||= Links.new(@links)
+      end
+
+      # Provides the payment_account 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/payment_account_transaction.rb

@@ -0,0 +1,78 @@
+#
+# 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 payment_account_transaction resource returned from the API
+
+    # 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).
+    class PaymentAccountTransaction
+      attr_reader :amount
+      attr_reader :balance_after_transaction
+      attr_reader :counterparty_name
+      attr_reader :currency
+      attr_reader :description
+      attr_reader :direction
+      attr_reader :id
+      attr_reader :reference
+      attr_reader :value_date
+
+      # Initialize a payment_account_transaction resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @amount = object['amount']
+        @balance_after_transaction = object['balance_after_transaction']
+        @counterparty_name = object['counterparty_name']
+        @currency = object['currency']
+        @description = object['description']
+        @direction = object['direction']
+        @id = object['id']
+        @links = object['links']
+        @reference = object['reference']
+        @value_date = object['value_date']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @payment_account_transaction_links ||= Links.new(@links)
+      end
+
+      # Provides the payment_account_transaction 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 payment_bank_account
+          @links['payment_bank_account']
+        end
+
+        def payout
+          @links['payout']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/payout.rb

@@ -17,8 +17,18 @@ module GoCardlessPro
     # Payouts are created automatically after a payment has been successfully
     # collected.
     class Payout
-      attr_reader :amount, :arrival_date, :created_at, :currency, :deducted_fees, :fx, :id, :metadata, :payout_type,
-                  :reference, :status, :tax_currency
+      attr_reader :amount
+      attr_reader :arrival_date
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :deducted_fees
+      attr_reader :fx
+      attr_reader :id
+      attr_reader :metadata
+      attr_reader :payout_type
+      attr_reader :reference
+      attr_reader :status
+      attr_reader :tax_currency
 
       # Initialize a payout resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/payout_item.rb

@@ -33,7 +33,9 @@ module GoCardlessPro
     # <code>410 Gone</code>.
     #
     class PayoutItem
-      attr_reader :amount, :taxes, :type
+      attr_reader :amount
+      attr_reader :taxes
+      attr_reader :type
 
       # Initialize a payout_item resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/redirect_flow.rb

@@ -49,8 +49,16 @@ module GoCardlessPro
     # complete an expired redirect flow. For an integrator this is shorter and
     # they will expire after 10 minutes.
     class RedirectFlow
-      attr_reader :confirmation_url, :created_at, :description, :id, :mandate_reference, :metadata, :redirect_url,
-                  :scheme, :session_token, :success_redirect_url
+      attr_reader :confirmation_url
+      attr_reader :created_at
+      attr_reader :description
+      attr_reader :id
+      attr_reader :mandate_reference
+      attr_reader :metadata
+      attr_reader :redirect_url
+      attr_reader :scheme
+      attr_reader :session_token
+      attr_reader :success_redirect_url
 
       # Initialize a redirect_flow resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/refund.rb

@@ -18,7 +18,14 @@ module GoCardlessPro
     # refund is created, and will update the `amount_refunded` property of the
     # payment.
     class Refund
-      attr_reader :amount, :created_at, :currency, :fx, :id, :metadata, :reference, :status
+      attr_reader :amount
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :fx
+      attr_reader :id
+      attr_reader :metadata
+      attr_reader :reference
+      attr_reader :status
 
       # Initialize a refund resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/scheme_identifier.rb

@@ -15,8 +15,24 @@ module GoCardlessPro
     # on customers' bank statements.
     #
     class SchemeIdentifier
-      attr_reader :address_line1, :address_line2, :address_line3, :can_specify_mandate_reference, :city, :country_code,
-                  :created_at, :currency, :email, :id, :minimum_advance_notice, :name, :phone_number, :postal_code, :reference, :region, :scheme, :status
+      attr_reader :address_line1
+      attr_reader :address_line2
+      attr_reader :address_line3
+      attr_reader :can_specify_mandate_reference
+      attr_reader :city
+      attr_reader :country_code
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :email
+      attr_reader :id
+      attr_reader :minimum_advance_notice
+      attr_reader :name
+      attr_reader :phone_number
+      attr_reader :postal_code
+      attr_reader :reference
+      attr_reader :region
+      attr_reader :scheme
+      attr_reader :status
 
       # Initialize a scheme_identifier resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/subscription.rb

@@ -68,8 +68,26 @@ module GoCardlessPro
     # - otherwise the charge date will be rolled __forwards__ to the next
     # business day.
     class Subscription
-      attr_reader :amount, :app_fee, :count, :created_at, :currency, :day_of_month, :earliest_charge_date_after_resume,
-                  :end_date, :id, :interval, :interval_unit, :metadata, :month, :name, :parent_plan_paused, :payment_reference, :retry_if_possible, :start_date, :status, :upcoming_payments
+      attr_reader :amount
+      attr_reader :app_fee
+      attr_reader :count
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :day_of_month
+      attr_reader :earliest_charge_date_after_resume
+      attr_reader :end_date
+      attr_reader :id
+      attr_reader :interval
+      attr_reader :interval_unit
+      attr_reader :metadata
+      attr_reader :month
+      attr_reader :name
+      attr_reader :parent_plan_paused
+      attr_reader :payment_reference
+      attr_reader :retry_if_possible
+      attr_reader :start_date
+      attr_reader :status
+      attr_reader :upcoming_payments
 
       # Initialize a subscription resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/tax_rate.rb

@@ -15,7 +15,12 @@ module GoCardlessPro
     # We also maintain a [static list of the tax rates for each
     # jurisdiction](#appendix-tax-rates).
     class TaxRate
-      attr_reader :end_date, :id, :jurisdiction, :percentage, :start_date, :type
+      attr_reader :end_date
+      attr_reader :id
+      attr_reader :jurisdiction
+      attr_reader :percentage
+      attr_reader :start_date
+      attr_reader :type
 
       # Initialize a tax_rate resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/transferred_mandate.rb

@@ -12,7 +12,9 @@ module GoCardlessPro
 
     # Mandates that have been transferred using Current Account Switch Service
     class TransferredMandate
-      attr_reader :encrypted_customer_bank_details, :encrypted_decryption_key, :public_key_id
+      attr_reader :encrypted_customer_bank_details
+      attr_reader :encrypted_decryption_key
+      attr_reader :public_key_id
 
       # Initialize a transferred_mandate resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/verification_detail.rb

@@ -22,8 +22,15 @@ module GoCardlessPro
     # your
     #   account.</p>
     class VerificationDetail
-      attr_reader :address_line1, :address_line2, :address_line3, :city, :company_number, :description, :directors,
-                  :name, :postal_code
+      attr_reader :address_line1
+      attr_reader :address_line2
+      attr_reader :address_line3
+      attr_reader :city
+      attr_reader :company_number
+      attr_reader :description
+      attr_reader :directors
+      attr_reader :name
+      attr_reader :postal_code
 
       # Initialize a verification_detail resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/webhook.rb

@@ -12,8 +12,19 @@ module GoCardlessPro
 
     # Basic description of a webhook
     class Webhook
-      attr_reader :created_at, :id, :is_test, :request_body, :request_headers, :response_body,
-                  :response_body_truncated, :response_code, :response_headers, :response_headers_content_truncated, :response_headers_count_truncated, :successful, :url
+      attr_reader :created_at
+      attr_reader :id
+      attr_reader :is_test
+      attr_reader :request_body
+      attr_reader :request_headers
+      attr_reader :response_body
+      attr_reader :response_body_truncated
+      attr_reader :response_code
+      attr_reader :response_headers
+      attr_reader :response_headers_content_truncated
+      attr_reader :response_headers_count_truncated
+      attr_reader :successful
+      attr_reader :url
 
       # Initialize a webhook resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/services/bank_account_details_service.rb

@@ -11,14 +11,19 @@ module GoCardlessPro
     # Service for making requests to the BankAccountDetail endpoints
     class BankAccountDetailsService < BaseService
       # Returns bank account details in the flattened JSON Web Encryption format
-      # described in RFC 7516
+      # 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)
+      # for more details.
       # Example URL: /bank_account_details/:identity
       #
       # @param identity       # Unique identifier, beginning with "BA".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/bank_account_details/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true

data/lib/gocardless_pro/services/bank_account_holder_verifications_service.rb

@@ -0,0 +1,86 @@
+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 BankAccountHolderVerification endpoints
+    class BankAccountHolderVerificationsService < BaseService
+      # Verify the account holder of the bank account. A complete verification can be
+      # attached when creating an outbound payment. This endpoint allows partner
+      # merchants to create Confirmation of Payee checks on customer bank accounts
+      # before sending outbound payments.
+      # Example URL: /bank_account_holder_verifications
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/bank_account_holder_verifications'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict.new(e.error)
+            when :fetch
+              return get(e.conflicting_resource_id)
+            end
+          end
+
+          raise e
+        end
+
+        return if response.body.nil?
+
+        Resources::BankAccountHolderVerification.new(unenvelope_body(response.body), response)
+      end
+
+      # Fetches a bank account holder verification by ID.
+      # Example URL: /bank_account_holder_verifications/:identity
+      #
+      # @param identity       # The unique identifier for the bank account holder verification resource,
+      # e.g. "BAHV123".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/bank_account_holder_verifications/:identity', {
+                         'identity' => identity,
+                       })
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::BankAccountHolderVerification.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)
+        body[envelope_key] || body['data']
+      end
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'bank_account_holder_verifications'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/bank_authorisations_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('/bank_authorisations/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true

data/lib/gocardless_pro/services/billing_request_flows_service.rb

@@ -38,7 +38,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def initialise(identity, options = {})
         path = sub_url('/billing_request_flows/:identity/actions/initialise', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}