rettiwt-api 7.0.3 → 7.1.1

package/src/services/public/ListService.ts

@@ -5,11 +5,17 @@ import { List } from '../../models/data/List';
 import { Tweet } from '../../models/data/Tweet';
 import { User } from '../../models/data/User';
 import { RettiwtConfig } from '../../models/RettiwtConfig';
+import { IListUpdates, INewList } from '../../types/args/PostArgs';
 import { IListMemberAddResponse } from '../../types/raw/list/AddMember';
+import { IListCreateResponse } from '../../types/raw/list/Create';
+import { IListDeleteResponse } from '../../types/raw/list/Delete';
 import { IListDetailsResponse } from '../../types/raw/list/Details';
 import { IListMembersResponse } from '../../types/raw/list/Members';
+import { IListMuteResponse } from '../../types/raw/list/Mute';
 import { IListMemberRemoveResponse } from '../../types/raw/list/RemoveMember';
 import { IListTweetsResponse } from '../../types/raw/list/Tweets';
+import { IListUnmuteResponse } from '../../types/raw/list/Unmute';
+import { IListUpdateResponse } from '../../types/raw/list/Update';
 
 import { FetcherService } from './FetcherService';
 
@@ -64,6 +70,82 @@ export class ListService extends FetcherService {
 		return data;
 	}
 
+	/**
+	 * Create a list.
+	 *
+	 * @param list - The details of the list to create.
+	 *
+	 * @returns The ID of the created list. If creation was unsuccessful, return `undefined`.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Creating a public list
+	 * rettiwt.list.create({ name: 'My list', description: 'List description', isPrivate: false })
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async create(list: INewList): Promise<string | undefined> {
+		const resource: ResourceType = ResourceType.LIST_CREATE;
+
+		// Creating the list
+		const response = await this.request<IListCreateResponse>(resource, {
+			list: list,
+		});
+
+		// Deserializing response
+		const data = Extractors[resource](response.data);
+
+		return data;
+	}
+
+	/**
+	 * Delete a list.
+	 *
+	 * @param id - The ID of the list to delete.
+	 *
+	 * @returns Whether deletion was successful.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Deleting the list with ID '1234567890'
+	 * rettiwt.list.delete('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async delete(id: string): Promise<boolean> {
+		const resource: ResourceType = ResourceType.LIST_DELETE;
+
+		// Deleting the list
+		const response = await this.request<IListDeleteResponse>(resource, { id: id });
+
+		// Deserializing response
+		const data = Extractors[resource](response.data);
+
+		return data;
+	}
+
 	/**
 	 * Get the details of a list.
 	 *
@@ -150,6 +232,43 @@ export class ListService extends FetcherService {
 		return data;
 	}
 
+	/**
+	 * Mute a list.
+	 *
+	 * @param id - The ID of the list to mute.
+	 *
+	 * @returns Whether muting was successful.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Muting the list with ID '1234567890'
+	 * rettiwt.list.mute('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async mute(id: string): Promise<boolean> {
+		const resource: ResourceType = ResourceType.LIST_MUTE;
+
+		// Muting the list
+		const response = await this.request<IListMuteResponse>(resource, { id: id });
+
+		// Deserializing response
+		const data = Extractors[resource](response.data);
+
+		return data;
+	}
+
 	/**
 	 * Remove a member from a list.
 	 *
@@ -238,4 +357,86 @@ export class ListService extends FetcherService {
 
 		return data;
 	}
+
+	/**
+	 * Unmute a list.
+	 *
+	 * @param id - The ID of the list to unmute.
+	 *
+	 * @returns Whether unmuting was successful.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Unmuting the list with ID '1234567890'
+	 * rettiwt.list.unmute('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async unmute(id: string): Promise<boolean> {
+		const resource: ResourceType = ResourceType.LIST_UNMUTE;
+
+		// Unmuting the list
+		const response = await this.request<IListUnmuteResponse>(resource, { id: id });
+
+		// Deserializing response
+		const data = Extractors[resource](response.data);
+
+		return data;
+	}
+
+	/**
+	 * Update a list.
+	 *
+	 * @param id - The ID of the list to update.
+	 * @param updates - The updates to apply to the list.
+	 *
+	 * @returns The updated list. If update was unsuccessful, return `undefined`.
+	 *
+	 * @remarks
+	 * Fields omitted from `updates` are left unchanged. Use an empty string for
+	 * `description` to clear the existing description.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Updating the list with ID '1234567890'
+	 * rettiwt.list.update('1234567890', { name: 'My list', description: 'List description', isPrivate: false })
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async update(id: string, updates: IListUpdates): Promise<List | undefined> {
+		const resource: ResourceType = ResourceType.LIST_UPDATE;
+
+		// Updating the list
+		const response = await this.request<IListUpdateResponse>(resource, {
+			id: id,
+			listUpdates: updates,
+		});
+
+		// Deserializing response
+		const data = Extractors[resource](response.data);
+
+		return data;
+	}
 }

package/src/services/public/TweetService.ts

@@ -15,6 +15,7 @@ import { IMediaInitializeUploadResponse } from '../../types/raw/media/InitalizeU
 import { ITweetBookmarkResponse } from '../../types/raw/tweet/Bookmark';
 import { ITweetDetailsResponse } from '../../types/raw/tweet/Details';
 import { ITweetDetailsBulkResponse } from '../../types/raw/tweet/DetailsBulk';
+import { ITweetHistoryResponse } from '../../types/raw/tweet/History';
 import { ITweetLikeResponse } from '../../types/raw/tweet/Like';
 import { ITweetLikersResponse } from '../../types/raw/tweet/Likers';
 import { ITweetPostNoteResponse, ITweetPostResponse } from '../../types/raw/tweet/Post';
@@ -176,6 +177,43 @@ export class TweetService extends FetcherService {
 		}
 	}
 
+	/**
+	 * Get the edit history of a tweet.
+	 *
+	 * @param id - The ID of the target tweet.
+	 *
+	 * @returns The list of tweet versions, ordered by the returned timeline.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Fetching the edit history of the tweet with id '1234567890'
+	 * rettiwt.tweet.history('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async history(id: string): Promise<Tweet[]> {
+		const resource = ResourceType.TWEET_HISTORY;
+
+		// Fetching raw tweet history
+		const response = await this.request<ITweetHistoryResponse>(resource, { id: id });
+
+		// Deserializing response
+		const data = Extractors[resource](response.data);
+
+		return data;
+	}
+
 	/**
 	 * Like a tweet.
 	 *

package/src/services/public/UserService.ts

@@ -32,6 +32,7 @@ import { IUserMediaResponse } from '../../types/raw/user/Media';
 import { IUserNotificationsResponse } from '../../types/raw/user/Notifications';
 import { IUserProfileUpdateResponse } from '../../types/raw/user/ProfileUpdate';
 import { IUserRecommendedResponse } from '../../types/raw/user/Recommended';
+import { IUserRemoveFollowerResponse } from '../../types/raw/user/RemoveFollower';
 import { IUserSearchResponse } from '../../types/raw/user/Search';
 import { IUserSettingsResponse } from '../../types/raw/user/Settings';
 import { IUserSubscriptionsResponse } from '../../types/raw/user/Subscriptions';
@@ -1041,6 +1042,45 @@ export class UserService extends FetcherService {
 		return data;
 	}
 
+	/**
+	 * Remove a user from the authenticated user's followers (force-unfollow).
+	 *
+	 * @param id - The ID of the user to remove as a follower.
+	 *
+	 * @returns Whether the user was removed successfully.
+	 *
+	 * @throws Code 108 if given user id is invalid.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Removing the User with id '1234567890' from the authenticated user's followers
+	 * rettiwt.user.removeFollower('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async removeFollower(id: string): Promise<boolean> {
+		const resource = ResourceType.USER_REMOVE_FOLLOWER;
+
+		// Removing the follower
+		const response = await this.request<IUserRemoveFollowerResponse>(resource, { id: id });
+
+		// Deserializing the response
+		const data = Extractors[resource](response.data) ?? false;
+
+		return data;
+	}
+
 	/**
 	 * Get the reply timeline of a user.
 	 *

package/src/types/args/PostArgs.ts

@@ -18,6 +18,10 @@ export interface IPostArgs {
 	 * - {@link ResourceType.TWEET_UNLIKE}
 	 * - {@link ResourceType.TWEET_UNPOST}
 	 * - {@link ResourceType.TWEET_UNRETWEET}
+	 * - {@link ResourceType.LIST_DELETE}
+	 * - {@link ResourceType.LIST_MUTE}
+	 * - {@link ResourceType.LIST_UNMUTE}
+	 * - {@link ResourceType.LIST_UPDATE}
 	 * - {@link ResourceType.USER_FOLLOW}
 	 * - {@link ResourceType.USER_UNFOLLOW}
 	 *
@@ -26,6 +30,23 @@ export interface IPostArgs {
 	 */
 	id?: string;
 
+	/**
+	 * The list that is to be created.
+	 *
+	 * @remarks
+	 * Required only when creating a list using the following resources:
+	 * - {@link ResourceType.LIST_CREATE}
+	 */
+	list?: INewList;
+
+	/**
+	 * The updates to apply to an existing list.
+	 *
+	 * @remarks
+	 * Required only when updating a list using {@link ResourceType.LIST_UPDATE}.
+	 */
+	listUpdates?: IListUpdates;
+
 	/**
 	 * The new username to set.
 	 *
@@ -104,6 +125,43 @@ export interface IPostArgs {
 	changePassword?: IChangePasswordArgs;
 }
 
+/**
+ * Configuration for the list to be created.
+ *
+ * @public
+ */
+export interface INewList {
+	/** The list name. */
+	name: string;
+
+	/** The list description. */
+	description?: string;
+
+	/** Whether the list is private. */
+	isPrivate?: boolean;
+}
+
+/**
+ * Configuration for the updates to apply to an existing list.
+ *
+ * @public
+ */
+export interface IListUpdates {
+	/** The updated list name. */
+	name?: string;
+
+	/**
+	 * The updated list description.
+	 *
+	 * @remarks
+	 * Use an empty string to clear the existing description.
+	 */
+	description?: string;
+
+	/** Whether the list is private. */
+	isPrivate?: boolean;
+}
+
 /**
  * Configuration for the new tweet to be posted.
  *

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

@@ -0,0 +1,16 @@
+/* eslint-disable */
+
+/**
+ * The raw data received when creating a tweet list.
+ *
+ * @public
+ */
+export interface IListCreateResponse {
+	data?: {
+		list?: IListCreateList;
+	};
+}
+
+interface IListCreateList {
+	id_str?: string;
+}

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

@@ -0,0 +1,12 @@
+/* eslint-disable */
+
+/**
+ * The raw data received when deleting a tweet list.
+ *
+ * @public
+ */
+export interface IListDeleteResponse {
+	data?: {
+		list_delete?: string;
+	};
+}

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

@@ -0,0 +1,10 @@
+/**
+ * The raw data received when muting a tweet list.
+ *
+ * @public
+ */
+export interface IListMuteResponse {
+	data?: {
+		list?: string;
+	};
+}

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

@@ -0,0 +1,10 @@
+/**
+ * The raw data received when unmuting a tweet list.
+ *
+ * @public
+ */
+export interface IListUnmuteResponse {
+	data?: {
+		list?: string;
+	};
+}

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

@@ -0,0 +1,12 @@
+import { IList } from '../base/List';
+
+/**
+ * The raw data received when updating a tweet list.
+ *
+ * @public
+ */
+export interface IListUpdateResponse {
+	data?: {
+		list?: IList;
+	};
+}

package/src/types/raw/tweet/History.ts

@@ -0,0 +1,57 @@
+/* eslint-disable */
+
+import { ITimelineTweet } from '../composite/TimelineTweet';
+
+/**
+ * Represents the raw response received when fetching a tweet's edit history.
+ *
+ * @public
+ */
+export interface ITweetHistoryResponse {
+	data?: {
+		tweet_result_by_rest_id?: {
+			result?: {
+				edit_history_timeline?: {
+					timeline?: ITweetHistoryTimeline;
+				};
+			};
+		};
+	};
+}
+
+export interface ITweetHistoryTimeline {
+	instructions?: ITweetHistoryInstruction[];
+}
+
+export interface ITweetHistoryInstruction {
+	direction?: string;
+	entries?: ITweetHistoryEntry[];
+	type: string;
+}
+
+export interface ITweetHistoryEntry {
+	content?: ITweetHistoryModule;
+	entryId: string;
+	sortIndex?: string;
+}
+
+export interface ITweetHistoryModule {
+	__typename: string;
+	displayType: string;
+	entryType: string;
+	header?: ITweetHistoryHeader;
+	items?: ITweetHistoryItem[];
+}
+
+export interface ITweetHistoryHeader {
+	displayType: string;
+	sticky: boolean;
+	text: string;
+}
+
+export interface ITweetHistoryItem {
+	entryId: string;
+	item: {
+		itemContent: ITimelineTweet;
+	};
+}

package/src/types/raw/user/RemoveFollower.ts

@@ -0,0 +1,15 @@
+/* eslint-disable */
+
+/**
+ * The raw data received when removing a given user from the authenticated user's followers.
+ *
+ * @public
+ */
+export interface IUserRemoveFollowerResponse {
+	data?: {
+		remove_follower?: {
+			__typename?: string;
+			unfollow_success_reason?: string;
+		};
+	};
+}