rettiwt-api 6.3.0-alpha.1 → 7.0.0

package/src/types/args/FetchArgs.ts

@@ -71,7 +71,7 @@ export interface IFetchArgs {
 	 *
 	 * @remarks
 	 * - Required for all resources except {@link ResourceType.TWEET_SEARCH} and {@link ResourceType.USER_TIMELINE_RECOMMENDED}.
-	 * - For {@link ResourceType.USER_DETAILS_BY_USERNAME} and {@link ResourceType.USER_SEARCH}, can be alphanumeric, while for others, is strictly numeric.
+	 * - For {@link ResourceType.USER_DETAILS_BY_USERNAME}, {@link ResourceType.USER_ABOUT_BY_USERNAME}, and {@link ResourceType.USER_SEARCH}, can be alphanumeric, while for others, is strictly numeric.
 	 */
 	id?: string;
 
@@ -83,6 +83,30 @@ export interface IFetchArgs {
 	 */
 	ids?: string[];
 
+	/**
+	 * Whether to include replay information when fetching space details.
+	 *
+	 * @remarks
+	 * - Only works for {@link ResourceType.SPACE_DETAILS}.
+	 */
+	withReplays?: boolean;
+
+	/**
+	 * Whether to include listeners information when fetching space details.
+	 *
+	 * @remarks
+	 * - Only works for {@link ResourceType.SPACE_DETAILS}.
+	 */
+	withListeners?: boolean;
+
+	/**
+	 * Whether to request metatags for space details.
+	 *
+	 * @remarks
+	 * - Only works for {@link ResourceType.SPACE_DETAILS}.
+	 */
+	isMetatagsQuery?: boolean;
+
 	/**
 	 * The sorting to use for tweet results.
 	 *
@@ -132,6 +156,22 @@ export interface IFetchArgs {
 	showVerifiedFollowers?: boolean;
 }
 
+/**
+ * Options specifying the data that is to be fetched for space details.
+ *
+ * @public
+ */
+export interface ISpaceDetailsOptions {
+	/** Whether to include replay information. */
+	withReplays?: boolean;
+
+	/** Whether to include listeners information. */
+	withListeners?: boolean;
+
+	/** Whether the request is a metatags query. */
+	isMetatagsQuery?: boolean;
+}
+
 /**
  * The filter to be used for searching tweets.
  *

package/src/types/args/PostArgs.ts

@@ -20,9 +20,20 @@ export interface IPostArgs {
 	 * - {@link ResourceType.TWEET_UNRETWEET}
 	 * - {@link ResourceType.USER_FOLLOW}
 	 * - {@link ResourceType.USER_UNFOLLOW}
+	 *
+	 * For {@link ResourceType.USER_USERNAME_CHANGE}, use {@link IPostArgs.username}.
+	 * `id` is still accepted for backward compatibility.
 	 */
 	id?: string;
 
+	/**
+	 * The new username to set.
+	 *
+	 * @remarks
+	 * Required only when changing username using {@link ResourceType.USER_USERNAME_CHANGE}.
+	 */
+	username?: string;
+
 	/**
 	 * The tweet that is to be posted.
 	 *
@@ -67,6 +78,30 @@ export interface IPostArgs {
 	 * Required only when updating user profile using {@link ResourceType.USER_PROFILE_UPDATE}
 	 */
 	profileOptions?: IProfileUpdateOptions;
+
+	/**
+	 * Base64-encoded profile image data.
+	 *
+	 * @remarks
+	 * Required only when updating profile image using {@link ResourceType.USER_PROFILE_IMAGE_UPDATE}.
+	 */
+	profileImage?: string;
+
+	/**
+	 * Base64-encoded profile banner data.
+	 *
+	 * @remarks
+	 * Required only when updating profile banner using {@link ResourceType.USER_PROFILE_BANNER_UPDATE}.
+	 */
+	profileBanner?: string;
+
+	/**
+	 * Password change arguments.
+	 *
+	 * @remarks
+	 * Required only when changing password using {@link ResourceType.USER_PASSWORD_CHANGE}.
+	 */
+	changePassword?: IChangePasswordArgs;
 }
 
 /**
@@ -98,7 +133,8 @@ export interface INewTweet {
 	 * The text for the tweet to be created.
 	 *
 	 * @remarks
-	 * Length of the tweet must be \<= 280 characters.
+	 * Length of the tweet must be \<= 280 characters for non-premium accounts.
+	 * X Premium (Blue) accounts can post longer tweets (up to 25,000 characters).
 	 */
 	text?: string;
 }
@@ -140,3 +176,16 @@ export interface IUploadArgs {
 	 */
 	size?: number;
 }
+
+/**
+ * Arguments for changing the account password.
+ *
+ * @public
+ */
+export interface IChangePasswordArgs {
+	/** The current account password. */
+	currentPassword: string;
+
+	/** The new password to set. */
+	newPassword: string;
+}

package/src/types/data/Space.ts

@@ -0,0 +1,122 @@
+/**
+ * The details of a single Space.
+ *
+ * @public
+ */
+export interface ISpace {
+	/** The rest id of the space. */
+	id: string;
+
+	/** The current state of the space. */
+	state?: string;
+
+	/** The title of the space. */
+	title?: string;
+
+	/** The media key of the space. */
+	mediaKey?: string;
+
+	/** The creation date of the space. */
+	createdAt?: string;
+
+	/** The scheduled start time of the space. */
+	scheduledStart?: string;
+
+	/** The actual start time of the space. */
+	startedAt?: string;
+
+	/** The end time of the space. */
+	endedAt?: string;
+
+	/** The time at which the space was last updated. */
+	updatedAt?: string;
+
+	/** The id of the user who created the space. */
+	creatorId?: string;
+
+	/** The conversation controls value for the space. */
+	conversationControls?: number;
+
+	/** Whether joining the space is disallowed. */
+	disallowJoin?: boolean;
+
+	/** Whether the space is for employees only. */
+	isEmployeeOnly?: boolean;
+
+	/** Whether the space is locked. */
+	isLocked?: boolean;
+
+	/** Whether the space is muted. */
+	isMuted?: boolean;
+
+	/** Whether clipping is available for the space. */
+	isSpaceAvailableForClipping?: boolean;
+
+	/** Whether replay is available for the space. */
+	isSpaceAvailableForReplay?: boolean;
+
+	/** Whether incognito is disabled for the space. */
+	noIncognito?: boolean;
+
+	/** The total live listeners count for the space. */
+	totalLiveListeners?: number;
+
+	/** The total replay watched count for the space. */
+	totalReplayWatched?: number;
+
+	/** The total participant count reported in the response. */
+	participantCount?: number;
+
+	/** Whether the authenticated user is subscribed to the space. */
+	isSubscribed?: boolean;
+
+	/** The participants information for the space. */
+	participants?: ISpaceParticipants;
+}
+
+/**
+ * The participants of a Space grouped by roles.
+ *
+ * @public
+ */
+export interface ISpaceParticipants {
+	/** The total count of participants. */
+	total?: number;
+
+	/** The list of admins in the space. */
+	admins: ISpaceParticipant[];
+
+	/** The list of speakers in the space. */
+	speakers: ISpaceParticipant[];
+
+	/** The list of listeners in the space. */
+	listeners: ISpaceParticipant[];
+}
+
+/**
+ * The details of a single space participant.
+ *
+ * @public
+ */
+export interface ISpaceParticipant {
+	/** The rest id of the user. */
+	id?: string;
+
+	/** The screen name of the user. */
+	screenName?: string;
+
+	/** The display name of the user. */
+	displayName?: string;
+
+	/** The avatar URL of the user. */
+	avatarUrl?: string;
+
+	/** Whether the user is verified. */
+	isVerified?: boolean;
+
+	/** Whether the user is muted by admins. */
+	isMutedByAdmin?: boolean;
+
+	/** Whether the user is muted by guests. */
+	isMutedByGuest?: boolean;
+}

package/src/types/data/UserAbout.ts

@@ -0,0 +1,87 @@
+/**
+ * The about profile details of a single user.
+ *
+ * @public
+ */
+export interface IUserAbout {
+	/** The rest id of the user. */
+	id: string;
+
+	/** The username/screenname of the user. */
+	userName: string;
+
+	/** The full name of the user. */
+	fullName: string;
+
+	/** The creation date of user's account. */
+	createdAt: string;
+
+	/** The url of the profile image. */
+	profileImage: string;
+
+	/** The shape of the profile image. */
+	profileImageShape?: string;
+
+	/** Whether the account is verified or not. */
+	isVerified: boolean;
+
+	/** Whether the account is protected. */
+	isProtected?: boolean;
+
+	/** About profile details of the user. */
+	aboutProfile?: IUserAboutProfile;
+
+	/** Verification metadata of the user. */
+	verificationInfo?: IUserAboutVerificationInfo;
+}
+
+/**
+ * About profile information for a user.
+ *
+ * @public
+ */
+export interface IUserAboutProfile {
+	/** Whether the created country is accurate. */
+	createdCountryAccurate?: boolean;
+
+	/** The country where the account is based. */
+	accountBasedIn?: string;
+
+	/** Whether the location is accurate. */
+	locationAccurate?: boolean;
+
+	/** The help URL for verified accounts. */
+	learnMoreUrl?: string;
+
+	/** The source platform of the account. */
+	source?: string;
+
+	/** Username change metadata for the user. */
+	usernameChanges?: IUserAboutUsernameChanges;
+}
+
+/**
+ * Username change metadata for a user.
+ *
+ * @public
+ */
+export interface IUserAboutUsernameChanges {
+	/** The number of username changes. */
+	count?: number;
+
+	/** The last time the username was changed. */
+	lastChangedAt?: string;
+}
+
+/**
+ * Verification metadata for a user.
+ *
+ * @public
+ */
+export interface IUserAboutVerificationInfo {
+	/** Whether the user's identity is verified. */
+	isIdentityVerified?: boolean;
+
+	/** When the account was verified. */
+	verifiedSince?: string;
+}

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

@@ -9,27 +9,47 @@ import { ITweet } from './Tweet';
  *
  * @public
  */
-export interface ISpace {
+export interface IRawSpace {
 	rest_id: string;
-	state: string;
-	title: string;
-	media_key: string;
-	created_at: number;
-	started_at: number;
-	ended_at: string;
-	replay_start_time: number;
-	updated_at: number;
-	creator_results: IDataResult<IUser>;
-	conversation_controls: number;
-	disallow_join: boolean;
-	is_employee_only: boolean;
-	is_locked: boolean;
-	is_muted: boolean;
-	is_space_available_for_clipping: boolean;
-	is_space_available_for_replay: boolean;
-	narrow_cast_space_type: number;
-	no_incognito: boolean;
-	total_replay_watched: number;
-	total_live_listeners: number;
-	tweet_results: IDataResult<ITweet>;
+	state?: string;
+	title?: string;
+	media_key?: string;
+	content_type?: string;
+	created_at?: number | string;
+	scheduled_start?: number | string;
+	started_at?: number | string;
+	ended_at?: number | string;
+	replay_start_time?: number | string;
+	updated_at?: number | string;
+	creator_id?: string;
+	creator_results?: IDataResult<IUser>;
+	conversation_controls?: number;
+	disallow_join?: boolean;
+	is_employee_only?: boolean;
+	is_locked?: boolean;
+	is_muted?: boolean;
+	is_space_available_for_clipping?: boolean;
+	is_space_available_for_replay?: boolean;
+	narrow_cast_space_type?: number;
+	no_incognito?: boolean;
+	pending_admin_twitter_user_ids?: Array<{ rest_id?: string }>;
+	total_replay_watched?: number;
+	total_live_listeners?: number;
+	participant_count?: number;
+	subscriber_count?: number;
+	max_guest_sessions?: number;
+	max_admin_capacity?: number;
+	is_ticketed?: boolean | string;
+	lang?: string;
+	host_ids?: string[];
+	speaker_ids?: string[];
+	invited_user_ids?: string[];
+	topics?: IRawSpaceTopic[];
+	tweet_results?: IDataResult<ITweet>;
+}
+
+export interface IRawSpaceTopic {
+	id: string;
+	name: string;
+	description?: string;
 }

package/src/types/raw/space/AudioSpaceById.ts

@@ -0,0 +1,57 @@
+/* eslint-disable */
+
+import { IRawSpace } from '../base/Space';
+
+/**
+ * The raw data received when fetching the details of a given Space.
+ *
+ * @public
+ */
+export interface IAudioSpaceByIdResponse {
+	data?: {
+		audioSpace?: IAudioSpace;
+	};
+	errors?: unknown[];
+}
+
+export interface IAudioSpace {
+	metadata?: IRawSpace;
+	participants?: IAudioSpaceParticipants;
+	sharings?: IAudioSpaceSharings;
+	is_subscribed?: boolean;
+}
+
+export interface IAudioSpaceParticipants {
+	total?: number;
+	admins?: IAudioSpaceParticipant[];
+	speakers?: IAudioSpaceParticipant[];
+	listeners?: IAudioSpaceParticipant[];
+}
+
+export interface IAudioSpaceParticipant {
+	periscope_user_id?: string;
+	start?: number | string;
+	twitter_screen_name?: string;
+	display_name?: string;
+	avatar_url?: string;
+	is_verified?: boolean;
+	is_muted_by_admin?: boolean;
+	is_muted_by_guest?: boolean;
+	user_results?: {
+		rest_id?: string;
+		result?: {
+			__typename?: string;
+			rest_id?: string;
+			is_blue_verified?: boolean;
+			verification?: {
+				verified_type?: string;
+				verified?: boolean;
+			};
+		};
+	};
+}
+
+export interface IAudioSpaceSharings {
+	items?: unknown[];
+	slice_info?: unknown;
+}