increase 0.211.0 → 0.213.0

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,

package/src/resources/intrafi-balances.ts

@@ -8,6 +8,14 @@ export class IntrafiBalances extends APIResource {
    * 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);

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>;

package/src/resources/oauth-applications.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class OAuthApplications extends APIResource {
   /**
    * Retrieve an OAuth Application
+   *
+   * @example
+   * ```ts
+   * const oauthApplication =
+   *   await client.oauthApplications.retrieve(
+   *     'application_gj9ufmpgh5i56k4vyriy',
+   *   );
+   * ```
    */
   retrieve(oauthApplicationId: string, options?: Core.RequestOptions): Core.APIPromise<OAuthApplication> {
     return this._client.get(`/oauth_applications/${oauthApplicationId}`, options);
@@ -15,6 +23,14 @@ export class OAuthApplications extends APIResource {
 
   /**
    * List OAuth Applications
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const oauthApplication of client.oauthApplications.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: OAuthApplicationListParams,

package/src/resources/oauth-connections.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class OAuthConnections extends APIResource {
   /**
    * Retrieve an OAuth Connection
+   *
+   * @example
+   * ```ts
+   * const oauthConnection =
+   *   await client.oauthConnections.retrieve(
+   *     'connection_dauknoksyr4wilz4e6my',
+   *   );
+   * ```
    */
   retrieve(oauthConnectionId: string, options?: Core.RequestOptions): Core.APIPromise<OAuthConnection> {
     return this._client.get(`/oauth_connections/${oauthConnectionId}`, options);
@@ -15,6 +23,14 @@ export class OAuthConnections extends APIResource {
 
   /**
    * List OAuth Connections
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const oauthConnection of client.oauthConnections.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: OAuthConnectionListParams,

package/src/resources/oauth-tokens.ts

@@ -6,6 +6,13 @@ import * as Core from '../core';
 export class OAuthTokens extends APIResource {
   /**
    * Create an OAuth Token
+   *
+   * @example
+   * ```ts
+   * const oauthToken = await client.oauthTokens.create({
+   *   grant_type: 'authorization_code',
+   * });
+   * ```
    */
   create(body: OAuthTokenCreateParams, options?: Core.RequestOptions): Core.APIPromise<OAuthToken> {
     return this._client.post('/oauth/tokens', { body, ...options });

package/src/resources/pending-transactions.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class PendingTransactions extends APIResource {
   /**
    * Retrieve a Pending Transaction
+   *
+   * @example
+   * ```ts
+   * const pendingTransaction =
+   *   await client.pendingTransactions.retrieve(
+   *     'pending_transaction_k1sfetcau2qbvjbzgju4',
+   *   );
+   * ```
    */
   retrieve(pendingTransactionId: string, options?: Core.RequestOptions): Core.APIPromise<PendingTransaction> {
     return this._client.get(`/pending_transactions/${pendingTransactionId}`, options);
@@ -15,6 +23,14 @@ export class PendingTransactions extends APIResource {
 
   /**
    * List Pending Transactions
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const pendingTransaction of client.pendingTransactions.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: PendingTransactionListParams,

package/src/resources/physical-card-profiles.ts

@@ -8,6 +8,18 @@ import { Page, type PageParams } from '../pagination';
 export class PhysicalCardProfiles extends APIResource {
   /**
    * Create a Physical Card Profile
+   *
+   * @example
+   * ```ts
+   * const physicalCardProfile =
+   *   await client.physicalCardProfiles.create({
+   *     carrier_image_file_id: 'file_h6v7mtipe119os47ehlu',
+   *     contact_phone: '+16505046304',
+   *     description: 'My Card Profile',
+   *     front_image_file_id: 'file_o6aex13wm1jcc36sgcj1',
+   *     program_id: 'program_i2v2os4mwza1oetokh9i',
+   *   });
+   * ```
    */
   create(
     body: PhysicalCardProfileCreateParams,
@@ -18,6 +30,14 @@ export class PhysicalCardProfiles extends APIResource {
 
   /**
    * Retrieve a Card Profile
+   *
+   * @example
+   * ```ts
+   * const physicalCardProfile =
+   *   await client.physicalCardProfiles.retrieve(
+   *     'physical_card_profile_m534d5rn9qyy9ufqxoec',
+   *   );
+   * ```
    */
   retrieve(
     physicalCardProfileId: string,
@@ -28,6 +48,14 @@ export class PhysicalCardProfiles extends APIResource {
 
   /**
    * List Physical Card Profiles
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const physicalCardProfile of client.physicalCardProfiles.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: PhysicalCardProfileListParams,
@@ -49,6 +77,14 @@ export class PhysicalCardProfiles extends APIResource {
 
   /**
    * Archive a Physical Card Profile
+   *
+   * @example
+   * ```ts
+   * const physicalCardProfile =
+   *   await client.physicalCardProfiles.archive(
+   *     'physical_card_profile_m534d5rn9qyy9ufqxoec',
+   *   );
+   * ```
    */
   archive(
     physicalCardProfileId: string,
@@ -59,6 +95,14 @@ export class PhysicalCardProfiles extends APIResource {
 
   /**
    * Clone a Physical Card Profile
+   *
+   * @example
+   * ```ts
+   * const physicalCardProfile =
+   *   await client.physicalCardProfiles.clone(
+   *     'physical_card_profile_m534d5rn9qyy9ufqxoec',
+   *   );
+   * ```
    */
   clone(
     physicalCardProfileId: string,

package/src/resources/physical-cards.ts

@@ -8,6 +8,24 @@ import { Page, type PageParams } from '../pagination';
 export class PhysicalCards extends APIResource {
   /**
    * Create a Physical Card
+   *
+   * @example
+   * ```ts
+   * const physicalCard = await client.physicalCards.create({
+   *   card_id: 'card_oubs0hwk5rn6knuecxg2',
+   *   cardholder: { first_name: 'Ian', last_name: 'Crease' },
+   *   shipment: {
+   *     address: {
+   *       city: 'New York',
+   *       line1: '33 Liberty Street',
+   *       name: 'Ian Crease',
+   *       postal_code: '10045',
+   *       state: 'NY',
+   *     },
+   *     method: 'usps',
+   *   },
+   * });
+   * ```
    */
   create(body: PhysicalCardCreateParams, options?: Core.RequestOptions): Core.APIPromise<PhysicalCard> {
     return this._client.post('/physical_cards', { body, ...options });
@@ -15,6 +33,13 @@ export class PhysicalCards extends APIResource {
 
   /**
    * Retrieve a Physical Card
+   *
+   * @example
+   * ```ts
+   * const physicalCard = await client.physicalCards.retrieve(
+   *   'physical_card_ode8duyq5v2ynhjoharl',
+   * );
+   * ```
    */
   retrieve(physicalCardId: string, options?: Core.RequestOptions): Core.APIPromise<PhysicalCard> {
     return this._client.get(`/physical_cards/${physicalCardId}`, options);
@@ -22,6 +47,14 @@ export class PhysicalCards extends APIResource {
 
   /**
    * Update a Physical Card
+   *
+   * @example
+   * ```ts
+   * const physicalCard = await client.physicalCards.update(
+   *   'physical_card_ode8duyq5v2ynhjoharl',
+   *   { status: 'disabled' },
+   * );
+   * ```
    */
   update(
     physicalCardId: string,
@@ -33,6 +66,14 @@ export class PhysicalCards extends APIResource {
 
   /**
    * List Physical Cards
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const physicalCard of client.physicalCards.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: PhysicalCardListParams,
@@ -246,6 +287,12 @@ export namespace PhysicalCard {
 
     export namespace Tracking {
       export interface Update {
+        /**
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
+         * carrier expects the card to be delivered.
+         */
+        carrier_estimated_delivery_at: string | null;
+
         /**
          * The type of tracking event.
          *

package/src/resources/programs.ts

@@ -8,6 +8,13 @@ import { Page, type PageParams } from '../pagination';
 export class Programs extends APIResource {
   /**
    * Retrieve a Program
+   *
+   * @example
+   * ```ts
+   * const program = await client.programs.retrieve(
+   *   'program_i2v2os4mwza1oetokh9i',
+   * );
+   * ```
    */
   retrieve(programId: string, options?: Core.RequestOptions): Core.APIPromise<Program> {
     return this._client.get(`/programs/${programId}`, options);
@@ -15,6 +22,14 @@ export class Programs extends APIResource {
 
   /**
    * List Programs
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const program of client.programs.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(query?: ProgramListParams, options?: Core.RequestOptions): Core.PagePromise<ProgramsPage, Program>;
   list(options?: Core.RequestOptions): Core.PagePromise<ProgramsPage, Program>;

package/src/resources/real-time-decisions.ts

@@ -6,6 +6,14 @@ import * as Core from '../core';
 export class RealTimeDecisions extends APIResource {
   /**
    * Retrieve a Real-Time Decision
+   *
+   * @example
+   * ```ts
+   * const realTimeDecision =
+   *   await client.realTimeDecisions.retrieve(
+   *     'real_time_decision_j76n2e810ezcg3zh5qtn',
+   *   );
+   * ```
    */
   retrieve(realTimeDecisionId: string, options?: Core.RequestOptions): Core.APIPromise<RealTimeDecision> {
     return this._client.get(`/real_time_decisions/${realTimeDecisionId}`, options);
@@ -13,6 +21,14 @@ export class RealTimeDecisions extends APIResource {
 
   /**
    * Action a Real-Time Decision
+   *
+   * @example
+   * ```ts
+   * const realTimeDecision =
+   *   await client.realTimeDecisions.action(
+   *     'real_time_decision_j76n2e810ezcg3zh5qtn',
+   *   );
+   * ```
    */
   action(
     realTimeDecisionId: string,

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

@@ -8,6 +8,18 @@ import { Page, type PageParams } from '../pagination';
 export class RealTimePaymentsTransfers extends APIResource {
   /**
    * Create a Real-Time Payments Transfer
+   *
+   * @example
+   * ```ts
+   * const realTimePaymentsTransfer =
+   *   await client.realTimePaymentsTransfers.create({
+   *     amount: 100,
+   *     creditor_name: 'Ian Crease',
+   *     remittance_information: 'Invoice 29582',
+   *     source_account_number_id:
+   *       'account_number_v18nkfqm6afpsrvy82b2',
+   *   });
+   * ```
    */
   create(
     body: RealTimePaymentsTransferCreateParams,
@@ -18,6 +30,14 @@ export class RealTimePaymentsTransfers extends APIResource {
 
   /**
    * Retrieve a Real-Time Payments Transfer
+   *
+   * @example
+   * ```ts
+   * const realTimePaymentsTransfer =
+   *   await client.realTimePaymentsTransfers.retrieve(
+   *     'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq',
+   *   );
+   * ```
    */
   retrieve(
     realTimePaymentsTransferId: string,
@@ -28,6 +48,14 @@ export class RealTimePaymentsTransfers extends APIResource {
 
   /**
    * List Real-Time Payments Transfers
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const realTimePaymentsTransfer of client.realTimePaymentsTransfers.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: RealTimePaymentsTransferListParams,

package/src/resources/routing-numbers.ts

@@ -10,6 +10,16 @@ export class RoutingNumbers extends APIResource {
    * user is providing you with bank account details. Since routing numbers uniquely
    * identify a bank, this will always return 0 or 1 entry. In Sandbox, the only
    * valid routing number for this method is 110000000.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const routingNumberListResponse of client.routingNumbers.list(
+   *   { routing_number: 'xxxxxxxxx' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: RoutingNumberListParams,

package/src/resources/simulations/account-statements.ts

@@ -8,6 +8,14 @@ export class AccountStatements extends APIResource {
   /**
    * Simulates an [Account Statement](#account-statements) being created for an
    * account. In production, Account Statements are generated once per month.
+   *
+   * @example
+   * ```ts
+   * const accountStatement =
+   *   await client.simulations.accountStatements.create({
+   *     account_id: 'account_in71c4amph0vgo2qllky',
+   *   });
+   * ```
    */
   create(
     body: AccountStatementCreateParams,

package/src/resources/simulations/account-transfers.ts

@@ -10,6 +10,14 @@ export class AccountTransfers extends APIResource {
    * endpoint simulates the approval of an [Account Transfer](#account-transfers).
    * You can also approve sandbox Account Transfers in the dashboard. This transfer
    * must first have a `status` of `pending_approval`.
+   *
+   * @example
+   * ```ts
+   * const accountTransfer =
+   *   await client.simulations.accountTransfers.complete(
+   *     'account_transfer_7k9qe1ysdgqztnt63l7n',
+   *   );
+   * ```
    */
   complete(
     accountTransferId: string,