@bycrawl/nodejs-sdk 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,803 @@
+declare const SDK_VERSION = "0.1.1";
+interface ResponseWrapper {
+    statusCode: number;
+    data: Record<string, unknown>;
+    headers: Record<string, string>;
+}
+interface TransportOptions {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+}
+declare class Transport {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly timeout;
+    private readonly maxRetries;
+    private readonly defaultHeaders;
+    constructor(options: TransportOptions);
+    request(method: string, path: string, options?: {
+        params?: Record<string, unknown>;
+        json?: Record<string, unknown>;
+        headers?: Record<string, string>;
+    }): Promise<ResponseWrapper>;
+}
+
+/**
+ * ByCrawl Response Types
+ *
+ * TypeScript interfaces for all API responses.
+ * All fields from the API are preserved — extra fields are allowed via index signatures.
+ */
+interface RateLimit {
+    limit: number | null;
+    remaining: number | null;
+    reset: number | null;
+}
+interface CreditInfo {
+    remaining: number | null;
+    used: number | null;
+}
+interface APIResponse<T> {
+    success: boolean;
+    data: T | null;
+    error: string | null;
+    queued: boolean;
+    rateLimit: RateLimit | null;
+    credit: CreditInfo | null;
+}
+interface PaginatedData<T> {
+    items: T[];
+    nextCursor: string | null;
+    [key: string]: unknown;
+}
+interface ThreadsUser {
+    id: string;
+    username: string;
+    fullName?: string | null;
+    profilePic?: string | null;
+    bio?: string | null;
+    isVerified?: boolean;
+    followerCount?: number | null;
+    followingCount?: number | null;
+    [key: string]: unknown;
+}
+interface ThreadsPostStats {
+    likes?: number;
+    replies?: number;
+    quotes?: number;
+    reposts?: number;
+    shares?: number;
+    [key: string]: unknown;
+}
+interface ThreadsMedia {
+    index?: number;
+    type?: string;
+    url?: string;
+    width?: number | null;
+    height?: number | null;
+    [key: string]: unknown;
+}
+interface ThreadsPost {
+    id: string;
+    code?: string | null;
+    text?: string | null;
+    user?: ThreadsUser | null;
+    media?: ThreadsMedia[];
+    stats?: ThreadsPostStats | null;
+    createdAt?: string | null;
+    views?: number | null;
+    isReply?: boolean;
+    replyTo?: unknown;
+    [key: string]: unknown;
+}
+interface FacebookUser {
+    id?: string | null;
+    name?: string | null;
+    username?: string | null;
+    category?: string | null;
+    profilePicture?: string | null;
+    coverPhoto?: string | null;
+    likesCount?: number | null;
+    description?: string | null;
+    [key: string]: unknown;
+}
+interface FacebookPost {
+    id?: string | null;
+    url?: string | null;
+    text?: string | null;
+    createdAt?: string | null;
+    reactionCount?: number | null;
+    commentCount?: number | null;
+    shareCount?: number | null;
+    viewCount?: number | null;
+    media?: Record<string, unknown>[];
+    [key: string]: unknown;
+}
+interface XUser {
+    id: string;
+    username: string;
+    name?: string | null;
+    description?: string | null;
+    profileImageUrl?: string | null;
+    bannerUrl?: string | null;
+    followersCount?: number | null;
+    followingCount?: number | null;
+    tweetCount?: number | null;
+    isVerified?: boolean;
+    isBlueVerified?: boolean;
+    createdAt?: string | null;
+    location?: string | null;
+    url?: string | null;
+    [key: string]: unknown;
+}
+interface XPost {
+    id: string;
+    text?: string | null;
+    createdAt?: string | null;
+    user?: XUser | null;
+    likeCount?: number | null;
+    retweetCount?: number | null;
+    replyCount?: number | null;
+    quoteCount?: number | null;
+    bookmarkCount?: number | null;
+    viewCount?: number | null;
+    media?: Record<string, unknown>[];
+    isRetweet?: boolean;
+    isReply?: boolean;
+    lang?: string | null;
+    url?: string | null;
+    [key: string]: unknown;
+}
+interface InstagramUser {
+    id?: string | null;
+    username?: string | null;
+    fullName?: string | null;
+    biography?: string | null;
+    profilePicUrl?: string | null;
+    followerCount?: number | null;
+    followingCount?: number | null;
+    mediaCount?: number | null;
+    isVerified?: boolean;
+    isPrivate?: boolean;
+    [key: string]: unknown;
+}
+interface InstagramTag {
+    name?: string | null;
+    mediaCount?: number | null;
+    [key: string]: unknown;
+}
+interface Subreddit {
+    name?: string | null;
+    title?: string | null;
+    description?: string | null;
+    subscribers?: number | null;
+    activeUsers?: number | null;
+    createdAt?: string | null;
+    [key: string]: unknown;
+}
+interface RedditPost {
+    id: string;
+    title?: string | null;
+    text?: string | null;
+    url?: string | null;
+    author?: string | null;
+    subreddit?: string | null;
+    score?: number | null;
+    upvoteRatio?: number | null;
+    numComments?: number | null;
+    createdAt?: string | null;
+    permalink?: string | null;
+    isNsfw?: boolean;
+    [key: string]: unknown;
+}
+interface RedditUser {
+    username?: string | null;
+    id?: string | null;
+    createdAt?: string | null;
+    linkKarma?: number | null;
+    commentKarma?: number | null;
+    isGold?: boolean;
+    [key: string]: unknown;
+}
+interface LinkedInCompany {
+    id?: string | null;
+    name?: string | null;
+    universalName?: string | null;
+    description?: string | null;
+    website?: string | null;
+    industry?: string | null;
+    size?: string | null;
+    headquarters?: string | null;
+    logo?: string | null;
+    banner?: string | null;
+    employeeCount?: number | string | null;
+    followerCount?: number | null;
+    specialties?: string[] | null;
+    founded?: string | null;
+    [key: string]: unknown;
+}
+interface LinkedInJob {
+    id?: string | null;
+    title?: string | null;
+    company?: string | null;
+    companyId?: string | null;
+    location?: string | null;
+    description?: string | null;
+    employmentType?: string | null;
+    postedAt?: string | null;
+    applyUrl?: string | null;
+    [key: string]: unknown;
+}
+interface LinkedInPost {
+    id?: string | null;
+    text?: string | null;
+    author?: Record<string, unknown> | null;
+    likesCount?: number | null;
+    commentsCount?: number | null;
+    sharesCount?: number | null;
+    createdAt?: string | null;
+    [key: string]: unknown;
+}
+interface LinkedInUser {
+    username?: string | null;
+    firstName?: string | null;
+    lastName?: string | null;
+    headline?: string | null;
+    summary?: string | null;
+    profilePicUrl?: string | null;
+    location?: string | null;
+    followerCount?: number | null;
+    connectionCount?: number | null;
+    [key: string]: unknown;
+}
+interface TikTokVideo {
+    id?: string | null;
+    description?: string | null;
+    createdAt?: string | null;
+    author?: Record<string, unknown> | null;
+    stats?: Record<string, unknown> | null;
+    music?: Record<string, unknown> | null;
+    videoUrl?: string | null;
+    coverUrl?: string | null;
+    duration?: number | null;
+    [key: string]: unknown;
+}
+interface TikTokUser {
+    id?: string | null;
+    username?: string | null;
+    displayName?: string | null;
+    avatarUrl?: string | null;
+    bio?: string | null;
+    signature?: string | null;
+    verified?: boolean;
+    followers?: number | null;
+    following?: number | null;
+    hearts?: number | null;
+    videoCount?: number | null;
+    [key: string]: unknown;
+}
+interface TikTokComment {
+    id?: string | null;
+    text?: string | null;
+    user?: Record<string, unknown> | null;
+    likeCount?: number | null;
+    replyCount?: number | null;
+    createdAt?: string | null;
+    [key: string]: unknown;
+}
+interface TikTokCategory {
+    id?: string | null;
+    name?: string | null;
+    [key: string]: unknown;
+}
+interface YouTubeVideo {
+    id?: string | null;
+    title?: string | null;
+    description?: string | null;
+    channelId?: string | null;
+    channelTitle?: string | null;
+    viewCount?: number | null;
+    likeCount?: number | null;
+    commentCount?: number | null;
+    duration?: string | null;
+    publishedAt?: string | null;
+    thumbnail?: string | null;
+    keywords?: string[];
+    [key: string]: unknown;
+}
+interface YouTubeChannel {
+    id?: string | null;
+    title?: string | null;
+    description?: string | null;
+    subscriberCount?: number | null;
+    videoCount?: number | null;
+    viewCount?: number | null;
+    thumbnail?: string | null;
+    banner?: string | null;
+    createdAt?: string | null;
+    country?: string | null;
+    [key: string]: unknown;
+}
+interface YouTubeComment {
+    id?: string | null;
+    text?: string | null;
+    author?: string | null;
+    authorChannelId?: string | null;
+    authorAvatar?: string | null;
+    isVerified?: boolean;
+    likeCount?: number | null;
+    replyCount?: number | null;
+    publishedAt?: string | null;
+    [key: string]: unknown;
+}
+interface DcardForum {
+    alias?: string | null;
+    name?: string | null;
+    description?: string | null;
+    isSchool?: boolean;
+    postCount?: Record<string, unknown> | null;
+    subscriptionCount?: number | null;
+    [key: string]: unknown;
+}
+interface DcardPost {
+    id?: number | null;
+    title?: string | null;
+    excerpt?: string | null;
+    content?: string | null;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+    forumAlias?: string | null;
+    forumName?: string | null;
+    commentCount?: number | null;
+    likeCount?: number | null;
+    topics?: string[];
+    media?: Record<string, unknown>[];
+    [key: string]: unknown;
+}
+interface DcardPersona {
+    username?: string | null;
+    nickname?: string | null;
+    postCount?: number | null;
+    gender?: string | null;
+    [key: string]: unknown;
+}
+interface GMapsPlace {
+    name?: string | null;
+    category?: string | null;
+    address?: string | null;
+    website?: string | null;
+    phone?: string | null;
+    rating?: number | null;
+    description?: string | null;
+    hours?: string | null;
+    lat?: number | null;
+    lng?: number | null;
+    placeId?: string | null;
+    priceLevel?: string | null;
+    photoCount?: number | null;
+    url?: string | null;
+    [key: string]: unknown;
+}
+interface Job104Job {
+    jobId?: string | null;
+    jobName?: string | null;
+    companyId?: string | null;
+    companyName?: string | null;
+    area?: string | null;
+    description?: string | null;
+    salary?: string | null;
+    employmentType?: string | null;
+    appearedAt?: string | null;
+    link?: string | null;
+    tags?: string[];
+    requirements?: string[];
+    [key: string]: unknown;
+}
+interface Job104Company {
+    id?: string | null;
+    name?: string | null;
+    description?: string | null;
+    industry?: string | null;
+    employeeCount?: string | null;
+    website?: string | null;
+    address?: string | null;
+    logoUrl?: string | null;
+    [key: string]: unknown;
+}
+interface BulkJob {
+    jobId: string;
+    status: string;
+    [key: string]: unknown;
+}
+interface BulkJobStatus {
+    jobId: string;
+    status: string;
+    total?: number | null;
+    completed?: number | null;
+    failed?: number | null;
+    createdAt?: string | null;
+    [key: string]: unknown;
+}
+
+/**
+ * APIResource Base Class
+ *
+ * All platform namespaces inherit from APIResource.
+ * Handles HTTP call delegation, response wrapping, header parsing, and pagination.
+ */
+
+declare class APIResource {
+    protected readonly _transport: Transport;
+    constructor(transport: Transport);
+    protected _get<T>(path: string, options?: {
+        params?: Record<string, unknown>;
+        castTo?: (raw: Record<string, unknown>) => T;
+    }): Promise<APIResponse<T>>;
+    protected _post<T>(path: string, options?: {
+        body?: Record<string, unknown>;
+        castTo?: (raw: Record<string, unknown>) => T;
+    }): Promise<APIResponse<T>>;
+    protected _getList<T>(path: string, options: {
+        params?: Record<string, unknown>;
+        itemsKey: string;
+        castTo?: (raw: Record<string, unknown>) => T;
+    }): Promise<APIResponse<T[]>>;
+    protected _request<T>(method: string, path: string, options?: {
+        params?: Record<string, unknown>;
+        body?: Record<string, unknown>;
+        castTo?: (raw: Record<string, unknown>) => T;
+    }): Promise<APIResponse<T>>;
+    protected _paginate<T>(path: string, options: {
+        params: Record<string, unknown>;
+        itemsKey?: string;
+        cursorKey?: string;
+        hasMoreKey?: string;
+        castTo?: (raw: Record<string, unknown>) => T;
+    }): AsyncGenerator<T>;
+    protected _paginateByPage<T>(path: string, options: {
+        params: Record<string, unknown>;
+        itemsKey?: string;
+        pageKey?: string;
+        castTo?: (raw: Record<string, unknown>) => T;
+    }): AsyncGenerator<T>;
+    protected _paginateByOffset<T>(path: string, options: {
+        params: Record<string, unknown>;
+        itemsKey?: string;
+        countKey?: string;
+        castTo?: (raw: Record<string, unknown>) => T;
+    }): AsyncGenerator<T>;
+}
+
+declare class Dcard extends APIResource {
+    getForum(alias: string): Promise<APIResponse<DcardForum>>;
+    getForumPosts(alias: string, options?: {
+        count?: number;
+        popular?: boolean;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    searchPosts(q: string, options?: {
+        count?: number;
+        offset?: number;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    getPersona(username: string): Promise<APIResponse<DcardPersona>>;
+    iterSearchPosts(q: string, options?: {
+        count?: number;
+    }): AsyncGenerator<DcardPost>;
+}
+
+declare class Facebook extends APIResource {
+    getUser(username: string): Promise<APIResponse<FacebookUser>>;
+    getUserPosts(username: string): Promise<APIResponse<FacebookPost[]>>;
+    getPost(options: {
+        url: string;
+    }): Promise<APIResponse<FacebookPost>>;
+    getPostComments(options: {
+        url: string;
+        cursor?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    searchPosts(q: string, options?: {
+        count?: number;
+        cursor?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    marketplaceBrowse(location: string, options?: {
+        category?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    marketplaceSearch(q: string, options?: {
+        location?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    marketplaceItem(listingId: string): Promise<APIResponse<Record<string, unknown>>>;
+    iterPostComments(options: {
+        url: string;
+    }): AsyncGenerator<Record<string, unknown>>;
+    iterSearchPosts(q: string, options?: {
+        count?: number;
+    }): AsyncGenerator<FacebookPost>;
+}
+
+declare class GMaps extends APIResource {
+    search(q: string, options?: {
+        language?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    getPlace(query: string, options?: {
+        language?: string;
+    }): Promise<APIResponse<GMapsPlace>>;
+}
+
+declare class Instagram extends APIResource {
+    getUser(username: string): Promise<APIResponse<InstagramUser>>;
+    searchTags(q: string): Promise<APIResponse<Record<string, unknown>>>;
+    getPost(shortcode: string): Promise<APIResponse<Record<string, unknown>>>;
+    getPostComments(shortcode: string, options?: {
+        cursor?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    getUserPosts(username: string, options?: {
+        cursor?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    iterUserPosts(username: string): AsyncGenerator<Record<string, unknown>>;
+    iterPostComments(shortcode: string): AsyncGenerator<Record<string, unknown>>;
+}
+
+declare class Job104 extends APIResource {
+    searchJobs(options?: {
+        q?: string;
+        welfare?: string;
+        area?: string;
+        page?: number;
+        count?: number;
+    }): Promise<APIResponse<Job104Job[]>>;
+    getCompany(companyId: string): Promise<APIResponse<Job104Company>>;
+    getJob(jobId: string): Promise<APIResponse<Job104Job>>;
+    iterSearchJobs(options?: {
+        q?: string;
+        welfare?: string;
+        area?: string;
+        count?: number;
+    }): AsyncGenerator<Job104Job>;
+}
+
+declare class LinkedIn extends APIResource {
+    getCompany(companyId: string): Promise<APIResponse<LinkedInCompany>>;
+    getCompanyJobs(companyId: string, options?: {
+        count?: number;
+        offset?: number;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    searchJobs(query: string, options?: {
+        location?: string;
+        count?: number;
+        offset?: number;
+    }): Promise<APIResponse<LinkedInJob[]>>;
+    getJob(jobId: string): Promise<APIResponse<LinkedInJob>>;
+    getPost(postId: string): Promise<APIResponse<LinkedInPost>>;
+    searchUsers(query: string, options?: {
+        count?: number;
+        offset?: number;
+    }): Promise<APIResponse<LinkedInUser[]>>;
+    getUser(username: string): Promise<APIResponse<LinkedInUser>>;
+    iterCompanyJobs(companyId: string, options?: {
+        count?: number;
+    }): AsyncGenerator<LinkedInJob>;
+    iterSearchJobs(query: string, options?: {
+        location?: string;
+        count?: number;
+    }): AsyncGenerator<LinkedInJob>;
+}
+
+declare class Reddit extends APIResource {
+    getSubreddit(name: string): Promise<APIResponse<Subreddit>>;
+    getSubredditPosts(name: string, options?: {
+        sort?: string;
+        t?: string;
+        count?: number;
+    }): Promise<APIResponse<RedditPost[]>>;
+    getPost(postId: string): Promise<APIResponse<RedditPost>>;
+    searchPosts(q: string, options?: {
+        sort?: string;
+        count?: number;
+    }): Promise<APIResponse<RedditPost[]>>;
+    getUser(username: string): Promise<APIResponse<RedditUser>>;
+    getUserPosts(username: string, options?: {
+        sort?: string;
+        t?: string;
+        count?: number;
+        after?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+}
+
+declare class Threads extends APIResource {
+    getPost(postId: string, options?: {
+        mode?: string;
+    }): Promise<APIResponse<ThreadsPost>>;
+    getPosts(ids: string[], options?: {
+        mode?: string;
+    }): Promise<APIResponse<ThreadsPost[]>>;
+    searchPosts(q: string, options?: {
+        count?: number;
+    }): Promise<APIResponse<ThreadsPost[]>>;
+    getUser(username: string): Promise<APIResponse<ThreadsUser>>;
+    getUserPosts(userId: string, options?: {
+        cursor?: string;
+        count?: number;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    getUserReplies(userId: string, options?: {
+        cursor?: string;
+        count?: number;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    searchUsers(q: string, options?: {
+        count?: number;
+    }): Promise<APIResponse<ThreadsUser[]>>;
+    getPublicFeed(options?: {
+        cursor?: string;
+        count?: number;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    bulkSubmit(ids: string[], options?: {
+        type?: string;
+    }): Promise<APIResponse<BulkJob>>;
+    bulkStatus(jobId: string): Promise<APIResponse<BulkJobStatus>>;
+    bulkResults(jobId: string): Promise<APIResponse<ThreadsPost[]>>;
+    bulkSubmitAndWait(ids: string[], options?: {
+        pollInterval?: number;
+        timeout?: number;
+    }): Promise<APIResponse<ThreadsPost[]>>;
+    iterUserPosts(userId: string, options?: {
+        count?: number;
+    }): AsyncGenerator<ThreadsPost>;
+    iterUserReplies(userId: string, options?: {
+        count?: number;
+    }): AsyncGenerator<ThreadsPost>;
+}
+
+declare class TikTok extends APIResource {
+    getVideo(videoId: string): Promise<APIResponse<TikTokVideo>>;
+    getUser(username: string): Promise<APIResponse<TikTokUser>>;
+    getUserVideos(username: string, options?: {
+        count?: number;
+    }): Promise<APIResponse<TikTokVideo[]>>;
+    getVideoComments(videoId: string, options?: {
+        cursor?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    getCategories(options?: {
+        category?: string;
+        count?: number;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    search(keyword: string, options?: {
+        count?: number;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    getVideoSubtitles(videoId: string): Promise<APIResponse<Record<string, unknown>>>;
+    iterVideoComments(videoId: string): AsyncGenerator<TikTokComment>;
+}
+
+declare class WebFetch extends APIResource {
+    fetch(url: string, options?: {
+        format?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+}
+
+declare class X extends APIResource {
+    getUser(username: string): Promise<APIResponse<XUser>>;
+    getUserPosts(username: string, options?: {
+        count?: number;
+        cursor?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    getPost(postId: string): Promise<APIResponse<XPost>>;
+    searchPosts(q: string, options?: {
+        count?: number;
+        cursor?: string;
+        product?: string;
+    }): Promise<APIResponse<XPost[]>>;
+    iterUserPosts(username: string, options?: {
+        count?: number;
+    }): AsyncGenerator<XPost>;
+    iterSearchPosts(q: string, options?: {
+        count?: number;
+        product?: string;
+    }): AsyncGenerator<XPost>;
+}
+
+declare class YouTube extends APIResource {
+    getVideo(videoId: string): Promise<APIResponse<YouTubeVideo>>;
+    getChannel(channelId: string): Promise<APIResponse<YouTubeChannel>>;
+    search(q: string, options?: {
+        count?: number;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    getVideoComments(videoId: string, options?: {
+        count?: number;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    getVideoTranscription(videoId: string, options?: {
+        language?: string;
+    }): Promise<APIResponse<Record<string, unknown>>>;
+    iterSearch(q: string, options?: {
+        count?: number;
+    }): AsyncGenerator<YouTubeVideo>;
+    iterVideoComments(videoId: string, options?: {
+        count?: number;
+    }): AsyncGenerator<YouTubeComment>;
+}
+
+/**
+ * ByCrawl Client
+ *
+ * Main entry point for the SDK. Wires up all platform namespaces
+ * and manages the HTTP transport.
+ */
+
+interface ByCrawlOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+}
+/**
+ * ByCrawl client for the ByCrawl social media data API.
+ *
+ * @example
+ * ```ts
+ * const client = new ByCrawl({ apiKey: "sk_byc_..." });
+ * const post = await client.threads.getPost("DQt-ox3kdE4");
+ * console.log(post.data);
+ * ```
+ */
+declare class ByCrawl {
+    readonly threads: Threads;
+    readonly facebook: Facebook;
+    readonly x: X;
+    readonly instagram: Instagram;
+    readonly reddit: Reddit;
+    readonly linkedin: LinkedIn;
+    readonly tiktok: TikTok;
+    readonly youtube: YouTube;
+    readonly dcard: Dcard;
+    readonly gmaps: GMaps;
+    readonly job104: Job104;
+    readonly web: WebFetch;
+    private readonly _transport;
+    constructor(options?: ByCrawlOptions);
+}
+
+/**
+ * ByCrawl Exception Hierarchy
+ *
+ * All SDK exceptions inherit from ByCrawlError.
+ * HTTP errors are mapped to specific subclasses by status code.
+ */
+declare class ByCrawlError extends Error {
+    constructor(message: string);
+}
+declare class APIError extends ByCrawlError {
+    readonly statusCode: number;
+    readonly body: Record<string, unknown> | null;
+    constructor(message: string, options: {
+        statusCode: number;
+        body?: Record<string, unknown> | null;
+    });
+}
+declare class AuthenticationError extends APIError {
+    constructor(message?: string, body?: Record<string, unknown> | null);
+}
+declare class PermissionError extends APIError {
+    constructor(message?: string, body?: Record<string, unknown> | null);
+}
+declare class NotFoundError extends APIError {
+    constructor(message?: string, body?: Record<string, unknown> | null);
+}
+declare class RateLimitError extends APIError {
+    readonly retryAfter: number | null;
+    constructor(message?: string, options?: {
+        retryAfter?: number | null;
+        body?: Record<string, unknown> | null;
+    });
+}
+declare class ServerError extends APIError {
+    constructor(message: string, options: {
+        statusCode: number;
+        body?: Record<string, unknown> | null;
+    });
+}
+declare class TimeoutError extends ByCrawlError {
+    constructor(message?: string);
+}
+declare class ConnectionError extends ByCrawlError {
+    constructor(message?: string);
+}
+
+export { APIError, type APIResponse, AuthenticationError, type BulkJob, type BulkJobStatus, ByCrawl, ByCrawlError, type ByCrawlOptions, ConnectionError, type CreditInfo, type DcardForum, type DcardPersona, type DcardPost, type FacebookPost, type FacebookUser, type GMapsPlace, type InstagramTag, type InstagramUser, type Job104Company, type Job104Job, type LinkedInCompany, type LinkedInJob, type LinkedInPost, type LinkedInUser, NotFoundError, type PaginatedData, PermissionError, type RateLimit, RateLimitError, type RedditPost, type RedditUser, SDK_VERSION, ServerError, type Subreddit, type ThreadsMedia, type ThreadsPost, type ThreadsPostStats, type ThreadsUser, type TikTokCategory, type TikTokComment, type TikTokUser, type TikTokVideo, TimeoutError, type XPost, type XUser, type YouTubeChannel, type YouTubeComment, type YouTubeVideo };