rettiwt-api 6.3.0-alpha.0 → 7.0.0

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

@@ -0,0 +1,89 @@
+/**
+ * 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/dist/types/data/Space.js

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

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

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

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

@@ -0,0 +1,68 @@
+/**
+ * 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/dist/types/data/UserAbout.js

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

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

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

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

@@ -6,27 +6,48 @@ 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/dist/types/raw/space/AudioSpaceById.d.ts

@@ -0,0 +1,50 @@
+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;
+}

package/dist/types/raw/space/AudioSpaceById.js

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

package/dist/types/raw/space/AudioSpaceById.js.map

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

package/dist/types/raw/space/Details.d.ts

@@ -1,315 +1,8 @@
+import { IRawSpace } from '../base/Space';
 /**
  * The raw data received when fetching the details of a given space.
  *
  * @public
  */
-export interface ISpaceDetailsResponse {
-    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: CreatorResults;
-    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: TweetResults;
+export interface ISpaceDetailsResponse extends IRawSpace {
 }
-interface CreatorResults {
-    result: Result;
-}
-interface Result {
-    __typename: string;
-    id: string;
-    rest_id: string;
-    affiliates_highlighted_label: AffiliatesHighlightedLabel;
-    has_graduated_access: boolean;
-    is_blue_verified: boolean;
-    profile_image_shape: string;
-    legacy: Legacy;
-    professional: Professional;
-    verified_phone_status: boolean;
-}
-interface AffiliatesHighlightedLabel {
-    label: Label;
-}
-interface Label {
-    url: Url;
-    badge: Badge;
-    description: string;
-    userLabelType: string;
-    userLabelDisplayType: string;
-}
-interface Url {
-    url: string;
-    urlType: string;
-}
-interface Badge {
-    url: string;
-}
-interface Legacy {
-    can_dm: boolean;
-    can_media_tag: boolean;
-    created_at: string;
-    default_profile: boolean;
-    default_profile_image: boolean;
-    description: string;
-    entities: Entities;
-    fast_followers_count: number;
-    favourites_count: number;
-    followers_count: number;
-    friends_count: number;
-    has_custom_timelines: boolean;
-    is_translator: boolean;
-    listed_count: number;
-    location: string;
-    media_count: number;
-    name: string;
-    normal_followers_count: number;
-    pinned_tweet_ids_str: string[];
-    possibly_sensitive: boolean;
-    profile_banner_url: string;
-    profile_image_url_https: string;
-    profile_interstitial_type: string;
-    screen_name: string;
-    statuses_count: number;
-    translator_type: string;
-    url: string;
-    verified: boolean;
-    want_retweets: boolean;
-    withheld_in_countries: any[];
-}
-interface Entities {
-    description: Description;
-    url: Url2;
-}
-interface Description {
-    urls: any[];
-}
-interface Url2 {
-    urls: Url3[];
-}
-interface Url3 {
-    display_url: string;
-    expanded_url: string;
-    url: string;
-    indices: number[];
-}
-interface Professional {
-    rest_id: string;
-    professional_type: string;
-    category: Category[];
-}
-interface Category {
-    id: number;
-    name: string;
-    icon_name: string;
-}
-interface TweetResults {
-    result: Result2;
-}
-interface Result2 {
-    __typename: string;
-    rest_id: string;
-    core: Core;
-    card: Card;
-    voiceInfo: VoiceInfo;
-    unmention_data: UnmentionData;
-    unified_card: UnifiedCard;
-    edit_control: EditControl;
-    is_translatable: boolean;
-    views: Views;
-    source: string;
-    legacy: Legacy4;
-}
-interface Core {
-    user_results: UserResults;
-}
-interface UserResults {
-    result: Result3;
-}
-interface Result3 {
-    __typename: string;
-    id: string;
-    rest_id: string;
-    affiliates_highlighted_label: AffiliatesHighlightedLabel2;
-    has_graduated_access: boolean;
-    is_blue_verified: boolean;
-    profile_image_shape: string;
-    legacy: Legacy2;
-    professional: Professional2;
-    verified_phone_status: boolean;
-}
-interface AffiliatesHighlightedLabel2 {
-    label: Label2;
-}
-interface Label2 {
-    url: Url4;
-    badge: Badge2;
-    description: string;
-    userLabelType: string;
-    userLabelDisplayType: string;
-}
-interface Url4 {
-    url: string;
-    urlType: string;
-}
-interface Badge2 {
-    url: string;
-}
-interface Legacy2 {
-    can_dm: boolean;
-    can_media_tag: boolean;
-    created_at: string;
-    default_profile: boolean;
-    default_profile_image: boolean;
-    description: string;
-    entities: Entities2;
-    fast_followers_count: number;
-    favourites_count: number;
-    followers_count: number;
-    friends_count: number;
-    has_custom_timelines: boolean;
-    is_translator: boolean;
-    listed_count: number;
-    location: string;
-    media_count: number;
-    name: string;
-    normal_followers_count: number;
-    pinned_tweet_ids_str: string[];
-    possibly_sensitive: boolean;
-    profile_banner_url: string;
-    profile_image_url_https: string;
-    profile_interstitial_type: string;
-    screen_name: string;
-    statuses_count: number;
-    translator_type: string;
-    url: string;
-    verified: boolean;
-    want_retweets: boolean;
-    withheld_in_countries: any[];
-}
-interface Entities2 {
-    description: Description2;
-    url: Url5;
-}
-interface Description2 {
-    urls: any[];
-}
-interface Url5 {
-    urls: Url6[];
-}
-interface Url6 {
-    display_url: string;
-    expanded_url: string;
-    url: string;
-    indices: number[];
-}
-interface Professional2 {
-    rest_id: string;
-    professional_type: string;
-    category: Category2[];
-}
-interface Category2 {
-    id: number;
-    name: string;
-    icon_name: string;
-}
-interface Card {
-    rest_id: string;
-    legacy: Legacy3;
-}
-interface Legacy3 {
-    binding_values: BindingValue[];
-    card_platform: CardPlatform;
-    name: string;
-    url: string;
-    user_refs_results: any[];
-}
-interface BindingValue {
-    key: string;
-    value: Value;
-}
-interface Value {
-    string_value: string;
-    type: string;
-    scribe_key?: string;
-}
-interface CardPlatform {
-    platform: Platform;
-}
-interface Platform {
-    audience: Audience;
-    device: Device;
-}
-interface Audience {
-    name: string;
-}
-interface Device {
-    name: string;
-    version: string;
-}
-interface VoiceInfo {
-}
-interface UnmentionData {
-}
-interface UnifiedCard {
-    card_fetch_state: string;
-}
-interface EditControl {
-    edit_tweet_ids: string[];
-    editable_until_msecs: string;
-    is_edit_eligible: boolean;
-    edits_remaining: string;
-}
-interface Views {
-    count: string;
-    state: string;
-}
-interface Legacy4 {
-    bookmark_count: number;
-    bookmarked: boolean;
-    created_at: string;
-    conversation_id_str: string;
-    display_text_range: number[];
-    entities: Entities3;
-    favorite_count: number;
-    favorited: boolean;
-    full_text: string;
-    is_quote_status: boolean;
-    lang: string;
-    possibly_sensitive: boolean;
-    possibly_sensitive_editable: boolean;
-    quote_count: number;
-    reply_count: number;
-    retweet_count: number;
-    retweeted: boolean;
-    user_id_str: string;
-    id_str: string;
-}
-interface Entities3 {
-    hashtags: any[];
-    symbols: any[];
-    timestamps: any[];
-    urls: Url7[];
-    user_mentions: any[];
-}
-interface Url7 {
-    display_url: string;
-    expanded_url: string;
-    url: string;
-    indices: number[];
-}
-export {};

package/dist/types/raw/tweet/Post.d.ts

@@ -7,7 +7,8 @@ export interface ITweetPostResponse {
     data: Data;
 }
 interface Data {
-    create_tweet: CreateTweet;
+    create_tweet?: CreateTweet;
+    create_note_tweet?: CreateTweet;
 }
 interface CreateTweet {
     tweet_results: TweetResults;
@@ -130,4 +131,18 @@ interface UserMention {
 }
 interface UnmentionInfo {
 }
+/**
+ * The raw data received after creating a note tweet (long-form tweet for X Premium accounts).
+ *
+ * @public
+ */
+export interface ITweetPostNoteResponse {
+    data: NoteTweetData;
+}
+interface NoteTweetData {
+    notetweet_create: NoteTweetCreate;
+}
+interface NoteTweetCreate {
+    tweet_results: TweetResults;
+}
 export {};