@youmind-openlab/rettiwt-api 1.0.0

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

@@ -0,0 +1,33 @@
+/**
+ * The details of a single Twitter List.
+ *
+ * @public
+ */
+export interface IList {
+	/** The date and time of creation of the list, int UTC string format. */
+	createdAt: string;
+
+	/** 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. */
+	name: string;
+
+	/** The number of subscribers of the list. */
+	subscriberCount: number;
+}

package/src/types/data/Notification.ts

@@ -0,0 +1,26 @@
+import { NotificationType } from '../../enums/Notification';
+
+/**
+ * The details of a single notification.
+ *
+ * @public
+ */
+export interface INotification {
+	/** The list of id of the users from whom the notification was received. */
+	from: string[];
+
+	/** The id of the notification. */
+	id: string;
+
+	/** The text contents of the notification. */
+	message: string;
+
+	/** The date/time at which the notification was received. */
+	receivedAt: string;
+
+	/** The list of id of the target tweet(s) of the notification. */
+	target: string[];
+
+	/** The type of notification. */
+	type?: NotificationType;
+}

package/src/types/data/Tweet.ts

@@ -0,0 +1,99 @@
+import { MediaType } from '../../enums/Media';
+
+import { IUser } from './User';
+
+/**
+ * The details of a single tweet.
+ *
+ * @public
+ */
+export interface ITweet {
+	/** The number of bookmarks of a tweet. */
+	bookmarkCount?: number;
+
+	/** The ID of tweet which started the current conversation. */
+	conversationId: string;
+
+	/** The creation date of the tweet. */
+	createdAt: string;
+
+	/** Additional tweet entities like urls, mentions, etc. */
+	entities: ITweetEntities;
+
+	/** The full text content of the tweet. */
+	fullText: string;
+
+	/** The rest id of the tweet. */
+	id: string;
+
+	/** The language in which the tweet is written. */
+	lang: string;
+
+	/** The number of likes of the tweet. */
+	likeCount?: number;
+
+	/** The urls of the media contents of the tweet (if any). */
+	media?: ITweetMedia[];
+
+	/** The number of quotes of the tweet. */
+	quoteCount?: number;
+
+	/** The tweet which is quoted in the tweet. */
+	quoted?: ITweet;
+
+	/** The number of replies to the tweet. */
+	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;
+
+	/** The tweet which is retweeted in this tweet (if any). */
+	retweetedTweet?: ITweet;
+
+	/** The details of the user who made the tweet. */
+	tweetBy: IUser;
+
+	/** The URL to the tweet. */
+	url: string;
+
+	/** The number of views of a tweet. */
+	viewCount?: number;
+}
+
+/**
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ *
+ * @public
+ */
+export interface ITweetEntities {
+	/** The list of hashtags mentioned in the tweet. */
+	hashtags: string[];
+
+	/** The list of IDs of users mentioned in the tweet. */
+	mentionedUsers: string[];
+
+	/** The list of urls mentioned in the tweet. */
+	urls: string[];
+}
+
+/**
+ * The details of a single media content included in a tweet.
+ *
+ * @public
+ */
+export interface ITweetMedia {
+	/** The ID of the media. */
+	id: string;
+
+	/** The thumbnail URL for the video content of the tweet. */
+	thumbnailUrl?: string;
+
+	/** The type of media. */
+	type: MediaType;
+
+	/** The direct URL to the media. */
+	url: string;
+}

package/src/types/data/User.ts

@@ -0,0 +1,54 @@
+/**
+ * The details of a single user.
+ *
+ * @public
+ */
+export interface IUser {
+	/** The creation date of user's account. */
+	createdAt: string;
+
+	/** The user's description. */
+	description?: string;
+
+	/** The number of followers of the user. */
+	followersCount: number;
+
+	/** The number of following of the user. */
+	followingsCount: number;
+
+	/** The full name of the user. */
+	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. */
+	likeCount: number;
+
+	/** The location of user as provided by user. */
+	location?: string;
+
+	/** The rest id of the tweet pinned in the user's profile. */
+	pinnedTweet?: string;
+
+	/** The url of the profile banner image. */
+	profileBanner?: string;
+
+	/** The url of the profile image. */
+	profileImage: string;
+
+	/** The number of tweets made by the user. */
+	statusesCount: number;
+
+	/** The username/screenname of the user. */
+	userName: string;
+}

package/src/types/errors/TwitterError.ts

@@ -0,0 +1,37 @@
+/**
+ * The error thrown by Twitter API.
+ *
+ * @public
+ */
+export interface ITwitterError extends Error {
+	/** The details of each error. */
+	details: ITwitterErrorDetails[];
+
+	/** The error message in the response. */
+	message: string;
+
+	/** The name of the error response. */
+	name: string;
+
+	/** The response status code. */
+	status: number;
+}
+
+/**
+ * The error details.
+ *
+ * @public
+ */
+export interface ITwitterErrorDetails {
+	/** The internal error code. */
+	code: number;
+
+	/** The message associated with the error. */
+	message: string;
+
+	/** The name of the error. */
+	name?: string;
+
+	/** The type of error. */
+	type?: string;
+}

package/src/types/params/Variables.ts

@@ -0,0 +1,41 @@
+/**
+ * Media to be sent as payload.
+ *
+ * @internal
+ */
+export interface IMediaVariable {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	media_entities: IMediaEntityVariable[];
+	possibly_sensitive: boolean;
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+}
+
+/**
+ * Each media item in the media payload.
+ *
+ * @internal
+ */
+export interface IMediaEntityVariable {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	media_id: string;
+	tagged_users: string[];
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+}
+
+/**
+ * Reply specific details to be sent in payload.
+ *
+ * @internal
+ */
+export interface IReplyVariable {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	exclude_reply_user_ids: string[];
+	in_reply_to_tweet_id: string;
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+}

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

@@ -0,0 +1,32 @@
+/* eslint-disable */
+
+/**
+ * Represents the raw data of the analytic result of the User.
+ *
+ * @public
+ */
+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_values: IAnalyticsMetricValue[];
+	timestamp: IAnalyticsTimeStamp;
+}
+
+export interface IAnalyticsMetricValue {
+	metric_value: number;
+	metric_type: string;
+}
+
+export interface IAnalyticsTimeStamp {
+	iso8601_time: string;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * Represents the raw data of a single BookmarkFolder.
+ *
+ * @public
+ */
+export interface IBookmarkFolder {
+	/** The unique identifier for the folder. */
+	id: string;
+
+	/** The display name of the folder. */
+	name: string;
+}

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

@@ -0,0 +1,13 @@
+/* eslint-disable */
+
+/**
+ * Represents a cursor object used for pagination.
+ *
+ * @public
+ */
+export interface ICursor {
+	entryType: string;
+	__typename: string;
+	value: string;
+	cursorType: string;
+}

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

@@ -0,0 +1,38 @@
+/* eslint-disable */
+
+/**
+ * Error details for multiple errors.
+ *
+ * @public
+ */
+export interface IErrorData {
+	data: unknown;
+	errors: IErrorDetails[];
+}
+
+/**
+ * Error details of a single error.
+ *
+ * @public
+ */
+export interface IErrorDetails {
+	message: string;
+	extensions?: IErrorExtensions;
+	code: number;
+	kind?: string;
+	name?: string;
+	source?: string;
+	tracing?: IErrorTracing;
+}
+
+export interface IErrorExtensions {
+	name: string;
+	source: string;
+	code: number;
+	kind: string;
+	tracing: IErrorTracing;
+}
+
+export interface IErrorTracing {
+	trace_id: string;
+}

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

@@ -0,0 +1,40 @@
+/* eslint-disable */
+
+import { ITweet } from './Tweet';
+
+/**
+ * Represents the raw data of a single Tweet with limited visibility actions.
+ *
+ * @public
+ */
+export interface ILimitedVisibilityTweet {
+	__typename: string;
+	tweet: ITweet;
+	limitedActionResults: ITweetLimitedActionResults;
+}
+
+export interface ITweetLimitedActionResults {
+	limited_actions: ITweetLimitedAction[];
+}
+
+export interface ITweetLimitedAction {
+	action: string;
+	prompt: ILimitedActionPrompt;
+}
+
+export interface ILimitedActionPrompt {
+	__typename: string;
+	cta_type: string;
+	headline: IPromptHeadline;
+	subtext: IPromptSubtext;
+}
+
+export interface IPromptHeadline {
+	text: string;
+	entities: any[];
+}
+
+export interface IPromptSubtext {
+	text: string;
+	entities: any[];
+}

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

@@ -0,0 +1,50 @@
+/* eslint-disable */
+
+import { IDataResult } from '../composite/DataResult';
+import { IUser } from './User';
+
+/**
+ * Represents the raw data of a single List.
+ *
+ * @public
+ */
+export interface IList {
+	created_at: number;
+	default_banner_media: IDefaultBannerMedia;
+	default_banner_media_results: IDefaultBannerMediaResults;
+	description: string;
+	following: boolean;
+	id: string;
+	id_str: string;
+	is_member: boolean;
+	member_count: number;
+	mode: string;
+	muting: boolean;
+	name: string;
+	subscriber_count: number;
+	user_results: IDataResult<IUser>;
+	facepile_urls: string[];
+	followers_context: string;
+	members_context: string;
+}
+
+export interface IDefaultBannerMedia {
+	media_info: IBannerMediaInfo;
+}
+
+export interface IDefaultBannerMediaResults {
+	result: IBannerMediaResult;
+}
+
+export interface IBannerMediaResult {
+	id: string;
+	media_key: string;
+	media_id: string;
+	media_info: IBannerMediaInfo;
+}
+
+export interface IBannerMediaInfo {
+	original_img_url: string;
+	original_img_width: number;
+	original_img_height: number;
+}

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

@@ -0,0 +1,53 @@
+/* eslint-disable */
+
+import { RawMediaType } from '../../../enums/raw/Media';
+
+/**
+ * Represents the raw data of a single Media.
+ *
+ * @public
+ */
+export interface IMedia {
+	display_url: string;
+	expanded_url: string;
+	id_str: string;
+	media_url_https: string;
+	type: RawMediaType;
+	url: string;
+}
+
+export interface IExtendedMedia extends IMedia {
+	media_key: string;
+	ext_media_availability: IMediaAvailability;
+	additional_media_info?: IAdditionalMediaInfo;
+	mediaStats?: IMediaStats;
+	video_info?: IVideoInfo;
+}
+
+export interface IMediaAvailability {
+	status: string;
+}
+
+export interface IAdditionalMediaInfo {
+	monetizable: boolean;
+}
+
+export interface IMediaStats {
+	viewCount: number;
+}
+
+export interface IMediaAvailability {
+	status: string;
+}
+
+export interface IVideoInfo {
+	aspect_ratio: number[];
+	duration_millis: number;
+	variants: IVideoVariant[];
+}
+
+export interface IVideoVariant {
+	bitrate: number;
+	content_type: string;
+	url: string;
+}

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/Notification.ts

@@ -0,0 +1,66 @@
+/* eslint-disable */
+
+import { RawNotificationType } from '../../../enums/raw/Notification';
+import { IDataResult } from '../composite/DataResult';
+import { ITweet } from './Tweet';
+import { IUser } from './User';
+
+/**
+ * Represents the raw data of a single Notification.
+ *
+ * @public
+ */
+export interface INotification {
+	itemType: string;
+	__typename: string;
+	id: string;
+	notification_icon: RawNotificationType;
+	rich_message: INotificationRichMessage;
+	notification_url: INotificationUrl;
+	template: INoticiationTemplate;
+	timestamp_ms: string;
+}
+
+export interface INotificationRichMessage {
+	rtl: boolean;
+	text: string;
+	entities: INotificationEntity[];
+}
+
+export interface INotificationEntity {
+	fromIndex: number;
+	toIndex: number;
+	ref: INotificationEntityRef;
+}
+
+export interface INotificationEntityRef {
+	type: string;
+	user_results: IDataResult<IUser>;
+}
+
+export interface INotificationUrl {
+	url: string;
+	urlType: string;
+	urtEndpointOptions?: INotificationUrtEndpointOptions;
+}
+
+export interface INotificationUrtEndpointOptions {
+	cacheId: string;
+	title: string;
+}
+
+export interface INoticiationTemplate {
+	__typename: string;
+	target_objects: INotificationTargetObject[];
+	from_users: INotificationFromUser[];
+}
+
+export interface INotificationTargetObject {
+	__typename: string;
+	tweet_results: IDataResult<ITweet>;
+}
+
+export interface INotificationFromUser {
+	__typename: string;
+	user_results: IDataResult<IUser>;
+}