gocardless_pro 2.24.0 → 2.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bac8c2899f9fd824c6dd5f94bcfa506694dc9f97839cb86a1b64149ccfc92e48
-  data.tar.gz: f12c865ed4d9eaa0def7d20fea5e2b15e2c225898de92bee5758d9a6757e476c
+  metadata.gz: ae7ce2e7f276bbb9d36b64093e6be341e1f76325a7ced35710e8276360c2df22
+  data.tar.gz: 554e6c6c947c94c76d250fafabdc3867b65ca218269ce70395fe5a0079fdb5e5
 SHA512:
-  metadata.gz: f3c76aad9bbaace084b8449366edc8b1f8b33f0b705e22050137bc3d2c31b43228addbea11943b337e8ac6c0a7da52117979dea6ee8e1e425dbca026d159e467
-  data.tar.gz: '097fd8d09e04a316d2e37010eb78d36b8278e7ec8e9cbed867c772ccf3b522957d1fae644c4357a2b560917a16e90b6284841679c79e8525f8f3324795715139'
+  metadata.gz: fb5865c593f89c21fe7b1d9ea930c2683286753f9635dcb0e70350ac4fd5af02345a6c472c8b9940484242f6f39cfd05fcdbca0c5a96c3e7cad66f2bf5cf42e6
+  data.tar.gz: 55605f88d457f5a0e8bb3445b9a796dbe1332a94eb3c1ab86318c4bce49d4ab88fcaf6a27ed67c01e4195f6b73eb40ede88d86f3f5998b09b348eb5e5a7a26d0

data/.circleci/config.yml

@@ -13,7 +13,19 @@ jobs:
     steps:
       - checkout
       - run: bundle install && bundle exec rspec
-
+  publish: &publish
+    docker:
+      - image: ruby:2.6
+    steps:
+      - checkout
+      - run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: $RUBYGEM_PUBLISH_API_KEY\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+          
 workflows:
   version: 2
   tests:
@@ -22,11 +34,18 @@ 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"
+      - publish:
+          filters:
+            branches:
+              only:
+                - master      
+          requires:
+            - test

data/lib/gocardless_pro/api_service.rb

@@ -34,6 +34,10 @@ module GoCardlessPro
       @headers = options[:default_headers] || {}
       @headers['Authorization'] = "Bearer #{token}"
       @on_idempotency_conflict = options[:on_idempotency_conflict] || :fetch
+
+      unless %i[fetch raise].include?(@on_idempotency_conflict)
+        raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+      end
     end
 
     # Make a request to the API

data/lib/gocardless_pro/client.rb

@@ -3,11 +3,36 @@ 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 billing_request_template to make API calls
+    def billing_request_templates
+      @billing_request_templates ||= Services::BillingRequestTemplatesService.new(@api_service)
+    end
+
+    # Access to the service for block to make API calls
+    def blocks
+      @blocks ||= Services::BlocksService.new(@api_service)
+    end
+
     # Access to the service for creditor to make API calls
     def creditors
       @creditors ||= Services::CreditorsService.new(@api_service)
@@ -48,6 +73,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)
@@ -68,6 +98,11 @@ module GoCardlessPro
       @mandate_pdfs ||= Services::MandatePdfsService.new(@api_service)
     end
 
+    # Access to the service for payer_authorisation to make API calls
+    def payer_authorisations
+      @payer_authorisations ||= Services::PayerAuthorisationsService.new(@api_service)
+    end
+
     # Access to the service for payment to make API calls
     def payments
       @payments ||= Services::PaymentsService.new(@api_service)
@@ -93,6 +128,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)
@@ -103,6 +143,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
@@ -153,7 +198,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.24.0',
+          'GoCardless-Client-Version' => '2.29.0',
         },
       }
     end

data/lib/gocardless_pro/error/authentication_error.rb

@@ -0,0 +1,4 @@
+module GoCardlessPro
+  class AuthenticationError < InvalidApiUsageError
+  end
+end

data/lib/gocardless_pro/error/permission_error.rb

@@ -0,0 +1,4 @@
+module GoCardlessPro
+  class PermissionError < InvalidApiUsageError
+  end
+end

data/lib/gocardless_pro/error/rate_limit_error.rb

@@ -0,0 +1,4 @@
+module GoCardlessPro
+  class RateLimitError < InvalidApiUsageError
+  end
+end

data/lib/gocardless_pro/middlewares/raise_gocardless_errors.rb

@@ -12,12 +12,23 @@ module GoCardlessPro
         if CLIENT_ERROR_STATUSES.include?(env.status)
           json_body ||= JSON.parse(env.body) unless env.body.empty?
           error_type = json_body['error']['type']
-          raise(error_class_for_type(error_type), json_body['error'])
+
+          error_class = error_class_for_status(env.status) || error_class_for_type(error_type)
+
+          raise(error_class, json_body['error'])
         end
       end
 
       private
 
+      def error_class_for_status(code)
+        {
+          401 => GoCardlessPro::AuthenticationError,
+          403 => GoCardlessPro::PermissionError,
+          429 => GoCardlessPro::RateLimitError,
+        }.fetch(code, nil)
+      end
+
       def error_class_for_type(type)
         {
           validation_failed: GoCardlessPro::ValidationError,

data/lib/gocardless_pro/resources/bank_authorisation.rb

@@ -0,0 +1,81 @@
+# 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.
+    class BankAuthorisation
+      attr_reader :authorisation_type
+      attr_reader :authorised_at
+      attr_reader :created_at
+      attr_reader :expires_at
+      attr_reader :id
+      attr_reader :last_visited_at
+      attr_reader :redirect_uri
+      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']
+        @authorised_at = object['authorised_at']
+        @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']
+        @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
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/billing_request.rb

@@ -0,0 +1,108 @@
+# 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 help create resources that require input or action from a
+    # customer. An example of required input might be additional customer
+    # billing
+    # details, while an action would be asking a customer to authorise a payment
+    # using their mobile banking app.
+    #
+    # See [Billing Requests:
+    # Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/)
+    # for how-to's, explanations and tutorials.
+    class BillingRequest
+      attr_reader :actions
+      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']
+        @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 bank_authorisation
+          @links['bank_authorisation']
+        end
+
+        def creditor
+          @links['creditor']
+        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_request
+          @links['mandate_request']
+        end
+
+        def mandate_request_mandate
+          @links['mandate_request_mandate']
+        end
+
+        def payment_request
+          @links['payment_request']
+        end
+
+        def payment_request_payment
+          @links['payment_request_payment']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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 block resource returned from the API
+
+    # A block object is a simple rule, when matched, pushes a newly created
+    # mandate to a blocked state. These details can be an exact match, like a
+    # bank account
+    # or an email, or a more generic match such as an email domain. New block
+    # types may be added
+    # over time. Payments and subscriptions can't be created against mandates in
+    # blocked state.
+    #
+    # <p class="notice">
+    #   Client libraries have not yet been updated for this API but will be
+    # released soon.
+    #   This API is currently only available for approved integrators - please
+    # <a href="mailto:help@gocardless.com">get in touch</a> if you would like to
+    # use this API.
+    # </p>
+    class Block
+      attr_reader :active
+      attr_reader :block_type
+      attr_reader :created_at
+      attr_reader :id
+      attr_reader :reason_description
+      attr_reader :reason_type
+      attr_reader :resource_reference
+      attr_reader :updated_at
+
+      # Initialize a block resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @active = object['active']
+        @block_type = object['block_type']
+        @created_at = object['created_at']
+        @id = object['id']
+        @reason_description = object['reason_description']
+        @reason_type = object['reason_type']
+        @resource_reference = object['resource_reference']
+        @updated_at = object['updated_at']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the block 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

@@ -60,6 +60,18 @@ module GoCardlessPro
           @links = links || {}
         end
 
+        def bank_authorisation
+          @links['bank_authorisation']
+        end
+
+        def billing_request
+          @links['billing_request']
+        end
+
+        def billing_request_flow
+          @links['billing_request_flow']
+        end
+
         def creditor
           @links['creditor']
         end
@@ -80,6 +92,10 @@ module GoCardlessPro
           @links['mandate']
         end
 
+        def mandate_request_mandate
+          @links['mandate_request_mandate']
+        end
+
         def new_customer_bank_account
           @links['new_customer_bank_account']
         end
@@ -104,6 +120,10 @@ module GoCardlessPro
           @links['payment']
         end
 
+        def payment_request_payment
+          @links['payment_request_payment']
+        end
+
         def payout
           @links['payout']
         end