x-twitter-scraper 0.1.0 → 0.2.0

package/resources/x/x.d.ts

@@ -1,7 +1,7 @@
 import { APIResource } from "../../core/resource.js";
 import * as Shared from "../shared.js";
 import * as AccountsAPI from "./accounts.js";
-import { AccountCreateParams, AccountCreateResponse, AccountDeleteResponse, AccountListResponse, AccountReauthParams, AccountReauthResponse, Accounts, XAccount, XAccountDetail } from "./accounts.js";
+import { AccountBulkRetryResponse, AccountCreateParams, AccountCreateResponse, AccountDeleteResponse, AccountListResponse, AccountReauthParams, AccountReauthResponse, Accounts, XAccount, XAccountDetail } from "./accounts.js";
 import * as BookmarksAPI from "./bookmarks.js";
 import { BookmarkListParams, BookmarkRetrieveFoldersResponse, Bookmarks } from "./bookmarks.js";
 import * as DmAPI from "./dm.js";
@@ -38,23 +38,46 @@ export declare class X extends APIResource {
     lists: ListsAPI.Lists;
     /**
      * Retrieve the full content of an X Article (long-form post) by tweet ID.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.getArticle('tweetId');
+     * ```
      */
     getArticle(tweetID: string, options?: RequestOptions): APIPromise<XGetArticleResponse>;
     /**
      * Get home timeline
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets = await client.x.getHomeTimeline();
+     * ```
      */
     getHomeTimeline(query?: XGetHomeTimelineParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
     /**
      * Get notifications
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.getNotifications();
+     * ```
      */
     getNotifications(query?: XGetNotificationsParams | null | undefined, options?: RequestOptions): APIPromise<XGetNotificationsResponse>;
     /**
      * Get trending topics
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.getTrends();
+     * ```
      */
-    getTrends(options?: RequestOptions): APIPromise<void>;
+    getTrends(options?: RequestOptions): APIPromise<XGetTrendsResponse>;
 }
 export interface XGetArticleResponse {
     article: XGetArticleResponse.Article;
+    /**
+     * Author of a tweet with follower count and verification status.
+     */
     author?: TweetsAPI.TweetAuthor;
 }
 export declare namespace XGetArticleResponse {
@@ -99,9 +122,22 @@ export declare namespace XGetNotificationsResponse {
         type?: string;
     }
 }
+export interface XGetTrendsResponse {
+    count: number;
+    trends: Array<XGetTrendsResponse.Trend>;
+    woeid: number;
+}
+export declare namespace XGetTrendsResponse {
+    interface Trend {
+        name: string;
+        description?: string;
+        query?: string;
+        rank?: number;
+    }
+}
 export interface XGetHomeTimelineParams {
     /**
-     * Pagination cursor from previous response
+     * Pagination cursor for timeline
      */
     cursor?: string;
     /**
@@ -111,7 +147,7 @@ export interface XGetHomeTimelineParams {
 }
 export interface XGetNotificationsParams {
     /**
-     * Pagination cursor from previous response
+     * Pagination cursor for notifications
      */
     cursor?: string;
     /**
@@ -120,7 +156,7 @@ export interface XGetNotificationsParams {
     type?: 'All' | 'Verified' | 'Mentions';
 }
 export declare namespace X {
-    export { type XGetArticleResponse as XGetArticleResponse, type XGetNotificationsResponse as XGetNotificationsResponse, type XGetHomeTimelineParams as XGetHomeTimelineParams, type XGetNotificationsParams as XGetNotificationsParams, };
+    export { type XGetArticleResponse as XGetArticleResponse, type XGetNotificationsResponse as XGetNotificationsResponse, type XGetTrendsResponse as XGetTrendsResponse, type XGetHomeTimelineParams as XGetHomeTimelineParams, type XGetNotificationsParams as XGetNotificationsParams, };
     export { Tweets as Tweets, type SearchTweet as SearchTweet, type TweetAuthor as TweetAuthor, type TweetDetail as TweetDetail, type TweetCreateResponse as TweetCreateResponse, type TweetRetrieveResponse as TweetRetrieveResponse, type TweetDeleteResponse as TweetDeleteResponse, type TweetCreateParams as TweetCreateParams, type TweetListParams as TweetListParams, type TweetDeleteParams as TweetDeleteParams, type TweetGetFavoritersParams as TweetGetFavoritersParams, type TweetGetQuotesParams as TweetGetQuotesParams, type TweetGetRepliesParams as TweetGetRepliesParams, type TweetGetRetweetersParams as TweetGetRetweetersParams, type TweetGetThreadParams as TweetGetThreadParams, type TweetSearchParams as TweetSearchParams, };
     export { Users as Users, type UserProfile as UserProfile, type UserRetrieveBatchParams as UserRetrieveBatchParams, type UserRetrieveFollowersParams as UserRetrieveFollowersParams, type UserRetrieveFollowersYouKnowParams as UserRetrieveFollowersYouKnowParams, type UserRetrieveFollowingParams as UserRetrieveFollowingParams, type UserRetrieveLikesParams as UserRetrieveLikesParams, type UserRetrieveMediaParams as UserRetrieveMediaParams, type UserRetrieveMentionsParams as UserRetrieveMentionsParams, type UserRetrieveSearchParams as UserRetrieveSearchParams, type UserRetrieveTweetsParams as UserRetrieveTweetsParams, type UserRetrieveVerifiedFollowersParams as UserRetrieveVerifiedFollowersParams, };
     export { Followers as Followers, type FollowerCheckResponse as FollowerCheckResponse, type FollowerCheckParams as FollowerCheckParams, };
@@ -128,7 +164,7 @@ export declare namespace X {
     export { Media as Media, type MediaDownloadResponse as MediaDownloadResponse, type MediaUploadResponse as MediaUploadResponse, type MediaDownloadParams as MediaDownloadParams, type MediaUploadParams as MediaUploadParams, };
     export { Profile as Profile, type ProfileUpdateResponse as ProfileUpdateResponse, type ProfileUpdateAvatarResponse as ProfileUpdateAvatarResponse, type ProfileUpdateBannerResponse as ProfileUpdateBannerResponse, type ProfileUpdateParams as ProfileUpdateParams, type ProfileUpdateAvatarParams as ProfileUpdateAvatarParams, type ProfileUpdateBannerParams as ProfileUpdateBannerParams, };
     export { Communities as Communities, type CommunityActionResult as CommunityActionResult, type CommunityCreateResponse as CommunityCreateResponse, type CommunityDeleteResponse as CommunityDeleteResponse, type CommunityRetrieveInfoResponse as CommunityRetrieveInfoResponse, type CommunityCreateParams as CommunityCreateParams, type CommunityDeleteParams as CommunityDeleteParams, type CommunityRetrieveMembersParams as CommunityRetrieveMembersParams, type CommunityRetrieveModeratorsParams as CommunityRetrieveModeratorsParams, type CommunityRetrieveSearchParams as CommunityRetrieveSearchParams, };
-    export { Accounts as Accounts, type XAccount as XAccount, type XAccountDetail as XAccountDetail, type AccountCreateResponse as AccountCreateResponse, type AccountListResponse as AccountListResponse, type AccountDeleteResponse as AccountDeleteResponse, type AccountReauthResponse as AccountReauthResponse, type AccountCreateParams as AccountCreateParams, type AccountReauthParams as AccountReauthParams, };
+    export { Accounts as Accounts, type XAccount as XAccount, type XAccountDetail as XAccountDetail, type AccountCreateResponse as AccountCreateResponse, type AccountListResponse as AccountListResponse, type AccountDeleteResponse as AccountDeleteResponse, type AccountBulkRetryResponse as AccountBulkRetryResponse, type AccountReauthResponse as AccountReauthResponse, type AccountCreateParams as AccountCreateParams, type AccountReauthParams as AccountReauthParams, };
     export { Bookmarks as Bookmarks, type BookmarkRetrieveFoldersResponse as BookmarkRetrieveFoldersResponse, type BookmarkListParams as BookmarkListParams, };
     export { Lists as Lists, type ListRetrieveFollowersParams as ListRetrieveFollowersParams, type ListRetrieveMembersParams as ListRetrieveMembersParams, type ListRetrieveTweetsParams as ListRetrieveTweetsParams, };
 }

package/resources/x/x.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"x.d.ts","sourceRoot":"","sources":["../../src/resources/x/x.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,WAAW;OAChB,EACL,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACR,QAAQ,EACR,cAAc,EACf;OACM,KAAK,YAAY;OACjB,EAAE,kBAAkB,EAAE,+BAA+B,EAAE,SAAS,EAAE;OAClE,KAAK,KAAK;OACV,EAAE,EAAE,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,YAAY,EAAE,cAAc,EAAE;OACxF,KAAK,YAAY;OACjB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,SAAS,EAAE;OACzD,KAAK,QAAQ;OACb,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,wBAAwB,EACxB,KAAK,EACN;OACM,KAAK,QAAQ;OACb,EACL,KAAK,EACL,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACpB;OACM,KAAK,UAAU;OACf,EACL,OAAO,EACP,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,mBAAmB,EACnB,qBAAqB,EACtB;OACM,KAAK,cAAc;OACnB,EACL,WAAW,EACX,qBAAqB,EACrB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,6BAA6B,EAC7B,8BAA8B,EAC9B,iCAAiC,EACjC,6BAA6B,EAC9B;OACM,KAAK,SAAS;OACd,EACL,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,WAAW,EACX,wBAAwB,EACxB,oBAAoB,EACpB,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,EACP;OACM,KAAK,QAAQ;OACb,EACL,WAAW,EACX,uBAAuB,EACvB,2BAA2B,EAC3B,kCAAkC,EAClC,2BAA2B,EAC3B,uBAAuB,EACvB,uBAAuB,EACvB,0BAA0B,EAC1B,wBAAwB,EACxB,wBAAwB,EACxB,mCAAmC,EACnC,KAAK,EACN;OACM,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,CAAE,SAAQ,WAAW;IAChC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,EAAE,EAAE,KAAK,CAAC,EAAE,CAA8B;IAC1C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAItF;;OAEG;IACH,eAAe,CACb,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC;IAIrC;;OAEG;IACH,gBAAgB,CACd,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMtD;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC;IAErC,MAAM,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,OAAO;QACtB,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAElC,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,OAAO;YACtB,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,OAAO,CAAC;IAEvB,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,EAAE,KAAK,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;CAC9D;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,YAAY;QAC3B,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,UAAU,CAAC;CACxC;AAaD,MAAM,CAAC,OAAO,WAAW,CAAC,CAAC;IACzB,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,EAAE,IAAI,EAAE,EACR,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
+{"version":3,"file":"x.d.ts","sourceRoot":"","sources":["../../src/resources/x/x.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,WAAW;OAChB,EACL,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACR,QAAQ,EACR,cAAc,EACf;OACM,KAAK,YAAY;OACjB,EAAE,kBAAkB,EAAE,+BAA+B,EAAE,SAAS,EAAE;OAClE,KAAK,KAAK;OACV,EAAE,EAAE,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,YAAY,EAAE,cAAc,EAAE;OACxF,KAAK,YAAY;OACjB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,SAAS,EAAE;OACzD,KAAK,QAAQ;OACb,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,wBAAwB,EACxB,KAAK,EACN;OACM,KAAK,QAAQ;OACb,EACL,KAAK,EACL,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACpB;OACM,KAAK,UAAU;OACf,EACL,OAAO,EACP,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,mBAAmB,EACnB,qBAAqB,EACtB;OACM,KAAK,cAAc;OACnB,EACL,WAAW,EACX,qBAAqB,EACrB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,6BAA6B,EAC7B,8BAA8B,EAC9B,iCAAiC,EACjC,6BAA6B,EAC9B;OACM,KAAK,SAAS;OACd,EACL,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,WAAW,EACX,wBAAwB,EACxB,oBAAoB,EACpB,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,EACP;OACM,KAAK,QAAQ;OACb,EACL,WAAW,EACX,uBAAuB,EACvB,2BAA2B,EAC3B,kCAAkC,EAClC,2BAA2B,EAC3B,uBAAuB,EACvB,uBAAuB,EACvB,0BAA0B,EAC1B,wBAAwB,EACxB,wBAAwB,EACxB,mCAAmC,EACnC,KAAK,EACN;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,CAAE,SAAQ,WAAW;IAChC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,EAAE,EAAE,KAAK,CAAC,EAAE,CAA8B;IAC1C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAItF;;;;;;;OAOG;IACH,eAAe,CACb,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC;IAIrC;;;;;;;OAOG;IACH,gBAAgB,CACd,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGpE;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,OAAO;QACtB,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAElC,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,OAAO;YACtB,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,OAAO,CAAC;IAEvB,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,EAAE,KAAK,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;CAC9D;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,YAAY;QAC3B,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAExC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC;QAEb,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,UAAU,CAAC;CACxC;AAaD,MAAM,CAAC,OAAO,WAAW,CAAC,CAAC;IACzB,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,EAAE,IAAI,EAAE,EACR,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/x/x.js

@@ -24,7 +24,6 @@ const TweetsAPI = tslib_1.__importStar(require("./tweets/tweets.js"));
 const tweets_1 = require("./tweets/tweets.js");
 const UsersAPI = tslib_1.__importStar(require("./users/users.js"));
 const users_1 = require("./users/users.js");
-const headers_1 = require("../../internal/headers.js");
 const path_1 = require("../../internal/utils/path.js");
 /**
  * X data lookups (subscription required)
@@ -45,30 +44,47 @@ class X extends resource_1.APIResource {
     }
     /**
      * Retrieve the full content of an X Article (long-form post) by tweet ID.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.getArticle('tweetId');
+     * ```
      */
     getArticle(tweetID, options) {
         return this._client.get((0, path_1.path) `/x/articles/${tweetID}`, options);
     }
     /**
      * Get home timeline
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets = await client.x.getHomeTimeline();
+     * ```
      */
     getHomeTimeline(query = {}, options) {
         return this._client.get('/x/timeline', { query, ...options });
     }
     /**
      * Get notifications
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.getNotifications();
+     * ```
      */
     getNotifications(query = {}, options) {
         return this._client.get('/x/notifications', { query, ...options });
     }
     /**
      * Get trending topics
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.getTrends();
+     * ```
      */
     getTrends(options) {
-        return this._client.get('/x/trends', {
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
-        });
+        return this._client.get('/x/trends', options);
     }
 }
 exports.X = X;

package/resources/x/x.js.map

@@ -1 +1 @@
-{"version":3,"file":"x.js","sourceRoot":"","sources":["../../src/resources/x/x.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,mEAA0C;AAC1C,4CAUoB;AACpB,qEAA4C;AAC5C,8CAA6F;AAC7F,uDAA8B;AAC9B,gCAA4G;AAC5G,qEAA4C;AAC5C,8CAAoF;AACpF,6DAAoC;AACpC,sCAKiB;AACjB,6DAAoC;AACpC,sCAMiB;AACjB,iEAAwC;AACxC,0CAQmB;AACnB,qFAA4D;AAC5D,8DAWmC;AACnC,sEAA6C;AAC7C,+CAiByB;AACzB,mEAA0C;AAC1C,4CAauB;AAEvB,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,CAAE,SAAQ,sBAAW;IAAlC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,OAAE,GAAa,IAAI,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsC3D,CAAC;IApCC;;OAEG;IACH,UAAU,CAAC,OAAe,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,eAAe,CACb,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE;YACnC,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAhDD,cAgDC;AA+FD,CAAC,CAAC,MAAM,GAAG,eAAM,CAAC;AAClB,CAAC,CAAC,KAAK,GAAG,aAAK,CAAC;AAChB,CAAC,CAAC,SAAS,GAAG,qBAAS,CAAC;AACxB,CAAC,CAAC,EAAE,GAAG,OAAE,CAAC;AACV,CAAC,CAAC,KAAK,GAAG,aAAK,CAAC;AAChB,CAAC,CAAC,OAAO,GAAG,iBAAO,CAAC;AACpB,CAAC,CAAC,WAAW,GAAG,yBAAW,CAAC;AAC5B,CAAC,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACtB,CAAC,CAAC,SAAS,GAAG,qBAAS,CAAC;AACxB,CAAC,CAAC,KAAK,GAAG,aAAK,CAAC"}
+{"version":3,"file":"x.js","sourceRoot":"","sources":["../../src/resources/x/x.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,mEAA0C;AAC1C,4CAWoB;AACpB,qEAA4C;AAC5C,8CAA6F;AAC7F,uDAA8B;AAC9B,gCAA4G;AAC5G,qEAA4C;AAC5C,8CAAoF;AACpF,6DAAoC;AACpC,sCAKiB;AACjB,6DAAoC;AACpC,sCAMiB;AACjB,iEAAwC;AACxC,0CAQmB;AACnB,qFAA4D;AAC5D,8DAWmC;AACnC,sEAA6C;AAC7C,+CAiByB;AACzB,mEAA0C;AAC1C,4CAauB;AAGvB,uDAAiD;AAEjD;;GAEG;AACH,MAAa,CAAE,SAAQ,sBAAW;IAAlC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,OAAE,GAAa,IAAI,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuD3D,CAAC;IArDC;;;;;;;OAOG;IACH,UAAU,CAAC,OAAe,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CACb,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CACd,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;CACF;AAjED,cAiEC;AAsHD,CAAC,CAAC,MAAM,GAAG,eAAM,CAAC;AAClB,CAAC,CAAC,KAAK,GAAG,aAAK,CAAC;AAChB,CAAC,CAAC,SAAS,GAAG,qBAAS,CAAC;AACxB,CAAC,CAAC,EAAE,GAAG,OAAE,CAAC;AACV,CAAC,CAAC,KAAK,GAAG,aAAK,CAAC;AAChB,CAAC,CAAC,OAAO,GAAG,iBAAO,CAAC;AACpB,CAAC,CAAC,WAAW,GAAG,yBAAW,CAAC;AAC5B,CAAC,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACtB,CAAC,CAAC,SAAS,GAAG,qBAAS,CAAC;AACxB,CAAC,CAAC,KAAK,GAAG,aAAK,CAAC"}

package/resources/x/x.mjs

@@ -20,7 +20,6 @@ import * as TweetsAPI from "./tweets/tweets.mjs";
 import { Tweets, } from "./tweets/tweets.mjs";
 import * as UsersAPI from "./users/users.mjs";
 import { Users, } from "./users/users.mjs";
-import { buildHeaders } from "../../internal/headers.mjs";
 import { path } from "../../internal/utils/path.mjs";
 /**
  * X data lookups (subscription required)
@@ -41,30 +40,47 @@ export class X extends APIResource {
     }
     /**
      * Retrieve the full content of an X Article (long-form post) by tweet ID.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.getArticle('tweetId');
+     * ```
      */
     getArticle(tweetID, options) {
         return this._client.get(path `/x/articles/${tweetID}`, options);
     }
     /**
      * Get home timeline
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets = await client.x.getHomeTimeline();
+     * ```
      */
     getHomeTimeline(query = {}, options) {
         return this._client.get('/x/timeline', { query, ...options });
     }
     /**
      * Get notifications
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.getNotifications();
+     * ```
      */
     getNotifications(query = {}, options) {
         return this._client.get('/x/notifications', { query, ...options });
     }
     /**
      * Get trending topics
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.getTrends();
+     * ```
      */
     getTrends(options) {
-        return this._client.get('/x/trends', {
-            ...options,
-            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-        });
+        return this._client.get('/x/trends', options);
     }
 }
 X.Tweets = Tweets;

package/resources/x/x.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"x.mjs","sourceRoot":"","sources":["../../src/resources/x/x.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,WAAW;OAChB,EAOL,QAAQ,GAGT;OACM,KAAK,YAAY;OACjB,EAAuD,SAAS,EAAE;OAClE,KAAK,KAAK;OACV,EAAE,EAAE,EAAoF;OACxF,KAAK,YAAY;OACjB,EAA8C,SAAS,EAAE;OACzD,KAAK,QAAQ;OACb,EAIL,KAAK,GACN;OACM,KAAK,QAAQ;OACb,EACL,KAAK,GAKN;OACM,KAAK,UAAU;OACf,EACL,OAAO,GAOR;OACM,KAAK,cAAc;OACnB,EACL,WAAW,GAUZ;OACM,KAAK,SAAS;OACd,EAgBL,MAAM,GACP;OACM,KAAK,QAAQ;OACb,EAYL,KAAK,GACN;OAEM,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,CAAE,SAAQ,WAAW;IAAlC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,OAAE,GAAa,IAAI,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsC3D,CAAC;IApCC;;OAEG;IACH,UAAU,CAAC,OAAe,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,eAAe,CACb,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE;YACnC,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA+FD,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC;AAClB,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC;AAChB,CAAC,CAAC,SAAS,GAAG,SAAS,CAAC;AACxB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC;AACV,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC;AAChB,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC;AACpB,CAAC,CAAC,WAAW,GAAG,WAAW,CAAC;AAC5B,CAAC,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACtB,CAAC,CAAC,SAAS,GAAG,SAAS,CAAC;AACxB,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC"}
+{"version":3,"file":"x.mjs","sourceRoot":"","sources":["../../src/resources/x/x.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,WAAW;OAChB,EAQL,QAAQ,GAGT;OACM,KAAK,YAAY;OACjB,EAAuD,SAAS,EAAE;OAClE,KAAK,KAAK;OACV,EAAE,EAAE,EAAoF;OACxF,KAAK,YAAY;OACjB,EAA8C,SAAS,EAAE;OACzD,KAAK,QAAQ;OACb,EAIL,KAAK,GACN;OACM,KAAK,QAAQ;OACb,EACL,KAAK,GAKN;OACM,KAAK,UAAU;OACf,EACL,OAAO,GAOR;OACM,KAAK,cAAc;OACnB,EACL,WAAW,GAUZ;OACM,KAAK,SAAS;OACd,EAgBL,MAAM,GACP;OACM,KAAK,QAAQ;OACb,EAYL,KAAK,GACN;OAGM,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,CAAE,SAAQ,WAAW;IAAlC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,OAAE,GAAa,IAAI,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuD3D,CAAC;IArDC;;;;;;;OAOG;IACH,UAAU,CAAC,OAAe,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CACb,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CACd,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;CACF;AAsHD,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC;AAClB,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC;AAChB,CAAC,CAAC,SAAS,GAAG,SAAS,CAAC;AACxB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC;AACV,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC;AAChB,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC;AACpB,CAAC,CAAC,WAAW,GAAG,WAAW,CAAC;AAC5B,CAAC,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACtB,CAAC,CAAC,SAAS,GAAG,SAAS,CAAC;AACxB,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC"}

package/src/client.ts

@@ -134,6 +134,7 @@ import {
   XGetHomeTimelineParams,
   XGetNotificationsParams,
   XGetNotificationsResponse,
+  XGetTrendsResponse,
 } from './resources/x/x';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
@@ -1095,6 +1096,7 @@ export declare namespace XTwitterScraper {
     X as X,
     type XGetArticleResponse as XGetArticleResponse,
     type XGetNotificationsResponse as XGetNotificationsResponse,
+    type XGetTrendsResponse as XGetTrendsResponse,
     type XGetHomeTimelineParams as XGetHomeTimelineParams,
     type XGetNotificationsParams as XGetNotificationsParams,
   };

package/src/resources/account.ts

@@ -10,6 +10,11 @@ import { RequestOptions } from '../internal/request-options';
 export class Account extends APIResource {
   /**
    * Get account info
+   *
+   * @example
+   * ```ts
+   * const account = await client.account.retrieve();
+   * ```
    */
   retrieve(options?: RequestOptions): APIPromise<AccountRetrieveResponse> {
     return this._client.get('/account', { ...options, __security: { apiKeyAuth: true } });
@@ -17,6 +22,13 @@ export class Account extends APIResource {
 
   /**
    * Set linked X username
+   *
+   * @example
+   * ```ts
+   * const response = await client.account.setXUsername({
+   *   username: 'elonmusk',
+   * });
+   * ```
    */
   setXUsername(
     body: AccountSetXUsernameParams,
@@ -27,12 +39,19 @@ export class Account extends APIResource {
 
   /**
    * Update account locale
+   *
+   * @example
+   * ```ts
+   * const response = await client.account.updateLocale({
+   *   locale: 'en',
+   * });
+   * ```
    */
   updateLocale(
     body: AccountUpdateLocaleParams,
     options?: RequestOptions,
   ): APIPromise<AccountUpdateLocaleResponse> {
-    return this._client.patch('/account', { body, ...options, __security: {} });
+    return this._client.patch('/account', { body, ...options, __security: { apiKeyAuth: true } });
   }
 }
 

package/src/resources/api-keys.ts

@@ -11,26 +11,46 @@ import { path } from '../internal/utils/path';
 export class APIKeys extends APIResource {
   /**
    * Create API key
+   *
+   * @example
+   * ```ts
+   * const apiKey = await client.apiKeys.create({
+   *   name: 'My API Key',
+   * });
+   * ```
    */
   create(body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKeyCreateResponse> {
-    return this._client.post('/api-keys', { body, ...options, __security: {} });
+    return this._client.post('/api-keys', { body, ...options, __security: { apiKeyAuth: true } });
   }
 
   /**
    * List API keys
+   *
+   * @example
+   * ```ts
+   * const apiKeys = await client.apiKeys.list();
+   * ```
    */
   list(options?: RequestOptions): APIPromise<APIKeyListResponse> {
-    return this._client.get('/api-keys', { ...options, __security: {} });
+    return this._client.get('/api-keys', { ...options, __security: { apiKeyAuth: true } });
   }
 
   /**
    * Revoke API key
+   *
+   * @example
+   * ```ts
+   * const response = await client.apiKeys.revoke('id');
+   * ```
    */
   revoke(id: string, options?: RequestOptions): APIPromise<APIKeyRevokeResponse> {
-    return this._client.delete(path`/api-keys/${id}`, { ...options, __security: {} });
+    return this._client.delete(path`/api-keys/${id}`, { ...options, __security: { apiKeyAuth: true } });
   }
 }
 
+/**
+ * API key metadata returned when listing keys.
+ */
 export interface APIKey {
   id: string;
 

package/src/resources/compose.ts

@@ -10,13 +10,44 @@ import { RequestOptions } from '../internal/request-options';
 export class Compose extends APIResource {
   /**
    * Compose, refine, or score a tweet
+   *
+   * @example
+   * ```ts
+   * const compose = await client.compose.create({
+   *   step: 'compose',
+   *   goal: 'engagement',
+   *   topic: 'AI trends in 2025',
+   * });
+   * ```
    */
   create(body: ComposeCreateParams, options?: RequestOptions): APIPromise<ComposeCreateResponse> {
     return this._client.post('/compose', { body, ...options });
   }
 }
 
-export type ComposeCreateResponse = { [key: string]: unknown };
+export interface ComposeCreateResponse {
+  /**
+   * AI feedback on the draft
+   */
+  feedback?: string;
+
+  /**
+   * Engagement score (0-100)
+   */
+  score?: number;
+
+  /**
+   * Improvement suggestions
+   */
+  suggestions?: Array<string>;
+
+  /**
+   * Generated or refined tweet text
+   */
+  text?: string;
+
+  [k: string]: unknown;
+}
 
 export interface ComposeCreateParams {
   /**

package/src/resources/credits.ts

@@ -10,6 +10,11 @@ import { RequestOptions } from '../internal/request-options';
 export class Credits extends APIResource {
   /**
    * Get credits balance
+   *
+   * @example
+   * ```ts
+   * const response = await client.credits.retrieveBalance();
+   * ```
    */
   retrieveBalance(options?: RequestOptions): APIPromise<CreditRetrieveBalanceResponse> {
     return this._client.get('/credits', options);
@@ -17,6 +22,13 @@ export class Credits extends APIResource {
 
   /**
    * Top up credits balance
+   *
+   * @example
+   * ```ts
+   * const response = await client.credits.topupBalance({
+   *   amount: 10000,
+   * });
+   * ```
    */
   topupBalance(
     body: CreditTopupBalanceParams,

package/src/resources/drafts.ts

@@ -12,6 +12,15 @@ import { path } from '../internal/utils/path';
 export class Drafts extends APIResource {
   /**
    * Save a tweet draft
+   *
+   * @example
+   * ```ts
+   * const draftDetail = await client.drafts.create({
+   *   text: 'AI is the future of productivity',
+   *   goal: 'engagement',
+   *   topic: 'AI trends',
+   * });
+   * ```
    */
   create(body: DraftCreateParams, options?: RequestOptions): APIPromise<DraftDetail> {
     return this._client.post('/drafts', { body, ...options });
@@ -19,6 +28,11 @@ export class Drafts extends APIResource {
 
   /**
    * Get draft by ID
+   *
+   * @example
+   * ```ts
+   * const draftDetail = await client.drafts.retrieve('id');
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<DraftDetail> {
     return this._client.get(path`/drafts/${id}`, options);
@@ -26,6 +40,11 @@ export class Drafts extends APIResource {
 
   /**
    * List saved drafts
+   *
+   * @example
+   * ```ts
+   * const drafts = await client.drafts.list();
+   * ```
    */
   list(
     query: DraftListParams | null | undefined = {},
@@ -36,6 +55,11 @@ export class Drafts extends APIResource {
 
   /**
    * Delete a draft
+   *
+   * @example
+   * ```ts
+   * await client.drafts.delete('id');
+   * ```
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/drafts/${id}`, {
@@ -45,6 +69,9 @@ export class Drafts extends APIResource {
   }
 }
 
+/**
+ * Saved tweet draft with optional topic and goal.
+ */
 export interface Draft {
   id: string;
 
@@ -57,6 +84,9 @@ export interface Draft {
   topic?: string;
 }
 
+/**
+ * Full tweet draft including update timestamp.
+ */
 export interface DraftDetail {
   id: string;
 
@@ -93,6 +123,9 @@ export interface DraftListParams {
    */
   afterCursor?: string;
 
+  /**
+   * Maximum number of items to return (1-100, default 50)
+   */
   limit?: number;
 }
 

package/src/resources/draws.ts

@@ -12,6 +12,11 @@ import { path } from '../internal/utils/path';
 export class Draws extends APIResource {
   /**
    * Get draw details
+   *
+   * @example
+   * ```ts
+   * const draw = await client.draws.retrieve('id');
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<DrawRetrieveResponse> {
     return this._client.get(path`/draws/${id}`, options);
@@ -19,6 +24,11 @@ export class Draws extends APIResource {
 
   /**
    * List draws
+   *
+   * @example
+   * ```ts
+   * const draws = await client.draws.list();
+   * ```
    */
   list(
     query: DrawListParams | null | undefined = {},
@@ -29,6 +39,14 @@ export class Draws extends APIResource {
 
   /**
    * Export draw data
+   *
+   * @example
+   * ```ts
+   * const response = await client.draws.export('id');
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
    */
   export(
     id: string,
@@ -45,12 +63,24 @@ export class Draws extends APIResource {
 
   /**
    * Run giveaway draw
+   *
+   * @example
+   * ```ts
+   * const response = await client.draws.run({
+   *   tweetUrl: 'https://x.com/elonmusk/status/1234567890',
+   *   mustRetweet: true,
+   *   winnerCount: 3,
+   * });
+   * ```
    */
   run(body: DrawRunParams, options?: RequestOptions): APIPromise<DrawRunResponse> {
     return this._client.post('/draws', { body, ...options });
   }
 }
 
+/**
+ * Full giveaway draw with tweet metrics, entries, and timing.
+ */
 export interface DrawDetail {
   id: string;
 
@@ -81,6 +111,9 @@ export interface DrawDetail {
   drawnAt?: string;
 }
 
+/**
+ * Giveaway draw summary with entry counts and status.
+ */
 export interface DrawListItem {
   id: string;
 
@@ -97,6 +130,9 @@ export interface DrawListItem {
   drawnAt?: string;
 }
 
+/**
+ * Giveaway draw winner with position and backup flag.
+ */
 export interface Winner {
   authorUsername: string;
 
@@ -108,6 +144,9 @@ export interface Winner {
 }
 
 export interface DrawRetrieveResponse {
+  /**
+   * Full giveaway draw with tweet metrics, entries, and timing.
+   */
   draw: DrawDetail;
 
   winners: Array<Winner>;
@@ -135,14 +174,20 @@ export interface DrawRunResponse {
 
 export interface DrawListParams {
   /**
-   * Cursor for pagination
+   * Cursor for keyset pagination
    */
   after?: string;
 
+  /**
+   * Maximum number of items to return (1-100, default 50)
+   */
   limit?: number;
 }
 
 export interface DrawExportParams {
+  /**
+   * Export output format
+   */
   format?: 'csv' | 'json' | 'md' | 'md-document' | 'pdf' | 'txt' | 'xlsx';
 
   /**