rettiwt-api 5.0.0-alpha.0 → 5.0.0-alpha.2

package/dist/index.d.ts

@@ -1,6 +1,15 @@
 export * from './Rettiwt';
+export * from './enums/raw/Analytics';
+export * from './enums/raw/Media';
+export * from './enums/raw/Notification';
+export * from './enums/raw/Tweet';
 export * from './enums/Api';
+export * from './enums/Authentication';
+export * from './enums/Data';
 export * from './enums/Http';
+export * from './enums/Logging';
+export * from './enums/Media';
+export * from './enums/Notification';
 export * from './enums/Resource';
 export * from './models/args/FetchArgs';
 export * from './models/args/PostArgs';
@@ -10,15 +19,76 @@ export * from './models/data/Notification';
 export * from './models/data/Tweet';
 export * from './models/data/User';
 export * from './models/errors/ApiError';
-export * from './models/errors/DataValidationError';
 export * from './models/errors/HttpError';
 export * from './models/errors/RettiwtError';
 export * from './models/errors/TimeoutError';
-export * from './services/public/AuthService';
+export * from './requests/List';
+export * from './requests/Media';
+export * from './requests/Tweet';
+export * from './requests/User';
 export * from './services/public/FetcherService';
+export * from './services/public/ListService';
 export * from './services/public/TweetService';
 export * from './services/public/UserService';
-export * from './types/RettiwtConfig';
+export * from './types/args/FetchArgs';
+export * from './types/args/PostArgs';
+export * from './types/auth/TidProvider';
+export * from './types/data/CursoredData';
+export * from './types/data/List';
+export * from './types/data/Notification';
+export * from './types/data/Tweet';
+export * from './types/data/User';
+export * from './types/params/Variables';
+export { IAnalytics as IRawAnalytics } from './types/raw/base/Analytic';
+export { ICursor as IRawCursor } from './types/raw/base/Cursor';
+export { ILimitedVisibilityTweet as IRawLimitedVisibilityTweet } from './types/raw/base/LimitedVisibilityTweet';
+export { IList as IRawList } from './types/raw/base/List';
+export { IMedia as IRawMedia } from './types/raw/base/Media';
+export { INotification as IRawNotification } from './types/raw/base/Notification';
+export { ISpace as IRawSpace } from './types/raw/base/Space';
+export { ITweet as IRawTweet } from './types/raw/base/Tweet';
+export { IUser as IRawUser } from './types/raw/base/User';
+export { IDataResult as IRawDataResult } from './types/raw/composite/DataResult';
+export { ITimelineTweet as IRawTimelineTweet } from './types/raw/composite/TimelineTweet';
+export { ITimelineUser as IRawTimelineUser } from './types/raw/composite/TimelineUser';
+export { IError as IRawError } from './types/raw/generic/Error';
+export { IResponse as IRawResponse } from './types/raw/generic/Response';
+export { IListDetailsResponse as IRawListDetailsResponse } from './types/raw/list/Details';
+export { IListMembersResponse as IRawListMembersResponse } from './types/raw/list/Members';
+export { IListTweetsResponse as IRawListTweetsResponse } from './types/raw/list/Tweets';
+export { IMediaFinalizeUploadResponse as IRawMediaFinalizeUploadResponse } from './types/raw/media/FinalizeUpload';
+export { IMediaInitializeUploadResponse as IRawMediaInitializeUploadResponse } from './types/raw/media/InitalizeUpload';
+export { IMediaLiveVideoStreamResponse as IRawMediaLiveVideoStreamResponse } from './types/raw/media/LiveVideoStream';
+export { ITweetDetailsResponse as IRawTweetDetailsResponse } from './types/raw/tweet/Details';
+export { ITweetLikeResponse as IRawTweetLikeResponse } from './types/raw/tweet/Like';
+export { ITweetLikersResponse as IRawTweetLikersResponse } from './types/raw/tweet/Likers';
+export { ITweetPostResponse as IRawTweetPostResponse } from './types/raw/tweet/Post';
+export { ITweetRepliesResponse as IRawTweetRepliesResponse } from './types/raw/tweet/Replies';
+export { ITweetRetweetResponse as IRawTweetRetweetResponse } from './types/raw/tweet/Retweet';
+export { ITweetRetweetersResponse as IRawTweetRetweetersResponse } from './types/raw/tweet/Retweeters';
+export { ITweetScheduleResponse as IRawTweetScheduleResponse } from './types/raw/tweet/Schedule';
+export { ITweetSearchResponse as IRawTweetSearchResponse } from './types/raw/tweet/Search';
+export { ITweetUnlikeResponse as IRawTweetUnlikeResponse } from './types/raw/tweet/Unlike';
+export { ITweetUnpostResponse as IRawTweetUnpostResponse } from './types/raw/tweet/Unpost';
+export { ITweetUnretweetResponse as IRawTweetUnretweetResponse } from './types/raw/tweet/Unretweet';
+export { ITweetUnscheduleResponse as ITRawTweetUnscheduleResponse } from './types/raw/tweet/Unschedule';
+export { IUserAffiliatesResponse as IRawUserAffiliatesResponse } from './types/raw/user/Affiliates';
+export { IUserAnalyticsResponse as IRawUserAnalyticsResponse } from './types/raw/user/Analytics';
+export { IUserBookmarksResponse as IRawUserBookmarksResponse } from './types/raw/user/Bookmarks';
+export { IUserDetailsResponse as IRawUserDetailsResponse } from './types/raw/user/Details';
+export { IUserFollowResponse as IRawUserFollowResponse } from './types/raw/user/Follow';
+export { IUserFollowedResponse as IRawUserFollowedResponse } from './types/raw/user/Followed';
+export { IUserFollowersResponse as IRawUserFollowersResponse } from './types/raw/user/Followers';
+export { IUserFollowingResponse as IRawUserFollowingResponse } from './types/raw/user/Following';
+export { IUserHighlightsResponse as IRawUserHighlightsResponse } from './types/raw/user/Highlights';
+export { IUserLikesResponse as IRawUserLikesResponse } from './types/raw/user/Likes';
+export { IUserMediaResponse as IRawUserMediaResponse } from './types/raw/user/Media';
+export { IUserNotificationsResponse as IRawUserNotificationsResponse } from './types/raw/user/Notifications';
+export { IUserRecommendedResponse as IRawUserRecommendedResponse } from './types/raw/user/Recommended';
+export { IUserScheduledResponse as IRawUserScheduledResponse } from './types/raw/user/Scheduled';
+export { IUserSubscriptionsResponse as IRawUserSubscriptionsResponse } from './types/raw/user/Subscriptions';
+export { IUserTweetsResponse as IRawUserTweetsResponse } from './types/raw/user/Tweets';
+export { IUserTweetsAndRepliesResponse as IRawUserTweetsAndRepliesResponse } from './types/raw/user/TweetsAndReplies';
+export { IUserUnfollowResponse as IRawUserUnfollowResponse } from './types/raw/user/Unfollow';
 export * from './types/ErrorHandler';
-export { IInitializeMediaUploadResponse, IListMembersResponse, IListTweetsResponse, ITweetDetailsResponse, ITweetLikeResponse, ITweetPostResponse, ITweetRepliesResponse, ITweetRetweetersResponse, ITweetRetweetResponse, ITweetScheduleResponse, ITweetSearchResponse, ITweetUnlikeResponse, ITweetUnpostResponse, ITweetUnscheduleResponse, ITweetUnretweetResponse, } from 'rettiwt-core';
-export { IUserBookmarksResponse, IUserDetailsResponse, IUserFollowedResponse, IUserFollowersResponse, IUserFollowingResponse, IUserFollowResponse, IUserHighlightsResponse, IUserLikesResponse, IUserMediaResponse, IUserNotificationsResponse, IUserRecommendedResponse, IUserSubscriptionsResponse, IUserTweetsAndRepliesResponse, IUserTweetsResponse, IUserUnfollowResponse, } from 'rettiwt-core';
+export * from './types/RettiwtConfig';

package/dist/index.js

@@ -17,30 +17,50 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // MAIN
 __exportStar(require("./Rettiwt"), exports);
 // ENUMS
+__exportStar(require("./enums/raw/Analytics"), exports);
+__exportStar(require("./enums/raw/Media"), exports);
+__exportStar(require("./enums/raw/Notification"), exports);
+__exportStar(require("./enums/raw/Tweet"), exports);
 __exportStar(require("./enums/Api"), exports);
+__exportStar(require("./enums/Authentication"), exports);
+__exportStar(require("./enums/Data"), exports);
 __exportStar(require("./enums/Http"), exports);
+__exportStar(require("./enums/Logging"), exports);
+__exportStar(require("./enums/Media"), exports);
+__exportStar(require("./enums/Notification"), exports);
 __exportStar(require("./enums/Resource"), exports);
-// ARG MODELS
+// MODELS
 __exportStar(require("./models/args/FetchArgs"), exports);
 __exportStar(require("./models/args/PostArgs"), exports);
-// DATA MODELS
 __exportStar(require("./models/data/CursoredData"), exports);
 __exportStar(require("./models/data/List"), exports);
 __exportStar(require("./models/data/Notification"), exports);
 __exportStar(require("./models/data/Tweet"), exports);
 __exportStar(require("./models/data/User"), exports);
-// ERROR MODELS
 __exportStar(require("./models/errors/ApiError"), exports);
-__exportStar(require("./models/errors/DataValidationError"), exports);
 __exportStar(require("./models/errors/HttpError"), exports);
 __exportStar(require("./models/errors/RettiwtError"), exports);
 __exportStar(require("./models/errors/TimeoutError"), exports);
+// REQUESTS
+__exportStar(require("./requests/List"), exports);
+__exportStar(require("./requests/Media"), exports);
+__exportStar(require("./requests/Tweet"), exports);
+__exportStar(require("./requests/User"), exports);
 // SERVICES
-__exportStar(require("./services/public/AuthService"), exports);
 __exportStar(require("./services/public/FetcherService"), exports);
+__exportStar(require("./services/public/ListService"), exports);
 __exportStar(require("./services/public/TweetService"), exports);
 __exportStar(require("./services/public/UserService"), exports);
 // TYPES
-__exportStar(require("./types/RettiwtConfig"), exports);
+__exportStar(require("./types/args/FetchArgs"), exports);
+__exportStar(require("./types/args/PostArgs"), exports);
+__exportStar(require("./types/auth/TidProvider"), exports);
+__exportStar(require("./types/data/CursoredData"), exports);
+__exportStar(require("./types/data/List"), exports);
+__exportStar(require("./types/data/Notification"), exports);
+__exportStar(require("./types/data/Tweet"), exports);
+__exportStar(require("./types/data/User"), exports);
+__exportStar(require("./types/params/Variables"), exports);
 __exportStar(require("./types/ErrorHandler"), exports);
+__exportStar(require("./types/RettiwtConfig"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,OAAO;AACP,4CAA0B;AAE1B,QAAQ;AACR,8CAA4B;AAC5B,+CAA6B;AAC7B,mDAAiC;AAEjC,aAAa;AACb,0DAAwC;AACxC,yDAAuC;AAEvC,cAAc;AACd,6DAA2C;AAC3C,qDAAmC;AACnC,6DAA2C;AAC3C,sDAAoC;AACpC,qDAAmC;AAEnC,eAAe;AACf,2DAAyC;AACzC,sEAAoD;AACpD,4DAA0C;AAC1C,+DAA6C;AAC7C,+DAA6C;AAE7C,WAAW;AACX,gEAA8C;AAC9C,mEAAiD;AACjD,iEAA+C;AAC/C,gEAA8C;AAE9C,QAAQ;AACR,wDAAsC;AACtC,uDAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,OAAO;AACP,4CAA0B;AAE1B,QAAQ;AACR,wDAAsC;AACtC,oDAAkC;AAClC,2DAAyC;AACzC,oDAAkC;AAClC,8CAA4B;AAC5B,yDAAuC;AACvC,+CAA6B;AAC7B,+CAA6B;AAC7B,kDAAgC;AAChC,gDAA8B;AAC9B,uDAAqC;AACrC,mDAAiC;AAEjC,SAAS;AACT,0DAAwC;AACxC,yDAAuC;AACvC,6DAA2C;AAC3C,qDAAmC;AACnC,6DAA2C;AAC3C,sDAAoC;AACpC,qDAAmC;AACnC,2DAAyC;AACzC,4DAA0C;AAC1C,+DAA6C;AAC7C,+DAA6C;AAE7C,WAAW;AACX,kDAAgC;AAChC,mDAAiC;AACjC,mDAAiC;AACjC,kDAAgC;AAEhC,WAAW;AACX,mEAAiD;AACjD,gEAA8C;AAC9C,iEAA+C;AAC/C,gEAA8C;AAE9C,QAAQ;AACR,yDAAuC;AACvC,wDAAsC;AACtC,2DAAyC;AACzC,4DAA0C;AAC1C,oDAAkC;AAClC,4DAA0C;AAC1C,qDAAmC;AACnC,oDAAkC;AAClC,2DAAyC;AAoDzC,uDAAqC;AACrC,wDAAsC"}

package/dist/models/RettiwtConfig.d.ts

@@ -0,0 +1,28 @@
+import { Agent } from 'https';
+import { ITidProvider } from '../types/auth/TidProvider';
+import { IErrorHandler } from '../types/ErrorHandler';
+import { IRettiwtConfig } from '../types/RettiwtConfig';
+export declare class RettiwtConfig implements IRettiwtConfig {
+    private _apiKey?;
+    private _httpsAgent;
+    private _userId;
+    readonly delay?: number | (() => number | Promise<number>);
+    readonly errorHandler?: IErrorHandler;
+    readonly logging?: boolean;
+    readonly tidProvider?: ITidProvider;
+    readonly timeout?: number;
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * @param config - The config for Rettiwt of type {@link IRettiwtConfig}.
+     */
+    constructor(config?: IRettiwtConfig);
+    get apiKey(): string | undefined;
+    /** The HTTPS agent instance to use. */
+    get httpsAgent(): Agent;
+    /** The ID of the user associated with the API key, if any. */
+    get userId(): string | undefined;
+    set apiKey(apiKey: string | undefined);
+    set proxyUrl(proxyUrl: URL | undefined);
+}

package/dist/models/RettiwtConfig.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RettiwtConfig = void 0;
+const https_1 = require("https");
+const https_proxy_agent_1 = require("https-proxy-agent");
+const AuthService_1 = require("../services/internal/AuthService");
+class RettiwtConfig {
+    // Parameters for internal use
+    _apiKey;
+    _httpsAgent;
+    _userId;
+    // Parameters that can be set once, upon initialization
+    delay;
+    errorHandler;
+    logging;
+    tidProvider;
+    timeout;
+    // Parameters that can be changed on the fly
+    headers;
+    /**
+     * @param config - The config for Rettiwt of type {@link IRettiwtConfig}.
+     */
+    constructor(config) {
+        this._apiKey = config?.apiKey;
+        this._httpsAgent = config?.proxyUrl ? new https_proxy_agent_1.HttpsProxyAgent(config?.proxyUrl) : new https_1.Agent();
+        this._userId = config?.apiKey ? AuthService_1.AuthService.getUserId(config?.apiKey) : undefined;
+        this.delay = config?.delay;
+        this.errorHandler = config?.errorHandler;
+        this.logging = config?.logging;
+        this.tidProvider = config?.tidProvider;
+        this.timeout = config?.timeout;
+        this.apiKey = config?.apiKey;
+        this.headers = config?.headers;
+    }
+    get apiKey() {
+        return this._apiKey;
+    }
+    /** The HTTPS agent instance to use. */
+    get httpsAgent() {
+        return this._httpsAgent;
+    }
+    /** The ID of the user associated with the API key, if any. */
+    get userId() {
+        return this._userId;
+    }
+    set apiKey(apiKey) {
+        this._apiKey = apiKey;
+        this._userId = apiKey ? AuthService_1.AuthService.getUserId(apiKey) : undefined;
+    }
+    set proxyUrl(proxyUrl) {
+        this._httpsAgent = proxyUrl ? new https_proxy_agent_1.HttpsProxyAgent(proxyUrl) : new https_1.Agent();
+    }
+}
+exports.RettiwtConfig = RettiwtConfig;
+//# sourceMappingURL=RettiwtConfig.js.map

package/dist/models/RettiwtConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RettiwtConfig.js","sourceRoot":"","sources":["../../src/models/RettiwtConfig.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAE9B,yDAAoD;AAEpD,kEAA+D;AAK/D,MAAa,aAAa;IACzB,8BAA8B;IACtB,OAAO,CAAU;IACjB,WAAW,CAAQ;IACnB,OAAO,CAAqB;IAEpC,uDAAuD;IACvC,KAAK,CAA6C;IAClD,YAAY,CAAiB;IAC7B,OAAO,CAAW;IAClB,WAAW,CAAgB;IAC3B,OAAO,CAAU;IAEjC,4CAA4C;IACrC,OAAO,CAA6B;IAE3C;;OAEG;IACH,YAAmB,MAAuB;QACzC,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE,MAAM,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,mCAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,aAAK,EAAE,CAAC;QAC1F,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,yBAAW,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClF,IAAI,CAAC,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,MAAM,EAAE,YAAY,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,MAAM,EAAE,WAAW,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,CAAC;IAChC,CAAC;IAED,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED,uCAAuC;IACvC,IAAW,UAAU;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAED,8DAA8D;IAC9D,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED,IAAW,MAAM,CAAC,MAA0B;QAC3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,yBAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACnE,CAAC;IAED,IAAW,QAAQ,CAAC,QAAyB;QAC5C,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,mCAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,aAAK,EAAE,CAAC;IAC3E,CAAC;CACD;AAtDD,sCAsDC"}

package/dist/models/args/FetchArgs.d.ts

@@ -1,149 +1,63 @@
-import { ESearchResultType, TweetFilter as TweetFilterCore } from 'rettiwt-core';
 import { EResourceType } from '../../enums/Resource';
+import { IFetchArgs, ITweetFilter } from '../../types/args/FetchArgs';
 /**
  * Options specifying the data that is to be fetched.
  *
  * @public
  */
-export declare class FetchArgs {
-    /**
-     * The number of data items to fetch.
-     *
-     * @remarks
-     * - Works only for cursored resources.
-     * - Must be \<= 20 for:
-     * 	- {@link EResourceType.USER_TIMELINE}
-     * 	- {@link EResourceType.USER_TIMELINE}
-     * 	- {@link EResourceType.USER_TIMELINE_AND_REPLIES}
-     * - Must be \<= 100 for all other cursored resources.
-     * - Due a bug on Twitter's end, count does not work for {@link EResourceType.USER_FOLLOWERS} and {@link EResourceType.USER_FOLLOWING}.
-     * - Has not effect for:
-     * 	- {@link EResourceType.USER_FEED_FOLLOWED}
-     * 	- {@link EResourceType.USER_FEED_RECOMMENDED}
-     */
+export declare class FetchArgs implements IFetchArgs {
     count?: number;
-    /**
-     * The cursor to the batch of data to fetch.
-     *
-     * @remarks
-     * - May be used for cursored resources.
-     * - Has no effect for other resources.
-     */
     cursor?: string;
-    /**
-     * The filter for searching tweets.
-     *
-     * @remarks
-     * Required when searching for tweets using {@link EResourceType.TWEET_SEARCH}.
-     */
     filter?: TweetFilter;
-    /**
-     * The id of the target resource.
-     *
-     * @remarks
-     * - Required for all resources except {@link EResourceType.TWEET_SEARCH} and {@link EResourceType.USER_TIMELINE_RECOMMENDED}.
-     * - For {@link EResourceType.USER_DETAILS_BY_USERNAME}, can be alphanumeric, while for others, is strictly numeric.
-     */
     id?: string;
-    /**
-     * The type of search results to fetch. Can be one of:
-     * - {@link EResourceType.LATEST}, for latest search results.
-     * - {@link EResourceType.TOP}, for top search results.
-     *
-     * @defaultValue {@link ESearchResultType.LATEST}.
-     *
-     * @remarks
-     * - Applicable only for {@link EResourceType.TWEET_SEARCH}.
-     */
-    results?: ESearchResultType;
+    ids?: string[];
     /**
      * @param resource - The resource to be fetched.
      * @param args - Additional user-defined arguments for fetching the resource.
      */
-    constructor(resource: EResourceType, args: FetchArgs);
+    constructor(resource: EResourceType, args: IFetchArgs);
 }
 /**
  * The filter to be used for searching tweets.
  *
  * @public
  */
-export declare class TweetFilter extends TweetFilterCore {
-    /** The date upto which tweets are to be searched. */
+export declare class TweetFilter implements ITweetFilter {
     endDate?: Date;
-    /** The list of words to exclude from search. */
     excludeWords?: string[];
-    /**
-     * The list of usernames whose tweets are to be searched.
-     *
-     * @remarks
-     * '\@' must be excluded from the username!
-     */
     fromUsers?: string[];
-    /**
-     * The list of hashtags to search.
-     *
-     * @remarks
-     * '#' must be excluded from the hashtag!
-     */
     hashtags?: string[];
-    /** The exact phrase to search. */
     includePhrase?: string;
-    /** The list of words to search. */
     includeWords?: string[];
-    /** The language of the tweets to search. */
     language?: string;
-    /**
-     * Whether to fetch tweets that are links or not.
-     *
-     * @defaultValue true
-     */
     links?: boolean;
-    /** The list from which tweets are to be searched. */
     list?: string;
-    /** The id of the tweet, before which the tweets are to be searched. */
     maxId?: string;
-    /**
-     * The list of username mentioned in the tweets to search.
-     *
-     * @remarks
-     * '\@' must be excluded from the username!
-     */
     mentions?: string[];
-    /** The minimun number of likes to search by. */
     minLikes?: number;
-    /** The minimum number of replies to search by. */
     minReplies?: number;
-    /** The minimum number of retweets to search by. */
     minRetweets?: number;
-    /** The optional words to search. */
     optionalWords?: string[];
-    /** The id of the tweet which is quoted in the tweets to search. */
     quoted?: string;
-    /**
-     * Whether to fetch tweets that are replies or not.
-     *
-     * @defaultValue true
-     */
     replies?: boolean;
-    /** The id of the tweet, after which the tweets are to be searched. */
     sinceId?: string;
-    /** The date starting from which tweets are to be searched. */
     startDate?: Date;
+    toUsers?: string[];
+    top?: boolean;
     /**
-     * The list of username to whom the tweets to be searched, are adressed.
-     *
-     * @remarks
-     * '\@' must be excluded from the username!
+     * @param filter - The filter configuration.
      */
-    toUsers?: string[];
+    constructor(filter: ITweetFilter);
     /**
-     * Whether to fetch top or not.
+     * Convert Date object to Twitter string representation.
+     * eg - 2023-06-23_11:21:06_UTC
      *
-     * @defaultValue true
+     * @param date - The date object to convert.
+     * @returns The Twitter string representation of the date.
      */
-    top?: boolean;
+    private static dateToTwitterString;
     /**
-     * @param filter - The filter to use for searching tweets.
+     * @returns The string representation of 'this' filter.
      */
-    constructor(filter: TweetFilter);
+    toString(): string;
 }