increase 0.316.0 → 0.317.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.317.0 (2025-09-24)
+
+Full Changelog: [v0.316.0...v0.317.0](https://github.com/Increase/increase-node/compare/v0.316.0...v0.317.0)
+
+### Features
+
+* **api:** api update ([2026a63](https://github.com/Increase/increase-node/commit/2026a637cb268b6278368a04a25e5148b2914e32))
+
 ## 0.316.0 (2025-09-23)
 
 Full Changelog: [v0.315.0...v0.316.0](https://github.com/Increase/increase-node/compare/v0.315.0...v0.316.0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "increase",
-  "version": "0.316.0",
+  "version": "0.317.0",
   "description": "The official TypeScript library for the Increase API",
   "author": "Increase <dev-feedback@increase.com>",
   "types": "./index.d.ts",

package/resources/account-transfers.d.ts

@@ -43,7 +43,7 @@ export declare class AccountTransfers extends APIResource {
     list(query?: AccountTransferListParams, options?: Core.RequestOptions): Core.PagePromise<AccountTransfersPage, AccountTransfer>;
     list(options?: Core.RequestOptions): Core.PagePromise<AccountTransfersPage, AccountTransfer>;
     /**
-     * Approve an Account Transfer
+     * Approves an Account Transfer in status `pending_approval`.
      *
      * @example
      * ```ts
@@ -55,7 +55,7 @@ export declare class AccountTransfers extends APIResource {
      */
     approve(accountTransferId: string, options?: Core.RequestOptions): Core.APIPromise<AccountTransfer>;
     /**
-     * Cancel an Account Transfer
+     * Cancels an Account Transfer in status `pending_approval`.
      *
      * @example
      * ```ts
@@ -70,20 +70,25 @@ export declare class AccountTransfers extends APIResource {
 export declare class AccountTransfersPage extends Page<AccountTransfer> {
 }
 /**
- * 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).
  */
 export interface AccountTransfer {
     /**
-     * The account transfer's identifier.
+     * The Account Transfer's identifier.
      */
     id: string;
     /**
-     * The Account to which the transfer belongs.
+     * The Account from which the transfer originated.
      */
     account_id: string;
     /**
-     * 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.
      */
     amount: number;
     /**
@@ -106,8 +111,8 @@ export interface AccountTransfer {
      */
     created_by: AccountTransfer.CreatedBy | null;
     /**
-     * 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)
@@ -118,15 +123,17 @@ export interface AccountTransfer {
      */
     currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
     /**
-     * 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.
      */
     description: string;
     /**
-     * The destination account's identifier.
+     * The destination Account's identifier.
      */
     destination_account_id: string;
     /**
-     * The ID for the transaction receiving the transfer.
+     * The identifier of the Transaction on the destination Account representing the
+     * received funds.
      */
     destination_transaction_id: string | null;
     /**
@@ -135,10 +142,6 @@ export interface AccountTransfer {
      * about [idempotency](https://increase.com/documentation/idempotency-keys).
      */
     idempotency_key: string | null;
-    /**
-     * The transfer's network.
-     */
-    network: 'account';
     /**
      * The ID for the pending transaction representing the transfer. A pending
      * transaction is created when the transfer
@@ -149,13 +152,15 @@ export interface AccountTransfer {
     /**
      * 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.
      */
     status: 'pending_approval' | 'canceled' | 'complete';
     /**
-     * The ID for the transaction funding the transfer.
+     * The identifier of the Transaction on the originating account representing the
+     * transferred funds.
      */
     transaction_id: string | null;
     /**
@@ -256,7 +261,7 @@ export declare namespace AccountTransfer {
 }
 export interface AccountTransferCreateParams {
     /**
-     * The identifier for the account that will send the transfer.
+     * The identifier for the originating Account that will send the transfer.
      */
     account_id: string;
     /**
@@ -265,15 +270,18 @@ export interface AccountTransferCreateParams {
      */
     amount: number;
     /**
-     * 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.
      */
     description: string;
     /**
-     * The identifier for the account that will receive the transfer.
+     * The identifier for the destination Account that will receive the transfer.
      */
     destination_account_id: string;
     /**
-     * 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).
      */
     require_approval?: boolean;
 }

package/resources/account-transfers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"account-transfers.d.ts","sourceRoot":"","sources":["../src/resources/account-transfers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAI1G;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAIpG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,eAAe,CAAC;IAC1D,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,eAAe,CAAC;IAW5F;;;;;;;;;;OAUG;IACH,OAAO,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAInG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;CAGnG;AAED,qBAAa,oBAAqB,SAAQ,IAAI,CAAC,eAAe,CAAC;CAAG;AAElE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,eAAe,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,YAAY,EAAE,eAAe,CAAC,YAAY,GAAG,IAAI,CAAC;IAElD;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,eAAe,CAAC,SAAS,GAAG,IAAI,CAAC;IAE7C;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAExD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC;IAEnB;;;;;OAKG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;;;;OAMG;IACH,MAAM,EAAE,kBAAkB,GAAG,UAAU,GAAG,UAAU,CAAC;IAErD;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,yBAAiB,eAAe,CAAC;IAC/B;;;OAGG;IACH,UAAiB,QAAQ;QACvB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,OAAO,EAAE,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC;QAEjC;;;;;;;;WAQG;QACH,QAAQ,EAAE,SAAS,GAAG,mBAAmB,GAAG,MAAM,CAAC;QAEnD;;WAEG;QACH,iBAAiB,EAAE,SAAS,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAErD;;WAEG;QACH,IAAI,EAAE,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC;KAC7B;IAED,UAAiB,SAAS,CAAC;QACzB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED;;WAEG;QACH,UAAiB,gBAAgB;YAC/B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,yBAA0B,SAAQ,UAAU;IAC3D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,yBAAyB,CAAC,SAAS,CAAC;IAEjD;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,oBAAoB,IAAI,oBAAoB,EAC5C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"account-transfers.d.ts","sourceRoot":"","sources":["../src/resources/account-transfers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAI1G;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAIpG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,eAAe,CAAC;IAC1D,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,eAAe,CAAC;IAW5F;;;;;;;;;;OAUG;IACH,OAAO,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAInG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;CAGnG;AAED,qBAAa,oBAAqB,SAAQ,IAAI,CAAC,eAAe,CAAC;CAAG;AAElE;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,eAAe,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,YAAY,EAAE,eAAe,CAAC,YAAY,GAAG,IAAI,CAAC;IAElD;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,eAAe,CAAC,SAAS,GAAG,IAAI,CAAC;IAE7C;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAExD;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;;OAKG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;;;;;OAOG;IACH,MAAM,EAAE,kBAAkB,GAAG,UAAU,GAAG,UAAU,CAAC;IAErD;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,yBAAiB,eAAe,CAAC;IAC/B;;;OAGG;IACH,UAAiB,QAAQ;QACvB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,OAAO,EAAE,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC;QAEjC;;;;;;;;WAQG;QACH,QAAQ,EAAE,SAAS,GAAG,mBAAmB,GAAG,MAAM,CAAC;QAEnD;;WAEG;QACH,iBAAiB,EAAE,SAAS,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAErD;;WAEG;QACH,IAAI,EAAE,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC;KAC7B;IAED,UAAiB,SAAS,CAAC;QACzB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED;;WAEG;QACH,UAAiB,gBAAgB;YAC/B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,yBAA0B,SAAQ,UAAU;IAC3D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,yBAAyB,CAAC,SAAS,CAAC;IAEjD;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,oBAAoB,IAAI,oBAAoB,EAC5C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/account-transfers.js

@@ -44,7 +44,7 @@ class AccountTransfers extends resource_1.APIResource {
         return this._client.getAPIList('/account_transfers', AccountTransfersPage, { query, ...options });
     }
     /**
-     * Approve an Account Transfer
+     * Approves an Account Transfer in status `pending_approval`.
      *
      * @example
      * ```ts
@@ -58,7 +58,7 @@ class AccountTransfers extends resource_1.APIResource {
         return this._client.post(`/account_transfers/${accountTransferId}/approve`, options);
     }
     /**
-     * Cancel an Account Transfer
+     * Cancels an Account Transfer in status `pending_approval`.
      *
      * @example
      * ```ts

package/resources/account-transfers.js.map

@@ -1 +1 @@
-{"version":3,"file":"account-transfers.js","sourceRoot":"","sources":["../src/resources/account-transfers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAiC,EAAE,OAA6B;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,iBAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,iBAAiB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAkBD,IAAI,CACF,QAAyD,EAAE,EAC3D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,iBAAyB,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,iBAAiB,UAAU,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,iBAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,iBAAiB,SAAS,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;CACF;AAzFD,4CAyFC;AAED,MAAa,oBAAqB,SAAQ,iBAAqB;CAAG;AAAlE,oDAAkE;AAgSlE,gBAAgB,CAAC,oBAAoB,GAAG,oBAAoB,CAAC"}
+{"version":3,"file":"account-transfers.js","sourceRoot":"","sources":["../src/resources/account-transfers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAiC,EAAE,OAA6B;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,iBAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,iBAAiB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAkBD,IAAI,CACF,QAAyD,EAAE,EAC3D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,iBAAyB,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,iBAAiB,UAAU,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,iBAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,iBAAiB,SAAS,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;CACF;AAzFD,4CAyFC;AAED,MAAa,oBAAqB,SAAQ,iBAAqB;CAAG;AAAlE,oDAAkE;AAuSlE,gBAAgB,CAAC,oBAAoB,GAAG,oBAAoB,CAAC"}

package/resources/account-transfers.mjs

@@ -41,7 +41,7 @@ export class AccountTransfers extends APIResource {
         return this._client.getAPIList('/account_transfers', AccountTransfersPage, { query, ...options });
     }
     /**
-     * Approve an Account Transfer
+     * Approves an Account Transfer in status `pending_approval`.
      *
      * @example
      * ```ts
@@ -55,7 +55,7 @@ export class AccountTransfers extends APIResource {
         return this._client.post(`/account_transfers/${accountTransferId}/approve`, options);
     }
     /**
-     * Cancel an Account Transfer
+     * Cancels an Account Transfer in status `pending_approval`.
      *
      * @example
      * ```ts

package/resources/account-transfers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"account-transfers.mjs","sourceRoot":"","sources":["../src/resources/account-transfers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAiC,EAAE,OAA6B;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,iBAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,iBAAiB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAkBD,IAAI,CACF,QAAyD,EAAE,EAC3D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,iBAAyB,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,iBAAiB,UAAU,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,iBAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,iBAAiB,SAAS,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,IAAqB;CAAG;AAgSlE,gBAAgB,CAAC,oBAAoB,GAAG,oBAAoB,CAAC"}
+{"version":3,"file":"account-transfers.mjs","sourceRoot":"","sources":["../src/resources/account-transfers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAiC,EAAE,OAA6B;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,iBAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,iBAAiB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAkBD,IAAI,CACF,QAAyD,EAAE,EAC3D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,iBAAyB,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,iBAAiB,UAAU,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,iBAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,iBAAiB,SAAS,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,IAAqB;CAAG;AAuSlE,gBAAgB,CAAC,oBAAoB,GAAG,oBAAoB,CAAC"}

package/src/resources/account-transfers.ts

@@ -66,7 +66,7 @@ export class AccountTransfers extends APIResource {
   }
 
   /**
-   * Approve an Account Transfer
+   * Approves an Account Transfer in status `pending_approval`.
    *
    * @example
    * ```ts
@@ -81,7 +81,7 @@ export class AccountTransfers extends APIResource {
   }
 
   /**
-   * Cancel an Account Transfer
+   * Cancels an Account Transfer in status `pending_approval`.
    *
    * @example
    * ```ts
@@ -99,22 +99,27 @@ export class AccountTransfers extends APIResource {
 export class AccountTransfersPage extends Page<AccountTransfer> {}
 
 /**
- * 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).
  */
 export interface AccountTransfer {
   /**
-   * The account transfer's identifier.
+   * The Account Transfer's identifier.
    */
   id: string;
 
   /**
-   * The Account to which the transfer belongs.
+   * The Account from which the transfer originated.
    */
   account_id: string;
 
   /**
-   * 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.
    */
   amount: number;
 
@@ -142,8 +147,8 @@ export interface AccountTransfer {
   created_by: AccountTransfer.CreatedBy | null;
 
   /**
-   * 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)
@@ -155,17 +160,19 @@ export interface AccountTransfer {
   currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
   /**
-   * 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.
    */
   description: string;
 
   /**
-   * The destination account's identifier.
+   * The destination Account's identifier.
    */
   destination_account_id: string;
 
   /**
-   * The ID for the transaction receiving the transfer.
+   * The identifier of the Transaction on the destination Account representing the
+   * received funds.
    */
   destination_transaction_id: string | null;
 
@@ -176,11 +183,6 @@ export interface AccountTransfer {
    */
   idempotency_key: string | null;
 
-  /**
-   * The transfer's network.
-   */
-  network: 'account';
-
   /**
    * The ID for the pending transaction representing the transfer. A pending
    * transaction is created when the transfer
@@ -192,14 +194,16 @@ export interface AccountTransfer {
   /**
    * 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.
    */
   status: 'pending_approval' | 'canceled' | 'complete';
 
   /**
-   * The ID for the transaction funding the transfer.
+   * The identifier of the Transaction on the originating account representing the
+   * transferred funds.
    */
   transaction_id: string | null;
 
@@ -313,7 +317,7 @@ export namespace AccountTransfer {
 
 export interface AccountTransferCreateParams {
   /**
-   * The identifier for the account that will send the transfer.
+   * The identifier for the originating Account that will send the transfer.
    */
   account_id: string;
 
@@ -324,17 +328,20 @@ export interface AccountTransferCreateParams {
   amount: number;
 
   /**
-   * 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.
    */
   description: string;
 
   /**
-   * The identifier for the account that will receive the transfer.
+   * The identifier for the destination Account that will receive the transfer.
    */
   destination_account_id: string;
 
   /**
-   * 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).
    */
   require_approval?: boolean;
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.316.0'; // x-release-please-version
+export const VERSION = '0.317.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.316.0";
+export declare const VERSION = "0.317.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.316.0'; // x-release-please-version
+exports.VERSION = '0.317.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.316.0'; // x-release-please-version
+export const VERSION = '0.317.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map