@youmind-openlab/rettiwt-api 1.0.0

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

@@ -0,0 +1,301 @@
+/* eslint-disable */
+
+import { Users, Conversations } from './InboxInitial';
+
+/**
+ * The raw data received when fetching the inbox timeline.
+ *
+ * @public
+ */
+export interface IInboxTimelineResponse {
+	inbox_timeline: InboxTimeline;
+}
+
+interface InboxTimeline {
+	status: 'HAS_MORE' | 'AT_END';
+	min_entry_id: string;
+	entries: TimelineEntry[];
+	users: Users;
+	conversations: Conversations;
+}
+
+type TimelineEntry =
+	| { trust_conversation: TrustConversation }
+	| { message: TimelineMessage }
+	| { participants_leave: ParticipantsLeave };
+
+interface TrustConversation {
+	id: string;
+	time: string;
+	affects_sort: boolean;
+	request_id: string;
+	conversation_id: string;
+	reason: string; // e.g., "accept"
+}
+
+export interface TimelineMessage {
+	id: string;
+	time: string;
+	affects_sort: boolean;
+	request_id: string;
+	conversation_id: string;
+	message_data: TimelineMessageData;
+}
+
+interface TimelineMessageData {
+	id: string;
+	time: string;
+	recipient_id?: string;
+	sender_id: string;
+	conversation_id?: string;
+	text: string;
+	edit_count: number;
+	entities?: MessageEntities;
+	reply_data?: ReplyData;
+	attachment?: MessageAttachment;
+}
+
+interface MessageEntities {
+	hashtags: any[];
+	symbols: any[];
+	user_mentions: UserMention[];
+	urls: UrlEntity[];
+}
+
+interface UserMention {
+	screen_name: string;
+	name: string;
+	id: number;
+	id_str: string;
+	indices: [number, number];
+}
+
+interface UrlEntity {
+	url: string;
+	expanded_url: string;
+	display_url: string;
+	indices: [number, number];
+}
+
+interface ReplyData {
+	id: string;
+	time: string;
+	recipient_id: string;
+	sender_id: string;
+	text: string;
+	edit_count: number;
+	entities?: MessageEntities;
+}
+
+interface MessageAttachment {
+	card?: CardAttachment;
+	tweet?: TweetAttachment;
+}
+
+interface CardAttachment {
+	name: string;
+	url: string;
+	card_type_url: string;
+	binding_values: CardBindingValues;
+}
+
+interface CardBindingValues {
+	vanity_url?: StringValue;
+	domain?: StringValue;
+	title?: StringValue;
+	description?: StringValue;
+	thumbnail_image_small?: ImageValue;
+	thumbnail_image?: ImageValue;
+	thumbnail_image_large?: ImageValue;
+	thumbnail_image_x_large?: ImageValue;
+	thumbnail_image_color?: ImageColorValue;
+	thumbnail_image_original?: ImageValue;
+	summary_photo_image_small?: ImageValue;
+	summary_photo_image?: ImageValue;
+	summary_photo_image_large?: ImageValue;
+	summary_photo_image_x_large?: ImageValue;
+	summary_photo_image_color?: ImageColorValue;
+	summary_photo_image_original?: ImageValue;
+	photo_image_full_size_small?: ImageValue;
+	photo_image_full_size?: ImageValue;
+	photo_image_full_size_large?: ImageValue;
+	photo_image_full_size_x_large?: ImageValue;
+	photo_image_full_size_color?: ImageColorValue;
+	photo_image_full_size_original?: ImageValue;
+	card_url?: StringValue;
+}
+
+interface StringValue {
+	type: 'STRING';
+	string_value: string;
+	scribe_key?: string;
+}
+
+interface ImageValue {
+	type: 'IMAGE';
+	image_value: {
+		url: string;
+		width: number;
+		height: number;
+		alt: string | null;
+	};
+}
+
+interface ImageColorValue {
+	type: 'IMAGE_COLOR';
+	image_color_value: {
+		palette: ColorPalette[];
+	};
+}
+
+interface ColorPalette {
+	percentage: number;
+	rgb: {
+		red: number;
+		green: number;
+		blue: number;
+	};
+}
+
+interface TweetAttachment {
+	id: string;
+	url: string;
+	display_url: string;
+	expanded_url: string;
+	indices: [number, number];
+	status: TwitterStatus;
+}
+
+interface TwitterStatus {
+	created_at: string;
+	id: number;
+	id_str: string;
+	full_text: string;
+	truncated: boolean;
+	display_text_range: [number, number];
+	entities: MessageEntities;
+	source: string;
+	in_reply_to_status_id: number | null;
+	in_reply_to_status_id_str: string | null;
+	in_reply_to_user_id: number | null;
+	in_reply_to_user_id_str: string | null;
+	in_reply_to_screen_name: string | null;
+	user: TwitterUser;
+	geo: any;
+	coordinates: any;
+	place: any;
+	contributors: any;
+	is_quote_status: boolean;
+	retweet_count: number;
+	favorite_count: number;
+	reply_count: number;
+	quote_count: number;
+	favorited: boolean;
+	retweeted: boolean;
+	lang: string;
+	supplemental_language: string | null;
+	ext: TwitterExtensions;
+}
+
+interface TwitterUser {
+	id: number;
+	id_str: string;
+	name: string;
+	screen_name: string;
+	location: string;
+	description: string;
+	url: string;
+	entities: UserEntityInfo;
+	protected: boolean;
+	followers_count: number;
+	fast_followers_count: number;
+	normal_followers_count: number;
+	friends_count: number;
+	listed_count: number;
+	created_at: string;
+	favourites_count: number;
+	utc_offset: any;
+	time_zone: any;
+	geo_enabled: boolean;
+	verified: boolean;
+	statuses_count: number;
+	media_count: number;
+	lang: any;
+	contributors_enabled: boolean;
+	is_translator: boolean;
+	is_translation_enabled: boolean;
+	profile_background_color: string;
+	profile_background_image_url: string | null;
+	profile_background_image_url_https: string | null;
+	profile_background_tile: boolean;
+	profile_image_url: string;
+	profile_image_url_https: string;
+	profile_banner_url: string;
+	profile_link_color: string;
+	profile_sidebar_border_color: string;
+	profile_sidebar_fill_color: string;
+	profile_text_color: string;
+	profile_use_background_image: boolean;
+	default_profile: boolean;
+	default_profile_image: boolean;
+	pinned_tweet_ids: number[];
+	pinned_tweet_ids_str: string[];
+	has_custom_timelines: boolean;
+	can_dm: any;
+	can_media_tag: boolean;
+	following: boolean;
+	follow_request_sent: boolean;
+	notifications: boolean;
+	muting: any;
+	blocking: boolean;
+	blocked_by: boolean;
+	want_retweets: boolean;
+	advertiser_account_type: string;
+	advertiser_account_service_levels: any[];
+	business_profile_state: string;
+	translator_type: string;
+	withheld_in_countries: any[];
+	followed_by: boolean;
+	ext: TwitterExtensions;
+	require_some_consent: boolean;
+}
+
+interface UserEntityInfo {
+	url: {
+		urls: UrlEntity[];
+	};
+	description: {
+		urls: UrlEntity[];
+	};
+}
+
+interface TwitterExtensions {
+	businessAffiliationsLabel?: {
+		r: { ok: any };
+		ttl: number;
+	};
+	superFollowMetadata?: {
+		r: { ok: any };
+		ttl: number;
+	};
+	parodyCommentaryFanLabel?: {
+		r: { ok: string };
+		ttl: number;
+	};
+	highlightedLabel?: {
+		r: { ok: any };
+		ttl: number;
+	};
+}
+
+interface ParticipantsLeave {
+	id: string;
+	time: string;
+	affects_sort: boolean;
+	conversation_id: string;
+	participants: ParticipantInfo[];
+}
+
+interface ParticipantInfo {
+	user_id: string;
+}

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

@@ -0,0 +1,46 @@
+/* eslint-disable */
+
+import { Users, Conversations, InboxInitialState } from './InboxInitial';
+
+/**
+ * The raw data received when fetching user updates from the DM system.
+ * The response structure varies based on query parameters.
+ *
+ * @public
+ */
+export interface IUserUpdatesResponse {
+	user_events?: UserEvents;
+	inbox_initial_state?: InboxInitialState;
+}
+
+/**
+ * User events can have different structures based on the request type:
+ * - With active_conversation_id + cursor: Full data with users and conversations
+ * - Without active_conversation_id and cursor: Same as inbox initial (see IInboxInitialResponse)
+ * - With cursor only: Minimal data with just event IDs and cursor
+ */
+type UserEvents = UserEventsWithData | UserEventsMinimal;
+
+/**
+ * Full user events data returned when requesting with active_conversation_id and cursor.
+ * Used for conversation-specific updates with user and conversation context.
+ */
+interface UserEventsWithData {
+	cursor: string;
+	last_seen_event_id: string;
+	trusted_last_seen_event_id: string;
+	untrusted_last_seen_event_id: string;
+	users: Users;
+	conversations: Conversations;
+}
+
+/**
+ * Minimal user events data returned when requesting with cursor only (no active_conversation_id).
+ * Used for lightweight polling of event state without full data.
+ */
+interface UserEventsMinimal {
+	cursor: string;
+	last_seen_event_id: string;
+	trusted_last_seen_event_id: string;
+	untrusted_last_seen_event_id: string;
+}

package/src/types/raw/generic/Response.ts

@@ -0,0 +1,10 @@
+/**
+ * The generic raw data received.
+ *
+ * @typeParam DataType - The type of data contained in the response, incase of successful request.
+ *
+ * @public
+ */
+export interface IResponse<DataType> {
+	data: DataType;
+}

package/src/types/raw/list/AddMember.ts

@@ -0,0 +1,175 @@
+/* eslint-disable */
+
+/**
+ * The raw data received after adding a member to a tweet list.
+ *
+ * @public
+ */
+export interface IListMemberAddResponse {
+	data: Data;
+}
+
+export interface Data {
+	list: List;
+}
+
+export interface List {
+	created_at: number;
+	default_banner_media: DefaultBannerMedia;
+	default_banner_media_results: DefaultBannerMediaResults;
+	description: string;
+	facepile_urls: any[];
+	following: boolean;
+	id: string;
+	id_str: string;
+	is_member: boolean;
+	member_count: number;
+	members_context: string;
+	mode: string;
+	muting: boolean;
+	name: string;
+	pinning: boolean;
+	subscriber_count: number;
+	user_results: UserResults;
+}
+
+export interface DefaultBannerMedia {
+	media_info: MediaInfo;
+}
+
+export interface MediaInfo {
+	original_img_url: string;
+	original_img_width: number;
+	original_img_height: number;
+	salient_rect: SalientRect;
+}
+
+export interface SalientRect {
+	left: number;
+	top: number;
+	width: number;
+	height: number;
+}
+
+export interface DefaultBannerMediaResults {
+	result: Result;
+}
+
+export interface Result {
+	id: string;
+	media_key: string;
+	media_id: string;
+	media_info: MediaInfo2;
+	__typename: string;
+}
+
+export interface MediaInfo2 {
+	__typename: string;
+	original_img_height: number;
+	original_img_width: number;
+	original_img_url: string;
+	salient_rect: SalientRect2;
+}
+
+export interface SalientRect2 {
+	height: number;
+	left: number;
+	top: number;
+	width: number;
+}
+
+export interface UserResults {
+	result: Result2;
+}
+
+export interface Result2 {
+	__typename: string;
+	id: string;
+	rest_id: string;
+	affiliates_highlighted_label: AffiliatesHighlightedLabel;
+	avatar: Avatar;
+	core: Core;
+	dm_permissions: DmPermissions;
+	has_graduated_access: boolean;
+	is_blue_verified: boolean;
+	legacy: Legacy;
+	location: Location;
+	media_permissions: MediaPermissions;
+	parody_commentary_fan_label: string;
+	profile_image_shape: string;
+	privacy: Privacy;
+	relationship_perspectives: RelationshipPerspectives;
+	tipjar_settings: TipjarSettings;
+	verification: Verification;
+	verified_phone_status: boolean;
+}
+
+export interface AffiliatesHighlightedLabel {}
+
+export interface Avatar {
+	image_url: string;
+}
+
+export interface Core {
+	created_at: string;
+	name: string;
+	screen_name: string;
+}
+
+export interface DmPermissions {
+	can_dm: boolean;
+}
+
+export interface Legacy {
+	default_profile: boolean;
+	default_profile_image: boolean;
+	description: string;
+	entities: Entities;
+	fast_followers_count: number;
+	favourites_count: number;
+	followers_count: number;
+	friends_count: number;
+	has_custom_timelines: boolean;
+	is_translator: boolean;
+	listed_count: number;
+	media_count: number;
+	needs_phone_verification: boolean;
+	normal_followers_count: number;
+	pinned_tweet_ids_str: any[];
+	possibly_sensitive: boolean;
+	profile_interstitial_type: string;
+	statuses_count: number;
+	translator_type: string;
+	want_retweets: boolean;
+	withheld_in_countries: any[];
+}
+
+export interface Entities {
+	description: Description;
+}
+
+export interface Description {
+	urls: any[];
+}
+
+export interface Location {
+	location: string;
+}
+
+export interface MediaPermissions {
+	can_media_tag: boolean;
+}
+
+export interface Privacy {
+	protected: boolean;
+}
+
+export interface RelationshipPerspectives {
+	following: boolean;
+}
+
+export interface TipjarSettings {}
+
+export interface Verification {
+	verified: boolean;
+}

package/src/types/raw/list/Details.ts

@@ -0,0 +1,176 @@
+/* eslint-disable */
+
+/**
+ * The raw data received when fetching the details of a tweet list.
+ *
+ * @public
+ */
+export interface IListDetailsResponse {
+	data: Data;
+}
+
+interface Data {
+	list: List;
+}
+
+interface List {
+	created_at: number;
+	default_banner_media: DefaultBannerMedia;
+	default_banner_media_results: DefaultBannerMediaResults;
+	description: string;
+	facepile_urls: string[];
+	followers_context: string;
+	following: boolean;
+	id: string;
+	id_str: string;
+	is_member: boolean;
+	member_count: number;
+	members_context: string;
+	mode: string;
+	muting: boolean;
+	name: string;
+	pinning: boolean;
+	subscriber_count: number;
+	user_results: UserResults;
+}
+
+interface DefaultBannerMedia {
+	media_info: MediaInfo;
+}
+
+interface MediaInfo {
+	original_img_url: string;
+	original_img_width: number;
+	original_img_height: number;
+	salient_rect: SalientRect;
+}
+
+interface SalientRect {
+	left: number;
+	top: number;
+	width: number;
+	height: number;
+}
+
+interface DefaultBannerMediaResults {
+	result: Result;
+}
+
+interface Result {
+	id: string;
+	media_key: string;
+	media_id: string;
+	media_info: MediaInfo2;
+	__typename: string;
+}
+
+interface MediaInfo2 {
+	__typename: string;
+	original_img_height: number;
+	original_img_width: number;
+	original_img_url: string;
+	salient_rect: SalientRect2;
+}
+
+interface SalientRect2 {
+	height: number;
+	left: number;
+	top: number;
+	width: number;
+}
+
+interface UserResults {
+	result: Result2;
+}
+
+interface Result2 {
+	__typename: string;
+	id: string;
+	rest_id: string;
+	affiliates_highlighted_label: AffiliatesHighlightedLabel;
+	avatar: Avatar;
+	core: Core;
+	dm_permissions: DmPermissions;
+	has_graduated_access: boolean;
+	is_blue_verified: boolean;
+	legacy: Legacy;
+	location: Location;
+	media_permissions: MediaPermissions;
+	parody_commentary_fan_label: string;
+	profile_image_shape: string;
+	privacy: Privacy;
+	relationship_perspectives: RelationshipPerspectives;
+	tipjar_settings: TipjarSettings;
+	verification: Verification;
+	verified_phone_status: boolean;
+}
+
+interface AffiliatesHighlightedLabel {}
+
+interface Avatar {
+	image_url: string;
+}
+
+interface Core {
+	created_at: string;
+	name: string;
+	screen_name: string;
+}
+
+interface DmPermissions {
+	can_dm: boolean;
+}
+
+interface Legacy {
+	default_profile: boolean;
+	default_profile_image: boolean;
+	description: string;
+	entities: Entities;
+	fast_followers_count: number;
+	favourites_count: number;
+	followers_count: number;
+	friends_count: number;
+	has_custom_timelines: boolean;
+	is_translator: boolean;
+	listed_count: number;
+	media_count: number;
+	normal_followers_count: number;
+	pinned_tweet_ids_str: string[];
+	possibly_sensitive: boolean;
+	profile_banner_url: string;
+	profile_interstitial_type: string;
+	statuses_count: number;
+	translator_type: string;
+	want_retweets: boolean;
+	withheld_in_countries: any[];
+}
+
+interface Entities {
+	description: Description;
+}
+
+interface Description {
+	urls: any[];
+}
+
+interface Location {
+	location: string;
+}
+
+interface MediaPermissions {
+	can_media_tag: boolean;
+}
+
+interface Privacy {
+	protected: boolean;
+}
+
+interface RelationshipPerspectives {
+	following: boolean;
+}
+
+interface TipjarSettings {}
+
+interface Verification {
+	verified: boolean;
+}