x-twitter-scraper 0.12.3 → 0.13.0

package/src/resources/x/bookmarks.ts

@@ -14,7 +14,8 @@ import { RequestOptions } from '../../internal/request-options';
  */
 export class Bookmarks extends APIResource {
   /**
-   * Get bookmarked tweets
+   * Returns your X account's bookmarks, else 424 `account_required`. A folder needs
+   * X Premium, else 424 `bookmark_folders_unavailable`.
    *
    * @example
    * ```ts
@@ -29,15 +30,19 @@ export class Bookmarks extends APIResource {
   }
 
   /**
-   * Get bookmark folders
+   * Returns your X account's bookmark folders, else 424 `account_required`. Folders
+   * need X Premium, else 424 `bookmark_folders_unavailable`.
    *
    * @example
    * ```ts
    * const response = await client.x.bookmarks.retrieveFolders();
    * ```
    */
-  retrieveFolders(options?: RequestOptions): APIPromise<BookmarkRetrieveFoldersResponse> {
-    return this._client.get('/x/bookmarks/folders', options);
+  retrieveFolders(
+    query: BookmarkRetrieveFoldersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BookmarkRetrieveFoldersResponse> {
+    return this._client.get('/x/bookmarks/folders', { query, ...options });
   }
 }
 
@@ -45,39 +50,128 @@ export interface BookmarkRetrieveFoldersResponse {
   folders: Array<BookmarkRetrieveFoldersResponse.Folder>;
 
   /**
-   * Always false for the current bookmark folder route
+   * Whether another folder page is available
    */
   has_next_page: boolean;
 
   /**
-   * Always empty for the current bookmark folder route
+   * Cursor for the next folder page
    */
   next_cursor: string;
 }
 
 export namespace BookmarkRetrieveFoldersResponse {
+  /**
+   * Bookmark folder and its optional public cover image.
+   */
   export interface Folder {
+    /**
+     * Folder ID.
+     */
     id: string;
 
-    name: string;
+    /**
+     * Public folder cover image metadata.
+     */
+    media?: Folder.Media;
+
+    /**
+     * Folder name.
+     */
+    name?: string;
+  }
+
+  export namespace Folder {
+    /**
+     * Public folder cover image metadata.
+     */
+    export interface Media {
+      /**
+       * Media object ID.
+       */
+      id?: string;
+
+      /**
+       * Media ID.
+       */
+      mediaId?: string;
+
+      /**
+       * Stable media key.
+       */
+      mediaKey?: string;
+
+      /**
+       * Original image height.
+       */
+      originalImageHeight?: number;
+
+      /**
+       * Original image URL.
+       */
+      originalImageUrl?: string;
+
+      /**
+       * Original image width.
+       */
+      originalImageWidth?: number;
+
+      /**
+       * Dominant image colors and their proportions.
+       */
+      palette?: Array<Media.Palette>;
+
+      /**
+       * Media object type.
+       */
+      type?: string;
+    }
+
+    export namespace Media {
+      export interface Palette {
+        percentage?: number;
+
+        rgb?: Palette.Rgb;
+      }
+
+      export namespace Palette {
+        export interface Rgb {
+          blue?: number;
+
+          green?: number;
+
+          red?: number;
+        }
+      }
+    }
   }
 }
 
 export interface BookmarkListParams {
   /**
-   * Pagination cursor for bookmarks
+   * Pagination cursor for bookmarks. Also read as next_cursor, next_token,
+   * pagination_token or continuation_token.
    */
   cursor?: string;
 
   /**
-   * Optional bookmark folder ID
+   * Optional bookmark folder ID. Folders need X Premium.
    */
   folderId?: string;
 }
 
+export interface BookmarkRetrieveFoldersParams {
+  /**
+   * Pagination cursor for collection results. Also read as next_cursor, next_token,
+   * pagination_token or continuation_token.
+   */
+  cursor?: string;
+}
+
 export declare namespace Bookmarks {
   export {
     type BookmarkRetrieveFoldersResponse as BookmarkRetrieveFoldersResponse,
     type BookmarkListParams as BookmarkListParams,
+    type BookmarkRetrieveFoldersParams as BookmarkRetrieveFoldersParams,
   };
 }

package/src/resources/x/broadcasts.ts

@@ -0,0 +1,225 @@
+// SPDX-FileCopyrightText: 2026 Xquik contributors
+//
+// SPDX-License-Identifier: Apache-2.0
+
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * X live video details, watch counts, and broadcaster
+ */
+export class Broadcasts extends APIResource {
+  /**
+   * Returns one X broadcast, the live video X hosts at x.com/i/broadcasts, live or
+   * ended. Accepts the broadcast ID or the URL-encoded broadcast URL. Reading a
+   * broadcast adds no view to it.
+   *
+   * @example
+   * ```ts
+   * const broadcast = await client.x.broadcasts.retrieve('id');
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: BroadcastRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BroadcastRetrieveResponse> {
+    return this._client.get(path`/x/broadcasts/${id}`, { query, ...options });
+  }
+}
+
+export interface BroadcastRetrieveResponse {
+  /**
+   * X broadcast, a live video
+   */
+  broadcast: BroadcastRetrieveResponse.Broadcast;
+}
+
+export namespace BroadcastRetrieveResponse {
+  /**
+   * X broadcast, a live video
+   */
+  export interface Broadcast {
+    /**
+     * Broadcast ID
+     */
+    id: string;
+
+    /**
+     * Camera rotation in degrees
+     */
+    cameraRotation?: number;
+
+    /**
+     * X's code for who may chat
+     */
+    chatOption?: number;
+
+    /**
+     * Public X profile.
+     */
+    creator?: Shared.UserProfile;
+
+    /**
+     * When the broadcast ended
+     */
+    endedAt?: string;
+
+    /**
+     * Video height in pixels
+     */
+    height?: number;
+
+    /**
+     * Whether X offers a recording of the broadcast
+     */
+    isAvailableForReplay?: boolean;
+
+    /**
+     * Whether the video stream runs in high-latency mode
+     */
+    isHighLatency?: boolean;
+
+    /**
+     * Whether X marks the chat private
+     */
+    isPrivateChat?: boolean;
+
+    /**
+     * Whether the broadcaster edited the title of the replay
+     */
+    isTitleEdited?: boolean;
+
+    /**
+     * When the video stream last reached X
+     */
+    lastPingAt?: string;
+
+    /**
+     * X's media key for the video
+     */
+    mediaKey?: string;
+
+    /**
+     * Broadcaster, as X's live video service names the account
+     */
+    periscopeUser?: Broadcast.PeriscopeUser;
+
+    /**
+     * Image X shows before the broadcast starts
+     */
+    preLiveSlateUrl?: string;
+
+    /**
+     * When the broadcast was set to start
+     */
+    scheduledStart?: string;
+
+    /**
+     * What produced the video stream, as X names it
+     */
+    source?: string;
+
+    /**
+     * When the broadcast went live
+     */
+    startedAt?: string;
+
+    /**
+     * Such as NotStarted, Running or Ended, as X names it
+     */
+    state?: string;
+
+    /**
+     * Broadcast title
+     */
+    title?: string;
+
+    /**
+     * Accounts that watched, live or after
+     */
+    totalWatched?: number;
+
+    /**
+     * Accounts watching, as X counts them
+     */
+    totalWatching?: number;
+
+    /**
+     * Search tweet with author. Zero metrics may mean X omitted counts.
+     */
+    tweet?: Shared.SearchTweet;
+
+    /**
+     * ID of the post that announces the broadcast
+     */
+    tweetId?: string;
+
+    /**
+     * X's revision number of the broadcast
+     */
+    version?: number;
+
+    /**
+     * Video width in pixels
+     */
+    width?: number;
+  }
+
+  export namespace Broadcast {
+    /**
+     * Broadcaster, as X's live video service names the account
+     */
+    export interface PeriscopeUser {
+      /**
+       * Live video account ID
+       */
+      id?: string;
+
+      /**
+       * Live video display name
+       */
+      displayName?: string;
+
+      /**
+       * Live video avatar URL
+       */
+      profilePicture?: string;
+
+      /**
+       * Live video username
+       */
+      username?: string;
+    }
+  }
+}
+
+export interface BroadcastRetrieveParams {
+  /**
+   * Fields to keep in each row, comma-separated. Use dots for nested fields, such as
+   * author.username. A list keeps the field in each item. Case & underscores do not
+   * matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
+   * always stay. An unknown name answers 400 unknown_field with the valid names,
+   * before any read. The price stays the same. SDK row types then hold only the
+   * named fields.
+   */
+  fields?: string;
+
+  /**
+   * Fields to drop from each row, comma-separated. It takes the same names as
+   * fields. With fields, it drops from the kept fields.
+   */
+  omit?: string;
+}
+
+export declare namespace Broadcasts {
+  export {
+    type BroadcastRetrieveResponse as BroadcastRetrieveResponse,
+    type BroadcastRetrieveParams as BroadcastRetrieveParams,
+  };
+}