gocardless_pro 4.2.0 → 4.4.1

data/lib/gocardless_pro/resources/tax_rate.rb

@@ -12,10 +12,15 @@ 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, :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

@@ -13,17 +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, :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 :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
@@ -35,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/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/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

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

@@ -0,0 +1,92 @@
+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)
+        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
+        '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
@@ -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

data/lib/gocardless_pro/services/bank_details_lookups_service.rb

@@ -19,23 +19,25 @@ module GoCardlessPro
       # number match the details held by
       # the relevant bank.
       #
-      # If your request returns an [error](#api-usage-errors) or the
+      # If your request returns an error
+      # (https://developer.gocardless.com/api-reference/#api-usage-errors) or the
       # `available_debit_schemes`
       # attribute is an empty array, you will not be able to collect payments from the
       # specified bank account. GoCardless may be able to collect payments from an
       # account
       # even if no `bic` is returned.
       #
-      # Bank account details may be supplied using [local
-      # details](#appendix-local-bank-details) or an IBAN.
+      # Bank account details may be supplied using local details
+      # (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
+      # or an IBAN.
       #
-      # _ACH scheme_ For compliance reasons, an extra validation step is done using
+      # ACH scheme For compliance reasons, an extra validation step is done using
       # a third-party provider to make sure the customer's bank account can accept
       # Direct Debit. If a bank account is discovered to be closed or invalid, the
       # customer is requested to adjust the account number/routing number and
       # succeed in this check to continue with the flow.
       #
-      # _Note:_ Usage of this endpoint is monitored. If your organisation relies on
+      # Note: Usage of this endpoint is monitored. If your organisation relies on
       # GoCardless for
       # modulus or reachability checking but not for payment collection, please get in
       # touch.
@@ -63,7 +65,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/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) || {}
@@ -60,7 +60,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/billing_request_templates_service.rb

@@ -10,8 +10,9 @@ module GoCardlessPro
   module Services
     # Service for making requests to the BillingRequestTemplate endpoints
     class BillingRequestTemplatesService < BaseService
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # Billing Request Templates.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your Billing Request Templates.
       # Example URL: /billing_request_templates
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -46,7 +47,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/billing_request_templates/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -79,7 +80,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -97,11 +98,11 @@ module GoCardlessPro
       # Requests created by this template.
       # Example URL: /billing_request_templates/:identity
       #
-      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param identity       # Unique identifier, beginning with "BRT".
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/billing_request_templates/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -123,7 +124,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/billing_request_with_actions_service.rb

@@ -40,7 +40,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