@augustusbank/typescript-sdk 0.11.0

package/src/resources/quotes/indicative.ts

@@ -0,0 +1,100 @@
+// 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 Indicative extends APIResource {
+  /**
+   * Returns an indicative quote for a currency pair. Not persisted or holdable.
+   */
+  retrieve(
+    query: IndicativeRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<IndicativeRetrieveResponse> {
+    return this._client.get('/v1/quotes/indicative', { query, ...options });
+  }
+}
+
+export interface IndicativeRetrieveResponse {
+  /**
+   * Conversion fee, or null if no fee applies.
+   */
+  fee: IndicativeRetrieveResponse.Fee | null;
+
+  /**
+   * ISO 8601 UTC timestamp when the quote was fetched.
+   */
+  quoted_at: string;
+
+  /**
+   * Conversion rate applied.
+   */
+  rate: string;
+
+  /**
+   * Source amount as a string decimal.
+   */
+  source_amount: string;
+
+  /**
+   * Source currency code.
+   */
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Target amount as a string decimal.
+   */
+  target_amount: string;
+
+  /**
+   * Target currency code.
+   */
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Venue the quote was fetched from.
+   */
+  venue: string;
+}
+
+export namespace IndicativeRetrieveResponse {
+  /**
+   * Conversion fee, or null if no fee applies.
+   */
+  export interface Fee {
+    /**
+     * Fee amount as a string decimal.
+     */
+    amount: string;
+
+    /**
+     * Fee currency code.
+     */
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  }
+}
+
+export interface IndicativeRetrieveParams {
+  /**
+   * Source currency code.
+   */
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Target currency code.
+   */
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Source amount as a string decimal. Defaults to 1 unit if omitted.
+   */
+  source_amount?: string;
+}
+
+export declare namespace Indicative {
+  export {
+    type IndicativeRetrieveResponse as IndicativeRetrieveResponse,
+    type IndicativeRetrieveParams as IndicativeRetrieveParams,
+  };
+}

package/src/resources/quotes/quotes.ts

@@ -0,0 +1,108 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as IndicativeAPI from './indicative';
+import { Indicative, IndicativeRetrieveParams, IndicativeRetrieveResponse } from './indicative';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Quotes extends APIResource {
+  indicative: IndicativeAPI.Indicative = new IndicativeAPI.Indicative(this._client);
+
+  /**
+   * Retrieves a persisted quote by ID.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<QuoteRetrieveResponse> {
+    return this._client.get(path`/v1/quotes/${id}`, options);
+  }
+}
+
+export interface QuoteRetrieveResponse {
+  /**
+   * Unique identifier of the quote.
+   */
+  id: string;
+
+  /**
+   * ISO 8601 UTC timestamp when the quote was created.
+   */
+  created_at: string;
+
+  /**
+   * Exchange rate applied.
+   */
+  exchange_rate: string;
+
+  /**
+   * ISO 8601 UTC timestamp when the quote expires.
+   */
+  expires_at: string;
+
+  /**
+   * Current funding status of the quote.
+   */
+  funding_status: 'pending' | 'sent' | 'completed' | 'failed' | 'on_hold';
+
+  /**
+   * Source amount as a string decimal.
+   */
+  source_amount: string;
+
+  /**
+   * Source currency code.
+   */
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Current status of the quote.
+   */
+  status:
+    | 'pending'
+    | 'quote_accepted'
+    | 'order_pending'
+    | 'order_failed'
+    | 'order_completed'
+    | 'withdrawal_pending'
+    | 'withdrawal_failed'
+    | 'withdrawal_completed'
+    | 'completed'
+    | 'failed';
+
+  /**
+   * Target amount as a string decimal.
+   */
+  target_amount: string;
+
+  /**
+   * Target currency code.
+   */
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'quote';
+
+  /**
+   * ISO 8601 UTC timestamp when the quote was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * Execution venue (e.g. "kraken").
+   */
+  venue: string;
+}
+
+Quotes.Indicative = Indicative;
+
+export declare namespace Quotes {
+  export { type QuoteRetrieveResponse as QuoteRetrieveResponse };
+
+  export {
+    Indicative as Indicative,
+    type IndicativeRetrieveResponse as IndicativeRetrieveResponse,
+    type IndicativeRetrieveParams as IndicativeRetrieveParams,
+  };
+}

package/src/resources/quotes.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './quotes/index';

package/src/resources/returns.ts

@@ -0,0 +1,102 @@
+// 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';
+import { path } from '../internal/utils/path';
+
+export class Returns extends APIResource {
+  /**
+   * Retrieves a return by ID.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<ReturnRetrieveResponse> {
+    return this._client.get(path`/v1/returns/${id}`, options);
+  }
+}
+
+export interface ReturnRetrieveResponse {
+  /**
+   * 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';
+
+  /**
+   * ID of the parent deposit.
+   */
+  deposit_id: string;
+
+  /**
+   * Failure details when status is failed, otherwise null.
+   */
+  failure: ReturnRetrieveResponse.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 ReturnRetrieveResponse {
+  /**
+   * 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 declare namespace Returns {
+  export { type ReturnRetrieveResponse as ReturnRetrieveResponse };
+}

package/src/resources/scopes.ts

@@ -0,0 +1,80 @@
+// 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 Scopes extends APIResource {
+  /**
+   * Returns the catalogue of scopes available to API keys. The list is filtered by
+   * the `Api-Version` request header and defaults to the latest version when the
+   * header is omitted. Public: no authentication required.
+   */
+  list(options?: RequestOptions): APIPromise<ScopeListResponse> {
+    return this._client.get('/v1/scopes', options);
+  }
+}
+
+export interface ScopeListResponse {
+  data: Array<ScopeListResponse.Data>;
+
+  has_more: boolean;
+
+  next_cursor: string | null;
+}
+
+export namespace ScopeListResponse {
+  export interface Data {
+    /**
+     * Scope identifier in `resource:action` format.
+     */
+    id:
+      | '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';
+
+    /**
+     * Action category.
+     */
+    action: 'read' | 'write';
+
+    /**
+     * First API version that exposes this scope.
+     */
+    available_from: string;
+
+    /**
+     * API version in which this scope was deprecated; null if not deprecated.
+     */
+    deprecated_in: string | null;
+
+    /**
+     * Human-readable description of the scope.
+     */
+    description: string;
+
+    /**
+     * Resource the scope applies to.
+     */
+    resource: string;
+
+    type: 'scope';
+  }
+}
+
+export declare namespace Scopes {
+  export { type ScopeListResponse as ScopeListResponse };
+}

package/src/resources/webhook-deliveries.ts

@@ -0,0 +1,267 @@
+// 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 WebhookDeliveries extends APIResource {
+  /**
+   * Retrieves a webhook delivery by ID.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<WebhookDeliveryRetrieveResponse> {
+    return this._client.get(path`/v1/webhook_deliveries/${id}`, options);
+  }
+
+  /**
+   * Lists webhook deliveries for the merchant with cursor-based pagination.
+   * Deliveries are retained for 30 days.
+   */
+  list(
+    query: WebhookDeliveryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<WebhookDeliveryListResponsesCursorPage, WebhookDeliveryListResponse> {
+    return this._client.getAPIList('/v1/webhook_deliveries', CursorPage<WebhookDeliveryListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Triggers a fresh delivery attempt of the event to the same webhook subscription.
+   */
+  redeliver(id: string, options?: RequestOptions): APIPromise<WebhookDeliveryRedeliverResponse> {
+    return this._client.post(path`/v1/webhook_deliveries/${id}/redeliver`, options);
+  }
+}
+
+export type WebhookDeliveryListResponsesCursorPage = CursorPage<WebhookDeliveryListResponse>;
+
+export interface WebhookDeliveryRetrieveResponse {
+  /**
+   * Unique identifier of the webhook delivery.
+   */
+  id: string;
+
+  /**
+   * Ordered list of HTTP delivery attempts for this delivery.
+   */
+  attempts: Array<WebhookDeliveryRetrieveResponse.Attempt>;
+
+  /**
+   * ISO 8601 UTC timestamp when the delivery was created.
+   */
+  created_at: string;
+
+  /**
+   * Identifier of the event this delivery was for.
+   */
+  event_id: string;
+
+  /**
+   * Current status of the delivery.
+   */
+  status: 'pending' | 'delivered' | 'failed' | 'processing' | 'ignored';
+
+  /**
+   * Identifier of the webhook subscription this delivery targeted.
+   */
+  subscription_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'webhook_delivery';
+
+  /**
+   * ISO 8601 UTC timestamp when the delivery was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace WebhookDeliveryRetrieveResponse {
+  export interface Attempt {
+    /**
+     * ISO 8601 UTC timestamp when this attempt resolved.
+     */
+    attempted_at: string;
+
+    /**
+     * Current status of the delivery.
+     */
+    status: 'pending' | 'delivered' | 'failed' | 'processing' | 'ignored';
+
+    /**
+     * HTTP status code returned by the receiver for this attempt.
+     */
+    status_code: number;
+  }
+}
+
+export interface WebhookDeliveryListResponse {
+  /**
+   * Unique identifier of the webhook delivery.
+   */
+  id: string;
+
+  /**
+   * Ordered list of HTTP delivery attempts for this delivery.
+   */
+  attempts: Array<WebhookDeliveryListResponse.Attempt>;
+
+  /**
+   * ISO 8601 UTC timestamp when the delivery was created.
+   */
+  created_at: string;
+
+  /**
+   * Identifier of the event this delivery was for.
+   */
+  event_id: string;
+
+  /**
+   * Current status of the delivery.
+   */
+  status: 'pending' | 'delivered' | 'failed' | 'processing' | 'ignored';
+
+  /**
+   * Identifier of the webhook subscription this delivery targeted.
+   */
+  subscription_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'webhook_delivery';
+
+  /**
+   * ISO 8601 UTC timestamp when the delivery was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace WebhookDeliveryListResponse {
+  export interface Attempt {
+    /**
+     * ISO 8601 UTC timestamp when this attempt resolved.
+     */
+    attempted_at: string;
+
+    /**
+     * Current status of the delivery.
+     */
+    status: 'pending' | 'delivered' | 'failed' | 'processing' | 'ignored';
+
+    /**
+     * HTTP status code returned by the receiver for this attempt.
+     */
+    status_code: number;
+  }
+}
+
+export interface WebhookDeliveryRedeliverResponse {
+  /**
+   * Unique identifier of the webhook delivery.
+   */
+  id: string;
+
+  /**
+   * Ordered list of HTTP delivery attempts for this delivery.
+   */
+  attempts: Array<WebhookDeliveryRedeliverResponse.Attempt>;
+
+  /**
+   * ISO 8601 UTC timestamp when the delivery was created.
+   */
+  created_at: string;
+
+  /**
+   * Identifier of the event this delivery was for.
+   */
+  event_id: string;
+
+  /**
+   * Current status of the delivery.
+   */
+  status: 'pending' | 'delivered' | 'failed' | 'processing' | 'ignored';
+
+  /**
+   * Identifier of the webhook subscription this delivery targeted.
+   */
+  subscription_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'webhook_delivery';
+
+  /**
+   * ISO 8601 UTC timestamp when the delivery was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace WebhookDeliveryRedeliverResponse {
+  export interface Attempt {
+    /**
+     * ISO 8601 UTC timestamp when this attempt resolved.
+     */
+    attempted_at: string;
+
+    /**
+     * Current status of the delivery.
+     */
+    status: 'pending' | 'delivered' | 'failed' | 'processing' | 'ignored';
+
+    /**
+     * HTTP status code returned by the receiver for this attempt.
+     */
+    status_code: number;
+  }
+}
+
+export interface WebhookDeliveryListParams extends CursorPageParams {
+  created_at?: WebhookDeliveryListParams.CreatedAt;
+
+  /**
+   * Filter by event ID.
+   */
+  event_id?: string;
+
+  /**
+   * Filter by delivery status.
+   */
+  status?: 'pending' | 'delivered' | 'failed' | 'processing' | 'ignored';
+
+  /**
+   * Filter by webhook subscription ID.
+   */
+  subscription_id?: string;
+}
+
+export namespace WebhookDeliveryListParams {
+  export interface CreatedAt {
+    /**
+     * Include deliveries whose created_at is greater than or equal to this ISO 8601
+     * timestamp.
+     */
+    gte?: string;
+
+    /**
+     * Include deliveries whose created_at is less than or equal to this ISO 8601
+     * timestamp.
+     */
+    lte?: string;
+  }
+}
+
+export declare namespace WebhookDeliveries {
+  export {
+    type WebhookDeliveryRetrieveResponse as WebhookDeliveryRetrieveResponse,
+    type WebhookDeliveryListResponse as WebhookDeliveryListResponse,
+    type WebhookDeliveryRedeliverResponse as WebhookDeliveryRedeliverResponse,
+    type WebhookDeliveryListResponsesCursorPage as WebhookDeliveryListResponsesCursorPage,
+    type WebhookDeliveryListParams as WebhookDeliveryListParams,
+  };
+}