rettiwt-api 5.0.0-alpha.3 → 5.0.0

package/dist/services/public/UserService.d.ts

@@ -16,6 +16,34 @@ export declare class UserService extends FetcherService {
      * @internal
      */
     constructor(config: RettiwtConfig);
+    /**
+     * Get the list affiliates of a user.
+     *
+     * @param id - The ID of the target user. If no id is provided, the logged-in user's id is used.
+     * @param count - The number of affiliates to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of affiliates to fetch.
+     *
+     * @returns The list of users affiliated to 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 affiliates of the User with id '1234567890'
+     * rettiwt.user.affiliates('1234567890')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     */
+    affiliates(id?: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
     /**
      * Get the list of bookmarks of the logged in user.
      *
@@ -25,7 +53,8 @@ export declare class UserService extends FetcherService {
      * @returns The list of tweets bookmarked by the target user.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -45,15 +74,19 @@ export declare class UserService extends FetcherService {
     /**
      * Get the details of a user.
      *
-     * @param id - The username/id(s) of the target user/users.
+     * @param id - The username/ID/IDs of the target user/users. If no ID is provided, the logged-in user's ID is used.
      *
      * @returns
      * The details of the given user.
+     *
+     * If more than one ID is provided, returns a list.
+     *
      * If no user matches the given id, returns `undefined`.
      *
      * @example
-     * Fetching the details using username
-     * ```
+     *
+     * #### Fetching the details of a single user using username
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -70,8 +103,9 @@ export declare class UserService extends FetcherService {
      * ```
      *
      * @example
-     * Fetching the details using id
-     * ```
+     *
+     * #### Fetching the details of a single user using ID
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -80,25 +114,44 @@ export declare class UserService extends FetcherService {
      * // Fetching the details of the User with id '1234567890'
      * rettiwt.user.details('1234567890')
      * .then(res => {
-     * 	console.log(res);
+     * 	console.log(res);	# 'res' is a single tweet
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     * * @example
+     *
+     * #### Fetching the details of multiple users
+     * ```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 users with IDs '123', '456', '789'
+     * rettiwt.user.details(['123', '456', '789'])
+     * .then(res => {
+     * 	console.log(res);	# 'res' is an array of users
      * })
      * .catch(err => {
      * 	console.log(err);
      * });
      * ```
      */
-    details<T extends string | string[]>(id: T): Promise<T extends string ? User | undefined : User[]>;
+    details<T extends string | string[] | undefined>(id: T): Promise<T extends string | undefined ? User | undefined : User[]>;
     /**
      * Follow a user.
      *
-     * @param id - The id the user to be followed.
+     * @param id - The ID the user to be followed.
      *
      * @returns Whether following was successful or not.
      *
      * @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'
@@ -123,7 +176,8 @@ export declare class UserService extends FetcherService {
      * @returns - The followed feed of the logged-in user.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -145,14 +199,15 @@ export declare class UserService extends FetcherService {
     /**
      * Get the list followers of a user.
      *
-     * @param id - The id of the target user.
+     * @param id - The ID of the target user. If no ID is provided, the logged-in user's ID is used.
      * @param count - The number of followers to fetch, must be \<= 100.
      * @param cursor - The cursor to the batch of followers to fetch.
      *
      * @returns The list of users following the target user.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -168,18 +223,19 @@ export declare class UserService extends FetcherService {
      * });
      * ```
      */
-    followers(id: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    followers(id?: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
     /**
      * Get the list of users who are followed by a user.
      *
-     * @param id - The id of the target user.
+     * @param id - The ID of the target user. If no ID is provided, the logged-in user's ID is used.
      * @param count - The number of following to fetch, must be \<= 100.
      * @param cursor - The cursor to the batch of following to fetch.
      *
      * @returns The list of users followed by the target user.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -195,18 +251,19 @@ export declare class UserService extends FetcherService {
      * });
      * ```
      */
-    following(id: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    following(id?: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
     /**
      * Get the highlighted tweets of a user.
      *
-     * @param id - The id of the target user.
+     * @param id - The ID of the target user. If no ID is provided, the logged-in user's ID is used.
      * @param count - The number of followers to fetch, must be \<= 100.
      * @param cursor - The cursor to the batch of followers to fetch.
      *
      * @returns The list of highlighted tweets of the target user.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -232,7 +289,8 @@ export declare class UserService extends FetcherService {
      * @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'
@@ -252,14 +310,15 @@ export declare class UserService extends FetcherService {
     /**
      * Get the media timeline of a user.
      *
-     * @param id - The id of the target user.
+     * @param id - The ID of the target user. If no ID is provided, the logged-in user's ID is used.
      * @param count - The number of media to fetch, must be \<= 100.
      * @param cursor - The cursor to the batch of media to fetch
      *
      * @returns The media timeline of the target user.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -275,7 +334,7 @@ export declare class UserService extends FetcherService {
      * });
      * ```
      */
-    media(id: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+    media(id?: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
     /**
      * Stream notifications of the logged in user in pseudo real-time.
      *
@@ -284,7 +343,8 @@ export declare class UserService extends FetcherService {
      * @returns An async generator that yields new notifications as they are received.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -294,7 +354,7 @@ export declare class UserService extends FetcherService {
      * async function streamNotifications() {
      * 	try {
      * 		// Awaiting for the notifications returned by the AsyncGenerator returned by the method
-     * 		for await (const notification of rettiwt.user.notifications(1000)) {
+     * 		for await (const notification of rettiwt.user.notifications(5000)) {
      * 			console.log(notification.message);
      * 		}
      * 	}
@@ -316,7 +376,8 @@ export declare class UserService extends FetcherService {
      * @returns - The recommended feed of the logged-in user.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -338,14 +399,15 @@ export declare class UserService extends FetcherService {
     /**
      * Get the reply timeline of a user.
      *
-     * @param id - The id of the target user.
+     * @param id - The ID of the target user. If no ID is provided, the logged-in user's ID is used.
      * @param count - The number of replies to fetch, must be \<= 20.
      * @param cursor - The cursor to the batch of replies to fetch.
      *
      * @returns The reply timeline of the target user.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -361,20 +423,25 @@ export declare class UserService extends FetcherService {
      * });
      * ```
      *
-     * @remarks If the target user has a pinned tweet, the returned reply timeline has one item extra and this is always the pinned tweet.
+     * @remarks
+     *
+     * If the target user has a pinned tweet, the returned reply timeline has one item extra and this is always the pinned tweet.
      */
-    replies(id: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+    replies(id?: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
     /**
      * Get the list of subscriptions of a user.
      *
-     * @param id - The id of the target user.
+     * @deprecated Currently not working.
+     *
+     * @param id - The ID of the target user. If no ID is provided, the logged-in user's ID is used.
      * @param count - The number of subscriptions to fetch, must be \<= 100.
      * @param cursor - The cursor to the batch of subscriptions to fetch.
      *
      * @returns The list of subscriptions by the target user.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -394,14 +461,15 @@ export declare class UserService extends FetcherService {
     /**
      * Get the tweet timeline of a user.
      *
-     * @param id - The id of the target user.
+     * @param id - The ID of the target user. If no ID is provided, the logged-in user's ID is used.
      * @param count - The number of timeline items to fetch, must be \<= 20.
      * @param cursor - The cursor to the batch of timeline items to fetch.
      *
      * @returns The timeline of the target user.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -418,6 +486,7 @@ export declare class UserService extends FetcherService {
      * ```
      *
      * @remarks
+     *
      * - If the target user has a pinned tweet, the returned timeline has one item extra and this is always the pinned tweet.
      * - If timeline is fetched without authenticating, then the most popular tweets of the target user are returned instead.
      */
@@ -425,14 +494,13 @@ export declare class UserService extends FetcherService {
     /**
      * Unfollow a user.
      *
-     * @param id - The id the user to be unfollowed.
+     * @param id - The ID the user to be unfollowed.
      *
      * @returns Whether unfollowing was successful or not.
      *
-     * @throws Code 34 if given user id is invalid.
-     *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'