gocardless_pro 2.40.0 → 2.41.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e651254dd1b8ee279f19b5c698c1cc0d71412186c7ffc472cd92d403c694d41f
-  data.tar.gz: 493fc00fae5258c12b24d6a13fff0d2c76db9948b3898a782a6cf4eb59b281c8
+  metadata.gz: 8e9725480d2dc2fc482dae8257c5f426aed030db8f58f51d074e9ddcdbe862de
+  data.tar.gz: a5811ee88da9fc7ef0e05c22978d4a47b85c25ec99c85bacb03f61deaa1363e6
 SHA512:
-  metadata.gz: 907c66f3f805bca23f58fea3c35893b1dd7623e6003d293f04fc8afeb667268a28f0dae259bed2255b97acd8c970cacaebedfc6e8b8d49365a23def27f544aa4
-  data.tar.gz: 5f242c38777b4b9747fdca04e4dc335a9ffb740cc82b2af16dd21558a603786bc7cb5f80ad355423522ca2300a0bfc7664b41af20e0630bdff298d3d730ae821
+  metadata.gz: fd894ee1d6988315558c652f2f9bc7cb91f81cb2ffa12c3f379be7e6737f303d329e0056d8b1bc6f2e2f50688623cdfa23499bf5ceec4417b1ab16d33b9a5b6c
+  data.tar.gz: 05f5e838a611c7ba37d406ccb66e2df50b6f1a30cae552c7fcdbf9b62b59c4b579609008e94b158197a46fd0b3a5fa9dcffd45971d79fb4d040b87989ba49aa9

data/Gemfile

@@ -3,7 +3,8 @@ gemspec
 
 # We support both pre-1.x and post-1.x Faraday versions, but to ensure compatibility we
 # pin this gem against each in separate runs of CI, using the FARADAY_VERSION env var. For
-# more details on the values, see .circleci/config.yml.
+# more details on the values, see .github/workflows/tests.yml in the gocardless-pro-ruby
+# repository.
 if ENV.key?("FARADAY_VERSION")
   gem 'faraday', "~> #{ENV["FARADAY_VERSION"]}"
 end

data/lib/gocardless_pro/api_service.rb

@@ -1,5 +1,3 @@
-# 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.
@@ -35,9 +33,9 @@ module GoCardlessPro
       @headers['Authorization'] = "Bearer #{token}"
       @on_idempotency_conflict = options[:on_idempotency_conflict] || :fetch
 
-      unless %i[fetch raise].include?(@on_idempotency_conflict)
-        raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
-      end
+      return if %i[fetch raise].include?(@on_idempotency_conflict)
+
+      raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
     end
 
     # Make a request to the API
@@ -47,6 +45,7 @@ module GoCardlessPro
     # @param options [Hash] the options hash
     def make_request(method, path, options = {})
       raise ArgumentError, 'options must be a hash' unless options.is_a?(Hash)
+
       options[:headers] ||= {}
       options[:headers] = @headers.merge(options[:headers])
       Request.new(@connection, method, @path_prefix + path, options).request

data/lib/gocardless_pro/client.rb

@@ -133,6 +133,11 @@ module GoCardlessPro
       @scenario_simulators ||= Services::ScenarioSimulatorsService.new(@api_service)
     end
 
+    # Access to the service for scheme_identifier to make API calls
+    def scheme_identifiers
+      @scheme_identifiers ||= Services::SchemeIdentifiersService.new(@api_service)
+    end
+
     # Access to the service for subscription to make API calls
     def subscriptions
       @subscriptions ||= Services::SubscriptionsService.new(@api_service)
@@ -143,6 +148,11 @@ module GoCardlessPro
       @tax_rates ||= Services::TaxRatesService.new(@api_service)
     end
 
+    # Access to the service for verification_detail to make API calls
+    def verification_details
+      @verification_details ||= Services::VerificationDetailsService.new(@api_service)
+    end
+
     # Access to the service for webhook to make API calls
     def webhooks
       @webhooks ||= Services::WebhooksService.new(@api_service)
@@ -195,10 +205,10 @@ module GoCardlessPro
       {
         default_headers: {
           'GoCardless-Version' => '2015-07-06',
-          'User-Agent' => user_agent.to_s,
+          'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.40.0',
+          'GoCardless-Client-Version' => '2.41.1',
         },
       }
     end
@@ -219,7 +229,7 @@ module GoCardlessPro
           comment = [
             "#{ruby_engine}/#{ruby_version}",
             "#{RUBY_ENGINE}/#{interpreter_version}",
-            RUBY_PLATFORM.to_s,
+            "#{RUBY_PLATFORM}",
           ]
           comment << "faraday/#{Faraday::VERSION}"
           "#{gem_info} #{comment.join(' ')}"

data/lib/gocardless_pro/error/invalid_state_error.rb

@@ -10,6 +10,7 @@ module GoCardlessPro
 
     def conflicting_resource_id
       return unless idempotent_creation_conflict?
+
       idempotent_creation_conflict_error['links'][CONFLICTING_RESOURCE_ID]
     end
 

data/lib/gocardless_pro/error.rb

@@ -7,6 +7,7 @@ module GoCardlessPro
     #  @param error the error from the API
     def initialize(error)
       raise ArgumentError, 'GoCardless errors expect a hash' unless error.is_a?(Hash)
+
       @error = error
     end
 

data/lib/gocardless_pro/middlewares/raise_gocardless_errors.rb

@@ -5,18 +5,16 @@ module GoCardlessPro
       CLIENT_ERROR_STATUSES = 400..500
 
       def on_complete(env)
-        if !json?(env) || API_ERROR_STATUSES.include?(env.status)
-          raise ApiError, generate_error_data(env)
-        end
+        raise ApiError, generate_error_data(env) if !json?(env) || API_ERROR_STATUSES.include?(env.status)
 
-        if CLIENT_ERROR_STATUSES.include?(env.status)
-          json_body ||= JSON.parse(env.body) unless env.body.empty?
-          error_type = json_body['error']['type']
+        return unless CLIENT_ERROR_STATUSES.include?(env.status)
 
-          error_class = error_class_for_status(env.status) || error_class_for_type(error_type)
+        json_body ||= JSON.parse(env.body) unless env.body.empty?
+        error_type = json_body['error']['type']
 
-          raise(error_class, json_body['error'])
-        end
+        error_class = error_class_for_status(env.status) || error_class_for_type(error_type)
+
+        raise(error_class, json_body['error'])
       end
 
       private

data/lib/gocardless_pro/request.rb

@@ -52,15 +52,13 @@ module GoCardlessPro
 
       begin
         yield
-      rescue => exception
+      rescue StandardError => e
         requests_attempted += 1
 
-        if requests_attempted < total_requests_allowed && should_retry?(exception)
-          sleep(RETRY_DELAY)
-          retry
-        else
-          raise exception
-        end
+        raise e unless requests_attempted < total_requests_allowed && should_retry?(e)
+
+        sleep(RETRY_DELAY)
+        retry
       end
     end
 

data/lib/gocardless_pro/resources/bank_authorisation.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/bank_details_lookup.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/billing_request.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/billing_request_flow.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/billing_request_template.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/block.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/creditor.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/creditor_bank_account.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/currency_exchange_rate.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/customer.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/customer_bank_account.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/customer_notification.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/event.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/instalment_schedule.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/institution.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/mandate.rb

@@ -1,5 +1,3 @@
-# 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.
@@ -28,6 +26,7 @@ module GoCardlessPro
       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
@@ -45,6 +44,7 @@ module GoCardlessPro
         @reference = object['reference']
         @scheme = object['scheme']
         @status = object['status']
+        @verified_at = object['verified_at']
         @response = response
       end
 

data/lib/gocardless_pro/resources/mandate_import.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/mandate_import_entry.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/mandate_pdf.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/payer_authorisation.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/payment.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/payout.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/payout_item.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/redirect_flow.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/refund.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/scenario_simulator.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/scheme_identifier.rb

@@ -0,0 +1,73 @@
+#
+# 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 scheme_identifier resource returned from the API
+
+    # 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
+      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
+      def initialize(object, response = nil)
+        @object = object
+
+        @address_line1 = object['address_line1']
+        @address_line2 = object['address_line2']
+        @address_line3 = object['address_line3']
+        @can_specify_mandate_reference = object['can_specify_mandate_reference']
+        @city = object['city']
+        @country_code = object['country_code']
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @email = object['email']
+        @id = object['id']
+        @minimum_advance_notice = object['minimum_advance_notice']
+        @name = object['name']
+        @phone_number = object['phone_number']
+        @postal_code = object['postal_code']
+        @reference = object['reference']
+        @region = object['region']
+        @scheme = object['scheme']
+        @status = object['status']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the scheme_identifier resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/subscription.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/tax_rate.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/resources/verification_detail.rb

@@ -0,0 +1,66 @@
+#
+# 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 verification_detail resource returned from the API
+
+    # Details of a creditor that are required for verification
+    class VerificationDetail
+      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 :postal_code
+
+      # Initialize a verification_detail resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @address_line1 = object['address_line1']
+        @address_line2 = object['address_line2']
+        @address_line3 = object['address_line3']
+        @city = object['city']
+        @company_number = object['company_number']
+        @description = object['description']
+        @directors = object['directors']
+        @links = object['links']
+        @postal_code = object['postal_code']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @verification_detail_links ||= Links.new(@links)
+      end
+
+      # Provides the verification_detail 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/webhook.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/gocardless_pro/services/bank_authorisations_service.rb

@@ -16,7 +16,9 @@ module GoCardlessPro
       # @param identity       # Unique identifier, beginning with "BAU".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
-        path = sub_url('/bank_authorisations/:identity', 'identity' => identity)
+        path = sub_url('/bank_authorisations/:identity', {
+                         'identity' => identity,
+                       })
 
         options[:retry_failures] = true
 

data/lib/gocardless_pro/services/billing_request_flows_service.rb

@@ -37,7 +37,9 @@ module GoCardlessPro
       # @param identity       # Unique identifier, beginning with "BRF".
       # @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)
+        path = sub_url('/billing_request_flows/:identity/actions/initialise', {
+                         'identity' => identity,
+                       })
 
         params = options.delete(:params) || {}
         options[:params] = {}

data/lib/gocardless_pro/services/billing_request_templates_service.rb

@@ -45,7 +45,9 @@ module GoCardlessPro
       # @param identity       # Unique identifier, beginning with "BRT".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
-        path = sub_url('/billing_request_templates/:identity', 'identity' => identity)
+        path = sub_url('/billing_request_templates/:identity', {
+                         'identity' => identity,
+                       })
 
         options[:retry_failures] = true
 
@@ -98,7 +100,9 @@ module GoCardlessPro
       # @param identity       # Unique identifier, beginning with "BRQ".
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
-        path = sub_url('/billing_request_templates/:identity', 'identity' => identity)
+        path = sub_url('/billing_request_templates/:identity', {
+                         'identity' => identity,
+                       })
 
         params = options.delete(:params) || {}
         options[:params] = {}