gocardless_pro 2.25.0 → 2.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1d21b1955fd8db168185745bd1afbd46fd7c3fa434006abf5c0e838cd7507e
-  data.tar.gz: ef057338fc37aa2e791ef3dcd7536a50ff55711e7d8fa5762a51d6797395cab6
+  metadata.gz: 36f326b7d949867117fd93ecbe9074fcdb54ee3b690f046c2e48e16ce92281dc
+  data.tar.gz: dba0ba60c85f16a5d3c87f311ea6b4b73d93a438441a2ff96c962669c56f7630
 SHA512:
-  metadata.gz: 7c1daafd49f92798ff81c407809ecf888429f2c723801c42b49dfe4d7d7351ae818925c46d897784f798c7d4ee2c7089959594cec38ab0fc6df3472f481d0207
-  data.tar.gz: 78eb4cd3154aa14fe50e445cd94605fe39f91893564650948717e84356fb7d374357ecbfad08784be2c21221fc096530e85407c8a1a3eb794b2ab5d40d0024d1
+  metadata.gz: 5e5939895e083285066011907aad6a992fbb1f65b86392482964a4c856f64bf2834d9a63bb20faf2e7d3c00d5fa27e32ec0c2a9c4770f805ef2db2ba2983c79f
+  data.tar.gz: da519896309a48029ff7d5fb47f2747234b119fb7b539a8701892fe19ea2c921d3606cd66dc9ed4ce70f891a408a979176de5806881a44ce6a82b600aa8cb91b

data/.circleci/config.yml

@@ -22,11 +22,11 @@ workflows:
           matrix:
             parameters:
               faraday-version: ["0.9.2", "1.0"]
-              ruby-version: ["2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7"]
+              ruby-version: ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "3.0"]
             exclude:
-              - faraday-version: "1.0"
-                ruby-version: "2.0"
               - faraday-version: "1.0"
                 ruby-version: "2.1"
               - faraday-version: "1.0"
                 ruby-version: "2.2"
+              - faraday-version: "0.9.2"
+                ruby-version: "3.0"

data/lib/gocardless_pro.rb

@@ -38,9 +38,18 @@ require_relative 'gocardless_pro/response'
 require_relative 'gocardless_pro/api_response'
 require_relative 'gocardless_pro/webhook'
 
+require_relative 'gocardless_pro/resources/bank_authorisation'
+require_relative 'gocardless_pro/services/bank_authorisations_service'
+
 require_relative 'gocardless_pro/resources/bank_details_lookup'
 require_relative 'gocardless_pro/services/bank_details_lookups_service'
 
+require_relative 'gocardless_pro/resources/billing_request'
+require_relative 'gocardless_pro/services/billing_requests_service'
+
+require_relative 'gocardless_pro/resources/billing_request_flow'
+require_relative 'gocardless_pro/services/billing_request_flows_service'
+
 require_relative 'gocardless_pro/resources/creditor'
 require_relative 'gocardless_pro/services/creditors_service'
 
@@ -65,6 +74,9 @@ require_relative 'gocardless_pro/services/events_service'
 require_relative 'gocardless_pro/resources/instalment_schedule'
 require_relative 'gocardless_pro/services/instalment_schedules_service'
 
+require_relative 'gocardless_pro/resources/institution'
+require_relative 'gocardless_pro/services/institutions_service'
+
 require_relative 'gocardless_pro/resources/mandate'
 require_relative 'gocardless_pro/services/mandates_service'
 
@@ -95,10 +107,16 @@ require_relative 'gocardless_pro/services/redirect_flows_service'
 require_relative 'gocardless_pro/resources/refund'
 require_relative 'gocardless_pro/services/refunds_service'
 
+require_relative 'gocardless_pro/resources/scenario_simulator'
+require_relative 'gocardless_pro/services/scenario_simulators_service'
+
 require_relative 'gocardless_pro/resources/subscription'
 require_relative 'gocardless_pro/services/subscriptions_service'
 
 require_relative 'gocardless_pro/resources/tax_rate'
 require_relative 'gocardless_pro/services/tax_rates_service'
 
+require_relative 'gocardless_pro/resources/webhook'
+require_relative 'gocardless_pro/services/webhooks_service'
+
 require_relative 'gocardless_pro/client.rb'

data/lib/gocardless_pro/client.rb

@@ -3,11 +3,26 @@ module GoCardlessPro
   class Client
     extend Forwardable
 
+    # Access to the service for bank_authorisation to make API calls
+    def bank_authorisations
+      @bank_authorisations ||= Services::BankAuthorisationsService.new(@api_service)
+    end
+
     # Access to the service for bank_details_lookup to make API calls
     def bank_details_lookups
       @bank_details_lookups ||= Services::BankDetailsLookupsService.new(@api_service)
     end
 
+    # Access to the service for billing_request to make API calls
+    def billing_requests
+      @billing_requests ||= Services::BillingRequestsService.new(@api_service)
+    end
+
+    # Access to the service for billing_request_flow to make API calls
+    def billing_request_flows
+      @billing_request_flows ||= Services::BillingRequestFlowsService.new(@api_service)
+    end
+
     # Access to the service for creditor to make API calls
     def creditors
       @creditors ||= Services::CreditorsService.new(@api_service)
@@ -48,6 +63,11 @@ module GoCardlessPro
       @instalment_schedules ||= Services::InstalmentSchedulesService.new(@api_service)
     end
 
+    # Access to the service for institution to make API calls
+    def institutions
+      @institutions ||= Services::InstitutionsService.new(@api_service)
+    end
+
     # Access to the service for mandate to make API calls
     def mandates
       @mandates ||= Services::MandatesService.new(@api_service)
@@ -98,6 +118,11 @@ module GoCardlessPro
       @refunds ||= Services::RefundsService.new(@api_service)
     end
 
+    # Access to the service for scenario_simulator to make API calls
+    def scenario_simulators
+      @scenario_simulators ||= Services::ScenarioSimulatorsService.new(@api_service)
+    end
+
     # Access to the service for subscription to make API calls
     def subscriptions
       @subscriptions ||= Services::SubscriptionsService.new(@api_service)
@@ -108,6 +133,11 @@ module GoCardlessPro
       @tax_rates ||= Services::TaxRatesService.new(@api_service)
     end
 
+    # Access to the service for webhook to make API calls
+    def webhooks
+      @webhooks ||= Services::WebhooksService.new(@api_service)
+    end
+
     # Get a Client configured to use HTTP Basic authentication with the GC Api
     #
     # @param options [Hash<Symbol,String>] configuration for creating the client
@@ -158,7 +188,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.25.0',
+          'GoCardless-Client-Version' => '2.27.0',
         },
       }
     end

data/lib/gocardless_pro/resources/bank_authorisation.rb

@@ -0,0 +1,87 @@
+# 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 bank_authorisation resource returned from the API
+
+    # Bank Authorisations can be used to authorise Billing Requests.
+    # Authorisations
+    # are created against a specific bank, usually the bank that provides the
+    # payer's
+    # account.
+    #
+    # Creation of Bank Authorisations is only permitted from GoCardless hosted
+    # UIs
+    # (see Billing Request Flows) to ensure we meet regulatory requirements for
+    # checkout flows. The exceptions are integrators with the custom payment
+    # pages
+    # upgrade, who have been audited to check their flows meet requirements.
+    class BankAuthorisation
+      attr_reader :authorisation_type
+      attr_reader :created_at
+      attr_reader :expires_at
+      attr_reader :id
+      attr_reader :last_visited_at
+      attr_reader :redirect_uri
+      attr_reader :short_url
+      attr_reader :url
+
+      # Initialize a bank_authorisation resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @authorisation_type = object['authorisation_type']
+        @created_at = object['created_at']
+        @expires_at = object['expires_at']
+        @id = object['id']
+        @last_visited_at = object['last_visited_at']
+        @links = object['links']
+        @redirect_uri = object['redirect_uri']
+        @short_url = object['short_url']
+        @url = object['url']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @bank_authorisation_links ||= Links.new(@links)
+      end
+
+      # Provides the bank_authorisation 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
+
+        def institution
+          @links['institution']
+        end
+
+        def payment_request
+          @links['payment_request']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/billing_request.rb

@@ -0,0 +1,86 @@
+# 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 resource returned from the API
+
+    # Billing Requests
+    class BillingRequest
+      attr_reader :actions
+      attr_reader :auto_fulfil
+      attr_reader :created_at
+      attr_reader :id
+      attr_reader :mandate_request
+      attr_reader :metadata
+      attr_reader :payment_request
+      attr_reader :resources
+      attr_reader :status
+
+      # Initialize a billing_request resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @actions = object['actions']
+        @auto_fulfil = object['auto_fulfil']
+        @created_at = object['created_at']
+        @id = object['id']
+        @links = object['links']
+        @mandate_request = object['mandate_request']
+        @metadata = object['metadata']
+        @payment_request = object['payment_request']
+        @resources = object['resources']
+        @status = object['status']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @billing_request_links ||= Links.new(@links)
+      end
+
+      # Provides the billing_request resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def customer
+          @links['customer']
+        end
+
+        def customer_bank_account
+          @links['customer_bank_account']
+        end
+
+        def customer_billing_detail
+          @links['customer_billing_detail']
+        end
+
+        def mandate_bank_authorisation
+          @links['mandate_bank_authorisation']
+        end
+
+        def payment_bank_authorisation
+          @links['payment_bank_authorisation']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/billing_request_flow.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 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 :created_at
+      attr_reader :expires_at
+      attr_reader :redirect_uri
+
+      # 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']
+        @created_at = object['created_at']
+        @expires_at = object['expires_at']
+        @links = object['links']
+        @redirect_uri = object['redirect_uri']
+        @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/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/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

@@ -53,6 +53,9 @@ module GoCardlessPro
     # 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