gocardless_pro 2.56.0 → 3.0.0

data/lib/gocardless_pro/resources/scheme_identifier.rb

@@ -15,24 +15,8 @@ module GoCardlessPro
     # on customers' bank statements.
     #
     class SchemeIdentifier
-      attr_reader :address_line1
-      attr_reader :address_line2
-      attr_reader :address_line3
-      attr_reader :can_specify_mandate_reference
-      attr_reader :city
-      attr_reader :country_code
-      attr_reader :created_at
-      attr_reader :currency
-      attr_reader :email
-      attr_reader :id
-      attr_reader :minimum_advance_notice
-      attr_reader :name
-      attr_reader :phone_number
-      attr_reader :postal_code
-      attr_reader :reference
-      attr_reader :region
-      attr_reader :scheme
-      attr_reader :status
+      attr_reader :address_line1, :address_line2, :address_line3, :can_specify_mandate_reference, :city, :country_code,
+                  :created_at, :currency, :email, :id, :minimum_advance_notice, :name, :phone_number, :postal_code, :reference, :region, :scheme, :status
 
       # Initialize a scheme_identifier resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/subscription.rb

@@ -68,25 +68,8 @@ module GoCardlessPro
     # - otherwise the charge date will be rolled __forwards__ to the next
     # business day.
     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
-      attr_reader :interval_unit
-      attr_reader :metadata
-      attr_reader :month
-      attr_reader :name
-      attr_reader :payment_reference
-      attr_reader :retry_if_possible
-      attr_reader :start_date
-      attr_reader :status
-      attr_reader :upcoming_payments
+      attr_reader :amount, :app_fee, :count, :created_at, :currency, :day_of_month, :earliest_charge_date_after_resume,
+                  :end_date, :id, :interval, :interval_unit, :metadata, :month, :name, :parent_plan_paused, :payment_reference, :retry_if_possible, :start_date, :status, :upcoming_payments
 
       # Initialize a subscription resource instance
       # @param object [Hash] an object returned from the API
@@ -108,6 +91,7 @@ module GoCardlessPro
         @metadata = object['metadata']
         @month = object['month']
         @name = object['name']
+        @parent_plan_paused = object['parent_plan_paused']
         @payment_reference = object['payment_reference']
         @retry_if_possible = object['retry_if_possible']
         @start_date = object['start_date']

data/lib/gocardless_pro/resources/tax_rate.rb

@@ -15,12 +15,7 @@ module GoCardlessPro
     # 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
-      attr_reader :jurisdiction
-      attr_reader :percentage
-      attr_reader :start_date
-      attr_reader :type
+      attr_reader :end_date, :id, :jurisdiction, :percentage, :start_date, :type
 
       # Initialize a tax_rate resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/transferred_mandate.rb

@@ -12,9 +12,7 @@ module GoCardlessPro
 
     # Mandates that have been transferred using Current Account Switch Service
     class TransferredMandate
-      attr_reader :encrypted_customer_bank_details
-      attr_reader :encrypted_decryption_key
-      attr_reader :public_key_id
+      attr_reader :encrypted_customer_bank_details, :encrypted_decryption_key, :public_key_id
 
       # Initialize a transferred_mandate resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/verification_detail.rb

@@ -22,15 +22,8 @@ module GoCardlessPro
     # your
     #   account.</p>
     class VerificationDetail
-      attr_reader :address_line1
-      attr_reader :address_line2
-      attr_reader :address_line3
-      attr_reader :city
-      attr_reader :company_number
-      attr_reader :description
-      attr_reader :directors
-      attr_reader :name
-      attr_reader :postal_code
+      attr_reader :address_line1, :address_line2, :address_line3, :city, :company_number, :description, :directors,
+                  :name, :postal_code
 
       # Initialize a verification_detail resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/resources/webhook.rb

@@ -12,19 +12,8 @@ module GoCardlessPro
 
     # 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
+      attr_reader :created_at, :id, :is_test, :request_body, :request_headers, :response_body,
+                  :response_body_truncated, :response_code, :response_headers, :response_headers_content_truncated, :response_headers_count_truncated, :successful, :url
 
       # Initialize a webhook resource instance
       # @param object [Hash] an object returned from the API

data/lib/gocardless_pro/services/bank_authorisations_service.rb

@@ -52,7 +52,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/bank_authorisations/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true

data/lib/gocardless_pro/services/billing_request_flows_service.rb

@@ -38,7 +38,7 @@ module GoCardlessPro
       # @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,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/billing_request_templates_service.rb

@@ -46,7 +46,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/billing_request_templates/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -101,7 +101,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/billing_request_templates/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/billing_requests_service.rb

@@ -61,7 +61,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def collect_customer_details(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/collect_customer_details', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -122,7 +122,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def collect_bank_account(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/collect_bank_account', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -163,7 +163,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def confirm_payer_details(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/confirm_payer_details', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -203,7 +203,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def fulfil(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/fulfil', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -243,7 +243,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/cancel', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -311,7 +311,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/billing_requests/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -335,7 +335,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def notify(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/notify', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -375,7 +375,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def fallback(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/fallback', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -420,7 +420,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def choose_currency(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/choose_currency', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -459,7 +459,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def select_institution(identity, options = {})
         path = sub_url('/billing_requests/:identity/actions/select_institution', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/blocks_service.rb

@@ -52,7 +52,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/blocks/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -100,7 +100,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def disable(identity, options = {})
         path = sub_url('/blocks/:identity/actions/disable', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -139,7 +139,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def enable(identity, options = {})
         path = sub_url('/blocks/:identity/actions/enable', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/creditor_bank_accounts_service.rb

@@ -81,7 +81,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/creditor_bank_accounts/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -107,7 +107,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def disable(identity, options = {})
         path = sub_url('/creditor_bank_accounts/:identity/actions/disable', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/creditors_service.rb

@@ -81,7 +81,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/creditors/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -101,7 +101,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/creditors/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/customer_bank_accounts_service.rb

@@ -93,7 +93,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/customer_bank_accounts/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -113,7 +113,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/customer_bank_accounts/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -142,7 +142,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def disable(identity, options = {})
         path = sub_url('/customer_bank_accounts/:identity/actions/disable', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/customer_notifications_service.rb

@@ -24,7 +24,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def handle(identity, options = {})
         path = sub_url('/customer_notifications/:identity/actions/handle', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/customers_service.rb

@@ -81,7 +81,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/customers/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -101,7 +101,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/customers/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -131,7 +131,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def remove(identity, options = {})
         path = sub_url('/customers/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = false

data/lib/gocardless_pro/services/events_service.rb

@@ -46,7 +46,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/events/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true

data/lib/gocardless_pro/services/exports_service.rb

@@ -0,0 +1,75 @@
+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 Export endpoints
+    class ExportsService < BaseService
+      # Returns a single export.
+      # Example URL: /exports/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "EX".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/exports/:identity', {
+                         'identity' => identity
+                       })
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::Export.new(unenvelope_body(response.body), response)
+      end
+
+      # Returns a list of exports which are available for download.
+      # Example URL: /exports
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/exports'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Export
+        )
+      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
+
+      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
+        'exports'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/instalment_schedules_service.rb

@@ -147,7 +147,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/instalment_schedules/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -166,7 +166,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/instalment_schedules/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -193,7 +193,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/instalment_schedules/:identity/actions/cancel', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/institutions_service.rb

@@ -47,7 +47,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def list_for_billing_request(identity, options = {})
         path = sub_url('/billing_requests/:identity/institutions', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = false

data/lib/gocardless_pro/services/logos_service.rb

@@ -12,6 +12,11 @@ module GoCardlessPro
     class LogosService < BaseService
       # Creates a new logo associated with a creditor. If a creditor already has a
       # logo, this will update the existing logo linked to the creditor.
+      #
+      # We support JPG and PNG formats. Your logo will be scaled to a maximum of 300px
+      # by 40px. For more guidance on how to upload logos that will look
+      # great across your customer payment page and notification emails see
+      # [here](https://developer.gocardless.com/gc-embed/setting-up-branding#tips_for_uploading_your_logo).
       # Example URL: /branding/logos
       # @param options [Hash] parameters as a hash, under a params key.
       def create_for_creditor(options = {})

data/lib/gocardless_pro/services/mandate_imports_service.rb

@@ -56,7 +56,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/mandate_imports/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -85,7 +85,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def submit(identity, options = {})
         path = sub_url('/mandate_imports/:identity/actions/submit', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -130,7 +130,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/mandate_imports/:identity/actions/cancel', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/mandates_service.rb

@@ -82,7 +82,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/mandates/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -102,7 +102,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/mandates/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -131,7 +131,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/mandates/:identity/actions/cancel', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -181,7 +181,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def reinstate(identity, options = {})
         path = sub_url('/mandates/:identity/actions/reinstate', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/services/payer_authorisations_service.rb

@@ -18,7 +18,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/payer_authorisations/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         options[:retry_failures] = true
@@ -85,7 +85,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/payer_authorisations/:identity', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -111,7 +111,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def submit(identity, options = {})
         path = sub_url('/payer_authorisations/:identity/actions/submit', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}
@@ -160,7 +160,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def confirm(identity, options = {})
         path = sub_url('/payer_authorisations/:identity/actions/confirm', {
-                         'identity' => identity,
+                         'identity' => identity
                        })
 
         params = options.delete(:params) || {}