@zubari/sdk 0.2.5 → 0.2.7

package/dist/services/index.d.ts

@@ -212,6 +212,276 @@ interface ListingFilters {
     page?: number;
     limit?: number;
 }
+interface TipUser {
+    id: string;
+    username?: string;
+    displayName?: string;
+    avatarUrl?: string;
+}
+interface Tip {
+    id: string;
+    senderId: string;
+    recipientId?: string;
+    senderAddress: string;
+    recipientAddress: string;
+    tokenAddress?: string;
+    amount: string;
+    amountUsd?: string;
+    platformFee: string;
+    message?: string;
+    network: string;
+    transactionHash?: string;
+    status: 'PENDING' | 'CONFIRMED' | 'FAILED';
+    createdAt: string;
+    sender?: TipUser;
+    recipient?: TipUser;
+}
+interface SendTipRequest {
+    recipientAddress: string;
+    recipientUsername?: string;
+    amount: string;
+    tokenAddress?: string;
+    network?: string;
+    message?: string;
+    transactionHash?: string;
+}
+interface SendTipResponse {
+    success: boolean;
+    message?: string;
+    tip?: Tip;
+    platformFee?: string;
+    platformFeeBps?: number;
+    error?: string;
+}
+interface TipStatsResponse {
+    success: boolean;
+    sent?: {
+        count: number;
+        totalAmount: string;
+        totalAmountUsd: string;
+    };
+    received?: {
+        count: number;
+        totalAmount: string;
+        totalAmountUsd: string;
+        platformFees: string;
+    };
+    error?: string;
+}
+interface TipsListResponse {
+    success: boolean;
+    tips?: Tip[];
+    pagination?: {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+    };
+    totals?: {
+        count: number;
+        amount: string;
+        amountUsd: string;
+    };
+    error?: string;
+}
+interface TipFilters {
+    page?: number;
+    limit?: number;
+    status?: 'PENDING' | 'CONFIRMED' | 'FAILED';
+}
+interface UpdateTipStatusRequest {
+    status: 'PENDING' | 'CONFIRMED' | 'FAILED';
+    transactionHash?: string;
+}
+interface SubscriptionPlan {
+    id: string;
+    creatorId: string;
+    name: string;
+    description?: string;
+    price: string;
+    priceUsd?: string;
+    paymentToken?: string;
+    durationDays: number;
+    perks: string[];
+    nftBadge: boolean;
+    maxSubscribers?: number;
+    isActive: boolean;
+    activeSubscribers?: number;
+    createdAt: string;
+    updatedAt: string;
+    creator?: TipUser & {
+        isVerified?: boolean;
+    };
+}
+interface Subscription {
+    id: string;
+    planId: string;
+    subscriberId: string;
+    creatorId: string;
+    subscriberAddress?: string;
+    creatorAddress?: string;
+    transactionHash?: string;
+    amount?: string;
+    startDate: string;
+    endDate: string;
+    expiresAt: string;
+    autoRenew: boolean;
+    status: 'ACTIVE' | 'EXPIRED' | 'CANCELLED';
+    createdAt: string;
+    plan?: Partial<SubscriptionPlan>;
+    creator?: TipUser & {
+        isVerified?: boolean;
+    };
+    subscriber?: TipUser;
+}
+interface CreatePlanRequest {
+    name: string;
+    description?: string;
+    price: string;
+    priceUsd?: number;
+    paymentToken?: string;
+    durationDays?: number;
+    perks?: string[];
+    nftBadge?: boolean;
+    maxSubscribers?: number;
+}
+interface CreatePlanResponse {
+    success: boolean;
+    message?: string;
+    plan?: SubscriptionPlan;
+    error?: string;
+}
+interface SubscribeRequest {
+    planId: string;
+    transactionHash?: string;
+    autoRenew?: boolean;
+}
+interface SubscribeResponse {
+    success: boolean;
+    message?: string;
+    subscription?: Subscription;
+    error?: string;
+}
+interface SubscriptionListResponse {
+    success: boolean;
+    subscriptions?: Subscription[];
+    pagination?: {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+    };
+    stats?: {
+        totalSubscribers: number;
+    };
+    error?: string;
+}
+interface SubscriptionFilters {
+    page?: number;
+    limit?: number;
+    status?: 'ACTIVE' | 'EXPIRED' | 'CANCELLED';
+}
+interface ContractSubscribeRequest {
+    planId: string;
+    months?: number;
+    seed: string;
+}
+interface ContractSubscribeResponse {
+    success: boolean;
+    transactionHash?: string;
+    subscription?: Subscription;
+    message?: string;
+    error?: string;
+}
+interface ContractCreatePlanRequest {
+    name: string;
+    description?: string;
+    price: string;
+    paymentToken?: string;
+    durationDays?: number;
+    maxSubscribers?: number;
+    seed: string;
+}
+interface ContractCreatePlanResponse {
+    success: boolean;
+    transactionHash?: string;
+    plan?: SubscriptionPlan;
+    message?: string;
+    error?: string;
+}
+interface IsSubscribedResponse {
+    subscriber: string;
+    creator: string;
+    isSubscribed: boolean;
+}
+interface PlatformFeeResponse {
+    feeBps: number;
+    feePercent: string;
+}
+interface EarningsResponse {
+    success: boolean;
+    address?: string;
+    pendingEarnings?: string;
+    totalEarnings?: string;
+    earningsBreakdown?: {
+        tips: string;
+        subscriptions: string;
+        nftSales: string;
+        royalties: string;
+    };
+    recentPayouts?: Array<{
+        id: string;
+        amount: string;
+        txHash: string;
+        createdAt: string;
+    }>;
+    error?: string;
+}
+interface ClaimEarningsRequest {
+    seed: string;
+}
+interface ClaimEarningsResponse {
+    success: boolean;
+    transactionHash?: string;
+    amount?: string;
+    message?: string;
+    error?: string;
+}
+interface PayoutHistoryResponse {
+    success: boolean;
+    payouts?: Array<{
+        id: string;
+        amount: string;
+        status: string;
+        txHash: string;
+        createdAt: string;
+        confirmedAt?: string;
+    }>;
+    pagination?: {
+        page: number;
+        limit: number;
+        total: number;
+        pages: number;
+    };
+    error?: string;
+}
+interface EarningsBreakdownResponse {
+    success: boolean;
+    breakdown?: {
+        tips: string;
+        subscriptions: string;
+        nftSales: string;
+        royalties: string;
+        total: string;
+    };
+    percentages?: {
+        tips: string;
+        subscriptions: string;
+        nftSales: string;
+        royalties: string;
+    };
+    error?: string;
+}
 /**
  * Zubari API Client for backend integration
  */
@@ -290,6 +560,138 @@ declare class ZubariApiClient {
      * Get marketplace statistics
      */
     getMarketStats(): Promise<MarketStatsResponse>;
+    /**
+     * Send a tip to a creator
+     */
+    sendTip(params: SendTipRequest): Promise<SendTipResponse>;
+    /**
+     * Get tip statistics for current user
+     */
+    getTipStats(): Promise<TipStatsResponse>;
+    /**
+     * Get tips sent by current user
+     */
+    getSentTips(filters?: TipFilters): Promise<TipsListResponse>;
+    /**
+     * Get tips received by current user
+     */
+    getReceivedTips(filters?: TipFilters): Promise<TipsListResponse>;
+    /**
+     * Get a single tip by ID
+     */
+    getTip(tipId: string): Promise<{
+        success: boolean;
+        tip?: Tip;
+        error?: string;
+    }>;
+    /**
+     * Update tip status (for transaction confirmation)
+     */
+    updateTipStatus(tipId: string, params: UpdateTipStatusRequest): Promise<{
+        success: boolean;
+        tip?: Tip;
+        message?: string;
+        error?: string;
+    }>;
+    /**
+     * Create a new subscription plan (creator only)
+     */
+    createSubscriptionPlan(params: CreatePlanRequest): Promise<CreatePlanResponse>;
+    /**
+     * Get current user's subscription plans
+     */
+    getMySubscriptionPlans(): Promise<{
+        success: boolean;
+        plans?: SubscriptionPlan[];
+        error?: string;
+    }>;
+    /**
+     * Get subscription plan by ID
+     */
+    getSubscriptionPlan(planId: string): Promise<{
+        success: boolean;
+        plan?: SubscriptionPlan & {
+            isSubscribed?: boolean;
+        };
+        error?: string;
+    }>;
+    /**
+     * Delete/deactivate subscription plan
+     */
+    deleteSubscriptionPlan(planId: string): Promise<{
+        success: boolean;
+        message?: string;
+        deactivated?: boolean;
+        error?: string;
+    }>;
+    /**
+     * Subscribe to a plan
+     */
+    subscribe(params: SubscribeRequest): Promise<SubscribeResponse>;
+    /**
+     * Get current user's subscriptions (as subscriber)
+     */
+    getMySubscriptions(filters?: SubscriptionFilters): Promise<SubscriptionListResponse>;
+    /**
+     * Get subscribers to current user's plans (as creator)
+     */
+    getMySubscribers(filters?: SubscriptionFilters): Promise<SubscriptionListResponse>;
+    /**
+     * Cancel subscription
+     */
+    cancelSubscription(subscriptionId: string): Promise<{
+        success: boolean;
+        message?: string;
+        error?: string;
+    }>;
+    /**
+     * Create a subscription plan on-chain
+     */
+    createSubscriptionPlanOnChain(params: ContractCreatePlanRequest): Promise<ContractCreatePlanResponse>;
+    /**
+     * Subscribe to a plan on-chain
+     */
+    subscribeOnChain(params: ContractSubscribeRequest): Promise<ContractSubscribeResponse>;
+    /**
+     * Cancel subscription on-chain
+     */
+    cancelSubscriptionOnChain(subscriptionId: string, seed: string): Promise<{
+        success: boolean;
+        transactionHash?: string;
+        message?: string;
+        error?: string;
+    }>;
+    /**
+     * Check if user is subscribed to a creator on-chain
+     */
+    isSubscribed(subscriber: string, creator: string): Promise<IsSubscribedResponse>;
+    /**
+     * Get subscription platform fee
+     */
+    getSubscriptionPlatformFee(): Promise<PlatformFeeResponse>;
+    /**
+     * Get pending and claimed earnings for the authenticated user
+     */
+    getEarnings(): Promise<EarningsResponse>;
+    /**
+     * Claim pending earnings
+     */
+    claimEarnings(params: ClaimEarningsRequest): Promise<ClaimEarningsResponse>;
+    /**
+     * Get payout history for the authenticated user
+     */
+    getPayoutHistory(filters?: {
+        page?: number;
+        limit?: number;
+    }): Promise<PayoutHistoryResponse>;
+    /**
+     * Get earnings breakdown by source
+     */
+    getEarningsBreakdown(): Promise<EarningsBreakdownResponse>;
+    /**
+     * Get current platform fee for payouts
+     */
+    getPayoutsPlatformFee(): Promise<PlatformFeeResponse>;
 }
 /**
  * Get or create the Zubari API client instance
@@ -300,4 +702,4 @@ declare function getZubariApiClient(config?: Partial<ZubariApiConfig>): ZubariAp
  */
 declare function createZubariApiClient(config: ZubariApiConfig): ZubariApiClient;
 
-export { type BuyItemRequest, type BuyItemResponse, type CancelListingRequest, type CancelListingResponse, type CreateNFTRequest, type CreateVoucherRequest, type CreateVoucherResponse, type ListItemRequest, type ListItemResponse, type ListingFilters, type ListingsResponse, type MarketListing, type MarketStatsResponse, type NFTFilters, type NFTListResponse, type NFTResponse, type NFTVoucher, type RedeemVoucherRequest, type RedeemVoucherResponse, type UpdatePriceRequest, type UpdatePriceResponse, type VoucherStatusResponse, ZubariApiClient, type ZubariApiConfig, createZubariApiClient, getZubariApiClient };
+export { type BuyItemRequest, type BuyItemResponse, type CancelListingRequest, type CancelListingResponse, type ClaimEarningsRequest, type ClaimEarningsResponse, type ContractCreatePlanRequest, type ContractCreatePlanResponse, type ContractSubscribeRequest, type ContractSubscribeResponse, type CreateNFTRequest, type CreatePlanRequest, type CreatePlanResponse, type CreateVoucherRequest, type CreateVoucherResponse, type EarningsBreakdownResponse, type EarningsResponse, type IsSubscribedResponse, type ListItemRequest, type ListItemResponse, type ListingFilters, type ListingsResponse, type MarketListing, type MarketStatsResponse, type NFTFilters, type NFTListResponse, type NFTResponse, type NFTVoucher, type PayoutHistoryResponse, type PlatformFeeResponse, type RedeemVoucherRequest, type RedeemVoucherResponse, type SendTipRequest, type SendTipResponse, type SubscribeRequest, type SubscribeResponse, type Subscription, type SubscriptionFilters, type SubscriptionListResponse, type SubscriptionPlan, type Tip, type TipFilters, type TipStatsResponse, type TipUser, type TipsListResponse, type UpdatePriceRequest, type UpdatePriceResponse, type UpdateTipStatusRequest, type VoucherStatusResponse, ZubariApiClient, type ZubariApiConfig, createZubariApiClient, getZubariApiClient };