gocardless_pro 2.24.0 → 2.29.0

data/lib/gocardless_pro/services/instalment_schedules_service.rb

@@ -52,8 +52,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
 
@@ -102,8 +100,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
 
@@ -133,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.
@@ -212,8 +208,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/institutions_service.rb

@@ -0,0 +1,56 @@
+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 Institution endpoints
+    class InstitutionsService < BaseService
+      # Returns a list of all supported institutions.
+      # Example URL: /institutions
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/institutions'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Institution
+        )
+      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
+
+      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
+        'institutions'
+      end
+    end
+  end
+end

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/mandate_imports_service.rb

@@ -38,8 +38,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
 
@@ -104,8 +102,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
 
@@ -149,8 +145,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/mandates_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.
@@ -148,8 +146,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
 
@@ -198,8 +194,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/payer_authorisations_service.rb

@@ -0,0 +1,202 @@
+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 PayerAuthorisation endpoints
+    class PayerAuthorisationsService < BaseService
+      # Retrieves the details of a single existing Payer Authorisation. It can be used
+      # for polling the status of a Payer Authorisation.
+      # Example URL: /payer_authorisations/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "PA".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/payer_authorisations/:identity', 'identity' => identity)
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::PayerAuthorisation.new(unenvelope_body(response.body), response)
+      end
+
+      # Creates a Payer Authorisation. The resource is saved to the database even if
+      # incomplete. An empty array of incomplete_fields means that the resource is
+      # valid. The ID of the resource is used for the other actions. This endpoint has
+      # been designed this way so you do not need to save any payer data on your
+      # servers or the browser while still being able to implement a progressive
+      # solution, such as a multi-step form.
+      # Example URL: /payer_authorisations
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/payer_authorisations'
+
+        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::PayerAuthorisation.new(unenvelope_body(response.body), response)
+      end
+
+      # Updates a Payer Authorisation. Updates the Payer Authorisation with the
+      # request data. Can be invoked as many times as needed. Only fields present in
+      # the request will be modified. An empty array of incomplete_fields means that
+      # the resource is valid. This endpoint has been designed this way so you do not
+      # need to save any payer data on your servers or the browser while still being
+      # able to implement a progressive solution, such a multi-step form. <p
+      # class="notice"> Note that in order to update the `metadata` attribute values
+      # it must be sent completely as it overrides the previously existing values.
+      # </p>
+      # Example URL: /payer_authorisations/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "PA".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/payer_authorisations/:identity', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        response = make_request(:put, path, options)
+
+        return if response.body.nil?
+
+        Resources::PayerAuthorisation.new(unenvelope_body(response.body), response)
+      end
+
+      # Submits all the data previously pushed to this PayerAuthorisation for
+      # verification. This time, a 200 HTTP status is returned if the resource is
+      # valid and a 422 error response in case of validation errors. After it is
+      # successfully submitted, the Payer Authorisation can no longer be edited.
+      # Example URL: /payer_authorisations/:identity/actions/submit
+      #
+      # @param identity       # Unique identifier, beginning with "PA".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def submit(identity, options = {})
+        path = sub_url('/payer_authorisations/:identity/actions/submit', '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::PayerAuthorisation.new(unenvelope_body(response.body), response)
+      end
+
+      # Confirms the Payer Authorisation, indicating that the resources are ready to
+      # be created.
+      # A Payer Authorisation cannot be confirmed if it hasn't been submitted yet.
+      #
+      # <p class="notice">
+      #   The main use of the confirm endpoint is to enable integrators to acknowledge
+      # the end of the setup process.
+      #   They might want to make the payers go through some other steps after they go
+      # through our flow or make them go through the necessary verification mechanism
+      # (upcoming feature).
+      # </p>
+      # Example URL: /payer_authorisations/:identity/actions/confirm
+      #
+      # @param identity       # Unique identifier, beginning with "PA".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def confirm(identity, options = {})
+        path = sub_url('/payer_authorisations/:identity/actions/confirm', '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::PayerAuthorisation.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
+        'payer_authorisations'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/payments_service.rb

@@ -39,8 +39,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
 
@@ -70,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.
@@ -150,8 +148,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
 
@@ -198,8 +194,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/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/redirect_flows_service.rb

@@ -35,8 +35,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
 
@@ -100,8 +98,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/refunds_service.rb

@@ -50,8 +50,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
 
@@ -81,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/scenario_simulators_service.rb

@@ -0,0 +1,170 @@
+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 ScenarioSimulator endpoints
+    class ScenarioSimulatorsService < BaseService
+      # Runs the specific scenario simulator against the specific resource
+      # Example URL: /scenario_simulators/:identity/actions/run
+      #
+      # @param identity       # The unique identifier of the simulator, used to initiate simulations.
+      # One of:
+      # <ul>
+      # <li>`creditor_verification_status_action_required`: Sets a creditor's
+      # `verification status` to `action required`, meaning that the creditor
+      # must provide further information to GoCardless in order to verify their
+      # account to receive payouts.</li>
+      # <li>`creditor_verification_status_in_review`: Sets a creditor's
+      # `verification status` to `in review`, meaning that the creditor has
+      # provided all of the information requested by GoCardless to verify their
+      # account, and is now awaiting review.</li>
+      # <li>`creditor_verification_status_successful`: Sets a creditor's
+      # `verification status` to `successful`, meaning that the creditor is
+      # fully verified and can receive payouts.</li>
+      # <li>`payment_confirmed`: Transitions a payment through to `confirmed`.
+      # It must start in the `pending_submission` state, and its mandate must be
+      # in the `activated` state (unless it is a payment for ACH, BECS, BECS_NZ
+      # or SEPA, in which cases the mandate may be `pending_submission`, since
+      # their mandates are submitted with their first payment).</li>
+      # <li>`payment_paid_out`: Transitions a payment through to `paid_out`,
+      # having been collected successfully and paid out to you. It must start in
+      # the `pending_submission` state, and its mandate must be in the
+      # `activated` state (unless it is a payment for ACH, BECS, BECS_NZ or
+      # SEPA, in which cases the mandate may be `pending_submission`, since
+      # their mandates are submitted with their first payment).</li>
+      # <li>`payment_failed`: Transitions a payment through to `failed`. It must
+      # start in the `pending_submission` state, and its mandate must be in the
+      # `activated` state (unless it is a payment for ACH, BECS, BECS_NZ or
+      # SEPA, in which cases the mandate may be `pending_submission`, since
+      # their mandates are submitted with their first payment).</li>
+      # <li>`payment_charged_back`: Behaves the same as the `payout_paid_out`
+      # simulator, except that the payment is transitioned to `charged_back`
+      # after it is paid out, having been charged back by the customer.</li>
+      # <li>`payment_chargeback_settled`: Behaves the same as the
+      # `payment_charged_back` simulator, except that the charged back payment
+      # is additionally included as a debit item in a payout, thereby settling
+      # the charged back payment.</li>
+      # <li>`payment_late_failure`: Transitions a payment through to
+      # `late_failure`, having been apparently collected successfully
+      # beforehand. It must start in the `pending_submission` state, and its
+      # mandate must be in the `activated` state (unless it is a payment for
+      # ACH, BECS, BECS_NZ or SEPA, in which cases the mandate may be
+      # `pending_submission`, since their mandates are submitted with their
+      # first payment). Not compatible with Autogiro mandates.</li>
+      # <li>`payment_late_failure_settled`: Behaves the same as the
+      # `payment_late_failure` simulator, except that the late failure is
+      # additionally included as a debit item in a payout, thereby settling the
+      # late failure.</li>
+      # <li>`payment_submitted`: Transitions a payment to `submitted`, without
+      # proceeding any further. It must start in the `pending_submission`
+      # state.</li>
+      # <li>`mandate_activated`: Transitions a mandate through to `activated`,
+      # having been submitted to the banks and set up successfully. It must
+      # start in the `pending_submission` state. Not compatible with ACH, BECS,
+      # BECS_NZ and SEPA mandates, which are submitted and activated with their
+      # first payment.</li>
+      # <li>`mandate_customer_approval_granted`: Transitions a mandate through
+      # to `pending_submission`, as if the customer approved the mandate
+      # creation. It must start in the `pending_customer_approval` state.
+      # Compatible only with Bacs and SEPA mandates, which support customer
+      # signatures on the mandate. All payments associated with the mandate will
+      # be transitioned to `pending_submission`. All subscriptions associated
+      # with the mandate will become `active`.</li>
+      # <li>`mandate_customer_approval_skipped`: Transitions a mandate through
+      # to `pending_submission`, as if the customer skipped the mandate approval
+      # during the mandate creation process. It must start in the
+      # `pending_customer_approval` state. Compatible only with Bacs and SEPA
+      # mandates, which support customer signatures on the mandate. All payments
+      # associated with the mandate will be transitioned to
+      # `pending_submission`. All subscriptions associated with the mandate will
+      # become `active`.</li>
+      # <li>`mandate_failed`: Transitions a mandate through to `failed`, having
+      # been submitted to the banks but found to be invalid (for example due to
+      # invalid bank details). It must start in the `pending_submission` or
+      # `submitted` states. Not compatible with SEPA mandates, which are
+      # submitted with their first payment.</li>
+      # <li>`mandate_expired`: Transitions a mandate through to `expired`,
+      # having been submitted to the banks, set up successfully and then expired
+      # because no collection attempts were made against it for longer than the
+      # scheme's dormancy period (13 months for Bacs, 3 years for SEPA, 15
+      # months for ACH, Betalingsservice, and BECS). It must start in the
+      # `pending_submission` state. Not compatible with Autogiro, BECS NZ, and
+      # PAD mandates, which do not expire.</li>
+      # <li>`mandate_transferred`: Transitions a mandate through to
+      # `transferred`, having been submitted to the banks, set up successfully
+      # and then moved to a new bank account due to the customer using the UK's
+      # Current Account Switching Service (CASS). It must start in the
+      # `pending_submission` state. Only compatible with Bacs mandates.</li>
+      # <li>`mandate_transferred_with_resubmission`: Transitions a mandate
+      # through `transferred` and resubmits it to the banks, can be caused be
+      # the UK's Current Account Switching Service (CASS) or when a customer
+      # contacts GoCardless to change their bank details. It must start in the
+      # `pending_submission` state. Only compatible with Bacs, SEPA and Autogiro
+      # mandates.</li>
+      # <li>`refund_paid`: Transitions a refund to `paid`. It must start in
+      # either the `pending_submission` or `submitted` state.</li>
+      # <li>`refund_settled`: Transitions a refund to `paid`, if it's not
+      # already, then generates a payout that includes the refund, thereby
+      # settling the funds. It must start in one of `pending_submission`,
+      # `submitted` or `paid` states.</li>
+      # <li>`refund_bounced`: Transitions a refund to `bounced`. It must start
+      # in either the `pending_submission`, `submitted`, or `paid` state.</li>
+      # <li>`refund_returned`: Transitions a refund to `refund_returned`. The
+      # refund must start in `pending_submission`.</li>
+      # <li>`payout_bounced`: Transitions a payout to `bounced`. It must start
+      # in the `paid` state.</li>
+      # <li>`billing_request_fulfilled`: Authorises the billing request, fulfils
+      # it, and moves the associated payment to `failed`. The billing request
+      # must be in the `pending` state, with all actions completed except for
+      # `bank_authorisation`. Only billing requests with a `payment_request` are
+      # supported.</li>
+      # <li>`billing_request_fulfilled_and_payment_failed`: Authorises the
+      # billing request, fulfils it, and moves the associated payment to
+      # `failed`. The billing request must be in the `pending` state, with all
+      # actions completed except for `bank_authorisation`. Only billing requests
+      # with a `payment_request` are supported.</li>
+      # <li>`billing_request_fulfilled_and_payment_paid_out`: Authorises the
+      # billing request, fulfils it, and moves the associated payment to
+      # `paid_out`. The billing request must be in the `pending` state, with all
+      # actions completed except for `bank_authorisation`. Only billing requests
+      # with a `payment_request` are supported.</li>
+      # </ul>
+      # @param options [Hash] parameters as a hash, under a params key.
+      def run(identity, options = {})
+        path = sub_url('/scenario_simulators/:identity/actions/run', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+
+        Resources::ScenarioSimulator.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
+        'scenario_simulators'
+      end
+    end
+  end
+end