gocardless_pro 2.40.0 → 2.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e651254dd1b8ee279f19b5c698c1cc0d71412186c7ffc472cd92d403c694d41f
-  data.tar.gz: 493fc00fae5258c12b24d6a13fff0d2c76db9948b3898a782a6cf4eb59b281c8
+  metadata.gz: 54e49d4ec8bdde6078ef0bef2d7b64552070a6114fc7eb5073ad9df5b8346ad7
+  data.tar.gz: 4e7b1b362161c3f84fba2d2de48a08cf9d3168417c5f96c630c13f8cb9418a06
 SHA512:
-  metadata.gz: 907c66f3f805bca23f58fea3c35893b1dd7623e6003d293f04fc8afeb667268a28f0dae259bed2255b97acd8c970cacaebedfc6e8b8d49365a23def27f544aa4
-  data.tar.gz: 5f242c38777b4b9747fdca04e4dc335a9ffb740cc82b2af16dd21558a603786bc7cb5f80ad355423522ca2300a0bfc7664b41af20e0630bdff298d3d730ae821
+  metadata.gz: 785d50c105361f93a7a0be17ce38f09fc19ebc5b3738eeba6b0aa82212336c61e113b875e1b575c60534c9cdff764f1ce0710a131eeaa1a767d0667a757ca1d6
+  data.tar.gz: 0d0e24924d3e6f1dcfc9353b53ed5124600be89a62744899389c0afb99598d93b9678b85b0054c49174a94097c5cae6a0e59e1cd56ab17e355622ee028fce40f

data/.github/workflows/tests.yml

@@ -1,8 +1,6 @@
 name: gocardless/gocardless-pro-ruby/tests
-on:
-  push:
-    branches:
-    - master
+on: push
+
 env:
   RUBYGEM_PUBLISH_API_KEY: ${{ secrets.RUBYGEM_PUBLISH_API_KEY }}
 jobs:
@@ -25,7 +23,7 @@ jobs:
     - uses: actions/checkout@v2
     - run: bundle install && bundle exec rspec
   publish:
-    if: contains('refs/heads/master', github.ref)
+    if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     container:
       image: ruby:2.6

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/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)
@@ -198,7 +208,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.40.0',
+          'GoCardless-Client-Version' => '2.41.0',
         },
       }
     end

data/lib/gocardless_pro/resources/mandate.rb

@@ -28,6 +28,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 +46,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/scheme_identifier.rb

@@ -0,0 +1,75 @@
+# 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.
+#
+
+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/verification_detail.rb

@@ -0,0 +1,68 @@
+# 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.
+#
+
+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/services/creditors_service.rb

@@ -113,6 +113,50 @@ module GoCardlessPro
         Resources::Creditor.new(unenvelope_body(response.body), response)
       end
 
+      # Applies a [scheme identifier](#core-endpoints-scheme-identifiers) to a
+      # creditor.
+      # If the creditor already has a scheme identifier for the scheme, it will be
+      # replaced,
+      # and any mandates attached to it transferred asynchronously.
+      # For some schemes, the application of the scheme identifier will be performed
+      # asynchronously.
+      #
+      # Example URL: /creditors/:identity/actions/apply_scheme_identifier
+      #
+      # @param identity       # Unique identifier, beginning with "CR".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def apply_scheme_identifier(identity, options = {})
+        path = sub_url('/creditors/:identity/actions/apply_scheme_identifier', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        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, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            end
+          end
+
+          raise e
+        end
+
+        return if response.body.nil?
+
+        Resources::Creditor.new(unenvelope_body(response.body), response)
+      end
+
       private
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/scheme_identifiers_service.rb

@@ -0,0 +1,114 @@
+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 SchemeIdentifier endpoints
+    class SchemeIdentifiersService < BaseService
+      # Creates a new scheme identifier. The scheme identifier must be [applied to a
+      # creditor](#creditors-apply-a-scheme-identifier) before payments are taken
+      # using it. The scheme identifier must also have the `status` of active before
+      # it can be used. For some schemes e.g. faster_payments this will happen
+      # instantly. For other schemes e.g. bacs this can take several days.
+      #
+      # Example URL: /scheme_identifiers
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/scheme_identifiers'
+
+        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, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            end
+          end
+
+          raise e
+        end
+
+        return if response.body.nil?
+
+        Resources::SchemeIdentifier.new(unenvelope_body(response.body), response)
+      end
+
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your scheme
+      # identifiers.
+      # Example URL: /scheme_identifiers
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/scheme_identifiers'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::SchemeIdentifier
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is similar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          options: options
+        ).enumerator
+      end
+
+      # Retrieves the details of an existing scheme identifier.
+      # Example URL: /scheme_identifiers/:identity
+      #
+      # @param identity       # Unique identifier, usually beginning with "SU".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/scheme_identifiers/:identity', 'identity' => identity)
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::SchemeIdentifier.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
+        'scheme_identifiers'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/verification_details_service.rb

@@ -0,0 +1,51 @@
+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 VerificationDetail endpoints
+    class VerificationDetailsService < BaseService
+      # Verification details represent any information needed by GoCardless to verify
+      # a creditor.
+      # Currently, only UK-based companies are supported.
+      # In other words, to submit verification details for a creditor, their
+      # creditor_type must be company and their country_code must be GB.
+      # Example URL: /verification_details
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/verification_details'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+
+        Resources::VerificationDetail.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
+        'verification_details'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/version.rb

@@ -4,5 +4,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '2.40.0'.freeze
+  VERSION = '2.41.0'.freeze
 end

data/lib/gocardless_pro.rb

@@ -119,12 +119,18 @@ require_relative 'gocardless_pro/services/refunds_service'
 require_relative 'gocardless_pro/resources/scenario_simulator'
 require_relative 'gocardless_pro/services/scenario_simulators_service'
 
+require_relative 'gocardless_pro/resources/scheme_identifier'
+require_relative 'gocardless_pro/services/scheme_identifiers_service'
+
 require_relative 'gocardless_pro/resources/subscription'
 require_relative 'gocardless_pro/services/subscriptions_service'
 
 require_relative 'gocardless_pro/resources/tax_rate'
 require_relative 'gocardless_pro/services/tax_rates_service'
 
+require_relative 'gocardless_pro/resources/verification_detail'
+require_relative 'gocardless_pro/services/verification_details_service'
+
 require_relative 'gocardless_pro/resources/webhook'
 require_relative 'gocardless_pro/services/webhooks_service'
 

data/spec/resources/creditor_spec.rb

@@ -562,4 +562,98 @@ describe GoCardlessPro::Resources::Creditor do
       end
     end
   end
+
+  describe '#apply_scheme_identifier' do
+    subject(:post_response) { client.creditors.apply_scheme_identifier(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /creditors/%v/actions/apply_scheme_identifier
+      stub_url = '/creditors/:identity/actions/apply_scheme_identifier'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
+        body: {
+          'creditors' => {
+
+            'activated' => 'activated-input',
+            'address_line1' => 'address_line1-input',
+            'address_line2' => 'address_line2-input',
+            'address_line3' => 'address_line3-input',
+            'can_create_refunds' => 'can_create_refunds-input',
+            'city' => 'city-input',
+            'country_code' => 'country_code-input',
+            'created_at' => 'created_at-input',
+            'creditor_type' => 'creditor_type-input',
+            'custom_payment_pages_enabled' => 'custom_payment_pages_enabled-input',
+            'fx_payout_currency' => 'fx_payout_currency-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'logo_url' => 'logo_url-input',
+            'mandate_imports_enabled' => 'mandate_imports_enabled-input',
+            'merchant_responsible_for_notifications' => 'merchant_responsible_for_notifications-input',
+            'name' => 'name-input',
+            'postal_code' => 'postal_code-input',
+            'region' => 'region-input',
+            'scheme_identifiers' => 'scheme_identifiers-input',
+            'verification_status' => 'verification_status-input',
+          },
+        }.to_json,
+
+        headers: response_headers
+      )
+    end
+
+    it 'wraps the response and calls the right endpoint' do
+      expect(post_response).to be_a(GoCardlessPro::Resources::Creditor)
+
+      expect(stub).to have_been_requested
+    end
+
+    context 'when the request needs a body and custom header' do
+      let(:body) { { foo: 'bar' } }
+      let(:headers) { { 'Foo' => 'Bar' } }
+      subject(:post_response) { client.creditors.apply_scheme_identifier(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /creditors/%v/actions/apply_scheme_identifier
+        stub_url = '/creditors/:identity/actions/apply_scheme_identifier'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'creditors' => {
+
+                'activated' => 'activated-input',
+                'address_line1' => 'address_line1-input',
+                'address_line2' => 'address_line2-input',
+                'address_line3' => 'address_line3-input',
+                'can_create_refunds' => 'can_create_refunds-input',
+                'city' => 'city-input',
+                'country_code' => 'country_code-input',
+                'created_at' => 'created_at-input',
+                'creditor_type' => 'creditor_type-input',
+                'custom_payment_pages_enabled' => 'custom_payment_pages_enabled-input',
+                'fx_payout_currency' => 'fx_payout_currency-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'logo_url' => 'logo_url-input',
+                'mandate_imports_enabled' => 'mandate_imports_enabled-input',
+                'merchant_responsible_for_notifications' => 'merchant_responsible_for_notifications-input',
+                'name' => 'name-input',
+                'postal_code' => 'postal_code-input',
+                'region' => 'region-input',
+                'scheme_identifiers' => 'scheme_identifiers-input',
+                'verification_status' => 'verification_status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
 end