@xkova/sdk 0.1.0-alpha.1

package/dist/resources/payment-requests.d.ts

@@ -0,0 +1,115 @@
+import { Resource, type ReqBody, type Query } from './base.js';
+import type { XKOVAMutationOptions } from '../client.js';
+export interface PaymentRequestApprovalContext {
+    senderWalletId: string;
+    accountHolderId: string;
+}
+export declare class PaymentRequestsResource extends Resource {
+    list(query?: Query<'listPaymentRequests'>): Promise<{
+        data: import("../generated/types.js").components["schemas"]["PaymentRequest"][];
+        next_cursor?: string | null;
+        has_more: boolean;
+    }>;
+    create(body: ReqBody<'createPaymentRequest'>, opts?: XKOVAMutationOptions): Promise<{
+        id?: import("../generated/types.js").components["schemas"]["PaymentRequestId"];
+        requester_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
+        payer_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        payer_lookup?: string | null;
+        amount?: import("../generated/types.js").components["schemas"]["Money"];
+        token_deployment_id?: string;
+        memo?: string | null;
+        state?: "pending" | "approved" | "declined" | "expired" | "cancelled";
+        expires_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        spawned_txn_id?: import("../generated/types.js").components["schemas"]["PaymentId"] | null;
+        decline_reason?: string | null;
+        created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+    }>;
+    retrieve(id: string): Promise<{
+        id?: import("../generated/types.js").components["schemas"]["PaymentRequestId"];
+        requester_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
+        payer_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        payer_lookup?: string | null;
+        amount?: import("../generated/types.js").components["schemas"]["Money"];
+        token_deployment_id?: string;
+        memo?: string | null;
+        state?: "pending" | "approved" | "declined" | "expired" | "cancelled";
+        expires_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        spawned_txn_id?: import("../generated/types.js").components["schemas"]["PaymentId"] | null;
+        decline_reason?: string | null;
+        created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+    }>;
+    approve(id: string, context: PaymentRequestApprovalContext, opts?: XKOVAMutationOptions): Promise<{
+        id: import("../generated/types.js").components["schemas"]["PaymentId"];
+        tenant_id: string;
+        channel: string;
+        chain_id: string;
+        chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
+        tx_ref: string | null;
+        from_wallet_id: import("../generated/types.js").components["schemas"]["WalletId"];
+        from_wallet_address: string;
+        to_account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        open_compliance_case_id: import("../generated/types.js").components["schemas"]["ComplianceCaseId"] | null;
+        from_account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        to_address: string;
+        to_wallet_id: import("../generated/types.js").components["schemas"]["WalletId"] | null;
+        token_deployment_id: string;
+        token_symbol: string;
+        gross_amount: import("../generated/types.js").components["schemas"]["Money"];
+        net_amount: import("../generated/types.js").components["schemas"]["Money"];
+        fee_snapshot: {
+            beneficiary?: string;
+            basis?: string;
+            rate?: import("../generated/types.js").components["schemas"]["Money"];
+            computed_amount?: import("../generated/types.js").components["schemas"]["Money"];
+        }[];
+        fee_schedule_ref: {
+            schedule_id?: string;
+            version?: number;
+        };
+        memo: string | null;
+        display_type: "p2p_send" | "external_send" | "escrow_create" | "escrow_release" | "funding" | "off_ramp" | "receive";
+        status: "pending_quote" | "pending_compliance" | "pending_approval" | "pending_confirm" | "pending_sign" | "submission_pending" | "submission_unknown" | "on_chain_pending" | "confirmed" | "reorg_detected" | "blocked" | "failed" | "cancelled";
+        status_canonical: import("../generated/types.js").components["schemas"]["StatusCanonical"];
+        failure_reason_code: string | null;
+        failure_reason_detail: string | null;
+        is_retryable: boolean | null;
+        idempotency_key: string;
+        correlation_id: import("../generated/types.js").components["schemas"]["CorrelationId"];
+        signing_expires_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+        created_at: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        finalized_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+    }>;
+    cancel(id: string, opts?: XKOVAMutationOptions): Promise<{
+        id?: import("../generated/types.js").components["schemas"]["PaymentRequestId"];
+        requester_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
+        payer_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        payer_lookup?: string | null;
+        amount?: import("../generated/types.js").components["schemas"]["Money"];
+        token_deployment_id?: string;
+        memo?: string | null;
+        state?: "pending" | "approved" | "declined" | "expired" | "cancelled";
+        expires_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        spawned_txn_id?: import("../generated/types.js").components["schemas"]["PaymentId"] | null;
+        decline_reason?: string | null;
+        created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+    }>;
+    decline(id: string, body?: ReqBody<'declinePaymentRequest'>, opts?: XKOVAMutationOptions): Promise<{
+        id?: import("../generated/types.js").components["schemas"]["PaymentRequestId"];
+        requester_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
+        payer_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        payer_lookup?: string | null;
+        amount?: import("../generated/types.js").components["schemas"]["Money"];
+        token_deployment_id?: string;
+        memo?: string | null;
+        state?: "pending" | "approved" | "declined" | "expired" | "cancelled";
+        expires_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        spawned_txn_id?: import("../generated/types.js").components["schemas"]["PaymentId"] | null;
+        decline_reason?: string | null;
+        created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+    }>;
+    remind(id: string, opts?: XKOVAMutationOptions): Promise<void>;
+}

package/dist/resources/payment-requests.js

@@ -0,0 +1,27 @@
+import { Resource } from './base.js';
+export class PaymentRequestsResource extends Resource {
+    list(query = {}) {
+        return this.getJson('/payment-requests', query);
+    }
+    create(body, opts) {
+        return this.postJson('/payment-requests', body, opts);
+    }
+    retrieve(id) {
+        return this.getJson(`/payment-requests/${this.enc(id)}`);
+    }
+    approve(id, context, opts) {
+        return this.postJson(`/payment-requests/${this.enc(id)}/approve`, undefined, opts, undefined, {
+            'X-Sender-Wallet-Id': context.senderWalletId,
+            'X-Account-Holder-Id': context.accountHolderId,
+        });
+    }
+    cancel(id, opts) {
+        return this.postJson(`/payment-requests/${this.enc(id)}/cancel`, undefined, opts);
+    }
+    decline(id, body = {}, opts) {
+        return this.postJson(`/payment-requests/${this.enc(id)}/decline`, body, opts);
+    }
+    remind(id, opts) {
+        return this.postJson(`/payment-requests/${this.enc(id)}/remind`, undefined, opts);
+    }
+}

package/dist/resources/payments.d.ts

@@ -0,0 +1,182 @@
+import { Resource, type ReqBody, type Query } from './base.js';
+import type { XKOVAMutationOptions } from '../client.js';
+type PaymentMemberHeaders = {
+    memberSessionId: string;
+    memberAuthPublishableKey: string;
+} | {
+    memberSessionId?: never;
+    memberAuthPublishableKey?: never;
+};
+export type PaymentCreateOptions = XKOVAMutationOptions & PaymentMemberHeaders;
+export declare class PaymentsResource extends Resource {
+    list(query?: Query<'listPayments'>): Promise<{
+        data: unknown[];
+        next_cursor: string | null;
+        has_more: boolean;
+    } & {
+        data?: import("../generated/types.js").components["schemas"]["Payment"][];
+    }>;
+    /** Validates the proposed payment and records the quoted fees. */
+    quote(body: ReqBody<'quotePayment'>, opts?: XKOVAMutationOptions): Promise<{
+        quote_id?: string;
+        gross_amount?: import("../generated/types.js").components["schemas"]["Money"];
+        net_amount?: import("../generated/types.js").components["schemas"]["Money"];
+        fee_snapshot?: {
+            beneficiary?: string;
+            basis?: "flat" | "bps" | "percent";
+            rate?: import("../generated/types.js").components["schemas"]["Money"];
+            computed_amount?: import("../generated/types.js").components["schemas"]["Money"];
+        }[];
+        fee_fingerprint?: string;
+        compliance_fingerprint?: string;
+        compliance_decision?: "allow" | "review" | "block";
+        compliance_reason_code?: string;
+        expires_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        within_limits?: boolean;
+        daily_remaining?: {
+            tx_count?: number;
+            gross_amount?: import("../generated/types.js").components["schemas"]["Money"];
+        };
+    }>;
+    /** Simulate a payment without creating it. */
+    simulate(body: ReqBody<'simulatePayment'>, opts?: XKOVAMutationOptions): Promise<{
+        would_succeed: boolean;
+        revert_reason: string | null;
+        balance_sufficient: boolean;
+        allowance_sufficient: boolean;
+        gas_estimate: string;
+        fees: {
+            gross_amount: import("../generated/types.js").components["schemas"]["Money"];
+            net_amount: import("../generated/types.js").components["schemas"]["Money"];
+            total_fee_amount: import("../generated/types.js").components["schemas"]["Money"];
+        };
+    }>;
+    /** Pending member-signed payments need fresh authorization before signing. */
+    create(body: ReqBody<'createPayment'>, opts?: PaymentCreateOptions): Promise<{
+        id: import("../generated/types.js").components["schemas"]["PaymentId"];
+        tenant_id: string;
+        channel: string;
+        chain_id: string;
+        chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
+        tx_ref: string | null;
+        from_wallet_id: import("../generated/types.js").components["schemas"]["WalletId"];
+        from_wallet_address: string;
+        to_account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        open_compliance_case_id: import("../generated/types.js").components["schemas"]["ComplianceCaseId"] | null;
+        from_account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        to_address: string;
+        to_wallet_id: import("../generated/types.js").components["schemas"]["WalletId"] | null;
+        token_deployment_id: string;
+        token_symbol: string;
+        gross_amount: import("../generated/types.js").components["schemas"]["Money"];
+        net_amount: import("../generated/types.js").components["schemas"]["Money"];
+        fee_snapshot: {
+            beneficiary?: string;
+            basis?: string;
+            rate?: import("../generated/types.js").components["schemas"]["Money"];
+            computed_amount?: import("../generated/types.js").components["schemas"]["Money"];
+        }[];
+        fee_schedule_ref: {
+            schedule_id?: string;
+            version?: number;
+        };
+        memo: string | null;
+        display_type: "p2p_send" | "external_send" | "escrow_create" | "escrow_release" | "funding" | "off_ramp" | "receive";
+        status: "pending_quote" | "pending_compliance" | "pending_approval" | "pending_confirm" | "pending_sign" | "submission_pending" | "submission_unknown" | "on_chain_pending" | "confirmed" | "reorg_detected" | "blocked" | "failed" | "cancelled";
+        status_canonical: import("../generated/types.js").components["schemas"]["StatusCanonical"];
+        failure_reason_code: string | null;
+        failure_reason_detail: string | null;
+        is_retryable: boolean | null;
+        idempotency_key: string;
+        correlation_id: import("../generated/types.js").components["schemas"]["CorrelationId"];
+        signing_expires_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+        created_at: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        finalized_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+    }>;
+    retrieve(id: string, query?: Query<'getPayment'>): Promise<{
+        id: import("../generated/types.js").components["schemas"]["PaymentId"];
+        tenant_id: string;
+        channel: string;
+        chain_id: string;
+        chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
+        tx_ref: string | null;
+        from_wallet_id: import("../generated/types.js").components["schemas"]["WalletId"];
+        from_wallet_address: string;
+        to_account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        open_compliance_case_id: import("../generated/types.js").components["schemas"]["ComplianceCaseId"] | null;
+        from_account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        to_address: string;
+        to_wallet_id: import("../generated/types.js").components["schemas"]["WalletId"] | null;
+        token_deployment_id: string;
+        token_symbol: string;
+        gross_amount: import("../generated/types.js").components["schemas"]["Money"];
+        net_amount: import("../generated/types.js").components["schemas"]["Money"];
+        fee_snapshot: {
+            beneficiary?: string;
+            basis?: string;
+            rate?: import("../generated/types.js").components["schemas"]["Money"];
+            computed_amount?: import("../generated/types.js").components["schemas"]["Money"];
+        }[];
+        fee_schedule_ref: {
+            schedule_id?: string;
+            version?: number;
+        };
+        memo: string | null;
+        display_type: "p2p_send" | "external_send" | "escrow_create" | "escrow_release" | "funding" | "off_ramp" | "receive";
+        status: "pending_quote" | "pending_compliance" | "pending_approval" | "pending_confirm" | "pending_sign" | "submission_pending" | "submission_unknown" | "on_chain_pending" | "confirmed" | "reorg_detected" | "blocked" | "failed" | "cancelled";
+        status_canonical: import("../generated/types.js").components["schemas"]["StatusCanonical"];
+        failure_reason_code: string | null;
+        failure_reason_detail: string | null;
+        is_retryable: boolean | null;
+        idempotency_key: string;
+        correlation_id: import("../generated/types.js").components["schemas"]["CorrelationId"];
+        signing_expires_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+        created_at: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        finalized_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+    }>;
+    listEvents(id: string): Promise<{
+        data?: import("../generated/types.js").components["schemas"]["PaymentEvent"][];
+    }>;
+    cancel(id: string, opts?: XKOVAMutationOptions): Promise<{
+        id: import("../generated/types.js").components["schemas"]["PaymentId"];
+        tenant_id: string;
+        channel: string;
+        chain_id: string;
+        chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
+        tx_ref: string | null;
+        from_wallet_id: import("../generated/types.js").components["schemas"]["WalletId"];
+        from_wallet_address: string;
+        to_account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        open_compliance_case_id: import("../generated/types.js").components["schemas"]["ComplianceCaseId"] | null;
+        from_account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"] | null;
+        to_address: string;
+        to_wallet_id: import("../generated/types.js").components["schemas"]["WalletId"] | null;
+        token_deployment_id: string;
+        token_symbol: string;
+        gross_amount: import("../generated/types.js").components["schemas"]["Money"];
+        net_amount: import("../generated/types.js").components["schemas"]["Money"];
+        fee_snapshot: {
+            beneficiary?: string;
+            basis?: string;
+            rate?: import("../generated/types.js").components["schemas"]["Money"];
+            computed_amount?: import("../generated/types.js").components["schemas"]["Money"];
+        }[];
+        fee_schedule_ref: {
+            schedule_id?: string;
+            version?: number;
+        };
+        memo: string | null;
+        display_type: "p2p_send" | "external_send" | "escrow_create" | "escrow_release" | "funding" | "off_ramp" | "receive";
+        status: "pending_quote" | "pending_compliance" | "pending_approval" | "pending_confirm" | "pending_sign" | "submission_pending" | "submission_unknown" | "on_chain_pending" | "confirmed" | "reorg_detected" | "blocked" | "failed" | "cancelled";
+        status_canonical: import("../generated/types.js").components["schemas"]["StatusCanonical"];
+        failure_reason_code: string | null;
+        failure_reason_detail: string | null;
+        is_retryable: boolean | null;
+        idempotency_key: string;
+        correlation_id: import("../generated/types.js").components["schemas"]["CorrelationId"];
+        signing_expires_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+        created_at: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        finalized_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+    }>;
+}
+export {};

package/dist/resources/payments.js

@@ -0,0 +1,33 @@
+import { Resource } from './base.js';
+export class PaymentsResource extends Resource {
+    list(query = {}) {
+        return this.getJson('/payments', query);
+    }
+    /** Validates the proposed payment and records the quoted fees. */
+    quote(body, opts) {
+        return this.postJson('/payments/quote', body, opts);
+    }
+    /** Simulate a payment without creating it. */
+    simulate(body, opts) {
+        return this.postJson('/payments/simulate', body, opts);
+    }
+    /** Pending member-signed payments need fresh authorization before signing. */
+    create(body, opts = {}) {
+        const headers = opts.memberSessionId === undefined
+            ? undefined
+            : {
+                'X-Member-Session-Id': opts.memberSessionId,
+                'X-XKOVA-Publishable-Key': opts.memberAuthPublishableKey,
+            };
+        return this.postJson('/payments', body, opts, undefined, headers);
+    }
+    retrieve(id, query = {}) {
+        return this.getJson(`/payments/${this.enc(id)}`, query);
+    }
+    listEvents(id) {
+        return this.getJson(`/payments/${this.enc(id)}/events`);
+    }
+    cancel(id, opts) {
+        return this.postJson(`/payments/${this.enc(id)}/cancel`, undefined, opts);
+    }
+}

package/dist/resources/ramps.d.ts

@@ -0,0 +1,163 @@
+import { Resource, type ReqBody, type Query } from './base.js';
+import type { XKOVAMutationOptions, XKOVARequestControl } from '../client.js';
+export interface RampRequestOptions extends XKOVAMutationOptions {
+    sandboxScenario?: string;
+}
+export type SandboxFundingBody = Omit<ReqBody<'createFundingRequest'>, 'stablecoin'>;
+export declare class RampsResource extends Resource {
+    listFunding(query?: Query<'listFundingRequests'>, control?: XKOVARequestControl): Promise<{
+        data: import("../generated/types.js").components["schemas"]["FundingRequest"][];
+        next_cursor: string | null;
+        has_more: boolean;
+    }>;
+    createFunding(body: ReqBody<'createFundingRequest'>, opts?: RampRequestOptions): Promise<{
+        id?: import("../generated/types.js").components["schemas"]["FundingRequestId"];
+        tenant_id?: string;
+        workspace_id?: string;
+        chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
+        account_holder_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
+        amount?: import("../generated/types.js").components["schemas"]["Money"];
+        currency?: string;
+        state?: "pending_compliance" | "pending_issuance" | "settled" | "failed";
+        failure_reason_code?: string | null;
+        x_partner_reference?: string | null;
+        quote_id?: string | null;
+        bank_debit_transfer_id?: string | null;
+        partner_status?: string | null;
+        last_event_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+        metadata?: {
+            [key: string]: unknown;
+        } | null;
+        settlement_order: "hold_first" | "debit_first" | null;
+        idempotency_key?: string;
+        correlation_id?: string;
+        ramp_profile?: "mock" | "sandbox" | "coinbase";
+        hosted_redirect_url?: string | null;
+        created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        settled_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+    }>;
+    /**
+     * One-call sandbox funding convenience. This invokes the normal funding
+     * request operation and therefore returns the same production-shaped ramp
+     * resource, state transitions, webhooks, and idempotency behavior.
+     */
+    fundSandboxWallet(body: SandboxFundingBody, opts?: RampRequestOptions): Promise<{
+        id?: import("../generated/types.js").components["schemas"]["FundingRequestId"];
+        tenant_id?: string;
+        workspace_id?: string;
+        chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
+        account_holder_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
+        amount?: import("../generated/types.js").components["schemas"]["Money"];
+        currency?: string;
+        state?: "pending_compliance" | "pending_issuance" | "settled" | "failed";
+        failure_reason_code?: string | null;
+        x_partner_reference?: string | null;
+        quote_id?: string | null;
+        bank_debit_transfer_id?: string | null;
+        partner_status?: string | null;
+        last_event_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+        metadata?: {
+            [key: string]: unknown;
+        } | null;
+        settlement_order: "hold_first" | "debit_first" | null;
+        idempotency_key?: string;
+        correlation_id?: string;
+        ramp_profile?: "mock" | "sandbox" | "coinbase";
+        hosted_redirect_url?: string | null;
+        created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        settled_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+    }>;
+    getFunding(id: string): Promise<{
+        id?: import("../generated/types.js").components["schemas"]["FundingRequestId"];
+        tenant_id?: string;
+        workspace_id?: string;
+        chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
+        account_holder_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
+        amount?: import("../generated/types.js").components["schemas"]["Money"];
+        currency?: string;
+        state?: "pending_compliance" | "pending_issuance" | "settled" | "failed";
+        failure_reason_code?: string | null;
+        x_partner_reference?: string | null;
+        quote_id?: string | null;
+        bank_debit_transfer_id?: string | null;
+        partner_status?: string | null;
+        last_event_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+        metadata?: {
+            [key: string]: unknown;
+        } | null;
+        settlement_order: "hold_first" | "debit_first" | null;
+        idempotency_key?: string;
+        correlation_id?: string;
+        ramp_profile?: "mock" | "sandbox" | "coinbase";
+        hosted_redirect_url?: string | null;
+        created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        settled_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+    }>;
+    listOffRamp(query?: Query<'listOffRampRequests'>): Promise<{
+        data: import("../generated/types.js").components["schemas"]["OffRampRequest"][];
+        next_cursor: string | null;
+        has_more: boolean;
+    }>;
+    createOffRamp(body: ReqBody<'createOffRampRequest'>, opts?: RampRequestOptions): Promise<{
+        id?: import("../generated/types.js").components["schemas"]["OffRampRequestId"];
+        tenant_id?: string;
+        workspace_id?: string;
+        chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
+        account_holder_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
+        amount?: import("../generated/types.js").components["schemas"]["Money"];
+        currency?: string;
+        state?: "pending_compliance" | "pending_burn" | "awaiting_institution_credit" | "settled" | "failed";
+        failure_reason_code?: string | null;
+        x_partner_reference?: string | null;
+        bank_credit_transfer_id?: string | null;
+        partner_status?: string | null;
+        last_event_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+        metadata?: {
+            [key: string]: unknown;
+        } | null;
+        idempotency_key?: string;
+        correlation_id?: string;
+        ramp_profile?: "mock" | "sandbox" | "coinbase";
+        hosted_redirect_url?: string | null;
+        created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        settled_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+    }>;
+    getOffRamp(id: string): Promise<{
+        id?: import("../generated/types.js").components["schemas"]["OffRampRequestId"];
+        tenant_id?: string;
+        workspace_id?: string;
+        chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
+        account_holder_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
+        amount?: import("../generated/types.js").components["schemas"]["Money"];
+        currency?: string;
+        state?: "pending_compliance" | "pending_burn" | "awaiting_institution_credit" | "settled" | "failed";
+        failure_reason_code?: string | null;
+        x_partner_reference?: string | null;
+        bank_credit_transfer_id?: string | null;
+        partner_status?: string | null;
+        last_event_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+        metadata?: {
+            [key: string]: unknown;
+        } | null;
+        idempotency_key?: string;
+        correlation_id?: string;
+        ramp_profile?: "mock" | "sandbox" | "coinbase";
+        hosted_redirect_url?: string | null;
+        created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
+        settled_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
+    }>;
+    /** Resolve the partner redeem (burn) address for an off-ramp. */
+    offRampBurnAddress(query: Query<'getOffRampBurnAddress'>): Promise<{
+        burn_address: string;
+        stablecoin: "USDC" | "dUSDC";
+        chain: {
+            kind: string;
+            chain_id: number;
+        };
+    }>;
+}

package/dist/resources/ramps.js

@@ -0,0 +1,44 @@
+import { Resource } from './base.js';
+function rampHeaders(opts) {
+    if (opts.sandboxScenario === undefined)
+        return undefined;
+    return {
+        ...(opts.sandboxScenario !== undefined && { 'X-Sandbox-Scenario': opts.sandboxScenario }),
+    };
+}
+export class RampsResource extends Resource {
+    listFunding(query = {}, control) {
+        return this.getJson('/funding-requests', query, control);
+    }
+    createFunding(body, opts = {}) {
+        return this.postJson('/funding-requests', body, opts, undefined, rampHeaders(opts));
+    }
+    /**
+     * One-call sandbox funding convenience. This invokes the normal funding
+     * request operation and therefore returns the same production-shaped ramp
+     * resource, state transitions, webhooks, and idempotency behavior.
+     */
+    fundSandboxWallet(body, opts = {}) {
+        const funding = {
+            ...body,
+            stablecoin: 'dUSDC',
+        };
+        return this.createFunding(funding, opts);
+    }
+    getFunding(id) {
+        return this.getJson(`/funding-requests/${this.enc(id)}`);
+    }
+    listOffRamp(query = {}) {
+        return this.getJson('/off-ramp-requests', query);
+    }
+    createOffRamp(body, opts = {}) {
+        return this.postJson('/off-ramp-requests', body, opts, undefined, rampHeaders(opts));
+    }
+    getOffRamp(id) {
+        return this.getJson(`/off-ramp-requests/${this.enc(id)}`);
+    }
+    /** Resolve the partner redeem (burn) address for an off-ramp. */
+    offRampBurnAddress(query) {
+        return this.getJson('/off-ramp-requests/burn-address', query);
+    }
+}