friday-sdk/dist/index.d.ts

Official JavaScript/TypeScript SDK for the Friday API

import { AnalyzeCompanyOptions, CrawlOptions, CreateApiKeyOptions, CreateUserApiKeyOptions, ExtractOptions, GetProfileOptions, LinkedInCompanyPostsOptions, LinkedInProfilePostsOptions, RedditSearchOptions, RedditSubredditSearchOptions, RedditUserPostsOptions, RegenerateUserApiKeyOptions, SDKOptions, ScrapeOptions, SearchOptions, TwitterProfileOptions, XAboutOptions, XLatestOptions, XNewsOptions, XSearchOptions, XWhoamiOptions } from "./types";
export declare class FridayClient {
    private client;
    constructor(options: SDKOptions);
    get_status(): Promise<any>;
    getStatus(): Promise<any>;
    getProfile(options: GetProfileOptions): Promise<any>;
    analyzeCompany(optionsOrUrl: AnalyzeCompanyOptions | string): Promise<any>;
    scrape(url: string, options?: ScrapeOptions): Promise<any>;
    crawl(url: string, options?: CrawlOptions): Promise<any>;
    extract(url: string, query: string, optionsOrSchema?: ExtractOptions | Record<string, any> | Array<Record<string, any>>): Promise<any>;
    search(query: string, optionsOrLocation?: SearchOptions | string, numResults?: number): Promise<any>;
    redditSearch(query: string, options?: RedditSearchOptions): Promise<any>;
    redditSubredditSearch(options: RedditSubredditSearchOptions): Promise<any>;
    redditUserPosts(options: RedditUserPostsOptions): Promise<any>;
    scrapeTwitterProfile(options: TwitterProfileOptions): Promise<any>;
    xLatest(options: XLatestOptions): Promise<any>;
    xSearch(options: XSearchOptions): Promise<any>;
    xNews(options?: XNewsOptions): Promise<any>;
    xAbout(options: XAboutOptions): Promise<any>;
    xWhoami(options?: XWhoamiOptions): Promise<any>;
    linkedinProfilePosts(options: LinkedInProfilePostsOptions): Promise<any>;
    linkedinCompanyPosts(options: LinkedInCompanyPostsOptions): Promise<any>;
    createApiKey(options: CreateApiKeyOptions): Promise<any>;
    revokeApiKey(key: string): Promise<any>;
    resetRateLimits(): Promise<any>;
    createUserApiKey(options: CreateUserApiKeyOptions): Promise<any>;
    getUserApiKeys(jwtToken: string): Promise<any>;
    getSubscriptionPlans(jwtToken?: string): Promise<any>;
    regenerateUserApiKey(options: RegenerateUserApiKeyOptions): Promise<any>;
}
export * from "./types";