@sly_ai/sdk 0.1.0

package/dist/ucp.d.mts

@@ -0,0 +1,844 @@
+import { S as SlyClient } from './client-Cwe2CLU7.mjs';
+import './types-df1EICn_.mjs';
+
+/**
+ * UCP (Universal Commerce Protocol) Types for SDK
+ *
+ * Types for interacting with PayOS UCP settlement and merchant discovery.
+ *
+ * @see Story 43.9: UCP Client Module
+ */
+/**
+ * UCP Profile - fetched from /.well-known/ucp
+ */
+interface UCPProfile {
+    ucp: {
+        version: string;
+        services: Record<string, UCPService>;
+        capabilities: UCPCapability[];
+    };
+    business?: {
+        name: string;
+        logo_url?: string;
+        support_email?: string;
+    };
+    payment?: {
+        handlers: UCPPaymentHandler[];
+    };
+    checkout?: {
+        endpoint: string;
+        supported_currencies: string[];
+        payment_handlers: string[];
+    };
+}
+interface UCPService {
+    version: string;
+    spec?: string;
+    rest?: {
+        schema: string;
+        endpoint: string;
+    };
+    mcp?: {
+        endpoint: string;
+        tools: string[];
+    };
+}
+interface UCPCapability {
+    name: string;
+    version: string;
+    description?: string;
+}
+interface UCPPaymentHandler {
+    id: string;
+    name: string;
+    version: string;
+    spec?: string;
+    supported_currencies: string[];
+    supported_corridors: UCPCorridor[];
+}
+interface UCPCorridor {
+    id: string;
+    name: string;
+    source_currency: string;
+    destination_currency: string;
+    destination_country: string;
+    rail: 'pix' | 'spei' | 'wire' | 'usdc';
+    estimated_settlement: string;
+}
+interface UCPQuoteRequest {
+    corridor: 'pix' | 'spei';
+    amount: number;
+    currency: 'USD' | 'USDC';
+}
+interface UCPQuote {
+    from_amount: number;
+    from_currency: string;
+    to_amount: number;
+    to_currency: string;
+    fx_rate: number;
+    fees: number;
+    expires_at: string;
+}
+interface UCPTokenRequest {
+    corridor: 'pix' | 'spei';
+    amount: number;
+    currency: 'USD' | 'USDC';
+    recipient: UCPRecipient;
+    metadata?: Record<string, unknown>;
+}
+type UCPRecipient = UCPPixRecipient | UCPSpeiRecipient;
+interface UCPPixRecipient {
+    type: 'pix';
+    pix_key: string;
+    pix_key_type: 'cpf' | 'cnpj' | 'email' | 'phone' | 'evp';
+    name: string;
+    tax_id?: string;
+}
+interface UCPSpeiRecipient {
+    type: 'spei';
+    clabe: string;
+    name: string;
+    rfc?: string;
+}
+interface UCPToken {
+    token: string;
+    settlement_id: string;
+    quote: UCPQuote;
+    expires_at: string;
+    created_at: string;
+}
+interface UCPSettleRequest {
+    token: string;
+    idempotency_key?: string;
+}
+interface UCPSettlement {
+    id: string;
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+    token: string;
+    transfer_id?: string;
+    amount: {
+        source: number;
+        source_currency: string;
+        destination: number;
+        destination_currency: string;
+        fx_rate: number;
+        fees: number;
+    };
+    recipient: UCPRecipient;
+    corridor: 'pix' | 'spei';
+    estimated_completion?: string;
+    completed_at?: string;
+    failed_at?: string;
+    failure_reason?: string;
+    created_at: string;
+    updated_at: string;
+}
+interface ListSettlementsOptions {
+    status?: string;
+    corridor?: string;
+    limit?: number;
+    offset?: number;
+}
+interface ListSettlementsResponse {
+    data: UCPSettlement[];
+    pagination: {
+        limit: number;
+        offset: number;
+        total: number;
+    };
+}
+interface UCPCheckoutRequest {
+    line_items: UCPLineItem[];
+    buyer?: {
+        email?: string;
+        name?: string;
+        phone?: string;
+    };
+    shipping_address?: UCPAddress;
+}
+interface UCPLineItem {
+    product_id?: string;
+    name?: string;
+    description?: string;
+    quantity: number;
+    unit_price?: number;
+    currency?: string;
+    variant?: Record<string, string>;
+}
+interface UCPAddress {
+    line1: string;
+    line2?: string;
+    city: string;
+    state?: string;
+    postal_code: string;
+    country: string;
+}
+interface UCPCheckout {
+    id: string;
+    merchant_url: string;
+    status: 'open' | 'completed' | 'cancelled' | 'expired';
+    line_items: UCPLineItem[];
+    totals: {
+        subtotal: number;
+        tax: number;
+        shipping: number;
+        total: number;
+        currency: string;
+    };
+    payment_handlers: string[];
+    expires_at: string;
+    created_at: string;
+}
+interface UCPCompleteCheckoutRequest {
+    payment_handler: string;
+    payment_data: {
+        token: string;
+    };
+    shipping_address?: UCPAddress;
+}
+interface UCPOrder {
+    id: string;
+    checkout_id: string;
+    status: 'confirmed' | 'processing' | 'shipped' | 'delivered' | 'cancelled';
+    line_items: UCPLineItem[];
+    totals: {
+        subtotal: number;
+        tax: number;
+        shipping: number;
+        total: number;
+        currency: string;
+    };
+    payment: {
+        handler_id: string;
+        status: string;
+        settlement_id?: string;
+    };
+    created_at: string;
+}
+interface UCPHandlerInfo {
+    handler: {
+        id: string;
+        name: string;
+        version: string;
+    };
+    supported_corridors: string[];
+    supported_currencies: string[];
+    token_expiry_seconds: number;
+}
+/**
+ * Checkout status state machine
+ */
+type PayOSCheckoutStatus = 'incomplete' | 'requires_escalation' | 'ready_for_complete' | 'complete_in_progress' | 'completed' | 'canceled';
+/**
+ * PayOS-hosted checkout session
+ */
+interface PayOSCheckout {
+    id: string;
+    tenant_id: string;
+    status: PayOSCheckoutStatus;
+    currency: string;
+    line_items: PayOSLineItem[];
+    totals: PayOSTotal[];
+    buyer?: PayOSBuyer | null;
+    shipping_address?: UCPAddress | null;
+    billing_address?: UCPAddress | null;
+    payment_config: PayOSPaymentConfig;
+    payment_instruments: PayOSPaymentInstrument[];
+    selected_instrument_id?: string | null;
+    messages: PayOSCheckoutMessage[];
+    continue_url?: string | null;
+    cancel_url?: string | null;
+    links: PayOSLink[];
+    metadata: Record<string, unknown>;
+    order_id?: string | null;
+    expires_at: string;
+    created_at: string;
+    updated_at: string;
+}
+interface PayOSLineItem {
+    id: string;
+    name: string;
+    description?: string;
+    quantity: number;
+    unit_price: number;
+    total_price: number;
+    currency: string;
+    image_url?: string;
+    product_url?: string;
+}
+interface PayOSTotal {
+    type: 'subtotal' | 'tax' | 'shipping' | 'discount' | 'total' | string;
+    amount: number;
+    label: string;
+    currency?: string;
+}
+interface PayOSBuyer {
+    email?: string;
+    name?: string;
+    phone?: string;
+}
+interface PayOSPaymentConfig {
+    handlers: string[];
+    default_handler?: string;
+    capture_method?: 'automatic' | 'manual';
+}
+interface PayOSPaymentInstrument {
+    id: string;
+    handler: string;
+    type: string;
+    last4?: string;
+    brand?: string;
+    created_at: string;
+    metadata?: Record<string, unknown>;
+}
+interface PayOSCheckoutMessage {
+    id: string;
+    type: 'error' | 'warning' | 'info';
+    code: string;
+    severity?: 'recoverable' | 'requires_buyer_input' | 'requires_buyer_review';
+    path?: string;
+    content: string;
+    content_type: 'plain' | 'markdown';
+    created_at: string;
+}
+interface PayOSLink {
+    rel: string;
+    href: string;
+    title?: string;
+}
+interface CreatePayOSCheckoutRequest {
+    currency: string;
+    line_items?: PayOSLineItem[];
+    totals?: PayOSTotal[];
+    buyer?: PayOSBuyer;
+    shipping_address?: UCPAddress;
+    billing_address?: UCPAddress;
+    payment_config?: Partial<PayOSPaymentConfig>;
+    continue_url?: string;
+    cancel_url?: string;
+    links?: PayOSLink[];
+    metadata?: Record<string, unknown>;
+    expires_in_hours?: number;
+}
+interface UpdatePayOSCheckoutRequest {
+    line_items?: PayOSLineItem[];
+    totals?: PayOSTotal[];
+    buyer?: PayOSBuyer;
+    shipping_address?: UCPAddress | null;
+    billing_address?: UCPAddress | null;
+    selected_instrument_id?: string | null;
+    continue_url?: string;
+    cancel_url?: string;
+    metadata?: Record<string, unknown>;
+}
+type PayOSOrderStatus = 'confirmed' | 'processing' | 'shipped' | 'delivered' | 'cancelled' | 'refunded';
+interface PayOSOrder {
+    id: string;
+    tenant_id: string;
+    checkout_id: string;
+    status: PayOSOrderStatus;
+    currency: string;
+    line_items: PayOSLineItem[];
+    totals: PayOSTotal[];
+    buyer?: PayOSBuyer | null;
+    shipping_address?: UCPAddress | null;
+    billing_address?: UCPAddress | null;
+    payment: PayOSOrderPayment;
+    expectations: PayOSExpectation[];
+    events: PayOSFulfillmentEvent[];
+    adjustments: PayOSAdjustment[];
+    permalink_url?: string | null;
+    metadata: Record<string, unknown>;
+    created_at: string;
+    updated_at: string;
+}
+interface PayOSOrderPayment {
+    handler: string;
+    instrument_id?: string;
+    transaction_id?: string;
+    status: 'pending' | 'captured' | 'failed';
+    captured_at?: string;
+}
+interface PayOSExpectation {
+    id: string;
+    type: string;
+    description: string;
+    estimated_date?: string;
+    tracking_url?: string;
+}
+interface PayOSFulfillmentEvent {
+    id: string;
+    type: string;
+    timestamp: string;
+    description: string;
+    tracking_number?: string;
+    carrier?: string;
+}
+interface PayOSAdjustment {
+    id: string;
+    type: 'refund' | 'return' | 'credit';
+    amount: number;
+    reason?: string;
+    created_at: string;
+}
+interface ListPayOSOrdersOptions {
+    status?: PayOSOrderStatus;
+    limit?: number;
+    offset?: number;
+}
+interface ListPayOSOrdersResponse {
+    data: PayOSOrder[];
+    pagination: {
+        limit: number;
+        offset: number;
+        total: number;
+        total_pages: number;
+    };
+}
+type UCPIdentityScope = 'profile.read' | 'profile.write' | 'addresses.read' | 'addresses.write' | 'payment_methods.read' | 'payment_methods.write' | 'orders.read' | 'checkout.create' | 'checkout.complete';
+interface UCPOAuthClient {
+    id: string;
+    client_id: string;
+    name: string;
+    logo_url?: string;
+    redirect_uris: string[];
+    allowed_scopes: UCPIdentityScope[];
+    client_type: 'public' | 'confidential';
+    is_active: boolean;
+    created_at: string;
+    updated_at: string;
+}
+interface RegisterOAuthClientRequest {
+    name: string;
+    redirect_uris: string[];
+    allowed_scopes?: UCPIdentityScope[];
+    client_type?: 'public' | 'confidential';
+    logo_url?: string;
+}
+interface RegisterOAuthClientResponse {
+    client: UCPOAuthClient;
+    client_secret?: string;
+}
+interface UCPLinkedAccount {
+    id: string;
+    platform_id: string;
+    platform_name: string;
+    buyer_id?: string;
+    buyer_email?: string;
+    scopes: UCPIdentityScope[];
+    linked_at: string;
+    last_used_at?: string;
+}
+interface UCPTokenResponse {
+    access_token: string;
+    token_type: 'Bearer';
+    expires_in: number;
+    refresh_token: string;
+    scope: string;
+}
+interface UCPAuthorizationInfo {
+    client: {
+        id: string;
+        name: string;
+        logo_url?: string;
+    };
+    requested_scopes: string[];
+    redirect_uri: string;
+    state: string;
+    code_challenge?: string;
+    code_challenge_method?: 'S256' | 'plain';
+}
+interface UCPConsentRequest {
+    client_id: string;
+    redirect_uri: string;
+    scope: string;
+    state: string;
+    code_challenge?: string;
+    code_challenge_method?: 'S256' | 'plain';
+    buyer_id: string;
+    approved: boolean;
+}
+interface UCPConsentResponse {
+    redirect_uri: string;
+}
+interface UCPScopeInfo {
+    name: UCPIdentityScope;
+    description: string;
+}
+
+/**
+ * UCP Client - Universal Commerce Protocol
+ *
+ * Wraps PayOS UCP API endpoints for settlement and merchant discovery.
+ *
+ * @see Story 43.9: UCP Client Module
+ * @see https://ucp.dev/specification/overview/
+ */
+
+declare class UCPClient {
+    private client;
+    constructor(client: SlyClient);
+    /**
+     * Discover a UCP merchant's capabilities
+     *
+     * Fetches and caches the merchant's UCP profile from /.well-known/ucp
+     *
+     * @example
+     * ```typescript
+     * const merchant = await payos.ucp.discover('https://shop.example.com');
+     * console.log(merchant.ucp.version);
+     * console.log(merchant.payment?.handlers);
+     * ```
+     */
+    discover(merchantUrl: string): Promise<UCPProfile>;
+    /**
+     * Get PayOS's own UCP profile
+     *
+     * @example
+     * ```typescript
+     * const profile = await payos.ucp.getProfile();
+     * console.log(profile.payment?.handlers);
+     * ```
+     */
+    getProfile(): Promise<UCPProfile>;
+    /**
+     * Get available settlement corridors
+     *
+     * @example
+     * ```typescript
+     * const corridors = await payos.ucp.getCorridors();
+     * console.log(corridors.find(c => c.rail === 'pix'));
+     * ```
+     */
+    getCorridors(): Promise<UCPCorridor[]>;
+    /**
+     * Get UCP handler info
+     *
+     * @example
+     * ```typescript
+     * const info = await payos.ucp.getHandlerInfo();
+     * console.log(info.handler.name); // com.payos.latam_settlement
+     * ```
+     */
+    getHandlerInfo(): Promise<UCPHandlerInfo>;
+    /**
+     * Get an FX quote for a settlement corridor
+     *
+     * @example
+     * ```typescript
+     * const quote = await payos.ucp.getQuote({
+     *   corridor: 'pix',
+     *   amount: 100,
+     *   currency: 'USD',
+     * });
+     * console.log(`${quote.from_amount} USD = ${quote.to_amount} BRL`);
+     * ```
+     */
+    getQuote(request: UCPQuoteRequest): Promise<UCPQuote>;
+    /**
+     * Acquire a settlement token for completing a UCP checkout
+     *
+     * Tokens are valid for 15 minutes and lock in the FX rate.
+     *
+     * @example
+     * ```typescript
+     * const token = await payos.ucp.acquireToken({
+     *   corridor: 'pix',
+     *   amount: 100,
+     *   currency: 'USD',
+     *   recipient: {
+     *     type: 'pix',
+     *     pix_key: '12345678901',
+     *     pix_key_type: 'cpf',
+     *     name: 'Maria Silva',
+     *   },
+     * });
+     *
+     * console.log(token.token); // ucp_tok_...
+     * console.log(token.quote.to_amount); // 595.00 BRL
+     * ```
+     */
+    acquireToken(request: UCPTokenRequest): Promise<UCPToken>;
+    /**
+     * Complete settlement using a previously acquired token
+     *
+     * @example
+     * ```typescript
+     * const settlement = await payos.ucp.settle({
+     *   token: 'ucp_tok_...',
+     *   idempotency_key: 'checkout_12345',
+     * });
+     *
+     * console.log(settlement.status); // pending
+     * console.log(settlement.id); // Use this to track status
+     * ```
+     */
+    settle(request: UCPSettleRequest): Promise<UCPSettlement>;
+    /**
+     * Get settlement status by ID
+     *
+     * @example
+     * ```typescript
+     * const settlement = await payos.ucp.getSettlement('uuid');
+     * if (settlement.status === 'completed') {
+     *   console.log(`Completed at ${settlement.completed_at}`);
+     * }
+     * ```
+     */
+    getSettlement(settlementId: string): Promise<UCPSettlement>;
+    /**
+     * List settlements with optional filtering
+     *
+     * @example
+     * ```typescript
+     * const { data, pagination } = await payos.ucp.listSettlements({
+     *   status: 'completed',
+     *   corridor: 'pix',
+     *   limit: 50,
+     * });
+     * ```
+     */
+    listSettlements(options?: ListSettlementsOptions): Promise<ListSettlementsResponse>;
+    /**
+     * Create a checkout session with a UCP merchant
+     *
+     * @example
+     * ```typescript
+     * const checkout = await payos.ucp.createCheckout('https://shop.example.com', {
+     *   line_items: [
+     *     { product_id: 'prod_123', quantity: 2 },
+     *   ],
+     *   buyer: { email: 'buyer@example.com' },
+     * });
+     *
+     * console.log(checkout.totals.total);
+     * ```
+     */
+    createCheckout(merchantUrl: string, request: UCPCheckoutRequest): Promise<UCPCheckout>;
+    /**
+     * Complete a checkout with PayOS LATAM settlement
+     *
+     * This is a convenience method that:
+     * 1. Acquires a settlement token
+     * 2. Completes the checkout with the merchant
+     *
+     * @example
+     * ```typescript
+     * const order = await payos.ucp.completeCheckout(
+     *   'https://shop.example.com',
+     *   checkout.id,
+     *   {
+     *     corridor: 'pix',
+     *     recipient: {
+     *       type: 'pix',
+     *       pix_key: '12345678901',
+     *       pix_key_type: 'cpf',
+     *       name: 'Maria Silva',
+     *     },
+     *   }
+     * );
+     *
+     * console.log(order.id);
+     * console.log(order.payment.settlement_id);
+     * ```
+     */
+    completeCheckout(merchantUrl: string, checkoutId: string, settlement: {
+        corridor: 'pix' | 'spei';
+        recipient: UCPTokenRequest['recipient'];
+    }): Promise<UCPOrder>;
+    /**
+     * Clear the profile cache (useful for testing)
+     */
+    clearCache(): void;
+    /**
+     * Check if PayOS supports a specific corridor
+     *
+     * @example
+     * ```typescript
+     * if (await payos.ucp.supportsCorridors('USD', 'BRL', 'pix')) {
+     *   // Can settle via Pix
+     * }
+     * ```
+     */
+    supportsCorridor(sourceCurrency: string, destinationCurrency: string, rail: string): Promise<boolean>;
+    /**
+     * Create Pix recipient helper
+     *
+     * @example
+     * ```typescript
+     * const recipient = payos.ucp.createPixRecipient({
+     *   pix_key: '12345678901',
+     *   pix_key_type: 'cpf',
+     *   name: 'Maria Silva',
+     * });
+     * ```
+     */
+    createPixRecipient(params: {
+        pix_key: string;
+        pix_key_type: 'cpf' | 'cnpj' | 'email' | 'phone' | 'evp';
+        name: string;
+        tax_id?: string;
+    }): UCPTokenRequest['recipient'];
+    /**
+     * Create SPEI recipient helper
+     *
+     * @example
+     * ```typescript
+     * const recipient = payos.ucp.createSpeiRecipient({
+     *   clabe: '012345678901234567',
+     *   name: 'Juan Garcia',
+     * });
+     * ```
+     */
+    createSpeiRecipient(params: {
+        clabe: string;
+        name: string;
+        rfc?: string;
+    }): UCPTokenRequest['recipient'];
+    /**
+     * Create a PayOS-hosted checkout session
+     *
+     * @example
+     * ```typescript
+     * const checkout = await payos.ucp.checkouts.create({
+     *   currency: 'USD',
+     *   line_items: [
+     *     { id: 'item_1', name: 'Product', quantity: 1, unit_price: 1000, total_price: 1000, currency: 'USD' }
+     *   ],
+     *   buyer: { email: 'buyer@example.com' },
+     * });
+     * ```
+     */
+    get checkouts(): {
+        create: (request: CreatePayOSCheckoutRequest) => Promise<PayOSCheckout>;
+        get: (checkoutId: string) => Promise<PayOSCheckout>;
+        update: (checkoutId: string, request: UpdatePayOSCheckoutRequest) => Promise<PayOSCheckout>;
+        complete: (checkoutId: string) => Promise<PayOSCheckout>;
+        cancel: (checkoutId: string) => Promise<PayOSCheckout>;
+        addPaymentInstrument: (checkoutId: string, instrument: {
+            id: string;
+            handler: string;
+            type: string;
+            last4?: string;
+            brand?: string;
+        }) => Promise<PayOSCheckout>;
+    };
+    /**
+     * Manage PayOS orders
+     *
+     * @example
+     * ```typescript
+     * const order = await payos.ucp.orders.get('ord_123');
+     * const orders = await payos.ucp.orders.list({ status: 'processing' });
+     * ```
+     */
+    get orders(): {
+        get: (orderId: string) => Promise<PayOSOrder>;
+        list: (options?: ListPayOSOrdersOptions) => Promise<ListPayOSOrdersResponse>;
+        updateStatus: (orderId: string, status: PayOSOrderStatus) => Promise<PayOSOrder>;
+        cancel: (orderId: string, reason?: string) => Promise<PayOSOrder>;
+        addExpectation: (orderId: string, expectation: Omit<PayOSExpectation, "id">) => Promise<PayOSOrder>;
+        updateExpectation: (orderId: string, expectationId: string, updates: Partial<Omit<PayOSExpectation, "id">>) => Promise<PayOSOrder>;
+        addEvent: (orderId: string, event: Omit<PayOSFulfillmentEvent, "id" | "timestamp">) => Promise<PayOSOrder>;
+        getEvents: (orderId: string) => Promise<{
+            data: PayOSFulfillmentEvent[];
+        }>;
+        addAdjustment: (orderId: string, adjustment: Omit<PayOSAdjustment, "id" | "created_at">) => Promise<PayOSOrder>;
+    };
+    /**
+     * OAuth 2.0 identity linking for AI agents/platforms
+     *
+     * @example
+     * ```typescript
+     * // Register an OAuth client
+     * const { client, client_secret } = await payos.ucp.identity.registerClient({
+     *   name: 'My AI Agent',
+     *   redirect_uris: ['https://myagent.com/callback'],
+     * });
+     *
+     * // List linked accounts
+     * const accounts = await payos.ucp.identity.listLinkedAccounts({ buyer_id: 'buyer_123' });
+     * ```
+     */
+    get identity(): {
+        /**
+         * Register an OAuth client (platform/agent)
+         */
+        registerClient: (request: RegisterOAuthClientRequest) => Promise<RegisterOAuthClientResponse>;
+        /**
+         * Get authorization info for consent screen
+         */
+        getAuthorizationInfo: (params: {
+            response_type: "code";
+            client_id: string;
+            redirect_uri: string;
+            scope: string;
+            state: string;
+            code_challenge?: string;
+            code_challenge_method?: "S256" | "plain";
+        }) => Promise<UCPAuthorizationInfo>;
+        /**
+         * Submit consent decision (after user authenticates)
+         */
+        submitConsent: (request: UCPConsentRequest) => Promise<UCPConsentResponse>;
+        /**
+         * Exchange authorization code for tokens
+         */
+        exchangeCode: (params: {
+            client_id: string;
+            client_secret?: string;
+            code: string;
+            redirect_uri: string;
+            code_verifier?: string;
+        }) => Promise<UCPTokenResponse>;
+        /**
+         * Refresh tokens
+         */
+        refreshTokens: (params: {
+            client_id: string;
+            client_secret?: string;
+            refresh_token: string;
+        }) => Promise<UCPTokenResponse>;
+        /**
+         * Revoke a token
+         */
+        revokeToken: (params: {
+            token: string;
+            token_type_hint?: "access_token" | "refresh_token";
+            client_id: string;
+            client_secret?: string;
+        }) => Promise<{
+            success: boolean;
+        }>;
+        /**
+         * List linked accounts
+         */
+        listLinkedAccounts: (params: {
+            buyer_id?: string;
+            platform_id?: string;
+            limit?: number;
+            offset?: number;
+        }) => Promise<{
+            data: UCPLinkedAccount[];
+            pagination?: {
+                limit: number;
+                offset: number;
+                total: number;
+            };
+        }>;
+        /**
+         * Unlink an account
+         */
+        unlinkAccount: (accountId: string, buyerId: string) => Promise<{
+            success: boolean;
+        }>;
+        /**
+         * Get available scopes
+         */
+        getScopes: () => Promise<{
+            data: UCPScopeInfo[];
+        }>;
+    };
+}
+
+export { type CreatePayOSCheckoutRequest, type ListPayOSOrdersOptions, type ListPayOSOrdersResponse, type ListSettlementsOptions, type ListSettlementsResponse, type PayOSAdjustment, type PayOSBuyer, type PayOSCheckout, type PayOSCheckoutMessage, type PayOSCheckoutStatus, type PayOSExpectation, type PayOSFulfillmentEvent, type PayOSLineItem, type PayOSLink, type PayOSOrder, type PayOSOrderPayment, type PayOSOrderStatus, type PayOSPaymentConfig, type PayOSPaymentInstrument, type PayOSTotal, type RegisterOAuthClientRequest, type RegisterOAuthClientResponse, type UCPAddress, type UCPAuthorizationInfo, type UCPCapability, type UCPCheckout, type UCPCheckoutRequest, UCPClient, type UCPCompleteCheckoutRequest, type UCPConsentRequest, type UCPConsentResponse, type UCPCorridor, type UCPHandlerInfo, type UCPIdentityScope, type UCPLineItem, type UCPLinkedAccount, type UCPOAuthClient, type UCPOrder, type UCPPaymentHandler, type UCPPixRecipient, type UCPProfile, type UCPQuote, type UCPQuoteRequest, type UCPRecipient, type UCPScopeInfo, type UCPService, type UCPSettleRequest, type UCPSettlement, type UCPSpeiRecipient, type UCPToken, type UCPTokenRequest, type UCPTokenResponse, type UpdatePayOSCheckoutRequest };