gocardless_pro 2.54.0 → 2.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0785e0ba3bd331adfc4a66689db74d9002d3ef91b1167300cdd3dd6868f645aa'
-  data.tar.gz: a9627b7713acc48be5544ac07548557cba21c816c8de681355b1b0a71e92b73a
+  metadata.gz: 2ff9a9f0905147eeb174b5e7d4ce029edc6f3b623525b8a23c18bed65964f95a
+  data.tar.gz: 9a8252e55308ecf44bd9b4c20dde80b34020dc1593ff56beb2301c0c34ac253f
 SHA512:
-  metadata.gz: c65cf5d68e95ad31daed9bb9c0e887c04632869fed3731c48f724099f2febd024a06415fee1f16f216d56475dbd55afb92ef1c08e0a54dc1d951d5c8d2398e1b
-  data.tar.gz: 3ce5ba13536d9f71947daf1998b60f21838a9438348c64215929737f66bbb956141e947ce048c1ca2b95e6ac19427c4824b8e7769e2b4dd3013f0dae970b2694
+  metadata.gz: b66fc420814c249b1f18280d9700c2dbd4f3953e2860f6a046c308e2ce11657ba9bcffed50d2925845a0f51996aa49d026b9d1ec1d51a6bcf8033b49bc187478
+  data.tar.gz: 7c4d56b3e7230598cfb3b2668c99e157fd168dbbcc60722dcbbaa87b2a807e54a791dbcaeb0d73a2cf9996ae3b64074cd27feaf438a990c8d83ba484c5378250

data/lib/gocardless_pro/client.rb

@@ -78,6 +78,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 +113,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 +228,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.54.0',
+          'GoCardless-Client-Version' => '2.56.0',
         },
       }
     end

data/lib/gocardless_pro/middlewares/raise_gocardless_errors.rb

@@ -3,9 +3,12 @@ module GoCardlessPro
     class RaiseGoCardlessErrors < Faraday::Middleware
       API_ERROR_STATUSES = 501..599
       CLIENT_ERROR_STATUSES = 400..500
+      API_STATUS_NO_CONTENT = 204
 
       def on_complete(env)
-        raise ApiError, generate_error_data(env) if !json?(env) || API_ERROR_STATUSES.include?(env.status)
+        if !(env.status == API_STATUS_NO_CONTENT || json?(env)) || API_ERROR_STATUSES.include?(env.status)
+          raise ApiError, generate_error_data(env)
+        end
 
         return unless CLIENT_ERROR_STATUSES.include?(env.status)
 

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

@@ -67,7 +67,6 @@ module GoCardlessPro
     # last working day of the month).
     # - otherwise the charge date will be rolled __forwards__ to the next
     # business day.
-    #
     class Subscription
       attr_reader :amount
       attr_reader :app_fee

data/lib/gocardless_pro/services/bank_details_lookups_service.rb

@@ -13,6 +13,12 @@ module GoCardlessPro
       # Performs a bank details lookup. As part of the lookup, a modulus check and
       # reachability check are performed.
       #
+      # For UK-based bank accounts, where an account holder name is provided (and an
+      # account number, a sort code or an iban
+      # are already present), we verify that the account holder name and bank account
+      # number match the details held by
+      # the relevant bank.
+      #
       # If your request returns an [error](#api-usage-errors) or the
       # `available_debit_schemes`
       # attribute is an empty array, you will not be able to collect payments from the

data/lib/gocardless_pro/services/billing_requests_service.rb

@@ -110,6 +110,12 @@ module GoCardlessPro
       # Direct Debit. If a bank account is discovered to be closed or invalid, the
       # customer is requested to adjust the account number/routing number and
       # succeed in this check to continue with the flow.
+      #
+      # _BACS scheme_ [Payer Name
+      # Verification](https://hub.gocardless.com/s/article/Introduction-to-Payer-Name-Verification?language=en_GB)
+      # is enabled by default for UK based bank accounts, meaning we verify the
+      # account holder name and bank account
+      # number match the details held by the relevant bank.
       # Example URL: /billing_requests/:identity/actions/collect_bank_account
       #
       # @param identity       # Unique identifier, beginning with "BRQ".

data/lib/gocardless_pro/services/logos_service.rb

@@ -0,0 +1,48 @@
+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.
+      # 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/services/subscriptions_service.rb

@@ -180,7 +180,6 @@ module GoCardlessPro
       #
       # - `pause_cycles_must_be_greater_than_or_equal_to` if the provided value for
       # `pause_cycles` cannot be satisfied.
-      #
       # Example URL: /subscriptions/:identity/actions/pause
       #
       # @param identity       # Unique identifier, beginning with "SB".

data/lib/gocardless_pro/version.rb

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

data/lib/gocardless_pro.rb

@@ -84,6 +84,9 @@ 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 +105,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.54.0
+  version: 2.56.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -127,12 +127,14 @@ files:
 - lib/gocardless_pro/resources/event.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
@@ -162,12 +164,14 @@ files:
 - lib/gocardless_pro/services/events_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
@@ -201,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: A gem for calling the GoCardless Pro API