gocardless_pro 2.28.0 → 2.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed30309cc0e32f7ec8fe6136447f06a06b7f6b42fea7ccadd35313cd2a5ca0a1
-  data.tar.gz: cd88fcef318324644a91336c487e2704283e12120c938bc48bfbba5cbaa36919
+  metadata.gz: ae7ce2e7f276bbb9d36b64093e6be341e1f76325a7ced35710e8276360c2df22
+  data.tar.gz: 554e6c6c947c94c76d250fafabdc3867b65ca218269ce70395fe5a0079fdb5e5
 SHA512:
-  metadata.gz: af3903ffe4dc7425072a286abc535fa379fd8d293307112d6f26b66d1ed283b7f8a440cddf833f255b13507b09ed5671d43e30773b1b50305c736ae30c84520b
-  data.tar.gz: c1f579f53780f7c1f96464810e2a5186fddf1d041af62f7cf975fa6d7e4304c1d149b74ff9fdf3d07985e41bb1ee46eb71ac67d556aab49343e85650e02f06b7
+  metadata.gz: fb5865c593f89c21fe7b1d9ea930c2683286753f9635dcb0e70350ac4fd5af02345a6c472c8b9940484242f6f39cfd05fcdbca0c5a96c3e7cad66f2bf5cf42e6
+  data.tar.gz: 55605f88d457f5a0e8bb3445b9a796dbe1332a94eb3c1ab86318c4bce49d4ab88fcaf6a27ed67c01e4195f6b73eb40ede88d86f3f5998b09b348eb5e5a7a26d0

data/lib/gocardless_pro/client.rb

@@ -28,6 +28,11 @@ module GoCardlessPro
       @billing_request_templates ||= Services::BillingRequestTemplatesService.new(@api_service)
     end
 
+    # Access to the service for block to make API calls
+    def blocks
+      @blocks ||= Services::BlocksService.new(@api_service)
+    end
+
     # Access to the service for creditor to make API calls
     def creditors
       @creditors ||= Services::CreditorsService.new(@api_service)
@@ -193,7 +198,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.28.0',
+          'GoCardless-Client-Version' => '2.29.0',
         },
       }
     end

data/lib/gocardless_pro/resources/bank_authorisation.rb

@@ -75,10 +75,6 @@ module GoCardlessPro
         def institution
           @links['institution']
         end
-
-        def payment_request
-          @links['payment_request']
-        end
       end
     end
   end

data/lib/gocardless_pro/resources/block.rb

@@ -0,0 +1,66 @@
+# 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 block resource returned from the API
+
+    # A block object is a simple rule, when matched, pushes a newly created
+    # mandate to a blocked state. These details can be an exact match, like a
+    # bank account
+    # or an email, or a more generic match such as an email domain. New block
+    # types may be added
+    # over time. Payments and subscriptions can't be created against mandates in
+    # blocked state.
+    #
+    # <p class="notice">
+    #   Client libraries have not yet been updated for this API but will be
+    # released soon.
+    #   This API is currently only available for approved integrators - please
+    # <a href="mailto:help@gocardless.com">get in touch</a> if you would like to
+    # use this API.
+    # </p>
+    class Block
+      attr_reader :active
+      attr_reader :block_type
+      attr_reader :created_at
+      attr_reader :id
+      attr_reader :reason_description
+      attr_reader :reason_type
+      attr_reader :resource_reference
+      attr_reader :updated_at
+
+      # Initialize a block resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @active = object['active']
+        @block_type = object['block_type']
+        @created_at = object['created_at']
+        @id = object['id']
+        @reason_description = object['reason_description']
+        @reason_type = object['reason_type']
+        @resource_reference = object['resource_reference']
+        @updated_at = object['updated_at']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the block resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/event.rb

@@ -60,6 +60,18 @@ module GoCardlessPro
           @links = links || {}
         end
 
+        def bank_authorisation
+          @links['bank_authorisation']
+        end
+
+        def billing_request
+          @links['billing_request']
+        end
+
+        def billing_request_flow
+          @links['billing_request_flow']
+        end
+
         def creditor
           @links['creditor']
         end
@@ -80,6 +92,10 @@ module GoCardlessPro
           @links['mandate']
         end
 
+        def mandate_request_mandate
+          @links['mandate_request_mandate']
+        end
+
         def new_customer_bank_account
           @links['new_customer_bank_account']
         end
@@ -104,6 +120,10 @@ module GoCardlessPro
           @links['payment']
         end
 
+        def payment_request_payment
+          @links['payment_request_payment']
+        end
+
         def payout
           @links['payout']
         end

data/lib/gocardless_pro/resources/institution.rb

@@ -15,6 +15,7 @@ module GoCardlessPro
     # Institutions that are supported when creating [Bank
     # Authorisations](#billing-requests-bank-authorisations).
     class Institution
+      attr_reader :country_code
       attr_reader :icon_url
       attr_reader :id
       attr_reader :logo_url
@@ -25,6 +26,7 @@ module GoCardlessPro
       def initialize(object, response = nil)
         @object = object
 
+        @country_code = object['country_code']
         @icon_url = object['icon_url']
         @id = object['id']
         @logo_url = object['logo_url']

data/lib/gocardless_pro/resources/redirect_flow.rb

@@ -49,6 +49,7 @@ module GoCardlessPro
       attr_reader :created_at
       attr_reader :description
       attr_reader :id
+      attr_reader :mandate_reference
       attr_reader :metadata
       attr_reader :redirect_url
       attr_reader :scheme
@@ -65,6 +66,7 @@ module GoCardlessPro
         @description = object['description']
         @id = object['id']
         @links = object['links']
+        @mandate_reference = object['mandate_reference']
         @metadata = object['metadata']
         @redirect_url = object['redirect_url']
         @scheme = object['scheme']

data/lib/gocardless_pro/services/billing_request_templates_service.rb

@@ -28,7 +28,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.
@@ -93,12 +93,12 @@ module GoCardlessPro
 
       # Updates a Billing Request Template, which will affect all future Billing
       # Requests created by this template.
-      # Example URL: /billing_requests/:identity
+      # Example URL: /billing_request_templates/:identity
       #
       # @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_requests/:identity', 'identity' => identity)
+        path = sub_url('/billing_request_templates/:identity', 'identity' => identity)
 
         params = options.delete(:params) || {}
         options[:params] = {}

data/lib/gocardless_pro/services/billing_requests_service.rb

@@ -28,7 +28,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/blocks_service.rb

@@ -0,0 +1,223 @@
+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 Block endpoints
+    class BlocksService < BaseService
+      # Creates a new Block of a given type. By default it will be active.
+      # Example URL: /blocks
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/blocks'
+
+        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::Block.new(unenvelope_body(response.body), response)
+      end
+
+      # Retrieves the details of an existing block.
+      # Example URL: /blocks/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "BLC".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/blocks/:identity', 'identity' => identity)
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::Block.new(unenvelope_body(response.body), response)
+      end
+
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
+      # blocks.
+      # Example URL: /blocks
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/blocks'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Block
+        )
+      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
+
+      # Disables a block so that it no longer will prevent mandate creation.
+      # Example URL: /blocks/:identity/actions/disable
+      #
+      # @param identity       # Unique identifier, beginning with "BLC".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def disable(identity, options = {})
+        path = sub_url('/blocks/:identity/actions/disable', '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::Block.new(unenvelope_body(response.body), response)
+      end
+
+      # Enables a previously disabled block so that it will prevent mandate creation
+      # Example URL: /blocks/:identity/actions/enable
+      #
+      # @param identity       # Unique identifier, beginning with "BLC".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def enable(identity, options = {})
+        path = sub_url('/blocks/:identity/actions/enable', '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::Block.new(unenvelope_body(response.body), response)
+      end
+
+      # Creates new blocks for a given reference. By default blocks will be active.
+      # Returns 201 if at least one block was created. Returns 200 if there were no
+      # new
+      # blocks created.
+      # Example URL: /block_by_ref
+      # @param options [Hash] parameters as a hash, under a params key.
+      def block_by_ref(options = {})
+        path = '/block_by_ref'
+
+        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
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Block
+        )
+      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
+        'blocks'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/creditor_bank_accounts_service.rb

@@ -63,7 +63,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/creditors_service.rb

@@ -63,7 +63,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/currency_exchange_rates_service.rb

@@ -28,7 +28,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/customer_bank_accounts_service.rb

@@ -75,7 +75,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/customers_service.rb

@@ -63,7 +63,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/events_service.rb

@@ -28,7 +28,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/instalment_schedules_service.rb

@@ -129,7 +129,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/institutions_service.rb

@@ -27,7 +27,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/mandate_import_entries_service.rb

@@ -60,7 +60,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/mandates_service.rb

@@ -63,7 +63,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/payments_service.rb

@@ -68,7 +68,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/payout_items_service.rb

@@ -29,7 +29,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/payouts_service.rb

@@ -28,7 +28,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/refunds_service.rb

@@ -79,7 +79,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -63,7 +63,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/tax_rates_service.rb

@@ -28,7 +28,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/services/webhooks_service.rb

@@ -28,7 +28,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # 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.

data/lib/gocardless_pro/version.rb

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

data/lib/gocardless_pro.rb

@@ -56,6 +56,9 @@ require_relative 'gocardless_pro/services/billing_request_flows_service'
 require_relative 'gocardless_pro/resources/billing_request_template'
 require_relative 'gocardless_pro/services/billing_request_templates_service'
 
+require_relative 'gocardless_pro/resources/block'
+require_relative 'gocardless_pro/services/blocks_service'
+
 require_relative 'gocardless_pro/resources/creditor'
 require_relative 'gocardless_pro/services/creditors_service'
 

data/spec/resources/billing_request_template_spec.rb

@@ -466,7 +466,7 @@ describe GoCardlessPro::Resources::BillingRequestTemplate do
       let(:update_params) { { 'hello' => 'world' } }
 
       let!(:stub) do
-        stub_url = '/billing_requests/:identity'.gsub(':identity', id)
+        stub_url = '/billing_request_templates/:identity'.gsub(':identity', id)
         stub_request(:put, /.*api.gocardless.com#{stub_url}/).to_return(
           body: {
             'billing_request_templates' => {