increase 0.210.0 → 0.212.0

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,

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

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