@youmind-openlab/rettiwt-api 1.0.1 → 1.0.3

package/dist/browser/requests/User.d.ts

@@ -1,143 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-import { RawAnalyticsGranularity, RawAnalyticsMetric } from '../enums/raw/Analytics';
-import { IProfileUpdateOptions } from '../types/args/ProfileArgs';
-/**
- * Collection of requests related to users.
- *
- * @public
- */
-export declare class UserRequests {
-    /**
-     * @param id - The id of the user whose affiliates are to be fetched.
-     * @param count - The number of affiliates to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of affiliates to fetch.
-     */
-    static affiliates(id: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param fromTime - The start time of the analytic data to be fetched.
-     * @param toTime - The end time of the analytic data to be fetched.
-     * @param granularity - The granularity of the analytic data to be fetched.
-     * @param requestedMetrics - The metrics to be fetched.
-     * @param showVerifiedFollowers - Whether to show verified followers in the analytics.
-     */
-    static analytics(fromTime: Date, toTime: Date, granularity: RawAnalyticsGranularity, requestedMetrics: RawAnalyticsMetric[], showVerifiedFollowers: boolean): AxiosRequestConfig;
-    /**
-     * Fetches tweets from a specific bookmark folder.
-     *
-     * @param folderId - The ID of the bookmark folder.
-     * @param count - The number of tweets to fetch.
-     * @param cursor - The cursor to the batch of tweets to fetch.
-     */
-    static bookmarkFolderTweets(folderId: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * Fetches the list of bookmark folders for the logged-in user.
-     *
-     * @param cursor - The cursor to the batch of bookmark folders to fetch.
-     */
-    static bookmarkFolders(cursor?: string): AxiosRequestConfig;
-    /**
-     * @param count - The number of bookmarks to fetch.
-     * @param cursor - The cursor to the batch of bookmarks to fetch.
-     */
-    static bookmarks(count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param ids - The IDs of the users whose details are to be fetched.
-     */
-    static bulkDetailsByIds(ids: string[]): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user whose details are to be fetched.
-     */
-    static detailsById(id: string): AxiosRequestConfig;
-    /**
-     * @param userName - The username of the user whose details are to be fetched.
-     */
-    static detailsByUsername(userName: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user to follow.
-     */
-    static follow(id: string): AxiosRequestConfig;
-    /**
-     * @param count - The number of timeline items to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of followed timeline items to fetch.
-     */
-    static followed(count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user whose followers are to be fetched.
-     * @param count - The number of followers to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of followers to fetch.
-     */
-    static followers(id: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user whose followings are to be fetched.
-     * @param count - The number of followings to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of followings to fetch.
-     */
-    static following(id: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user whose highlights are to be fetched.
-     * @param count - The number of highlights to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of highlights to fetch.
-     */
-    static highlights(id: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user whose likes are to be fetched.
-     * @param count - The number of likes to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of likes to fetch.
-     */
-    static likes(id: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user whose lists are to be fetched.
-     * @param count - The number of lists to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of lists to fetch.
-     */
-    static lists(id: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user whose media is to be fetched.
-     * @param count - The number of media to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of media to fetch.
-     */
-    static media(id: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param count - The number of notifications to fetch.
-     * @param cursor - The cursor to the batch of notifications to fetch.
-     */
-    static notifications(count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param count - The number of timeline items to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of recommended timeline items to fetch.
-     */
-    static recommended(count?: number, cursor?: string): AxiosRequestConfig;
-    static scheduled(): AxiosRequestConfig;
-    /**
-     * @param userName - The username to search for.
-     * @param count - The number of user matches to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of results to fetch.
-     */
-    static search(userName: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user whose subscriptions are to be fetched.
-     * @param count - The number of subscriptions to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of subscriptions to fetch.
-     */
-    static subscriptions(id: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user whose timeline tweets are to be fetched.
-     * @param count - The number of timeline tweets to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of timeline tweets to fetch.
-     */
-    static tweets(id: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user whose timeline tweets and replies are to be fetched.
-     * @param count - The number of timeline tweets and replies to fetch. Only works as a lower limit when used with a cursor.
-     * @param cursor - The cursor to the batch of timeline tweets and replies to fetch.
-     */
-    static tweetsAndReplies(id: string, count?: number, cursor?: string): AxiosRequestConfig;
-    /**
-     * @param id - The id of the user to be unfollowed.
-     */
-    static unfollow(id: string): AxiosRequestConfig;
-    /**
-     * @param options - The profile update options.
-     */
-    static updateProfile(options: IProfileUpdateOptions): AxiosRequestConfig;
-}