increase 1.150.0 → 1.151.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89c9f0057b1e157bd7959df269843a320b4480e2fd264514a86a769b0b6a25f1
-  data.tar.gz: daa213d1babb35d5b952477f9fcc03a736e2a83c7be6dccfada11ad8bcda97e4
+  metadata.gz: acb1fec6de870e0a54adc307845a4de25046ef5bb5f25ecb024b7a61e23b1036
+  data.tar.gz: 71d80220336df77cbfbef809e4b63f7be53e05bce254151dc3f43b8db01ef98b
 SHA512:
-  metadata.gz: e7c117463b779520a067e1ff187e265972bbe0935c8ec44e4ecca68917ad1f04fa4e47b4e0d1363e4893d74ef900dfe583b1e8ad69bdf05a1fdb3946092b5bd2
-  data.tar.gz: bb7deb0bc5ea347caebbf3d36f7d24c0cd2df616c5c828972e416066f86486e96c892d76d0750cee36af15b815a90764ee84cbe20b2831286b06fe3baab5b8af
+  metadata.gz: 894f6a1f6311526047c49b31e0a47169133199951058d065cf13a3dc9a22d9c7b889a87c1fd3fa14d6ad7e6bcf71c8b334195703115c1bbabf6622037737370d
+  data.tar.gz: 0ebdad7d065458d7395cb78fa2d1558d7f7b75c4f32b1f57f10d85f7f6d81ac5e121b31f5ddf44205cc05dffe280f0170c05ab7cea0f28ba608ad1c300d4eb0d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.151.0 (2025-11-26)
+
+Full Changelog: [v1.150.0...v1.151.0](https://github.com/Increase/increase-ruby/compare/v1.150.0...v1.151.0)
+
+### Features
+
+* **api:** api update ([482166c](https://github.com/Increase/increase-ruby/commit/482166c1ef656506c37cafb2585b0c9b3b8de2c7))
+
 ## 1.150.0 (2025-11-26)
 
 Full Changelog: [v1.149.0...v1.150.0](https://github.com/Increase/increase-ruby/compare/v1.149.0...v1.150.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.150.0"
+gem "increase", "~> 1.151.0"
 ```
 
 <!-- x-release-please-end -->
@@ -31,11 +31,43 @@ increase = Increase::Client.new(
   environment: "sandbox" # defaults to "production"
 )
 
-account = increase.accounts.create(name: "New Account!")
+account = increase.accounts.create(
+  name: "New Account!",
+  entity_id: "entity_n8y8tnk2p9339ti393yi",
+  program_id: "program_i2v2os4mwza1oetokh9i"
+)
 
 puts(account.id)
 ```
 
+### Pagination
+
+List methods in the Increase API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```ruby
+page = increase.accounts.list
+
+# Fetch single item from page.
+account = page.data[0]
+puts(account.id)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |account|
+  puts(account.id)
+end
+```
+
+Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
+
+```ruby
+if page.next_page?
+  new_page = page.next_page
+  puts(new_page.data[0].id)
+end
+```
+
 ### File uploads
 
 Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
@@ -106,7 +138,12 @@ increase = Increase::Client.new(
 )
 
 # Or, configure per-request:
-increase.accounts.create(name: "New Account!", request_options: {max_retries: 5})
+increase.accounts.create(
+  name: "New Account!",
+  entity_id: "entity_n8y8tnk2p9339ti393yi",
+  program_id: "program_i2v2os4mwza1oetokh9i",
+  request_options: {max_retries: 5}
+)
 ```
 
 ### Timeouts
@@ -120,7 +157,12 @@ increase = Increase::Client.new(
 )
 
 # Or, configure per-request:
-increase.accounts.create(name: "New Account!", request_options: {timeout: 5})
+increase.accounts.create(
+  name: "New Account!",
+  entity_id: "entity_n8y8tnk2p9339ti393yi",
+  program_id: "program_i2v2os4mwza1oetokh9i",
+  request_options: {timeout: 5}
+)
 ```
 
 On timeout, `Increase::Errors::APITimeoutError` is raised.
@@ -153,6 +195,8 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 account =
   increase.accounts.create(
     name: "New Account!",
+    entity_id: "entity_n8y8tnk2p9339ti393yi",
+    program_id: "program_i2v2os4mwza1oetokh9i",
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -198,17 +242,29 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-increase.accounts.create(name: "New Account!")
+increase.accounts.create(
+  name: "New Account!",
+  entity_id: "entity_n8y8tnk2p9339ti393yi",
+  program_id: "program_i2v2os4mwza1oetokh9i"
+)
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-increase.accounts.create(name: "New Account!")
+increase.accounts.create(
+  name: "New Account!",
+  entity_id: "entity_n8y8tnk2p9339ti393yi",
+  program_id: "program_i2v2os4mwza1oetokh9i"
+)
 
 # You can also splat a full Params class:
-params = Increase::AccountCreateParams.new(name: "New Account!")
+params = Increase::AccountCreateParams.new(
+  name: "New Account!",
+  entity_id: "entity_n8y8tnk2p9339ti393yi",
+  program_id: "program_i2v2os4mwza1oetokh9i"
+)
 increase.accounts.create(**params)
 ```
 

data/lib/increase/internal/page.rb

@@ -10,21 +10,21 @@ module Increase
     #   end
     #
     # @example
-    #   page.auto_paging_each do |item|
-    #     puts(item)
+    #   page.auto_paging_each do |account|
+    #     puts(account)
     #   end
     class Page
       include Increase::Internal::Type::BasePage
 
-      # @return [Object]
+      # @return [Array<generic<Elem>>, nil]
       attr_accessor :data
 
-      # @return [Object]
+      # @return [String, nil]
       attr_accessor :next_cursor
 
       # @return [Boolean]
       def next_page?
-        !empty? && !next_cursor.nil?
+        !data.to_a.empty? && !next_cursor.to_s.empty?
       end
 
       # @raise [Increase::HTTP::Error]
@@ -35,7 +35,7 @@ module Increase
           raise RuntimeError.new(message)
         end
 
-        req = Increase::Internal::Util.deep_merge(@req, {query: {":cursor": next_cursor}})
+        req = Increase::Internal::Util.deep_merge(@req, {query: {cursor: next_cursor}})
         @client.request(req)
       end
 
@@ -49,7 +49,7 @@ module Increase
 
         page = self
         loop do
-          page.each(&blk)
+          page.data&.each(&blk)
 
           break unless page.next_page?
           page = page.next_page
@@ -65,8 +65,12 @@ module Increase
       def initialize(client:, req:, headers:, page_data:)
         super
 
-        @data = page_data[:":data"]
-        @next_cursor = page_data[:":next_cursor"]
+        case page_data
+        in {data: Array => data}
+          @data = data.map { Increase::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        @next_cursor = page_data[:next_cursor]
       end
 
       # @api private
@@ -75,7 +79,7 @@ module Increase
       def inspect
         model = Increase::Internal::Type::Converter.inspect(@model, depth: 1)
 
-        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} next_cursor=#{next_cursor.inspect}>"
       end
     end
   end

data/lib/increase/models/routing_number_list_response.rb

@@ -4,168 +4,145 @@ module Increase
   module Models
     # @see Increase::Resources::RoutingNumbers#list
     class RoutingNumberListResponse < Increase::Internal::Type::BaseModel
-      # @!attribute data
-      #   The contents of the list.
-      #
-      #   @return [Array<Increase::Models::RoutingNumberListResponse::Data>]
-      required :data,
-               -> { Increase::Internal::Type::ArrayOf[Increase::Models::RoutingNumberListResponse::Data] }
-
-      # @!attribute next_cursor
-      #   A pointer to a place in the list.
-      #
-      #   @return [String, nil]
-      required :next_cursor, String, nil?: true
-
-      # @!method initialize(data:, next_cursor:)
-      #   A list of Routing Number objects.
-      #
-      #   @param data [Array<Increase::Models::RoutingNumberListResponse::Data>] The contents of the list.
-      #
-      #   @param next_cursor [String, nil] A pointer to a place in the list.
-
-      class Data < Increase::Internal::Type::BaseModel
-        # @!attribute ach_transfers
-        #   This routing number's support for ACH Transfers.
-        #
-        #   @return [Symbol, Increase::Models::RoutingNumberListResponse::Data::ACHTransfers]
-        required :ach_transfers, enum: -> { Increase::Models::RoutingNumberListResponse::Data::ACHTransfers }
-
-        # @!attribute fednow_transfers
-        #   This routing number's support for FedNow Transfers.
-        #
-        #   @return [Symbol, Increase::Models::RoutingNumberListResponse::Data::FednowTransfers]
-        required :fednow_transfers,
-                 enum: -> { Increase::Models::RoutingNumberListResponse::Data::FednowTransfers }
-
-        # @!attribute name
-        #   The name of the financial institution belonging to a routing number.
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute real_time_payments_transfers
-        #   This routing number's support for Real-Time Payments Transfers.
-        #
-        #   @return [Symbol, Increase::Models::RoutingNumberListResponse::Data::RealTimePaymentsTransfers]
-        required :real_time_payments_transfers,
-                 enum: -> { Increase::Models::RoutingNumberListResponse::Data::RealTimePaymentsTransfers }
-
-        # @!attribute routing_number
-        #   The nine digit routing number identifier.
-        #
-        #   @return [String]
-        required :routing_number, String
-
-        # @!attribute type
-        #   A constant representing the object's type. For this resource it will always be
-        #   `routing_number`.
-        #
-        #   @return [Symbol, Increase::Models::RoutingNumberListResponse::Data::Type]
-        required :type, enum: -> { Increase::Models::RoutingNumberListResponse::Data::Type }
-
-        # @!attribute wire_transfers
-        #   This routing number's support for Wire Transfers.
-        #
-        #   @return [Symbol, Increase::Models::RoutingNumberListResponse::Data::WireTransfers]
-        required :wire_transfers, enum: -> { Increase::Models::RoutingNumberListResponse::Data::WireTransfers }
-
-        # @!method initialize(ach_transfers:, fednow_transfers:, name:, real_time_payments_transfers:, routing_number:, type:, wire_transfers:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::RoutingNumberListResponse::Data} for more details.
-        #
-        #   Routing numbers are used to identify your bank in a financial transaction.
-        #
-        #   @param ach_transfers [Symbol, Increase::Models::RoutingNumberListResponse::Data::ACHTransfers] This routing number's support for ACH Transfers.
-        #
-        #   @param fednow_transfers [Symbol, Increase::Models::RoutingNumberListResponse::Data::FednowTransfers] This routing number's support for FedNow Transfers.
-        #
-        #   @param name [String] The name of the financial institution belonging to a routing number.
-        #
-        #   @param real_time_payments_transfers [Symbol, Increase::Models::RoutingNumberListResponse::Data::RealTimePaymentsTransfers] This routing number's support for Real-Time Payments Transfers.
-        #
-        #   @param routing_number [String] The nine digit routing number identifier.
-        #
-        #   @param type [Symbol, Increase::Models::RoutingNumberListResponse::Data::Type] A constant representing the object's type. For this resource it will always be `
-        #
-        #   @param wire_transfers [Symbol, Increase::Models::RoutingNumberListResponse::Data::WireTransfers] This routing number's support for Wire Transfers.
-
-        # This routing number's support for ACH Transfers.
-        #
-        # @see Increase::Models::RoutingNumberListResponse::Data#ach_transfers
-        module ACHTransfers
-          extend Increase::Internal::Type::Enum
-
-          # The routing number can receive this transfer type.
-          SUPPORTED = :supported
-
-          # The routing number cannot receive this transfer type.
-          NOT_SUPPORTED = :not_supported
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # This routing number's support for FedNow Transfers.
-        #
-        # @see Increase::Models::RoutingNumberListResponse::Data#fednow_transfers
-        module FednowTransfers
-          extend Increase::Internal::Type::Enum
-
-          # The routing number can receive this transfer type.
-          SUPPORTED = :supported
-
-          # The routing number cannot receive this transfer type.
-          NOT_SUPPORTED = :not_supported
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # This routing number's support for Real-Time Payments Transfers.
-        #
-        # @see Increase::Models::RoutingNumberListResponse::Data#real_time_payments_transfers
-        module RealTimePaymentsTransfers
-          extend Increase::Internal::Type::Enum
-
-          # The routing number can receive this transfer type.
-          SUPPORTED = :supported
-
-          # The routing number cannot receive this transfer type.
-          NOT_SUPPORTED = :not_supported
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # A constant representing the object's type. For this resource it will always be
-        # `routing_number`.
-        #
-        # @see Increase::Models::RoutingNumberListResponse::Data#type
-        module Type
-          extend Increase::Internal::Type::Enum
-
-          ROUTING_NUMBER = :routing_number
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # This routing number's support for Wire Transfers.
-        #
-        # @see Increase::Models::RoutingNumberListResponse::Data#wire_transfers
-        module WireTransfers
-          extend Increase::Internal::Type::Enum
-
-          # The routing number can receive this transfer type.
-          SUPPORTED = :supported
-
-          # The routing number cannot receive this transfer type.
-          NOT_SUPPORTED = :not_supported
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
+      # @!attribute ach_transfers
+      #   This routing number's support for ACH Transfers.
+      #
+      #   @return [Symbol, Increase::Models::RoutingNumberListResponse::ACHTransfers]
+      required :ach_transfers, enum: -> { Increase::Models::RoutingNumberListResponse::ACHTransfers }
+
+      # @!attribute fednow_transfers
+      #   This routing number's support for FedNow Transfers.
+      #
+      #   @return [Symbol, Increase::Models::RoutingNumberListResponse::FednowTransfers]
+      required :fednow_transfers, enum: -> { Increase::Models::RoutingNumberListResponse::FednowTransfers }
+
+      # @!attribute name
+      #   The name of the financial institution belonging to a routing number.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute real_time_payments_transfers
+      #   This routing number's support for Real-Time Payments Transfers.
+      #
+      #   @return [Symbol, Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers]
+      required :real_time_payments_transfers,
+               enum: -> { Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers }
+
+      # @!attribute routing_number
+      #   The nine digit routing number identifier.
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `routing_number`.
+      #
+      #   @return [Symbol, Increase::Models::RoutingNumberListResponse::Type]
+      required :type, enum: -> { Increase::Models::RoutingNumberListResponse::Type }
+
+      # @!attribute wire_transfers
+      #   This routing number's support for Wire Transfers.
+      #
+      #   @return [Symbol, Increase::Models::RoutingNumberListResponse::WireTransfers]
+      required :wire_transfers, enum: -> { Increase::Models::RoutingNumberListResponse::WireTransfers }
+
+      # @!method initialize(ach_transfers:, fednow_transfers:, name:, real_time_payments_transfers:, routing_number:, type:, wire_transfers:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::RoutingNumberListResponse} for more details.
+      #
+      #   Routing numbers are used to identify your bank in a financial transaction.
+      #
+      #   @param ach_transfers [Symbol, Increase::Models::RoutingNumberListResponse::ACHTransfers] This routing number's support for ACH Transfers.
+      #
+      #   @param fednow_transfers [Symbol, Increase::Models::RoutingNumberListResponse::FednowTransfers] This routing number's support for FedNow Transfers.
+      #
+      #   @param name [String] The name of the financial institution belonging to a routing number.
+      #
+      #   @param real_time_payments_transfers [Symbol, Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers] This routing number's support for Real-Time Payments Transfers.
+      #
+      #   @param routing_number [String] The nine digit routing number identifier.
+      #
+      #   @param type [Symbol, Increase::Models::RoutingNumberListResponse::Type] A constant representing the object's type. For this resource it will always be `
+      #
+      #   @param wire_transfers [Symbol, Increase::Models::RoutingNumberListResponse::WireTransfers] This routing number's support for Wire Transfers.
+
+      # This routing number's support for ACH Transfers.
+      #
+      # @see Increase::Models::RoutingNumberListResponse#ach_transfers
+      module ACHTransfers
+        extend Increase::Internal::Type::Enum
+
+        # The routing number can receive this transfer type.
+        SUPPORTED = :supported
+
+        # The routing number cannot receive this transfer type.
+        NOT_SUPPORTED = :not_supported
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # This routing number's support for FedNow Transfers.
+      #
+      # @see Increase::Models::RoutingNumberListResponse#fednow_transfers
+      module FednowTransfers
+        extend Increase::Internal::Type::Enum
+
+        # The routing number can receive this transfer type.
+        SUPPORTED = :supported
+
+        # The routing number cannot receive this transfer type.
+        NOT_SUPPORTED = :not_supported
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # This routing number's support for Real-Time Payments Transfers.
+      #
+      # @see Increase::Models::RoutingNumberListResponse#real_time_payments_transfers
+      module RealTimePaymentsTransfers
+        extend Increase::Internal::Type::Enum
+
+        # The routing number can receive this transfer type.
+        SUPPORTED = :supported
+
+        # The routing number cannot receive this transfer type.
+        NOT_SUPPORTED = :not_supported
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `routing_number`.
+      #
+      # @see Increase::Models::RoutingNumberListResponse#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        ROUTING_NUMBER = :routing_number
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # This routing number's support for Wire Transfers.
+      #
+      # @see Increase::Models::RoutingNumberListResponse#wire_transfers
+      module WireTransfers
+        extend Increase::Internal::Type::Enum
+
+        # The routing number can receive this transfer type.
+        SUPPORTED = :supported
+
+        # The routing number cannot receive this transfer type.
+        NOT_SUPPORTED = :not_supported
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/increase/resources/account_numbers.rb

@@ -110,7 +110,7 @@ module Increase
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Increase::Models::AccountNumberListResponse]
+      # @return [Increase::Internal::Page<Increase::Models::AccountNumber>]
       #
       # @see Increase::Models::AccountNumberListParams
       def list(params = {})
@@ -119,7 +119,8 @@ module Increase
           method: :get,
           path: "account_numbers",
           query: parsed,
-          model: Increase::Models::AccountNumberListResponse,
+          page: Increase::Internal::Page,
+          model: Increase::AccountNumber,
           options: options
         )
       end

data/lib/increase/resources/account_statements.rb

@@ -40,7 +40,7 @@ module Increase
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Increase::Models::AccountStatementListResponse]
+      # @return [Increase::Internal::Page<Increase::Models::AccountStatement>]
       #
       # @see Increase::Models::AccountStatementListParams
       def list(params = {})
@@ -49,7 +49,8 @@ module Increase
           method: :get,
           path: "account_statements",
           query: parsed,
-          model: Increase::Models::AccountStatementListResponse,
+          page: Increase::Internal::Page,
+          model: Increase::AccountStatement,
           options: options
         )
       end

data/lib/increase/resources/account_transfers.rb

@@ -75,7 +75,7 @@ module Increase
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Increase::Models::AccountTransferListResponse]
+      # @return [Increase::Internal::Page<Increase::Models::AccountTransfer>]
       #
       # @see Increase::Models::AccountTransferListParams
       def list(params = {})
@@ -84,7 +84,8 @@ module Increase
           method: :get,
           path: "account_transfers",
           query: parsed,
-          model: Increase::Models::AccountTransferListResponse,
+          page: Increase::Internal::Page,
+          model: Increase::AccountTransfer,
           options: options
         )
       end

data/lib/increase/resources/accounts.rb

@@ -108,7 +108,7 @@ module Increase
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Increase::Models::AccountListResponse]
+      # @return [Increase::Internal::Page<Increase::Models::Account>]
       #
       # @see Increase::Models::AccountListParams
       def list(params = {})
@@ -117,7 +117,8 @@ module Increase
           method: :get,
           path: "accounts",
           query: parsed,
-          model: Increase::Models::AccountListResponse,
+          page: Increase::Internal::Page,
+          model: Increase::Account,
           options: options
         )
       end

data/lib/increase/resources/ach_prenotifications.rb

@@ -89,7 +89,7 @@ module Increase
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Increase::Models::ACHPrenotificationListResponse]
+      # @return [Increase::Internal::Page<Increase::Models::ACHPrenotification>]
       #
       # @see Increase::Models::ACHPrenotificationListParams
       def list(params = {})
@@ -98,7 +98,8 @@ module Increase
           method: :get,
           path: "ach_prenotifications",
           query: parsed,
-          model: Increase::Models::ACHPrenotificationListResponse,
+          page: Increase::Internal::Page,
+          model: Increase::ACHPrenotification,
           options: options
         )
       end

data/lib/increase/resources/ach_transfers.rb

@@ -107,7 +107,7 @@ module Increase
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Increase::Models::ACHTransferListResponse]
+      # @return [Increase::Internal::Page<Increase::Models::ACHTransfer>]
       #
       # @see Increase::Models::ACHTransferListParams
       def list(params = {})
@@ -116,7 +116,8 @@ module Increase
           method: :get,
           path: "ach_transfers",
           query: parsed,
-          model: Increase::Models::ACHTransferListResponse,
+          page: Increase::Internal::Page,
+          model: Increase::ACHTransfer,
           options: options
         )
       end