increase 0.211.0 → 0.212.0

package/src/resources/simulations/inbound-funds-holds.ts

@@ -7,6 +7,14 @@ export class InboundFundsHolds extends APIResource {
   /**
    * This endpoint simulates immediately releasing an Inbound Funds Hold, which might
    * be created as a result of e.g., an ACH debit.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.simulations.inboundFundsHolds.release(
+   *     'inbound_funds_hold_9vuasmywdo7xb3zt4071',
+   *   );
+   * ```
    */
   release(
     inboundFundsHoldId: string,

package/src/resources/simulations/inbound-mail-items.ts

@@ -8,6 +8,15 @@ export class InboundMailItems extends APIResource {
   /**
    * Simulates an inbound mail item to your account, as if someone had mailed a
    * physical check to one of your account's Lockboxes.
+   *
+   * @example
+   * ```ts
+   * const inboundMailItem =
+   *   await client.simulations.inboundMailItems.create({
+   *     amount: 1000,
+   *     lockbox_id: 'lockbox_3xt21ok13q19advds4t5',
+   *   });
+   * ```
    */
   create(
     body: InboundMailItemCreateParams,

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

@@ -9,6 +9,18 @@ export class InboundRealTimePaymentsTransfers extends APIResource {
    * Simulates an
    * [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to
    * your account. Real-Time Payments are a beta feature.
+   *
+   * @example
+   * ```ts
+   * const inboundRealTimePaymentsTransfer =
+   *   await client.simulations.inboundRealTimePaymentsTransfers.create(
+   *     {
+   *       account_number_id:
+   *         'account_number_v18nkfqm6afpsrvy82b2',
+   *       amount: 1000,
+   *     },
+   *   );
+   * ```
    */
   create(
     body: InboundRealTimePaymentsTransferCreateParams,

package/src/resources/simulations/inbound-wire-drawdown-requests.ts

@@ -8,6 +8,24 @@ export class InboundWireDrawdownRequests extends APIResource {
   /**
    * Simulates receiving an
    * [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests).
+   *
+   * @example
+   * ```ts
+   * const inboundWireDrawdownRequest =
+   *   await client.simulations.inboundWireDrawdownRequests.create(
+   *     {
+   *       amount: 10000,
+   *       beneficiary_account_number: '987654321',
+   *       beneficiary_routing_number: '101050001',
+   *       currency: 'USD',
+   *       message_to_recipient: 'Invoice 29582',
+   *       originator_account_number: '987654321',
+   *       originator_routing_number: '101050001',
+   *       recipient_account_number_id:
+   *         'account_number_v18nkfqm6afpsrvy82b2',
+   *     },
+   *   );
+   * ```
    */
   create(
     body: InboundWireDrawdownRequestCreateParams,

package/src/resources/simulations/inbound-wire-transfers.ts

@@ -7,6 +7,16 @@ import * as InboundWireTransfersAPI from '../inbound-wire-transfers';
 export class InboundWireTransfers extends APIResource {
   /**
    * Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account.
+   *
+   * @example
+   * ```ts
+   * const inboundWireTransfer =
+   *   await client.simulations.inboundWireTransfers.create({
+   *     account_number_id:
+   *       'account_number_v18nkfqm6afpsrvy82b2',
+   *     amount: 1000,
+   *   });
+   * ```
    */
   create(
     body: InboundWireTransferCreateParams,

package/src/resources/simulations/interest-payments.ts

@@ -8,6 +8,15 @@ export class InterestPayments extends APIResource {
   /**
    * Simulates an interest payment to your account. In production, this happens
    * automatically on the first of each month.
+   *
+   * @example
+   * ```ts
+   * const transaction =
+   *   await client.simulations.interestPayments.create({
+   *     account_id: 'account_in71c4amph0vgo2qllky',
+   *     amount: 1000,
+   *   });
+   * ```
    */
   create(
     body: InterestPaymentCreateParams,

package/src/resources/simulations/physical-cards.ts

@@ -9,6 +9,15 @@ export class PhysicalCards extends APIResource {
    * This endpoint allows you to simulate advancing the shipment status of a Physical
    * Card, to simulate e.g., that a physical card was attempted shipped but then
    * failed delivery.
+   *
+   * @example
+   * ```ts
+   * const physicalCard =
+   *   await client.simulations.physicalCards.advanceShipment(
+   *     'physical_card_ode8duyq5v2ynhjoharl',
+   *     { shipment_status: 'shipped' },
+   *   );
+   * ```
    */
   advanceShipment(
     physicalCardId: string,

package/src/resources/simulations/programs.ts

@@ -10,6 +10,13 @@ export class Programs extends APIResource {
    * group has one program called Commercial Banking. Note that when your group
    * operates more than one program, `program_id` is a required field when creating
    * accounts.
+   *
+   * @example
+   * ```ts
+   * const program = await client.simulations.programs.create({
+   *   name: 'For Benefit Of',
+   * });
+   * ```
    */
   create(body: ProgramCreateParams, options?: Core.RequestOptions): Core.APIPromise<ProgramsAPI.Program> {
     return this._client.post('/simulations/programs', { body, ...options });

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

@@ -10,6 +10,14 @@ export class RealTimePaymentsTransfers extends APIResource {
    * [Real-Time Payments Transfer](#real-time-payments-transfers) and handling the
    * response from the destination financial institution. This transfer must first
    * have a `status` of `pending_submission`.
+   *
+   * @example
+   * ```ts
+   * const realTimePaymentsTransfer =
+   *   await client.simulations.realTimePaymentsTransfers.complete(
+   *     'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq',
+   *   );
+   * ```
    */
   complete(
     realTimePaymentsTransferId: string,

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

@@ -10,6 +10,14 @@ export class WireTransfers extends APIResource {
    * Reserve due to error conditions. This will also create a
    * [Transaction](#transaction) to account for the returned funds. This Wire
    * Transfer must first have a `status` of `complete`.
+   *
+   * @example
+   * ```ts
+   * const wireTransfer =
+   *   await client.simulations.wireTransfers.reverse(
+   *     'wire_transfer_5akynk7dqsq25qwk9q2u',
+   *   );
+   * ```
    */
   reverse(
     wireTransferId: string,
@@ -22,6 +30,14 @@ export class WireTransfers extends APIResource {
    * Simulates the submission of a [Wire Transfer](#wire-transfers) to the Federal
    * Reserve. This transfer must first have a `status` of `pending_approval` or
    * `pending_creating`.
+   *
+   * @example
+   * ```ts
+   * const wireTransfer =
+   *   await client.simulations.wireTransfers.submit(
+   *     'wire_transfer_5akynk7dqsq25qwk9q2u',
+   *   );
+   * ```
    */
   submit(
     wireTransferId: string,

package/src/resources/supplemental-documents.ts

@@ -7,6 +7,15 @@ import { Page, type PageParams } from '../pagination';
 export class SupplementalDocuments extends APIResource {
   /**
    * Create a supplemental document for an Entity
+   *
+   * @example
+   * ```ts
+   * const entitySupplementalDocument =
+   *   await client.supplementalDocuments.create({
+   *     entity_id: 'entity_n8y8tnk2p9339ti393yi',
+   *     file_id: 'file_makxrc67oh9l6sg7w9yc',
+   *   });
+   * ```
    */
   create(
     body: SupplementalDocumentCreateParams,
@@ -17,6 +26,16 @@ export class SupplementalDocuments extends APIResource {
 
   /**
    * List Entity Supplemental Document Submissions
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const entitySupplementalDocument of client.supplementalDocuments.list(
+   *   { entity_id: 'entity_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: SupplementalDocumentListParams,

package/src/resources/transactions.ts

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

package/src/resources/wire-drawdown-requests.ts

@@ -8,6 +8,20 @@ import { Page, type PageParams } from '../pagination';
 export class WireDrawdownRequests extends APIResource {
   /**
    * Create a Wire Drawdown Request
+   *
+   * @example
+   * ```ts
+   * const wireDrawdownRequest =
+   *   await client.wireDrawdownRequests.create({
+   *     account_number_id:
+   *       'account_number_v18nkfqm6afpsrvy82b2',
+   *     amount: 10000,
+   *     message_to_recipient: 'Invoice 29582',
+   *     recipient_account_number: '987654321',
+   *     recipient_name: 'Ian Crease',
+   *     recipient_routing_number: '101050001',
+   *   });
+   * ```
    */
   create(
     body: WireDrawdownRequestCreateParams,
@@ -18,6 +32,14 @@ export class WireDrawdownRequests extends APIResource {
 
   /**
    * Retrieve a Wire Drawdown Request
+   *
+   * @example
+   * ```ts
+   * const wireDrawdownRequest =
+   *   await client.wireDrawdownRequests.retrieve(
+   *     'wire_drawdown_request_q6lmocus3glo0lr2bfv3',
+   *   );
+   * ```
    */
   retrieve(
     wireDrawdownRequestId: string,
@@ -28,6 +50,14 @@ export class WireDrawdownRequests extends APIResource {
 
   /**
    * List Wire Drawdown Requests
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const wireDrawdownRequest of client.wireDrawdownRequests.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: WireDrawdownRequestListParams,

package/src/resources/wire-transfers.ts

@@ -8,6 +8,16 @@ import { Page, type PageParams } from '../pagination';
 export class WireTransfers extends APIResource {
   /**
    * Create a Wire Transfer
+   *
+   * @example
+   * ```ts
+   * const wireTransfer = await client.wireTransfers.create({
+   *   account_id: 'account_in71c4amph0vgo2qllky',
+   *   amount: 100,
+   *   beneficiary_name: 'Ian Crease',
+   *   message_to_recipient: 'New account transfer',
+   * });
+   * ```
    */
   create(body: WireTransferCreateParams, options?: Core.RequestOptions): Core.APIPromise<WireTransfer> {
     return this._client.post('/wire_transfers', { body, ...options });
@@ -15,6 +25,13 @@ export class WireTransfers extends APIResource {
 
   /**
    * Retrieve a Wire Transfer
+   *
+   * @example
+   * ```ts
+   * const wireTransfer = await client.wireTransfers.retrieve(
+   *   'wire_transfer_5akynk7dqsq25qwk9q2u',
+   * );
+   * ```
    */
   retrieve(wireTransferId: string, options?: Core.RequestOptions): Core.APIPromise<WireTransfer> {
     return this._client.get(`/wire_transfers/${wireTransferId}`, options);
@@ -22,6 +39,14 @@ export class WireTransfers extends APIResource {
 
   /**
    * List Wire Transfers
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const wireTransfer of client.wireTransfers.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: WireTransferListParams,
@@ -40,6 +65,13 @@ export class WireTransfers extends APIResource {
 
   /**
    * Approve a Wire Transfer
+   *
+   * @example
+   * ```ts
+   * const wireTransfer = await client.wireTransfers.approve(
+   *   'wire_transfer_5akynk7dqsq25qwk9q2u',
+   * );
+   * ```
    */
   approve(wireTransferId: string, options?: Core.RequestOptions): Core.APIPromise<WireTransfer> {
     return this._client.post(`/wire_transfers/${wireTransferId}/approve`, options);
@@ -47,6 +79,13 @@ export class WireTransfers extends APIResource {
 
   /**
    * Cancel a pending Wire Transfer
+   *
+   * @example
+   * ```ts
+   * const wireTransfer = await client.wireTransfers.cancel(
+   *   'wire_transfer_5akynk7dqsq25qwk9q2u',
+   * );
+   * ```
    */
   cancel(wireTransferId: string, options?: Core.RequestOptions): Core.APIPromise<WireTransfer> {
     return this._client.post(`/wire_transfers/${wireTransferId}/cancel`, options);

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.211.0'; // x-release-please-version
+export const VERSION = '0.212.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.211.0";
+export declare const VERSION = "0.212.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.211.0'; // x-release-please-version
+exports.VERSION = '0.212.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.211.0'; // x-release-please-version
+export const VERSION = '0.212.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map