gocardless_pro 2.24.0 → 2.29.0

data/lib/gocardless_pro/services/billing_requests_service.rb

@@ -0,0 +1,352 @@
+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 BillingRequest endpoints
+    class BillingRequestsService < BaseService
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
+      # billing_requests.
+      # Example URL: /billing_requests
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/billing_requests'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::BillingRequest
+        )
+      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
+
+      #
+      # Example URL: /billing_requests
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/billing_requests'
+
+        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::BillingRequest.new(unenvelope_body(response.body), response)
+      end
+
+      # Fetches a billing request
+      # Example URL: /billing_requests/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/billing_requests/:identity', 'identity' => identity)
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::BillingRequest.new(unenvelope_body(response.body), response)
+      end
+
+      # If the billing request has a pending <code>collect_customer_details</code>
+      # action, this endpoint can be used to collect the details in order to
+      # complete it.
+      #
+      # The endpoint takes the same payload as Customers, but checks that the
+      # customer fields are populated correctly for the billing request scheme.
+      #
+      # Whatever is provided to this endpoint is used to update the referenced
+      # customer, and will take effect immediately after the request is
+      # successful.
+      # Example URL: /billing_requests/:identity/actions/collect_customer_details
+      #
+      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def collect_customer_details(identity, options = {})
+        path = sub_url('/billing_requests/:identity/actions/collect_customer_details', '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::BillingRequest.new(unenvelope_body(response.body), response)
+      end
+
+      # If the billing request has a pending
+      # <code>collect_bank_account</code> action, this endpoint can be
+      # used to collect the details in order to complete it.
+      #
+      # The endpoint takes the same payload as Customer Bank Accounts, but check
+      # the bank account is valid for the billing request scheme before creating
+      # and attaching it.
+      # Example URL: /billing_requests/:identity/actions/collect_bank_account
+      #
+      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def collect_bank_account(identity, options = {})
+        path = sub_url('/billing_requests/:identity/actions/collect_bank_account', '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::BillingRequest.new(unenvelope_body(response.body), response)
+      end
+
+      # If a billing request is ready to be fulfilled, call this endpoint to cause
+      # it to fulfil, executing the payment.
+      # Example URL: /billing_requests/:identity/actions/fulfil
+      #
+      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def fulfil(identity, options = {})
+        path = sub_url('/billing_requests/:identity/actions/fulfil', '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::BillingRequest.new(unenvelope_body(response.body), response)
+      end
+
+      # This is needed when you have mandate_request. As a scheme compliance rule we
+      # are required to
+      # allow the payer to crosscheck the details entered by them and confirm it.
+      # Example URL: /billing_requests/:identity/actions/confirm_payer_details
+      #
+      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def confirm_payer_details(identity, options = {})
+        path = sub_url('/billing_requests/:identity/actions/confirm_payer_details', '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::BillingRequest.new(unenvelope_body(response.body), response)
+      end
+
+      # Immediately cancels a billing request, causing all billing request flows
+      # to expire.
+      # Example URL: /billing_requests/:identity/actions/cancel
+      #
+      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def cancel(identity, options = {})
+        path = sub_url('/billing_requests/:identity/actions/cancel', '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::BillingRequest.new(unenvelope_body(response.body), response)
+      end
+
+      # Notifies the customer linked to the billing request, asking them to authorise
+      # it.
+      # Currently, the customer can only be notified by email.
+      # Example URL: /billing_requests/:identity/actions/notify
+      #
+      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def notify(identity, options = {})
+        path = sub_url('/billing_requests/:identity/actions/notify', '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::BillingRequest.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
+        'billing_requests'
+      end
+    end
+  end
+end

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

@@ -34,8 +34,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -65,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.
@@ -126,8 +124,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/services/creditors_service.rb

@@ -34,8 +34,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -65,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

@@ -46,8 +46,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -77,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.
@@ -159,8 +157,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/services/customers_service.rb

@@ -34,8 +34,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -65,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.