increase 0.210.0 → 0.212.0

package/src/resources/exports.ts

@@ -8,6 +8,13 @@ import { Page, type PageParams } from '../pagination';
 export class Exports extends APIResource {
   /**
    * Create an Export
+   *
+   * @example
+   * ```ts
+   * const _export = await client.exports.create({
+   *   category: 'transaction_csv',
+   * });
+   * ```
    */
   create(body: ExportCreateParams, options?: Core.RequestOptions): Core.APIPromise<Export> {
     return this._client.post('/exports', { body, ...options });
@@ -15,6 +22,13 @@ export class Exports extends APIResource {
 
   /**
    * Retrieve an Export
+   *
+   * @example
+   * ```ts
+   * const _export = await client.exports.retrieve(
+   *   'export_8s4m48qz3bclzje0zwh9',
+   * );
+   * ```
    */
   retrieve(exportId: string, options?: Core.RequestOptions): Core.APIPromise<Export> {
     return this._client.get(`/exports/${exportId}`, options);
@@ -22,6 +36,14 @@ export class Exports extends APIResource {
 
   /**
    * List Exports
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const _export of client.exports.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(query?: ExportListParams, options?: Core.RequestOptions): Core.PagePromise<ExportsPage, Export>;
   list(options?: Core.RequestOptions): Core.PagePromise<ExportsPage, Export>;

package/src/resources/external-accounts.ts

@@ -8,6 +8,16 @@ import { Page, type PageParams } from '../pagination';
 export class ExternalAccounts extends APIResource {
   /**
    * Create an External Account
+   *
+   * @example
+   * ```ts
+   * const externalAccount =
+   *   await client.externalAccounts.create({
+   *     account_number: '987654321',
+   *     description: 'Landlord',
+   *     routing_number: '101050001',
+   *   });
+   * ```
    */
   create(body: ExternalAccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount> {
     return this._client.post('/external_accounts', { body, ...options });
@@ -15,6 +25,14 @@ export class ExternalAccounts extends APIResource {
 
   /**
    * Retrieve an External Account
+   *
+   * @example
+   * ```ts
+   * const externalAccount =
+   *   await client.externalAccounts.retrieve(
+   *     'external_account_ukk55lr923a3ac0pp7iv',
+   *   );
+   * ```
    */
   retrieve(externalAccountId: string, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount> {
     return this._client.get(`/external_accounts/${externalAccountId}`, options);
@@ -22,6 +40,14 @@ export class ExternalAccounts extends APIResource {
 
   /**
    * Update an External Account
+   *
+   * @example
+   * ```ts
+   * const externalAccount =
+   *   await client.externalAccounts.update(
+   *     'external_account_ukk55lr923a3ac0pp7iv',
+   *   );
+   * ```
    */
   update(
     externalAccountId: string,
@@ -33,6 +59,14 @@ export class ExternalAccounts extends APIResource {
 
   /**
    * List External Accounts
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const externalAccount of client.externalAccounts.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: ExternalAccountListParams,

package/src/resources/file-links.ts

@@ -6,6 +6,13 @@ import * as Core from '../core';
 export class FileLinks extends APIResource {
   /**
    * Create a File Link
+   *
+   * @example
+   * ```ts
+   * const fileLink = await client.fileLinks.create({
+   *   file_id: 'file_makxrc67oh9l6sg7w9yc',
+   * });
+   * ```
    */
   create(body: FileLinkCreateParams, options?: Core.RequestOptions): Core.APIPromise<FileLink> {
     return this._client.post('/file_links', { body, ...options });

package/src/resources/files.ts

@@ -10,6 +10,14 @@ export class Files extends APIResource {
    * To upload a file to Increase, you'll need to send a request of Content-Type
    * `multipart/form-data`. The request should contain the file you would like to
    * upload, as well as the parameters for creating a file.
+   *
+   * @example
+   * ```ts
+   * const file = await client.files.create({
+   *   file: fs.createReadStream('path/to/file'),
+   *   purpose: 'check_image_front',
+   * });
+   * ```
    */
   create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<File> {
     return this._client.post('/files', Core.multipartFormRequestOptions({ body, ...options }));
@@ -17,6 +25,13 @@ export class Files extends APIResource {
 
   /**
    * Retrieve a File
+   *
+   * @example
+   * ```ts
+   * const file = await client.files.retrieve(
+   *   'file_makxrc67oh9l6sg7w9yc',
+   * );
+   * ```
    */
   retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<File> {
     return this._client.get(`/files/${fileId}`, options);
@@ -24,6 +39,14 @@ export class Files extends APIResource {
 
   /**
    * List Files
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const file of client.files.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<FilesPage, File>;
   list(options?: Core.RequestOptions): Core.PagePromise<FilesPage, File>;

package/src/resources/groups.ts

@@ -6,6 +6,11 @@ import * as Core from '../core';
 export class Groups extends APIResource {
   /**
    * Returns details for the currently authenticated Group.
+   *
+   * @example
+   * ```ts
+   * const group = await client.groups.retrieve();
+   * ```
    */
   retrieve(options?: Core.RequestOptions): Core.APIPromise<Group> {
     return this._client.get('/groups/current', options);

package/src/resources/inbound-ach-transfers.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class InboundACHTransfers extends APIResource {
   /**
    * Retrieve an Inbound ACH Transfer
+   *
+   * @example
+   * ```ts
+   * const inboundACHTransfer =
+   *   await client.inboundACHTransfers.retrieve(
+   *     'inbound_ach_transfer_tdrwqr3fq9gnnq49odev',
+   *   );
+   * ```
    */
   retrieve(inboundACHTransferId: string, options?: Core.RequestOptions): Core.APIPromise<InboundACHTransfer> {
     return this._client.get(`/inbound_ach_transfers/${inboundACHTransferId}`, options);
@@ -15,6 +23,14 @@ export class InboundACHTransfers extends APIResource {
 
   /**
    * List Inbound ACH Transfers
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const inboundACHTransfer of client.inboundACHTransfers.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: InboundACHTransferListParams,
@@ -33,6 +49,14 @@ export class InboundACHTransfers extends APIResource {
 
   /**
    * Create a notification of change for an Inbound ACH Transfer
+   *
+   * @example
+   * ```ts
+   * const inboundACHTransfer =
+   *   await client.inboundACHTransfers.createNotificationOfChange(
+   *     'inbound_ach_transfer_tdrwqr3fq9gnnq49odev',
+   *   );
+   * ```
    */
   createNotificationOfChange(
     inboundACHTransferId: string,
@@ -47,6 +71,14 @@ export class InboundACHTransfers extends APIResource {
 
   /**
    * Decline an Inbound ACH Transfer
+   *
+   * @example
+   * ```ts
+   * const inboundACHTransfer =
+   *   await client.inboundACHTransfers.decline(
+   *     'inbound_ach_transfer_tdrwqr3fq9gnnq49odev',
+   *   );
+   * ```
    */
   decline(
     inboundACHTransferId: string,
@@ -58,6 +90,15 @@ export class InboundACHTransfers extends APIResource {
 
   /**
    * Return an Inbound ACH Transfer
+   *
+   * @example
+   * ```ts
+   * const inboundACHTransfer =
+   *   await client.inboundACHTransfers.transferReturn(
+   *     'inbound_ach_transfer_tdrwqr3fq9gnnq49odev',
+   *     { reason: 'payment_stopped' },
+   *   );
+   * ```
    */
   transferReturn(
     inboundACHTransferId: string,

package/src/resources/inbound-check-deposits.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class InboundCheckDeposits extends APIResource {
   /**
    * Retrieve an Inbound Check Deposit
+   *
+   * @example
+   * ```ts
+   * const inboundCheckDeposit =
+   *   await client.inboundCheckDeposits.retrieve(
+   *     'inbound_check_deposit_zoshvqybq0cjjm31mra',
+   *   );
+   * ```
    */
   retrieve(
     inboundCheckDepositId: string,
@@ -18,6 +26,14 @@ export class InboundCheckDeposits extends APIResource {
 
   /**
    * List Inbound Check Deposits
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const inboundCheckDeposit of client.inboundCheckDeposits.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: InboundCheckDepositListParams,
@@ -39,6 +55,14 @@ export class InboundCheckDeposits extends APIResource {
 
   /**
    * Decline an Inbound Check Deposit
+   *
+   * @example
+   * ```ts
+   * const inboundCheckDeposit =
+   *   await client.inboundCheckDeposits.decline(
+   *     'inbound_check_deposit_zoshvqybq0cjjm31mra',
+   *   );
+   * ```
    */
   decline(
     inboundCheckDepositId: string,
@@ -49,6 +73,15 @@ export class InboundCheckDeposits extends APIResource {
 
   /**
    * Return an Inbound Check Deposit
+   *
+   * @example
+   * ```ts
+   * const inboundCheckDeposit =
+   *   await client.inboundCheckDeposits.return(
+   *     'inbound_check_deposit_zoshvqybq0cjjm31mra',
+   *     { reason: 'altered_or_fictitious' },
+   *   );
+   * ```
    */
   return(
     inboundCheckDepositId: string,

package/src/resources/inbound-mail-items.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class InboundMailItems extends APIResource {
   /**
    * Retrieve an Inbound Mail Item
+   *
+   * @example
+   * ```ts
+   * const inboundMailItem =
+   *   await client.inboundMailItems.retrieve(
+   *     'inbound_mail_item_q6rrg7mmqpplx80zceev',
+   *   );
+   * ```
    */
   retrieve(inboundMailItemId: string, options?: Core.RequestOptions): Core.APIPromise<InboundMailItem> {
     return this._client.get(`/inbound_mail_items/${inboundMailItemId}`, options);
@@ -15,6 +23,14 @@ export class InboundMailItems extends APIResource {
 
   /**
    * List Inbound Mail Items
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const inboundMailItem of client.inboundMailItems.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: InboundMailItemListParams,

package/src/resources/inbound-real-time-payments-transfers.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class InboundRealTimePaymentsTransfers extends APIResource {
   /**
    * Retrieve an Inbound Real-Time Payments Transfer
+   *
+   * @example
+   * ```ts
+   * const inboundRealTimePaymentsTransfer =
+   *   await client.inboundRealTimePaymentsTransfers.retrieve(
+   *     'inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr',
+   *   );
+   * ```
    */
   retrieve(
     inboundRealTimePaymentsTransferId: string,
@@ -21,6 +29,14 @@ export class InboundRealTimePaymentsTransfers extends APIResource {
 
   /**
    * List Inbound Real-Time Payments Transfers
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const inboundRealTimePaymentsTransfer of client.inboundRealTimePaymentsTransfers.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: InboundRealTimePaymentsTransferListParams,

package/src/resources/inbound-wire-drawdown-requests.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class InboundWireDrawdownRequests extends APIResource {
   /**
    * Retrieve an Inbound Wire Drawdown Request
+   *
+   * @example
+   * ```ts
+   * const inboundWireDrawdownRequest =
+   *   await client.inboundWireDrawdownRequests.retrieve(
+   *     'inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e',
+   *   );
+   * ```
    */
   retrieve(
     inboundWireDrawdownRequestId: string,
@@ -18,6 +26,14 @@ export class InboundWireDrawdownRequests extends APIResource {
 
   /**
    * List Inbound Wire Drawdown Requests
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const inboundWireDrawdownRequest of client.inboundWireDrawdownRequests.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: InboundWireDrawdownRequestListParams,

package/src/resources/inbound-wire-transfers.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class InboundWireTransfers extends APIResource {
   /**
    * Retrieve an Inbound Wire Transfer
+   *
+   * @example
+   * ```ts
+   * const inboundWireTransfer =
+   *   await client.inboundWireTransfers.retrieve(
+   *     'inbound_wire_transfer_f228m6bmhtcxjco9pwp0',
+   *   );
+   * ```
    */
   retrieve(
     inboundWireTransferId: string,
@@ -18,6 +26,14 @@ export class InboundWireTransfers extends APIResource {
 
   /**
    * List Inbound Wire Transfers
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const inboundWireTransfer of client.inboundWireTransfers.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: InboundWireTransferListParams,
@@ -39,6 +55,15 @@ export class InboundWireTransfers extends APIResource {
 
   /**
    * Reverse an Inbound Wire Transfer
+   *
+   * @example
+   * ```ts
+   * const inboundWireTransfer =
+   *   await client.inboundWireTransfers.reverse(
+   *     'inbound_wire_transfer_f228m6bmhtcxjco9pwp0',
+   *     { reason: 'creditor_request' },
+   *   );
+   * ```
    */
   reverse(
     inboundWireTransferId: string,

package/src/resources/intrafi-account-enrollments.ts

@@ -8,6 +8,15 @@ import { Page, type PageParams } from '../pagination';
 export class IntrafiAccountEnrollments extends APIResource {
   /**
    * Enroll an account in the IntraFi deposit sweep network
+   *
+   * @example
+   * ```ts
+   * const intrafiAccountEnrollment =
+   *   await client.intrafiAccountEnrollments.create({
+   *     account_id: 'account_in71c4amph0vgo2qllky',
+   *     email_address: 'user@example.com',
+   *   });
+   * ```
    */
   create(
     body: IntrafiAccountEnrollmentCreateParams,
@@ -18,6 +27,14 @@ export class IntrafiAccountEnrollments extends APIResource {
 
   /**
    * Get an IntraFi Account Enrollment
+   *
+   * @example
+   * ```ts
+   * const intrafiAccountEnrollment =
+   *   await client.intrafiAccountEnrollments.retrieve(
+   *     'intrafi_account_enrollment_w8l97znzreopkwf2tg75',
+   *   );
+   * ```
    */
   retrieve(
     intrafiAccountEnrollmentId: string,
@@ -28,6 +45,14 @@ export class IntrafiAccountEnrollments extends APIResource {
 
   /**
    * List IntraFi Account Enrollments
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const intrafiAccountEnrollment of client.intrafiAccountEnrollments.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: IntrafiAccountEnrollmentListParams,
@@ -51,6 +76,14 @@ export class IntrafiAccountEnrollments extends APIResource {
 
   /**
    * Unenroll an account from IntraFi
+   *
+   * @example
+   * ```ts
+   * const intrafiAccountEnrollment =
+   *   await client.intrafiAccountEnrollments.unenroll(
+   *     'intrafi_account_enrollment_w8l97znzreopkwf2tg75',
+   *   );
+   * ```
    */
   unenroll(
     intrafiAccountEnrollmentId: string,
@@ -65,11 +98,11 @@ export class IntrafiAccountEnrollmentsPage extends Page<IntrafiAccountEnrollment
 /**
  * IntraFi is a
  * [network of financial institutions](https://www.intrafi.com/network-banks) that
- * allows Increase users to sweep funds to multiple banks, in addition to
- * Increase's main bank partners. This enables accounts to become eligible for
- * additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi
- * Account Enrollment object represents the status of an account in the network.
- * Sweeping an account to IntraFi doesn't affect funds availability.
+ * allows Increase users to sweep funds to multiple banks. This enables accounts to
+ * become eligible for additional Federal Deposit Insurance Corporation (FDIC)
+ * insurance. An IntraFi Account Enrollment object represents the status of an
+ * account in the network. Sweeping an account to IntraFi doesn't affect funds
+ * availability.
  */
 export interface IntrafiAccountEnrollment {
   /**

package/src/resources/intrafi-balances.ts

@@ -5,7 +5,17 @@ import * as Core from '../core';
 
 export class IntrafiBalances extends APIResource {
   /**
-   * Get IntraFi balances by bank
+   * Returns the IntraFi balance for the given account. IntraFi may sweep funds to
+   * multiple banks. This endpoint will include both the total balance and the amount
+   * swept to each institution.
+   *
+   * @example
+   * ```ts
+   * const intrafiBalance =
+   *   await client.intrafiBalances.intrafiBalance(
+   *     'account_in71c4amph0vgo2qllky',
+   *   );
+   * ```
    */
   intrafiBalance(accountId: string, options?: Core.RequestOptions): Core.APIPromise<IntrafiBalance> {
     return this._client.get(`/accounts/${accountId}/intrafi_balance`, options);
@@ -14,8 +24,8 @@ export class IntrafiBalances extends APIResource {
 
 /**
  * When using IntraFi, each account's balance over the standard FDIC insurance
- * amount are swept to various other institutions. Funds are rebalanced across
- * banks as needed once per business day.
+ * amount is swept to various other institutions. Funds are rebalanced across banks
+ * as needed once per business day.
  */
 export interface IntrafiBalance {
   /**

package/src/resources/intrafi-exclusions.ts

@@ -8,6 +8,15 @@ import { Page, type PageParams } from '../pagination';
 export class IntrafiExclusions extends APIResource {
   /**
    * Create an IntraFi Exclusion
+   *
+   * @example
+   * ```ts
+   * const intrafiExclusion =
+   *   await client.intrafiExclusions.create({
+   *     bank_name: 'Example Bank',
+   *     entity_id: 'entity_n8y8tnk2p9339ti393yi',
+   *   });
+   * ```
    */
   create(
     body: IntrafiExclusionCreateParams,
@@ -18,6 +27,14 @@ export class IntrafiExclusions extends APIResource {
 
   /**
    * Get an IntraFi Exclusion
+   *
+   * @example
+   * ```ts
+   * const intrafiExclusion =
+   *   await client.intrafiExclusions.retrieve(
+   *     'account_in71c4amph0vgo2qllky',
+   *   );
+   * ```
    */
   retrieve(intrafiExclusionId: string, options?: Core.RequestOptions): Core.APIPromise<IntrafiExclusion> {
     return this._client.get(`/intrafi_exclusions/${intrafiExclusionId}`, options);
@@ -25,6 +42,14 @@ export class IntrafiExclusions extends APIResource {
 
   /**
    * List IntraFi Exclusions
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const intrafiExclusion of client.intrafiExclusions.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: IntrafiExclusionListParams,
@@ -43,6 +68,14 @@ export class IntrafiExclusions extends APIResource {
 
   /**
    * Archive an IntraFi Exclusion
+   *
+   * @example
+   * ```ts
+   * const intrafiExclusion =
+   *   await client.intrafiExclusions.archive(
+   *     'intrafi_exclusion_ygfqduuzpau3jqof6jyh',
+   *   );
+   * ```
    */
   archive(intrafiExclusionId: string, options?: Core.RequestOptions): Core.APIPromise<IntrafiExclusion> {
     return this._client.post(`/intrafi_exclusions/${intrafiExclusionId}/archive`, options);

package/src/resources/lockboxes.ts

@@ -8,6 +8,13 @@ import { Page, type PageParams } from '../pagination';
 export class Lockboxes extends APIResource {
   /**
    * Create a Lockbox
+   *
+   * @example
+   * ```ts
+   * const lockbox = await client.lockboxes.create({
+   *   account_id: 'account_in71c4amph0vgo2qllky',
+   * });
+   * ```
    */
   create(body: LockboxCreateParams, options?: Core.RequestOptions): Core.APIPromise<Lockbox> {
     return this._client.post('/lockboxes', { body, ...options });
@@ -15,6 +22,13 @@ export class Lockboxes extends APIResource {
 
   /**
    * Retrieve a Lockbox
+   *
+   * @example
+   * ```ts
+   * const lockbox = await client.lockboxes.retrieve(
+   *   'lockbox_3xt21ok13q19advds4t5',
+   * );
+   * ```
    */
   retrieve(lockboxId: string, options?: Core.RequestOptions): Core.APIPromise<Lockbox> {
     return this._client.get(`/lockboxes/${lockboxId}`, options);
@@ -22,6 +36,13 @@ export class Lockboxes extends APIResource {
 
   /**
    * Update a Lockbox
+   *
+   * @example
+   * ```ts
+   * const lockbox = await client.lockboxes.update(
+   *   'lockbox_3xt21ok13q19advds4t5',
+   * );
+   * ```
    */
   update(
     lockboxId: string,
@@ -33,6 +54,14 @@ export class Lockboxes extends APIResource {
 
   /**
    * List Lockboxes
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const lockbox of client.lockboxes.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(query?: LockboxListParams, options?: Core.RequestOptions): Core.PagePromise<LockboxesPage, Lockbox>;
   list(options?: Core.RequestOptions): Core.PagePromise<LockboxesPage, Lockbox>;