@beep-it/sdk-core 0.2.0 → 0.3.0

package/dist/modules/payments.d.ts

@@ -1,8 +1,8 @@
 import { AxiosInstance } from 'axios';
-import { BeepPurchaseAsset, CheckPaymentStatusPayload, CheckPaymentStatusResponse, IssuePaymentPayload, IssuePaymentResponse, PauseStreamingPayload, PauseStreamingResponse, PaymentRequestData, RequestAndPurchaseAssetRequestParams, SignSolanaTransactionData, SignSolanaTransactionParams, StartStreamingPayload, StartStreamingResponse, StopStreamingPayload, StopStreamingResponse } from '../types';
+import { BeepPurchaseAsset, CheckPaymentStatusPayload, CheckPaymentStatusResponse, IssuePaymentPayload, IssuePaymentResponse, PauseStreamingPayload, PauseStreamingResponse, PaymentRequestData, RequestAndPurchaseAssetRequestParams, StartStreamingPayload, StartStreamingResponse, StopStreamingPayload, StopStreamingResponse } from '../types';
 /**
- * Module for handling payment operations including asset purchases and Solana transactions
- * Provides methods for creating payment requests and signing blockchain transactions
+ * Module for handling payment operations including asset purchases and SUI transactions
+ * Provides methods for creating payment requests and processing blockchain transactions
  */
 export declare class PaymentsModule {
     private client;
@@ -13,14 +13,16 @@ export declare class PaymentsModule {
      *
      * Notes:
      * - Do not pass walletId. The server derives the wallet based on your API key's merchant and requested chain.
-     * - amount must be in smallest units for the token (e.g., 6‑decimals USDC amount as an integer string).
+     * - amount is a human-readable decimal string (e.g., "1.0" for 1 USDC, "0.5" for 0.5 SUI).
+     *   The server converts to the token's base units internally.
+     * - Minimum: 0.01 per transaction. Maximum: 100,000 per transaction.
      * - This endpoint responds immediately with acceptance/rejection. Actual transfer executes asynchronously after funds are reserved.
      *
      * Example:
      * const res = await beep.payments.createPayout({
-     *   amount: '1000000', // 1.0 USDC with 6 decimals
+     *   amount: '1.50',  // 1.50 USDC (human-readable)
      *   destinationWalletAddress: 'DEST_ADDRESS',
-     *   chain: 'SOLANA',
+     *   chain: 'SUI',
      *   token: 'USDC',
      * });
      */
@@ -61,7 +63,7 @@ export declare class PaymentsModule {
      *
      * Phase 1 – Request payment (no paymentReference):
      * - Server responds with HTTP 402 Payment Required and a payload containing:
-     *   referenceKey, paymentUrl (Solana Pay), optional qrCode, amount, expiresAt, status.
+     *   referenceKey, paymentUrl, optional qrCode, amount, expiresAt, status.
      * - The SDK normalizes this by returning the payload (even when status code is 402).
      * - The caller must instruct the user to pay via their wallet using paymentUrl/qrCode.
      *
@@ -92,33 +94,6 @@ export declare class PaymentsModule {
      * const isPaid = !check?.referenceKey; // When no referenceKey is returned, payment is complete
      */
     requestAndPurchaseAsset(input: RequestAndPurchaseAssetRequestParams): Promise<PaymentRequestData | null>;
-    /**
-     * Signs a Solana transaction for direct blockchain payment processing
-     *
-     * @param input - Transaction parameters including addresses, amounts, and token details
-     * @returns Promise that resolves to signed transaction data
-     * @throws {Error} When transaction signing fails or required fields are missing
-     *
-     * @example
-     * ```typescript
-     * try {
-     *   const signedTx = await beep.payments.signSolanaTransaction({
-     *     senderAddress: 'sender_wallet_address',
-     *     recipientAddress: 'recipient_wallet_address',
-     *     tokenMintAddress: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
-     *     amount: 1000000, // 1.0 USDT in base units
-     *     decimals: 6
-     *   });
-     *
-     *   if (signedTx) {
-     *     console.log('Transaction ready for broadcast:', signedTx.signedTransaction);
-     *   }
-     * } catch (error) {
-     *   console.error('Transaction signing failed:', error);
-     * }
-     * ```
-     */
-    signSolanaTransaction(input: SignSolanaTransactionParams): Promise<SignSolanaTransactionData | null>;
     /**
      * Issues a payment request for streaming charges with specified asset chunks
      *

package/dist/modules/payments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/modules/payments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,aAAa,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,EACL,iBAAiB,EACjB,yBAAyB,EACzB,0BAA0B,EAC1B,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,oCAAoC,EAEpC,yBAAyB,EACzB,2BAA2B,EAE3B,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,UAAU,CAAC;AAIlB;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAgB;gBAElB,MAAM,EAAE,aAAa;IAIjC;;;;;;;;;;;;;;;;OAgBG;IACU,YAAY,CAAC,MAAM,EAAE;QAChC,MAAM,EAAE,MAAM,CAAC;QACf,wBAAwB,EAAE,MAAM,CAAC;QACjC,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC;QACV,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;QAChC,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IAKF;;;OAGG;IACU,wBAAwB,CAAC,OAAO,EAAE;QAC7C,MAAM,EAAE,iBAAiB,EAAE,CAAC;QAC5B,gBAAgB,EAAE,MAAM,CAAC;QACzB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI,KAAK,IAAI,CAAC;QACzD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;KACpC,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;KAAE,CAAC;IA+DhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,uBAAuB,CAC3B,KAAK,EAAE,oCAAoC,GAC1C,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAuBrC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,qBAAqB,CAChC,KAAK,EAAE,2BAA2B,GACjC,OAAO,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAiC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQ/E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAKrF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAKrF;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAKlF;;;;;OAKG;IAEG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;CAIjG"}
+{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/modules/payments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,aAAa,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,EACL,iBAAiB,EACjB,yBAAyB,EACzB,0BAA0B,EAC1B,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,oCAAoC,EAEpC,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,UAAU,CAAC;AAGlB;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAgB;gBAElB,MAAM,EAAE,aAAa;IAIjC;;;;;;;;;;;;;;;;;;OAkBG;IACU,YAAY,CAAC,MAAM,EAAE;QAChC,MAAM,EAAE,MAAM,CAAC;QACf,wBAAwB,EAAE,MAAM,CAAC;QACjC,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC;QACV,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;QAChC,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IAKF;;;OAGG;IACU,wBAAwB,CAAC,OAAO,EAAE;QAC7C,MAAM,EAAE,iBAAiB,EAAE,CAAC;QAC5B,gBAAgB,EAAE,MAAM,CAAC;QACzB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI,KAAK,IAAI,CAAC;QACzD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;KACpC,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;KAAE,CAAC;IA+DhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,uBAAuB,CAC3B,KAAK,EAAE,oCAAoC,GAC1C,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IA2BrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQ/E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAKrF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAKrF;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAKlF;;;;;OAKG;IAEG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;CAIjG"}

package/dist/modules/products.d.ts

@@ -23,7 +23,7 @@ export declare class ProductsModule {
      *   name: 'Premium License',
      *   description: 'Lifetime access to premium features',
      *   price: '99.99',
-     *   token: SupportedToken.USDT,
+     *   token: SupportedToken.USDC,
      *   isSubscription: false
      * });
      *
@@ -32,7 +32,7 @@ export declare class ProductsModule {
      *   name: 'Monthly Pro Plan',
      *   description: 'Monthly subscription with full access',
      *   price: '19.99',
-     *   token: SupportedToken.USDT,
+     *   token: SupportedToken.USDC,
      *   isSubscription: true
      * });
      * ```

package/dist/types/common.d.ts

@@ -0,0 +1,197 @@
+/**
+ * @fileoverview Common types and utilities used across the BEEP SDK
+ */
+/**
+ * Represents a monetary amount as a decimal string
+ * @example "10.50" represents $10.50
+ * @example "0.99" represents $0.99
+ */
+export type MoneyAmount = string;
+/**
+ * UUID v4 string format
+ * @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+ * @example "123e4567-e89b-12d3-a456-426614174000"
+ */
+export type UUID = string;
+/**
+ * ISO 8601 datetime string
+ * @format date-time
+ * @example "2023-12-25T10:30:00Z"
+ */
+export type ISODateTime = string;
+/**
+ * Blockchain transaction signature
+ * @example "5J3mBbAH58CpQ3Y5RNJpUKPE62jPJzqiPbZ4FwFeMr4xdHkfqGoeKv"
+ */
+export type TransactionSignature = string;
+/**
+ * Blockchain wallet address
+ * @example "0x742d35Cc6634C0532925a3b844Bc9e7595f56789"
+ */
+export type WalletAddress = string;
+/**
+ * Supported blockchain networks in BEEP
+ */
+export declare enum BlockchainNetwork {
+    /** SUI blockchain network */
+    SUI = "SUI",
+    /** Solana blockchain network */
+    SOLANA = "SOLANA"
+}
+/**
+ * Common API response wrapper
+ * @template T The type of data contained in the response
+ */
+export interface ApiResponse<T> {
+    /** Indicates if the request was successful */
+    success: boolean;
+    /** Response data when successful */
+    data?: T;
+    /** Error message when unsuccessful */
+    error?: string;
+    /** Additional error details */
+    details?: Record<string, any>;
+    /** Request tracking ID for support */
+    requestId?: string;
+}
+/**
+ * Pagination parameters for list endpoints
+ */
+export interface PaginationParams {
+    /** Maximum number of items to return (1-100) */
+    limit?: number;
+    /** Number of items to skip */
+    offset?: number;
+    /** Cursor for pagination */
+    cursor?: string;
+}
+/**
+ * Paginated response wrapper
+ * @template T The type of items in the list
+ */
+export interface PaginatedResponse<T> extends ApiResponse<T[]> {
+    /** Total number of items available */
+    total?: number;
+    /** Pagination metadata */
+    pagination?: {
+        /** Current page number */
+        page: number;
+        /** Items per page */
+        limit: number;
+        /** Total number of pages */
+        totalPages: number;
+        /** Cursor for next page */
+        nextCursor?: string;
+        /** Cursor for previous page */
+        prevCursor?: string;
+    };
+}
+/**
+ * Sort order for list endpoints
+ */
+export declare enum SortOrder {
+    /** Ascending order (oldest/smallest first) */
+    ASC = "asc",
+    /** Descending order (newest/largest first) */
+    DESC = "desc"
+}
+/**
+ * Common sorting parameters
+ */
+export interface SortParams {
+    /** Field to sort by */
+    sortBy?: string;
+    /** Sort order */
+    sortOrder?: SortOrder;
+}
+/**
+ * Date range filter
+ */
+export interface DateRangeFilter {
+    /** Start date (inclusive) */
+    from?: ISODateTime;
+    /** End date (inclusive) */
+    to?: ISODateTime;
+}
+/**
+ * Status indicator for various entities
+ */
+export declare enum EntityStatus {
+    /** Entity is active and operational */
+    ACTIVE = "active",
+    /** Entity is temporarily disabled */
+    INACTIVE = "inactive",
+    /** Entity is pending activation */
+    PENDING = "pending",
+    /** Entity has been deleted */
+    DELETED = "deleted",
+    /** Entity is archived */
+    ARCHIVED = "archived"
+}
+/**
+ * Generic filter parameters for list endpoints
+ */
+export interface FilterParams extends PaginationParams, SortParams {
+    /** Filter by status */
+    status?: EntityStatus | EntityStatus[];
+    /** Date range filter */
+    dateRange?: DateRangeFilter;
+    /** Search query */
+    search?: string;
+    /** Additional custom filters */
+    filters?: Record<string, any>;
+}
+/**
+ * Webhook event types
+ */
+export declare enum WebhookEventType {
+    /** Payment completed successfully */
+    PAYMENT_COMPLETED = "payment.completed",
+    /** Payment failed */
+    PAYMENT_FAILED = "payment.failed",
+    /** Invoice paid */
+    INVOICE_PAID = "invoice.paid",
+    /** Invoice expired */
+    INVOICE_EXPIRED = "invoice.expired",
+    /** Product created */
+    PRODUCT_CREATED = "product.created",
+    /** Product updated */
+    PRODUCT_UPDATED = "product.updated",
+    /** Subscription activated */
+    SUBSCRIPTION_ACTIVATED = "subscription.activated",
+    /** Subscription cancelled */
+    SUBSCRIPTION_CANCELLED = "subscription.cancelled"
+}
+/**
+ * Webhook payload structure
+ * @template T The type of data in the webhook
+ */
+export interface WebhookPayload<T> {
+    /** Unique event ID */
+    id: UUID;
+    /** Event type */
+    type: WebhookEventType;
+    /** Timestamp of the event */
+    timestamp: ISODateTime;
+    /** Event data */
+    data: T;
+    /** HMAC signature for verification */
+    signature: string;
+}
+/**
+ * Type guard to check if a value is a valid UUID
+ */
+export declare function isUUID(value: any): value is UUID;
+/**
+ * Type guard to check if a value is a valid money amount
+ */
+export declare function isMoneyAmount(value: any): value is MoneyAmount;
+/**
+ * Format a number as a money amount string
+ */
+export declare function formatMoneyAmount(amount: number, decimals?: number): MoneyAmount;
+/**
+ * Parse a money amount string to number
+ */
+export declare function parseMoneyAmount(amount: MoneyAmount): number;
+//# sourceMappingURL=common.d.ts.map

package/dist/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/types/common.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAE1B;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,6BAA6B;IAC7B,GAAG,QAAQ;IACX,gCAAgC;IAChC,MAAM,WAAW;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,8CAA8C;IAC9C,OAAO,EAAE,OAAO,CAAC;IACjB,oCAAoC;IACpC,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW,CAAC,CAAC,EAAE,CAAC;IAC5D,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,UAAU,CAAC,EAAE;QACX,0BAA0B;QAC1B,IAAI,EAAE,MAAM,CAAC;QACb,qBAAqB;QACrB,KAAK,EAAE,MAAM,CAAC;QACd,4BAA4B;QAC5B,UAAU,EAAE,MAAM,CAAC;QACnB,2BAA2B;QAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,+BAA+B;QAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,oBAAY,SAAS;IACnB,8CAA8C;IAC9C,GAAG,QAAQ;IACX,8CAA8C;IAC9C,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,6BAA6B;IAC7B,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,2BAA2B;IAC3B,EAAE,CAAC,EAAE,WAAW,CAAC;CAClB;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB,uCAAuC;IACvC,MAAM,WAAW;IACjB,qCAAqC;IACrC,QAAQ,aAAa;IACrB,mCAAmC;IACnC,OAAO,YAAY;IACnB,8BAA8B;IAC9B,OAAO,YAAY;IACnB,yBAAyB;IACzB,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,gBAAgB,EAAE,UAAU;IAChE,uBAAuB;IACvB,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY,EAAE,CAAC;IACvC,wBAAwB;IACxB,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,mBAAmB;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,qCAAqC;IACrC,iBAAiB,sBAAsB;IACvC,qBAAqB;IACrB,cAAc,mBAAmB;IACjC,mBAAmB;IACnB,YAAY,iBAAiB;IAC7B,sBAAsB;IACtB,eAAe,oBAAoB;IACnC,sBAAsB;IACtB,eAAe,oBAAoB;IACnC,sBAAsB;IACtB,eAAe,oBAAoB;IACnC,6BAA6B;IAC7B,sBAAsB,2BAA2B;IACjD,6BAA6B;IAC7B,sBAAsB,2BAA2B;CAClD;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,sBAAsB;IACtB,EAAE,EAAE,IAAI,CAAC;IACT,iBAAiB;IACjB,IAAI,EAAE,gBAAgB,CAAC;IACvB,6BAA6B;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,iBAAiB;IACjB,IAAI,EAAE,CAAC,CAAC;IACR,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,IAAI,CAIhD;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,WAAW,CAI9D;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAU,GAAG,WAAW,CAEnF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAE5D"}

package/dist/types/enhanced-payment.d.ts

@@ -0,0 +1,311 @@
+/**
+ * @fileoverview Enhanced payment types with comprehensive documentation and type safety
+ */
+import { UUID, MoneyAmount, ISODateTime, TransactionSignature, WalletAddress } from './common';
+import { InvoiceStatus } from './invoice';
+import { SupportedToken } from './token';
+/**
+ * Asset reference for purchasing existing products
+ * @example
+ * ```typescript
+ * const asset: BeepPurchaseAsset = {
+ *   assetId: '123e4567-e89b-12d3-a456-426614174000',
+ *   quantity: 2,
+ *   name: 'Premium Coffee', // Optional override
+ * };
+ * ```
+ */
+export interface BeepPurchaseAsset {
+    /** UUID of the existing product to purchase */
+    assetId: UUID;
+    /** Number of units to purchase (must be positive integer) */
+    quantity: number;
+    /** Optional name override for display purposes */
+    name?: string;
+    /** Optional description override for display purposes */
+    description?: string;
+}
+/**
+ * Parameters for requesting and purchasing assets
+ * @description Supports the 402 Payment Required flow for agent-compatible payments
+ * @example
+ * ```typescript
+ * // Initial request (no payment reference)
+ * const request: RequestAndPurchaseAssetParams = {
+ *   assets: [{ assetId: 'product-uuid', quantity: 1 }],
+ *   generateQrCode: true,
+ *   paymentLabel: 'My Store',
+ * };
+ *
+ * // Polling request (with payment reference)
+ * const pollRequest: RequestAndPurchaseAssetParams = {
+ *   assets: [{ assetId: 'product-uuid', quantity: 1 }],
+ *   paymentReference: response.referenceKey,
+ * };
+ * ```
+ */
+export interface RequestAndPurchaseAssetParams {
+    /** Array of assets to purchase */
+    assets: BeepPurchaseAsset[];
+    /**
+     * Payment reference from initial 402 response
+     * @description Include this when polling for payment completion
+     */
+    paymentReference?: string;
+    /**
+     * Generate QR code for mobile wallet payments
+     * @default true
+     */
+    generateQrCode?: boolean;
+    /**
+     * Label displayed in payment wallets
+     * @example "Coffee Shop - Downtown"
+     * @maxLength 50
+     */
+    paymentLabel?: string;
+}
+/**
+ * Payment request creation parameters
+ * @example
+ * ```typescript
+ * const payment: RequestPaymentPayload = {
+ *   amount: 25.50,
+ *   token: SupportedToken.USDC,
+ *   description: 'Premium subscription - 1 month',
+ *   metadata: {
+ *     userId: 'user-123',
+ *     plan: 'premium',
+ *   }
+ * };
+ * ```
+ */
+export interface RequestPaymentPayload {
+    /**
+     * Amount to charge in decimal format
+     * @min 0.01
+     * @example 10.50
+     */
+    amount: number;
+    /**
+     * Token type for payment
+     * @description Use either `token` or `splTokenAddress`, not both
+     */
+    token?: SupportedToken;
+    /**
+     * Custom token address
+     * @description Alternative to using the token enum
+     * @pattern ^[1-9A-HJ-NP-Za-km-z]{32,44}$
+     */
+    splTokenAddress?: string;
+    /**
+     * Human-readable payment description
+     * @maxLength 200
+     */
+    description?: string;
+    /**
+     * Custom metadata for your records
+     * @description This data is returned in webhooks and payment queries
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Webhook URL for payment notifications
+     * @format uri
+     * @example "https://api.example.com/webhooks/beep"
+     */
+    webhookUrl?: string;
+    /**
+     * Payment expiration time in minutes
+     * @default 15
+     * @min 5
+     * @max 1440
+     */
+    expirationMinutes?: number;
+}
+/**
+ * Payment request data structure (402 response)
+ * @description Returned when payment is required (HTTP 402)
+ */
+export interface PaymentRequestData {
+    /** Unique reference key for this payment request */
+    referenceKey: string;
+    /**
+     * Deep link URL for payment
+     * @format uri
+     * @example "sui:pay?recipient=..."
+     */
+    paymentUrl: string;
+    /**
+     * Base64-encoded QR code image
+     * @description Only present if generateQrCode was true
+     * @contentEncoding base64
+     * @contentMediaType image/png
+     */
+    qrCode?: string;
+    /** Total amount to be paid */
+    amount: MoneyAmount;
+    /** Token used for payment */
+    token: SupportedToken;
+    /** Recipient wallet address */
+    recipientAddress: WalletAddress;
+    /** Payment expiration timestamp */
+    expiresAt: ISODateTime;
+    /** Current payment status */
+    status: 'pending' | 'processing' | 'completed' | 'failed' | 'expired';
+}
+/**
+ * Successful payment response
+ * @description Returned when payment is completed successfully
+ */
+export interface PaymentSuccessResponse {
+    /** Payment receipt information */
+    receipt: {
+        /** Transaction ID on the blockchain */
+        transactionId: TransactionSignature;
+        /** Amount paid */
+        amount: MoneyAmount;
+        /** Token used */
+        token: SupportedToken;
+        /** Payment timestamp */
+        timestamp: ISODateTime;
+        /** Payer wallet address */
+        payerAddress: WalletAddress;
+        /** Recipient wallet address */
+        recipientAddress: WalletAddress;
+    };
+    /** Blockchain transaction signature */
+    txSignature: TransactionSignature;
+    /** Invoice ID if payment was for an invoice */
+    invoiceId?: UUID;
+    /** Custom metadata passed during payment creation */
+    metadata?: Record<string, any>;
+}
+/**
+ * Combined response type for request and purchase asset endpoint
+ * @description Can be either a payment request (402) or success response (200)
+ */
+export type RequestAndPurchaseAssetResponse = PaymentRequestData | PaymentSuccessResponse;
+/**
+ * Type guard to check if response is a payment request (402)
+ * @example
+ * ```typescript
+ * const response = await beep.payments.requestAndPurchaseAsset(params);
+ * if (isPaymentRequest(response)) {
+ *   // Show QR code to user
+ *   displayQR(response.qrCode);
+ * } else {
+ *   // Payment completed
+ *   console.log('Transaction:', response.txSignature);
+ * }
+ * ```
+ */
+export declare function isPaymentRequest(response: RequestAndPurchaseAssetResponse): response is PaymentRequestData;
+/**
+ * Type guard to check if response is a payment success
+ */
+export declare function isPaymentSuccess(response: RequestAndPurchaseAssetResponse): response is PaymentSuccessResponse;
+/**
+ * Payment status check parameters
+ */
+export interface CheckPaymentStatusPayload {
+    /** API key for authentication */
+    apiKey: string;
+    /**
+     * Invoice ID to check
+     * @description Provide either invoiceId or transactionReference
+     */
+    invoiceId?: UUID;
+    /**
+     * Transaction reference to check
+     * @description Provide either invoiceId or transactionReference
+     */
+    transactionReference?: string;
+}
+/**
+ * Payment status response
+ */
+export interface CheckPaymentStatusResponse {
+    /** Current payment status */
+    status: InvoiceStatus;
+    /** Transaction signature if payment is completed */
+    transactionSignature?: TransactionSignature;
+    /** Payment completion timestamp */
+    completedAt?: ISODateTime;
+    /** Error message if payment failed */
+    errorMessage?: string;
+    /** Additional status details */
+    details?: {
+        /** Number of confirmations on blockchain */
+        confirmations?: number;
+        /** Estimated completion time for pending payments */
+        estimatedCompletionTime?: ISODateTime;
+    };
+}
+/**
+ * Streaming payment session parameters
+ * @description Used for pay-as-you-go services and metered billing
+ * @example
+ * ```typescript
+ * const session: IssuePaymentPayload = {
+ *   apiKey: 'your_api_key',
+ *   assetChunks: [
+ *     { assetId: 'api-calls-product', quantity: 100 },
+ *     { assetId: 'storage-gb-product', quantity: 10 }
+ *   ],
+ *   payingMerchantId: 'merchant-uuid'
+ * };
+ * ```
+ */
+export interface IssuePaymentPayload {
+    /** API key for authentication */
+    apiKey: string;
+    /**
+     * Assets to be consumed during streaming session
+     * @description Each chunk represents a billable unit
+     */
+    assetChunks: BeepPurchaseAsset[];
+    /**
+     * Merchant ID who will be charged
+     * @description Must have sufficient balance or credit
+     */
+    payingMerchantId: UUID;
+    /**
+     * Maximum session duration in minutes
+     * @default 60
+     * @min 1
+     * @max 1440
+     */
+    maxDurationMinutes?: number;
+    /**
+     * Session metadata for tracking
+     */
+    metadata?: {
+        /** Session purpose or description */
+        purpose?: string;
+        /** Client application ID */
+        clientId?: string;
+        /** Additional custom fields */
+        [key: string]: any;
+    };
+}
+/**
+ * Streaming payment session response
+ */
+export interface IssuePaymentResponse {
+    /** Unique session ID for streaming payment */
+    sessionId: UUID;
+    /** Invoice ID for the streaming session */
+    invoiceId: UUID;
+    /** Session expiration timestamp */
+    expiresAt: ISODateTime;
+    /** Current session status */
+    status: 'active' | 'paused' | 'stopped' | 'expired';
+    /** Estimated cost based on asset chunks */
+    estimatedCost: {
+        /** Minimum cost if session ends immediately */
+        minimum: MoneyAmount;
+        /** Maximum cost if session runs full duration */
+        maximum: MoneyAmount;
+    };
+}
+export * from './streaming-payments';
+//# sourceMappingURL=enhanced-payment.d.ts.map

package/dist/types/enhanced-payment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enhanced-payment.d.ts","sourceRoot":"","sources":["../../src/types/enhanced-payment.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC/F,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,OAAO,EAAE,IAAI,CAAC;IACd,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,6BAA6B;IAC5C,kCAAkC;IAClC,MAAM,EAAE,iBAAiB,EAAE,CAAC;IAE5B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IAEvB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,oDAAoD;IACpD,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,8BAA8B;IAC9B,MAAM,EAAE,WAAW,CAAC;IAEpB,6BAA6B;IAC7B,KAAK,EAAE,cAAc,CAAC;IAEtB,+BAA+B;IAC/B,gBAAgB,EAAE,aAAa,CAAC;IAEhC,mCAAmC;IACnC,SAAS,EAAE,WAAW,CAAC;IAEvB,6BAA6B;IAC7B,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;CACvE;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,kCAAkC;IAClC,OAAO,EAAE;QACP,uCAAuC;QACvC,aAAa,EAAE,oBAAoB,CAAC;QACpC,kBAAkB;QAClB,MAAM,EAAE,WAAW,CAAC;QACpB,iBAAiB;QACjB,KAAK,EAAE,cAAc,CAAC;QACtB,wBAAwB;QACxB,SAAS,EAAE,WAAW,CAAC;QACvB,2BAA2B;QAC3B,YAAY,EAAE,aAAa,CAAC;QAC5B,+BAA+B;QAC/B,gBAAgB,EAAE,aAAa,CAAC;KACjC,CAAC;IAEF,uCAAuC;IACvC,WAAW,EAAE,oBAAoB,CAAC;IAElC,+CAA+C;IAC/C,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,kBAAkB,GAAG,sBAAsB,CAAC;AAE1F;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,+BAA+B,GACxC,QAAQ,IAAI,kBAAkB,CAEhC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,+BAA+B,GACxC,QAAQ,IAAI,sBAAsB,CAEpC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,6BAA6B;IAC7B,MAAM,EAAE,aAAa,CAAC;IAEtB,oDAAoD;IACpD,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAE5C,mCAAmC;IACnC,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,gCAAgC;IAChC,OAAO,CAAC,EAAE;QACR,4CAA4C;QAC5C,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,qDAAqD;QACrD,uBAAuB,CAAC,EAAE,WAAW,CAAC;KACvC,CAAC;CACH;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,mBAAmB;IAClC,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,WAAW,EAAE,iBAAiB,EAAE,CAAC;IAEjC;;;OAGG;IACH,gBAAgB,EAAE,IAAI,CAAC;IAEvB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT,qCAAqC;QACrC,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,+BAA+B;QAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8CAA8C;IAC9C,SAAS,EAAE,IAAI,CAAC;IAEhB,2CAA2C;IAC3C,SAAS,EAAE,IAAI,CAAC;IAEhB,mCAAmC;IACnC,SAAS,EAAE,WAAW,CAAC;IAEvB,6BAA6B;IAC7B,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;IAEpD,2CAA2C;IAC3C,aAAa,EAAE;QACb,+CAA+C;QAC/C,OAAO,EAAE,WAAW,CAAC;QACrB,iDAAiD;QACjD,OAAO,EAAE,WAAW,CAAC;KACtB,CAAC;CACH;AAGD,cAAc,sBAAsB,CAAC"}