@augustusbank/typescript-sdk 0.20.0 → 0.22.0

package/resources/returns.d.mts

@@ -5,14 +5,36 @@ import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Returns extends APIResource {
     /**
      * Initiates a return of funds from a deposit to the source.
+     *
+     * @example
+     * ```ts
+     * const _return = await client.returns.create({
+     *   deposit_id: '550e8400-e29b-41d4-a716-446655440004',
+     * });
+     * ```
      */
     create(body: ReturnCreateParams, options?: RequestOptions): APIPromise<ReturnCreateResponse>;
     /**
      * Retrieves a return by ID.
+     *
+     * @example
+     * ```ts
+     * const _return = await client.returns.retrieve(
+     *   '550e8400-e29b-41d4-a716-446655440005',
+     * );
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<ReturnRetrieveResponse>;
     /**
      * Lists deposit returns for the merchant with cursor-based pagination.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const returnListResponse of client.returns.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: ReturnListParams | null | undefined, options?: RequestOptions): PagePromise<ReturnListResponsesCursorPage, ReturnListResponse>;
 }
@@ -27,11 +49,7 @@ export interface ReturnCreateResponse {
      */
     amount: string;
     /**
-     * ISO 8601 UTC timestamp when the return was created.
-     */
-    created_at: string;
-    /**
-     * Currency code (ISO 4217 currency code or crypto currency code).
+     * Currency code (ISO 4217 or crypto).
      */
     currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
     /**
@@ -42,18 +60,31 @@ export interface ReturnCreateResponse {
      * Failure details when status is failed, otherwise null.
      */
     failure: ReturnCreateResponse.Failure | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was initiated.
+     */
+    initiated_at: string;
+    /**
+     * Payment scheme or blockchain used for the return, or null when unknown.
+     */
+    rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was sent.
+     */
+    sent_at: string | null;
     /**
      * Current status of the return.
      */
-    status: 'pending' | 'paid' | 'failed' | 'returned';
+    status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
     /**
-     * Type of the resource.
+     * Transaction hash for crypto returns, or null when not known. Only blockchain
+     * rails support this field.
      */
-    type: 'return';
+    tx_hash: string | null;
     /**
-     * ISO 8601 UTC timestamp when the return was last updated.
+     * Resource type discriminator.
      */
-    updated_at: string;
+    type: 'return';
 }
 export declare namespace ReturnCreateResponse {
     /**
@@ -63,7 +94,7 @@ export declare namespace ReturnCreateResponse {
         /**
          * Failure code.
          */
-        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
+        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
         /**
          * Human-readable description of the failure.
          */
@@ -84,11 +115,7 @@ export interface ReturnRetrieveResponse {
      */
     amount: string;
     /**
-     * ISO 8601 UTC timestamp when the return was created.
-     */
-    created_at: string;
-    /**
-     * Currency code (ISO 4217 currency code or crypto currency code).
+     * Currency code (ISO 4217 or crypto).
      */
     currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
     /**
@@ -99,18 +126,31 @@ export interface ReturnRetrieveResponse {
      * Failure details when status is failed, otherwise null.
      */
     failure: ReturnRetrieveResponse.Failure | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was initiated.
+     */
+    initiated_at: string;
+    /**
+     * Payment scheme or blockchain used for the return, or null when unknown.
+     */
+    rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was sent.
+     */
+    sent_at: string | null;
     /**
      * Current status of the return.
      */
-    status: 'pending' | 'paid' | 'failed' | 'returned';
+    status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
     /**
-     * Type of the resource.
+     * Transaction hash for crypto returns, or null when not known. Only blockchain
+     * rails support this field.
      */
-    type: 'return';
+    tx_hash: string | null;
     /**
-     * ISO 8601 UTC timestamp when the return was last updated.
+     * Resource type discriminator.
      */
-    updated_at: string;
+    type: 'return';
 }
 export declare namespace ReturnRetrieveResponse {
     /**
@@ -120,7 +160,7 @@ export declare namespace ReturnRetrieveResponse {
         /**
          * Failure code.
          */
-        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
+        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
         /**
          * Human-readable description of the failure.
          */
@@ -141,11 +181,7 @@ export interface ReturnListResponse {
      */
     amount: string;
     /**
-     * ISO 8601 UTC timestamp when the return was created.
-     */
-    created_at: string;
-    /**
-     * Currency code (ISO 4217 currency code or crypto currency code).
+     * Currency code (ISO 4217 or crypto).
      */
     currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
     /**
@@ -156,18 +192,31 @@ export interface ReturnListResponse {
      * Failure details when status is failed, otherwise null.
      */
     failure: ReturnListResponse.Failure | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was initiated.
+     */
+    initiated_at: string;
+    /**
+     * Payment scheme or blockchain used for the return, or null when unknown.
+     */
+    rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was sent.
+     */
+    sent_at: string | null;
     /**
      * Current status of the return.
      */
-    status: 'pending' | 'paid' | 'failed' | 'returned';
+    status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
     /**
-     * Type of the resource.
+     * Transaction hash for crypto returns, or null when not known. Only blockchain
+     * rails support this field.
      */
-    type: 'return';
+    tx_hash: string | null;
     /**
-     * ISO 8601 UTC timestamp when the return was last updated.
+     * Resource type discriminator.
      */
-    updated_at: string;
+    type: 'return';
 }
 export declare namespace ReturnListResponse {
     /**
@@ -177,7 +226,7 @@ export declare namespace ReturnListResponse {
         /**
          * Failure code.
          */
-        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
+        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
         /**
          * Human-readable description of the failure.
          */
@@ -193,10 +242,6 @@ export interface ReturnCreateParams {
      * Deposit to return funds from.
      */
     deposit_id: string;
-    /**
-     * Payment rail when the deposit allows multiple schemes.
-     */
-    rail?: 'sepa_instant' | 'sepa' | 'faster_payments';
 }
 export interface ReturnListParams extends CursorPageParams {
     created_at?: ReturnListParams.CreatedAt;
@@ -205,9 +250,9 @@ export interface ReturnListParams extends CursorPageParams {
      */
     deposit_id?: string;
     /**
-     * Current status of the return.
+     * Filter by return status.
      */
-    status?: 'pending' | 'paid' | 'failed' | 'returned';
+    status?: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 }
 export declare namespace ReturnListParams {
     interface CreatedAt {

package/resources/returns.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"returns.d.mts","sourceRoot":"","sources":["../src/resources/returns.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,+BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI5F;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIlF;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;CAGlE;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,MAAM,GAAG,iBAAiB,CAAC;CACpD;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,UAAU,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;CACrD;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"returns.d.mts","sourceRoot":"","sources":["../src/resources/returns.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,+BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI5F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;CAGlE;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EACA,MAAM,GACN,cAAc,GACd,iBAAiB,GACjB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,SAAS,GACT,SAAS,GACT,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,SAAS,GACT,cAAc,GACd,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnE;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EACA,MAAM,GACN,cAAc,GACd,iBAAiB,GACjB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,SAAS,GACT,SAAS,GACT,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,SAAS,GACT,cAAc,GACd,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnE;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EACA,MAAM,GACN,cAAc,GACd,iBAAiB,GACjB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,SAAS,GACT,SAAS,GACT,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,SAAS,GACT,cAAc,GACd,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnE;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,UAAU,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;CACrE;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/returns.d.ts

@@ -5,14 +5,36 @@ import { RequestOptions } from "../internal/request-options.js";
 export declare class Returns extends APIResource {
     /**
      * Initiates a return of funds from a deposit to the source.
+     *
+     * @example
+     * ```ts
+     * const _return = await client.returns.create({
+     *   deposit_id: '550e8400-e29b-41d4-a716-446655440004',
+     * });
+     * ```
      */
     create(body: ReturnCreateParams, options?: RequestOptions): APIPromise<ReturnCreateResponse>;
     /**
      * Retrieves a return by ID.
+     *
+     * @example
+     * ```ts
+     * const _return = await client.returns.retrieve(
+     *   '550e8400-e29b-41d4-a716-446655440005',
+     * );
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<ReturnRetrieveResponse>;
     /**
      * Lists deposit returns for the merchant with cursor-based pagination.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const returnListResponse of client.returns.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: ReturnListParams | null | undefined, options?: RequestOptions): PagePromise<ReturnListResponsesCursorPage, ReturnListResponse>;
 }
@@ -27,11 +49,7 @@ export interface ReturnCreateResponse {
      */
     amount: string;
     /**
-     * ISO 8601 UTC timestamp when the return was created.
-     */
-    created_at: string;
-    /**
-     * Currency code (ISO 4217 currency code or crypto currency code).
+     * Currency code (ISO 4217 or crypto).
      */
     currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
     /**
@@ -42,18 +60,31 @@ export interface ReturnCreateResponse {
      * Failure details when status is failed, otherwise null.
      */
     failure: ReturnCreateResponse.Failure | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was initiated.
+     */
+    initiated_at: string;
+    /**
+     * Payment scheme or blockchain used for the return, or null when unknown.
+     */
+    rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was sent.
+     */
+    sent_at: string | null;
     /**
      * Current status of the return.
      */
-    status: 'pending' | 'paid' | 'failed' | 'returned';
+    status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
     /**
-     * Type of the resource.
+     * Transaction hash for crypto returns, or null when not known. Only blockchain
+     * rails support this field.
      */
-    type: 'return';
+    tx_hash: string | null;
     /**
-     * ISO 8601 UTC timestamp when the return was last updated.
+     * Resource type discriminator.
      */
-    updated_at: string;
+    type: 'return';
 }
 export declare namespace ReturnCreateResponse {
     /**
@@ -63,7 +94,7 @@ export declare namespace ReturnCreateResponse {
         /**
          * Failure code.
          */
-        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
+        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
         /**
          * Human-readable description of the failure.
          */
@@ -84,11 +115,7 @@ export interface ReturnRetrieveResponse {
      */
     amount: string;
     /**
-     * ISO 8601 UTC timestamp when the return was created.
-     */
-    created_at: string;
-    /**
-     * Currency code (ISO 4217 currency code or crypto currency code).
+     * Currency code (ISO 4217 or crypto).
      */
     currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
     /**
@@ -99,18 +126,31 @@ export interface ReturnRetrieveResponse {
      * Failure details when status is failed, otherwise null.
      */
     failure: ReturnRetrieveResponse.Failure | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was initiated.
+     */
+    initiated_at: string;
+    /**
+     * Payment scheme or blockchain used for the return, or null when unknown.
+     */
+    rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was sent.
+     */
+    sent_at: string | null;
     /**
      * Current status of the return.
      */
-    status: 'pending' | 'paid' | 'failed' | 'returned';
+    status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
     /**
-     * Type of the resource.
+     * Transaction hash for crypto returns, or null when not known. Only blockchain
+     * rails support this field.
      */
-    type: 'return';
+    tx_hash: string | null;
     /**
-     * ISO 8601 UTC timestamp when the return was last updated.
+     * Resource type discriminator.
      */
-    updated_at: string;
+    type: 'return';
 }
 export declare namespace ReturnRetrieveResponse {
     /**
@@ -120,7 +160,7 @@ export declare namespace ReturnRetrieveResponse {
         /**
          * Failure code.
          */
-        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
+        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
         /**
          * Human-readable description of the failure.
          */
@@ -141,11 +181,7 @@ export interface ReturnListResponse {
      */
     amount: string;
     /**
-     * ISO 8601 UTC timestamp when the return was created.
-     */
-    created_at: string;
-    /**
-     * Currency code (ISO 4217 currency code or crypto currency code).
+     * Currency code (ISO 4217 or crypto).
      */
     currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
     /**
@@ -156,18 +192,31 @@ export interface ReturnListResponse {
      * Failure details when status is failed, otherwise null.
      */
     failure: ReturnListResponse.Failure | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was initiated.
+     */
+    initiated_at: string;
+    /**
+     * Payment scheme or blockchain used for the return, or null when unknown.
+     */
+    rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
+    /**
+     * ISO 8601 UTC timestamp when the return was sent.
+     */
+    sent_at: string | null;
     /**
      * Current status of the return.
      */
-    status: 'pending' | 'paid' | 'failed' | 'returned';
+    status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
     /**
-     * Type of the resource.
+     * Transaction hash for crypto returns, or null when not known. Only blockchain
+     * rails support this field.
      */
-    type: 'return';
+    tx_hash: string | null;
     /**
-     * ISO 8601 UTC timestamp when the return was last updated.
+     * Resource type discriminator.
      */
-    updated_at: string;
+    type: 'return';
 }
 export declare namespace ReturnListResponse {
     /**
@@ -177,7 +226,7 @@ export declare namespace ReturnListResponse {
         /**
          * Failure code.
          */
-        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
+        code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
         /**
          * Human-readable description of the failure.
          */
@@ -193,10 +242,6 @@ export interface ReturnCreateParams {
      * Deposit to return funds from.
      */
     deposit_id: string;
-    /**
-     * Payment rail when the deposit allows multiple schemes.
-     */
-    rail?: 'sepa_instant' | 'sepa' | 'faster_payments';
 }
 export interface ReturnListParams extends CursorPageParams {
     created_at?: ReturnListParams.CreatedAt;
@@ -205,9 +250,9 @@ export interface ReturnListParams extends CursorPageParams {
      */
     deposit_id?: string;
     /**
-     * Current status of the return.
+     * Filter by return status.
      */
-    status?: 'pending' | 'paid' | 'failed' | 'returned';
+    status?: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 }
 export declare namespace ReturnListParams {
     interface CreatedAt {

package/resources/returns.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"returns.d.ts","sourceRoot":"","sources":["../src/resources/returns.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,8BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI5F;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIlF;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;CAGlE;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,MAAM,GAAG,iBAAiB,CAAC;CACpD;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,UAAU,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;CACrD;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"returns.d.ts","sourceRoot":"","sources":["../src/resources/returns.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,8BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI5F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;CAGlE;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EACA,MAAM,GACN,cAAc,GACd,iBAAiB,GACjB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,SAAS,GACT,SAAS,GACT,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,SAAS,GACT,cAAc,GACd,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnE;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EACA,MAAM,GACN,cAAc,GACd,iBAAiB,GACjB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,SAAS,GACT,SAAS,GACT,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,SAAS,GACT,cAAc,GACd,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnE;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EACA,MAAM,GACN,cAAc,GACd,iBAAiB,GACjB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,SAAS,GACT,SAAS,GACT,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,SAAS,GACT,cAAc,GACd,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnE;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,UAAU,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;CACrE;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/returns.js

@@ -8,18 +8,40 @@ const path_1 = require("../internal/utils/path.js");
 class Returns extends resource_1.APIResource {
     /**
      * Initiates a return of funds from a deposit to the source.
+     *
+     * @example
+     * ```ts
+     * const _return = await client.returns.create({
+     *   deposit_id: '550e8400-e29b-41d4-a716-446655440004',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/returns', { body, ...options });
     }
     /**
      * Retrieves a return by ID.
+     *
+     * @example
+     * ```ts
+     * const _return = await client.returns.retrieve(
+     *   '550e8400-e29b-41d4-a716-446655440005',
+     * );
+     * ```
      */
     retrieve(id, options) {
         return this._client.get((0, path_1.path) `/v1/returns/${id}`, options);
     }
     /**
      * Lists deposit returns for the merchant with cursor-based pagination.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const returnListResponse of client.returns.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/returns', (pagination_1.CursorPage), { query, ...options });

package/resources/returns.js.map

@@ -1 +1 @@
-{"version":3,"file":"returns.js","sourceRoot":"","sources":["../src/resources/returns.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAxBD,0BAwBC"}
+{"version":3,"file":"returns.js","sourceRoot":"","sources":["../src/resources/returns.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AA9CD,0BA8CC"}

package/resources/returns.mjs

@@ -5,18 +5,40 @@ import { path } from "../internal/utils/path.mjs";
 export class Returns extends APIResource {
     /**
      * Initiates a return of funds from a deposit to the source.
+     *
+     * @example
+     * ```ts
+     * const _return = await client.returns.create({
+     *   deposit_id: '550e8400-e29b-41d4-a716-446655440004',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/returns', { body, ...options });
     }
     /**
      * Retrieves a return by ID.
+     *
+     * @example
+     * ```ts
+     * const _return = await client.returns.retrieve(
+     *   '550e8400-e29b-41d4-a716-446655440005',
+     * );
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(path `/v1/returns/${id}`, options);
     }
     /**
      * Lists deposit returns for the merchant with cursor-based pagination.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const returnListResponse of client.returns.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/returns', (CursorPage), { query, ...options });

package/resources/returns.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"returns.mjs","sourceRoot":"","sources":["../src/resources/returns.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,UAAU,EAAsC,+BAA2B;AAEpF,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF"}
+{"version":3,"file":"returns.mjs","sourceRoot":"","sources":["../src/resources/returns.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,UAAU,EAAsC,+BAA2B;AAEpF,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF"}

package/resources/scopes.d.mts

@@ -19,7 +19,7 @@ export declare namespace ScopeListResponse {
         /**
          * Scope identifier in `resource:action` format.
          */
-        id: 'payouts:read' | 'payouts:write' | 'deposits:read' | 'returns:read' | 'returns:write' | 'conversions:read' | 'conversions:write' | 'quotes:read' | 'accounts:read' | 'accounts:write' | 'account_programs:read' | 'account_holders:read' | 'account_holders:write' | 'webhook_subscriptions:read' | 'webhook_subscriptions:write' | 'events:read' | 'webhook_deliveries:read' | 'webhook_deliveries:write' | 'transactions:read';
+        id: 'payouts:read' | 'payouts:write' | 'deposits:read' | 'returns:read' | 'returns:write' | 'conversions:read' | 'conversions:write' | 'quotes:read' | 'accounts:read' | 'accounts:write' | 'account_programs:read' | 'account_holders:read' | 'account_holders:write' | 'counterparties:read' | 'counterparties:write' | 'webhook_subscriptions:read' | 'webhook_subscriptions:write' | 'events:read' | 'webhook_deliveries:read' | 'webhook_deliveries:write' | 'transactions:read' | 'simulations:write';
         /**
          * Action category.
          */
@@ -40,6 +40,9 @@ export declare namespace ScopeListResponse {
          * Resource the scope applies to.
          */
         resource: string;
+        /**
+         * Resource type discriminator.
+         */
         type: 'scope';
     }
 }

package/resources/scopes.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"scopes.d.mts","sourceRoot":"","sources":["../src/resources/scopes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAG9D;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EACE,cAAc,GACd,eAAe,GACf,eAAe,GACf,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,aAAa,GACb,eAAe,GACf,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,uBAAuB,GACvB,4BAA4B,GAC5B,6BAA6B,GAC7B,aAAa,GACb,yBAAyB,GACzB,0BAA0B,GAC1B,mBAAmB,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAEzB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACxD"}
+{"version":3,"file":"scopes.d.mts","sourceRoot":"","sources":["../src/resources/scopes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAG9D;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EACE,cAAc,GACd,eAAe,GACf,eAAe,GACf,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,aAAa,GACb,eAAe,GACf,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,uBAAuB,GACvB,qBAAqB,GACrB,sBAAsB,GACtB,4BAA4B,GAC5B,6BAA6B,GAC7B,aAAa,GACb,yBAAyB,GACzB,0BAA0B,GAC1B,mBAAmB,GACnB,mBAAmB,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAEzB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACxD"}