rettiwt-api 6.0.7 → 6.1.0

package/src/types/args/PostArgs.ts

@@ -9,13 +9,15 @@ export interface IPostArgs {
 	 *
 	 * @remarks
 	 * Required only when posting using the following resources:
-	 * - {@link EResourceType.TWEET_LIKE}
-	 * - {@link EResourceType.TWEET_RETWEET}
-	 * - {@link EResourceType.TWEET_UNLIKE}
-	 * - {@link EResourceType.TWEET_UNPOST}
-	 * - {@link EResourceType.TWEET_UNRETWEET}
-	 * - {@link EResourceType.USER_FOLLOW}
-	 * - {@link EResourceType.USER_UNFOLLOW}
+	 * - {@link ResourceType.TWEET_BOOKMARK}
+	 * - {@link ResourceType.TWEET_LIKE}
+	 * - {@link ResourceType.TWEET_RETWEET}
+	 * - {@link ResourceType.TWEET_UNBOOKMARK}
+	 * - {@link ResourceType.TWEET_UNLIKE}
+	 * - {@link ResourceType.TWEET_UNPOST}
+	 * - {@link ResourceType.TWEET_UNRETWEET}
+	 * - {@link ResourceType.USER_FOLLOW}
+	 * - {@link ResourceType.USER_UNFOLLOW}
 	 */
 	id?: string;
 
@@ -23,7 +25,7 @@ export interface IPostArgs {
 	 * The tweet that is to be posted.
 	 *
 	 * @remarks
-	 * Required only when posting a tweet using {@link EResourceType.TWEET_POST}
+	 * Required only when posting a tweet using {@link ResourceType.TWEET_POST}
 	 */
 	tweet?: INewTweet;
 
@@ -32,11 +34,29 @@ export interface IPostArgs {
 	 *
 	 * @remarks
 	 * Required only when uploading a media using the following resources:
-	 * - {@link EResourceType.MEDIA_UPLOAD_APPEND}
-	 * - {@link EResourceType.MEDIA_UPLOAD_FINALIZE}
-	 * - {@link EResourceType.MEDIA_UPLOAD_INITIALIZE}
+	 * - {@link ResourceType.MEDIA_UPLOAD_APPEND}
+	 * - {@link ResourceType.MEDIA_UPLOAD_FINALIZE}
+	 * - {@link ResourceType.MEDIA_UPLOAD_INITIALIZE}
 	 */
 	upload?: IUploadArgs;
+
+	/**
+	 * The id of the target user.
+	 *
+	 * @remarks
+	 * Required only for the following resources:
+	 * - {@link ResourceType.LIST_MEMBER_ADD}
+	 * - {@link ResourceType.LIST_MEMBER_REMOVE}
+	 */
+	userId?: string;
+
+	/**
+	 * The id of the conversation to delete.
+	 *
+	 * @remarks
+	 * Required only when deleting a conversation using {@link ResourceType.DM_DELETE_CONVERSATION}
+	 */
+	conversationId?: string;
 }
 
 /**

package/src/types/data/Analytics.ts

@@ -0,0 +1,58 @@
+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/src/types/data/Conversation.ts

@@ -0,0 +1,44 @@
+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/src/types/data/CursoredData.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';
@@ -9,7 +12,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[];
 

package/src/types/data/DirectMessage.ts

@@ -0,0 +1,33 @@
+/**
+ * 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/src/types/data/Inbox.ts

@@ -0,0 +1,23 @@
+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/src/types/data/List.ts

@@ -7,15 +7,21 @@ 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;
 

package/src/types/data/Tweet.ts

@@ -9,7 +9,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;
@@ -30,25 +30,25 @@ export interface ITweet {
 	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;
@@ -60,7 +60,7 @@ export interface ITweet {
 	url: string;
 
 	/** The number of views of a tweet. */
-	viewCount: number;
+	viewCount?: number;
 }
 
 /**

package/src/types/data/User.ts

@@ -22,6 +22,12 @@ export interface IUser {
 	/** 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;
 

package/src/types/raw/base/Analytic.ts

@@ -8,11 +8,17 @@
 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;
 }
 

package/src/types/raw/base/Message.ts

@@ -0,0 +1,22 @@
+/* eslint-disable */
+
+import { ConversationMessage } from '../dm/Conversation';
+import { Message } from '../dm/InboxInitial';
+import { TimelineMessage } from '../dm/InboxTimeline';
+
+// Extract the message_data types
+type ConversationMessageData = ConversationMessage['message_data'];
+type InboxMessageData = Message['message_data'];
+type TimelineMessageData = TimelineMessage['message_data'];
+
+// Create unified message_data type that includes all possible fields
+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;
+}

package/src/types/raw/base/Tweet.ts

@@ -17,7 +17,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;
@@ -78,14 +78,14 @@ export interface ITweetNoteMedia {
 }
 
 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;
@@ -93,10 +93,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/src/types/raw/base/User.ts

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

package/src/types/raw/composite/TimelineList.ts

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

package/src/types/raw/dm/Conversation.ts

@@ -0,0 +1,59 @@
+/* eslint-disable */
+
+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; // e.g., "accept"
+}

package/src/types/raw/dm/InboxInitial.ts

@@ -0,0 +1,155 @@
+/* eslint-disable */
+
+/**
+ * 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; // "HAS_MORE" | "AT_END"
+	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; // Only for GROUP_DM
+	created_by_user_id?: string; // Only for GROUP_DM
+	name?: string; // Only for GROUP_DM
+	avatar_image_https?: string; // Only for GROUP_DM
+	avatar?: ConversationAvatar; // Only for GROUP_DM
+	read_only?: boolean; // Only for ONE_TO_ONE
+	social_proof?: SocialProof[]; // Only for untrusted conversations
+}
+
+interface ConversationAvatar {
+	image: {
+		original_info: {
+			url: string;
+			width: number;
+			height: number;
+		};
+	};
+}
+
+interface Participant {
+	user_id: string;
+	join_time?: string; // Only for GROUP_DM
+	last_read_event_id?: string;
+	join_conversation_event_id?: string; // Only for GROUP_DM
+	is_admin?: boolean; // Only for GROUP_DM
+}
+
+export interface SocialProof {
+	proof_type: string; // e.g., "mutual_friends"
+	users: any[]; // Array of users (structure depends on proof_type)
+	total: number;
+}