release: 1.88.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.87.0"
+  ".": "1.88.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 214
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-beb9032c2ea0fb6fb46727701c252d27d8f2f77688472dc922fb10afb142dd1c.yml
-openapi_spec_hash: dc5aa90744d4e0958a9a2d652adda0ba
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-4c440e14682c4e4c886da6d05b2f5ff539a3aadc6906bb4069a5df45e0d3cae9.yml
+openapi_spec_hash: e400be1da67cec4ce706eda1868dd86b
 config_hash: 8dadd60eab7ab858cf06c6a8633ed9f3

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.88.0 (2025-09-24)
+
+Full Changelog: [v1.87.0...v1.88.0](https://github.com/Increase/increase-ruby/compare/v1.87.0...v1.88.0)
+
+### Features
+
+* **api:** api update ([3f9bdb7](https://github.com/Increase/increase-ruby/commit/3f9bdb780f32cc60a80b2db10cf3eea3f7872330))
+
 ## 1.87.0 (2025-09-23)
 
 Full Changelog: [v1.86.0...v1.87.0](https://github.com/Increase/increase-ruby/compare/v1.86.0...v1.87.0)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    increase (1.87.0)
+    increase (1.88.0)
       connection_pool
 
 GEM

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.87.0"
+gem "increase", "~> 1.88.0"
 ```
 
 <!-- x-release-please-end -->

lib/increase/models/account_transfer.rb

@@ -5,20 +5,20 @@ module Models
     # @see Increase::Resources::AccountTransfers#create
     class AccountTransfer < Increase::Internal::Type::BaseModel
       # @!attribute id
-      #   The account transfer's identifier.
+      #   The Account Transfer's identifier.
       #
       #   @return [String]
       required :id, String
 
       # @!attribute account_id
-      #   The Account to which the transfer belongs.
+      #   The Account from which the transfer originated.
       #
       #   @return [String]
       required :account_id, String
 
       # @!attribute amount
-      #   The transfer amount in the minor unit of the destination account currency. For
-      #   dollars, for example, this is cents.
+      #   The transfer amount in cents. This will always be positive and indicates the
+      #   amount of money leaving the originating account.
       #
       #   @return [Integer]
       required :amount, Integer
@@ -51,26 +51,28 @@ class AccountTransfer < Increase::Internal::Type::BaseModel
       required :created_by, -> { Increase::AccountTransfer::CreatedBy }, nil?: true
 
       # @!attribute currency
-      #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-      #   account currency.
+      #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
+      #   currency.
       #
       #   @return [Symbol, Increase::Models::AccountTransfer::Currency]
       required :currency, enum: -> { Increase::AccountTransfer::Currency }
 
       # @!attribute description
-      #   The description that will show on the transactions.
+      #   An internal-facing description for the transfer for display in the API and
+      #   dashboard. This will also show in the description of the created Transactions.
       #
       #   @return [String]
       required :description, String
 
       # @!attribute destination_account_id
-      #   The destination account's identifier.
+      #   The destination Account's identifier.
       #
       #   @return [String]
       required :destination_account_id, String
 
       # @!attribute destination_transaction_id
-      #   The ID for the transaction receiving the transfer.
+      #   The identifier of the Transaction on the destination Account representing the
+      #   received funds.
       #
       #   @return [String, nil]
       required :destination_transaction_id, String, nil?: true
@@ -83,12 +85,6 @@ class AccountTransfer < Increase::Internal::Type::BaseModel
       #   @return [String, nil]
       required :idempotency_key, String, nil?: true
 
-      # @!attribute network
-      #   The transfer's network.
-      #
-      #   @return [Symbol, Increase::Models::AccountTransfer::Network]
-      required :network, enum: -> { Increase::AccountTransfer::Network }
-
       # @!attribute pending_transaction_id
       #   The ID for the pending transaction representing the transfer. A pending
       #   transaction is created when the transfer
@@ -105,7 +101,8 @@ class AccountTransfer < Increase::Internal::Type::BaseModel
       required :status, enum: -> { Increase::AccountTransfer::Status }
 
       # @!attribute transaction_id
-      #   The ID for the transaction funding the transfer.
+      #   The identifier of the Transaction on the originating account representing the
+      #   transferred funds.
       #
       #   @return [String, nil]
       required :transaction_id, String, nil?: true
@@ -117,17 +114,22 @@ class AccountTransfer < Increase::Internal::Type::BaseModel
       #   @return [Symbol, Increase::Models::AccountTransfer::Type]
       required :type, enum: -> { Increase::AccountTransfer::Type }
 
-      # @!method initialize(id:, account_id:, amount:, approval:, cancellation:, created_at:, created_by:, currency:, description:, destination_account_id:, destination_transaction_id:, idempotency_key:, network:, pending_transaction_id:, status:, transaction_id:, type:)
+      # @!method initialize(id:, account_id:, amount:, approval:, cancellation:, created_at:, created_by:, currency:, description:, destination_account_id:, destination_transaction_id:, idempotency_key:, pending_transaction_id:, status:, transaction_id:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::AccountTransfer} for more details.
       #
-      #   Account transfers move funds between your own accounts at Increase.
+      #   Account transfers move funds between your own accounts at Increase (accounting
+      #   systems often refer to these as Book Transfers). Account Transfers are free and
+      #   synchronous. Upon creation they create two Transactions, one negative on the
+      #   originating account and one positive on the destination account (unless the
+      #   transfer requires approval, in which case the Transactions will be created when
+      #   the transfer is approved).
       #
-      #   @param id [String] The account transfer's identifier.
+      #   @param id [String] The Account Transfer's identifier.
       #
-      #   @param account_id [String] The Account to which the transfer belongs.
+      #   @param account_id [String] The Account from which the transfer originated.
       #
-      #   @param amount [Integer] The transfer amount in the minor unit of the destination account currency. For d
+      #   @param amount [Integer] The transfer amount in cents. This will always be positive and indicates the amo
       #
       #   @param approval [Increase::Models::AccountTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved,
       #
@@ -137,23 +139,21 @@ class AccountTransfer < Increase::Internal::Type::BaseModel
       #
       #   @param created_by [Increase::Models::AccountTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
       #
-      #   @param currency [Symbol, Increase::Models::AccountTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
+      #   @param currency [Symbol, Increase::Models::AccountTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
       #
-      #   @param description [String] The description that will show on the transactions.
+      #   @param description [String] An internal-facing description for the transfer for display in the API and dashb
       #
-      #   @param destination_account_id [String] The destination account's identifier.
+      #   @param destination_account_id [String] The destination Account's identifier.
       #
-      #   @param destination_transaction_id [String, nil] The ID for the transaction receiving the transfer.
+      #   @param destination_transaction_id [String, nil] The identifier of the Transaction on the destination Account representing the re
       #
       #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
       #
-      #   @param network [Symbol, Increase::Models::AccountTransfer::Network] The transfer's network.
-      #
       #   @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact
       #
       #   @param status [Symbol, Increase::Models::AccountTransfer::Status] The lifecycle status of the transfer.
       #
-      #   @param transaction_id [String, nil] The ID for the transaction funding the transfer.
+      #   @param transaction_id [String, nil] The identifier of the Transaction on the originating account representing the tr
       #
       #   @param type [Symbol, Increase::Models::AccountTransfer::Type] A constant representing the object's type. For this resource it will always be `
 
@@ -312,8 +312,8 @@ class User < Increase::Internal::Type::BaseModel
         end
       end
 
-      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-      # account currency.
+      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
+      # currency.
       #
       # @see Increase::Models::AccountTransfer#currency
       module Currency
@@ -341,28 +341,16 @@ module Currency
         #   @return [Array<Symbol>]
       end
 
-      # The transfer's network.
-      #
-      # @see Increase::Models::AccountTransfer#network
-      module Network
-        extend Increase::Internal::Type::Enum
-
-        ACCOUNT = :account
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
       # The lifecycle status of the transfer.
       #
       # @see Increase::Models::AccountTransfer#status
       module Status
         extend Increase::Internal::Type::Enum
 
-        # The transfer is pending approval.
+        # The transfer is pending approval from your team.
         PENDING_APPROVAL = :pending_approval
 
-        # The transfer has been canceled.
+        # The transfer was pending approval from your team and has been canceled.
         CANCELED = :canceled
 
         # The transfer has been completed.

lib/increase/models/account_transfer_create_params.rb

@@ -8,7 +8,7 @@ class AccountTransferCreateParams < Increase::Internal::Type::BaseModel
       include Increase::Internal::Type::RequestParameters
 
       # @!attribute account_id
-      #   The identifier for the account that will send the transfer.
+      #   The identifier for the originating Account that will send the transfer.
       #
       #   @return [String]
       required :account_id, String
@@ -21,19 +21,22 @@ class AccountTransferCreateParams < Increase::Internal::Type::BaseModel
       required :amount, Integer
 
       # @!attribute description
-      #   The description you choose to give the transfer.
+      #   An internal-facing description for the transfer for display in the API and
+      #   dashboard. This will also show in the description of the created Transactions.
       #
       #   @return [String]
       required :description, String
 
       # @!attribute destination_account_id
-      #   The identifier for the account that will receive the transfer.
+      #   The identifier for the destination Account that will receive the transfer.
       #
       #   @return [String]
       required :destination_account_id, String
 
       # @!attribute require_approval
-      #   Whether the transfer requires explicit approval via the dashboard or API.
+      #   Whether the transfer should require explicit approval via the dashboard or API.
+      #   For more information, see
+      #   [Transfer Approvals](/documentation/transfer-approvals).
       #
       #   @return [Boolean, nil]
       optional :require_approval, Increase::Internal::Type::Boolean
@@ -42,15 +45,15 @@ class AccountTransferCreateParams < Increase::Internal::Type::BaseModel
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::AccountTransferCreateParams} for more details.
       #
-      #   @param account_id [String] The identifier for the account that will send the transfer.
+      #   @param account_id [String] The identifier for the originating Account that will send the transfer.
       #
       #   @param amount [Integer] The transfer amount in the minor unit of the account currency. For dollars, for
       #
-      #   @param description [String] The description you choose to give the transfer.
+      #   @param description [String] An internal-facing description for the transfer for display in the API and dashb
       #
-      #   @param destination_account_id [String] The identifier for the account that will receive the transfer.
+      #   @param destination_account_id [String] The identifier for the destination Account that will receive the transfer.
       #
-      #   @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      #   @param require_approval [Boolean] Whether the transfer should require explicit approval via the dashboard or API.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
     end

lib/increase/resources/account_transfers.rb

@@ -10,15 +10,15 @@ class AccountTransfers
       #
       # @overload create(account_id:, amount:, description:, destination_account_id:, require_approval: nil, request_options: {})
       #
-      # @param account_id [String] The identifier for the account that will send the transfer.
+      # @param account_id [String] The identifier for the originating Account that will send the transfer.
       #
       # @param amount [Integer] The transfer amount in the minor unit of the account currency. For dollars, for
       #
-      # @param description [String] The description you choose to give the transfer.
+      # @param description [String] An internal-facing description for the transfer for display in the API and dashb
       #
-      # @param destination_account_id [String] The identifier for the account that will receive the transfer.
+      # @param destination_account_id [String] The identifier for the destination Account that will receive the transfer.
       #
-      # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      # @param require_approval [Boolean] Whether the transfer should require explicit approval via the dashboard or API.
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -90,7 +90,7 @@ def list(params = {})
         )
       end
 
-      # Approve an Account Transfer
+      # Approves an Account Transfer in status `pending_approval`.
       #
       # @overload approve(account_transfer_id, request_options: {})
       #
@@ -110,7 +110,7 @@ def approve(account_transfer_id, params = {})
         )
       end
 
-      # Cancel an Account Transfer
+      # Cancels an Account Transfer in status `pending_approval`.
       #
       # @overload cancel(account_transfer_id, request_options: {})
       #

lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.87.0"
+  VERSION = "1.88.0"
 end