@youmind-openlab/rettiwt-api 1.0.0

package/dist/types/data/Conversation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Conversation.js","sourceRoot":"","sources":["../../../src/types/data/Conversation.ts"],"names":[],"mappings":""}

package/dist/types/data/CursoredData.d.ts

@@ -0,0 +1,20 @@
+import { IBookmarkFolder } from './BookmarkFolder';
+import { IConversation } from './Conversation';
+import { IDirectMessage } from './DirectMessage';
+import { IList } from './List';
+import { INotification } from './Notification';
+import { ITweet } from './Tweet';
+import { IUser } from './User';
+/**
+ * The data that is fetched batch-wise using a cursor.
+ *
+ * @typeParam T - Type of data to be stored.
+ *
+ * @public
+ */
+export interface ICursoredData<T extends IDirectMessage | IConversation | INotification | ITweet | IUser | IList | IBookmarkFolder> {
+    /** The batch of data of the given type. */
+    list: T[];
+    /** The cursor to the next batch of data. */
+    next: string;
+}

package/dist/types/data/CursoredData.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=CursoredData.js.map

package/dist/types/data/CursoredData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CursoredData.js","sourceRoot":"","sources":["../../../src/types/data/CursoredData.ts"],"names":[],"mappings":""}

package/dist/types/data/DirectMessage.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The details of a single direct message.
+ *
+ * @public
+ */
+export interface IDirectMessage {
+    /** The unique identifier of the message. */
+    id: string;
+    /** The ID of the conversation this message belongs to. */
+    conversationId: string;
+    /** The ID of the user who sent the message. */
+    senderId: string;
+    /** The ID of the user who received the message (for one-to-one conversations). */
+    recipientId?: string;
+    /** The text content of the message. */
+    text: string;
+    /** The timestamp when the message was sent (ISO 8601 format). */
+    createdAt: string;
+    /** Array of media URLs attached to the message. */
+    mediaUrls?: string[];
+    /** Number of times the message has been edited. */
+    editCount?: number;
+    /** Whether the message has been read. */
+    read?: boolean;
+}

package/dist/types/data/DirectMessage.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DirectMessage.js.map

package/dist/types/data/DirectMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DirectMessage.js","sourceRoot":"","sources":["../../../src/types/data/DirectMessage.ts"],"names":[],"mappings":""}

package/dist/types/data/Inbox.d.ts

@@ -0,0 +1,18 @@
+import { IConversation } from './Conversation';
+/**
+ * The details of a DM inbox containing conversations and metadata.
+ *
+ * @public
+ */
+export interface IInbox {
+    /** List of conversations in the inbox. */
+    conversations: IConversation[];
+    /** The cursor for pagination of conversations. */
+    cursor: string;
+    /** The ID of the last seen event. */
+    lastSeenEventId: string;
+    /** The ID of the last seen trusted event. */
+    trustedLastSeenEventId: string;
+    /** The ID of the last seen untrusted event. */
+    untrustedLastSeenEventId: string;
+}

package/dist/types/data/Inbox.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Inbox.js.map

package/dist/types/data/Inbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Inbox.js","sourceRoot":"","sources":["../../../src/types/data/Inbox.ts"],"names":[],"mappings":""}

package/dist/types/data/List.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The details of a single Twitter List.
+ *
+ * @public
+ */
+export interface IList {
+    /** The date and time of creation of the list, int UTC string format. */
+    createdAt: string;
+    /** The ID of the user who created the list. */
+    createdBy: string;
+    /** The list description. */
+    description?: string;
+    /** Whether the user is following the list or not. */
+    isFollowing: boolean;
+    /** The rest id of the list. */
+    id: string;
+    /** Whether the user is a member of the list or not. */
+    isMember: boolean;
+    /** The number of memeber of the list. */
+    memberCount: number;
+    /** The name of the list. */
+    name: string;
+    /** The number of subscribers of the list. */
+    subscriberCount: number;
+}

package/dist/types/data/List.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=List.js.map

package/dist/types/data/List.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../src/types/data/List.ts"],"names":[],"mappings":""}

package/dist/types/data/Notification.d.ts

@@ -0,0 +1,20 @@
+import { NotificationType } from '../../enums/Notification';
+/**
+ * The details of a single notification.
+ *
+ * @public
+ */
+export interface INotification {
+    /** The list of id of the users from whom the notification was received. */
+    from: string[];
+    /** The id of the notification. */
+    id: string;
+    /** The text contents of the notification. */
+    message: string;
+    /** The date/time at which the notification was received. */
+    receivedAt: string;
+    /** The list of id of the target tweet(s) of the notification. */
+    target: string[];
+    /** The type of notification. */
+    type?: NotificationType;
+}

package/dist/types/data/Notification.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Notification.js.map

package/dist/types/data/Notification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Notification.js","sourceRoot":"","sources":["../../../src/types/data/Notification.ts"],"names":[],"mappings":""}

package/dist/types/data/Tweet.d.ts

@@ -0,0 +1,73 @@
+import { MediaType } from '../../enums/Media';
+import { IUser } from './User';
+/**
+ * The details of a single tweet.
+ *
+ * @public
+ */
+export interface ITweet {
+    /** The number of bookmarks of a tweet. */
+    bookmarkCount?: number;
+    /** The ID of tweet which started the current conversation. */
+    conversationId: string;
+    /** The creation date of the tweet. */
+    createdAt: string;
+    /** Additional tweet entities like urls, mentions, etc. */
+    entities: ITweetEntities;
+    /** The full text content of the tweet. */
+    fullText: string;
+    /** The rest id of the tweet. */
+    id: string;
+    /** The language in which the tweet is written. */
+    lang: string;
+    /** The number of likes of the tweet. */
+    likeCount?: number;
+    /** The urls of the media contents of the tweet (if any). */
+    media?: ITweetMedia[];
+    /** The number of quotes of the tweet. */
+    quoteCount?: number;
+    /** The tweet which is quoted in the tweet. */
+    quoted?: ITweet;
+    /** The number of replies to the tweet. */
+    replyCount?: number;
+    /** The rest id of the tweet to which the tweet is a reply. */
+    replyTo?: string;
+    /** The number of retweets of the tweet. */
+    retweetCount?: number;
+    /** The tweet which is retweeted in this tweet (if any). */
+    retweetedTweet?: ITweet;
+    /** The details of the user who made the tweet. */
+    tweetBy: IUser;
+    /** The URL to the tweet. */
+    url: string;
+    /** The number of views of a tweet. */
+    viewCount?: number;
+}
+/**
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ *
+ * @public
+ */
+export interface ITweetEntities {
+    /** The list of hashtags mentioned in the tweet. */
+    hashtags: string[];
+    /** The list of IDs of users mentioned in the tweet. */
+    mentionedUsers: string[];
+    /** The list of urls mentioned in the tweet. */
+    urls: string[];
+}
+/**
+ * The details of a single media content included in a tweet.
+ *
+ * @public
+ */
+export interface ITweetMedia {
+    /** The ID of the media. */
+    id: string;
+    /** The thumbnail URL for the video content of the tweet. */
+    thumbnailUrl?: string;
+    /** The type of media. */
+    type: MediaType;
+    /** The direct URL to the media. */
+    url: string;
+}

package/dist/types/data/Tweet.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Tweet.js.map

package/dist/types/data/Tweet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tweet.js","sourceRoot":"","sources":["../../../src/types/data/Tweet.ts"],"names":[],"mappings":""}

package/dist/types/data/User.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The details of a single user.
+ *
+ * @public
+ */
+export interface IUser {
+    /** The creation date of user's account. */
+    createdAt: string;
+    /** The user's description. */
+    description?: string;
+    /** The number of followers of the user. */
+    followersCount: number;
+    /** The number of following of the user. */
+    followingsCount: number;
+    /** The full name of the user. */
+    fullName: string;
+    /** The rest id of the user. */
+    id: string;
+    /** Whether the user is being followed by the logged-in user. Available only when logged in. */
+    isFollowed?: boolean;
+    /** Whether the user is following the logged-in user. Available only when logged in. */
+    isFollowing?: boolean;
+    /** Whether the account is verified or not. */
+    isVerified: boolean;
+    /** The number of tweets liked by the user. */
+    likeCount: number;
+    /** The location of user as provided by user. */
+    location?: string;
+    /** The rest id of the tweet pinned in the user's profile. */
+    pinnedTweet?: string;
+    /** The url of the profile banner image. */
+    profileBanner?: string;
+    /** The url of the profile image. */
+    profileImage: string;
+    /** The number of tweets made by the user. */
+    statusesCount: number;
+    /** The username/screenname of the user. */
+    userName: string;
+}

package/dist/types/data/User.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=User.js.map

package/dist/types/data/User.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../src/types/data/User.ts"],"names":[],"mappings":""}

package/dist/types/errors/TwitterError.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The error thrown by Twitter API.
+ *
+ * @public
+ */
+export interface ITwitterError extends Error {
+    /** The details of each error. */
+    details: ITwitterErrorDetails[];
+    /** The error message in the response. */
+    message: string;
+    /** The name of the error response. */
+    name: string;
+    /** The response status code. */
+    status: number;
+}
+/**
+ * The error details.
+ *
+ * @public
+ */
+export interface ITwitterErrorDetails {
+    /** The internal error code. */
+    code: number;
+    /** The message associated with the error. */
+    message: string;
+    /** The name of the error. */
+    name?: string;
+    /** The type of error. */
+    type?: string;
+}

package/dist/types/errors/TwitterError.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TwitterError.js.map

package/dist/types/errors/TwitterError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TwitterError.js","sourceRoot":"","sources":["../../../src/types/errors/TwitterError.ts"],"names":[],"mappings":""}

package/dist/types/params/Variables.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Media to be sent as payload.
+ *
+ * @internal
+ */
+export interface IMediaVariable {
+    media_entities: IMediaEntityVariable[];
+    possibly_sensitive: boolean;
+}
+/**
+ * Each media item in the media payload.
+ *
+ * @internal
+ */
+export interface IMediaEntityVariable {
+    media_id: string;
+    tagged_users: string[];
+}
+/**
+ * Reply specific details to be sent in payload.
+ *
+ * @internal
+ */
+export interface IReplyVariable {
+    exclude_reply_user_ids: string[];
+    in_reply_to_tweet_id: string;
+}

package/dist/types/params/Variables.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Variables.js.map

package/dist/types/params/Variables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Variables.js","sourceRoot":"","sources":["../../../src/types/params/Variables.ts"],"names":[],"mappings":""}

package/dist/types/raw/base/Analytic.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Represents the raw data of the analytic result of the User.
+ *
+ * @public
+ */
+export interface IAnalytics {
+    __typename: string;
+    organic_metrics_time_series: IAnalyticsMetric[];
+    verified_follower_count: string;
+    relationship_counts: IAnalyticsRelationships;
+    id: string;
+}
+export interface IAnalyticsRelationships {
+    followers: number;
+}
+export interface IAnalyticsMetric {
+    metric_values: IAnalyticsMetricValue[];
+    timestamp: IAnalyticsTimeStamp;
+}
+export interface IAnalyticsMetricValue {
+    metric_value: number;
+    metric_type: string;
+}
+export interface IAnalyticsTimeStamp {
+    iso8601_time: string;
+}

package/dist/types/raw/base/Analytic.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Analytic.js.map

package/dist/types/raw/base/Analytic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Analytic.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Analytic.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/BookmarkFolder.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Represents the raw data of a single BookmarkFolder.
+ *
+ * @public
+ */
+export interface IBookmarkFolder {
+    /** The unique identifier for the folder. */
+    id: string;
+    /** The display name of the folder. */
+    name: string;
+}

package/dist/types/raw/base/BookmarkFolder.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=BookmarkFolder.js.map

package/dist/types/raw/base/BookmarkFolder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BookmarkFolder.js","sourceRoot":"","sources":["../../../../src/types/raw/base/BookmarkFolder.ts"],"names":[],"mappings":""}

package/dist/types/raw/base/Cursor.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Represents a cursor object used for pagination.
+ *
+ * @public
+ */
+export interface ICursor {
+    entryType: string;
+    __typename: string;
+    value: string;
+    cursorType: string;
+}

package/dist/types/raw/base/Cursor.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Cursor.js.map

package/dist/types/raw/base/Cursor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cursor.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Cursor.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/Error.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Error details for multiple errors.
+ *
+ * @public
+ */
+export interface IErrorData {
+    data: unknown;
+    errors: IErrorDetails[];
+}
+/**
+ * Error details of a single error.
+ *
+ * @public
+ */
+export interface IErrorDetails {
+    message: string;
+    extensions?: IErrorExtensions;
+    code: number;
+    kind?: string;
+    name?: string;
+    source?: string;
+    tracing?: IErrorTracing;
+}
+export interface IErrorExtensions {
+    name: string;
+    source: string;
+    code: number;
+    kind: string;
+    tracing: IErrorTracing;
+}
+export interface IErrorTracing {
+    trace_id: string;
+}

package/dist/types/raw/base/Error.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Error.js.map

package/dist/types/raw/base/Error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Error.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/LimitedVisibilityTweet.d.ts

@@ -0,0 +1,32 @@
+import { ITweet } from './Tweet';
+/**
+ * Represents the raw data of a single Tweet with limited visibility actions.
+ *
+ * @public
+ */
+export interface ILimitedVisibilityTweet {
+    __typename: string;
+    tweet: ITweet;
+    limitedActionResults: ITweetLimitedActionResults;
+}
+export interface ITweetLimitedActionResults {
+    limited_actions: ITweetLimitedAction[];
+}
+export interface ITweetLimitedAction {
+    action: string;
+    prompt: ILimitedActionPrompt;
+}
+export interface ILimitedActionPrompt {
+    __typename: string;
+    cta_type: string;
+    headline: IPromptHeadline;
+    subtext: IPromptSubtext;
+}
+export interface IPromptHeadline {
+    text: string;
+    entities: any[];
+}
+export interface IPromptSubtext {
+    text: string;
+    entities: any[];
+}

package/dist/types/raw/base/LimitedVisibilityTweet.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LimitedVisibilityTweet.js.map

package/dist/types/raw/base/LimitedVisibilityTweet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LimitedVisibilityTweet.js","sourceRoot":"","sources":["../../../../src/types/raw/base/LimitedVisibilityTweet.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/List.d.ts

@@ -0,0 +1,43 @@
+import { IDataResult } from '../composite/DataResult';
+import { IUser } from './User';
+/**
+ * Represents the raw data of a single List.
+ *
+ * @public
+ */
+export interface IList {
+    created_at: number;
+    default_banner_media: IDefaultBannerMedia;
+    default_banner_media_results: IDefaultBannerMediaResults;
+    description: string;
+    following: boolean;
+    id: string;
+    id_str: string;
+    is_member: boolean;
+    member_count: number;
+    mode: string;
+    muting: boolean;
+    name: string;
+    subscriber_count: number;
+    user_results: IDataResult<IUser>;
+    facepile_urls: string[];
+    followers_context: string;
+    members_context: string;
+}
+export interface IDefaultBannerMedia {
+    media_info: IBannerMediaInfo;
+}
+export interface IDefaultBannerMediaResults {
+    result: IBannerMediaResult;
+}
+export interface IBannerMediaResult {
+    id: string;
+    media_key: string;
+    media_id: string;
+    media_info: IBannerMediaInfo;
+}
+export interface IBannerMediaInfo {
+    original_img_url: string;
+    original_img_width: number;
+    original_img_height: number;
+}

package/dist/types/raw/base/List.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=List.js.map

package/dist/types/raw/base/List.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../../src/types/raw/base/List.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/Media.d.ts

@@ -0,0 +1,43 @@
+import { RawMediaType } from '../../../enums/raw/Media';
+/**
+ * Represents the raw data of a single Media.
+ *
+ * @public
+ */
+export interface IMedia {
+    display_url: string;
+    expanded_url: string;
+    id_str: string;
+    media_url_https: string;
+    type: RawMediaType;
+    url: string;
+}
+export interface IExtendedMedia extends IMedia {
+    media_key: string;
+    ext_media_availability: IMediaAvailability;
+    additional_media_info?: IAdditionalMediaInfo;
+    mediaStats?: IMediaStats;
+    video_info?: IVideoInfo;
+}
+export interface IMediaAvailability {
+    status: string;
+}
+export interface IAdditionalMediaInfo {
+    monetizable: boolean;
+}
+export interface IMediaStats {
+    viewCount: number;
+}
+export interface IMediaAvailability {
+    status: string;
+}
+export interface IVideoInfo {
+    aspect_ratio: number[];
+    duration_millis: number;
+    variants: IVideoVariant[];
+}
+export interface IVideoVariant {
+    bitrate: number;
+    content_type: string;
+    url: string;
+}

package/dist/types/raw/base/Media.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Media.js.map

package/dist/types/raw/base/Media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Media.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Media.ts"],"names":[],"mappings":";AAAA,oBAAoB"}