increase 0.211.0 → 0.213.0

package/src/resources/entities.ts

@@ -9,6 +9,13 @@ import { Page, type PageParams } from '../pagination';
 export class Entities extends APIResource {
   /**
    * Create an Entity
+   *
+   * @example
+   * ```ts
+   * const entity = await client.entities.create({
+   *   structure: 'corporation',
+   * });
+   * ```
    */
   create(body: EntityCreateParams, options?: Core.RequestOptions): Core.APIPromise<Entity> {
     return this._client.post('/entities', { body, ...options });
@@ -16,6 +23,13 @@ export class Entities extends APIResource {
 
   /**
    * Retrieve an Entity
+   *
+   * @example
+   * ```ts
+   * const entity = await client.entities.retrieve(
+   *   'entity_n8y8tnk2p9339ti393yi',
+   * );
+   * ```
    */
   retrieve(entityId: string, options?: Core.RequestOptions): Core.APIPromise<Entity> {
     return this._client.get(`/entities/${entityId}`, options);
@@ -23,6 +37,14 @@ export class Entities extends APIResource {
 
   /**
    * List Entities
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const entity of client.entities.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(query?: EntityListParams, options?: Core.RequestOptions): Core.PagePromise<EntitiesPage, Entity>;
   list(options?: Core.RequestOptions): Core.PagePromise<EntitiesPage, Entity>;
@@ -38,6 +60,13 @@ export class Entities extends APIResource {
 
   /**
    * Archive an Entity
+   *
+   * @example
+   * ```ts
+   * const entity = await client.entities.archive(
+   *   'entity_n8y8tnk2p9339ti393yi',
+   * );
+   * ```
    */
   archive(entityId: string, options?: Core.RequestOptions): Core.APIPromise<Entity> {
     return this._client.post(`/entities/${entityId}/archive`, options);
@@ -45,6 +74,17 @@ export class Entities extends APIResource {
 
   /**
    * Archive a beneficial owner for a corporate Entity
+   *
+   * @example
+   * ```ts
+   * const entity = await client.entities.archiveBeneficialOwner(
+   *   'entity_n8y8tnk2p9339ti393yi',
+   *   {
+   *     beneficial_owner_id:
+   *       'entity_setup_beneficial_owner_submission_vgkyk7dj5eb4sfhdbkx7',
+   *   },
+   * );
+   * ```
    */
   archiveBeneficialOwner(
     entityId: string,
@@ -58,6 +98,13 @@ export class Entities extends APIResource {
    * Depending on your program, you may be required to re-confirm an Entity's details
    * on a recurring basis. After making any required updates, call this endpoint to
    * record that your user confirmed their details.
+   *
+   * @example
+   * ```ts
+   * const entity = await client.entities.confirm(
+   *   'entity_n8y8tnk2p9339ti393yi',
+   * );
+   * ```
    */
   confirm(
     entityId: string,
@@ -69,6 +116,30 @@ export class Entities extends APIResource {
 
   /**
    * Create a beneficial owner for a corporate Entity
+   *
+   * @example
+   * ```ts
+   * const entity = await client.entities.createBeneficialOwner(
+   *   'entity_n8y8tnk2p9339ti393yi',
+   *   {
+   *     beneficial_owner: {
+   *       individual: {
+   *         address: {
+   *           country: 'US',
+   *           line1: '33 Liberty Street',
+   *         },
+   *         date_of_birth: '1970-01-31',
+   *         identification: {
+   *           method: 'social_security_number',
+   *           number: '078051120',
+   *         },
+   *         name: 'Ian Crease',
+   *       },
+   *       prongs: ['control'],
+   *     },
+   *   },
+   * );
+   * ```
    */
   createBeneficialOwner(
     entityId: string,
@@ -80,6 +151,21 @@ export class Entities extends APIResource {
 
   /**
    * Update a Natural Person or Corporation's address
+   *
+   * @example
+   * ```ts
+   * const entity = await client.entities.updateAddress(
+   *   'entity_n8y8tnk2p9339ti393yi',
+   *   {
+   *     address: {
+   *       city: 'New York',
+   *       line1: '33 Liberty Street',
+   *       state: 'NY',
+   *       zip: '10045',
+   *     },
+   *   },
+   * );
+   * ```
    */
   updateAddress(
     entityId: string,
@@ -91,6 +177,22 @@ export class Entities extends APIResource {
 
   /**
    * Update the address for a beneficial owner belonging to a corporate Entity
+   *
+   * @example
+   * ```ts
+   * const entity =
+   *   await client.entities.updateBeneficialOwnerAddress(
+   *     'entity_n8y8tnk2p9339ti393yi',
+   *     {
+   *       address: {
+   *         country: 'US',
+   *         line1: '33 Liberty Street',
+   *       },
+   *       beneficial_owner_id:
+   *         'entity_setup_beneficial_owner_submission_vgkyk7dj5eb4sfhdbkx7',
+   *     },
+   *   );
+   * ```
    */
   updateBeneficialOwnerAddress(
     entityId: string,
@@ -102,6 +204,14 @@ export class Entities extends APIResource {
 
   /**
    * Update the industry code for a corporate Entity
+   *
+   * @example
+   * ```ts
+   * const entity = await client.entities.updateIndustryCode(
+   *   'entity_n8y8tnk2p9339ti393yi',
+   *   { industry_code: '5132' },
+   * );
+   * ```
    */
   updateIndustryCode(
     entityId: string,

package/src/resources/event-subscriptions.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class EventSubscriptions extends APIResource {
   /**
    * Create an Event Subscription
+   *
+   * @example
+   * ```ts
+   * const eventSubscription =
+   *   await client.eventSubscriptions.create({
+   *     url: 'https://website.com/webhooks',
+   *   });
+   * ```
    */
   create(
     body: EventSubscriptionCreateParams,
@@ -18,6 +26,14 @@ export class EventSubscriptions extends APIResource {
 
   /**
    * Retrieve an Event Subscription
+   *
+   * @example
+   * ```ts
+   * const eventSubscription =
+   *   await client.eventSubscriptions.retrieve(
+   *     'event_subscription_001dzz0r20rcdxgb013zqb8m04g',
+   *   );
+   * ```
    */
   retrieve(eventSubscriptionId: string, options?: Core.RequestOptions): Core.APIPromise<EventSubscription> {
     return this._client.get(`/event_subscriptions/${eventSubscriptionId}`, options);
@@ -25,6 +41,14 @@ export class EventSubscriptions extends APIResource {
 
   /**
    * Update an Event Subscription
+   *
+   * @example
+   * ```ts
+   * const eventSubscription =
+   *   await client.eventSubscriptions.update(
+   *     'event_subscription_001dzz0r20rcdxgb013zqb8m04g',
+   *   );
+   * ```
    */
   update(
     eventSubscriptionId: string,
@@ -36,6 +60,14 @@ export class EventSubscriptions extends APIResource {
 
   /**
    * List Event Subscriptions
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const eventSubscription of client.eventSubscriptions.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: EventSubscriptionListParams,

package/src/resources/events.ts

@@ -8,6 +8,13 @@ import { Page, type PageParams } from '../pagination';
 export class Events extends APIResource {
   /**
    * Retrieve an Event
+   *
+   * @example
+   * ```ts
+   * const event = await client.events.retrieve(
+   *   'event_001dzz0r20rzr4zrhrr1364hy80',
+   * );
+   * ```
    */
   retrieve(eventId: string, options?: Core.RequestOptions): Core.APIPromise<Event> {
     return this._client.get(`/events/${eventId}`, options);
@@ -15,6 +22,14 @@ export class Events extends APIResource {
 
   /**
    * List Events
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const event of client.events.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(query?: EventListParams, options?: Core.RequestOptions): Core.PagePromise<EventsPage, Event>;
   list(options?: Core.RequestOptions): Core.PagePromise<EventsPage, Event>;

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,