@augustusbank/typescript-sdk 0.15.0 → 0.17.0

package/src/resources/returns.ts

@@ -53,7 +53,7 @@ export interface ReturnCreateResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
   /**
    * ID of the parent deposit.
@@ -136,7 +136,7 @@ export interface ReturnRetrieveResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
   /**
    * ID of the parent deposit.
@@ -219,7 +219,7 @@ export interface ReturnListResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
   /**
    * ID of the parent deposit.

package/src/resources/scopes.ts

@@ -39,13 +39,13 @@ export namespace ScopeListResponse {
       | 'quotes:read'
       | 'accounts:read'
       | 'accounts:write'
-      | 'account_openings:write'
       | 'account_programs:read'
       | 'webhook_subscriptions:read'
       | 'webhook_subscriptions:write'
       | 'events:read'
       | 'webhook_deliveries:read'
-      | 'webhook_deliveries:write';
+      | 'webhook_deliveries:write'
+      | 'transactions:read';
 
     /**
      * Action category.

package/src/resources/transactions.ts

@@ -0,0 +1,405 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+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 Transactions extends APIResource {
+  /**
+   * Retrieves a transaction by ID.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<TransactionRetrieveResponse> {
+    return this._client.get(path`/v1/transactions/${id}`, options);
+  }
+
+  /**
+   * Lists transactions for an account with cursor-based pagination.
+   */
+  list(
+    query: TransactionListParams,
+    options?: RequestOptions,
+  ): PagePromise<TransactionListResponsesCursorPage, TransactionListResponse> {
+    return this._client.getAPIList('/v1/transactions', CursorPage<TransactionListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type TransactionListResponsesCursorPage = CursorPage<TransactionListResponse>;
+
+export interface TransactionRetrieveResponse {
+  /**
+   * Unique identifier of the transaction.
+   */
+  id: string;
+
+  /**
+   * ID of the merchant account this transaction settled on.
+   */
+  account_id: string;
+
+  /**
+   * Absolute amount as a string decimal (e.g. "100.50").
+   */
+  amount: string;
+
+  /**
+   * Reference visible on the bank statement, or null when not applicable.
+   */
+  bank_statement_reference: string | null;
+
+  /**
+   * Bank account or wallet of the other party, or null when not known.
+   */
+  counterparty:
+    | TransactionRetrieveResponse.UnionMember0
+    | TransactionRetrieveResponse.UnionMember1
+    | TransactionRetrieveResponse.UnionMember2
+    | TransactionRetrieveResponse.UnionMember3
+    | null;
+
+  /**
+   * ISO 8601 UTC timestamp when the transaction was recorded.
+   */
+  created_at: string;
+
+  /**
+   * ISO 4217 fiat or crypto currency code of the amount.
+   */
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+
+  /**
+   * The product that caused this transaction, or null when no product is linked.
+   */
+  product: TransactionRetrieveResponse.Product | null;
+
+  /**
+   * Direction of the movement relative to the merchant account.
+   */
+  side: 'credit' | 'debit';
+
+  /**
+   * Lifecycle state of the transaction.
+   */
+  status: 'pending' | 'completed' | 'failed';
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'transaction';
+}
+
+export namespace TransactionRetrieveResponse {
+  export interface UnionMember0 {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Bank Identifier Code, or null if not provided.
+     */
+    bic: string | null;
+
+    /**
+     * International Bank Account Number.
+     */
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
+  }
+
+  export interface UnionMember1 {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * UK account number (8 digits).
+     */
+    account_number: string;
+
+    /**
+     * UK sort code (6 digits).
+     */
+    sort_code: string;
+
+    /**
+     * Discriminator for UK sort code financial address.
+     */
+    type: 'sort_code';
+  }
+
+  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 financial address.
+     */
+    type: 'aba';
+  }
+
+  export interface UnionMember3 {
+    /**
+     * Wallet address on the specified blockchain.
+     */
+    address: string;
+
+    /**
+     * Blockchain network for the crypto wallet.
+     */
+    blockchain:
+      | 'bitcoin'
+      | 'ethereum'
+      | 'solana'
+      | 'polygon'
+      | 'bitcoin_testnet4'
+      | 'ethereum_sepolia'
+      | 'solana_devnet'
+      | 'polygon_amoy';
+
+    /**
+     * Discriminator for crypto wallet financial address.
+     */
+    type: 'crypto_wallet';
+  }
+
+  /**
+   * The product that caused this transaction, or null when no product is linked.
+   */
+  export interface Product {
+    /**
+     * Identifier of the product resource that caused this transaction.
+     */
+    id: string;
+
+    /**
+     * Type of the product that caused this transaction.
+     */
+    type: 'deposit' | 'deposit_return' | 'refund' | 'payout';
+  }
+}
+
+export interface TransactionListResponse {
+  /**
+   * Unique identifier of the transaction.
+   */
+  id: string;
+
+  /**
+   * ID of the merchant account this transaction settled on.
+   */
+  account_id: string;
+
+  /**
+   * Absolute amount as a string decimal (e.g. "100.50").
+   */
+  amount: string;
+
+  /**
+   * Reference visible on the bank statement, or null when not applicable.
+   */
+  bank_statement_reference: string | null;
+
+  /**
+   * Bank account or wallet of the other party, or null when not known.
+   */
+  counterparty:
+    | TransactionListResponse.UnionMember0
+    | TransactionListResponse.UnionMember1
+    | TransactionListResponse.UnionMember2
+    | TransactionListResponse.UnionMember3
+    | null;
+
+  /**
+   * ISO 8601 UTC timestamp when the transaction was recorded.
+   */
+  created_at: string;
+
+  /**
+   * ISO 4217 fiat or crypto currency code of the amount.
+   */
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+
+  /**
+   * The product that caused this transaction, or null when no product is linked.
+   */
+  product: TransactionListResponse.Product | null;
+
+  /**
+   * Direction of the movement relative to the merchant account.
+   */
+  side: 'credit' | 'debit';
+
+  /**
+   * Lifecycle state of the transaction.
+   */
+  status: 'pending' | 'completed' | 'failed';
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'transaction';
+}
+
+export namespace TransactionListResponse {
+  export interface UnionMember0 {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Bank Identifier Code, or null if not provided.
+     */
+    bic: string | null;
+
+    /**
+     * International Bank Account Number.
+     */
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
+  }
+
+  export interface UnionMember1 {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * UK account number (8 digits).
+     */
+    account_number: string;
+
+    /**
+     * UK sort code (6 digits).
+     */
+    sort_code: string;
+
+    /**
+     * Discriminator for UK sort code financial address.
+     */
+    type: 'sort_code';
+  }
+
+  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 financial address.
+     */
+    type: 'aba';
+  }
+
+  export interface UnionMember3 {
+    /**
+     * Wallet address on the specified blockchain.
+     */
+    address: string;
+
+    /**
+     * Blockchain network for the crypto wallet.
+     */
+    blockchain:
+      | 'bitcoin'
+      | 'ethereum'
+      | 'solana'
+      | 'polygon'
+      | 'bitcoin_testnet4'
+      | 'ethereum_sepolia'
+      | 'solana_devnet'
+      | 'polygon_amoy';
+
+    /**
+     * Discriminator for crypto wallet financial address.
+     */
+    type: 'crypto_wallet';
+  }
+
+  /**
+   * The product that caused this transaction, or null when no product is linked.
+   */
+  export interface Product {
+    /**
+     * Identifier of the product resource that caused this transaction.
+     */
+    id: string;
+
+    /**
+     * Type of the product that caused this transaction.
+     */
+    type: 'deposit' | 'deposit_return' | 'refund' | 'payout';
+  }
+}
+
+export interface TransactionListParams extends CursorPageParams {
+  /**
+   * Account to list transactions for.
+   */
+  account_id: string;
+
+  created_at?: TransactionListParams.CreatedAt;
+}
+
+export namespace TransactionListParams {
+  export interface CreatedAt {
+    /**
+     * Include transactions whose created_at is greater than or equal to this ISO 8601
+     * timestamp.
+     */
+    gte?: string;
+
+    /**
+     * Include transactions whose created_at is less than or equal to this ISO 8601
+     * timestamp.
+     */
+    lte?: string;
+  }
+}
+
+export declare namespace Transactions {
+  export {
+    type TransactionRetrieveResponse as TransactionRetrieveResponse,
+    type TransactionListResponse as TransactionListResponse,
+    type TransactionListResponsesCursorPage as TransactionListResponsesCursorPage,
+    type TransactionListParams as TransactionListParams,
+  };
+}

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' | 'BTC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * Bank account or crypto wallet the payout was sent to.
@@ -289,7 +289,7 @@ export namespace PayoutInitiatedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * Bank account or crypto wallet the payout was sent to.
@@ -510,7 +510,7 @@ export namespace PayoutPaidWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * Bank account or crypto wallet the payout was sent to.
@@ -731,7 +731,7 @@ export namespace PayoutFailedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * Bank account or crypto wallet the payout was sent to.
@@ -952,7 +952,7 @@ export namespace ReturnInitiatedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * ID of the parent deposit.
@@ -1067,7 +1067,7 @@ export namespace ReturnPaidWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * ID of the parent deposit.
@@ -1182,7 +1182,7 @@ export namespace ReturnFailedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * ID of the parent deposit.
@@ -1297,7 +1297,7 @@ export namespace ReturnReturnedWebhookEvent {
     /**
      * Currency code (ISO 4217 currency code or crypto currency code).
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * ID of the parent deposit.
@@ -1417,7 +1417,7 @@ export namespace DepositReceivedWebhookEvent {
     /**
      * Supported fiat or crypto currency code for the deposit amount.
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * ID of the merchant account that received the deposit.
@@ -1651,7 +1651,7 @@ export namespace ConversionCreatedWebhookEvent {
     /**
      * Source currency code.
      */
-    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * Current status of the conversion.
@@ -1666,7 +1666,7 @@ export namespace ConversionCreatedWebhookEvent {
     /**
      * Target currency code.
      */
-    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * Resource type discriminator.
@@ -1767,7 +1767,7 @@ export namespace ConversionCompletedWebhookEvent {
     /**
      * Source currency code.
      */
-    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * Current status of the conversion.
@@ -1782,7 +1782,7 @@ export namespace ConversionCompletedWebhookEvent {
     /**
      * Target currency code.
      */
-    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * Resource type discriminator.
@@ -1883,7 +1883,7 @@ export namespace ConversionFailedWebhookEvent {
     /**
      * Source currency code.
      */
-    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * Current status of the conversion.
@@ -1898,7 +1898,7 @@ export namespace ConversionFailedWebhookEvent {
     /**
      * Target currency code.
      */
-    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
+    target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
     /**
      * Resource type discriminator.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.15.0'; // x-release-please-version
+export const VERSION = '0.17.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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