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

package/dist/models/data/User.js

@@ -31,7 +31,7 @@ class User {
         this.id = user.rest_id;
         this.userName = user.legacy.screen_name;
         this.fullName = user.legacy.name;
-        this.createdAt = user.legacy.created_at;
+        this.createdAt = new Date(user.legacy.created_at).toISOString();
         this.description = user.legacy.description.length ? user.legacy.description : undefined;
         this.isVerified = user.is_blue_verified;
         this.likeCount = user.legacy.favourites_count;
@@ -44,24 +44,23 @@ class User {
         this.profileImage = user.legacy.profile_image_url_https;
     }
     /**
-     * Extracts and deserializes the list of users from the given raw response data.
+     * Extracts and deserializes multiple target users from the given raw response data.
      *
      * @param response - The raw response data.
+     * @param ids - The ids of the target users.
      *
-     * @returns The deserialized list of users.
-     *
-     * @internal
+     * @returns The target deserialized users.
      */
-    static list(response) {
-        const users = [];
+    static multiple(response, ids) {
+        let users = [];
         // Extracting the matching data
-        const extract = (0, JsonUtils_1.findByFilter)(response, '__typename', 'TimelineUser');
+        const extract = (0, JsonUtils_1.findByFilter)(response, '__typename', 'User');
         // Deserializing valid data
         for (const item of extract) {
-            if (item.user_results?.result?.legacy) {
+            if (item.legacy && item.legacy.created_at) {
                 // Logging
-                LogService_1.LogService.log(Logging_1.ELogActions.DESERIALIZE, { id: item.user_results.result.rest_id });
-                users.push(new User(item.user_results.result));
+                LogService_1.LogService.log(Logging_1.ELogActions.DESERIALIZE, { id: item.rest_id });
+                users.push(new User(item));
             }
             else {
                 // Logging
@@ -71,6 +70,10 @@ class User {
                 });
             }
         }
+        // Filtering only required user, if required
+        if (ids && ids.length) {
+            users = users.filter((user) => ids.includes(user.id));
+        }
         return users;
     }
     /**
@@ -79,8 +82,6 @@ class User {
      * @param response - The raw response data.
      *
      * @returns The target deserialized user.
-     *
-     * @internal
      */
     static single(response) {
         const users = [];
@@ -103,6 +104,55 @@ class User {
         }
         return users.length ? users[0] : undefined;
     }
+    /**
+     * Extracts and deserializes the timeline of users from the given raw response data.
+     *
+     * @param response - The raw response data.
+     *
+     * @returns The deserialized timeline of users.
+     */
+    static timeline(response) {
+        const users = [];
+        // Extracting the matching data
+        const extract = (0, JsonUtils_1.findByFilter)(response, '__typename', 'TimelineUser');
+        // Deserializing valid data
+        for (const item of extract) {
+            if (item.user_results?.result?.legacy) {
+                // Logging
+                LogService_1.LogService.log(Logging_1.ELogActions.DESERIALIZE, { id: item.user_results.result.rest_id });
+                users.push(new User(item.user_results.result));
+            }
+            else {
+                // Logging
+                LogService_1.LogService.log(Logging_1.ELogActions.WARNING, {
+                    action: Logging_1.ELogActions.DESERIALIZE,
+                    message: `User not found, skipping`,
+                });
+            }
+        }
+        return users;
+    }
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON() {
+        return {
+            createdAt: this.createdAt,
+            description: this.description,
+            followersCount: this.followersCount,
+            followingsCount: this.followingsCount,
+            fullName: this.fullName,
+            id: this.id,
+            isVerified: this.isVerified,
+            likeCount: this.likeCount,
+            location: this.location,
+            pinnedTweet: this.pinnedTweet,
+            profileBanner: this.profileBanner,
+            profileImage: this.profileImage,
+            statusesCount: this.statusesCount,
+            userName: this.userName,
+        };
+    }
 }
 exports.User = User;
 //# sourceMappingURL=User.js.map

package/dist/models/data/User.js.map

@@ -1 +1 @@
-{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../src/models/data/User.ts"],"names":[],"mappings":";;;AAEA,iDAAkD;AAClD,sDAAsD;AACtD,mEAAgE;AAGhE;;;;GAIG;AACH,MAAa,IAAI;IACT,SAAS,CAAS;IAClB,WAAW,CAAU;IACrB,cAAc,CAAS;IACvB,eAAe,CAAS;IACxB,QAAQ,CAAS;IACjB,EAAE,CAAS;IACX,UAAU,CAAU;IACpB,SAAS,CAAS;IAClB,QAAQ,CAAU;IAClB,WAAW,CAAU;IACrB,aAAa,CAAU;IACvB,YAAY,CAAS;IACrB,aAAa,CAAS;IACtB,QAAQ,CAAS;IAExB;;OAEG;IACH,YAAmB,IAAc;QAChC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QACxF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;QAClD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC;IACzD,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,IAAI,CAAC,QAA8B;QAChD,MAAM,KAAK,GAAW,EAAE,CAAC;QAEzB,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAA,wBAAY,EAAmB,QAAQ,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;QAEvF,2BAA2B;QAC3B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;gBACvC,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,qBAAW,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;gBAElF,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACP,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,qBAAW,CAAC,OAAO,EAAE;oBACnC,MAAM,EAAE,qBAAW,CAAC,WAAW;oBAC/B,OAAO,EAAE,0BAA0B;iBACnC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAA8B;QAClD,MAAM,KAAK,GAAW,EAAE,CAAC;QAEzB,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAA,wBAAY,EAAW,QAAQ,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QAEvE,2BAA2B;QAC3B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;gBAC3C,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,qBAAW,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBAE9D,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACP,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,qBAAW,CAAC,OAAO,EAAE;oBACnC,MAAM,EAAE,qBAAW,CAAC,WAAW;oBAC/B,OAAO,EAAE,0BAA0B;iBACnC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5C,CAAC;CACD;AAvGD,oBAuGC"}
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../src/models/data/User.ts"],"names":[],"mappings":";;;AAAA,iDAAkD;AAClD,sDAAsD;AACtD,mEAAgE;AAKhE;;;;GAIG;AACH,MAAa,IAAI;IACT,SAAS,CAAS;IAClB,WAAW,CAAU;IACrB,cAAc,CAAS;IACvB,eAAe,CAAS;IACxB,QAAQ,CAAS;IACjB,EAAE,CAAS;IACX,UAAU,CAAU;IACpB,SAAS,CAAS;IAClB,QAAQ,CAAU;IAClB,WAAW,CAAU;IACrB,aAAa,CAAU;IACvB,YAAY,CAAS;IACrB,aAAa,CAAS;IACtB,QAAQ,CAAS;IAExB;;OAEG;IACH,YAAmB,IAAc;QAChC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;QAChE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QACxF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;QAClD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC;IACzD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,QAAQ,CAAC,QAA8B,EAAE,GAAa;QACnE,IAAI,KAAK,GAAW,EAAE,CAAC;QAEvB,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAA,wBAAY,EAAW,QAAQ,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QAEvE,2BAA2B;QAC3B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;gBAC3C,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,qBAAW,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBAE9D,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACP,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,qBAAW,CAAC,OAAO,EAAE;oBACnC,MAAM,EAAE,qBAAW,CAAC,WAAW;oBAC/B,OAAO,EAAE,0BAA0B;iBACnC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,4CAA4C;QAC5C,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACvB,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACvD,CAAC;QAED,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAA8B;QAClD,MAAM,KAAK,GAAW,EAAE,CAAC;QAEzB,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAA,wBAAY,EAAW,QAAQ,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QAEvE,2BAA2B;QAC3B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;gBAC3C,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,qBAAW,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBAE9D,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACP,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,qBAAW,CAAC,OAAO,EAAE;oBACnC,MAAM,EAAE,qBAAW,CAAC,WAAW;oBAC/B,OAAO,EAAE,0BAA0B;iBACnC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,QAAQ,CAAC,QAA8B;QACpD,MAAM,KAAK,GAAW,EAAE,CAAC;QAEzB,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAA,wBAAY,EAAmB,QAAQ,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;QAEvF,2BAA2B;QAC3B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;gBACvC,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,qBAAW,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;gBAElF,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACP,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,qBAAW,CAAC,OAAO,EAAE;oBACnC,MAAM,EAAE,qBAAW,CAAC,WAAW;oBAC/B,OAAO,EAAE,0BAA0B;iBACnC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC;IACH,CAAC;CACD;AA/JD,oBA+JC"}

package/dist/models/errors/RettiwtError.d.ts

@@ -1,8 +1,9 @@
 /**
  * Represents an error that arises inside the package.
- *
- * @internal
  */
 export declare class RettiwtError extends Error {
+    /**
+     * @param message - The error message.
+     */
     constructor(message?: string);
 }

package/dist/models/errors/RettiwtError.js

@@ -3,10 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RettiwtError = void 0;
 /**
  * Represents an error that arises inside the package.
- *
- * @internal
  */
 class RettiwtError extends Error {
+    /**
+     * @param message - The error message.
+     */
     constructor(message) {
         super(message);
         Object.setPrototypeOf(this, RettiwtError.prototype);

package/dist/models/errors/RettiwtError.js.map

@@ -1 +1 @@
-{"version":3,"file":"RettiwtError.js","sourceRoot":"","sources":["../../../src/models/errors/RettiwtError.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,YAAa,SAAQ,KAAK;IACtC,YAAmB,OAAgB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;CACD;AAND,oCAMC"}
+{"version":3,"file":"RettiwtError.js","sourceRoot":"","sources":["../../../src/models/errors/RettiwtError.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,YAAa,SAAQ,KAAK;IACtC;;OAEG;IACH,YAAmB,OAAgB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;CACD;AATD,oCASC"}

package/dist/models/params/Variables.d.ts

@@ -0,0 +1,41 @@
+import { IMediaEntityVariable, IMediaVariable, IReplyVariable } from '../../types/params/Variables';
+import { NewTweetMedia } from '../args/PostArgs';
+/**
+ * Media to be sent as payload.
+ *
+ * @internal
+ */
+export declare class MediaVariable implements IMediaVariable {
+    media_entities: MediaEntityVariable[];
+    possibly_sensitive: boolean;
+    /**
+     * @param media - The list of NewTweetMedia objects specifying the media items to be sent in the Tweet.
+     */
+    constructor(media: NewTweetMedia[]);
+}
+/**
+ * Each media item in the media payload.
+ *
+ * @internal
+ */
+export declare class MediaEntityVariable implements IMediaEntityVariable {
+    media_id: string;
+    tagged_users: string[];
+    /**
+     * @param media - The NewTweetMedia object specifying the details of the media item to be included in the payload.
+     */
+    constructor(media: NewTweetMedia);
+}
+/**
+ * Reply specific details to be sent in payload.
+ *
+ * @internal
+ */
+export declare class ReplyVariable implements IReplyVariable {
+    exclude_reply_user_ids: string[];
+    in_reply_to_tweet_id: string;
+    /**
+     * @param replyTo - The id of the Tweet to which this Tweet is a reply.
+     */
+    constructor(replyTo: string);
+}

package/dist/models/params/Variables.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplyVariable = exports.MediaEntityVariable = exports.MediaVariable = void 0;
+/**
+ * Media to be sent as payload.
+ *
+ * @internal
+ */
+class MediaVariable {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    media_entities;
+    possibly_sensitive;
+    /* eslint-enable @typescript-eslint/naming-convention */
+    /**
+     * @param media - The list of NewTweetMedia objects specifying the media items to be sent in the Tweet.
+     */
+    constructor(media) {
+        this.media_entities = media.map((item) => new MediaEntityVariable(item));
+        this.possibly_sensitive = false;
+    }
+}
+exports.MediaVariable = MediaVariable;
+/**
+ * Each media item in the media payload.
+ *
+ * @internal
+ */
+class MediaEntityVariable {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    media_id;
+    tagged_users;
+    /* eslint-enable @typescript-eslint/naming-convention */
+    /**
+     * @param media - The NewTweetMedia object specifying the details of the media item to be included in the payload.
+     */
+    constructor(media) {
+        this.media_id = media.id;
+        this.tagged_users = media.tags ?? [];
+    }
+}
+exports.MediaEntityVariable = MediaEntityVariable;
+/**
+ * Reply specific details to be sent in payload.
+ *
+ * @internal
+ */
+class ReplyVariable {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    exclude_reply_user_ids;
+    in_reply_to_tweet_id;
+    /* eslint-enable @typescript-eslint/naming-convention */
+    /**
+     * @param replyTo - The id of the Tweet to which this Tweet is a reply.
+     */
+    constructor(replyTo) {
+        this.in_reply_to_tweet_id = replyTo;
+        this.exclude_reply_user_ids = [];
+    }
+}
+exports.ReplyVariable = ReplyVariable;
+//# sourceMappingURL=Variables.js.map

package/dist/models/params/Variables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Variables.js","sourceRoot":"","sources":["../../../src/models/params/Variables.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH,MAAa,aAAa;IACzB,yDAAyD;IAClD,cAAc,CAAwB;IACtC,kBAAkB,CAAU;IACnC,wDAAwD;IAExD;;OAEG;IACH,YAAmB,KAAsB;QACxC,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACjC,CAAC;CACD;AAbD,sCAaC;AAED;;;;GAIG;AACH,MAAa,mBAAmB;IAC/B,yDAAyD;IAClD,QAAQ,CAAS;IACjB,YAAY,CAAW;IAC9B,wDAAwD;IAExD;;OAEG;IACH,YAAmB,KAAoB;QACtC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,EAAE,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;IACtC,CAAC;CACD;AAbD,kDAaC;AAED;;;;GAIG;AACH,MAAa,aAAa;IACzB,yDAAyD;IAClD,sBAAsB,CAAW;IACjC,oBAAoB,CAAS;IACpC,wDAAwD;IAExD;;OAEG;IACH,YAAmB,OAAe;QACjC,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC;QACpC,IAAI,CAAC,sBAAsB,GAAG,EAAE,CAAC;IAClC,CAAC;CACD;AAbD,sCAaC"}

package/dist/requests/List.d.ts

@@ -0,0 +1,24 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * Collection of requests related to lists.
+ *
+ * @public
+ */
+export declare class ListRequests {
+    /**
+     * @param id - The id of the list whose details are to be fetched.
+     */
+    static details(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the list whose members are to be fetched.
+     * @param count - The number of members to fetch. Must be \<= 100.
+     * @param cursor - The cursor to the batch of members to fetch.
+     */
+    static members(id: string, count?: number, cursor?: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the list whose tweets are to be fetched.
+     * @param count - The number of tweets to fetch. Must be \<= 100.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     */
+    static tweets(id: string, count?: number, cursor?: string): AxiosRequestConfig;
+}

package/dist/requests/List.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListRequests = void 0;
+/**
+ * Collection of requests related to lists.
+ *
+ * @public
+ */
+class ListRequests {
+    /**
+     * @param id - The id of the list whose details are to be fetched.
+     */
+    static details(id) {
+        return {
+            method: 'get',
+            url: 'https://x.com/i/api/graphql/gO1_eYPohKYHwCG2m-1ZnQ/ListByRestId',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                variables: JSON.stringify({ listId: id }),
+                features: JSON.stringify({
+                    rweb_lists_timeline_redesign_enabled: true,
+                    responsive_web_graphql_exclude_directive_enabled: true,
+                    verified_phone_label_enabled: true,
+                    responsive_web_graphql_skip_user_profile_image_extensions_enabled: false,
+                    responsive_web_graphql_timeline_navigation_enabled: true,
+                }),
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+            paramsSerializer: { encode: encodeURIComponent },
+        };
+    }
+    /**
+     * @param id - The id of the list whose members are to be fetched.
+     * @param count - The number of members to fetch. Must be \<= 100.
+     * @param cursor - The cursor to the batch of members to fetch.
+     */
+    static members(id, count, cursor) {
+        return {
+            method: 'get',
+            url: 'https://x.com/i/api/graphql/dsJhIe3M0vCopjSfU6SlQw/ListMembers',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                variables: JSON.stringify({
+                    listId: id,
+                    count: count,
+                    cursor: cursor,
+                }),
+                features: JSON.stringify({
+                    rweb_tipjar_consumption_enabled: true,
+                    responsive_web_graphql_exclude_directive_enabled: true,
+                    verified_phone_label_enabled: true,
+                    creator_subscriptions_tweet_preview_api_enabled: true,
+                    responsive_web_graphql_timeline_navigation_enabled: true,
+                    responsive_web_graphql_skip_user_profile_image_extensions_enabled: false,
+                    communities_web_enable_tweet_community_results_fetch: true,
+                    c9s_tweet_anatomy_moderator_badge_enabled: true,
+                    articles_preview_enabled: true,
+                    responsive_web_edit_tweet_api_enabled: true,
+                    graphql_is_translatable_rweb_tweet_is_translatable_enabled: true,
+                    view_counts_everywhere_api_enabled: true,
+                    longform_notetweets_consumption_enabled: true,
+                    responsive_web_twitter_article_tweet_consumption_enabled: true,
+                    tweet_awards_web_tipping_enabled: false,
+                    creator_subscriptions_quote_tweet_preview_enabled: false,
+                    freedom_of_speech_not_reach_fetch_enabled: true,
+                    standardized_nudges_misinfo: true,
+                    tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled: true,
+                    rweb_video_timestamps_enabled: true,
+                    longform_notetweets_rich_text_read_enabled: true,
+                    longform_notetweets_inline_media_enabled: true,
+                    responsive_web_enhance_cards_enabled: false,
+                }),
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+        };
+    }
+    /**
+     * @param id - The id of the list whose tweets are to be fetched.
+     * @param count - The number of tweets to fetch. Must be \<= 100.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     */
+    static tweets(id, count, cursor) {
+        return {
+            method: 'get',
+            url: 'https://x.com/i/api/graphql/naCjgapXCSCsbZ7qnnItQA/ListLatestTweetsTimeline',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                variables: JSON.stringify({
+                    listId: id,
+                    count: count,
+                    cursor: cursor,
+                }),
+                features: JSON.stringify({
+                    rweb_lists_timeline_redesign_enabled: true,
+                    responsive_web_graphql_exclude_directive_enabled: true,
+                    verified_phone_label_enabled: true,
+                    creator_subscriptions_tweet_preview_api_enabled: true,
+                    responsive_web_graphql_timeline_navigation_enabled: true,
+                    responsive_web_graphql_skip_user_profile_image_extensions_enabled: false,
+                    tweetypie_unmention_optimization_enabled: true,
+                    responsive_web_edit_tweet_api_enabled: true,
+                    graphql_is_translatable_rweb_tweet_is_translatable_enabled: true,
+                    view_counts_everywhere_api_enabled: true,
+                    longform_notetweets_consumption_enabled: true,
+                    responsive_web_twitter_article_tweet_consumption_enabled: false,
+                    tweet_awards_web_tipping_enabled: false,
+                    freedom_of_speech_not_reach_fetch_enabled: true,
+                    standardized_nudges_misinfo: true,
+                    tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled: true,
+                    longform_notetweets_rich_text_read_enabled: true,
+                    longform_notetweets_inline_media_enabled: true,
+                    responsive_web_media_download_video_enabled: false,
+                    responsive_web_enhance_cards_enabled: false,
+                }),
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+            paramsSerializer: { encode: encodeURIComponent },
+        };
+    }
+}
+exports.ListRequests = ListRequests;
+//# sourceMappingURL=List.js.map

package/dist/requests/List.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../src/requests/List.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACH,MAAa,YAAY;IACxB;;OAEG;IACI,MAAM,CAAC,OAAO,CAAC,EAAU;QAC/B,OAAO;YACN,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,iEAAiE;YACtE,MAAM,EAAE;gBACP,yDAAyD;gBACzD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;gBACzC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;oBACxB,oCAAoC,EAAE,IAAI;oBAC1C,gDAAgD,EAAE,IAAI;oBACtD,4BAA4B,EAAE,IAAI;oBAClC,iEAAiE,EAAE,KAAK;oBACxE,kDAAkD,EAAE,IAAI;iBACxD,CAAC;gBACF,wDAAwD;aACxD;YACD,gBAAgB,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;SAChD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAChE,OAAO;YACN,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,gEAAgE;YACrE,MAAM,EAAE;gBACP,yDAAyD;gBACzD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC;oBACzB,MAAM,EAAE,EAAE;oBACV,KAAK,EAAE,KAAK;oBACZ,MAAM,EAAE,MAAM;iBACd,CAAC;gBACF,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;oBACxB,+BAA+B,EAAE,IAAI;oBACrC,gDAAgD,EAAE,IAAI;oBACtD,4BAA4B,EAAE,IAAI;oBAClC,+CAA+C,EAAE,IAAI;oBACrD,kDAAkD,EAAE,IAAI;oBACxD,iEAAiE,EAAE,KAAK;oBACxE,oDAAoD,EAAE,IAAI;oBAC1D,yCAAyC,EAAE,IAAI;oBAC/C,wBAAwB,EAAE,IAAI;oBAC9B,qCAAqC,EAAE,IAAI;oBAC3C,0DAA0D,EAAE,IAAI;oBAChE,kCAAkC,EAAE,IAAI;oBACxC,uCAAuC,EAAE,IAAI;oBAC7C,wDAAwD,EAAE,IAAI;oBAC9D,gCAAgC,EAAE,KAAK;oBACvC,iDAAiD,EAAE,KAAK;oBACxD,yCAAyC,EAAE,IAAI;oBAC/C,2BAA2B,EAAE,IAAI;oBACjC,uEAAuE,EAAE,IAAI;oBAC7E,6BAA6B,EAAE,IAAI;oBACnC,0CAA0C,EAAE,IAAI;oBAChD,wCAAwC,EAAE,IAAI;oBAC9C,oCAAoC,EAAE,KAAK;iBAC3C,CAAC;gBACF,wDAAwD;aACxD;SACD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC/D,OAAO;YACN,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,6EAA6E;YAClF,MAAM,EAAE;gBACP,yDAAyD;gBACzD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC;oBACzB,MAAM,EAAE,EAAE;oBACV,KAAK,EAAE,KAAK;oBACZ,MAAM,EAAE,MAAM;iBACd,CAAC;gBACF,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;oBACxB,oCAAoC,EAAE,IAAI;oBAC1C,gDAAgD,EAAE,IAAI;oBACtD,4BAA4B,EAAE,IAAI;oBAClC,+CAA+C,EAAE,IAAI;oBACrD,kDAAkD,EAAE,IAAI;oBACxD,iEAAiE,EAAE,KAAK;oBACxE,wCAAwC,EAAE,IAAI;oBAC9C,qCAAqC,EAAE,IAAI;oBAC3C,0DAA0D,EAAE,IAAI;oBAChE,kCAAkC,EAAE,IAAI;oBACxC,uCAAuC,EAAE,IAAI;oBAC7C,wDAAwD,EAAE,KAAK;oBAC/D,gCAAgC,EAAE,KAAK;oBACvC,yCAAyC,EAAE,IAAI;oBAC/C,2BAA2B,EAAE,IAAI;oBACjC,uEAAuE,EAAE,IAAI;oBAC7E,0CAA0C,EAAE,IAAI;oBAChD,wCAAwC,EAAE,IAAI;oBAC9C,2CAA2C,EAAE,KAAK;oBAClD,oCAAoC,EAAE,KAAK;iBAC3C,CAAC;gBACF,wDAAwD;aACxD;YACD,gBAAgB,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;SAChD,CAAC;IACH,CAAC;CACD;AAjHD,oCAiHC"}

package/dist/requests/Media.d.ts

@@ -0,0 +1,21 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * Collection of requests related to media.
+ *
+ * @public
+ */
+export declare class MediaRequests {
+    /**
+     * @param id - The allocated id of the media item to be uploaded.
+     * @param media - The media item to upload.
+     */
+    static appendUpload(id: string, media: string | ArrayBuffer): AxiosRequestConfig;
+    /**
+     * @param id - The allocated id of the media item.
+     */
+    static finalizeUpload(id: string): AxiosRequestConfig;
+    /**
+     * @param size - The size (in bytes) of the media item to be uploaded.
+     */
+    static initializeUpload(size: number): AxiosRequestConfig;
+}

package/dist/requests/Media.js

@@ -0,0 +1,70 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaRequests = void 0;
+const fs_1 = __importDefault(require("fs"));
+const form_data_1 = __importDefault(require("form-data"));
+/**
+ * Collection of requests related to media.
+ *
+ * @public
+ */
+class MediaRequests {
+    /**
+     * @param id - The allocated id of the media item to be uploaded.
+     * @param media - The media item to upload.
+     */
+    static appendUpload(id, media) {
+        const data = new form_data_1.default();
+        data.append('media', typeof media == 'string' ? fs_1.default.createReadStream(media) : Buffer.from(media));
+        return {
+            method: 'post',
+            headers: { referer: 'https://x.com' },
+            url: 'https://upload.x.com/i/media/upload.json',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                command: 'APPEND',
+                media_id: id,
+                segment_index: 0,
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+            data: data,
+        };
+    }
+    /**
+     * @param id - The allocated id of the media item.
+     */
+    static finalizeUpload(id) {
+        return {
+            method: 'post',
+            headers: { referer: 'https://x.com' },
+            url: 'https://upload.x.com/i/media/upload.json',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                command: 'FINALIZE',
+                media_id: id,
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+        };
+    }
+    /**
+     * @param size - The size (in bytes) of the media item to be uploaded.
+     */
+    static initializeUpload(size) {
+        return {
+            method: 'post',
+            headers: { referer: 'https://x.com' },
+            url: 'https://upload.x.com/i/media/upload.json',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                command: 'INIT',
+                total_bytes: size,
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+        };
+    }
+}
+exports.MediaRequests = MediaRequests;
+//# sourceMappingURL=Media.js.map

package/dist/requests/Media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Media.js","sourceRoot":"","sources":["../../src/requests/Media.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AAGpB,0DAAiC;AAEjC;;;;GAIG;AACH,MAAa,aAAa;IACzB;;;OAGG;IACI,MAAM,CAAC,YAAY,CAAC,EAAU,EAAE,KAA2B;QACjE,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,YAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACjG,OAAO;YACN,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;YACrC,GAAG,EAAE,0CAA0C;YAC/C,MAAM,EAAE;gBACP,yDAAyD;gBACzD,OAAO,EAAE,QAAQ;gBACjB,QAAQ,EAAE,EAAE;gBACZ,aAAa,EAAE,CAAC;gBAChB,wDAAwD;aACxD;YACD,IAAI,EAAE,IAAI;SACV,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,EAAU;QACtC,OAAO;YACN,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;YACrC,GAAG,EAAE,0CAA0C;YAC/C,MAAM,EAAE;gBACP,yDAAyD;gBACzD,OAAO,EAAE,UAAU;gBACnB,QAAQ,EAAE,EAAE;gBACZ,wDAAwD;aACxD;SACD,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAY;QAC1C,OAAO;YACN,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;YACrC,GAAG,EAAE,0CAA0C;YAC/C,MAAM,EAAE;gBACP,yDAAyD;gBACzD,OAAO,EAAE,MAAM;gBACf,WAAW,EAAE,IAAI;gBACjB,wDAAwD;aACxD;SACD,CAAC;IACH,CAAC;CACD;AAxDD,sCAwDC"}

package/dist/requests/Tweet.d.ts

@@ -0,0 +1,75 @@
+import { AxiosRequestConfig } from 'axios';
+import { ITweetFilter } from '../types/args/FetchArgs';
+import { INewTweet } from '../types/args/PostArgs';
+/**
+ * Collection of requests related to tweets.
+ *
+ * @public
+ */
+export declare class TweetRequests {
+    /**
+     * @param ids - The IDs of the tweets whose details are to be fetched.
+     */
+    static bulkDetails(ids: string[]): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet whose details are to be fetched.
+     */
+    static details(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet to be liked.
+     */
+    static like(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet whose likers are to be fetched.
+     * @param count - The number of likers to fetch. Only works as a lower limit when used with a cursor.
+     * @param cursor - The cursor to the batch of likers to fetch.
+     */
+    static likers(id: string, count?: number, cursor?: string): AxiosRequestConfig;
+    /**
+     * @param args - The configuration object for the tweet to be posted.
+     */
+    static post(args: INewTweet): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet whose replies are to be fetched.
+     * @param cursor - The cursor to the batch of replies to fetch.
+     */
+    static replies(id: string, cursor?: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet which is to be retweeted.
+     */
+    static retweet(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet whose retweeters are to be fetched.
+     * @param count - The number of retweeters to fetch. Only works as a lower limit when used with a cursor.
+     * @param cursor - The cursor to the batch of retweeters to fetch.
+     */
+    static retweeters(id: string, count?: number, cursor?: string): AxiosRequestConfig;
+    /**
+     * @param args - The configuration object for the tweet to be posted.
+     *
+     * @remarks - Only `text` and `media.id` parameters are supported.
+     */
+    static schedule(args: INewTweet): AxiosRequestConfig;
+    /**
+     * @param filter - The filter to use for searching tweets.
+     * @param count - The number of tweets to fetch. Only works as a lower limit when used with a cursor.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     */
+    static search(filter: ITweetFilter, count?: number, cursor?: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet to be unliked.
+     */
+    static unlike(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet to be unposted.
+     */
+    static unpost(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the source tweet (which was retweeted), to be unretweeted.
+     */
+    static unretweet(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the scheduled tweet to be unscheduled.
+     */
+    static unschedule(id: string): AxiosRequestConfig;
+}