rettiwt-api 6.0.8 → 6.1.0

package/src/services/public/ListService.ts

@@ -1,10 +1,14 @@
 import { Extractors } from '../../collections/Extractors';
 import { ResourceType } from '../../enums/Resource';
 import { CursoredData } from '../../models/data/CursoredData';
+import { List } from '../../models/data/List';
 import { Tweet } from '../../models/data/Tweet';
 import { User } from '../../models/data/User';
 import { RettiwtConfig } from '../../models/RettiwtConfig';
+import { IListMemberAddResponse } from '../../types/raw/list/AddMember';
+import { IListDetailsResponse } from '../../types/raw/list/Details';
 import { IListMembersResponse } from '../../types/raw/list/Members';
+import { IListMemberRemoveResponse } from '../../types/raw/list/RemoveMember';
 import { IListTweetsResponse } from '../../types/raw/list/Tweets';
 
 import { FetcherService } from './FetcherService';
@@ -19,6 +23,88 @@ export class ListService extends FetcherService {
 		super(config);
 	}
 
+	/**
+	 * Add a user as a member of a list.
+	 *
+	 * @param listId - The ID of the target list.
+	 * @param userId - The ID of the target user to be added as a member.
+	 *
+	 * @returns The new member count of the list. If adding 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 });
+	 *
+	 * // Adding a user with ID '123456789' as a member to the list with ID '987654321'
+	 * rettiwt.list.addMember('987654321', '123456789')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async addMember(listId: string, userId: string): Promise<number | undefined> {
+		const resource: ResourceType = ResourceType.LIST_MEMBER_ADD;
+
+		// Adding the user as a member
+		const response = await this.request<IListMemberAddResponse>(resource, {
+			id: listId,
+			userId: userId,
+		});
+
+		// Deserializing response
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
+	/**
+	 * Get the details of a list.
+	 *
+	 * @param id - The ID of the target list.
+	 *
+	 * @returns
+	 * The details of the target list.
+	 *
+	 * If list not found, returns undefined.
+	 *
+	 * @example
+	 *
+	 * #### Fetching the details of a list
+	 * ```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 details of the list with the id '1234567890'
+	 * rettiwt.list.details('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async details(id: string): Promise<List | undefined> {
+		const resource: ResourceType = ResourceType.LIST_DETAILS;
+
+		// Getting the details of the list
+		const response = await this.request<IListDetailsResponse>(resource, { id: id });
+
+		// Deserializing response
+		const data = Extractors[resource](response, id);
+
+		return data;
+	}
+
 	/**
 	 * Get the list of members of a tweet list.
 	 *
@@ -64,6 +150,47 @@ export class ListService extends FetcherService {
 		return data;
 	}
 
+	/**
+	 * Remove a member from a list.
+	 *
+	 * @param listId - The ID of the target list.
+	 * @param userId - The ID of the target user to removed from the members.
+	 *
+	 * @returns The new member count of the list. If removal 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 });
+	 *
+	 * // Removing a user with ID '123456789' from the member of the list with ID '987654321'
+	 * rettiwt.list.removeMember('987654321', '123456789')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async removeMember(listId: string, userId: string): Promise<number | undefined> {
+		const resource: ResourceType = ResourceType.LIST_MEMBER_REMOVE;
+
+		// Removing the member
+		const response = await this.request<IListMemberRemoveResponse>(resource, {
+			id: listId,
+			userId: userId,
+		});
+
+		// Deserializing response
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
 	/**
 	 * Get the list of tweets from a tweet list.
 	 *

package/src/services/public/TweetService.ts

@@ -12,6 +12,7 @@ import { ITweetFilter } from '../../types/args/FetchArgs';
 import { INewTweet } from '../../types/args/PostArgs';
 import { IMediaInitializeUploadResponse } from '../../types/raw/media/InitalizeUpload';
 
+import { ITweetBookmarkResponse } from '../../types/raw/tweet/Bookmark';
 import { ITweetDetailsResponse } from '../../types/raw/tweet/Details';
 import { ITweetDetailsBulkResponse } from '../../types/raw/tweet/DetailsBulk';
 import { ITweetLikeResponse } from '../../types/raw/tweet/Like';
@@ -22,6 +23,7 @@ import { ITweetRetweetResponse } from '../../types/raw/tweet/Retweet';
 import { ITweetRetweetersResponse } from '../../types/raw/tweet/Retweeters';
 import { ITweetScheduleResponse } from '../../types/raw/tweet/Schedule';
 import { ITweetSearchResponse } from '../../types/raw/tweet/Search';
+import { ITweetUnbookmarkResponse } from '../../types/raw/tweet/Unbookmark';
 import { ITweetUnlikeResponse } from '../../types/raw/tweet/Unlike';
 import { ITweetUnpostResponse } from '../../types/raw/tweet/Unpost';
 import { ITweetUnretweetResponse } from '../../types/raw/tweet/Unretweet';
@@ -44,6 +46,45 @@ export class TweetService extends FetcherService {
 		super(config);
 	}
 
+	/**
+	 * Bookmark a tweet.
+	 *
+	 * @param id - The ID of the tweet to be bookmarked.
+	 *
+	 * @returns Whether bookmarking was successful or not.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Bookmarking the Tweet with id '1234567890'
+	 * rettiwt.tweet.bookmark('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async bookmark(id: string): Promise<boolean> {
+		const resource = ResourceType.TWEET_BOOKMARK;
+
+		// Favoriting the tweet
+		const response = await this.request<ITweetBookmarkResponse>(resource, {
+			id: id,
+		});
+
+		// Deserializing response
+		const data = Extractors[resource](response) ?? false;
+
+		return data;
+	}
+
 	/**
 	 * Get the details of one or more tweets.
 	 *
@@ -315,6 +356,10 @@ export class TweetService extends FetcherService {
 	/**
 	 * Get the list of replies to a tweet.
 	 *
+	 * If the target tweet is a thread,
+	 * the first batch always contains all the tweets in the thread,
+	 * if `sortBy` is set to {@link TweetRepliesSortType.RELEVANCE}.
+	 *
 	 * @param id - The ID of the target tweet.
 	 * @param cursor - The cursor to the batch of replies to fetch.
 	 * @param sortBy - The sorting order of the replies to fetch. Default is {@link TweetRepliesSortType.RECENT}.
@@ -605,6 +650,43 @@ export class TweetService extends FetcherService {
 		}
 	}
 
+	/**
+	 * Unbookmark a tweet.
+	 *
+	 * @param id - The ID of the target tweet.
+	 *
+	 * @returns Whether unbookmarking was successful or not.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Unbookmarking the tweet with id '1234567890'
+	 * rettiwt.tweet.unbookmark('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async unbookmark(id: string): Promise<boolean> {
+		const resource = ResourceType.TWEET_UNBOOKMARK;
+
+		// Unliking the tweet
+		const response = await this.request<ITweetUnbookmarkResponse>(resource, { id: id });
+
+		// Deserializing the response
+		const data = Extractors[resource](response) ?? false;
+
+		return data;
+	}
+
 	/**
 	 * Unlike a tweet.
 	 *

package/src/services/public/UserService.ts

@@ -1,11 +1,15 @@
 import { Extractors } from '../../collections/Extractors';
+import { RawAnalyticsGranularity, RawAnalyticsMetric } from '../../enums/raw/Analytics';
 import { ResourceType } from '../../enums/Resource';
+import { Analytics } from '../../models/data/Analytics';
 import { CursoredData } from '../../models/data/CursoredData';
+import { List } from '../../models/data/List';
 import { Notification } from '../../models/data/Notification';
 import { Tweet } from '../../models/data/Tweet';
 import { User } from '../../models/data/User';
 import { RettiwtConfig } from '../../models/RettiwtConfig';
 import { IUserAffiliatesResponse } from '../../types/raw/user/Affiliates';
+import { IUserAnalyticsResponse } from '../../types/raw/user/Analytics';
 import { IUserBookmarksResponse } from '../../types/raw/user/Bookmarks';
 import { IUserDetailsResponse } from '../../types/raw/user/Details';
 import { IUserDetailsBulkResponse } from '../../types/raw/user/DetailsBulk';
@@ -15,6 +19,7 @@ import { IUserFollowersResponse } from '../../types/raw/user/Followers';
 import { IUserFollowingResponse } from '../../types/raw/user/Following';
 import { IUserHighlightsResponse } from '../../types/raw/user/Highlights';
 import { IUserLikesResponse } from '../../types/raw/user/Likes';
+import { IUserListsResponse } from '../../types/raw/user/Lists';
 import { IUserMediaResponse } from '../../types/raw/user/Media';
 import { IUserNotificationsResponse } from '../../types/raw/user/Notifications';
 import { IUserRecommendedResponse } from '../../types/raw/user/Recommended';
@@ -83,6 +88,64 @@ export class UserService extends FetcherService {
 		return data;
 	}
 
+	/**
+	 * Get the analytics overview of the logged in user.
+	 *
+	 * @param fromTime - The start time of the analytics period. Defaults to 7 days ago.
+	 * @param toTime - The end time of the analytics period. Defaults to now.
+	 * @param granularity - The granularity of the analytics data. Defaults to daily.
+	 * @param metrics - The metrics to include in the analytics data. Defaults to all available metrics available.
+	 * @param showVerifiedFollowers - Whether to include verified follower count and relationship counts in the response. Defaults to true.
+	 *
+	 * @returns The raw analytics data of the user.
+	 *
+	 * @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 analytics overview of the logged in user
+	 * rettiwt.user.analytics().then(res => {
+	 *  console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async analytics(
+		fromTime?: Date,
+		toTime?: Date,
+		granularity?: RawAnalyticsGranularity,
+		metrics?: RawAnalyticsMetric[],
+		showVerifiedFollowers?: boolean,
+	): Promise<Analytics> {
+		const resource = ResourceType.USER_ANALYTICS;
+
+		// Define default values if not provided
+		fromTime = fromTime ?? new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
+		toTime = toTime ?? new Date();
+		granularity = granularity ?? RawAnalyticsGranularity.DAILY;
+		metrics = metrics ?? Object.values(RawAnalyticsMetric);
+		showVerifiedFollowers = showVerifiedFollowers ?? true;
+
+		// Fetching raw analytics
+		const response = await this.request<IUserAnalyticsResponse>(resource, {
+			fromTime,
+			toTime,
+			granularity,
+			metrics,
+			showVerifiedFollowers,
+		});
+
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
 	/**
 	 * Get the list of bookmarks of the logged in user.
 	 *
@@ -165,8 +228,8 @@ export class UserService extends FetcherService {
 	 * // Creating a new Rettiwt instance using the given 'API_KEY'
 	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
 	 *
-	 * // Fetching the details of the User with username 'user1'
-	 * rettiwt.user.details('user1')
+	 * // Fetching the details of the User with username 'user1' or '@user1'
+	 * rettiwt.user.details('user1') // or @user1
 	 * .then(res => {
 	 * 	console.log(res);
 	 * })
@@ -243,6 +306,9 @@ export class UserService extends FetcherService {
 			// If username is given
 			if (id && isNaN(Number(id))) {
 				resource = ResourceType.USER_DETAILS_BY_USERNAME;
+				if (id?.startsWith('@')) {
+					id = id.slice(1);
+				}
 			}
 			// If id is given (or not, for self details)
 			else {
@@ -515,6 +581,48 @@ export class UserService extends FetcherService {
 		return data;
 	}
 
+	/**
+	 * Get the list of of the the logged in user. Includes both followed and owned.
+	 *
+	 * @param count - The number of lists to fetch, must be \<= 100.
+	 * @param cursor - The cursor to the batch of likes to fetch.
+	 *
+	 * @returns The list of tweets liked by the target user.
+	 *
+	 * @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 first 100 Lists of the logged in User
+	 * rettiwt.user.lists()
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async lists(count?: number, cursor?: string): Promise<CursoredData<List>> {
+		const resource = ResourceType.USER_LISTS;
+
+		// Fetching raw list of lists
+		const response = await this.request<IUserListsResponse>(resource, {
+			id: this.config.userId,
+			count: count,
+			cursor: cursor,
+		});
+
+		// Deserializing response
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
 	/**
 	 * Get the media timeline of a user.
 	 *

package/src/types/args/FetchArgs.ts

@@ -1,3 +1,4 @@
+import { RawAnalyticsGranularity, RawAnalyticsMetric } from '../../enums/raw/Analytics';
 import { TweetRepliesSortType } from '../../enums/Tweet';
 
 /**
@@ -6,21 +7,45 @@ import { TweetRepliesSortType } from '../../enums/Tweet';
  * @public
  */
 export interface IFetchArgs {
+	/**
+	 * The id of the active conversation.
+	 *
+	 * @remarks
+	 * - Required only for {@link ResourceType.DM_USER_UPDATES}.
+	 */
+	activeConversationId?: string;
+
+	/**
+	 * The maximum id of the data to fetch.
+	 *
+	 * @remarks
+	 * - May be used for {@link ResourceType.DM_INBOX_TIMELINE} and {@link ResourceType.DM_CONVERSATION}.
+	 */
+	maxId?: string;
+
+	/**
+	 * The id of the conversation to fetch.
+	 *
+	 * @remarks
+	 * - Required only for {@link ResourceType.DM_CONVERSATION} and {@link ResourceType.DM_DELETE_CONVERSATION}.
+	 */
+	conversationId?: string;
+
 	/**
 	 * The number of data items to fetch.
 	 *
 	 * @remarks
 	 * - Works only for cursored resources.
-	 * - Does not work for {@link EResourceType.TWEET_REPLIES}.
+	 * - Does not work for {@link ResourceType.TWEET_REPLIES}.
 	 * - Must be \<= 20 for:
-	 * 	- {@link EResourceType.USER_TIMELINE}
-	 * 	- {@link EResourceType.USER_TIMELINE}
-	 * 	- {@link EResourceType.USER_TIMELINE_AND_REPLIES}
+	 * 	- {@link ResourceType.USER_TIMELINE}
+	 * 	- {@link ResourceType.USER_TIMELINE}
+	 * 	- {@link ResourceType.USER_TIMELINE_AND_REPLIES}
 	 * - Must be \<= 100 for all other cursored resources.
-	 * - Due a bug on Twitter's end, count does not work for {@link EResourceType.USER_FOLLOWERS} and {@link EResourceType.USER_FOLLOWING}.
+	 * - Due a bug on Twitter's end, count does not work for {@link ResourceType.USER_FOLLOWERS} and {@link ResourceType.USER_FOLLOWING}.
 	 * - Has not effect for:
-	 * 	- {@link EResourceType.USER_FEED_FOLLOWED}
-	 * 	- {@link EResourceType.USER_FEED_RECOMMENDED}
+	 * 	- {@link ResourceType.USER_FEED_FOLLOWED}
+	 * 	- {@link ResourceType.USER_FEED_RECOMMENDED}
 	 */
 	count?: number;
 
@@ -37,7 +62,7 @@ export interface IFetchArgs {
 	 * The filter for searching tweets.
 	 *
 	 * @remarks
-	 * Required when searching for tweets using {@link EResourceType.TWEET_SEARCH}.
+	 * Required when searching for tweets using {@link ResourceType.TWEET_SEARCH}.
 	 */
 	filter?: ITweetFilter;
 
@@ -45,8 +70,8 @@ export interface IFetchArgs {
 	 * The id of the target resource.
 	 *
 	 * @remarks
-	 * - Required for all resources except {@link EResourceType.TWEET_SEARCH} and {@link EResourceType.USER_TIMELINE_RECOMMENDED}.
-	 * - For {@link EResourceType.USER_DETAILS_BY_USERNAME}, can be alphanumeric, while for others, is strictly numeric.
+	 * - Required for all resources except {@link ResourceType.TWEET_SEARCH} and {@link ResourceType.USER_TIMELINE_RECOMMENDED}.
+	 * - For {@link ResourceType.USER_DETAILS_BY_USERNAME}, can be alphanumeric, while for others, is strictly numeric.
 	 */
 	id?: string;
 
@@ -54,7 +79,7 @@ export interface IFetchArgs {
 	 * The IDs of the target resources.
 	 *
 	 * @remarks
-	 * - Required only for {@link EResourceType.TWEET_DETAILS_BULK} and {@link EResourceType.USER_DETAILS_BY_IDS_BULK}.
+	 * - Required only for {@link ResourceType.TWEET_DETAILS_BULK} and {@link ResourceType.USER_DETAILS_BY_IDS_BULK}.
 	 */
 	ids?: string[];
 
@@ -62,9 +87,49 @@ export interface IFetchArgs {
 	 * The sorting to use for tweet results.
 	 *
 	 * @remarks
-	 * - Only works for {@link EResourceType.TWEET_REPLIES}.
+	 * - Only works for {@link ResourceType.TWEET_REPLIES}.
 	 */
 	sortBy?: TweetRepliesSortType;
+
+	/**
+	 * The date to start fetching data from.
+	 *
+	 * @remarks
+	 * - Only works for {@link EResourceType.USER_ANALYTICS}.
+	 */
+	fromTime?: Date;
+
+	/**
+	 * The date to end fetching data at.
+	 *
+	 * @remarks
+	 * - Only works for {@link EResourceType.USER_ANALYTICS}.
+	 */
+	toTime?: Date;
+
+	/**
+	 * The granularity of the data to fetch.
+	 *
+	 * @remarks
+	 * - Only works for {@link EResourceType.USER_ANALYTICS}.
+	 */
+	granularity?: RawAnalyticsGranularity;
+
+	/**
+	 * The metrics to fetch.
+	 *
+	 * @remarks
+	 * - Only works for {@link EResourceType.USER_ANALYTICS}.
+	 */
+	metrics?: RawAnalyticsMetric[];
+
+	/**
+	 * Show the verified follower count and relationship counts in the response.
+	 *
+	 * @remarks
+	 * - Only works for {@link EResourceType.USER_ANALYTICS}.
+	 */
+	showVerifiedFollowers?: boolean;
 }
 
 /**

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[];
+}