socialfi/dist/api.d.ts

Build social features into your app with ease

export interface ActivityItemSchema {
    type: 'following' | 'new_content' | 'like' | 'comment' | 'new_follower';
    actor_id: string;
    actor_username: string;
    target_id?: string;
    target_username?: string;
    comment_id?: string;
    timestamp: number;
    activity: string;
}
export interface GetActivityFeedResponseSchema {
    activities: {
        type: 'following' | 'new_content' | 'like' | 'comment' | 'new_follower';
        actor_id: string;
        actor_username: string;
        target_id?: string;
        target_username?: string;
        comment_id?: string;
        timestamp: number;
        activity: string;
    }[];
    page: number;
    pageSize: number;
}
export interface SwapTransactionSchema {
    type: string;
    source: string;
    description: string;
    fee: number;
    timestamp: string;
    signature: string;
    success: boolean;
    walletAddress: string;
    username: string;
    from: {
        amount: number;
        token: string;
    };
    to: {
        amount: number;
        token: string;
    };
    profile?: {
        username: string;
        id: string;
    };
    accountsInvolved: string[];
    involvedProfiles?: {
        address: string;
        profile: {
            username: string;
            id: string;
        };
    }[];
}
export interface GetSwapActivityResponseSchema {
    transactions: {
        type: string;
        source: string;
        description: string;
        fee: number;
        timestamp: string;
        signature: string;
        success: boolean;
        walletAddress: string;
        username: string;
        from: {
            amount: number;
            token: string;
        };
        to: {
            amount: number;
            token: string;
        };
        profile?: {
            username: string;
            id: string;
        };
        accountsInvolved: string[];
        involvedProfiles?: {
            address: string;
            profile: {
                username: string;
                id: string;
            };
        }[];
    }[];
    page: number;
    pageSize: number;
}
export interface CommentSchema {
    id: string;
    created_at: number;
    text: string;
}
export interface CommentDetailsSchema {
    comment: {
        id: string;
        created_at: number;
        text: string;
    };
    contentId?: string;
    author?: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
    socialCounts: {
        likeCount: number;
    };
    requestingProfileSocialInfo?: {
        hasLiked: boolean;
    };
}
export interface CommentDetailsWithRepliesSchema {
    comment: {
        id: string;
        created_at: number;
        text: string;
    };
    contentId?: string;
    author?: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
    socialCounts: {
        likeCount: number;
    };
    requestingProfileSocialInfo?: {
        hasLiked: boolean;
    };
    recentReplies?: {
        comment: {
            id: string;
            created_at: number;
            text: string;
        };
        contentId?: string;
        author?: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
        socialCounts: {
            likeCount: number;
        };
        requestingProfileSocialInfo?: {
            hasLiked: boolean;
        };
    }[];
}
export interface CreateCommentSchema {
    contentId?: string;
    profileId: string;
    /** @minLength 1 */
    text: string;
    commentId?: string;
    properties?: {
        key: string;
        value: string | number | boolean;
    }[];
    targetProfileId?: string;
}
export interface UpdateCommentSchema {
    properties: {
        key: string;
        value: string | number | boolean;
    }[];
}
export interface GetCommentsResponseSchema {
    comments: {
        comment: {
            id: string;
            created_at: number;
            text: string;
        };
        contentId?: string;
        author?: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
        socialCounts: {
            likeCount: number;
        };
        requestingProfileSocialInfo?: {
            hasLiked: boolean;
        };
        recentReplies?: {
            comment: {
                id: string;
                created_at: number;
                text: string;
            };
            contentId?: string;
            author?: {
                id: string;
                namespace: string;
                created_at: number;
                username: string;
                bio?: string | null;
                image?: string | null;
            };
            socialCounts: {
                likeCount: number;
            };
            requestingProfileSocialInfo?: {
                hasLiked: boolean;
            };
        }[];
    }[];
    page: number;
    pageSize: number;
}
export interface GetBatchCommentsResponseSchema {
    successful: {
        comment: {
            id: string;
            created_at: number;
            text: string;
        };
        contentId?: string;
        author?: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
        socialCounts: {
            likeCount: number;
        };
    }[];
    failed: {
        id: string;
        error: string;
    }[];
}
export interface ContactSchema {
    /** @minLength 1 */
    id: string;
    type: 'EMAIL' | 'PHONE' | 'TWITTER';
    /** only available for x contact types */
    bio?: string;
    /** only available for x contact types */
    image?: string;
}
export interface ContentSchema {
    id: string;
    created_at: number;
    namespace: string;
}
export interface ContentDetailsSchema {
    content: {
        id: string;
        created_at: number;
        namespace: string;
    } | null;
    socialCounts: {
        likeCount: number;
        commentCount: number;
    };
    authorProfile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
    requestingProfileSocialInfo?: {
        hasLiked?: boolean;
    };
}
export interface ContentWithCreatorSchema {
    content: {
        id: string;
        created_at: number;
        namespace: string;
    } | null;
    authorProfile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
}
export interface FindOrCreateContentSchema {
    /** @minLength 1 */
    id: string;
    profileId?: string;
    relatedContentId?: string;
    properties?: {
        key: string;
        value: string | number | boolean;
    }[];
}
export interface UpdateContentSchema {
    properties: {
        key: string;
        value: string | number | boolean;
    }[];
}
export interface GetContestsResponseSchema {
    contents: {
        content: {
            id: string;
            created_at: number;
            namespace: string;
        } | null;
        socialCounts: {
            likeCount: number;
            commentCount: number;
        };
        authorProfile: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
        requestingProfileSocialInfo?: {
            hasLiked?: boolean;
        };
    }[];
    page: number;
    pageSize: number;
    totalCount: number;
}
export interface GetBatchContentsResponseSchema {
    successful: {
        content: {
            id: string;
            created_at: number;
            namespace: string;
        } | null;
        socialCounts: {
            likeCount: number;
            commentCount: number;
        };
        authorProfile: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
        requestingProfileSocialInfo?: {
            hasLiked?: boolean;
        };
    }[];
    failed: {
        id: string;
        error: string;
    }[];
}
export interface BeforeLLMUsageSchema {
    /** @minLength 1 */
    userId: string;
    /** @minLength 1 */
    idempotencyKey: string;
    /**
     * @min 0
     * @exclusiveMin true
     */
    promptTokens: number;
}
export interface BeforeLLMUsageResponseSchema {
    /**
     * @min 0
     * @exclusiveMin true
     */
    id: number;
}
export interface AfterLLMUsageSchema {
    /** @minLength 1 */
    userId: string;
    /**
     * @min 0
     * @exclusiveMin true
     */
    transactionId: number;
    /**
     * @min 0
     * @exclusiveMin true
     */
    completionTokens: number;
}
export interface AfterLLMUsageResponseSchema {
    /**
     * @min 0
     * @exclusiveMin true
     */
    usageId: number;
    /**
     * @min 0
     * @exclusiveMin true
     */
    transactionId: number;
    remainingBalance: string;
}
export interface CurrentBalanceResponseSchema {
    balance: string;
}
export interface BundleSchema {
    /**
     * @min 0
     * @exclusiveMin true
     */
    id: number;
    name: string;
    /**
     * @min 0
     * @exclusiveMin true
     */
    credits: number;
    price: string;
}
export interface ChestSchema {
    /**
     * @min 0
     * @exclusiveMin true
     */
    id: number;
    userId: string;
    type: string;
    /**
     * @min 0
     * @exclusiveMin true
     */
    credits: number;
}
export interface ApiChestSchema {
    /**
     * @min 0
     * @exclusiveMin true
     */
    id: number;
}
export interface GetChestsResponseSchema {
    chests: {
        /**
         * @min 0
         * @exclusiveMin true
         */
        id: number;
    }[];
    claimedAt?: string | null;
    availableAt?: string | null;
}
export interface ClaimChestResponseSchema {
    balance?: string;
    /**
     * @min 0
     * @exclusiveMin true
     */
    giftAmount?: number;
}
export interface PlayGameResponseSchema {
    userBalance?: string;
    gameCreditsFee: number;
    challengeFee?: number;
}
export interface GameEndInputSchema {
    /**
     * @min 0
     * @exclusiveMin true
     */
    score: number;
    profileId: string;
}
export interface CreditTransactionSchema {
    /**
     * @min 0
     * @exclusiveMin true
     */
    id: number;
    userId: string;
    amount: string;
    description?: string | null;
    type: string;
}
export interface CustomPropertySchema {
    key: string;
    value: string | number | boolean;
}
export interface TweetSchema {
    id: string;
    text: string;
    /** @format date-time */
    createdAt: string;
    /** @min 0 */
    likes: number;
    /** @min 0 */
    retweets: number;
    /** @format uri */
    url: string;
}
export interface UserTweetsSchema {
    handle: string;
    tweets: {
        id: string;
        text: string;
        /** @format date-time */
        createdAt: string;
        /** @min 0 */
        likes: number;
        /** @min 0 */
        retweets: number;
        /** @format uri */
        url: string;
    }[];
}
export interface CastSchema {
    id: string;
    text: string;
    /**
     * @min 0
     * @exclusiveMin true
     */
    createdAt: number;
    /** @format uri */
    url: string;
}
export interface UserCastsSchema {
    user: {
        fid: number;
        username: string;
    };
    casts: {
        id: string;
        text: string;
        /**
         * @min 0
         * @exclusiveMin true
         */
        createdAt: number;
        /** @format uri */
        url: string;
    }[];
}
export interface FarcasterUserSchema {
    fid: number;
    username: string;
}
export interface CreateFollowSchema {
    startId: string;
    endId: string;
}
export interface DeleteFollowSchema {
    startId: string;
    endId: string;
}
export interface IsFollowingSchema {
    isFollowing: boolean;
}
export interface ProfileIdentitySchema {
    wallet?: {
        /** @minLength 32 */
        address?: string;
    };
    contact?: {
        id: string;
    };
    profiles: {
        profile: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
        namespace: {
            name: string | null;
            readableName: string | null;
            faviconURL: string | null;
            userProfileURL: string | null;
        };
    }[];
}
export interface ProfileIdentityResponseSchema {
    identities: {
        wallet?: {
            /** @minLength 32 */
            address?: string;
        };
        contact?: {
            id: string;
        };
        profiles: {
            profile: {
                id: string;
                namespace: string;
                created_at: number;
                username: string;
                bio?: string | null;
                image?: string | null;
            };
            namespace: {
                name: string | null;
                readableName: string | null;
                faviconURL: string | null;
                userProfileURL: string | null;
            };
        }[];
    }[];
    page: number;
    pageSize: number;
}
export interface LeaderboardEntrySchema {
    /**
     * @min 0
     * @exclusiveMin true
     */
    position: number;
    score: number;
    profile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
}
export interface LeaderboardUserNearbySchema {
    username: string;
    profileId: string;
    score: number;
}
export interface LeaderboardUserSchema {
    position: number;
    score: number;
    hasPlayerAbove: boolean;
    hasPlayerBelow: boolean;
    nearby: {
        username: string;
        profileId: string;
        score: number;
    }[];
}
export interface SuggestionUserSchema {
    profile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
    score: number;
    position: number;
}
export interface LeaderboardMetricsSchema {
    contentCount: number;
}
export interface LeaderboardEntryWithMetricsSchema {
    profile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
    metrics: {
        contentCount: number;
    };
}
export interface LeaderboardResponseSchema {
    entries: {
        profile: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
        metrics: {
            contentCount: number;
        };
    }[];
    page: number;
    pageSize: number;
}
export interface LeaderboardTimeWindowSchema {
    field: string;
    start: number;
    end?: number;
}
export interface GetLeaderboardParamsSchema {
    namespace: string;
    timeWindow?: {
        field: string;
        start: number;
        end?: number;
    };
    page?: number;
    pageSize?: number;
}
export interface CreateLikeSchema {
    startId: string;
}
export interface DeleteLikeSchema {
    startId: string;
}
export interface NamespacePropertiesSchema {
    name: string | null;
    readableName: string | null;
    faviconURL: string | null;
    userProfileURL: string | null;
}
export interface CreateNimbusAppSchema {
    name: string;
    userId: string;
    paid?: boolean;
}
export interface NimbusCheckoutInputSchema {
    bundleId: string;
    idempotencyKey: string;
    successUrl?: string;
    cancelUrl?: string;
}
export interface NimbusCheckoutResponseSchema {
    id: string;
    url: string | null;
    idempotencyKey: string;
    userId: string;
}
export interface NimbusDeployInputSchema {
    contentId: string;
    idempotencyKey: string;
}
export interface GameDetailsSchema {
    gameId: string;
    gameName: string;
    appNamespace: string;
    title: string;
    deployUrl: string;
    coverImageUrl: string | null;
    templateId: string | null;
    isMobileFriendly: boolean;
    creatorProfile: {
        id: string;
        username: string;
    };
    socialCounts: {
        likeCount: number;
        playCount: number;
    };
}
export interface GamesAndScoresSchema {
    scores: {
        gameDetails: {
            gameId: string;
            gameName: string;
            appNamespace: string;
            title: string;
            deployUrl: string;
            coverImageUrl: string | null;
            templateId: string | null;
            isMobileFriendly: boolean;
            creatorProfile: {
                id: string;
                username: string;
            };
            socialCounts: {
                likeCount: number;
                playCount: number;
            };
        };
        score: {
            /**
             * @min 0
             * @exclusiveMin true
             */
            position: number;
            score: number;
            profile: {
                id: string;
                namespace: string;
                created_at: number;
                username: string;
                bio?: string | null;
                image?: string | null;
            };
        };
    }[];
}
export interface GetGamesResponseSchema {
    games: {
        gameId: string;
        gameName: string;
        appNamespace: string;
        title: string;
        deployUrl: string;
        coverImageUrl: string | null;
        templateId: string | null;
        isMobileFriendly: boolean;
        creatorProfile: {
            id: string;
            username: string;
        };
        socialCounts: {
            likeCount: number;
            playCount: number;
        };
    }[];
    page: number;
    pageSize: number;
}
export interface ChallengeLeaderboardEntrySchema {
    position: number;
    profileId: string;
    dynamicUserId?: string;
    score: number;
    credits: number;
}
export interface CurrentChallengeResponseSchema {
    challenge: {
        startAt: string;
        endAt: string;
        gameId: string;
        totalPrizePool: string;
        totalPlayers: number;
    };
    leaderboard: {
        position: number;
        profileId: string;
        dynamicUserId?: string;
        score: number;
        credits: number;
    }[];
    userPosition: {
        position: number;
        profileId: string;
        dynamicUserId?: string;
        score: number;
        credits: number;
    } | null;
}
export interface LinkSchema {
    label: string;
    url: string;
}
export interface BaseNotificationSchema {
    message: string;
    link?: {
        label: string;
        url: string;
    };
    recipient: string;
    /** @default false */
    skip?: boolean;
}
export interface WalletNotificationSchema {
    message: string;
    link?: {
        label: string;
        url: string;
    };
    recipient: string;
    /** @default false */
    skip?: boolean;
    medium: 'wallet';
    title: string;
}
export interface PhoneNotificationSchema {
    message: string;
    link?: {
        label: string;
        url: string;
    };
    recipient: string;
    /** @default false */
    skip?: boolean;
    medium: 'phone';
}
export interface EmailNotificationSchema {
    message: string;
    link?: {
        label: string;
        url: string;
    };
    recipient: string;
    /** @default false */
    skip?: boolean;
    medium: 'email';
    subject: string;
}
export interface GetPointsEarnedByPeriodSchema {
    periodType: 'MONTH' | 'YEAR';
}
export interface GetPointsEarnedByPeriodResponseSchema {
    periods: {
        totalPoints: number;
        date: string;
    }[];
}
export interface ProfileSchema {
    id: string;
    namespace: string;
    created_at: number;
    username: string;
    bio?: string | null;
    image?: string | null;
}
export interface ProfileWithWalletSchema {
    id: string;
    namespace: string;
    created_at: number;
    username: string;
    bio?: string | null;
    image?: string | null;
    wallet?: {
        id: string;
        created_at: number;
        blockchain: 'SOLANA' | 'ETHEREUM';
        wallet_type?: 'PHANTOM' | 'WEB3AUTH';
    } | null;
}
export interface FindOrCreateProfileSchema {
    /** Username for the profile */
    username: string;
    /** Optional unique identifier for the profile */
    id?: string;
    /** Optional biography or description */
    bio?: string;
    /** Optional URL to profile image */
    image?: string;
    /** Optional ID of the referring profile */
    referredById?: string;
    /** Optional phone number for contact */
    phoneNumber?: string;
    /**
     * Optional blockchain wallet address
     * @minLength 32
     */
    walletAddress?: string;
    /** Optional blockchain network identifier */
    blockchain?: 'SOLANA' | 'ETHEREUM';
    /** Optional contact information */
    contact?: {
        /** @minLength 1 */
        id: string;
        type: 'EMAIL' | 'PHONE' | 'TWITTER';
        /** only available for x contact types */
        bio?: string;
        /** only available for x contact types */
        image?: string;
    };
    /** Optional array of custom properties */
    properties?: {
        key: string;
        value: string | number | boolean;
    }[];
    /**
     * Optional execution method, defaults to FAST_UNCONFIRMED
     * @default "FAST_UNCONFIRMED"
     */
    execution?: 'FAST_UNCONFIRMED' | 'QUICK_SIGNATURE' | 'CONFIRMED_AND_PARSED';
}
export interface X {
    /** Username for the profile */
    username: string;
    /** Optional unique identifier for the profile */
    id?: string;
    /** Optional biography or description */
    bio?: string;
    /** Optional URL to profile image */
    image?: string;
    /** Optional ID of the referring profile */
    referredById?: string;
    /** Optional phone number for contact */
    phoneNumber?: string;
    /** Optional contact information */
    contact?: {
        /** @minLength 1 */
        id: string;
        type: 'EMAIL' | 'PHONE' | 'TWITTER';
        /** only available for x contact types */
        bio?: string;
        /** only available for x contact types */
        image?: string;
    };
    /** Optional array of custom properties */
    properties?: {
        key: string;
        value: string | number | boolean;
    }[];
}
export interface UpdateProfileSchema {
    username?: string;
    bio?: string;
    image?: string;
    properties?: {
        key: string;
        value: string | number | boolean;
    }[];
    /** @default "FAST_UNCONFIRMED" */
    execution?: 'FAST_UNCONFIRMED' | 'QUICK_SIGNATURE' | 'CONFIRMED_AND_PARSED';
}
export interface SuggestedProfileFollowSchema {
    namespaces: {
        name: string | null;
        readableName: string | null;
        faviconURL: string | null;
        userProfileURL: string | null;
    }[];
    profile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
    wallet?: {
        address: string;
    };
    contact?: {
        /** @minLength 1 */
        id: string;
        type: 'EMAIL' | 'PHONE' | 'TWITTER';
        /** only available for x contact types */
        bio?: string;
        /** only available for x contact types */
        image?: string;
    };
}
export interface SuggestedProfilesToInvite {
    namespaces: {
        name: string | null;
        readableName: string | null;
        faviconURL: string | null;
        userProfileURL: string | null;
    }[];
    namespaceCount: number;
    profiles: {
        namespace: {
            name: string | null;
            readableName: string | null;
            faviconURL: string | null;
            userProfileURL: string | null;
        };
        profiles: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        }[];
    }[];
    wallet?: {
        address: string;
    };
    contact?: {
        /** @minLength 1 */
        id: string;
        type: 'EMAIL' | 'PHONE' | 'TWITTER';
        /** only available for x contact types */
        bio?: string;
        /** only available for x contact types */
        image?: string;
    };
}
export interface RefferSchema {
    depth: number;
    profile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
}
export interface ReferralProfilesSchema {
    upstream: {
        depth: number;
        profile: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
    }[];
    downstream: {
        depth: number;
        profile: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
    }[];
}
export interface IProfileWithWalletsSchema {
    id: string;
    namespace: string;
    created_at: number;
    username: string;
    bio?: string | null;
    image?: string | null;
    wallets: {
        id: string;
        created_at: number;
        blockchain: 'SOLANA' | 'ETHEREUM';
        wallet_type?: 'PHANTOM' | 'WEB3AUTH';
    }[];
}
export interface ITokenHoldersResponseSchema {
    profiles: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
        wallets: {
            id: string;
            created_at: number;
            blockchain: 'SOLANA' | 'ETHEREUM';
            wallet_type?: 'PHANTOM' | 'WEB3AUTH';
        }[];
    }[];
}
export interface FindOrCreateResponseSchema {
    profile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
    walletAddress?: string;
    hashedPhoneNumber?: string;
    contact?: {
        /** @minLength 1 */
        id: string;
        type: 'EMAIL' | 'PHONE' | 'TWITTER';
        /** only available for x contact types */
        bio?: string;
        /** only available for x contact types */
        image?: string;
    };
}
export interface GetProfilesItemSchema {
    profile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
    wallet?: {
        address: string;
    };
    namespace?: {
        name: string | null;
        readableName: string | null;
        faviconURL: string | null;
        userProfileURL: string | null;
    };
    contact?: {
        /** @minLength 1 */
        id: string;
        type: 'EMAIL' | 'PHONE' | 'TWITTER';
        /** only available for x contact types */
        bio?: string;
        /** only available for x contact types */
        image?: string;
    };
    socialCounts: {
        followers: number;
        following: number;
    };
}
export interface GetProfilesResponseSchema {
    profiles: {
        profile: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
        wallet?: {
            address: string;
        };
        namespace?: {
            name: string | null;
            readableName: string | null;
            faviconURL: string | null;
            userProfileURL: string | null;
        };
        contact?: {
            /** @minLength 1 */
            id: string;
            type: 'EMAIL' | 'PHONE' | 'TWITTER';
            /** only available for x contact types */
            bio?: string;
            /** only available for x contact types */
            image?: string;
        };
        socialCounts: {
            followers: number;
            following: number;
        };
    }[];
    page: number;
    pageSize: number;
    totalCount: number;
}
export interface GetProfileDetailsSchema {
    profile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
    walletAddress?: string;
    hashedPhoneNumber?: string;
    contact?: {
        /** @minLength 1 */
        id: string;
        type: 'EMAIL' | 'PHONE' | 'TWITTER';
        /** only available for x contact types */
        bio?: string;
        /** only available for x contact types */
        image?: string;
    };
    socialCounts: {
        followers: number;
        following: number;
    };
    namespace?: {
        name: string | null;
        readableName: string | null;
        faviconURL: string | null;
        userProfileURL: string | null;
    };
}
export interface GetProfileFollowersResponseSchema {
    profiles: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
        wallet?: {
            id: string;
            created_at: number;
            blockchain: 'SOLANA' | 'ETHEREUM';
            wallet_type?: 'PHANTOM' | 'WEB3AUTH';
        } | null;
    }[];
    page: number;
    pageSize: number;
}
export interface GetGlobalProfileFollowersResponseSchema {
    profiles: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
        wallet?: {
            id: string;
            created_at: number;
            blockchain: 'SOLANA' | 'ETHEREUM';
            wallet_type?: 'PHANTOM' | 'WEB3AUTH';
        } | null;
    }[];
    page: number;
    pageSize: number;
    totalCount: number;
}
export interface GetProfileFollowingResponseSchema {
    profiles: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
        wallet?: {
            id: string;
            created_at: number;
            blockchain: 'SOLANA' | 'ETHEREUM';
            wallet_type?: 'PHANTOM' | 'WEB3AUTH';
        } | null;
    }[];
    page: number;
    pageSize: number;
}
export interface GetGlobalProfileFollowingResponseSchema {
    profiles: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
        wallet?: {
            id: string;
            created_at: number;
            blockchain: 'SOLANA' | 'ETHEREUM';
            wallet_type?: 'PHANTOM' | 'WEB3AUTH';
        } | null;
    }[];
    page: number;
    pageSize: number;
    totalCount: number;
}
export interface GetProfileFollowingWhoFollowResponseSchema {
    profiles: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    }[];
    page: number;
    pageSize: number;
}
export interface LinkedWalletSchema {
    /** @minLength 32 */
    address: string;
    blockchain: 'SOLANA' | 'ETHEREUM';
}
export type LinkWalletsInputSchema = {
    data: {
        /** @minLength 32 */
        address: string;
        blockchain: 'SOLANA' | 'ETHEREUM';
    };
    proof: string;
}[];
export type LinkContactsInputSchema = {
    data: {
        /** @minLength 1 */
        id: string;
        type: 'EMAIL' | 'PHONE' | 'TWITTER';
        /** only available for x contact types */
        bio?: string;
        /** only available for x contact types */
        image?: string;
    };
    proof: string;
}[];
export interface SearchProfilesResponseSchema {
    profiles: {
        profile: {
            id: string;
            namespace: string;
            created_at: number;
            username: string;
            bio?: string | null;
            image?: string | null;
        };
        socialCounts: {
            followers: number;
            following: number;
        };
        walletAddress: string | null;
        namespace: {
            name: string | null;
            readableName: string | null;
            faviconURL: string | null;
            userProfileURL: string | null;
        };
    }[];
    page: number;
    pageSize: number;
}
export interface LikeCommentCountsSchema {
    likeCount: number;
    commentCount: number;
}
export interface SocialInfoSchema {
    hasLiked?: boolean;
}
export interface FollowCountsSchema {
    followers: number;
    following: number;
}
export interface FollowWithGlobalCountsSchema {
    followers: number;
    following: number;
    globalFollowers: number;
    globalFollowing: number;
}
export interface WalletSchema {
    id: string;
    created_at: number;
    blockchain: 'SOLANA' | 'ETHEREUM';
    wallet_type?: 'PHANTOM' | 'WEB3AUTH';
}
export interface ConnectWalletResponseSchema {
    success: boolean;
    message?: string;
}
export interface FindOrCreateCreateParams {
    apiKey: string;
}
export type FindOrCreateCreateData = FindOrCreateResponseSchema;
export interface ProfilesListParams {
    apiKey: string;
    /** @minLength 32 */
    walletAddress?: string;
    phoneNumber?: string;
    email?: string;
    page?: string;
    pageSize?: string;
    /** @default "created_at" */
    sortBy?: string;
    /** @default "DESC" */
    sortDirection?: 'ASC' | 'DESC';
}
export type ProfilesListData = GetProfilesResponseSchema;
export interface ProfilesDetailParams {
    apiKey: string;
    /** The id of the start profile. */
    id: string;
}
export type ProfilesDetailData = GetProfileDetailsSchema;
export interface ProfilesUpdateParams {
    apiKey: string;
    id: string;
}
export type ProfilesUpdateData = ProfileSchema;
export interface FollowersListParams {
    apiKey: string;
    page?: string;
    pageSize?: string;
    id: string;
}
export type FollowersListData = GetProfileFollowersResponseSchema;
export interface FollowersGlobalListParams {
    apiKey: string;
    page?: string;
    pageSize?: string;
    id: string;
}
export type FollowersGlobalListData = GetGlobalProfileFollowersResponseSchema;
export interface FollowingListParams {
    apiKey: string;
    page?: string;
    pageSize?: string;
    id: string;
}
export type FollowingListData = GetProfileFollowingResponseSchema;
export interface FollowingGlobalListParams {
    apiKey: string;
    page?: string;
    pageSize?: string;
    id: string;
}
export type FollowingGlobalListData = GetGlobalProfileFollowingResponseSchema;
export interface FollowingWhoFollowListParams {
    apiKey: string;
    requestorId: string;
    page?: string;
    pageSize?: string;
    id: string;
}
export type FollowingWhoFollowListData = GetProfileFollowingWhoFollowResponseSchema;
export interface SuggestedDetailParams {
    apiKey: string;
    /** @default "PHONE" */
    contactType?: 'EMAIL' | 'PHONE' | 'TWITTER';
    /** should either be a wallet address (default) or a contact id. when using contact ids, specify the contactType via query params */
    identifier: string;
}
export type SuggestedDetailData = Record<string, {
    namespaces: {
        name: string | null;
        readableName: string | null;
        faviconURL: string | null;
        userProfileURL: string | null;
    }[];
    profile: {
        id: string;
        namespace: string;
        created_at: number;
        username: string;
        bio?: string | null;
        image?: string | null;
    };
    wallet?: {
        address: string;
    };
    contact?: {
        /** @minLength 1 */
        id: string;
        type: 'EMAIL' | 'PHONE' | 'TWITTER';
        /** only available for x contact types */
        bio?: string;
        /** only available for x contact types */
        image?: string;
    };
}>;
export interface SuggestedGlobalListParams {
    apiKey: string;
    /** @default "PHONE" */
    contactType?: 'EMAIL' | 'PHONE' | 'TWITTER';
    /** should either be a wallet address (default) or a contact id. when using contact ids, specify the contactType via query params */
    identifier: string;
}
export type SuggestedGlobalListData = SuggestedProfilesToInvite[];
export interface ReferralsListParams {
    apiKey: string;
    /** Optional filter to specify the depth of upstream referral connections (profiles that referred this user). Defaults to 2 if no value is specified. */
    upstream?: string;
    /** Optional filter to specify the depth of downstream referral connections (profiles referred by this user). Defaults to 2 if no value is specified. */
    downstream?: string;
    id: string;
}
export type ReferralsListData = ReferralProfilesSchema;
export interface TokenOwnersDetailParams {
    apiKey: string;
    requestorId?: string;
    /** @default "false" */
    includeExternalProfiles?: string;
    page?: string;
    pageSize?: string;
    tokenAddress: string;
}
export type TokenOwnersDetailData = ITokenHoldersResponseSchema;
export interface NotificationCreateParams {
    apiKey: string;
    id: string;
}
export type NotificationCreateData = object;
export interface PostFollowersParams {
    apiKey: string;
}
export type PostFollowersData = object;
export interface RemoveCreateParams {
    apiKey: string;
}
export type RemoveCreateData = object;
export interface StateListParams {
    apiKey: string;
    startId: string;
    endId: string;
}
export type StateListData = IsFollowingSchema;
export interface ContentsListParams {
    apiKey: string;
    orderByField?: string;
    orderByDirection?: 'ASC' | 'DESC';
    requireFields?: string;
    filterField?: string;
    filterValue?: string;
    page?: string;
    pageSize?: string;
    profileId?: string;
    requestingProfileId?: string;
    namespace?: 'primitives';
}
export type ContentsListData = GetContestsResponseSchema;
export interface ContentsDetailParams {
    apiKey: string;
    requestingProfileId?: string;
    id: string;
}
export type ContentsDetailData = ContentDetailsSchema;
export interface ContentsUpdateParams {
    apiKey: string;
    id: string;
}
export type ContentsUpdateData = ContentSchema;
export interface ContentsDeleteParams {
    apiKey: string;
    id: string;
}
export type ContentsDeleteData = object;
export interface FindOrCreateCreateParams2 {
    apiKey: string;
}
export type FindOrCreateCreateResult = ContentSchema;
export interface BatchReadCreateParams {
    apiKey: string;
}
export type BatchReadCreateData = GetBatchContentsResponseSchema;
export interface CommentsListParams {
    apiKey: string;
    contentId?: string;
    profileId?: string;
    targetProfileId?: string;
    page?: string;
    pageSize?: string;
    requestingProfileId?: string;
}
export type CommentsListData = GetCommentsResponseSchema;
export interface CommentsCreateParams {
    apiKey: string;
}
export type CommentsCreateData = CommentSchema;
export interface CommentsDetailParams {
    apiKey: string;
    requestingProfileId?: string;
    id: string;
}
export type CommentsDetailData = CommentDetailsWithRepliesSchema;
export interface CommentsUpdateParams {
    apiKey: string;
    id: string;
}
export type CommentsUpdateData = CommentSchema;
export interface CommentsDeleteParams {
    apiKey: string;
    id: string;
}
export type CommentsDeleteData = object;
export interface RepliesListParams {
    apiKey: string;
    page?: string;
    pageSize?: string;
    requestingProfileId?: string;
    id: string;
}
export type RepliesListData = GetCommentsResponseSchema;
export interface BatchReadCreateParams2 {
    apiKey: string;
}
export type BatchReadCreateResult = GetBatchCommentsResponseSchema;
export interface LikesCreateParams {
    apiKey: string;
    nodeId: string;
}
export type LikesCreateData = object;
export interface LikesDeleteParams {
    apiKey: string;
    nodeId: string;
}
export type LikesDeleteData = object;
export interface ConnectCreateParams {
    apiKey: string;
    address: string;
}
export type ConnectCreateData = object;
export interface SocialCountsListParams {
    apiKey: string;
    address: string;
}
export type SocialCountsListData = FollowWithGlobalCountsSchema;
export interface ProfilesListParams2 {
    apiKey: string;
    query: string;
    /** @default "false" */
    includeExternalProfiles?: string;
    page?: string;
    pageSize?: string;
}
export type ProfilesListResult = SearchProfilesResponseSchema;
export interface FeedListParams {
    apiKey: string;
    username: string;
    page?: string;
    pageSize?: string;
}
export type FeedListData = GetActivityFeedResponseSchema;
export interface SwapListParams {
    apiKey: string;
    username?: string;
    page?: string;
    pageSize?: string;
    tokenAddress?: string;
}
export type SwapListData = GetSwapActivityResponseSchema;
export interface IdentitiesDetailParams {
    apiKey: string;
    page?: string;
    pageSize?: string;
    id: string;
}
export type IdentitiesDetailData = ProfileIdentityResponseSchema;
export interface ProfilesListParams4 {
    apiKey: string;
    /** @default "PHONE" */
    contactType?: 'EMAIL' | 'PHONE' | 'TWITTER';
    page?: string;
    pageSize?: string;
    /** @default "created_at" */
    sortBy?: string;
    /** @default "DESC" */
    sortDirection?: 'ASC' | 'DESC';
    id: string;
}
export type ProfilesListOutput = GetProfilesResponseSchema;
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
export type QueryParamsType = Record<string | number, any>;
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
    /** set parameter to `true` for call `securityWorker` for this request */
    secure?: boolean;
    /** request path */
    path: string;
    /** content type of request body */
    type?: ContentType;
    /** query params */
    query?: QueryParamsType;
    /** format of response (i.e. response.json() -> format: "json") */
    format?: ResponseType;
    /** request body */
    body?: unknown;
}
export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
    securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
    secure?: boolean;
    format?: ResponseType;
}
export declare enum ContentType {
    Json = "application/json",
    FormData = "multipart/form-data",
    UrlEncoded = "application/x-www-form-urlencoded",
    Text = "text/plain"
}
export declare class HttpClient<SecurityDataType = unknown> {
    instance: AxiosInstance;
    private securityData;
    private securityWorker?;
    private secure?;
    private format?;
    constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
    setSecurityData: (data: SecurityDataType | null) => void;
    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
    protected stringifyFormItem(formItem: unknown): string;
    protected createFormData(input: Record<string, unknown>): FormData;
    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<T>;
}
/**
 * @title Tapestry API Reference
 * @version 1.0.0
 * @baseUrl https://api.usetapestry.dev/api/v1
 *
 * Documentation for all routes in the API
 */
export declare class SocialFi<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
    profiles: {
        /**
         * @description For creating a user profile. The endpoint will first check to see if the wallet exists elsewhere on the graph. If it does, we will create a new profile that is namespaced to your app and associate with the wallet you pass in. If the wallet does not yet exist, we will create a node for the wallet, a node for the profile (namespaced to your app) and an edge indicating that the wallet you passed in is associated with the profile on your app.
         *
         * @tags Profiles
         * @name FindOrCreateCreate
         * @summary Find or create a profile
         * @request POST:/profiles/findOrCreate
         */
        findOrCreateCreate: (query: FindOrCreateCreateParams, data: FindOrCreateProfileSchema, params?: RequestParams) => Promise<FindOrCreateResponseSchema>;
        /**
         * No description
         *
         * @tags Profiles
         * @name ProfilesList
         * @summary Get profiles
         * @request GET:/profiles/
         */
        profilesList: (query: ProfilesListParams, params?: RequestParams) => Promise<GetProfilesResponseSchema>;
        /**
         * @description Get comprehensive profile information including node details and follower/following counts
         *
         * @tags Profiles
         * @name ProfilesDetail
         * @summary Find a profile
         * @request GET:/profiles/{id}
         */
        profilesDetail: ({ id, ...query }: ProfilesDetailParams, params?: RequestParams) => Promise<GetProfileDetailsSchema>;
        /**
         * No description
         *
         * @tags Profiles
         * @name ProfilesUpdate
         * @summary Update a profile
         * @request PUT:/profiles/{id}
         */
        profilesUpdate: ({ id, ...query }: ProfilesUpdateParams, data: UpdateProfileSchema, params?: RequestParams) => Promise<ProfileSchema>;
        /**
         * @description Get a list of profiles that follow a user
         *
         * @tags Profiles
         * @name FollowersList
         * @summary Get followers
         * @request GET:/profiles/{id}/followers
         */
        followersList: ({ id, ...query }: FollowersListParams, params?: RequestParams) => Promise<GetProfileFollowersResponseSchema>;
        /**
         * @description Get a list of profiles that follow a user across all connected wallets and contacts
         *
         * @tags Profiles
         * @name FollowersGlobalList
         * @summary Get global followers
         * @request GET:/profiles/{id}/followers/global
         */
        followersGlobalList: ({ id, ...query }: FollowersGlobalListParams, params?: RequestParams) => Promise<GetGlobalProfileFollowersResponseSchema>;
        /**
         * @description Get a list of profiles that a user follows
         *
         * @tags Profiles
         * @name FollowingList
         * @summary Get following
         * @request GET:/profiles/{id}/following
         */
        followingList: ({ id, ...query }: FollowingListParams, params?: RequestParams) => Promise<GetProfileFollowingResponseSchema>;
        /**
         * @description Get a list of profiles that a user follows across all connected wallets and contacts
         *
         * @tags Profiles
         * @name FollowingGlobalList
         * @summary Get global following
         * @request GET:/profiles/{id}/following/global
         */
        followingGlobalList: ({ id, ...query }: FollowingGlobalListParams, params?: RequestParams) => Promise<GetGlobalProfileFollowingResponseSchema>;
        /**
         * @description Helpful for creating UIs like "this user is followed by {number} other users you follow"
         *
         * @tags Profiles
         * @name FollowingWhoFollowList
         * @summary Get a list of profiles in a user's network that also follow a given profile
         * @request GET:/profiles/{id}/following-who-follow
         */
        followingWhoFollowList: ({ id, ...query }: FollowingWhoFollowListParams, params?: RequestParams) => Promise<GetProfileFollowingWhoFollowResponseSchema>;
        /**
         * @description Helpful for populating UIs like "people you may know"
         *
         * @tags Profiles
         * @name SuggestedDetail
         * @summary Get suggested profiles to follow
         * @request GET:/profiles/suggested/{identifier}
         */
        suggestedDetail: ({ identifier, ...query }: SuggestedDetailParams, params?: RequestParams) => Promise<SuggestedDetailData>;
        /**
         * No description
         *
         * @tags Profiles
         * @name SuggestedGlobalList
         * @summary Get suggested profiles to invite
         * @request GET:/profiles/suggested/{identifier}/global
         */
        suggestedGlobalList: ({ identifier, ...query }: SuggestedGlobalListParams, params?: RequestParams) => Promise<SuggestedGlobalListData>;
        /**
         * @description Retrieve all referral connections for a user profile, including both users who made referrals (upstream) and users who were referred (downstream) by this profile, with depth indicating the number of connection levels (defaults to 2, maximum 6). For example, depth=1 shows direct referrals, while depth=2 includes referrals made by those direct referrals.
         *
         * @tags Profiles
         * @name ReferralsList
         * @summary Retrieve referrals
         * @request GET:/profiles/{id}/referrals
         */