gocardless_pro 2.17.1 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb41d5906c1d6d6a9fc78abc852058cf63715020e3c957c7a0a8bcc8e907d74e
-  data.tar.gz: c85a921b9ea881ed5acc7d56c20b4f75f5c51e1c5e305d4de8c7d0079798adbf
+  metadata.gz: 4c285e5a1284e099a2840ea4dfb7a8282a73a38aa0def7e81f522654b4be5922
+  data.tar.gz: 0443f073f12c0c6d69029a4a79d28634978274e73b6d1bc0a1517066c44b66e8
 SHA512:
-  metadata.gz: 54114ab5751f18ea4c0b010ca600db89523de93353f309cd0e247dbc13a7339f1cf14d7869f44db7d7b0a7571233a54bd9bc0130c9c4eb796bf186bda5e659eb
-  data.tar.gz: a2c5a5cdc5321d2e8a00f82adaba6b56540f3aa86d55cf950862f92fbc1cd971e5bad955b4701d69c4babb2fa5ac83a01a53f5da3427117ec7c11d652c47730e
+  metadata.gz: bf2401b3823b41bd1d562a80f0e7a8b0847a86f04e1ec29ad2e55b3caf814e39ea379f0686c6108b91de81701b8cebc697e0bd1f7cd4741c44176785c01bcc27
+  data.tar.gz: f8aa9bd7ff1c8f969d54ae654b324395572459ec065e603601dbe5eb9a38ec61852724820dc8423bc7407e47004434dcee4b880b3a4d2678086b0f0729dece07

data/lib/gocardless_pro.rb

@@ -47,6 +47,9 @@ require_relative 'gocardless_pro/services/creditors_service'
 require_relative 'gocardless_pro/resources/creditor_bank_account'
 require_relative 'gocardless_pro/services/creditor_bank_accounts_service'
 
+require_relative 'gocardless_pro/resources/currency_exchange_rate'
+require_relative 'gocardless_pro/services/currency_exchange_rates_service'
+
 require_relative 'gocardless_pro/resources/customer'
 require_relative 'gocardless_pro/services/customers_service'
 

data/lib/gocardless_pro/client.rb

@@ -18,6 +18,11 @@ module GoCardlessPro
       @creditor_bank_accounts ||= Services::CreditorBankAccountsService.new(@api_service)
     end
 
+    # Access to the service for currency_exchange_rate to make API calls
+    def currency_exchange_rates
+      @currency_exchange_rates ||= Services::CurrencyExchangeRatesService.new(@api_service)
+    end
+
     # Access to the service for customer to make API calls
     def customers
       @customers ||= Services::CustomersService.new(@api_service)
@@ -143,7 +148,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.17.1',
+          'GoCardless-Client-Version' => '2.21.0',
         },
       }
     end

data/lib/gocardless_pro/resources/creditor_bank_account.rb

@@ -23,8 +23,7 @@ module GoCardlessPro
     # `links[creditor_bank_account]` in the error response.
     #
     # <p class="restricted-notice"><strong>Restricted</strong>: This API is not
-    # available for
-    # partner integrations.</p>
+    # available for partner integrations.</p>
     class CreditorBankAccount
       attr_reader :account_holder_name
       attr_reader :account_number_ending

data/lib/gocardless_pro/resources/currency_exchange_rate.rb

@@ -0,0 +1,44 @@
+# 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 currency_exchange_rate resource returned from the API
+
+    # Currency exchange rates from our foreign exchange provider.
+    class CurrencyExchangeRate
+      attr_reader :rate
+      attr_reader :source
+      attr_reader :target
+      attr_reader :time
+
+      # Initialize a currency_exchange_rate resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @rate = object['rate']
+        @source = object['source']
+        @target = object['target']
+        @time = object['time']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the currency_exchange_rate resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/customer_notification.rb

@@ -23,11 +23,9 @@ module GoCardlessPro
     # way, it is no longer visible using this API.
     #
     # <p class="restricted-notice"><strong>Restricted</strong>: 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>
-    #
+    # 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 CustomerNotification
       attr_reader :action_taken
       attr_reader :action_taken_at

data/lib/gocardless_pro/resources/event.rb

@@ -14,7 +14,8 @@ module GoCardlessPro
 
     # Events are stored for all webhooks. An event refers to a resource which
     # has been updated, for example a payment which has been collected, or a
-    # mandate which has been transferred.
+    # mandate which has been transferred. See [here](#event-actions) for a
+    # complete list of event types.
     class Event
       attr_reader :action
       attr_reader :created_at

data/lib/gocardless_pro/resources/mandate_import.rb

@@ -47,16 +47,13 @@ module GoCardlessPro
     # system](#mandate-import-entries-list-all-mandate-import-entries).
     #
     # <p class="notice">Note that all Mandate Imports have an upper limit of
-    # 30,000 entries, so
-    # we recommend you split your import into several smaller imports if you're
-    # planning to
-    # exceed this threshold.</p>
+    # 30,000 entries, so we recommend you split your import into several smaller
+    # imports if you're planning to exceed this threshold.</p>
     #
     # <p class="restricted-notice"><strong>Restricted</strong>: 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>
+    # 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 MandateImport
       attr_reader :created_at
       attr_reader :id

data/lib/gocardless_pro/resources/mandate_import_entry.rb

@@ -39,11 +39,9 @@ module GoCardlessPro
     # been imported.
     #
     # <p class="restricted-notice"><strong>Restricted</strong>: 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>
-    #
+    # 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 MandateImportEntry
       attr_reader :created_at
       attr_reader :record_identifier

data/lib/gocardless_pro/resources/payout.rb

@@ -26,6 +26,7 @@ module GoCardlessPro
       attr_reader :deducted_fees
       attr_reader :fx
       attr_reader :id
+      attr_reader :metadata
       attr_reader :payout_type
       attr_reader :reference
       attr_reader :status
@@ -43,6 +44,7 @@ module GoCardlessPro
         @fx = object['fx']
         @id = object['id']
         @links = object['links']
+        @metadata = object['metadata']
         @payout_type = object['payout_type']
         @reference = object['reference']
         @status = object['status']

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 :metadata
       attr_reader :redirect_url
       attr_reader :scheme
       attr_reader :session_token
@@ -64,6 +65,7 @@ module GoCardlessPro
         @description = object['description']
         @id = object['id']
         @links = object['links']
+        @metadata = object['metadata']
         @redirect_url = object['redirect_url']
         @scheme = object['scheme']
         @session_token = object['session_token']

data/lib/gocardless_pro/resources/subscription.rb

@@ -20,40 +20,45 @@ module GoCardlessPro
     # The following rules apply when specifying recurrence:
     #
     # - The first payment must be charged within 1 year.
-    # - When neither `month` nor `day_of_month` are present, the subscription
-    # will recur from the `start_date` based on the `interval_unit`.
-    # - If `month` or `day_of_month` are present, the recurrence rules will be
-    # applied from the `start_date`, and the following validations apply:
+    # - If `day_of_month` and `start_date` are not provided `start_date` will be
+    # the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date` and
+    # the subscription will then recur based on the `interval` & `interval_unit`
+    # - If `month` or `day_of_month` are present the following validations
+    # apply:
     #
-    # | interval_unit   | month                                          |
-    # day_of_month                            |
-    # | :-------------- | :--------------------------------------------- |
-    # :-------------------------------------- |
-    # | yearly          | optional (required if `day_of_month` provided) |
-    # optional (required if `month` provided) |
-    # | monthly         | invalid                                        |
-    # required                                |
-    # | weekly          | invalid                                        |
-    # invalid                                 |
+    # | __interval_unit__ | __month__                                      |
+    # __day_of_month__                           |
+    # | :---------------- | :--------------------------------------------- |
+    # :----------------------------------------- |
+    # | yearly            | optional (required if `day_of_month` provided) |
+    # optional (invalid if `month` not provided) |
+    # | monthly           | invalid                                        |
+    # optional                                   |
+    # | weekly            | invalid                                        |
+    # invalid                                    |
     #
     # Examples:
     #
-    # | interval_unit   | interval   | month   | day_of_month   | valid?
-    #                                     |
-    # | :-------------- | :--------- | :------ | :------------- |
+    # | __interval_unit__ | __interval__ | __month__ | __day_of_month__ | valid?
+    #                                             |
+    # | :---------------- | :----------- | :-------- | :--------------- |
     # :------------------------------------------------- |
-    # | yearly          | 1          | january | -1             | valid
-    #                                     |
-    # | yearly          | 1          | march   |                | invalid -
-    # missing `day_of_month`                   |
-    # | monthly         | 6          |         | 12             | valid
-    #                                     |
-    # | monthly         | 6          | august  | 12             | invalid -
-    # `month` must be blank                    |
-    # | weekly          | 2          |         |                | valid
-    #                                     |
-    # | weekly          | 2          | october | 10             | invalid -
-    # `month` and `day_of_month` must be blank |
+    # | yearly            | 1            | january   | -1               | valid
+    #                                             |
+    # | monthly           | 6            |           |                  | valid
+    #                                             |
+    # | monthly           | 6            |           | 12               | valid
+    #                                             |
+    # | weekly            | 2            |           |                  | valid
+    #                                             |
+    # | yearly            | 1            | march     |                  |
+    # invalid - missing `day_of_month`                   |
+    # | yearly            | 1            |           | 2                |
+    # invalid - missing `month`                          |
+    # | monthly           | 6            | august    | 12               |
+    # invalid - `month` must be blank                    |
+    # | weekly            | 2            | october   | 10               |
+    # invalid - `month` and `day_of_month` must be blank |
     #
     # ### Rolling dates
     #
@@ -69,9 +74,11 @@ module GoCardlessPro
     class Subscription
       attr_reader :amount
       attr_reader :app_fee
+      attr_reader :count
       attr_reader :created_at
       attr_reader :currency
       attr_reader :day_of_month
+      attr_reader :earliest_charge_date_after_resume
       attr_reader :end_date
       attr_reader :id
       attr_reader :interval
@@ -92,9 +99,11 @@ module GoCardlessPro
 
         @amount = object['amount']
         @app_fee = object['app_fee']
+        @count = object['count']
         @created_at = object['created_at']
         @currency = object['currency']
         @day_of_month = object['day_of_month']
+        @earliest_charge_date_after_resume = object['earliest_charge_date_after_resume']
         @end_date = object['end_date']
         @id = object['id']
         @interval = object['interval']

data/lib/gocardless_pro/services/currency_exchange_rates_service.rb

@@ -0,0 +1,67 @@
+require_relative './base_service'
+require 'uri'
+
+# 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 CurrencyExchangeRate endpoints
+    class CurrencyExchangeRatesService < BaseService
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of all
+      # exchange rates.
+      # Example URL: /currency_exchange_rates
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/currency_exchange_rates'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::CurrencyExchangeRate
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar 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
+        'currency_exchange_rates'
+      end
+
+      # take a URL with placeholder params and substitute them out for the actual value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", URI.escape(value))
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/customers_service.rb

@@ -123,8 +123,7 @@ module GoCardlessPro
       # ID.
       #
       # <p class="restricted-notice"><strong>The action of removing a customer cannot
-      # be
-      # reversed, so please use with care.</strong></p>
+      # be reversed, so please use with care.</strong></p>
       # Example URL: /customers/:identity
       #
       # @param identity       # Unique identifier, beginning with "CU".

data/lib/gocardless_pro/services/instalment_schedules_service.rb

@@ -12,11 +12,66 @@ module GoCardlessPro
     # Service for making requests to the InstalmentSchedule endpoints
     class InstalmentSchedulesService < BaseService
       # Creates a new instalment schedule object, along with the associated payments.
+      # This
+      # API is recommended if you know the specific dates you wish to charge.
+      # Otherwise,
+      # please check out the [scheduling
+      # version](#instalment-schedules-create-with-schedule).
       #
-      # The `instalments` property can either be an array of payment properties
-      # (`amount`
-      # and `charge_date`) or a schedule object with `interval`, `interval_unit` and
-      # `amounts`.
+      # The `instalments` property is an array of payment properties (`amount` and
+      # `charge_date`).
+      #
+      # It can take quite a while to create the associated payments, so the API will
+      # return
+      # the status as `pending` initially. When processing has completed, a subsequent
+      # GET
+      # request for the instalment schedule will either have the status `success` and
+      # link
+      # to the created payments, or the status `error` and detailed information about
+      # the
+      # failures.
+      # Example URL: /instalment_schedules
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create_with_dates(options = {})
+        path = '/instalment_schedules'
+
+        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)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
+
+          raise e
+        end
+
+        return if response.body.nil?
+
+        Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
+      end
+
+      # Creates a new instalment schedule object, along with the associated payments.
+      # This
+      # API is recommended if you wish to use the GoCardless scheduling logic. For
+      # finer
+      # control over the individual dates, please check out the [alternative
+      # version](#instalment-schedules-create-with-dates).
       #
       # It can take quite a while to create the associated payments, so the API will
       # return
@@ -27,7 +82,7 @@ module GoCardlessPro
       # failures.
       # Example URL: /instalment_schedules
       # @param options [Hash] parameters as a hash, under a params key.
-      def create(options = {})
+      def create_with_schedule(options = {})
         path = '/instalment_schedules'
 
         params = options.delete(:params) || {}
@@ -107,6 +162,27 @@ module GoCardlessPro
         Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
       end
 
+      # Updates an instalment schedule. This accepts only the metadata parameter.
+      # Example URL: /instalment_schedules/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "IS".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/instalment_schedules/: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::InstalmentSchedule.new(unenvelope_body(response.body), response)
+      end
+
       # Immediately cancels an instalment schedule; no further payments will be
       # collected for it.
       #