@augustusbank/typescript-sdk 0.11.0

package/src/resources/api-keys.ts

@@ -0,0 +1,89 @@
+// 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 { RequestOptions } from '../internal/request-options';
+
+export class APIKeys extends APIResource {
+  /**
+   * Returns the API key resource for the key authenticating this request. Useful for
+   * verifying which key is in use and discovering its current authorization context
+   * without inferring it from rejected requests.
+   */
+  introspect(options?: RequestOptions): APIPromise<APIKeyIntrospectResponse> {
+    return this._client.get('/v1/api_key', options);
+  }
+}
+
+export interface APIKeyIntrospectResponse {
+  /**
+   * Unique identifier of the API key.
+   */
+  id: string;
+
+  /**
+   * Effective API version for the request (header value or merchant pin).
+   */
+  api_version: string;
+
+  /**
+   * ISO 8601 UTC timestamp at which this key was created.
+   */
+  created_at: string;
+
+  /**
+   * ISO 8601 UTC timestamp at which this key expires. `null` if the key has no
+   * expiry.
+   */
+  expires_at: string | null;
+
+  /**
+   * IP addresses or CIDR ranges this key is permitted to authenticate from. An empty
+   * array means the key is not IP-restricted.
+   */
+  ip_allow_list: Array<string>;
+
+  /**
+   * Identifier of the merchant the key belongs to.
+   */
+  merchant_id: string;
+
+  /**
+   * The effective set of scopes for this key. Stored aliases (e.g. `full_access`,
+   * `read_only`) are always expanded to concrete `resource:action` scopes against
+   * the current registry before they appear here.
+   */
+  scopes: Array<
+    | 'payouts:read'
+    | 'payouts:write'
+    | 'deposits:read'
+    | 'returns:read'
+    | 'returns:write'
+    | 'conversions:read'
+    | 'conversions:write'
+    | 'quotes:read'
+    | 'accounts:read'
+    | 'accounts:write'
+    | 'account_programs:read'
+    | 'webhook_subscriptions:read'
+    | 'webhook_subscriptions:write'
+    | 'events:read'
+    | 'webhook_deliveries:read'
+    | 'webhook_deliveries:write'
+  >;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'api_key';
+
+  /**
+   * ISO 8601 UTC timestamp of the last update to this key (e.g. roll, IP allowlist
+   * change, revoke). `null` if the key has not been updated since creation.
+   */
+  updated_at: string | null;
+}
+
+export declare namespace APIKeys {
+  export { type APIKeyIntrospectResponse as APIKeyIntrospectResponse };
+}

package/src/resources/api-versions.ts

@@ -0,0 +1,61 @@
+// 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 { RequestOptions } from '../internal/request-options';
+
+export class APIVersions extends APIResource {
+  /**
+   * Returns the catalogue of publicly available Augustus Banking API versions,
+   * ordered oldest to newest. New accounts and unpinned merchants resolve to the
+   * entry with `is_latest: true`. Public: no authentication required.
+   */
+  list(options?: RequestOptions): APIPromise<APIVersionListResponse> {
+    return this._client.get('/v1/api_versions', options);
+  }
+}
+
+export interface APIVersionListResponse {
+  data: Array<APIVersionListResponse.Data>;
+
+  has_more: boolean;
+
+  next_cursor: string | null;
+}
+
+export namespace APIVersionListResponse {
+  export interface Data {
+    /**
+     * When this version was marked deprecated, ISO 8601 UTC. Null if not deprecated.
+     */
+    deprecated_at: string | null;
+
+    /**
+     * True for the most recently published version. New accounts and unpinned
+     * merchants resolve to this version.
+     */
+    is_latest: boolean;
+
+    /**
+     * Version identifier as sent in the `api-version` request header.
+     */
+    name: string;
+
+    /**
+     * When this version became publicly available, ISO 8601 UTC.
+     */
+    released_at: string;
+
+    /**
+     * When this version will stop being served, ISO 8601 UTC. Null if no sunset is
+     * scheduled.
+     */
+    sunset_at: string | null;
+
+    type: 'api_version';
+  }
+}
+
+export declare namespace APIVersions {
+  export { type APIVersionListResponse as APIVersionListResponse };
+}

package/src/resources/conversions.ts

@@ -0,0 +1,340 @@
+// 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 Conversions extends APIResource {
+  /**
+   * Creates and executes a conversion.
+   */
+  create(body: ConversionCreateParams, options?: RequestOptions): APIPromise<ConversionCreateResponse> {
+    return this._client.post('/v1/conversions', { body, ...options });
+  }
+
+  /**
+   * Retrieves a conversion by ID.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<ConversionRetrieveResponse> {
+    return this._client.get(path`/v1/conversions/${id}`, options);
+  }
+
+  /**
+   * Returns a paginated list of conversions.
+   */
+  list(
+    query: ConversionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ConversionListResponsesCursorPage, ConversionListResponse> {
+    return this._client.getAPIList('/v1/conversions', CursorPage<ConversionListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type ConversionListResponsesCursorPage = CursorPage<ConversionListResponse>;
+
+export interface ConversionCreateResponse {
+  /**
+   * Unique identifier of the conversion.
+   */
+  id: string;
+
+  /**
+   * ISO 8601 UTC timestamp when the conversion completed, or null.
+   */
+  completed_at: string | null;
+
+  /**
+   * ISO 8601 UTC timestamp when the conversion was created.
+   */
+  created_at: string;
+
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  failure: ConversionCreateResponse.Failure | null;
+
+  /**
+   * Key-value pairs stored with the conversion.
+   */
+  metadata: { [key: string]: string };
+
+  /**
+   * ID of the associated quote, or null.
+   */
+  quote_id: string | null;
+
+  /**
+   * ID of the source account, or null.
+   */
+  source_account_id: string | null;
+
+  /**
+   * Source amount as a string decimal.
+   */
+  source_amount: string;
+
+  /**
+   * Source currency code.
+   */
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Current status of the conversion.
+   */
+  status: 'pending' | 'completed' | 'failed';
+
+  /**
+   * ID of the target account, or null.
+   */
+  target_account_id: string | null;
+
+  /**
+   * Target currency code.
+   */
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'conversion';
+
+  /**
+   * ISO 8601 UTC timestamp when the conversion was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace ConversionCreateResponse {
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  export interface Failure {
+    /**
+     * Human-readable description of the failure.
+     */
+    message: string;
+  }
+}
+
+export interface ConversionRetrieveResponse {
+  /**
+   * Unique identifier of the conversion.
+   */
+  id: string;
+
+  /**
+   * ISO 8601 UTC timestamp when the conversion completed, or null.
+   */
+  completed_at: string | null;
+
+  /**
+   * ISO 8601 UTC timestamp when the conversion was created.
+   */
+  created_at: string;
+
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  failure: ConversionRetrieveResponse.Failure | null;
+
+  /**
+   * Key-value pairs stored with the conversion.
+   */
+  metadata: { [key: string]: string };
+
+  /**
+   * ID of the associated quote, or null.
+   */
+  quote_id: string | null;
+
+  /**
+   * ID of the source account, or null.
+   */
+  source_account_id: string | null;
+
+  /**
+   * Source amount as a string decimal.
+   */
+  source_amount: string;
+
+  /**
+   * Source currency code.
+   */
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Current status of the conversion.
+   */
+  status: 'pending' | 'completed' | 'failed';
+
+  /**
+   * ID of the target account, or null.
+   */
+  target_account_id: string | null;
+
+  /**
+   * Target currency code.
+   */
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'conversion';
+
+  /**
+   * ISO 8601 UTC timestamp when the conversion was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace ConversionRetrieveResponse {
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  export interface Failure {
+    /**
+     * Human-readable description of the failure.
+     */
+    message: string;
+  }
+}
+
+export interface ConversionListResponse {
+  /**
+   * Unique identifier of the conversion.
+   */
+  id: string;
+
+  /**
+   * ISO 8601 UTC timestamp when the conversion completed, or null.
+   */
+  completed_at: string | null;
+
+  /**
+   * ISO 8601 UTC timestamp when the conversion was created.
+   */
+  created_at: string;
+
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  failure: ConversionListResponse.Failure | null;
+
+  /**
+   * Key-value pairs stored with the conversion.
+   */
+  metadata: { [key: string]: string };
+
+  /**
+   * ID of the associated quote, or null.
+   */
+  quote_id: string | null;
+
+  /**
+   * ID of the source account, or null.
+   */
+  source_account_id: string | null;
+
+  /**
+   * Source amount as a string decimal.
+   */
+  source_amount: string;
+
+  /**
+   * Source currency code.
+   */
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Current status of the conversion.
+   */
+  status: 'pending' | 'completed' | 'failed';
+
+  /**
+   * ID of the target account, or null.
+   */
+  target_account_id: string | null;
+
+  /**
+   * Target currency code.
+   */
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'conversion';
+
+  /**
+   * ISO 8601 UTC timestamp when the conversion was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace ConversionListResponse {
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  export interface Failure {
+    /**
+     * Human-readable description of the failure.
+     */
+    message: string;
+  }
+}
+
+export interface ConversionCreateParams {
+  /**
+   * ID of the source account to debit.
+   */
+  source_account_id: string;
+
+  /**
+   * Amount to convert as a string decimal (e.g. "100.50").
+   */
+  source_amount: string;
+
+  /**
+   * ID of the target account to credit.
+   */
+  target_account_id: string;
+
+  /**
+   * Key-value pairs stored with the conversion.
+   */
+  metadata?: { [key: string]: string };
+}
+
+export interface ConversionListParams extends CursorPageParams {
+  /**
+   * Filter by source currency code.
+   */
+  source_currency?: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Filter by conversion status.
+   */
+  status?: 'pending' | 'completed' | 'failed';
+
+  /**
+   * Filter by target currency code.
+   */
+  target_currency?: 'EUR' | 'GBP' | 'USD' | 'USDC';
+}
+
+export declare namespace Conversions {
+  export {
+    type ConversionCreateResponse as ConversionCreateResponse,
+    type ConversionRetrieveResponse as ConversionRetrieveResponse,
+    type ConversionListResponse as ConversionListResponse,
+    type ConversionListResponsesCursorPage as ConversionListResponsesCursorPage,
+    type ConversionCreateParams as ConversionCreateParams,
+    type ConversionListParams as ConversionListParams,
+  };
+}