gocardless_pro 2.50.0 → 2.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f164005d420d7e25bf6136468135896557ab788109318c297baf5602f1853d22
-  data.tar.gz: b6562baa4240d16bb4fc4abfbae44dd3633aea7915f5f6798aaaa2637737dac2
+  metadata.gz: 3d1328075d0ff385462311f7794d0c3d8e7ffec62bb63f0f7909bf98b0bdd057
+  data.tar.gz: 39d4d8f486b7b34abe93ed4e6324031d3125d36939c4de5a0eb612b588d2ed3b
 SHA512:
-  metadata.gz: ee77c38fc64a3292fa4b67ebe5ddec78e91676e2de17c9239a9916e4d0608f7971bd2eec5284ad91062bbc8bf5e1647fa32153a3f34bb1e46cf553e1390f9d88
-  data.tar.gz: be6995220f245a7fa3d34e7596fa73670de392fd735af5d65e0b6e49c93521e2e8720d0f6ed20a579511cbf7b5da07eb49c6fc75d58c25437812123141c70070
+  metadata.gz: b9f1a58f1003b8e7853ad534f35778ea7da9f0be28508f6a1d3ccf38d46a1d06640f6322233f2b3c5a47946b8189ced7d8ac4ae5c3e121a2922fa9961c585372
+  data.tar.gz: 1109ba23c7de3b637a92faeaf4ec438b060bad7541047ad512186bfa4b8043bf56b7d219094b7942974be1425519c4a4139109f6f7376b3db0d5b4db13d4e6fd

data/lib/gocardless_pro/client.rb

@@ -153,6 +153,11 @@ module GoCardlessPro
       @tax_rates ||= Services::TaxRatesService.new(@api_service)
     end
 
+    # Access to the service for transferred_mandate to make API calls
+    def transferred_mandates
+      @transferred_mandates ||= Services::TransferredMandatesService.new(@api_service)
+    end
+
     # Access to the service for verification_detail to make API calls
     def verification_details
       @verification_details ||= Services::VerificationDetailsService.new(@api_service)
@@ -213,7 +218,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.50.0',
+          'GoCardless-Client-Version' => '2.51.0',
         },
       }
     end

data/lib/gocardless_pro/resources/billing_request_flow.rb

@@ -17,6 +17,7 @@ module GoCardlessPro
       attr_reader :authorisation_url
       attr_reader :auto_fulfil
       attr_reader :created_at
+      attr_reader :customer_details_captured
       attr_reader :exit_uri
       attr_reader :expires_at
       attr_reader :id
@@ -39,6 +40,7 @@ module GoCardlessPro
         @authorisation_url = object['authorisation_url']
         @auto_fulfil = object['auto_fulfil']
         @created_at = object['created_at']
+        @customer_details_captured = object['customer_details_captured']
         @exit_uri = object['exit_uri']
         @expires_at = object['expires_at']
         @id = object['id']

data/lib/gocardless_pro/resources/billing_request_template.rb

@@ -10,7 +10,21 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a billing_request_template resource returned from the API
 
-    # Billing Request Templates
+    # Billing Request Templates are reusable templates that result in
+    # numerous Billing Requests with similar attributes. They provide
+    # a no-code solution for generating various types of multi-user payment
+    # links.
+    #
+    # Each template includes a reusable URL that can be embedded in a website
+    # or shared with customers via email. Every time the URL is opened,
+    # it generates a new Billing Request.
+    #
+    # Billing Request Templates overcome the key limitation of the Billing
+    # Request:
+    # a Billing Request cannot be shared among multiple users because it is
+    # intended
+    # for single-use and is designed to cater to the unique needs of individual
+    # customers.
     class BillingRequestTemplate
       attr_reader :authorisation_url
       attr_reader :created_at

data/lib/gocardless_pro/resources/transferred_mandate.rb

@@ -0,0 +1,60 @@
+#
+# 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 transferred_mandate resource returned from the API
+
+    # Mandates that have been transferred using Current Account Switch Service
+    class TransferredMandate
+      attr_reader :encrypted_data
+      attr_reader :key
+      attr_reader :kid
+
+      # Initialize a transferred_mandate resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @encrypted_data = object['encrypted_data']
+        @key = object['key']
+        @kid = object['kid']
+        @links = object['links']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @transferred_mandate_links ||= Links.new(@links)
+      end
+
+      # Provides the transferred_mandate resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def customer_bank_account
+          @links['customer_bank_account']
+        end
+
+        def mandate
+          @links['mandate']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/billing_requests_service.rb

@@ -101,6 +101,10 @@ module GoCardlessPro
       # the bank account is valid for the billing request scheme before creating
       # and attaching it.
       #
+      # If the scheme is PayTo and the pay_id is available, this can be included in
+      # the payload along with the
+      # country_code.
+      #
       # _ACH scheme_ For compliance reasons, an extra validation step is done using
       # a third-party provider to make sure the customer's bank account can accept
       # Direct Debit. If a bank account is discovered to be closed or invalid, the

data/lib/gocardless_pro/services/transferred_mandates_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 TransferredMandate endpoints
+    class TransferredMandatesService < BaseService
+      # Returns encrypted bank details for the transferred mandate
+      # Example URL: /transferred_mandate/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "MD". Note that this prefix may not
+      # apply to mandates created before 2016.
+      # @param options [Hash] parameters as a hash, under a params key.
+      def transferred_mandates(identity, options = {})
+        path = sub_url('/transferred_mandate/:identity', {
+                         'identity' => identity,
+                       })
+
+        options[:retry_failures] = false
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::TransferredMandate.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
+        'transferred_mandate'
+      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.50.0'
+  VERSION = '2.51.0'
 end

data/lib/gocardless_pro.rb

@@ -129,6 +129,9 @@ require_relative 'gocardless_pro/services/subscriptions_service'
 require_relative 'gocardless_pro/resources/tax_rate'
 require_relative 'gocardless_pro/services/tax_rates_service'
 
+require_relative 'gocardless_pro/resources/transferred_mandate'
+require_relative 'gocardless_pro/services/transferred_mandates_service'
+
 require_relative 'gocardless_pro/resources/verification_detail'
 require_relative 'gocardless_pro/services/verification_details_service'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 2.50.0
+  version: 2.51.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -142,6 +142,7 @@ files:
 - lib/gocardless_pro/resources/scheme_identifier.rb
 - lib/gocardless_pro/resources/subscription.rb
 - lib/gocardless_pro/resources/tax_rate.rb
+- lib/gocardless_pro/resources/transferred_mandate.rb
 - lib/gocardless_pro/resources/verification_detail.rb
 - lib/gocardless_pro/resources/webhook.rb
 - lib/gocardless_pro/response.rb
@@ -176,6 +177,7 @@ files:
 - lib/gocardless_pro/services/scheme_identifiers_service.rb
 - lib/gocardless_pro/services/subscriptions_service.rb
 - lib/gocardless_pro/services/tax_rates_service.rb
+- lib/gocardless_pro/services/transferred_mandates_service.rb
 - lib/gocardless_pro/services/verification_details_service.rb
 - lib/gocardless_pro/services/webhooks_service.rb
 - lib/gocardless_pro/version.rb