@stableops/api-sdk 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,247 @@
+type StableOpsEnvironment = 'sandbox' | 'live';
+type RetryOptions = {
+    maxRetries?: number;
+    baseDelayMs?: number;
+    maxDelayMs?: number;
+};
+type ClientOptions = {
+    apiKey?: string;
+    baseUrl?: string;
+    organizationSlug?: string;
+    environment?: StableOpsEnvironment;
+    fetch?: typeof fetch;
+    timeoutMs?: number;
+    retry?: RetryOptions;
+    _sleep?: (ms: number) => Promise<void>;
+    _random?: () => number;
+};
+type RequestInit = {
+    method: 'GET' | 'POST' | 'PATCH' | 'DELETE';
+    path: string;
+    body?: unknown;
+    query?: Record<string, string | number | undefined>;
+    idempotencyKey?: string;
+    retryable?: boolean;
+};
+declare class StableOpsError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly details: unknown;
+    constructor(status: number, code: string, message: string, details: unknown);
+}
+declare class HttpClient {
+    private readonly baseUrl;
+    private readonly headers;
+    private readonly fetchImpl;
+    private readonly timeoutMs;
+    private readonly maxRetries;
+    private readonly backoff;
+    private readonly sleep;
+    private readonly random;
+    constructor(options: ClientOptions);
+    request<T>(init: RequestInit): Promise<T>;
+}
+
+type ChainId = 'ethereum' | 'base' | 'base-sepolia' | 'arbitrum' | 'polygon' | 'tron' | 'solana' | 'ethereum-sepolia' | 'arbitrum-sepolia' | 'polygon-amoy' | 'solana-devnet' | 'tron-nile';
+type Asset = 'USDC' | 'USDT';
+type PaymentOrderStatus = 'created' | 'detected' | 'confirmed' | 'finalized' | 'reverted' | 'expired' | 'canceled';
+type PaymentOrderScenario = 'saas_subscription' | 'trading_deposit' | 'agent_workflow' | 'generic';
+type AcceptedAssetInput = {
+    chain: ChainId;
+    asset: Asset;
+};
+type WebhookEventType = 'payment_order.created' | 'payment.detected' | 'payment.confirmed' | 'payment.finalized' | 'payment.reverted' | 'payment.expired' | 'address.pool.low' | 'webhook.delivery.failed' | 'agent.action.requested' | 'agent.action.approved' | 'agent.action.executed';
+type WebhookDeliveryStatus = 'pending' | 'succeeded' | 'failed' | 'dead_letter';
+type CreatePaymentOrderInput = {
+    merchantOrderId: string;
+    amount: string;
+    amountMode?: 'exact' | 'auto';
+    settlementAsset: Asset;
+    acceptedAssets: AcceptedAssetInput[];
+    scenario?: PaymentOrderScenario;
+    expiresAt?: string;
+    metadata?: Record<string, unknown>;
+};
+type PaymentOrderInstruction = {
+    chain: ChainId;
+    asset: Asset;
+    address: string;
+};
+type PaymentOrder = {
+    id: string;
+    merchantOrderId: string;
+    scenario: PaymentOrderScenario;
+    amount: string;
+    requestedAmount: string;
+    settlementAsset: Asset;
+    status: PaymentOrderStatus;
+    expiresAt: string | null;
+    metadata: unknown;
+    createdAt: string;
+    acceptedAssets?: AcceptedAssetInput[];
+    paymentInstructions: PaymentOrderInstruction[];
+};
+type PaymentOrderTimelineEntry = {
+    from: PaymentOrderStatus | null;
+    to: PaymentOrderStatus;
+    reason: string | null;
+    at: string;
+};
+type PaymentOrderDetail = PaymentOrder & {
+    timeline: PaymentOrderTimelineEntry[];
+};
+type NormalizedEvent = {
+    id: string;
+    chain: ChainId;
+    asset: Asset;
+    fromAddress: string;
+    toAddress: string;
+    amount: string;
+    txHash: string;
+    logIndex: number;
+    blockNumber: string;
+    paymentOrderId: string | null;
+    confirmations: number;
+    detectedAt: string;
+};
+type RawChainEvent = {
+    id: string;
+    source: string;
+    blockHash: string | null;
+    receivedAt: string;
+    payload: unknown;
+};
+type EventPaymentOrderSummary = {
+    id: string;
+    merchantOrderId: string;
+    status: PaymentOrderStatus;
+    settlementAsset: Asset;
+    amount: string;
+};
+type EventWebhookDelivery = {
+    id: string;
+    webhookEndpointId: string;
+    eventType: WebhookEventType;
+    status: WebhookDeliveryStatus;
+    attempts: number;
+    responseStatus: number | null;
+    errorMessage: string | null;
+    lastAttemptAt: string | null;
+    createdAt: string;
+};
+type NormalizedEventDetail = NormalizedEvent & {
+    rawChainEvent: RawChainEvent;
+    paymentOrder: EventPaymentOrderSummary | null;
+    deliveries: EventWebhookDelivery[];
+};
+type WebhookEndpoint = {
+    id: string;
+    url: string;
+    description: string | null;
+    enabledEvents: WebhookEventType[];
+    redactMetadata: boolean;
+    disabledAt: string | null;
+    createdAt: string;
+    secret?: string;
+};
+type CreateWebhookEndpointInput = {
+    url: string;
+    description?: string;
+    enabledEvents?: WebhookEventType[];
+    redactMetadata?: boolean;
+};
+type UpdateWebhookEndpointInput = {
+    description?: string | null;
+    enabledEvents?: WebhookEventType[];
+    redactMetadata?: boolean;
+};
+type WebhookDelivery = {
+    id: string;
+    webhookEndpointId: string;
+    eventId: string;
+    eventType: WebhookEventType;
+    paymentOrderId: string | null;
+    status: WebhookDeliveryStatus;
+    attempts: number;
+    responseStatus: number | null;
+    responseDurationMs: number | null;
+    errorMessage: string | null;
+    nextRetryAt: string | null;
+    lastAttemptAt: string | null;
+    succeededAt: string | null;
+    deadLetteredAt: string | null;
+    createdAt: string;
+};
+type ReplayDeliveryResult = {
+    deliveryId: string;
+};
+type ReplayDeadLettersInput = {
+    endpointId?: string;
+    limit?: number;
+};
+type ReplayDeadLettersResult = {
+    replayed: number;
+    items: {
+        originalId: string;
+        deliveryId: string;
+    }[];
+};
+
+declare class PaymentOrdersApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(input: CreatePaymentOrderInput, options: {
+        idempotencyKey: string;
+    }): Promise<PaymentOrder>;
+    retrieve(id: string): Promise<PaymentOrderDetail>;
+    list(params?: {
+        status?: PaymentOrderStatus;
+        limit?: number;
+    }): Promise<PaymentOrder[]>;
+    cancel(id: string): Promise<PaymentOrder>;
+}
+declare class EventsApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(params?: {
+        chain?: ChainId;
+        asset?: Asset;
+        paymentOrderId?: string;
+        limit?: number;
+        toAddress?: string;
+        txHash?: string;
+    }): Promise<NormalizedEvent[]>;
+    retrieve(id: string): Promise<NormalizedEventDetail>;
+}
+
+declare class WebhookEndpointsApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(input: CreateWebhookEndpointInput): Promise<WebhookEndpoint>;
+    list(): Promise<WebhookEndpoint[]>;
+    update(endpointId: string, input: UpdateWebhookEndpointInput): Promise<WebhookEndpoint>;
+    rotateSecret(endpointId: string): Promise<WebhookEndpoint>;
+    replay(endpointId: string, eventId: string): Promise<ReplayDeliveryResult>;
+}
+declare class WebhookDeliveriesApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(params?: {
+        status?: WebhookDeliveryStatus;
+        endpointId?: string;
+        paymentOrderId?: string;
+        limit?: number;
+    }): Promise<WebhookDelivery[]>;
+    replay(deliveryId: string): Promise<ReplayDeliveryResult>;
+    replayDeadLetters(input?: ReplayDeadLettersInput): Promise<ReplayDeadLettersResult>;
+}
+
+declare class StableOps {
+    readonly paymentOrders: PaymentOrdersApi;
+    readonly events: EventsApi;
+    readonly webhookEndpoints: WebhookEndpointsApi;
+    readonly webhookDeliveries: WebhookDeliveriesApi;
+    constructor(options?: ClientOptions);
+}
+
+export { type AcceptedAssetInput, type Asset, type ChainId, type ClientOptions, type CreatePaymentOrderInput, type CreateWebhookEndpointInput, type EventPaymentOrderSummary, type EventWebhookDelivery, type NormalizedEvent, type NormalizedEventDetail, type PaymentOrder, type PaymentOrderDetail, type PaymentOrderInstruction, type PaymentOrderScenario, type PaymentOrderStatus, type PaymentOrderTimelineEntry, type RawChainEvent, type ReplayDeadLettersInput, type ReplayDeadLettersResult, type ReplayDeliveryResult, type RetryOptions, StableOps, StableOpsError, type UpdateWebhookEndpointInput, type WebhookDelivery, type WebhookDeliveryStatus, type WebhookEndpoint, type WebhookEventType };

package/dist/index.d.ts

@@ -0,0 +1,247 @@
+type StableOpsEnvironment = 'sandbox' | 'live';
+type RetryOptions = {
+    maxRetries?: number;
+    baseDelayMs?: number;
+    maxDelayMs?: number;
+};
+type ClientOptions = {
+    apiKey?: string;
+    baseUrl?: string;
+    organizationSlug?: string;
+    environment?: StableOpsEnvironment;
+    fetch?: typeof fetch;
+    timeoutMs?: number;
+    retry?: RetryOptions;
+    _sleep?: (ms: number) => Promise<void>;
+    _random?: () => number;
+};
+type RequestInit = {
+    method: 'GET' | 'POST' | 'PATCH' | 'DELETE';
+    path: string;
+    body?: unknown;
+    query?: Record<string, string | number | undefined>;
+    idempotencyKey?: string;
+    retryable?: boolean;
+};
+declare class StableOpsError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly details: unknown;
+    constructor(status: number, code: string, message: string, details: unknown);
+}
+declare class HttpClient {
+    private readonly baseUrl;
+    private readonly headers;
+    private readonly fetchImpl;
+    private readonly timeoutMs;
+    private readonly maxRetries;
+    private readonly backoff;
+    private readonly sleep;
+    private readonly random;
+    constructor(options: ClientOptions);
+    request<T>(init: RequestInit): Promise<T>;
+}
+
+type ChainId = 'ethereum' | 'base' | 'base-sepolia' | 'arbitrum' | 'polygon' | 'tron' | 'solana' | 'ethereum-sepolia' | 'arbitrum-sepolia' | 'polygon-amoy' | 'solana-devnet' | 'tron-nile';
+type Asset = 'USDC' | 'USDT';
+type PaymentOrderStatus = 'created' | 'detected' | 'confirmed' | 'finalized' | 'reverted' | 'expired' | 'canceled';
+type PaymentOrderScenario = 'saas_subscription' | 'trading_deposit' | 'agent_workflow' | 'generic';
+type AcceptedAssetInput = {
+    chain: ChainId;
+    asset: Asset;
+};
+type WebhookEventType = 'payment_order.created' | 'payment.detected' | 'payment.confirmed' | 'payment.finalized' | 'payment.reverted' | 'payment.expired' | 'address.pool.low' | 'webhook.delivery.failed' | 'agent.action.requested' | 'agent.action.approved' | 'agent.action.executed';
+type WebhookDeliveryStatus = 'pending' | 'succeeded' | 'failed' | 'dead_letter';
+type CreatePaymentOrderInput = {
+    merchantOrderId: string;
+    amount: string;
+    amountMode?: 'exact' | 'auto';
+    settlementAsset: Asset;
+    acceptedAssets: AcceptedAssetInput[];
+    scenario?: PaymentOrderScenario;
+    expiresAt?: string;
+    metadata?: Record<string, unknown>;
+};
+type PaymentOrderInstruction = {
+    chain: ChainId;
+    asset: Asset;
+    address: string;
+};
+type PaymentOrder = {
+    id: string;
+    merchantOrderId: string;
+    scenario: PaymentOrderScenario;
+    amount: string;
+    requestedAmount: string;
+    settlementAsset: Asset;
+    status: PaymentOrderStatus;
+    expiresAt: string | null;
+    metadata: unknown;
+    createdAt: string;
+    acceptedAssets?: AcceptedAssetInput[];
+    paymentInstructions: PaymentOrderInstruction[];
+};
+type PaymentOrderTimelineEntry = {
+    from: PaymentOrderStatus | null;
+    to: PaymentOrderStatus;
+    reason: string | null;
+    at: string;
+};
+type PaymentOrderDetail = PaymentOrder & {
+    timeline: PaymentOrderTimelineEntry[];
+};
+type NormalizedEvent = {
+    id: string;
+    chain: ChainId;
+    asset: Asset;
+    fromAddress: string;
+    toAddress: string;
+    amount: string;
+    txHash: string;
+    logIndex: number;
+    blockNumber: string;
+    paymentOrderId: string | null;
+    confirmations: number;
+    detectedAt: string;
+};
+type RawChainEvent = {
+    id: string;
+    source: string;
+    blockHash: string | null;
+    receivedAt: string;
+    payload: unknown;
+};
+type EventPaymentOrderSummary = {
+    id: string;
+    merchantOrderId: string;
+    status: PaymentOrderStatus;
+    settlementAsset: Asset;
+    amount: string;
+};
+type EventWebhookDelivery = {
+    id: string;
+    webhookEndpointId: string;
+    eventType: WebhookEventType;
+    status: WebhookDeliveryStatus;
+    attempts: number;
+    responseStatus: number | null;
+    errorMessage: string | null;
+    lastAttemptAt: string | null;
+    createdAt: string;
+};
+type NormalizedEventDetail = NormalizedEvent & {
+    rawChainEvent: RawChainEvent;
+    paymentOrder: EventPaymentOrderSummary | null;
+    deliveries: EventWebhookDelivery[];
+};
+type WebhookEndpoint = {
+    id: string;
+    url: string;
+    description: string | null;
+    enabledEvents: WebhookEventType[];
+    redactMetadata: boolean;
+    disabledAt: string | null;
+    createdAt: string;
+    secret?: string;
+};
+type CreateWebhookEndpointInput = {
+    url: string;
+    description?: string;
+    enabledEvents?: WebhookEventType[];
+    redactMetadata?: boolean;
+};
+type UpdateWebhookEndpointInput = {
+    description?: string | null;
+    enabledEvents?: WebhookEventType[];
+    redactMetadata?: boolean;
+};
+type WebhookDelivery = {
+    id: string;
+    webhookEndpointId: string;
+    eventId: string;
+    eventType: WebhookEventType;
+    paymentOrderId: string | null;
+    status: WebhookDeliveryStatus;
+    attempts: number;
+    responseStatus: number | null;
+    responseDurationMs: number | null;
+    errorMessage: string | null;
+    nextRetryAt: string | null;
+    lastAttemptAt: string | null;
+    succeededAt: string | null;
+    deadLetteredAt: string | null;
+    createdAt: string;
+};
+type ReplayDeliveryResult = {
+    deliveryId: string;
+};
+type ReplayDeadLettersInput = {
+    endpointId?: string;
+    limit?: number;
+};
+type ReplayDeadLettersResult = {
+    replayed: number;
+    items: {
+        originalId: string;
+        deliveryId: string;
+    }[];
+};
+
+declare class PaymentOrdersApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(input: CreatePaymentOrderInput, options: {
+        idempotencyKey: string;
+    }): Promise<PaymentOrder>;
+    retrieve(id: string): Promise<PaymentOrderDetail>;
+    list(params?: {
+        status?: PaymentOrderStatus;
+        limit?: number;
+    }): Promise<PaymentOrder[]>;
+    cancel(id: string): Promise<PaymentOrder>;
+}
+declare class EventsApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(params?: {
+        chain?: ChainId;
+        asset?: Asset;
+        paymentOrderId?: string;
+        limit?: number;
+        toAddress?: string;
+        txHash?: string;
+    }): Promise<NormalizedEvent[]>;
+    retrieve(id: string): Promise<NormalizedEventDetail>;
+}
+
+declare class WebhookEndpointsApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(input: CreateWebhookEndpointInput): Promise<WebhookEndpoint>;
+    list(): Promise<WebhookEndpoint[]>;
+    update(endpointId: string, input: UpdateWebhookEndpointInput): Promise<WebhookEndpoint>;
+    rotateSecret(endpointId: string): Promise<WebhookEndpoint>;
+    replay(endpointId: string, eventId: string): Promise<ReplayDeliveryResult>;
+}
+declare class WebhookDeliveriesApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(params?: {
+        status?: WebhookDeliveryStatus;
+        endpointId?: string;
+        paymentOrderId?: string;
+        limit?: number;
+    }): Promise<WebhookDelivery[]>;
+    replay(deliveryId: string): Promise<ReplayDeliveryResult>;
+    replayDeadLetters(input?: ReplayDeadLettersInput): Promise<ReplayDeadLettersResult>;
+}
+
+declare class StableOps {
+    readonly paymentOrders: PaymentOrdersApi;
+    readonly events: EventsApi;
+    readonly webhookEndpoints: WebhookEndpointsApi;
+    readonly webhookDeliveries: WebhookDeliveriesApi;
+    constructor(options?: ClientOptions);
+}
+
+export { type AcceptedAssetInput, type Asset, type ChainId, type ClientOptions, type CreatePaymentOrderInput, type CreateWebhookEndpointInput, type EventPaymentOrderSummary, type EventWebhookDelivery, type NormalizedEvent, type NormalizedEventDetail, type PaymentOrder, type PaymentOrderDetail, type PaymentOrderInstruction, type PaymentOrderScenario, type PaymentOrderStatus, type PaymentOrderTimelineEntry, type RawChainEvent, type ReplayDeadLettersInput, type ReplayDeadLettersResult, type ReplayDeliveryResult, type RetryOptions, StableOps, StableOpsError, type UpdateWebhookEndpointInput, type WebhookDelivery, type WebhookDeliveryStatus, type WebhookEndpoint, type WebhookEventType };