release: 0.338.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.337.0"
+  ".": "0.338.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
 
+## 0.338.0 (2025-09-24)
+
+Full Changelog: [v0.337.0...v0.338.0](https://github.com/Increase/increase-python/compare/v0.337.0...v0.338.0)
+
+### Features
+
+* **api:** api update ([29dcbeb](https://github.com/Increase/increase-python/commit/29dcbeb0dc87eaee5af6fa61fe7e7466efc11cab))
+
 ## 0.337.0 (2025-09-23)
 
 Full Changelog: [v0.336.0...v0.337.0](https://github.com/Increase/increase-python/compare/v0.336.0...v0.337.0)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "increase"
-version = "0.337.0"
+version = "0.338.0"
 description = "The official Python library for the increase API"
 dynamic = ["readme"]
 license = "Apache-2.0"

src/increase/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "increase"
-__version__ = "0.337.0"  # x-release-please-version
+__version__ = "0.338.0"  # x-release-please-version

src/increase/resources/account_transfers.py

@@ -62,16 +62,19 @@ def create(
         Create an Account Transfer
 
         Args:
-          account_id: The identifier for the account that will send the transfer.
+          account_id: The identifier for the originating Account that will send the transfer.
 
           amount: The transfer amount in the minor unit of the account currency. For dollars, for
               example, this is cents.
 
-          description: The description you choose to give the transfer.
+          description: 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.
 
-          destination_account_id: The identifier for the account that will receive the transfer.
+          destination_account_id: The identifier for the destination Account that will receive the transfer.
 
-          require_approval: Whether the transfer requires explicit approval via the dashboard or API.
+          require_approval: Whether the transfer should require explicit approval via the dashboard or API.
+              For more information, see
+              [Transfer Approvals](/documentation/transfer-approvals).
 
           extra_headers: Send extra headers
 
@@ -216,7 +219,7 @@ def approve(
         idempotency_key: str | None = None,
     ) -> AccountTransfer:
         """
-        Approve an Account Transfer
+        Approves an Account Transfer in status `pending_approval`.
 
         Args:
           account_transfer_id: The identifier of the Account Transfer to approve.
@@ -260,7 +263,7 @@ def cancel(
         idempotency_key: str | None = None,
     ) -> AccountTransfer:
         """
-        Cancel an Account Transfer
+        Cancels an Account Transfer in status `pending_approval`.
 
         Args:
           account_transfer_id: The identifier of the pending Account Transfer to cancel.
@@ -332,16 +335,19 @@ async def create(
         Create an Account Transfer
 
         Args:
-          account_id: The identifier for the account that will send the transfer.
+          account_id: The identifier for the originating Account that will send the transfer.
 
           amount: The transfer amount in the minor unit of the account currency. For dollars, for
               example, this is cents.
 
-          description: The description you choose to give the transfer.
+          description: 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.
 
-          destination_account_id: The identifier for the account that will receive the transfer.
+          destination_account_id: The identifier for the destination Account that will receive the transfer.
 
-          require_approval: Whether the transfer requires explicit approval via the dashboard or API.
+          require_approval: Whether the transfer should require explicit approval via the dashboard or API.
+              For more information, see
+              [Transfer Approvals](/documentation/transfer-approvals).
 
           extra_headers: Send extra headers
 
@@ -486,7 +492,7 @@ async def approve(
         idempotency_key: str | None = None,
     ) -> AccountTransfer:
         """
-        Approve an Account Transfer
+        Approves an Account Transfer in status `pending_approval`.
 
         Args:
           account_transfer_id: The identifier of the Account Transfer to approve.
@@ -530,7 +536,7 @@ async def cancel(
         idempotency_key: str | None = None,
     ) -> AccountTransfer:
         """
-        Cancel an Account Transfer
+        Cancels an Account Transfer in status `pending_approval`.
 
         Args:
           account_transfer_id: The identifier of the pending Account Transfer to cancel.

src/increase/types/account_transfer.py

@@ -83,15 +83,16 @@ class CreatedBy(BaseModel):
 
 class AccountTransfer(BaseModel):
     id: str
-    """The account transfer's identifier."""
+    """The Account Transfer's identifier."""
 
     account_id: str
-    """The Account to which the transfer belongs."""
+    """The Account from which the transfer originated."""
 
     amount: int
-    """The transfer amount in the minor unit of the destination account currency.
+    """The transfer amount in cents.
 
-    For dollars, for example, this is cents.
+    This will always be positive and indicates the amount of money leaving the
+    originating account.
     """
 
     approval: Optional[Approval] = None
@@ -117,8 +118,8 @@ class AccountTransfer(BaseModel):
 
     currency: Literal["CAD", "CHF", "EUR", "GBP", "JPY", "USD"]
     """
-    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.
 
     - `CAD` - Canadian Dollar (CAD)
     - `CHF` - Swiss Franc (CHF)
@@ -129,13 +130,19 @@ class AccountTransfer(BaseModel):
     """
 
     description: str
-    """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.
+    """
 
     destination_account_id: str
-    """The destination account's identifier."""
+    """The destination Account's identifier."""
 
     destination_transaction_id: Optional[str] = None
-    """The ID for the transaction receiving the transfer."""
+    """
+    The identifier of the Transaction on the destination Account representing the
+    received funds.
+    """
 
     idempotency_key: Optional[str] = None
     """The idempotency key you chose for this object.
@@ -145,9 +152,6 @@ class AccountTransfer(BaseModel):
     [idempotency](https://increase.com/documentation/idempotency-keys).
     """
 
-    network: Literal["account"]
-    """The transfer's network."""
-
     pending_transaction_id: Optional[str] = None
     """The ID for the pending transaction representing the transfer.
 
@@ -159,13 +163,17 @@ class AccountTransfer(BaseModel):
     status: Literal["pending_approval", "canceled", "complete"]
     """The lifecycle status of the transfer.
 
-    - `pending_approval` - The transfer is pending approval.
-    - `canceled` - The transfer has been canceled.
+    - `pending_approval` - The transfer is pending approval from your team.
+    - `canceled` - The transfer was pending approval from your team and has been
+      canceled.
     - `complete` - The transfer has been completed.
     """
 
     transaction_id: Optional[str] = None
-    """The ID for the transaction funding the transfer."""
+    """
+    The identifier of the Transaction on the originating account representing the
+    transferred funds.
+    """
 
     type: Literal["account_transfer"]
     """A constant representing the object's type.

src/increase/types/account_transfer_create_params.py

@@ -9,7 +9,7 @@
 
 class AccountTransferCreateParams(TypedDict, total=False):
     account_id: Required[str]
-    """The identifier for the account that will send the transfer."""
+    """The identifier for the originating Account that will send the transfer."""
 
     amount: Required[int]
     """The transfer amount in the minor unit of the account currency.
@@ -18,10 +18,17 @@ class AccountTransferCreateParams(TypedDict, total=False):
     """
 
     description: Required[str]
-    """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.
+    """
 
     destination_account_id: Required[str]
-    """The identifier for the account that will receive the transfer."""
+    """The identifier for the destination Account that will receive the transfer."""
 
     require_approval: bool
-    """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).
+    """