@youmind-openlab/rettiwt-api 1.0.0

package/dist/models/data/User.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.User = void 0;
+const Logging_1 = require("../../enums/Logging");
+const JsonUtils_1 = require("../../helper/JsonUtils");
+const LogService_1 = require("../../services/internal/LogService");
+/**
+ * The details of a single user.
+ *
+ * @public
+ */
+class User {
+    /** The raw user details. */
+    _raw;
+    createdAt;
+    description;
+    followersCount;
+    followingsCount;
+    fullName;
+    id;
+    isFollowed;
+    isFollowing;
+    isVerified;
+    likeCount;
+    location;
+    pinnedTweet;
+    profileBanner;
+    profileImage;
+    statusesCount;
+    userName;
+    /**
+     * @param user - The raw user details.
+     */
+    constructor(user) {
+        this._raw = { ...user };
+        this.id = user.rest_id;
+        this.userName = user.core?.screen_name ?? user.legacy.screen_name ?? '';
+        this.fullName = user.core?.name ?? user.legacy.name ?? '';
+        this.createdAt = new Date(user.core?.created_at ?? user.legacy.created_at ?? 0).toISOString();
+        this.description = user.legacy.description.length ? user.legacy.description : undefined;
+        this.isFollowed = user.legacy.following;
+        this.isFollowing = user.legacy.followed_by;
+        this.isVerified = user.is_blue_verified;
+        this.likeCount = user.legacy.favourites_count;
+        this.followersCount = user.legacy.followers_count;
+        this.followingsCount = user.legacy.friends_count;
+        this.statusesCount = user.legacy.statuses_count;
+        this.location = user.location?.location ?? user.legacy.location ?? undefined;
+        this.pinnedTweet = user.legacy.pinned_tweet_ids_str[0];
+        this.profileBanner = user.legacy.profile_banner_url;
+        this.profileImage = user.avatar?.image_url ?? user.legacy.profile_image_url_https ?? '';
+    }
+    /** The raw user details. */
+    get raw() {
+        return { ...this._raw };
+    }
+    /**
+     * 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 target deserialized users.
+     */
+    static multiple(response, ids) {
+        let users = [];
+        // Extracting the matching data
+        const extract = (0, JsonUtils_1.findByFilter)(response, '__typename', 'User');
+        // Deserializing valid data
+        for (const item of extract) {
+            if (item.legacy && (item.core?.created_at || item.legacy.created_at)) {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.DESERIALIZE, { id: item.rest_id });
+                users.push(new User(item));
+            }
+            else {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.WARNING, {
+                    action: Logging_1.LogActions.DESERIALIZE,
+                    message: `User not found, skipping`,
+                });
+            }
+        }
+        // Filtering only required user, if required
+        if (ids && ids.length) {
+            users = users.filter((user) => ids.includes(user.id));
+        }
+        return users;
+    }
+    /**
+     * Extracts and deserializes a single target user from the given raw response data.
+     *
+     * @param response - The raw response data.
+     *
+     * @returns The target deserialized user.
+     */
+    static single(response) {
+        const users = [];
+        // Extracting the matching data
+        const extract = (0, JsonUtils_1.findByFilter)(response, '__typename', 'User');
+        // Deserializing valid data
+        for (const item of extract) {
+            if (item.legacy && (item.core?.created_at || item.legacy.created_at)) {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.DESERIALIZE, { id: item.rest_id });
+                users.push(new User(item));
+            }
+            else {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.WARNING, {
+                    action: Logging_1.LogActions.DESERIALIZE,
+                    message: `User not found, skipping`,
+                });
+            }
+        }
+        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.LogActions.DESERIALIZE, { id: item.user_results.result.rest_id });
+                users.push(new User(item.user_results.result));
+            }
+            else {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.WARNING, {
+                    action: Logging_1.LogActions.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,
+            isFollowed: this.isFollowed,
+            isFollowing: this.isFollowing,
+            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

@@ -0,0 +1 @@
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../src/models/data/User.ts"],"names":[],"mappings":";;;AAAA,iDAAiD;AACjD,sDAAsD;AACtD,mEAAgE;AAKhE;;;;GAIG;AACH,MAAa,IAAI;IAChB,4BAA4B;IACX,IAAI,CAAW;IAEzB,SAAS,CAAS;IAClB,WAAW,CAAU;IACrB,cAAc,CAAS;IACvB,eAAe,CAAS;IACxB,QAAQ,CAAS;IACjB,EAAE,CAAS;IACX,UAAU,CAAW;IACrB,WAAW,CAAW;IACtB,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,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;QACxB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC;QACxE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QAC1D,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9F,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,MAAM,CAAC,SAAS,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,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,QAAQ,EAAE,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,SAAS,CAAC;QAC7E,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,EAAE,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,uBAAuB,IAAI,EAAE,CAAC;IACzF,CAAC;IAED,4BAA4B;IAC5B,IAAW,GAAG;QACb,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IACzB,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,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBACtE,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBAE7D,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACP,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,OAAO,EAAE;oBAClC,MAAM,EAAE,oBAAU,CAAC,WAAW;oBAC9B,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,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBACtE,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBAE7D,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACP,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,OAAO,EAAE;oBAClC,MAAM,EAAE,oBAAU,CAAC,WAAW;oBAC9B,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,oBAAU,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;gBAEjF,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,oBAAU,CAAC,OAAO,EAAE;oBAClC,MAAM,EAAE,oBAAU,CAAC,WAAW;oBAC9B,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,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,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;AA9KD,oBA8KC"}

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

@@ -0,0 +1,37 @@
+import { AxiosError } from 'axios';
+import { ITwitterError, ITwitterErrorDetails } from '../../types/errors/TwitterError';
+import { IErrorData as IRawErrorData, IErrorDetails as IRawErrorDetails } from '../../types/raw/base/Error';
+/**
+ * The error thrown by Twitter API.
+ *
+ * @public
+ */
+export declare class TwitterError extends Error implements ITwitterError {
+    details: ITwitterErrorDetails[];
+    message: string;
+    name: string;
+    status: number;
+    /**
+     * @param error - The error response received from Twitter.
+     */
+    constructor(error: AxiosError<IRawErrorData | IRawErrorDetails>);
+}
+/**
+ * The error details.
+ *
+ * @public
+ */
+export declare class TwitterErrorDetails implements ITwitterErrorDetails {
+    code: number;
+    message: string;
+    name?: string;
+    type?: string;
+    /**
+     * @param details - The details of the error.
+     */
+    constructor(details: IRawErrorDetails);
+    /**
+     * @returns The JSON representation of `this` object.
+     */
+    toJSON(): ITwitterErrorDetails;
+}

package/dist/models/errors/TwitterError.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TwitterErrorDetails = exports.TwitterError = void 0;
+/**
+ * The error thrown by Twitter API.
+ *
+ * @public
+ */
+class TwitterError extends Error {
+    details;
+    message;
+    name;
+    status;
+    /**
+     * @param error - The error response received from Twitter.
+     */
+    constructor(error) {
+        super(error.message);
+        this.details = ((error.response?.data).errors
+            ? (error.response?.data).errors.map((item) => new TwitterErrorDetails(item))
+            : [new TwitterErrorDetails(error.response?.data)]).map((item) => item.toJSON());
+        this.message = error.message;
+        this.name = 'TWITTER_ERROR';
+        this.status = error.status ?? 500;
+    }
+}
+exports.TwitterError = TwitterError;
+/**
+ * The error details.
+ *
+ * @public
+ */
+class TwitterErrorDetails {
+    code;
+    message;
+    name;
+    type;
+    /**
+     * @param details - The details of the error.
+     */
+    constructor(details) {
+        this.code = details.code;
+        this.message = details.message;
+        this.name = details.name;
+        this.type = details.kind;
+    }
+    /**
+     * @returns The JSON representation of `this` object.
+     */
+    toJSON() {
+        return {
+            code: this.code,
+            message: this.message,
+            name: this.message,
+            type: this.type,
+        };
+    }
+}
+exports.TwitterErrorDetails = TwitterErrorDetails;
+//# sourceMappingURL=TwitterError.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TwitterError.js","sourceRoot":"","sources":["../../../src/models/errors/TwitterError.ts"],"names":[],"mappings":";;;AAKA;;;;GAIG;AACH,MAAa,YAAa,SAAQ,KAAK;IAC/B,OAAO,CAAyB;IAChC,OAAO,CAAS;IAChB,IAAI,CAAS;IACb,MAAM,CAAS;IAEtB;;OAEG;IACH,YAAmB,KAAmD;QACrE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,CACd,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAsB,CAAA,CAAC,MAAM;YAC7C,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAsB,CAAA,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC,IAAI,mBAAmB,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAwB,CAAC,CAAC,CACtE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC;IACnC,CAAC;CACD;AApBD,oCAoBC;AAED;;;;GAIG;AACH,MAAa,mBAAmB;IACxB,IAAI,CAAS;IACb,OAAO,CAAS;IAChB,IAAI,CAAU;IACd,IAAI,CAAU;IAErB;;OAEG;IACH,YAAmB,OAAyB;QAC3C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,OAAO;YAClB,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;CACD;AA3BD,kDA2BC"}

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/DirectMessage.d.ts

@@ -0,0 +1,28 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * Collection of requests related to direct messages.
+ *
+ * @public
+ */
+export declare class DMRequests {
+    /**
+     * Get a specific DM conversation
+     * @param conversationId - The conversation ID (e.g., "394028042-1712730991884689408")
+     * @param maxId - Maximum ID for pagination (optional)
+     */
+    static conversation(conversationId: string, maxId?: string): AxiosRequestConfig;
+    /**
+     * Delete a DM conversation
+     * @param conversationId - The ID of the conversation to delete
+     */
+    static deleteConversation(conversationId: string): AxiosRequestConfig;
+    /**
+     * Get the initial state of the DM inbox
+     */
+    static inboxInitial(): AxiosRequestConfig;
+    /**
+     * Get inbox timeline (pagination of conversations)
+     * @param maxId - Maximum ID for pagination
+     */
+    static inboxTimeline(maxId?: string): AxiosRequestConfig;
+}

package/dist/requests/DirectMessage.js

@@ -0,0 +1,149 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DMRequests = void 0;
+const querystring_1 = __importDefault(require("querystring"));
+/**
+ * Common parameter sets for DM requests
+ */
+const BaseDMParams = {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    nsfw_filtering_enabled: false,
+    filter_low_quality: true,
+    include_quality: 'all',
+    dm_secret_conversations_enabled: false,
+    krs_registration_enabled: false,
+    cards_platform: 'Web-12',
+    include_cards: 1,
+    include_ext_alt_text: true,
+    include_ext_limited_action_results: true,
+    include_quote_count: true,
+    include_reply_count: 1,
+    tweet_mode: 'extended',
+    include_ext_views: true,
+    include_groups: true,
+    include_inbox_timelines: true,
+    include_ext_media_color: true,
+    supports_reactions: true,
+    supports_edit: true,
+    include_ext_edit_control: true,
+    include_ext_business_affiliations_label: true,
+    ext: 'mediaColor%2CaltText%2CbusinessAffiliationsLabel%2CmediaStats%2ChighlightedLabel%2CparodyCommentaryFanLabel%2CvoiceInfo%2CbirdwatchPivot%2CsuperFollowMetadata%2CunmentionInfo%2CeditControl%2Carticle',
+    /* eslint-enable @typescript-eslint/naming-convention */
+};
+const DMUserIncludeParams = {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    include_profile_interstitial_type: 1,
+    include_blocking: 1,
+    include_blocked_by: 1,
+    include_followed_by: 1,
+    include_want_retweets: 1,
+    include_mute_edge: 1,
+    include_can_dm: 1,
+    include_can_media_tag: 1,
+    include_ext_is_blue_verified: 1,
+    include_ext_verified_type: 1,
+    include_ext_profile_image_shape: 1,
+    skip_status: 1,
+    /* eslint-enable @typescript-eslint/naming-convention */
+};
+/**
+ * Collection of requests related to direct messages.
+ *
+ * @public
+ */
+class DMRequests {
+    /**
+     * Get a specific DM conversation
+     * @param conversationId - The conversation ID (e.g., "394028042-1712730991884689408")
+     * @param maxId - Maximum ID for pagination (optional)
+     */
+    static conversation(conversationId, maxId) {
+        const context = maxId ? 'FETCH_DM_CONVERSATION_HISTORY' : 'FETCH_DM_CONVERSATION';
+        return {
+            method: 'get',
+            url: `https://x.com/i/api/1.1/dm/conversation/${conversationId}.json`,
+            params: {
+                ...BaseDMParams,
+                ...DMUserIncludeParams,
+                /* eslint-disable @typescript-eslint/naming-convention */
+                max_id: maxId,
+                context: context,
+                dm_users: false,
+                include_conversation_info: true,
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+            paramsSerializer: { encode: encodeURIComponent },
+        };
+    }
+    /**
+     * Delete a DM conversation
+     * @param conversationId - The ID of the conversation to delete
+     */
+    static deleteConversation(conversationId) {
+        return {
+            method: 'post',
+            url: `https://x.com/i/api/1.1/dm/${conversationId}/delete.json`,
+            data: querystring_1.default.stringify({
+                /* eslint-disable @typescript-eslint/naming-convention */
+                dm_secret_conversations_enabled: false,
+                krs_registration_enabled: false,
+                cards_platform: 'Web-12',
+                include_cards: 1,
+                include_ext_alt_text: true,
+                include_ext_limited_action_results: true,
+                include_quote_count: true,
+                include_reply_count: 1,
+                tweet_mode: 'extended',
+                include_ext_views: true,
+                dm_users: false,
+                include_groups: true,
+                include_inbox_timelines: true,
+                include_ext_media_color: true,
+                supports_reactions: true,
+                supports_edit: true,
+                include_conversation_info: true,
+            }),
+        };
+    }
+    /**
+     * Get the initial state of the DM inbox
+     */
+    static inboxInitial() {
+        return {
+            method: 'get',
+            url: 'https://x.com/i/api/1.1/dm/inbox_initial_state.json',
+            params: {
+                ...BaseDMParams,
+                ...DMUserIncludeParams,
+                /* eslint-disable @typescript-eslint/naming-convention */
+                dm_users: true,
+                include_ext_parody_commentary_fan_label: true,
+                ext: 'mediaColor%2CaltText%2CmediaStats%2ChighlightedLabel%2CparodyCommentaryFanLabel%2CvoiceInfo%2CbirdwatchPivot%2CsuperFollowMetadata%2CunmentionInfo%2CeditControl%2Carticle',
+            },
+            paramsSerializer: { encode: encodeURIComponent },
+        };
+    }
+    /**
+     * Get inbox timeline (pagination of conversations)
+     * @param maxId - Maximum ID for pagination
+     */
+    static inboxTimeline(maxId) {
+        return {
+            method: 'get',
+            url: 'https://x.com/i/api/1.1/dm/inbox_timeline/trusted.json',
+            params: {
+                ...BaseDMParams,
+                ...DMUserIncludeParams,
+                /* eslint-disable @typescript-eslint/naming-convention */
+                max_id: maxId,
+                dm_users: false,
+            },
+            paramsSerializer: { encode: encodeURIComponent },
+        };
+    }
+}
+exports.DMRequests = DMRequests;
+//# sourceMappingURL=DirectMessage.js.map

package/dist/requests/DirectMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DirectMessage.js","sourceRoot":"","sources":["../../src/requests/DirectMessage.ts"],"names":[],"mappings":";;;;;;AAAA,8DAA6B;AAI7B;;GAEG;AACH,MAAM,YAAY,GAAG;IACpB,yDAAyD;IAEzD,sBAAsB,EAAE,KAAK;IAC7B,kBAAkB,EAAE,IAAI;IACxB,eAAe,EAAE,KAAK;IACtB,+BAA+B,EAAE,KAAK;IACtC,wBAAwB,EAAE,KAAK;IAC/B,cAAc,EAAE,QAAQ;IACxB,aAAa,EAAE,CAAC;IAChB,oBAAoB,EAAE,IAAI;IAC1B,kCAAkC,EAAE,IAAI;IACxC,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,CAAC;IACtB,UAAU,EAAE,UAAU;IACtB,iBAAiB,EAAE,IAAI;IACvB,cAAc,EAAE,IAAI;IACpB,uBAAuB,EAAE,IAAI;IAC7B,uBAAuB,EAAE,IAAI;IAC7B,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,IAAI;IACnB,wBAAwB,EAAE,IAAI;IAC9B,uCAAuC,EAAE,IAAI;IAC7C,GAAG,EAAE,wMAAwM;IAE7M,wDAAwD;CACxD,CAAC;AAEF,MAAM,mBAAmB,GAAG;IAC3B,yDAAyD;IAEzD,iCAAiC,EAAE,CAAC;IACpC,gBAAgB,EAAE,CAAC;IACnB,kBAAkB,EAAE,CAAC;IACrB,mBAAmB,EAAE,CAAC;IACtB,qBAAqB,EAAE,CAAC;IACxB,iBAAiB,EAAE,CAAC;IACpB,cAAc,EAAE,CAAC;IACjB,qBAAqB,EAAE,CAAC;IACxB,4BAA4B,EAAE,CAAC;IAC/B,yBAAyB,EAAE,CAAC;IAC5B,+BAA+B,EAAE,CAAC;IAClC,WAAW,EAAE,CAAC;IAEd,wDAAwD;CACxD,CAAC;AAEF;;;;GAIG;AACH,MAAa,UAAU;IACtB;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,cAAsB,EAAE,KAAc;QAChE,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,+BAA+B,CAAC,CAAC,CAAC,uBAAuB,CAAC;QAElF,OAAO;YACN,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,2CAA2C,cAAc,OAAO;YACrE,MAAM,EAAE;gBACP,GAAG,YAAY;gBACf,GAAG,mBAAmB;gBACtB,yDAAyD;gBACzD,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE,OAAO;gBAChB,QAAQ,EAAE,KAAK;gBACf,yBAAyB,EAAE,IAAI;gBAC/B,wDAAwD;aACxD;YACD,gBAAgB,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;SAChD,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,cAAsB;QACtD,OAAO;YACN,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,8BAA8B,cAAc,cAAc;YAC/D,IAAI,EAAE,qBAAE,CAAC,SAAS,CAAC;gBAClB,yDAAyD;gBACzD,+BAA+B,EAAE,KAAK;gBACtC,wBAAwB,EAAE,KAAK;gBAC/B,cAAc,EAAE,QAAQ;gBACxB,aAAa,EAAE,CAAC;gBAChB,oBAAoB,EAAE,IAAI;gBAC1B,kCAAkC,EAAE,IAAI;gBACxC,mBAAmB,EAAE,IAAI;gBACzB,mBAAmB,EAAE,CAAC;gBACtB,UAAU,EAAE,UAAU;gBACtB,iBAAiB,EAAE,IAAI;gBACvB,QAAQ,EAAE,KAAK;gBACf,cAAc,EAAE,IAAI;gBACpB,uBAAuB,EAAE,IAAI;gBAC7B,uBAAuB,EAAE,IAAI;gBAC7B,kBAAkB,EAAE,IAAI;gBACxB,aAAa,EAAE,IAAI;gBACnB,yBAAyB,EAAE,IAAI;aAC/B,CAAC;SACF,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY;QACzB,OAAO;YACN,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,qDAAqD;YAC1D,MAAM,EAAE;gBACP,GAAG,YAAY;gBACf,GAAG,mBAAmB;gBACtB,yDAAyD;gBACzD,QAAQ,EAAE,IAAI;gBACd,uCAAuC,EAAE,IAAI;gBAC7C,GAAG,EAAE,4KAA4K;aACjL;YACD,gBAAgB,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;SAChD,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,aAAa,CAAC,KAAc;QACzC,OAAO;YACN,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,wDAAwD;YAC7D,MAAM,EAAE;gBACP,GAAG,YAAY;gBACf,GAAG,mBAAmB;gBACtB,yDAAyD;gBACzD,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,KAAK;aACf;YACD,gBAAgB,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;SAChD,CAAC;IACH,CAAC;CAgFD;AA7KD,gCA6KC"}

package/dist/requests/List.d.ts

@@ -0,0 +1,34 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * Collection of requests related to lists.
+ *
+ * @public
+ */
+export declare class ListRequests {
+    /**
+     * @param listId - The ID of the target list.
+     * @param userId - The ID of the user to be added as a member.
+     */
+    static addMember(listId: string, userId: string): AxiosRequestConfig;
+    /**
+     * @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 listId - The ID of the target list.
+     * @param userId - The ID of the user to remove as a member.
+     */
+    static removeMember(listId: string, userId: 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;
+}