@sly_ai/sdk 0.1.0

package/dist/types-df1EICn_.d.mts

@@ -0,0 +1,165 @@
+/**
+ * Core type definitions for the Sly SDK
+ */
+/**
+ * SDK environment configuration
+ */
+type SlyEnvironment = 'sandbox' | 'testnet' | 'production';
+type PayOSEnvironment = SlyEnvironment;
+/**
+ * Environment-specific configuration
+ */
+interface EnvironmentConfig {
+    apiUrl: string;
+    facilitatorUrl?: string;
+}
+/**
+ * Sly SDK configuration options
+ */
+interface SlyConfig {
+    /**
+     * Sly API key
+     */
+    apiKey: string;
+    /**
+     * Environment to connect to (optional — auto-inferred from API key prefix)
+     * - sandbox: Base Sepolia testnet (pk_test_* / pk_sandbox_*)
+     * - testnet: Alias for sandbox
+     * - production: Base mainnet (pk_live_*)
+     *
+     * If omitted, inferred from apiKey prefix. Explicit value overrides inference.
+     */
+    environment?: SlyEnvironment;
+    /**
+     * EVM private key (required for testnet/production x402)
+     * Not needed for sandbox mode
+     */
+    evmPrivateKey?: string;
+    /**
+     * Custom API URL (overrides environment default)
+     */
+    apiUrl?: string;
+    /**
+     * Custom facilitator URL for x402 (overrides environment default)
+     */
+    facilitatorUrl?: string;
+}
+type PayOSConfig = SlyConfig;
+/**
+ * Payment protocol types supported by PayOS
+ */
+type PaymentProtocol = 'x402' | 'ap2' | 'acp' | 'direct';
+/**
+ * Settlement rail types
+ */
+type SettlementRail = 'pix' | 'spei' | 'wire' | 'usdc';
+/**
+ * Supported currencies
+ */
+type Currency = 'USD' | 'BRL' | 'MXN' | 'USDC';
+/**
+ * Settlement quote request
+ */
+interface SettlementQuoteRequest {
+    fromCurrency: Currency;
+    toCurrency: Currency;
+    amount: string;
+    rail?: SettlementRail;
+}
+/**
+ * Settlement quote response
+ */
+interface SettlementQuote {
+    id: string;
+    fromCurrency: Currency;
+    toCurrency: Currency;
+    fromAmount: string;
+    toAmount: string;
+    fxRate: string;
+    fees: {
+        platformFee: string;
+        fxFee: string;
+        railFee: string;
+        total: string;
+    };
+    rail: SettlementRail;
+    expiresAt: string;
+    estimatedSettlementSeconds: number;
+}
+/**
+ * Settlement creation request
+ */
+interface CreateSettlementRequest {
+    quoteId: string;
+    destinationAccountId: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Settlement status
+ */
+type SettlementStatus = 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled';
+/**
+ * Settlement response
+ */
+interface Settlement {
+    id: string;
+    quoteId: string;
+    status: SettlementStatus;
+    fromAmount: string;
+    fromCurrency: Currency;
+    toAmount: string;
+    toCurrency: Currency;
+    rail: SettlementRail;
+    destinationAccountId: string;
+    createdAt: string;
+    completedAt?: string;
+    failureReason?: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Compliance check request
+ */
+interface ComplianceCheckRequest {
+    recipientAccountId: string;
+    amount: string;
+    currency: Currency;
+}
+/**
+ * Compliance check response
+ */
+interface ComplianceCheckResponse {
+    approved: boolean;
+    flags: string[];
+    requiredActions: string[];
+    message?: string;
+}
+/**
+ * API capability definition
+ */
+interface Capability {
+    name: string;
+    description: string;
+    category: string;
+    endpoint: string;
+    parameters: Record<string, unknown>;
+    returns: Record<string, unknown>;
+    errors: string[];
+    supportsSimulation: boolean;
+    supportsIdempotency: boolean;
+}
+/**
+ * Capabilities response
+ */
+interface CapabilitiesResponse {
+    apiVersion: string;
+    capabilities: Capability[];
+    limits: {
+        rateLimit: string;
+        maxTransfer: string;
+    };
+    supportedCurrencies: Currency[];
+    supportedRails: SettlementRail[];
+    webhookEvents: string[];
+}
+
+export type { ComplianceCheckResponse as C, EnvironmentConfig as E, PayOSEnvironment as P, SettlementQuote as S, Settlement as a, SlyConfig as b, SettlementQuoteRequest as c, CreateSettlementRequest as d, ComplianceCheckRequest as e, CapabilitiesResponse as f, SlyEnvironment as g, Capability as h, PayOSConfig as i, PaymentProtocol as j, SettlementRail as k, Currency as l, SettlementStatus as m };

package/dist/types-df1EICn_.d.ts

@@ -0,0 +1,165 @@
+/**
+ * Core type definitions for the Sly SDK
+ */
+/**
+ * SDK environment configuration
+ */
+type SlyEnvironment = 'sandbox' | 'testnet' | 'production';
+type PayOSEnvironment = SlyEnvironment;
+/**
+ * Environment-specific configuration
+ */
+interface EnvironmentConfig {
+    apiUrl: string;
+    facilitatorUrl?: string;
+}
+/**
+ * Sly SDK configuration options
+ */
+interface SlyConfig {
+    /**
+     * Sly API key
+     */
+    apiKey: string;
+    /**
+     * Environment to connect to (optional — auto-inferred from API key prefix)
+     * - sandbox: Base Sepolia testnet (pk_test_* / pk_sandbox_*)
+     * - testnet: Alias for sandbox
+     * - production: Base mainnet (pk_live_*)
+     *
+     * If omitted, inferred from apiKey prefix. Explicit value overrides inference.
+     */
+    environment?: SlyEnvironment;
+    /**
+     * EVM private key (required for testnet/production x402)
+     * Not needed for sandbox mode
+     */
+    evmPrivateKey?: string;
+    /**
+     * Custom API URL (overrides environment default)
+     */
+    apiUrl?: string;
+    /**
+     * Custom facilitator URL for x402 (overrides environment default)
+     */
+    facilitatorUrl?: string;
+}
+type PayOSConfig = SlyConfig;
+/**
+ * Payment protocol types supported by PayOS
+ */
+type PaymentProtocol = 'x402' | 'ap2' | 'acp' | 'direct';
+/**
+ * Settlement rail types
+ */
+type SettlementRail = 'pix' | 'spei' | 'wire' | 'usdc';
+/**
+ * Supported currencies
+ */
+type Currency = 'USD' | 'BRL' | 'MXN' | 'USDC';
+/**
+ * Settlement quote request
+ */
+interface SettlementQuoteRequest {
+    fromCurrency: Currency;
+    toCurrency: Currency;
+    amount: string;
+    rail?: SettlementRail;
+}
+/**
+ * Settlement quote response
+ */
+interface SettlementQuote {
+    id: string;
+    fromCurrency: Currency;
+    toCurrency: Currency;
+    fromAmount: string;
+    toAmount: string;
+    fxRate: string;
+    fees: {
+        platformFee: string;
+        fxFee: string;
+        railFee: string;
+        total: string;
+    };
+    rail: SettlementRail;
+    expiresAt: string;
+    estimatedSettlementSeconds: number;
+}
+/**
+ * Settlement creation request
+ */
+interface CreateSettlementRequest {
+    quoteId: string;
+    destinationAccountId: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Settlement status
+ */
+type SettlementStatus = 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled';
+/**
+ * Settlement response
+ */
+interface Settlement {
+    id: string;
+    quoteId: string;
+    status: SettlementStatus;
+    fromAmount: string;
+    fromCurrency: Currency;
+    toAmount: string;
+    toCurrency: Currency;
+    rail: SettlementRail;
+    destinationAccountId: string;
+    createdAt: string;
+    completedAt?: string;
+    failureReason?: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Compliance check request
+ */
+interface ComplianceCheckRequest {
+    recipientAccountId: string;
+    amount: string;
+    currency: Currency;
+}
+/**
+ * Compliance check response
+ */
+interface ComplianceCheckResponse {
+    approved: boolean;
+    flags: string[];
+    requiredActions: string[];
+    message?: string;
+}
+/**
+ * API capability definition
+ */
+interface Capability {
+    name: string;
+    description: string;
+    category: string;
+    endpoint: string;
+    parameters: Record<string, unknown>;
+    returns: Record<string, unknown>;
+    errors: string[];
+    supportsSimulation: boolean;
+    supportsIdempotency: boolean;
+}
+/**
+ * Capabilities response
+ */
+interface CapabilitiesResponse {
+    apiVersion: string;
+    capabilities: Capability[];
+    limits: {
+        rateLimit: string;
+        maxTransfer: string;
+    };
+    supportedCurrencies: Currency[];
+    supportedRails: SettlementRail[];
+    webhookEvents: string[];
+}
+
+export type { ComplianceCheckResponse as C, EnvironmentConfig as E, PayOSEnvironment as P, SettlementQuote as S, Settlement as a, SlyConfig as b, SettlementQuoteRequest as c, CreateSettlementRequest as d, ComplianceCheckRequest as e, CapabilitiesResponse as f, SlyEnvironment as g, Capability as h, PayOSConfig as i, PaymentProtocol as j, SettlementRail as k, Currency as l, SettlementStatus as m };