gocardless_pro 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b6c3812f06f80708ae87c97ddaadcd761072a851345b9ef5cf8334a41440f16
-  data.tar.gz: 4b8de1ec177c357bf1ff19714318edd61b87a9da9241d3fed8861c3e9a4bc37c
+  metadata.gz: dc192d2230d8b35d8e0d5d7aecbfce3fc0fcd3516d973b3cef282771e8c16026
+  data.tar.gz: 7db1089cd74597a29b745f2b1275d4fef842317e2672b7fe0ebe3bdf4ae91f1d
 SHA512:
-  metadata.gz: f53d81b4695e0a720a12f5f1b57ab4c0c94d6fbb5997bf42f73a6285b15abad69b7199d5f6fd6845e724e2552d66220f1946290f3ac93b2cad772714cba7a97f
-  data.tar.gz: af724b976c328d768ac04c64303bf1c9c36aa6a8e916564e4ffef23303eaf884e9a067d994f2ea51553dd7a04aba1ca70ae79cad904edb3f18aa19429f21b0c8
+  metadata.gz: 48cc431b2261bd308a6675d01127dcd11d57c3699872098da4eba888921e09c372b1e157565bd91416dc53f8c0a6d60587e7c183499f71c90caaef395c134b22
+  data.tar.gz: 2d8d59d8c86123537449a90a0a9fb927cbcba5f3b79afb9cd4111be21688a7a9f64aef4acc5e1f45dca34184d114d343389e2bc878a77c98ee7c115cf50339fc

data/lib/gocardless_pro/client.rb

@@ -123,6 +123,11 @@ module GoCardlessPro
       @negative_balance_limits ||= Services::NegativeBalanceLimitsService.new(@api_service)
     end
 
+    # Access to the service for outbound_payment to make API calls
+    def outbound_payments
+      @outbound_payments ||= Services::OutboundPaymentsService.new(@api_service)
+    end
+
     # Access to the service for payer_authorisation to make API calls
     def payer_authorisations
       @payer_authorisations ||= Services::PayerAuthorisationsService.new(@api_service)
@@ -243,7 +248,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '3.5.0'
+          'GoCardless-Client-Version' => '3.6.0'
         }
       }
     end

data/lib/gocardless_pro/resources/outbound_payment.rb

@@ -0,0 +1,82 @@
+#
+# 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 outbound_payment resource returned from the API
+
+    # Outbound Payments represent payments sent from
+    # [creditors](#core-endpoints-creditors).
+    #
+    # GoCardless will notify you via a [webhook](#appendix-webhooks) when the
+    # status of the outbound payment [changes](#event-actions-outbound-payment).
+    #
+    # <p class="restricted-notice"><strong>Restricted</strong>: Outbound
+    # Payments are currently in Early Access and available only to a limited
+    # list of organisations. If you are interested in using this feature, please
+    # stay tuned for our public launch announcement. We are actively testing and
+    # 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
+
+      # Initialize a outbound_payment resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @amount = object['amount']
+        @created_at = object['created_at']
+        @description = object['description']
+        @execution_date = object['execution_date']
+        @id = object['id']
+        @is_withdrawal = object['is_withdrawal']
+        @links = object['links']
+        @metadata = object['metadata']
+        @reference = object['reference']
+        @scheme = object['scheme']
+        @status = object['status']
+        @verifications = object['verifications']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @outbound_payment_links ||= Links.new(@links)
+      end
+
+      # Provides the outbound_payment resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def creditor
+          @links['creditor']
+        end
+
+        def customer
+          @links['customer']
+        end
+
+        def recipient_bank_account
+          @links['recipient_bank_account']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/outbound_payments_service.rb

@@ -0,0 +1,252 @@
+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 OutboundPayment endpoints
+    class OutboundPaymentsService < BaseService
+      #
+      # Example URL: /outbound_payments
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/outbound_payments'
+
+        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::OutboundPayment.new(unenvelope_body(response.body), response)
+      end
+
+      # Creates an outbound payment to your verified business bank account as the
+      # recipient.
+      # Example URL: /outbound_payments/withdrawal
+      # @param options [Hash] parameters as a hash, under a params key.
+      def withdraw(options = {})
+        path = '/outbound_payments/withdrawal'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        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::OutboundPayment.new(unenvelope_body(response.body), response)
+      end
+
+      # Cancels an outbound payment. Only outbound payments with either `verifying`,
+      # `pending_approval`, or `scheduled` status can be cancelled.
+      # Once an outbound payment is `executing`, the money moving process has begun
+      # and cannot be reversed.
+      # Example URL: /outbound_payments/:identity/actions/cancel
+      #
+      # @param identity       # Unique identifier of the outbound payment.
+      # @param options [Hash] parameters as a hash, under a params key.
+      def cancel(identity, options = {})
+        path = sub_url('/outbound_payments/:identity/actions/cancel', {
+                         'identity' => identity
+                       })
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        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::OutboundPayment.new(unenvelope_body(response.body), response)
+      end
+
+      # Approves an outbound payment. Only outbound payments with the
+      # “pending_approval” status can be approved.
+      # Example URL: /outbound_payments/:identity/actions/approve
+      #
+      # @param identity       # Unique identifier of the outbound payment.
+      # @param options [Hash] parameters as a hash, under a params key.
+      def approve(identity, options = {})
+        path = sub_url('/outbound_payments/:identity/actions/approve', {
+                         'identity' => identity
+                       })
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        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::OutboundPayment.new(unenvelope_body(response.body), response)
+      end
+
+      # Fetches an outbound_payment by ID
+      # Example URL: /outbound_payments/:identity
+      #
+      # @param identity       # Unique identifier of the outbound payment.
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/outbound_payments/:identity', {
+                         'identity' => identity
+                       })
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::OutboundPayment.new(unenvelope_body(response.body), response)
+      end
+
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of outbound
+      # payments.
+      # Example URL: /outbound_payments
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/outbound_payments'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::OutboundPayment
+        )
+      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
+
+      # Updates an outbound payment object. This accepts only the metadata parameter.
+      # Example URL: /outbound_payments/:identity
+      #
+      # @param identity       # Unique identifier of the outbound payment.
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/outbound_payments/:identity', {
+                         'identity' => identity
+                       })
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        response = make_request(:put, path, options)
+
+        return if response.body.nil?
+
+        Resources::OutboundPayment.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
+        'outbound_payments'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/version.rb

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

data/lib/gocardless_pro.rb

@@ -111,6 +111,9 @@ require_relative 'gocardless_pro/services/mandate_pdfs_service'
 require_relative 'gocardless_pro/resources/negative_balance_limit'
 require_relative 'gocardless_pro/services/negative_balance_limits_service'
 
+require_relative 'gocardless_pro/resources/outbound_payment'
+require_relative 'gocardless_pro/services/outbound_payments_service'
+
 require_relative 'gocardless_pro/resources/payer_authorisation'
 require_relative 'gocardless_pro/services/payer_authorisations_service'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - GoCardless
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-04 00:00:00.000000000 Z
+date: 2025-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,6 +136,7 @@ files:
 - 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/outbound_payment.rb
 - lib/gocardless_pro/resources/payer_authorisation.rb
 - lib/gocardless_pro/resources/payer_theme.rb
 - lib/gocardless_pro/resources/payment.rb
@@ -176,6 +177,7 @@ files:
 - 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/outbound_payments_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