gocardless_pro 2.56.0 → 2.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ff9a9f0905147eeb174b5e7d4ce029edc6f3b623525b8a23c18bed65964f95a
-  data.tar.gz: 9a8252e55308ecf44bd9b4c20dde80b34020dc1593ff56beb2301c0c34ac253f
+  metadata.gz: a0a146b35e39aaaec207ce920824529baf883e1a47f145ca7925de250438aab9
+  data.tar.gz: 688023c522f8547e097e53ec3ef20fc11bf06d1d12a2149c97383d7bf6b3ead0
 SHA512:
-  metadata.gz: b66fc420814c249b1f18280d9700c2dbd4f3953e2860f6a046c308e2ce11657ba9bcffed50d2925845a0f51996aa49d026b9d1ec1d51a6bcf8033b49bc187478
-  data.tar.gz: 7c4d56b3e7230598cfb3b2668c99e157fd168dbbcc60722dcbbaa87b2a807e54a791dbcaeb0d73a2cf9996ae3b64074cd27feaf438a990c8d83ba484c5378250
+  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)
@@ -228,7 +233,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.56.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/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

@@ -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/version.rb

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

data/lib/gocardless_pro.rb

@@ -78,6 +78,9 @@ 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'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 2.56.0
+  version: 2.57.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-28 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -125,6 +125,7 @@ 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
@@ -162,6 +163,7 @@ 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