@augustusbank/typescript-sdk 0.11.0

package/src/resources/deposits.ts

@@ -0,0 +1,364 @@
+// 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 Deposits extends APIResource {
+  /**
+   * Retrieves a deposit by ID.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<DepositRetrieveResponse> {
+    return this._client.get(path`/v1/deposits/${id}`, options);
+  }
+
+  /**
+   * Lists deposits for the merchant with cursor-based pagination.
+   */
+  list(
+    query: DepositListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DepositListResponsesCursorPage, DepositListResponse> {
+    return this._client.getAPIList('/v1/deposits', CursorPage<DepositListResponse>, { query, ...options });
+  }
+}
+
+export type DepositListResponsesCursorPage = CursorPage<DepositListResponse>;
+
+export interface DepositRetrieveResponse {
+  /**
+   * Unique identifier of the deposit.
+   */
+  id: string;
+
+  /**
+   * 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;
+
+  /**
+   * ISO 8601 UTC timestamp when the deposit was created.
+   */
+  created_at: string;
+
+  /**
+   * Supported fiat or crypto currency code for the deposit amount.
+   */
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * ID of the merchant account that received the deposit.
+   */
+  destination_account_id: string;
+
+  /**
+   * Payment rail or blockchain used for the deposit.
+   */
+  rail:
+    | 'sepa_instant'
+    | 'faster_payments'
+    | 'sepa'
+    | 'elixir'
+    | 'express_elixir'
+    | 'sek_account_to_account'
+    | 'sumclearing'
+    | 'straksclearing'
+    | 'swift'
+    | 'internal'
+    | 'target'
+    | 'eth'
+    | 'eth_sepolia'
+    | 'sol'
+    | 'sol_devnet'
+    | 'matic'
+    | 'matic_amoy'
+    | null;
+
+  /**
+   * Array of deposit return IDs associated with this deposit.
+   */
+  returns: Array<string>;
+
+  /**
+   * Counterparty bank account or crypto wallet that sent the funds.
+   */
+  source:
+    | DepositRetrieveResponse.UnionMember0
+    | DepositRetrieveResponse.UnionMember1
+    | DepositRetrieveResponse.UnionMember2;
+
+  /**
+   * Current status of the deposit.
+   */
+  status: 'received' | 'rejected' | 'in_return' | 'returned' | 'return_failed' | 'return_returned';
+
+  /**
+   * Transaction hash for crypto deposits, or null when not known.
+   */
+  tx_hash: string | null;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'deposit';
+
+  /**
+   * ISO 8601 UTC timestamp when the deposit was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace DepositRetrieveResponse {
+  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 source.
+     */
+    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 source.
+     */
+    type: 'sort_code';
+  }
+
+  export interface UnionMember2 {
+    /**
+     * Wallet address on the specified blockchain.
+     */
+    address: string;
+
+    /**
+     * Blockchain network for the crypto wallet.
+     */
+    blockchain: 'ethereum' | 'solana' | 'polygon';
+
+    /**
+     * Discriminator for crypto wallet source.
+     */
+    type: 'crypto_wallet';
+  }
+}
+
+export interface DepositListResponse {
+  /**
+   * Unique identifier of the deposit.
+   */
+  id: string;
+
+  /**
+   * 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;
+
+  /**
+   * ISO 8601 UTC timestamp when the deposit was created.
+   */
+  created_at: string;
+
+  /**
+   * Supported fiat or crypto currency code for the deposit amount.
+   */
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * ID of the merchant account that received the deposit.
+   */
+  destination_account_id: string;
+
+  /**
+   * Payment rail or blockchain used for the deposit.
+   */
+  rail:
+    | 'sepa_instant'
+    | 'faster_payments'
+    | 'sepa'
+    | 'elixir'
+    | 'express_elixir'
+    | 'sek_account_to_account'
+    | 'sumclearing'
+    | 'straksclearing'
+    | 'swift'
+    | 'internal'
+    | 'target'
+    | 'eth'
+    | 'eth_sepolia'
+    | 'sol'
+    | 'sol_devnet'
+    | 'matic'
+    | 'matic_amoy'
+    | null;
+
+  /**
+   * Array of deposit return IDs associated with this deposit.
+   */
+  returns: Array<string>;
+
+  /**
+   * Counterparty bank account or crypto wallet that sent the funds.
+   */
+  source:
+    | DepositListResponse.UnionMember0
+    | DepositListResponse.UnionMember1
+    | DepositListResponse.UnionMember2;
+
+  /**
+   * Current status of the deposit.
+   */
+  status: 'received' | 'rejected' | 'in_return' | 'returned' | 'return_failed' | 'return_returned';
+
+  /**
+   * Transaction hash for crypto deposits, or null when not known.
+   */
+  tx_hash: string | null;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'deposit';
+
+  /**
+   * ISO 8601 UTC timestamp when the deposit was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace DepositListResponse {
+  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 source.
+     */
+    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 source.
+     */
+    type: 'sort_code';
+  }
+
+  export interface UnionMember2 {
+    /**
+     * Wallet address on the specified blockchain.
+     */
+    address: string;
+
+    /**
+     * Blockchain network for the crypto wallet.
+     */
+    blockchain: 'ethereum' | 'solana' | 'polygon';
+
+    /**
+     * Discriminator for crypto wallet source.
+     */
+    type: 'crypto_wallet';
+  }
+}
+
+export interface DepositListParams extends CursorPageParams {
+  created_at?: DepositListParams.CreatedAt;
+
+  /**
+   * Filter by deposit status.
+   */
+  status?: 'received' | 'rejected' | 'in_return' | 'returned' | 'return_failed' | 'return_returned';
+}
+
+export namespace DepositListParams {
+  export interface CreatedAt {
+    /**
+     * Include deposits whose created_at is greater than or equal to this ISO 8601
+     * timestamp.
+     */
+    gte?: string;
+
+    /**
+     * Include deposits whose created_at is less than or equal to this ISO 8601
+     * timestamp.
+     */
+    lte?: string;
+  }
+}
+
+export declare namespace Deposits {
+  export {
+    type DepositRetrieveResponse as DepositRetrieveResponse,
+    type DepositListResponse as DepositListResponse,
+    type DepositListResponsesCursorPage as DepositListResponsesCursorPage,
+    type DepositListParams as DepositListParams,
+  };
+}

package/src/resources/events.ts

@@ -0,0 +1,170 @@
+// 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 Events extends APIResource {
+  /**
+   * Retrieves a webhook event by ID.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<EventRetrieveResponse> {
+    return this._client.get(path`/v1/events/${id}`, options);
+  }
+
+  /**
+   * Lists webhook events for the merchant with cursor-based pagination. Events are
+   * retained for 30 days.
+   */
+  list(
+    query: EventListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<EventListResponsesCursorPage, EventListResponse> {
+    return this._client.getAPIList('/v1/events', CursorPage<EventListResponse>, { query, ...options });
+  }
+}
+
+export type EventListResponsesCursorPage = CursorPage<EventListResponse>;
+
+export interface EventRetrieveResponse {
+  /**
+   * Unique identifier of the event. Matches the envelope `id` delivered in the
+   * webhook payload and is stable across subscription fan-out and retries.
+   */
+  id: string;
+
+  /**
+   * API version the event payload was rendered at. Stable across retries and
+   * redeliveries, and mirrored in the webhook envelope `api_version` field.
+   */
+  api_version: string;
+
+  /**
+   * ISO 8601 UTC timestamp when the event was created.
+   */
+  created_at: string;
+
+  /**
+   * Event payload. Shape matches the resource schema for `event_type`.
+   */
+  data: { [key: string]: unknown };
+
+  /**
+   * Event type.
+   */
+  event_type:
+    | 'payout.created'
+    | 'payout.initiated'
+    | 'payout.paid'
+    | 'payout.failed'
+    | 'return.initiated'
+    | 'return.paid'
+    | 'return.failed'
+    | 'return.returned'
+    | 'deposit.received'
+    | 'conversion.created'
+    | 'conversion.completed'
+    | 'conversion.failed'
+    | 'ping.test';
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'event';
+}
+
+export interface EventListResponse {
+  /**
+   * Unique identifier of the event. Matches the envelope `id` delivered in the
+   * webhook payload and is stable across subscription fan-out and retries.
+   */
+  id: string;
+
+  /**
+   * API version the event payload was rendered at. Stable across retries and
+   * redeliveries, and mirrored in the webhook envelope `api_version` field.
+   */
+  api_version: string;
+
+  /**
+   * ISO 8601 UTC timestamp when the event was created.
+   */
+  created_at: string;
+
+  /**
+   * Event payload. Shape matches the resource schema for `event_type`.
+   */
+  data: { [key: string]: unknown };
+
+  /**
+   * Event type.
+   */
+  event_type:
+    | 'payout.created'
+    | 'payout.initiated'
+    | 'payout.paid'
+    | 'payout.failed'
+    | 'return.initiated'
+    | 'return.paid'
+    | 'return.failed'
+    | 'return.returned'
+    | 'deposit.received'
+    | 'conversion.created'
+    | 'conversion.completed'
+    | 'conversion.failed'
+    | 'ping.test';
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'event';
+}
+
+export interface EventListParams extends CursorPageParams {
+  created_at?: EventListParams.CreatedAt;
+
+  /**
+   * Filter by event type.
+   */
+  event_type?:
+    | 'payout.created'
+    | 'payout.initiated'
+    | 'payout.paid'
+    | 'payout.failed'
+    | 'return.initiated'
+    | 'return.paid'
+    | 'return.failed'
+    | 'return.returned'
+    | 'deposit.received'
+    | 'conversion.created'
+    | 'conversion.completed'
+    | 'conversion.failed'
+    | 'ping.test';
+}
+
+export namespace EventListParams {
+  export interface CreatedAt {
+    /**
+     * Include events whose created_at is greater than or equal to this ISO 8601
+     * timestamp.
+     */
+    gte?: string;
+
+    /**
+     * Include events whose created_at is less than or equal to this ISO 8601
+     * timestamp.
+     */
+    lte?: string;
+  }
+}
+
+export declare namespace Events {
+  export {
+    type EventRetrieveResponse as EventRetrieveResponse,
+    type EventListResponse as EventListResponse,
+    type EventListResponsesCursorPage as EventListResponsesCursorPage,
+    type EventListParams as EventListParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,99 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { APIKeys, type APIKeyIntrospectResponse } from './api-keys';
+export { APIVersions, type APIVersionListResponse } from './api-versions';
+export {
+  AccountPrograms,
+  type AccountProgramRetrieveResponse,
+  type AccountProgramListResponse,
+  type AccountProgramRetrieveBalanceResponse,
+  type AccountProgramListParams,
+  type AccountProgramListResponsesCursorPage,
+} from './account-programs';
+export {
+  Accounts,
+  type AccountCreateResponse,
+  type AccountRetrieveResponse,
+  type AccountListResponse,
+  type AccountCloseResponse,
+  type AccountFreezeResponse,
+  type AccountRetrieveBalanceResponse,
+  type AccountUnfreezeResponse,
+  type AccountCreateParams,
+  type AccountListParams,
+  type AccountCloseParams,
+  type AccountListResponsesCursorPage,
+} from './accounts';
+export {
+  Conversions,
+  type ConversionCreateResponse,
+  type ConversionRetrieveResponse,
+  type ConversionListResponse,
+  type ConversionCreateParams,
+  type ConversionListParams,
+  type ConversionListResponsesCursorPage,
+} from './conversions';
+export {
+  Deposits,
+  type DepositRetrieveResponse,
+  type DepositListResponse,
+  type DepositListParams,
+  type DepositListResponsesCursorPage,
+} from './deposits';
+export {
+  Events,
+  type EventRetrieveResponse,
+  type EventListResponse,
+  type EventListParams,
+  type EventListResponsesCursorPage,
+} from './events';
+export {
+  Payouts,
+  type PayoutCreateResponse,
+  type PayoutRetrieveResponse,
+  type PayoutListResponse,
+  type PayoutCreateParams,
+  type PayoutListParams,
+  type PayoutListResponsesCursorPage,
+} from './payouts';
+export { Quotes, type QuoteRetrieveResponse } from './quotes/quotes';
+export { Returns, type ReturnRetrieveResponse } from './returns';
+export { Scopes, type ScopeListResponse } from './scopes';
+export {
+  WebhookDeliveries,
+  type WebhookDeliveryRetrieveResponse,
+  type WebhookDeliveryListResponse,
+  type WebhookDeliveryRedeliverResponse,
+  type WebhookDeliveryListParams,
+  type WebhookDeliveryListResponsesCursorPage,
+} from './webhook-deliveries';
+export {
+  WebhookSubscriptions,
+  type WebhookSubscriptionCreateResponse,
+  type WebhookSubscriptionRetrieveResponse,
+  type WebhookSubscriptionUpdateResponse,
+  type WebhookSubscriptionListResponse,
+  type WebhookSubscriptionDeleteResponse,
+  type WebhookSubscriptionSendTestEventResponse,
+  type WebhookSubscriptionCreateParams,
+  type WebhookSubscriptionUpdateParams,
+  type WebhookSubscriptionListParams,
+  type WebhookSubscriptionListResponsesCursorPage,
+} from './webhook-subscriptions';
+export {
+  Webhooks,
+  type PayoutCreatedWebhookEvent,
+  type PayoutInitiatedWebhookEvent,
+  type PayoutPaidWebhookEvent,
+  type PayoutFailedWebhookEvent,
+  type ReturnInitiatedWebhookEvent,
+  type ReturnPaidWebhookEvent,
+  type ReturnFailedWebhookEvent,
+  type ReturnReturnedWebhookEvent,
+  type DepositReceivedWebhookEvent,
+  type ConversionCreatedWebhookEvent,
+  type ConversionCompletedWebhookEvent,
+  type ConversionFailedWebhookEvent,
+  type PingTestWebhookEvent,
+  type UnwrapWebhookEvent,
+} from './webhooks';