gocardless_pro 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae0ea22dd4b670953304572b2a6a581af2ebf4c0e527e326e5a49ea61a60b402
-  data.tar.gz: b0f1e3fe0ebac8518f08a99d810306561fbf1bf8ddab7b62c35851f0200e0fed
+  metadata.gz: cb18a622d5c0c067330de44a389114cf405a64cfc0edea91a919e394ae474f04
+  data.tar.gz: 69e13eaaa22df8ec0cc104205ffb96c1505471dfb0d1dd30df831756439cd924
 SHA512:
-  metadata.gz: ac60edc33ac56076650205bac66dd77015635f89fca725e8704db3eeb5904634710638b0e3ae7438009cf819d74ce096fbd817f7219e26d25f31daa3538d786a
-  data.tar.gz: 461a8ea1135dc677860bc144d11234146df2422b0034d674089c64c4d67213bfd49b93633f9a0a465b096b1cabee449e46e0c1429ecc5942fdc96e96edddbfb8
+  metadata.gz: 228213efb6ebec8cc8a1cefebc7177f288d07ad6553d554fdca1357e67891af93036d236a17c0a544c851d64251025b80162fc1e6367aa2660afcf9ce8bd6bdd
+  data.tar.gz: ac9e1c9f784c67e41effafaddbc444d5d19eae51d00970f39edc0ea4cd466833761f517b1528f776f5ec4194c27595ac0b9fa6e4b5471284aaa92eed876ca783

data/lib/gocardless_pro/client.rb

@@ -38,6 +38,11 @@ module GoCardlessPro
       @billing_request_templates ||= Services::BillingRequestTemplatesService.new(@api_service)
     end
 
+    # Access to the service for billing_request_with_action to make API calls
+    def billing_request_with_actions
+      @billing_request_with_actions ||= Services::BillingRequestWithActionsService.new(@api_service)
+    end
+
     # Access to the service for block to make API calls
     def blocks
       @blocks ||= Services::BlocksService.new(@api_service)
@@ -248,7 +253,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '3.7.0'
+          'GoCardless-Client-Version' => '3.8.0'
         }
       }
     end

data/lib/gocardless_pro/resources/billing_request_with_action.rb

@@ -0,0 +1,47 @@
+#
+# 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 billing_request_with_action resource returned from the API
+
+    #  Billing Requests help create resources that require input or action from
+    # a customer. An example of required input might be additional customer
+    # billing details, while an action would be asking a customer to authorise a
+    # payment using their mobile banking app.
+    #
+    # See [Billing Requests:
+    # Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/)
+    # for how-to's, explanations and tutorials. <p
+    # class="notice"><strong>Important</strong>: All properties associated with
+    # `subscription_request` and `instalment_schedule_request` are only
+    # supported for ACH and PAD schemes.</p>
+    class BillingRequestWithAction
+      attr_reader :bank_authorisations, :billing_requests
+
+      # Initialize a billing_request_with_action resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @bank_authorisations = object['bank_authorisations']
+        @billing_requests = object['billing_requests']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the billing_request_with_action resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/outbound_payment.rb

@@ -23,8 +23,8 @@ module GoCardlessPro
     # refining our API to ensure it meets your needs and provides the best
     # experience.</p>
     class OutboundPayment
-      attr_reader :amount, :created_at, :description, :execution_date, :id, :is_withdrawal, :metadata, :reference,
-                  :scheme, :status, :verifications
+      attr_reader :amount, :created_at, :currency, :description, :execution_date, :id, :is_withdrawal, :metadata,
+                  :reference, :scheme, :status, :verifications
 
       # Initialize a outbound_payment resource instance
       # @param object [Hash] an object returned from the API
@@ -33,6 +33,7 @@ module GoCardlessPro
 
         @amount = object['amount']
         @created_at = object['created_at']
+        @currency = object['currency']
         @description = object['description']
         @execution_date = object['execution_date']
         @id = object['id']

data/lib/gocardless_pro/services/billing_request_with_actions_service.rb

@@ -0,0 +1,52 @@
+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 BillingRequestWithAction endpoints
+    class BillingRequestWithActionsService < BaseService
+      # Creates a billing request and completes any specified actions in a single
+      # request.
+      # This endpoint allows you to create a billing request and immediately complete
+      # actions
+      # such as collecting customer details, bank account details, or other required
+      # actions.
+      # Example URL: /billing_requests/create_with_actions
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create_with_actions(options = {})
+        path = '/billing_requests/create_with_actions'
+
+        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::BillingRequestWithAction.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
+        'billing_requests'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/refunds_service.rb

@@ -20,9 +20,6 @@ module GoCardlessPro
       # the total amount refunded for the payment. This safeguard is there to prevent
       # two processes from creating refunds without awareness of each other.
       #
-      # - `number_of_refunds_exceeded` if twenty five or more refunds have already
-      # been created against the payment.
-      #
       # - `available_refund_amount_insufficient` if the creditor does not have
       # sufficient balance for refunds available to cover the cost of the requested
       # refund.

data/lib/gocardless_pro/version.rb

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

data/lib/gocardless_pro.rb

@@ -60,6 +60,9 @@ require_relative 'gocardless_pro/services/billing_request_flows_service'
 require_relative 'gocardless_pro/resources/billing_request_template'
 require_relative 'gocardless_pro/services/billing_request_templates_service'
 
+require_relative 'gocardless_pro/resources/billing_request_with_action'
+require_relative 'gocardless_pro/services/billing_request_with_actions_service'
+
 require_relative 'gocardless_pro/resources/block'
 require_relative 'gocardless_pro/services/blocks_service'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - GoCardless
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-25 00:00:00.000000000 Z
+date: 2025-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -119,6 +119,7 @@ files:
 - lib/gocardless_pro/resources/billing_request.rb
 - lib/gocardless_pro/resources/billing_request_flow.rb
 - lib/gocardless_pro/resources/billing_request_template.rb
+- lib/gocardless_pro/resources/billing_request_with_action.rb
 - lib/gocardless_pro/resources/block.rb
 - lib/gocardless_pro/resources/creditor.rb
 - lib/gocardless_pro/resources/creditor_bank_account.rb
@@ -159,6 +160,7 @@ files:
 - lib/gocardless_pro/services/base_service.rb
 - lib/gocardless_pro/services/billing_request_flows_service.rb
 - lib/gocardless_pro/services/billing_request_templates_service.rb
+- lib/gocardless_pro/services/billing_request_with_actions_service.rb
 - lib/gocardless_pro/services/billing_requests_service.rb
 - lib/gocardless_pro/services/blocks_service.rb
 - lib/gocardless_pro/services/creditor_bank_accounts_service.rb