increase 0.210.0 → 0.212.0

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,

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

@@ -12,6 +12,14 @@ export class ACHTransfers extends APIResource {
    * within 30 minutes. Since sandbox ACH Transfers are not submitted to the Federal
    * Reserve, this endpoint allows you to skip that delay and add the acknowledgment
    * subresource to the ACH Transfer.
+   *
+   * @example
+   * ```ts
+   * const achTransfer =
+   *   await client.simulations.achTransfers.acknowledge(
+   *     'ach_transfer_uoxatyh3lt5evrsdvo7q',
+   *   );
+   * ```
    */
   acknowledge(
     achTransferId: string,
@@ -23,6 +31,18 @@ export class ACHTransfers extends APIResource {
   /**
    * Simulates receiving a Notification of Change for an
    * [ACH Transfer](#ach-transfers).
+   *
+   * @example
+   * ```ts
+   * const achTransfer =
+   *   await client.simulations.achTransfers.createNotificationOfChange(
+   *     'ach_transfer_uoxatyh3lt5evrsdvo7q',
+   *     {
+   *       change_code: 'incorrect_routing_number',
+   *       corrected_data: '123456789',
+   *     },
+   *   );
+   * ```
    */
   createNotificationOfChange(
     achTransferId: string,
@@ -39,6 +59,14 @@ export class ACHTransfers extends APIResource {
    * Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve
    * due to an error condition. This will also create a Transaction to account for
    * the returned funds. This transfer must first have a `status` of `submitted`.
+   *
+   * @example
+   * ```ts
+   * const achTransfer =
+   *   await client.simulations.achTransfers.return(
+   *     'ach_transfer_uoxatyh3lt5evrsdvo7q',
+   *   );
+   * ```
    */
   return(
     achTransferId: string,
@@ -55,6 +83,14 @@ export class ACHTransfers extends APIResource {
    * `pending_submission`, the simulation will also submit the transfer. Without this
    * simulation the transfer will eventually settle on its own following the same
    * Federal Reserve timeline as in production.
+   *
+   * @example
+   * ```ts
+   * const achTransfer =
+   *   await client.simulations.achTransfers.settle(
+   *     'ach_transfer_uoxatyh3lt5evrsdvo7q',
+   *   );
+   * ```
    */
   settle(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfersAPI.ACHTransfer> {
     return this._client.post(`/simulations/ach_transfers/${achTransferId}/settle`, options);
@@ -67,6 +103,14 @@ export class ACHTransfers extends APIResource {
    * Federal Reserve three times per day on weekdays. Since sandbox ACH Transfers are
    * not submitted to the Federal Reserve, this endpoint allows you to skip that
    * delay and transition the ACH Transfer to a status of `submitted`.
+   *
+   * @example
+   * ```ts
+   * const achTransfer =
+   *   await client.simulations.achTransfers.submit(
+   *     'ach_transfer_uoxatyh3lt5evrsdvo7q',
+   *   );
+   * ```
    */
   submit(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfersAPI.ACHTransfer> {
     return this._client.post(`/simulations/ach_transfers/${achTransferId}/submit`, options);

package/src/resources/simulations/card-authorization-expirations.ts

@@ -7,6 +7,16 @@ import * as CardPaymentsAPI from '../card-payments';
 export class CardAuthorizationExpirations extends APIResource {
   /**
    * Simulates expiring a Card Authorization immediately.
+   *
+   * @example
+   * ```ts
+   * const cardPayment =
+   *   await client.simulations.cardAuthorizationExpirations.create(
+   *     {
+   *       card_payment_id: 'card_payment_nd3k2kacrqjli8482ave',
+   *     },
+   *   );
+   * ```
    */
   create(
     body: CardAuthorizationExpirationCreateParams,

package/src/resources/simulations/card-authorizations.ts

@@ -14,6 +14,14 @@ export class CardAuthorizations extends APIResource {
    * `card_decline`. You can pass either a Card id or a
    * [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
    * ways purchases can be made.
+   *
+   * @example
+   * ```ts
+   * const cardAuthorization =
+   *   await client.simulations.cardAuthorizations.create({
+   *     amount: 1000,
+   *   });
+   * ```
    */
   create(
     body: CardAuthorizationCreateParams,

package/src/resources/simulations/card-disputes.ts

@@ -10,6 +10,15 @@ export class CardDisputes extends APIResource {
    * will be reviewed. Since no review happens in sandbox, this endpoint simulates
    * moving a Card Dispute into a rejected or accepted state. A Card Dispute can only
    * be actioned one time and must have a status of `pending_reviewing`.
+   *
+   * @example
+   * ```ts
+   * const cardDispute =
+   *   await client.simulations.cardDisputes.action(
+   *     'card_dispute_h9sc95nbl1cgltpp7men',
+   *     { status: 'rejected' },
+   *   );
+   * ```
    */
   action(
     cardDisputeId: string,

package/src/resources/simulations/card-fuel-confirmations.ts

@@ -9,6 +9,15 @@ export class CardFuelConfirmations extends APIResource {
    * Simulates the fuel confirmation of an authorization by a card acquirer. This
    * happens asynchronously right after a fuel pump transaction is completed. A fuel
    * confirmation can only happen once per authorization.
+   *
+   * @example
+   * ```ts
+   * const cardPayment =
+   *   await client.simulations.cardFuelConfirmations.create({
+   *     amount: 5000,
+   *     card_payment_id: 'card_payment_nd3k2kacrqjli8482ave',
+   *   });
+   * ```
    */
   create(
     body: CardFuelConfirmationCreateParams,

package/src/resources/simulations/card-increments.ts

@@ -8,6 +8,15 @@ export class CardIncrements extends APIResource {
   /**
    * Simulates the increment of an authorization by a card acquirer. An authorization
    * can be incremented multiple times.
+   *
+   * @example
+   * ```ts
+   * const cardPayment =
+   *   await client.simulations.cardIncrements.create({
+   *     amount: 500,
+   *     card_payment_id: 'card_payment_nd3k2kacrqjli8482ave',
+   *   });
+   * ```
    */
   create(
     body: CardIncrementCreateParams,

package/src/resources/simulations/card-refunds.ts

@@ -8,6 +8,14 @@ export class CardRefunds extends APIResource {
   /**
    * Simulates refunding a card transaction. The full value of the original sandbox
    * transaction is refunded.
+   *
+   * @example
+   * ```ts
+   * const transaction =
+   *   await client.simulations.cardRefunds.create({
+   *     transaction_id: 'transaction_uyrp7fld2ium70oa7oi',
+   *   });
+   * ```
    */
   create(
     body: CardRefundCreateParams,

package/src/resources/simulations/card-reversals.ts

@@ -10,6 +10,14 @@ export class CardReversals extends APIResource {
    * can be partially reversed multiple times, up until the total authorized amount.
    * Marks the pending transaction as complete if the authorization is fully
    * reversed.
+   *
+   * @example
+   * ```ts
+   * const cardPayment =
+   *   await client.simulations.cardReversals.create({
+   *     card_payment_id: 'card_payment_nd3k2kacrqjli8482ave',
+   *   });
+   * ```
    */
   create(
     body: CardReversalCreateParams,

package/src/resources/simulations/card-settlements.ts

@@ -11,6 +11,16 @@ export class CardSettlements extends APIResource {
    * simulates that event, which may occur many days after the purchase in
    * production. The amount settled can be different from the amount originally
    * authorized, for example, when adding a tip to a restaurant bill.
+   *
+   * @example
+   * ```ts
+   * const transaction =
+   *   await client.simulations.cardSettlements.create({
+   *     card_id: 'card_oubs0hwk5rn6knuecxg2',
+   *     pending_transaction_id:
+   *       'pending_transaction_k1sfetcau2qbvjbzgju4',
+   *   });
+   * ```
    */
   create(
     body: CardSettlementCreateParams,

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

@@ -9,6 +9,14 @@ export class CheckDeposits extends APIResource {
    * Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to
    * factors like poor image quality. This Check Deposit must first have a `status`
    * of `pending`.
+   *
+   * @example
+   * ```ts
+   * const checkDeposit =
+   *   await client.simulations.checkDeposits.reject(
+   *     'check_deposit_f06n9gpg7sxn8t19lfc1',
+   *   );
+   * ```
    */
   reject(
     checkDepositId: string,
@@ -20,6 +28,14 @@ export class CheckDeposits extends APIResource {
   /**
    * Simulates the return of a [Check Deposit](#check-deposits). This Check Deposit
    * must first have a `status` of `submitted`.
+   *
+   * @example
+   * ```ts
+   * const checkDeposit =
+   *   await client.simulations.checkDeposits.return(
+   *     'check_deposit_f06n9gpg7sxn8t19lfc1',
+   *   );
+   * ```
    */
   return(
     checkDepositId: string,
@@ -31,6 +47,14 @@ export class CheckDeposits extends APIResource {
   /**
    * Simulates the submission of a [Check Deposit](#check-deposits) to the Federal
    * Reserve. This Check Deposit must first have a `status` of `pending`.
+   *
+   * @example
+   * ```ts
+   * const checkDeposit =
+   *   await client.simulations.checkDeposits.submit(
+   *     'check_deposit_f06n9gpg7sxn8t19lfc1',
+   *   );
+   * ```
    */
   submit(
     checkDepositId: string,