gocardless_pro 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 472fa55ccac2de3bebc711783644d3f39312330c885b4fbf02a466a039009dc2
-  data.tar.gz: 2fcabb2995c68ef9919c1e6b0a1c98b8d7b3b327dfe8f2b024d99aac00b79f42
+  metadata.gz: 9b6c3812f06f80708ae87c97ddaadcd761072a851345b9ef5cf8334a41440f16
+  data.tar.gz: 4b8de1ec177c357bf1ff19714318edd61b87a9da9241d3fed8861c3e9a4bc37c
 SHA512:
-  metadata.gz: 6c9bb7e031e4fb33eeca2fab1fb6383f4cbb00bb64cac562b5a8b084d1f20ac5ce64d26e71662e2809e21d0b6929dad942963d3418fcb8787ea9a6e44134d3d1
-  data.tar.gz: 6eedaf33f297a6d4560481d1c81f10017cf3894b4b6df483c6945d36cffcd2a6a73590855a0882938d9955893e42456c69134a79d9eb4f8c91d1480831e8c893
+  metadata.gz: f53d81b4695e0a720a12f5f1b57ab4c0c94d6fbb5997bf42f73a6285b15abad69b7199d5f6fd6845e724e2552d66220f1946290f3ac93b2cad772714cba7a97f
+  data.tar.gz: af724b976c328d768ac04c64303bf1c9c36aa6a8e916564e4ffef23303eaf884e9a067d994f2ea51553dd7a04aba1ca70ae79cad904edb3f18aa19429f21b0c8

data/lib/gocardless_pro/client.rb

@@ -8,6 +8,11 @@ module GoCardlessPro
       @balances ||= Services::BalancesService.new(@api_service)
     end
 
+    # Access to the service for bank_account_detail to make API calls
+    def bank_account_details
+      @bank_account_details ||= Services::BankAccountDetailsService.new(@api_service)
+    end
+
     # Access to the service for bank_authorisation to make API calls
     def bank_authorisations
       @bank_authorisations ||= Services::BankAuthorisationsService.new(@api_service)
@@ -238,7 +243,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '3.4.0'
+          'GoCardless-Client-Version' => '3.5.0'
         }
       }
     end

data/lib/gocardless_pro/resources/bank_account_detail.rb

@@ -0,0 +1,40 @@
+#
+# 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 bank_account_detail resource returned from the API
+
+    # Retrieve bank account details in JWE encrypted format
+    class BankAccountDetail
+      attr_reader :ciphertext, :encrypted_key, :iv, :protected, :tag
+
+      # Initialize a bank_account_detail resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @ciphertext = object['ciphertext']
+        @encrypted_key = object['encrypted_key']
+        @iv = object['iv']
+        @protected = object['protected']
+        @tag = object['tag']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the bank_account_detail resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/bank_account_details_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 BankAccountDetail endpoints
+    class BankAccountDetailsService < BaseService
+      # Returns bank account details in the flattened JSON Web Encryption format
+      # described in RFC 7516
+      # Example URL: /bank_account_details/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "BA".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/bank_account_details/:identity', {
+                         'identity' => identity
+                       })
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::BankAccountDetail.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
+        'bank_account_details'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/billing_requests_service.rb

@@ -11,7 +11,8 @@ module GoCardlessPro
     # Service for making requests to the BillingRequest endpoints
     class BillingRequestsService < BaseService
       # <p class="notice"><strong>Important</strong>: All properties associated with
-      # `subscription_request` are only supported for ACH and PAD schemes.</p>
+      # `subscription_request` and `instalment_schedule_request` are only supported
+      # for ACH and PAD schemes.</p>
       # Example URL: /billing_requests
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -46,78 +47,6 @@ module GoCardlessPro
         Resources::BillingRequest.new(unenvelope_body(response.body), response)
       end
 
-      # <p class="notice"><strong>Important</strong>: All properties associated with
-      # `instalment_schedule_request` are only supported for ACH and PAD schemes.</p>
-      # Example URL: /billing_requests
-      # @param options [Hash] parameters as a hash, under a params key.
-      def create_with_instalments_with_dates(options = {})
-        path = '/billing_requests'
-
-        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)
-            end
-          end
-
-          raise e
-        end
-
-        return if response.body.nil?
-
-        Resources::BillingRequest.new(unenvelope_body(response.body), response)
-      end
-
-      # <p class="notice"><strong>Important</strong>: All properties associated with
-      # `instalment_schedule_request` are only supported for ACH and PAD schemes.</p>
-      # Example URL: /billing_requests
-      # @param options [Hash] parameters as a hash, under a params key.
-      def create_with_instalments_with_schedule(options = {})
-        path = '/billing_requests'
-
-        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)
-            end
-          end
-
-          raise e
-        end
-
-        return if response.body.nil?
-
-        Resources::BillingRequest.new(unenvelope_body(response.body), response)
-      end
-
       # If the billing request has a pending <code>collect_customer_details</code>
       # action, this endpoint can be used to collect the details in order to
       # complete it.

data/lib/gocardless_pro/version.rb

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

data/lib/gocardless_pro.rb

@@ -42,6 +42,9 @@ require_relative 'gocardless_pro/webhook'
 require_relative 'gocardless_pro/resources/balance'
 require_relative 'gocardless_pro/services/balances_service'
 
+require_relative 'gocardless_pro/resources/bank_account_detail'
+require_relative 'gocardless_pro/services/bank_account_details_service'
+
 require_relative 'gocardless_pro/resources/bank_authorisation'
 require_relative 'gocardless_pro/services/bank_authorisations_service'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - GoCardless
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -113,6 +113,7 @@ files:
 - lib/gocardless_pro/paginator.rb
 - lib/gocardless_pro/request.rb
 - lib/gocardless_pro/resources/balance.rb
+- lib/gocardless_pro/resources/bank_account_detail.rb
 - lib/gocardless_pro/resources/bank_authorisation.rb
 - lib/gocardless_pro/resources/bank_details_lookup.rb
 - lib/gocardless_pro/resources/billing_request.rb
@@ -151,6 +152,7 @@ files:
 - lib/gocardless_pro/resources/webhook.rb
 - lib/gocardless_pro/response.rb
 - lib/gocardless_pro/services/balances_service.rb
+- lib/gocardless_pro/services/bank_account_details_service.rb
 - lib/gocardless_pro/services/bank_authorisations_service.rb
 - lib/gocardless_pro/services/bank_details_lookups_service.rb
 - lib/gocardless_pro/services/base_service.rb