@augustusbank/typescript-sdk 0.16.0 → 0.17.0

package/resources/transactions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.mjs","sourceRoot":"","sources":["../src/resources/transactions.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,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,UAAmC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/client.ts

@@ -85,6 +85,13 @@ import {
   Returns,
 } from './resources/returns';
 import { ScopeListResponse, Scopes } from './resources/scopes';
+import {
+  TransactionListParams,
+  TransactionListResponse,
+  TransactionListResponsesCursorPage,
+  TransactionRetrieveResponse,
+  Transactions,
+} from './resources/transactions';
 import {
   WebhookDeliveries,
   WebhookDeliveryListParams,
@@ -916,6 +923,7 @@ export class Augustus {
   webhooks: API.Webhooks = new API.Webhooks(this);
   payouts: API.Payouts = new API.Payouts(this);
   deposits: API.Deposits = new API.Deposits(this);
+  transactions: API.Transactions = new API.Transactions(this);
   conversions: API.Conversions = new API.Conversions(this);
   quotes: API.Quotes = new API.Quotes(this);
   accounts: API.Accounts = new API.Accounts(this);
@@ -932,6 +940,7 @@ export class Augustus {
 Augustus.Webhooks = Webhooks;
 Augustus.Payouts = Payouts;
 Augustus.Deposits = Deposits;
+Augustus.Transactions = Transactions;
 Augustus.Conversions = Conversions;
 Augustus.Quotes = Quotes;
 Augustus.Accounts = Accounts;
@@ -986,6 +995,14 @@ export declare namespace Augustus {
     type DepositListParams as DepositListParams,
   };
 
+  export {
+    Transactions as Transactions,
+    type TransactionRetrieveResponse as TransactionRetrieveResponse,
+    type TransactionListResponse as TransactionListResponse,
+    type TransactionListResponsesCursorPage as TransactionListResponsesCursorPage,
+    type TransactionListParams as TransactionListParams,
+  };
+
   export {
     Conversions as Conversions,
     type ConversionCreateResponse as ConversionCreateResponse,

package/src/resources/api-keys.ts

@@ -70,6 +70,7 @@ export interface APIKeyIntrospectResponse {
     | 'events:read'
     | 'webhook_deliveries:read'
     | 'webhook_deliveries:write'
+    | 'transactions:read'
   >;
 
   /**

package/src/resources/index.ts

@@ -67,6 +67,13 @@ export {
   type ReturnListResponsesCursorPage,
 } from './returns';
 export { Scopes, type ScopeListResponse } from './scopes';
+export {
+  Transactions,
+  type TransactionRetrieveResponse,
+  type TransactionListResponse,
+  type TransactionListParams,
+  type TransactionListResponsesCursorPage,
+} from './transactions';
 export {
   WebhookDeliveries,
   type WebhookDeliveryRetrieveResponse,

package/src/resources/scopes.ts

@@ -44,7 +44,8 @@ export namespace ScopeListResponse {
       | '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/version.ts

@@ -1 +1 @@
-export const VERSION = '0.16.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.16.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.16.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.16.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.16.0'; // x-release-please-version
+export const VERSION = '0.17.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map