gocardless_pro 2.55.0 → 2.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a70aec41dcf3f0306b0358bb4b883594f3662c92d14b6424ea6a1563a4568dfc
-  data.tar.gz: 1c0a8185eba12c72f38fdbed514140f7128132b1b8407508bf123634d59d61df
+  metadata.gz: a0a146b35e39aaaec207ce920824529baf883e1a47f145ca7925de250438aab9
+  data.tar.gz: 688023c522f8547e097e53ec3ef20fc11bf06d1d12a2149c97383d7bf6b3ead0
 SHA512:
-  metadata.gz: 527f1b09398fb3953a4b3f8f4844ef265cc0c00e53dbf2464ec71acdf5ae9258c8220cef3ea85992fbf199fa6026499372b94cba96afc876d92ccc7af5dc8520
-  data.tar.gz: a02c87b919cfea0934a4afdbd01f9fc70d8ed3f98b27e1af4f4ed0790a48416a3402999f0527f76d863a2af441b22897bebe69eb5af5b889306cdafdebb942cb
+  metadata.gz: b1fc013bde352a7494de64b4625e588825bd7a2411ad4cbed44f6b79d42751ef7add42013e6e4ef18e37c4d439fc3a16acdb749cb2286a90b486c5c3e41eee75
+  data.tar.gz: d97c7be78b0af2dd1d1d3f31265db04761055d2fd4cb16de12945cd28ba4c8ba66ed6471d7a014b5e8723e6ba7d4a3d5f23ab770c2a4fde8f823c4fbd00c8219

data/lib/gocardless_pro/client.rb

@@ -68,6 +68,11 @@ module GoCardlessPro
       @events ||= Services::EventsService.new(@api_service)
     end
 
+    # Access to the service for export to make API calls
+    def exports
+      @exports ||= Services::ExportsService.new(@api_service)
+    end
+
     # Access to the service for instalment_schedule to make API calls
     def instalment_schedules
       @instalment_schedules ||= Services::InstalmentSchedulesService.new(@api_service)
@@ -78,6 +83,11 @@ module GoCardlessPro
       @institutions ||= Services::InstitutionsService.new(@api_service)
     end
 
+    # Access to the service for logo to make API calls
+    def logos
+      @logos ||= Services::LogosService.new(@api_service)
+    end
+
     # Access to the service for mandate to make API calls
     def mandates
       @mandates ||= Services::MandatesService.new(@api_service)
@@ -108,6 +118,11 @@ module GoCardlessPro
       @payer_authorisations ||= Services::PayerAuthorisationsService.new(@api_service)
     end
 
+    # Access to the service for payer_theme to make API calls
+    def payer_themes
+      @payer_themes ||= Services::PayerThemesService.new(@api_service)
+    end
+
     # Access to the service for payment to make API calls
     def payments
       @payments ||= Services::PaymentsService.new(@api_service)
@@ -218,7 +233,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.55.0',
+          'GoCardless-Client-Version' => '2.57.0',
         },
       }
     end

data/lib/gocardless_pro/resources/export.rb

@@ -0,0 +1,44 @@
+#
+# 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 export resource returned from the API
+
+    # File-based exports of data
+    class Export
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :download_url
+      attr_reader :export_type
+      attr_reader :id
+
+      # Initialize a export resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @download_url = object['download_url']
+        @export_type = object['export_type']
+        @id = object['id']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the export resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/logo.rb

@@ -0,0 +1,38 @@
+#
+# 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 logo resource returned from the API
+
+    # Logos are image uploads that, when associated with a creditor, are shown
+    # on the [billing request flow](#billing-requests-billing-request-flows)
+    # payment pages.
+    class Logo
+      attr_reader :id
+
+      # Initialize a logo 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 logo resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/payer_theme.rb

@@ -0,0 +1,36 @@
+#
+# 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_theme resource returned from the API
+
+    # Custom colour themes for payment pages and customer notifications.
+    class PayerTheme
+      attr_reader :id
+
+      # Initialize a payer_theme 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 payer_theme resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/subscription.rb

@@ -82,6 +82,7 @@ module GoCardlessPro
       attr_reader :metadata
       attr_reader :month
       attr_reader :name
+      attr_reader :parent_plan_paused
       attr_reader :payment_reference
       attr_reader :retry_if_possible
       attr_reader :start_date
@@ -108,6 +109,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/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/logos_service.rb

@@ -0,0 +1,53 @@
+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 Logo endpoints
+    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 = {})
+        path = '/branding/logos'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+
+        Resources::Logo.new(unenvelope_body(response.body), response)
+      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
+        'logos'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/payer_themes_service.rb

@@ -0,0 +1,49 @@
+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 PayerTheme endpoints
+    class PayerThemesService < BaseService
+      # Creates a new payer theme associated with a creditor. If a creditor already
+      # has payer themes, this will update the existing payer theme linked to the
+      # creditor.
+      # Example URL: /branding/payer_themes
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create_for_creditor(options = {})
+        path = '/branding/payer_themes'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+
+        Resources::PayerTheme.new(unenvelope_body(response.body), response)
+      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
+        'payer_themes'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/version.rb

@@ -3,5 +3,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '2.55.0'
+  VERSION = '2.57.0'
 end

data/lib/gocardless_pro.rb

@@ -78,12 +78,18 @@ require_relative 'gocardless_pro/services/customer_notifications_service'
 require_relative 'gocardless_pro/resources/event'
 require_relative 'gocardless_pro/services/events_service'
 
+require_relative 'gocardless_pro/resources/export'
+require_relative 'gocardless_pro/services/exports_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/logo'
+require_relative 'gocardless_pro/services/logos_service'
+
 require_relative 'gocardless_pro/resources/mandate'
 require_relative 'gocardless_pro/services/mandates_service'
 
@@ -102,6 +108,9 @@ require_relative 'gocardless_pro/services/negative_balance_limits_service'
 require_relative 'gocardless_pro/resources/payer_authorisation'
 require_relative 'gocardless_pro/services/payer_authorisations_service'
 
+require_relative 'gocardless_pro/resources/payer_theme'
+require_relative 'gocardless_pro/services/payer_themes_service'
+
 require_relative 'gocardless_pro/resources/payment'
 require_relative 'gocardless_pro/services/payments_service'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 2.55.0
+  version: 2.57.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -125,14 +125,17 @@ files:
 - lib/gocardless_pro/resources/customer_bank_account.rb
 - lib/gocardless_pro/resources/customer_notification.rb
 - lib/gocardless_pro/resources/event.rb
+- lib/gocardless_pro/resources/export.rb
 - lib/gocardless_pro/resources/instalment_schedule.rb
 - lib/gocardless_pro/resources/institution.rb
+- lib/gocardless_pro/resources/logo.rb
 - lib/gocardless_pro/resources/mandate.rb
 - lib/gocardless_pro/resources/mandate_import.rb
 - lib/gocardless_pro/resources/mandate_import_entry.rb
 - lib/gocardless_pro/resources/mandate_pdf.rb
 - lib/gocardless_pro/resources/negative_balance_limit.rb
 - lib/gocardless_pro/resources/payer_authorisation.rb
+- lib/gocardless_pro/resources/payer_theme.rb
 - lib/gocardless_pro/resources/payment.rb
 - lib/gocardless_pro/resources/payout.rb
 - lib/gocardless_pro/resources/payout_item.rb
@@ -160,14 +163,17 @@ files:
 - lib/gocardless_pro/services/customer_notifications_service.rb
 - lib/gocardless_pro/services/customers_service.rb
 - lib/gocardless_pro/services/events_service.rb
+- lib/gocardless_pro/services/exports_service.rb
 - lib/gocardless_pro/services/instalment_schedules_service.rb
 - lib/gocardless_pro/services/institutions_service.rb
+- lib/gocardless_pro/services/logos_service.rb
 - lib/gocardless_pro/services/mandate_import_entries_service.rb
 - lib/gocardless_pro/services/mandate_imports_service.rb
 - lib/gocardless_pro/services/mandate_pdfs_service.rb
 - lib/gocardless_pro/services/mandates_service.rb
 - lib/gocardless_pro/services/negative_balance_limits_service.rb
 - lib/gocardless_pro/services/payer_authorisations_service.rb
+- lib/gocardless_pro/services/payer_themes_service.rb
 - lib/gocardless_pro/services/payments_service.rb
 - lib/gocardless_pro/services/payout_items_service.rb
 - lib/gocardless_pro/services/payouts_service.rb