gocardless_pro 2.24.0 → 2.29.0

data/lib/gocardless_pro/resources/institution.rb

@@ -0,0 +1,47 @@
+# 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 institution resource returned from the API
+
+    # 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
+      attr_reader :name
+
+      # Initialize a institution resource instance
+      # @param object [Hash] an object returned from the API
+      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']
+        @name = object['name']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the institution resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/payer_authorisation.rb

@@ -0,0 +1,131 @@
+# 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 payer_authorisation resource returned from the API
+
+    # <p class="restricted-notice">
+    #   Payer Authorisations is deprecated in favour of
+    #   <a
+    # href="https://developer.gocardless.com/getting-started/billing-requests/overview/">
+    #   Billing Requests</a>. Please consider using Billing Requests to build
+    # any
+    #   future integrations.
+    # </p>
+    #
+    # Payer Authorisation resource acts as a wrapper for creating customer, bank
+    # account and mandate details in a single request.
+    # PayerAuthorisation API enables the integrators to build their own custom
+    # payment pages.
+    #
+    # The process to use the Payer Authorisation API is as follows:
+    #
+    #   1. Create a Payer Authorisation, either empty or with already available
+    # information
+    #   2. Update the authorisation with additional information or fix any
+    # mistakes
+    #   3. Submit the authorisation, after the payer has reviewed their
+    # information
+    #   4. [coming soon] Redirect the payer to the verification mechanisms from
+    # the response of the Submit request (this will be introduced as a
+    # non-breaking change)
+    #   5. Confirm the authorisation to indicate that the resources can be
+    # created
+    #
+    # After the Payer Authorisation is confirmed, resources will eventually be
+    # created as it's an asynchronous process.
+    #
+    # To retrieve the status and ID of the linked resources you can do one of
+    # the following:
+    # <ol>
+    #   <li> Listen to <code>  payer_authorisation_completed </code>  <a
+    # href="#appendix-webhooks"> webhook</a> (recommended)</li>
+    #   <li> Poll the GET <a
+    # href="#payer-authorisations-get-a-single-payer-authorisation">
+    # endpoint</a></li>
+    #   <li> Poll the GET events API
+    # <code>https://api.gocardless.com/events?payer_authorisation={id}&action=completed</code>
+    # </li>
+    # </ol>
+    #
+    # <p class="notice">
+    #   Note that the `create` and `update` endpoints behave differently than
+    #   other existing `create` and `update` endpoints. The Payer Authorisation
+    # is still saved if incomplete data is provided.
+    #   We return the list of incomplete data in the `incomplete_fields` along
+    # with the resources in the body of the response.
+    #   The bank account details(account_number, bank_code & branch_code) must
+    # be sent together rather than splitting across different request for both
+    # `create` and `update` endpoints.
+    #   <br><br>
+    #   The API is designed to be flexible and allows you to collect information
+    # in multiple steps without storing any sensitive data in the browser or in
+    # your servers.
+    # </p>
+    class PayerAuthorisation
+      attr_reader :bank_account
+      attr_reader :created_at
+      attr_reader :customer
+      attr_reader :id
+      attr_reader :incomplete_fields
+      attr_reader :mandate
+      attr_reader :status
+
+      # Initialize a payer_authorisation resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @bank_account = object['bank_account']
+        @created_at = object['created_at']
+        @customer = object['customer']
+        @id = object['id']
+        @incomplete_fields = object['incomplete_fields']
+        @links = object['links']
+        @mandate = object['mandate']
+        @status = object['status']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @payer_authorisation_links ||= Links.new(@links)
+      end
+
+      # Provides the payer_authorisation resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def bank_account
+          @links['bank_account']
+        end
+
+        def customer
+          @links['customer']
+        end
+
+        def mandate
+          @links['mandate']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/payout_item.rb

@@ -73,6 +73,10 @@ module GoCardlessPro
         def payment
           @links['payment']
         end
+
+        def refund
+          @links['refund']
+        end
       end
     end
   end

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/resources/scenario_simulator.rb

@@ -0,0 +1,42 @@
+# 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 scenario_simulator resource returned from the API
+
+    # Scenario Simulators allow you to manually trigger and test certain paths
+    # that your
+    # integration will encounter in the real world. These endpoints are only
+    # active in the
+    # sandbox environment.
+    class ScenarioSimulator
+      attr_reader :id
+
+      # Initialize a scenario_simulator resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @id = object['id']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the scenario_simulator resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/webhook.rb

@@ -0,0 +1,62 @@
+# 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 webhook resource returned from the API
+
+    # Basic description of a webhook
+    class Webhook
+      attr_reader :created_at
+      attr_reader :id
+      attr_reader :is_test
+      attr_reader :request_body
+      attr_reader :request_headers
+      attr_reader :response_body
+      attr_reader :response_body_truncated
+      attr_reader :response_code
+      attr_reader :response_headers
+      attr_reader :response_headers_content_truncated
+      attr_reader :response_headers_count_truncated
+      attr_reader :successful
+      attr_reader :url
+
+      # Initialize a webhook resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @created_at = object['created_at']
+        @id = object['id']
+        @is_test = object['is_test']
+        @request_body = object['request_body']
+        @request_headers = object['request_headers']
+        @response_body = object['response_body']
+        @response_body_truncated = object['response_body_truncated']
+        @response_code = object['response_code']
+        @response_headers = object['response_headers']
+        @response_headers_content_truncated = object['response_headers_content_truncated']
+        @response_headers_count_truncated = object['response_headers_count_truncated']
+        @successful = object['successful']
+        @url = object['url']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the webhook resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/bank_authorisations_service.rb

@@ -0,0 +1,80 @@
+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 BankAuthorisation endpoints
+    class BankAuthorisationsService < BaseService
+      # Fetches a bank authorisation
+      # Example URL: /bank_authorisations/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "BAU".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/bank_authorisations/:identity', 'identity' => identity)
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::BankAuthorisation.new(unenvelope_body(response.body), response)
+      end
+
+      # Create a Bank Authorisation.
+      # Example URL: /bank_authorisations
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/bank_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::BankAuthorisation.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
+        'bank_authorisations'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/billing_request_flows_service.rb

@@ -0,0 +1,70 @@
+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 BillingRequestFlow endpoints
+    class BillingRequestFlowsService < BaseService
+      # Creates a new billing request flow.
+      # Example URL: /billing_request_flows
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/billing_request_flows'
+
+        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::BillingRequestFlow.new(unenvelope_body(response.body), response)
+      end
+
+      # Returns the flow having generated a fresh session token which can be used to
+      # power
+      # integrations that manipulate the flow.
+      # Example URL: /billing_request_flows/:identity/actions/initialise
+      #
+      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def initialise(identity, options = {})
+        path = sub_url('/billing_request_flows/:identity/actions/initialise', 'identity' => identity)
+
+        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::BillingRequestFlow.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_request_flows'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/billing_request_templates_service.rb

@@ -0,0 +1,131 @@
+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 BillingRequestTemplate endpoints
+    class BillingRequestTemplatesService < BaseService
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
+      # Billing Request Templates.
+      # Example URL: /billing_request_templates
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/billing_request_templates'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::BillingRequestTemplate
+        )
+      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
+
+      # Fetches a Billing Request Template
+      # Example URL: /billing_request_templates/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "BRT".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/billing_request_templates/:identity', 'identity' => identity)
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::BillingRequestTemplate.new(unenvelope_body(response.body), response)
+      end
+
+      #
+      # Example URL: /billing_request_templates
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/billing_request_templates'
+
+        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::BillingRequestTemplate.new(unenvelope_body(response.body), response)
+      end
+
+      # Updates a Billing Request Template, which will affect all future Billing
+      # Requests created by this template.
+      # 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_request_templates/: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::BillingRequestTemplate.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_request_templates'
+      end
+    end
+  end
+end