increase 0.211.0 → 0.213.0

package/src/resources/bookkeeping-entry-sets.ts

@@ -8,6 +8,25 @@ import { Page, type PageParams } from '../pagination';
 export class BookkeepingEntrySets extends APIResource {
   /**
    * Create a Bookkeeping Entry Set
+   *
+   * @example
+   * ```ts
+   * const bookkeepingEntrySet =
+   *   await client.bookkeepingEntrySets.create({
+   *     entries: [
+   *       {
+   *         account_id:
+   *           'bookkeeping_account_9husfpw68pzmve9dvvc7',
+   *         amount: 100,
+   *       },
+   *       {
+   *         account_id:
+   *           'bookkeeping_account_t2obldz1rcu15zr54umg',
+   *         amount: -100,
+   *       },
+   *     ],
+   *   });
+   * ```
    */
   create(
     body: BookkeepingEntrySetCreateParams,
@@ -18,6 +37,14 @@ export class BookkeepingEntrySets extends APIResource {
 
   /**
    * Retrieve a Bookkeeping Entry Set
+   *
+   * @example
+   * ```ts
+   * const bookkeepingEntrySet =
+   *   await client.bookkeepingEntrySets.retrieve(
+   *     'bookkeeping_entry_set_n80c6wr2p8gtc6p4ingf',
+   *   );
+   * ```
    */
   retrieve(
     bookkeepingEntrySetId: string,
@@ -28,6 +55,14 @@ export class BookkeepingEntrySets extends APIResource {
 
   /**
    * List Bookkeeping Entry Sets
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const bookkeepingEntrySet of client.bookkeepingEntrySets.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: BookkeepingEntrySetListParams,

package/src/resources/card-disputes.ts

@@ -8,6 +8,15 @@ import { Page, type PageParams } from '../pagination';
 export class CardDisputes extends APIResource {
   /**
    * Create a Card Dispute
+   *
+   * @example
+   * ```ts
+   * const cardDispute = await client.cardDisputes.create({
+   *   disputed_transaction_id:
+   *     'transaction_uyrp7fld2ium70oa7oi',
+   *   explanation: 'Unauthorized recurring transaction.',
+   * });
+   * ```
    */
   create(body: CardDisputeCreateParams, options?: Core.RequestOptions): Core.APIPromise<CardDispute> {
     return this._client.post('/card_disputes', { body, ...options });
@@ -15,6 +24,13 @@ export class CardDisputes extends APIResource {
 
   /**
    * Retrieve a Card Dispute
+   *
+   * @example
+   * ```ts
+   * const cardDispute = await client.cardDisputes.retrieve(
+   *   'card_dispute_h9sc95nbl1cgltpp7men',
+   * );
+   * ```
    */
   retrieve(cardDisputeId: string, options?: Core.RequestOptions): Core.APIPromise<CardDispute> {
     return this._client.get(`/card_disputes/${cardDisputeId}`, options);
@@ -22,6 +38,14 @@ export class CardDisputes extends APIResource {
 
   /**
    * List Card Disputes
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const cardDispute of client.cardDisputes.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: CardDisputeListParams,

package/src/resources/card-payments.ts

@@ -8,6 +8,13 @@ import { Page, type PageParams } from '../pagination';
 export class CardPayments extends APIResource {
   /**
    * Retrieve a Card Payment
+   *
+   * @example
+   * ```ts
+   * const cardPayment = await client.cardPayments.retrieve(
+   *   'card_payment_nd3k2kacrqjli8482ave',
+   * );
+   * ```
    */
   retrieve(cardPaymentId: string, options?: Core.RequestOptions): Core.APIPromise<CardPayment> {
     return this._client.get(`/card_payments/${cardPaymentId}`, options);
@@ -15,6 +22,14 @@ export class CardPayments extends APIResource {
 
   /**
    * List Card Payments
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const cardPayment of client.cardPayments.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: CardPaymentListParams,

package/src/resources/card-purchase-supplements.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class CardPurchaseSupplements extends APIResource {
   /**
    * Retrieve a Card Purchase Supplement
+   *
+   * @example
+   * ```ts
+   * const cardPurchaseSupplement =
+   *   await client.cardPurchaseSupplements.retrieve(
+   *     'card_purchase_supplement_ijuc45iym4jchnh2sfk3',
+   *   );
+   * ```
    */
   retrieve(
     cardPurchaseSupplementId: string,
@@ -18,6 +26,14 @@ export class CardPurchaseSupplements extends APIResource {
 
   /**
    * List Card Purchase Supplements
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const cardPurchaseSupplement of client.cardPurchaseSupplements.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: CardPurchaseSupplementListParams,

package/src/resources/cards.ts

@@ -8,6 +8,13 @@ import { Page, type PageParams } from '../pagination';
 export class Cards extends APIResource {
   /**
    * Create a Card
+   *
+   * @example
+   * ```ts
+   * const card = await client.cards.create({
+   *   account_id: 'account_in71c4amph0vgo2qllky',
+   * });
+   * ```
    */
   create(body: CardCreateParams, options?: Core.RequestOptions): Core.APIPromise<Card> {
     return this._client.post('/cards', { body, ...options });
@@ -15,6 +22,13 @@ export class Cards extends APIResource {
 
   /**
    * Retrieve a Card
+   *
+   * @example
+   * ```ts
+   * const card = await client.cards.retrieve(
+   *   'card_oubs0hwk5rn6knuecxg2',
+   * );
+   * ```
    */
   retrieve(cardId: string, options?: Core.RequestOptions): Core.APIPromise<Card> {
     return this._client.get(`/cards/${cardId}`, options);
@@ -22,6 +36,13 @@ export class Cards extends APIResource {
 
   /**
    * Update a Card
+   *
+   * @example
+   * ```ts
+   * const card = await client.cards.update(
+   *   'card_oubs0hwk5rn6knuecxg2',
+   * );
+   * ```
    */
   update(cardId: string, body: CardUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Card> {
     return this._client.patch(`/cards/${cardId}`, { body, ...options });
@@ -29,6 +50,14 @@ export class Cards extends APIResource {
 
   /**
    * List Cards
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const card of client.cards.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(query?: CardListParams, options?: Core.RequestOptions): Core.PagePromise<CardsPage, Card>;
   list(options?: Core.RequestOptions): Core.PagePromise<CardsPage, Card>;
@@ -44,6 +73,13 @@ export class Cards extends APIResource {
 
   /**
    * Retrieve sensitive details for a Card
+   *
+   * @example
+   * ```ts
+   * const cardDetails = await client.cards.details(
+   *   'card_oubs0hwk5rn6knuecxg2',
+   * );
+   * ```
    */
   details(cardId: string, options?: Core.RequestOptions): Core.APIPromise<CardDetails> {
     return this._client.get(`/cards/${cardId}/details`, options);

package/src/resources/check-deposits.ts

@@ -8,6 +8,16 @@ import { Page, type PageParams } from '../pagination';
 export class CheckDeposits extends APIResource {
   /**
    * Create a Check Deposit
+   *
+   * @example
+   * ```ts
+   * const checkDeposit = await client.checkDeposits.create({
+   *   account_id: 'account_in71c4amph0vgo2qllky',
+   *   amount: 1000,
+   *   back_image_file_id: 'file_26khfk98mzfz90a11oqx',
+   *   front_image_file_id: 'file_hkv175ovmc2tb2v2zbrm',
+   * });
+   * ```
    */
   create(body: CheckDepositCreateParams, options?: Core.RequestOptions): Core.APIPromise<CheckDeposit> {
     return this._client.post('/check_deposits', { body, ...options });
@@ -15,6 +25,13 @@ export class CheckDeposits extends APIResource {
 
   /**
    * Retrieve a Check Deposit
+   *
+   * @example
+   * ```ts
+   * const checkDeposit = await client.checkDeposits.retrieve(
+   *   'check_deposit_f06n9gpg7sxn8t19lfc1',
+   * );
+   * ```
    */
   retrieve(checkDepositId: string, options?: Core.RequestOptions): Core.APIPromise<CheckDeposit> {
     return this._client.get(`/check_deposits/${checkDepositId}`, options);
@@ -22,6 +39,14 @@ export class CheckDeposits extends APIResource {
 
   /**
    * List Check Deposits
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const checkDeposit of client.checkDeposits.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: CheckDepositListParams,
@@ -310,34 +335,46 @@ export namespace CheckDeposit {
      * against.
      *
      * - `ach_conversion_not_supported` - The check doesn't allow ACH conversion.
-     * - `closed_account` - The account is closed.
-     * - `duplicate_submission` - The check has already been deposited.
-     * - `insufficient_funds` - Insufficient funds
-     * - `no_account` - No account was found matching the check details.
-     * - `not_authorized` - The check was not authorized.
-     * - `stale_dated` - The check is too old.
-     * - `stop_payment` - The payment has been stopped by the account holder.
+     * - `closed_account` - The account is closed. (Check21 return code `D`)
+     * - `duplicate_submission` - The check has already been deposited. (Check21 return
+     *   code `Y`)
+     * - `insufficient_funds` - Insufficient funds (Check21 return code `A`)
+     * - `no_account` - No account was found matching the check details. (Check21
+     *   return code `E`)
+     * - `not_authorized` - The check was not authorized. (Check21 return code `Q`)
+     * - `stale_dated` - The check is too old. (Check21 return code `G`)
+     * - `stop_payment` - The payment has been stopped by the account holder. (Check21
+     *   return code `C`)
      * - `unknown_reason` - The reason for the return is unknown.
      * - `unmatched_details` - The image doesn't match the details submitted.
-     * - `unreadable_image` - The image could not be read.
-     * - `endorsement_irregular` - The check endorsement was irregular.
+     * - `unreadable_image` - The image could not be read. (Check21 return code `U`)
+     * - `endorsement_irregular` - The check endorsement was irregular. (Check21 return
+     *   code `J`)
      * - `altered_or_fictitious_item` - The check present was either altered or fake.
+     *   (Check21 return code `N`)
      * - `frozen_or_blocked_account` - The account this check is drawn on is frozen.
-     * - `post_dated` - The check is post dated.
-     * - `endorsement_missing` - The endorsement was missing.
-     * - `signature_missing` - The check signature was missing.
+     *   (Check21 return code `F`)
+     * - `post_dated` - The check is post dated. (Check21 return code `H`)
+     * - `endorsement_missing` - The endorsement was missing. (Check21 return code `I`)
+     * - `signature_missing` - The check signature was missing. (Check21 return code
+     *   `K`)
      * - `stop_payment_suspect` - The bank suspects a stop payment will be placed.
-     * - `unusable_image` - The bank cannot read the image.
+     *   (Check21 return code `T`)
+     * - `unusable_image` - The bank cannot read the image. (Check21 return code `U`)
      * - `image_fails_security_check` - The check image fails the bank's security
-     *   check.
-     * - `cannot_determine_amount` - The bank cannot determine the amount.
+     *   check. (Check21 return code `V`)
+     * - `cannot_determine_amount` - The bank cannot determine the amount. (Check21
+     *   return code `W`)
      * - `signature_irregular` - The signature is inconsistent with prior signatures.
+     *   (Check21 return code `L`)
      * - `non_cash_item` - The check is a non-cash item and cannot be drawn against the
-     *   account.
-     * - `unable_to_process` - The bank is unable to process this check.
+     *   account. (Check21 return code `M`)
+     * - `unable_to_process` - The bank is unable to process this check. (Check21
+     *   return code `O`)
      * - `item_exceeds_dollar_limit` - The check exceeds the bank or customer's limit.
+     *   (Check21 return code `P`)
      * - `branch_or_account_sold` - The bank sold this account and no longer services
-     *   this customer.
+     *   this customer. (Check21 return code `R`)
      */
     return_reason:
       | 'ach_conversion_not_supported'

package/src/resources/check-transfers.ts

@@ -8,6 +8,17 @@ import { Page, type PageParams } from '../pagination';
 export class CheckTransfers extends APIResource {
   /**
    * Create a Check Transfer
+   *
+   * @example
+   * ```ts
+   * const checkTransfer = await client.checkTransfers.create({
+   *   account_id: 'account_in71c4amph0vgo2qllky',
+   *   amount: 1000,
+   *   fulfillment_method: 'physical_check',
+   *   source_account_number_id:
+   *     'account_number_v18nkfqm6afpsrvy82b2',
+   * });
+   * ```
    */
   create(body: CheckTransferCreateParams, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer> {
     return this._client.post('/check_transfers', { body, ...options });
@@ -15,6 +26,13 @@ export class CheckTransfers extends APIResource {
 
   /**
    * Retrieve a Check Transfer
+   *
+   * @example
+   * ```ts
+   * const checkTransfer = await client.checkTransfers.retrieve(
+   *   'check_transfer_30b43acfu9vw8fyc4f5',
+   * );
+   * ```
    */
   retrieve(checkTransferId: string, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer> {
     return this._client.get(`/check_transfers/${checkTransferId}`, options);
@@ -22,6 +40,14 @@ export class CheckTransfers extends APIResource {
 
   /**
    * List Check Transfers
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const checkTransfer of client.checkTransfers.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: CheckTransferListParams,
@@ -40,6 +66,13 @@ export class CheckTransfers extends APIResource {
 
   /**
    * Approve a Check Transfer
+   *
+   * @example
+   * ```ts
+   * const checkTransfer = await client.checkTransfers.approve(
+   *   'check_transfer_30b43acfu9vw8fyc4f5',
+   * );
+   * ```
    */
   approve(checkTransferId: string, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer> {
     return this._client.post(`/check_transfers/${checkTransferId}/approve`, options);
@@ -47,6 +80,13 @@ export class CheckTransfers extends APIResource {
 
   /**
    * Cancel a pending Check Transfer
+   *
+   * @example
+   * ```ts
+   * const checkTransfer = await client.checkTransfers.cancel(
+   *   'check_transfer_30b43acfu9vw8fyc4f5',
+   * );
+   * ```
    */
   cancel(checkTransferId: string, options?: Core.RequestOptions): Core.APIPromise<CheckTransfer> {
     return this._client.post(`/check_transfers/${checkTransferId}/cancel`, options);
@@ -54,6 +94,14 @@ export class CheckTransfers extends APIResource {
 
   /**
    * Request a stop payment on a Check Transfer
+   *
+   * @example
+   * ```ts
+   * const checkTransfer =
+   *   await client.checkTransfers.stopPayment(
+   *     'check_transfer_30b43acfu9vw8fyc4f5',
+   *   );
+   * ```
    */
   stopPayment(
     checkTransferId: string,

package/src/resources/declined-transactions.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class DeclinedTransactions extends APIResource {
   /**
    * Retrieve a Declined Transaction
+   *
+   * @example
+   * ```ts
+   * const declinedTransaction =
+   *   await client.declinedTransactions.retrieve(
+   *     'declined_transaction_17jbn0yyhvkt4v4ooym8',
+   *   );
+   * ```
    */
   retrieve(
     declinedTransactionId: string,
@@ -18,6 +26,14 @@ export class DeclinedTransactions extends APIResource {
 
   /**
    * List Declined Transactions
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const declinedTransaction of client.declinedTransactions.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: DeclinedTransactionListParams,

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

@@ -8,6 +8,18 @@ import { Page, type PageParams } from '../pagination';
 export class DigitalCardProfiles extends APIResource {
   /**
    * Create a Digital Card Profile
+   *
+   * @example
+   * ```ts
+   * const digitalCardProfile =
+   *   await client.digitalCardProfiles.create({
+   *     app_icon_file_id: 'file_8zxqkwlh43wo144u8yec',
+   *     background_image_file_id: 'file_1ai913suu1zfn1pdetru',
+   *     card_description: 'MyBank Signature Card',
+   *     description: 'My Card Profile',
+   *     issuer_name: 'MyBank',
+   *   });
+   * ```
    */
   create(
     body: DigitalCardProfileCreateParams,
@@ -18,6 +30,14 @@ export class DigitalCardProfiles extends APIResource {
 
   /**
    * Retrieve a Digital Card Profile
+   *
+   * @example
+   * ```ts
+   * const digitalCardProfile =
+   *   await client.digitalCardProfiles.retrieve(
+   *     'digital_card_profile_s3puplu90f04xhcwkiga',
+   *   );
+   * ```
    */
   retrieve(digitalCardProfileId: string, options?: Core.RequestOptions): Core.APIPromise<DigitalCardProfile> {
     return this._client.get(`/digital_card_profiles/${digitalCardProfileId}`, options);
@@ -25,6 +45,14 @@ export class DigitalCardProfiles extends APIResource {
 
   /**
    * List Card Profiles
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const digitalCardProfile of client.digitalCardProfiles.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: DigitalCardProfileListParams,
@@ -43,6 +71,14 @@ export class DigitalCardProfiles extends APIResource {
 
   /**
    * Archive a Digital Card Profile
+   *
+   * @example
+   * ```ts
+   * const digitalCardProfile =
+   *   await client.digitalCardProfiles.archive(
+   *     'digital_card_profile_s3puplu90f04xhcwkiga',
+   *   );
+   * ```
    */
   archive(digitalCardProfileId: string, options?: Core.RequestOptions): Core.APIPromise<DigitalCardProfile> {
     return this._client.post(`/digital_card_profiles/${digitalCardProfileId}/archive`, options);
@@ -50,6 +86,14 @@ export class DigitalCardProfiles extends APIResource {
 
   /**
    * Clones a Digital Card Profile
+   *
+   * @example
+   * ```ts
+   * const digitalCardProfile =
+   *   await client.digitalCardProfiles.clone(
+   *     'digital_card_profile_s3puplu90f04xhcwkiga',
+   *   );
+   * ```
    */
   clone(
     digitalCardProfileId: string,

package/src/resources/digital-wallet-tokens.ts

@@ -8,6 +8,14 @@ import { Page, type PageParams } from '../pagination';
 export class DigitalWalletTokens extends APIResource {
   /**
    * Retrieve a Digital Wallet Token
+   *
+   * @example
+   * ```ts
+   * const digitalWalletToken =
+   *   await client.digitalWalletTokens.retrieve(
+   *     'digital_wallet_token_izi62go3h51p369jrie0',
+   *   );
+   * ```
    */
   retrieve(digitalWalletTokenId: string, options?: Core.RequestOptions): Core.APIPromise<DigitalWalletToken> {
     return this._client.get(`/digital_wallet_tokens/${digitalWalletTokenId}`, options);
@@ -15,6 +23,14 @@ export class DigitalWalletTokens extends APIResource {
 
   /**
    * List Digital Wallet Tokens
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const digitalWalletToken of client.digitalWalletTokens.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: DigitalWalletTokenListParams,

package/src/resources/documents.ts

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