gocardless_pro 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d491b212bf75a7f70a1191be6b0d7d94eb4fb6cfd2d319047d62d0e2e9adf94b
-  data.tar.gz: e473a9b05df7ec6b70e48f2b426a7fae6585ed0c919a3963d91431d6fe5bd4a4
+  metadata.gz: 215f258cc6eedaf440d8ecd8f6d603b85fc693f1d97bd1a84838e1cd8b910c8c
+  data.tar.gz: 4b94529879e8e0e88e09cf4b3a903c4e933acbc9934707e8b1d5f168c0b6b4c5
 SHA512:
-  metadata.gz: b605624bcbbace950cf6ad9c4558a0b06abc9da731c85e934645716918cd9b9b9a5b25649e7a3e9fab57d8ca38f4facb8a221276062a1671e168eaff294d94e6
-  data.tar.gz: eeb013ab2a0278f9f56ccb437b0f61107d7afdbdbb9670a58aff1c6afea7086b319f9a349996401d64c68281c9be743a27d1e1e7318d6ae0a6681325e438a6d1
+  metadata.gz: 96f03cb54c869ee653a7ea3bced2edca67e5edc0fe7ef4561b75edeca5a60a2d758b6c8632b0b86485500ef2d44644e369810e632575eb8e60cf5ba8da93e077
+  data.tar.gz: 320f63dd94607c96eef0a42ffb8137e24b9b6cd07d201ca29e3fa53b82ef81907f150d92df6f2e72430f5cedf0ed329d7bcc1b41e83261790e7c1e0c49a5c5ef

data/lib/gocardless_pro/client.rb

@@ -3,6 +3,11 @@ module GoCardlessPro
   class Client
     extend Forwardable
 
+    # Access to the service for balance to make API calls
+    def balances
+      @balances ||= Services::BalancesService.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)
@@ -233,7 +238,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '3.2.0'
+          'GoCardless-Client-Version' => '3.3.0'
         }
       }
     end

data/lib/gocardless_pro/resources/balance.rb

@@ -0,0 +1,61 @@
+#
+# 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 balance resource returned from the API
+
+    # Returns the balances for a creditor. These balances are the same as what’s
+    # shown in the dashboard with one exception (mentioned below under
+    # balance_type).
+    #
+    # These balances will typically be 3-5 minutes old. The balance amounts
+    # likely won’t match what’s shown in the dashboard as the dashboard balances
+    # are updated much less frequently (once per day).
+    class Balance
+      attr_reader :amount, :balance_type, :currency, :last_updated_at
+
+      # Initialize a balance resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @amount = object['amount']
+        @balance_type = object['balance_type']
+        @currency = object['currency']
+        @last_updated_at = object['last_updated_at']
+        @links = object['links']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @balance_links ||= Links.new(@links)
+      end
+
+      # Provides the balance 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
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/balances_service.rb

@@ -0,0 +1,57 @@
+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 Balance endpoints
+    class BalancesService < BaseService
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of balances
+      # for a given creditor. This endpoint is rate limited to 60 requests per minute.
+      # Example URL: /balances
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/balances'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Balance
+        )
+      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
+
+      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
+        'balances'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/refunds_service.rb

@@ -20,8 +20,8 @@ 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 five or more refunds have already been
-      # created against the payment.
+      # - `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

data/lib/gocardless_pro/services/scenario_simulators_service.rb

@@ -52,11 +52,12 @@ module GoCardlessPro
       # the charged back payment.</li>
       # <li>`payment_late_failure`: Transitions a payment through to
       # `late_failure`, having been apparently collected successfully
-      # beforehand. It must start in the `pending_submission` state, and its
-      # mandate must be in the `activated` state (unless it is a payment for
-      # ACH, BECS, BECS_NZ or SEPA, in which cases the mandate may be
-      # `pending_submission`, since their mandates are submitted with their
-      # first payment). Not compatible with Autogiro mandates.</li>
+      # beforehand. It must start in either the `pending_submission` or
+      # `paid_out` state, and its mandate must be in the `activated` state
+      # (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in which cases
+      # the mandate may be `pending_submission`, since their mandates are
+      # submitted with their first payment). Not compatible with Autogiro
+      # mandates.</li>
       # <li>`payment_late_failure_settled`: Behaves the same as the
       # `payment_late_failure` simulator, except that the late failure is
       # additionally included as a debit item in a payout, thereby settling the

data/lib/gocardless_pro/version.rb

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

data/lib/gocardless_pro.rb

@@ -39,6 +39,9 @@ require_relative 'gocardless_pro/response'
 require_relative 'gocardless_pro/api_response'
 require_relative 'gocardless_pro/webhook'
 
+require_relative 'gocardless_pro/resources/balance'
+require_relative 'gocardless_pro/services/balances_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.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - GoCardless
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-28 00:00:00.000000000 Z
+date: 2025-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -112,6 +112,7 @@ files:
 - lib/gocardless_pro/middlewares/raise_gocardless_errors.rb
 - lib/gocardless_pro/paginator.rb
 - lib/gocardless_pro/request.rb
+- lib/gocardless_pro/resources/balance.rb
 - lib/gocardless_pro/resources/bank_authorisation.rb
 - lib/gocardless_pro/resources/bank_details_lookup.rb
 - lib/gocardless_pro/resources/billing_request.rb
@@ -149,6 +150,7 @@ files:
 - lib/gocardless_pro/resources/verification_detail.rb
 - lib/gocardless_pro/resources/webhook.rb
 - lib/gocardless_pro/response.rb
+- lib/gocardless_pro/services/balances_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