@augustusbank/typescript-sdk 0.12.1 → 0.14.0

package/src/resources/returns.ts

@@ -2,16 +2,119 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Returns extends APIResource {
+  /**
+   * Initiates a return of funds from a deposit to the source.
+   */
+  create(body: ReturnCreateParams, options?: RequestOptions): APIPromise<ReturnCreateResponse> {
+    return this._client.post('/v1/returns', { body, ...options });
+  }
+
   /**
    * Retrieves a return by ID.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<ReturnRetrieveResponse> {
     return this._client.get(path`/v1/returns/${id}`, options);
   }
+
+  /**
+   * Lists deposit returns for the merchant with cursor-based pagination.
+   */
+  list(
+    query: ReturnListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ReturnListResponsesCursorPage, ReturnListResponse> {
+    return this._client.getAPIList('/v1/returns', CursorPage<ReturnListResponse>, { query, ...options });
+  }
+}
+
+export type ReturnListResponsesCursorPage = CursorPage<ReturnListResponse>;
+
+export interface ReturnCreateResponse {
+  /**
+   * Unique identifier of the return.
+   */
+  id: string;
+
+  /**
+   * Amount as a string decimal (e.g. "100.50").
+   */
+  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: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+
+  /**
+   * ID of the parent deposit.
+   */
+  deposit_id: string;
+
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  failure: ReturnCreateResponse.Failure | null;
+
+  /**
+   * Current status of the return.
+   */
+  status: 'pending' | 'paid' | 'failed' | 'returned';
+
+  /**
+   * Type of the resource.
+   */
+  type: 'return';
+
+  /**
+   * ISO 8601 UTC timestamp when the return was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace ReturnCreateResponse {
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  export interface Failure {
+    /**
+     * 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';
+
+    /**
+     * Human-readable description of the failure.
+     */
+    message: string;
+
+    /**
+     * Whether the return can be retried.
+     */
+    retry: boolean;
+  }
 }
 
 export interface ReturnRetrieveResponse {
@@ -33,7 +136,7 @@ export interface ReturnRetrieveResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * ID of the parent deposit.
@@ -97,6 +200,138 @@ export namespace ReturnRetrieveResponse {
   }
 }
 
+export interface ReturnListResponse {
+  /**
+   * Unique identifier of the return.
+   */
+  id: string;
+
+  /**
+   * Amount as a string decimal (e.g. "100.50").
+   */
+  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: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+
+  /**
+   * ID of the parent deposit.
+   */
+  deposit_id: string;
+
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  failure: ReturnListResponse.Failure | null;
+
+  /**
+   * Current status of the return.
+   */
+  status: 'pending' | 'paid' | 'failed' | 'returned';
+
+  /**
+   * Type of the resource.
+   */
+  type: 'return';
+
+  /**
+   * ISO 8601 UTC timestamp when the return was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace ReturnListResponse {
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  export interface Failure {
+    /**
+     * 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';
+
+    /**
+     * Human-readable description of the failure.
+     */
+    message: string;
+
+    /**
+     * Whether the return can be retried.
+     */
+    retry: boolean;
+  }
+}
+
+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;
+
+  /**
+   * Filter returns belonging to this deposit.
+   */
+  deposit_id?: string;
+
+  /**
+   * Current status of the return.
+   */
+  status?: 'pending' | 'paid' | 'failed' | 'returned';
+}
+
+export namespace ReturnListParams {
+  export interface CreatedAt {
+    /**
+     * Include returns whose created_at is greater than or equal to this ISO 8601
+     * timestamp.
+     */
+    gte?: string;
+
+    /**
+     * Include returns whose created_at is less than or equal to this ISO 8601
+     * timestamp.
+     */
+    lte?: string;
+  }
+}
+
 export declare namespace Returns {
-  export { type ReturnRetrieveResponse as ReturnRetrieveResponse };
+  export {
+    type ReturnCreateResponse as ReturnCreateResponse,
+    type ReturnRetrieveResponse as ReturnRetrieveResponse,
+    type ReturnListResponse as ReturnListResponse,
+    type ReturnListResponsesCursorPage as ReturnListResponsesCursorPage,
+    type ReturnCreateParams as ReturnCreateParams,
+    type ReturnListParams as ReturnListParams,
+  };
 }

package/src/resources/webhooks.ts

@@ -68,7 +68,7 @@ export namespace PayoutCreatedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * Bank account or crypto wallet the payout was sent to.
@@ -187,7 +187,15 @@ export namespace PayoutCreatedWebhookEvent {
       /**
        * Blockchain network for the crypto wallet.
        */
-      blockchain: 'ethereum' | 'solana' | 'polygon';
+      blockchain:
+        | 'bitcoin'
+        | 'ethereum'
+        | 'solana'
+        | 'polygon'
+        | 'bitcoin_testnet4'
+        | 'ethereum_sepolia'
+        | 'solana_devnet'
+        | 'polygon_amoy';
 
       /**
        * Discriminator for crypto wallet financial address.
@@ -281,7 +289,7 @@ export namespace PayoutInitiatedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * Bank account or crypto wallet the payout was sent to.
@@ -400,7 +408,15 @@ export namespace PayoutInitiatedWebhookEvent {
       /**
        * Blockchain network for the crypto wallet.
        */
-      blockchain: 'ethereum' | 'solana' | 'polygon';
+      blockchain:
+        | 'bitcoin'
+        | 'ethereum'
+        | 'solana'
+        | 'polygon'
+        | 'bitcoin_testnet4'
+        | 'ethereum_sepolia'
+        | 'solana_devnet'
+        | 'polygon_amoy';
 
       /**
        * Discriminator for crypto wallet financial address.
@@ -494,7 +510,7 @@ export namespace PayoutPaidWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * Bank account or crypto wallet the payout was sent to.
@@ -613,7 +629,15 @@ export namespace PayoutPaidWebhookEvent {
       /**
        * Blockchain network for the crypto wallet.
        */
-      blockchain: 'ethereum' | 'solana' | 'polygon';
+      blockchain:
+        | 'bitcoin'
+        | 'ethereum'
+        | 'solana'
+        | 'polygon'
+        | 'bitcoin_testnet4'
+        | 'ethereum_sepolia'
+        | 'solana_devnet'
+        | 'polygon_amoy';
 
       /**
        * Discriminator for crypto wallet financial address.
@@ -707,7 +731,7 @@ export namespace PayoutFailedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * Bank account or crypto wallet the payout was sent to.
@@ -826,7 +850,15 @@ export namespace PayoutFailedWebhookEvent {
       /**
        * Blockchain network for the crypto wallet.
        */
-      blockchain: 'ethereum' | 'solana' | 'polygon';
+      blockchain:
+        | 'bitcoin'
+        | 'ethereum'
+        | 'solana'
+        | 'polygon'
+        | 'bitcoin_testnet4'
+        | 'ethereum_sepolia'
+        | 'solana_devnet'
+        | 'polygon_amoy';
 
       /**
        * Discriminator for crypto wallet financial address.
@@ -920,7 +952,7 @@ export namespace ReturnInitiatedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * ID of the parent deposit.
@@ -1035,7 +1067,7 @@ export namespace ReturnPaidWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * ID of the parent deposit.
@@ -1150,7 +1182,7 @@ export namespace ReturnFailedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * ID of the parent deposit.
@@ -1265,7 +1297,7 @@ export namespace ReturnReturnedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * ID of the parent deposit.
@@ -1385,7 +1417,7 @@ export namespace DepositReceivedWebhookEvent {
     /**
      * Supported fiat or crypto currency code for the deposit amount.
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * ID of the merchant account that received the deposit.
@@ -1407,6 +1439,10 @@ export namespace DepositReceivedWebhookEvent {
       | 'swift'
       | 'internal'
       | 'target'
+      | 'ach'
+      | 'fedwire'
+      | 'btc'
+      | 'btc_testnet4'
       | 'eth'
       | 'eth_sepolia'
       | 'sol'
@@ -1423,7 +1459,7 @@ export namespace DepositReceivedWebhookEvent {
     /**
      * Counterparty bank account or crypto wallet that sent the funds.
      */
-    source: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2;
+    source: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
 
     /**
      * Current status of the deposit.
@@ -1492,6 +1528,28 @@ export namespace DepositReceivedWebhookEvent {
     }
 
     export interface UnionMember2 {
+      /**
+       * Name of the account holder.
+       */
+      account_holder_name: string;
+
+      /**
+       * Bank account number.
+       */
+      account_number: string;
+
+      /**
+       * ABA routing number (9 digits).
+       */
+      routing_number: string;
+
+      /**
+       * Discriminator for ABA wire source.
+       */
+      type: 'aba';
+    }
+
+    export interface UnionMember3 {
       /**
        * Wallet address on the specified blockchain.
        */
@@ -1500,7 +1558,15 @@ export namespace DepositReceivedWebhookEvent {
       /**
        * Blockchain network for the crypto wallet.
        */
-      blockchain: 'ethereum' | 'solana' | 'polygon';
+      blockchain:
+        | 'bitcoin'
+        | 'ethereum'
+        | 'solana'
+        | 'polygon'
+        | 'bitcoin_testnet4'
+        | 'ethereum_sepolia'
+        | 'solana_devnet'
+        | 'polygon_amoy';
 
       /**
        * Discriminator for crypto wallet source.
@@ -1585,7 +1651,7 @@ export namespace ConversionCreatedWebhookEvent {
     /**
      * Source currency code.
      */
-    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * Current status of the conversion.
@@ -1600,7 +1666,7 @@ export namespace ConversionCreatedWebhookEvent {
     /**
      * Target currency code.
      */
-    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * Resource type discriminator.
@@ -1701,7 +1767,7 @@ export namespace ConversionCompletedWebhookEvent {
     /**
      * Source currency code.
      */
-    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * Current status of the conversion.
@@ -1716,7 +1782,7 @@ export namespace ConversionCompletedWebhookEvent {
     /**
      * Target currency code.
      */
-    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * Resource type discriminator.
@@ -1817,7 +1883,7 @@ export namespace ConversionFailedWebhookEvent {
     /**
      * Source currency code.
      */
-    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * Current status of the conversion.
@@ -1832,7 +1898,7 @@ export namespace ConversionFailedWebhookEvent {
     /**
      * Target currency code.
      */
-    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
     /**
      * Resource type discriminator.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.12.1'; // x-release-please-version
+export const VERSION = '0.14.0'; // x-release-please-version

package/uploads.d.mts

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.mjs";
 //# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/uploads.d.ts

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.js";
 //# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,kCAA+B"}

package/uploads.mjs

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.mjs";
 //# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.12.1";
+export declare const VERSION = "0.14.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.12.1";
+export declare const VERSION = "0.14.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.12.1'; // x-release-please-version
+exports.VERSION = '0.14.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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