rettiwt-api 6.0.8 → 6.1.1

package/dist/types/data/Analytics.d.ts

@@ -0,0 +1,42 @@
+import type { IAnalyticsMetric } from '../../types/raw/base/Analytic';
+/**
+ * The details of the analytic result of the connected User.
+ *
+ * @public
+ */
+export interface IAnalytics {
+    /** The creation date of user's account. */
+    createdAt: string;
+    /** Total followers number */
+    followers: number;
+    /** Total verified followers */
+    verifiedFollowers: number;
+    /** Total impressions on the given period */
+    impressions: number;
+    /** Total profile visits on the given period */
+    profileVisits: number;
+    /** Total Engagements on the given period */
+    engagements: number;
+    /** Total Follows on the given period */
+    follows: number;
+    /** Total Replies on the given period */
+    replies: number;
+    /** Total Likes on the given period */
+    likes: number;
+    /** Total Retweets on the given period */
+    retweets: number;
+    /** Total Bookmark on the given period */
+    bookmarks: number;
+    /** Total Shares on the given period */
+    shares: number;
+    /** Total CreateTweets on the given period */
+    createTweets: number;
+    /** Total CreateQuote on the given period */
+    createQuote: number;
+    /** Total Unfollows on the given period */
+    unfollows: number;
+    /** Total CreateReply on the given period */
+    createReply: number;
+    /** Organic metrics times series  */
+    organicMetricsTimeSeries: IAnalyticsMetric[];
+}

package/dist/types/data/Analytics.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Analytics.js.map

package/dist/types/data/Analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Analytics.js","sourceRoot":"","sources":["../../../src/types/data/Analytics.ts"],"names":[],"mappings":""}

package/dist/types/data/Conversation.d.ts

@@ -0,0 +1,32 @@
+import { IDirectMessage } from './DirectMessage';
+/**
+ * The details of a single conversation.
+ *
+ * @public
+ */
+export interface IConversation {
+    /** The unique identifier of the conversation. */
+    id: string;
+    /** The type of conversation (ONE_TO_ONE or GROUP_DM). */
+    type: 'ONE_TO_ONE' | 'GROUP_DM';
+    /** Array of participant user IDs. */
+    participants: string[];
+    /** The name of the conversation (for group DMs). */
+    name?: string;
+    /** URL to the conversation avatar (for group DMs). */
+    avatarUrl?: string;
+    /** Whether the conversation is trusted. */
+    trusted: boolean;
+    /** Whether the conversation is muted. */
+    muted: boolean;
+    /** Whether notifications are disabled. */
+    notificationsDisabled: boolean;
+    /** The timestamp of the last activity (ISO 8601 format). */
+    lastActivityAt: string;
+    /** The ID of the last message. */
+    lastMessageId?: string;
+    /** Whether there are more messages to load. */
+    hasMore: boolean;
+    /** Array of messages in this conversation. */
+    messages: IDirectMessage[];
+}

package/dist/types/data/Conversation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Conversation.js.map

package/dist/types/data/Conversation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Conversation.js","sourceRoot":"","sources":["../../../src/types/data/Conversation.ts"],"names":[],"mappings":""}

package/dist/types/data/CursoredData.d.ts

@@ -1,3 +1,6 @@
+import { IConversation } from './Conversation';
+import { IDirectMessage } from './DirectMessage';
+import { IList } from './List';
 import { INotification } from './Notification';
 import { ITweet } from './Tweet';
 import { IUser } from './User';
@@ -8,7 +11,7 @@ import { IUser } from './User';
  *
  * @public
  */
-export interface ICursoredData<T extends INotification | ITweet | IUser> {
+export interface ICursoredData<T extends IDirectMessage | IConversation | INotification | ITweet | IUser | IList> {
     /** The batch of data of the given type. */
     list: T[];
     /** The cursor to the next batch of data. */

package/dist/types/data/DirectMessage.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The details of a single direct message.
+ *
+ * @public
+ */
+export interface IDirectMessage {
+    /** The unique identifier of the message. */
+    id: string;
+    /** The ID of the conversation this message belongs to. */
+    conversationId: string;
+    /** The ID of the user who sent the message. */
+    senderId: string;
+    /** The ID of the user who received the message (for one-to-one conversations). */
+    recipientId?: string;
+    /** The text content of the message. */
+    text: string;
+    /** The timestamp when the message was sent (ISO 8601 format). */
+    createdAt: string;
+    /** Array of media URLs attached to the message. */
+    mediaUrls?: string[];
+    /** Number of times the message has been edited. */
+    editCount?: number;
+    /** Whether the message has been read. */
+    read?: boolean;
+}

package/dist/types/data/DirectMessage.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DirectMessage.js.map

package/dist/types/data/DirectMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DirectMessage.js","sourceRoot":"","sources":["../../../src/types/data/DirectMessage.ts"],"names":[],"mappings":""}

package/dist/types/data/Inbox.d.ts

@@ -0,0 +1,18 @@
+import { IConversation } from './Conversation';
+/**
+ * The details of a DM inbox containing conversations and metadata.
+ *
+ * @public
+ */
+export interface IInbox {
+    /** List of conversations in the inbox. */
+    conversations: IConversation[];
+    /** The cursor for pagination of conversations. */
+    cursor: string;
+    /** The ID of the last seen event. */
+    lastSeenEventId: string;
+    /** The ID of the last seen trusted event. */
+    trustedLastSeenEventId: string;
+    /** The ID of the last seen untrusted event. */
+    untrustedLastSeenEventId: string;
+}

package/dist/types/data/Inbox.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Inbox.js.map

package/dist/types/data/Inbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Inbox.js","sourceRoot":"","sources":["../../../src/types/data/Inbox.ts"],"names":[],"mappings":""}

package/dist/types/data/List.d.ts

@@ -6,12 +6,16 @@
 export interface IList {
     /** The date and time of creation of the list, int UTC string format. */
     createdAt: string;
-    /** The rest id of the user who created the list. */
+    /** The ID of the user who created the list. */
     createdBy: string;
     /** The list description. */
     description?: string;
+    /** Whether the user is following the list or not. */
+    isFollowing: boolean;
     /** The rest id of the list. */
     id: string;
+    /** Whether the user is a member of the list or not. */
+    isMember: boolean;
     /** The number of memeber of the list. */
     memberCount: number;
     /** The name of the list. */

package/dist/types/data/Tweet.d.ts

@@ -7,7 +7,7 @@ import { IUser } from './User';
  */
 export interface ITweet {
     /** The number of bookmarks of a tweet. */
-    bookmarkCount: number;
+    bookmarkCount?: number;
     /** The ID of tweet which started the current conversation. */
     conversationId: string;
     /** The creation date of the tweet. */
@@ -21,19 +21,19 @@ export interface ITweet {
     /** The language in which the tweet is written. */
     lang: string;
     /** The number of likes of the tweet. */
-    likeCount: number;
+    likeCount?: number;
     /** The urls of the media contents of the tweet (if any). */
     media?: ITweetMedia[];
     /** The number of quotes of the tweet. */
-    quoteCount: number;
+    quoteCount?: number;
     /** The tweet which is quoted in the tweet. */
     quoted?: ITweet;
     /** The number of replies to the tweet. */
-    replyCount: number;
+    replyCount?: number;
     /** The rest id of the tweet to which the tweet is a reply. */
     replyTo?: string;
     /** The number of retweets of the tweet. */
-    retweetCount: number;
+    retweetCount?: number;
     /** The tweet which is retweeted in this tweet (if any). */
     retweetedTweet?: ITweet;
     /** The details of the user who made the tweet. */
@@ -41,7 +41,7 @@ export interface ITweet {
     /** The URL to the tweet. */
     url: string;
     /** The number of views of a tweet. */
-    viewCount: number;
+    viewCount?: number;
 }
 /**
  * The different types parsed entities like urls, media, mentions, hashtags, etc.

package/dist/types/data/User.d.ts

@@ -16,6 +16,10 @@ export interface IUser {
     fullName: string;
     /** The rest id of the user. */
     id: string;
+    /** Whether the user is being followed by the logged-in user. Available only when logged in. */
+    isFollowed?: boolean;
+    /** Whether the user is following the logged-in user. Available only when logged in. */
+    isFollowing?: boolean;
     /** Whether the account is verified or not. */
     isVerified: boolean;
     /** The number of tweets liked by the user. */

package/dist/types/raw/base/Analytic.d.ts

@@ -6,10 +6,15 @@
 export interface IAnalytics {
     __typename: string;
     organic_metrics_time_series: IAnalyticsMetric[];
+    verified_follower_count: string;
+    relationship_counts: IAnalyticsRelationships;
     id: string;
 }
+export interface IAnalyticsRelationships {
+    followers: number;
+}
 export interface IAnalyticsMetric {
-    metric_value: IAnalyticsMetricValue[];
+    metric_values: IAnalyticsMetricValue[];
     timestamp: IAnalyticsTimeStamp;
 }
 export interface IAnalyticsMetricValue {

package/dist/types/raw/base/Message.d.ts

@@ -0,0 +1,16 @@
+import { ConversationMessage } from '../dm/Conversation';
+import { Message } from '../dm/InboxInitial';
+import { TimelineMessage } from '../dm/InboxTimeline';
+type ConversationMessageData = ConversationMessage['message_data'];
+type InboxMessageData = Message['message_data'];
+type TimelineMessageData = TimelineMessage['message_data'];
+type UnifiedMessageData = InboxMessageData & Partial<ConversationMessageData> & Partial<TimelineMessageData>;
+export interface IMessage {
+    id: string;
+    time: string;
+    affects_sort?: boolean;
+    request_id: string;
+    conversation_id: string;
+    message_data: UnifiedMessageData;
+}
+export {};

package/dist/types/raw/base/Message.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Message.js.map

package/dist/types/raw/base/Message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Message.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Message.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/Tweet.d.ts

@@ -14,7 +14,7 @@ export interface ITweet {
     edit_control: ITweetEditControl;
     edit_perspective: ITweetEditPerspective;
     is_translatable: boolean;
-    views: ITweetViews;
+    views?: ITweetViews;
     source: string;
     quoted_status_result: IDataResult<ITweet | ILimitedVisibilityTweet>;
     note_tweet: ITweetNote;
@@ -64,14 +64,14 @@ export interface ITweetNoteMedia {
     inline_media: any[];
 }
 export interface ITweetLegacy {
-    bookmark_count: number;
+    bookmark_count?: number;
     bookmarked: boolean;
     created_at: string;
     conversation_id_str: string;
     display_text_range: number[];
     entities: IEntities;
     extended_entities: IExtendedEntities;
-    favorite_count: number;
+    favorite_count?: number;
     favorited: boolean;
     full_text: string;
     in_reply_to_status_id_str: string;
@@ -79,10 +79,10 @@ export interface ITweetLegacy {
     lang: string;
     possibly_sensitive: boolean;
     possibly_sensitive_editable: boolean;
-    quote_count: number;
+    quote_count?: number;
     quoted_status_id_str: string;
-    reply_count: number;
-    retweet_count: number;
+    reply_count?: number;
+    retweet_count?: number;
     retweeted: boolean;
     user_id_str: string;
     id_str: string;

package/dist/types/raw/base/User.d.ts

@@ -68,7 +68,8 @@ export interface IAffiliateHighlightedMentionResultLegacy {
     screen_name: string;
 }
 export interface IUserLegacy {
-    following: boolean;
+    followed_by?: boolean;
+    following?: boolean;
     can_dm: boolean;
     can_media_tag: boolean;
     created_at: string;

package/dist/types/raw/composite/TimelineList.d.ts

@@ -0,0 +1,9 @@
+import { IList } from '../base/List';
+/**
+ * Represents the raw data of a single timeline tweet.
+ *
+ * @public
+ */
+export interface ITimelineList {
+    list: IList;
+}

package/dist/types/raw/composite/TimelineList.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TimelineList.js.map

package/dist/types/raw/composite/TimelineList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimelineList.js","sourceRoot":"","sources":["../../../../src/types/raw/composite/TimelineList.ts"],"names":[],"mappings":""}

package/dist/types/raw/dm/Conversation.d.ts

@@ -0,0 +1,55 @@
+import { Users, Conversations } from './InboxInitial';
+/**
+ * The raw data received when fetching a specific conversation timeline.
+ *
+ * @public
+ */
+export interface IConversationTimelineResponse {
+    conversation_timeline: ConversationTimeline;
+}
+interface ConversationTimeline {
+    status: 'HAS_MORE' | 'AT_END';
+    min_entry_id: string;
+    max_entry_id: string;
+    entries: ConversationEntry[];
+    users: Users;
+    conversations: Conversations;
+}
+type ConversationEntry = {
+    message: ConversationMessage;
+} | {
+    trust_conversation: TrustConversation;
+};
+export interface ConversationMessage {
+    id: string;
+    time: string;
+    request_id: string;
+    conversation_id: string;
+    message_data: ConversationMessageData;
+}
+interface ConversationMessageData {
+    id: string;
+    time: string;
+    recipient_id: string;
+    sender_id: string;
+    text: string;
+    edit_count?: number;
+    message_reactions?: MessageReaction[];
+}
+interface MessageReaction {
+    id: string;
+    time: string;
+    conversation_id: string;
+    message_id: string;
+    reaction_key: string;
+    emoji_reaction: string;
+    sender_id: string;
+}
+interface TrustConversation {
+    id: string;
+    time: string;
+    request_id: string;
+    conversation_id: string;
+    reason: string;
+}
+export {};

package/dist/types/raw/dm/Conversation.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Conversation.js.map

package/dist/types/raw/dm/Conversation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Conversation.js","sourceRoot":"","sources":["../../../../src/types/raw/dm/Conversation.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/dm/InboxInitial.d.ts

@@ -0,0 +1,137 @@
+/**
+ * The raw data received when fetching the initial state of the DM inbox.
+ *
+ * @public
+ */
+export interface IInboxInitialResponse {
+    inbox_initial_state: InboxInitialState;
+}
+export interface InboxInitialState {
+    last_seen_event_id: string;
+    trusted_last_seen_event_id: string;
+    untrusted_last_seen_event_id: string;
+    cursor: string;
+    inbox_timelines: InboxTimelines;
+    entries: Entry[];
+    users: Users;
+    conversations: Conversations;
+}
+interface InboxTimelines {
+    trusted: TimelineStatus;
+    untrusted: TimelineStatus;
+    untrusted_low_quality: TimelineStatus;
+}
+interface TimelineStatus {
+    status: string;
+    min_entry_id: string;
+}
+interface Entry {
+    message: Message;
+}
+export interface Message {
+    id: string;
+    time: string;
+    affects_sort: boolean;
+    request_id: string;
+    conversation_id: string;
+    message_data: MessageData;
+}
+interface MessageData {
+    id: string;
+    time: string;
+    recipient_id: string;
+    sender_id: string;
+    text: string;
+    edit_count: number;
+}
+export interface Users {
+    [userId: string]: User;
+}
+interface User {
+    id: number;
+    id_str: string;
+    name: string;
+    screen_name: string;
+    profile_image_url: string;
+    profile_image_url_https: string;
+    following: boolean;
+    follow_request_sent: boolean;
+    description: string;
+    entities: UserEntities;
+    verified: boolean;
+    is_blue_verified: boolean;
+    protected: boolean;
+    blocking: boolean;
+    subscribed_by: boolean;
+    can_media_tag: boolean;
+    dm_blocked_by: boolean;
+    dm_blocking: boolean;
+    created_at: string;
+    friends_count: number;
+    followers_count: number;
+}
+interface UserEntities {
+    url: UrlEntity;
+    description: DescriptionEntity;
+}
+interface UrlEntity {
+    urls: UrlInfo[];
+}
+interface DescriptionEntity {
+    urls: UrlInfo[];
+}
+interface UrlInfo {
+    url: string;
+    expanded_url: string;
+    display_url: string;
+    indices: [number, number];
+}
+export interface Conversations {
+    [conversationId: string]: Conversation;
+}
+export interface Conversation {
+    conversation_id: string;
+    type: 'GROUP_DM' | 'ONE_TO_ONE';
+    sort_event_id: string;
+    sort_timestamp: string;
+    participants: Participant[];
+    nsfw: boolean;
+    notifications_disabled: boolean;
+    mention_notifications_disabled: boolean;
+    last_read_event_id: string;
+    trusted: boolean;
+    low_quality: boolean;
+    muted: boolean;
+    status: 'HAS_MORE' | 'AT_END';
+    min_entry_id: string;
+    max_entry_id: string;
+    create_time?: string;
+    created_by_user_id?: string;
+    name?: string;
+    avatar_image_https?: string;
+    avatar?: ConversationAvatar;
+    read_only?: boolean;
+    social_proof?: SocialProof[];
+}
+interface ConversationAvatar {
+    image: {
+        original_info: {
+            url: string;
+            width: number;
+            height: number;
+        };
+    };
+}
+interface Participant {
+    user_id: string;
+    join_time?: string;
+    last_read_event_id?: string;
+    join_conversation_event_id?: string;
+    is_admin?: boolean;
+}
+export interface SocialProof {
+    proof_type: string;
+    users: any[];
+    total: number;
+}
+export {};

package/dist/types/raw/dm/InboxInitial.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=InboxInitial.js.map

package/dist/types/raw/dm/InboxInitial.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InboxInitial.js","sourceRoot":"","sources":["../../../../src/types/raw/dm/InboxInitial.ts"],"names":[],"mappings":";AAAA,oBAAoB"}