gocardless_pro 2.23.0 → 2.28.0

data/lib/gocardless_pro/resources/billing_request_flow.rb

@@ -0,0 +1,72 @@
+# 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 billing_request_flow resource returned from the API
+
+    # Billing Request Flows can be created to enable a payer to authorise a
+    # payment created for a scheme with strong payer
+    # authorisation (such as open banking single payments).
+    class BillingRequestFlow
+      attr_reader :authorisation_url
+      attr_reader :auto_fulfil
+      attr_reader :created_at
+      attr_reader :expires_at
+      attr_reader :id
+      attr_reader :lock_bank_account
+      attr_reader :lock_customer_details
+      attr_reader :redirect_uri
+      attr_reader :session_token
+
+      # Initialize a billing_request_flow resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @authorisation_url = object['authorisation_url']
+        @auto_fulfil = object['auto_fulfil']
+        @created_at = object['created_at']
+        @expires_at = object['expires_at']
+        @id = object['id']
+        @links = object['links']
+        @lock_bank_account = object['lock_bank_account']
+        @lock_customer_details = object['lock_customer_details']
+        @redirect_uri = object['redirect_uri']
+        @session_token = object['session_token']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @billing_request_flow_links ||= Links.new(@links)
+      end
+
+      # Provides the billing_request_flow resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def billing_request
+          @links['billing_request']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/billing_request_template.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+#
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
+#
+
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Represents an instance of a billing_request_template resource returned from the API
+
+    # Billing Request Templates
+    class BillingRequestTemplate
+      attr_reader :authorisation_url
+      attr_reader :created_at
+      attr_reader :id
+      attr_reader :mandate_request_currency
+      attr_reader :mandate_request_metadata
+      attr_reader :mandate_request_scheme
+      attr_reader :mandate_request_verify
+      attr_reader :metadata
+      attr_reader :name
+      attr_reader :payment_request_amount
+      attr_reader :payment_request_currency
+      attr_reader :payment_request_description
+      attr_reader :payment_request_metadata
+      attr_reader :payment_request_scheme
+      attr_reader :redirect_uri
+      attr_reader :updated_at
+
+      # Initialize a billing_request_template resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @authorisation_url = object['authorisation_url']
+        @created_at = object['created_at']
+        @id = object['id']
+        @mandate_request_currency = object['mandate_request_currency']
+        @mandate_request_metadata = object['mandate_request_metadata']
+        @mandate_request_scheme = object['mandate_request_scheme']
+        @mandate_request_verify = object['mandate_request_verify']
+        @metadata = object['metadata']
+        @name = object['name']
+        @payment_request_amount = object['payment_request_amount']
+        @payment_request_currency = object['payment_request_currency']
+        @payment_request_description = object['payment_request_description']
+        @payment_request_metadata = object['payment_request_metadata']
+        @payment_request_scheme = object['payment_request_scheme']
+        @redirect_uri = object['redirect_uri']
+        @updated_at = object['updated_at']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the billing_request_template resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/creditor.rb

@@ -17,9 +17,8 @@ module GoCardlessPro
     # organisation will have a single "creditor", but the API also supports
     # collecting payments on behalf of others.
     #
-    # Please get in touch if you wish to use this endpoint. Currently, for Anti
-    # Money Laundering reasons, any creditors you add must be directly related
-    # to your organisation.
+    # Currently, for Anti Money Laundering reasons, any creditors you add must
+    # be directly related to your organisation.
     class Creditor
       attr_reader :address_line1
       attr_reader :address_line2

data/lib/gocardless_pro/resources/event.rb

@@ -64,6 +64,14 @@ module GoCardlessPro
           @links['creditor']
         end
 
+        def customer
+          @links['customer']
+        end
+
+        def customer_bank_account
+          @links['customer_bank_account']
+        end
+
         def instalment_schedule
           @links['instalment_schedule']
         end
@@ -88,6 +96,10 @@ module GoCardlessPro
           @links['parent_event']
         end
 
+        def payer_authorisation
+          @links['payer_authorisation']
+        end
+
         def payment
           @links['payment']
         end

data/lib/gocardless_pro/resources/institution.rb

@@ -0,0 +1,45 @@
+# 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 :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
+
+        @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/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/tax_rate.rb

@@ -13,6 +13,9 @@ module GoCardlessPro
     # Represents an instance of a tax_rate resource returned from the API
 
     # Tax rates from tax authority.
+    #
+    # We also maintain a [static list of the tax rates for each
+    # jurisdiction](#appendix-tax-rates).
     class TaxRate
       attr_reader :end_date
       attr_reader :id

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