twitter-openapi-typescript-generated 0.1.0 → 0.1.2

package/dist/apis/TweetApi.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
+import { type BookmarkSearchTimelineResponse } from '../models/BookmarkSearchTimelineResponse';
 import { type BookmarksResponse } from '../models/BookmarksResponse';
 import { type CommunityAboutTimelineResponse } from '../models/CommunityAboutTimelineResponse';
 import { type CommunityDiscoveryTimelineResponse } from '../models/CommunityDiscoveryTimelineResponse';
@@ -17,6 +18,7 @@ import { type CommunityMediaTimelineResponse } from '../models/CommunityMediaTim
 import { type CommunityTweetsTimelineResponse } from '../models/CommunityTweetsTimelineResponse';
 import { type ConnectTabTimelineResponse } from '../models/ConnectTabTimelineResponse';
 import { type ExplorePageResponse } from '../models/ExplorePageResponse';
+import { type ExploreSidebarResponse } from '../models/ExploreSidebarResponse';
 import { type GenericTimelineByIdResponse } from '../models/GenericTimelineByIdResponse';
 import { type ListLatestTweetsTimelineResponse } from '../models/ListLatestTweetsTimelineResponse';
 import { type NotificationsTimelineResponse } from '../models/NotificationsTimelineResponse';
@@ -25,6 +27,20 @@ import { type TimelineResponse } from '../models/TimelineResponse';
 import { type TweetDetailResponse } from '../models/TweetDetailResponse';
 import { type UserHighlightsTweetsResponse } from '../models/UserHighlightsTweetsResponse';
 import { type UserTweetsResponse } from '../models/UserTweetsResponse';
+export interface GetBookmarkSearchTimelineRequest {
+    /**
+     *
+     */
+    pathQueryId: string;
+    /**
+     *
+     */
+    features: string;
+    /**
+     *
+     */
+    variables: string;
+}
 export interface GetBookmarksRequest {
     /**
      *
@@ -123,6 +139,20 @@ export interface GetExplorePageRequest {
      */
     features: string;
 }
+export interface GetExploreSidebarRequest {
+    /**
+     *
+     */
+    pathQueryId: string;
+    /**
+     *
+     */
+    features: string;
+    /**
+     *
+     */
+    variables: string;
+}
 export interface GetGenericTimelineByIdRequest {
     /**
      *
@@ -417,6 +447,18 @@ export interface GetUserVideoTimelineRequest {
  *
  */
 export declare class TweetApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getBookmarkSearchTimeline without sending the request
+     */
+    getBookmarkSearchTimelineRequestOpts(requestParameters: GetBookmarkSearchTimelineRequest): Promise<runtime.RequestOpts>;
+    /**
+     * search the account\'s bookmarks
+     */
+    getBookmarkSearchTimelineRaw(requestParameters: GetBookmarkSearchTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BookmarkSearchTimelineResponse>>;
+    /**
+     * search the account\'s bookmarks
+     */
+    getBookmarkSearchTimeline(requestParameters: GetBookmarkSearchTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BookmarkSearchTimelineResponse>;
     /**
      * Creates request options for getBookmarks without sending the request
      */
@@ -501,6 +543,18 @@ export declare class TweetApi extends runtime.BaseAPI {
      * get the explore page (segmented timelines)
      */
     getExplorePage(requestParameters: GetExplorePageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExplorePageResponse>;
+    /**
+     * Creates request options for getExploreSidebar without sending the request
+     */
+    getExploreSidebarRequestOpts(requestParameters: GetExploreSidebarRequest): Promise<runtime.RequestOpts>;
+    /**
+     * the explore sidebar (trends)
+     */
+    getExploreSidebarRaw(requestParameters: GetExploreSidebarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExploreSidebarResponse>>;
+    /**
+     * the explore sidebar (trends)
+     */
+    getExploreSidebar(requestParameters: GetExploreSidebarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExploreSidebarResponse>;
     /**
      * Creates request options for getGenericTimelineById without sending the request
      */

package/dist/apis/TweetApi.js

@@ -24,6 +24,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TweetApi = void 0;
 const runtime = require("../runtime");
+const BookmarkSearchTimelineResponse_1 = require("../models/BookmarkSearchTimelineResponse");
 const BookmarksResponse_1 = require("../models/BookmarksResponse");
 const CommunityAboutTimelineResponse_1 = require("../models/CommunityAboutTimelineResponse");
 const CommunityDiscoveryTimelineResponse_1 = require("../models/CommunityDiscoveryTimelineResponse");
@@ -31,6 +32,7 @@ const CommunityMediaTimelineResponse_1 = require("../models/CommunityMediaTimeli
 const CommunityTweetsTimelineResponse_1 = require("../models/CommunityTweetsTimelineResponse");
 const ConnectTabTimelineResponse_1 = require("../models/ConnectTabTimelineResponse");
 const ExplorePageResponse_1 = require("../models/ExplorePageResponse");
+const ExploreSidebarResponse_1 = require("../models/ExploreSidebarResponse");
 const GenericTimelineByIdResponse_1 = require("../models/GenericTimelineByIdResponse");
 const ListLatestTweetsTimelineResponse_1 = require("../models/ListLatestTweetsTimelineResponse");
 const NotificationsTimelineResponse_1 = require("../models/NotificationsTimelineResponse");
@@ -43,6 +45,121 @@ const UserTweetsResponse_1 = require("../models/UserTweetsResponse");
  *
  */
 class TweetApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getBookmarkSearchTimeline without sending the request
+     */
+    getBookmarkSearchTimelineRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['pathQueryId'] == null) {
+                throw new runtime.RequiredError('pathQueryId', 'Required parameter "pathQueryId" was null or undefined when calling getBookmarkSearchTimeline().');
+            }
+            if (requestParameters['features'] == null) {
+                throw new runtime.RequiredError('features', 'Required parameter "features" was null or undefined when calling getBookmarkSearchTimeline().');
+            }
+            if (requestParameters['variables'] == null) {
+                throw new runtime.RequiredError('variables', 'Required parameter "variables" was null or undefined when calling getBookmarkSearchTimeline().');
+            }
+            const queryParameters = {};
+            if (requestParameters['features'] != null) {
+                queryParameters['features'] = requestParameters['features'];
+            }
+            if (requestParameters['variables'] != null) {
+                queryParameters['variables'] = requestParameters['variables'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Accept"] = yield this.configuration.apiKey("Accept"); // Accept authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-twitter-client-language"] = yield this.configuration.apiKey("x-twitter-client-language"); // ClientLanguage authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Priority"] = yield this.configuration.apiKey("Priority"); // Priority authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Referer"] = yield this.configuration.apiKey("Referer"); // Referer authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Fetch-Dest"] = yield this.configuration.apiKey("Sec-Fetch-Dest"); // SecFetchDest authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Ch-Ua-Platform"] = yield this.configuration.apiKey("Sec-Ch-Ua-Platform"); // SecChUaPlatform authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Fetch-Mode"] = yield this.configuration.apiKey("Sec-Fetch-Mode"); // SecFetchMode authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-csrf-token"] = yield this.configuration.apiKey("x-csrf-token"); // CsrfToken authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-client-uuid"] = yield this.configuration.apiKey("x-client-uuid"); // ClientUuid authentication
+            }
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-guest-token"] = yield this.configuration.apiKey("x-guest-token"); // GuestToken authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Ch-Ua"] = yield this.configuration.apiKey("Sec-Ch-Ua"); // SecChUa authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-client-transaction-id"] = yield this.configuration.apiKey("x-client-transaction-id"); // ClientTransactionId authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-twitter-active-user"] = yield this.configuration.apiKey("x-twitter-active-user"); // ActiveUser authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["user-agent"] = yield this.configuration.apiKey("user-agent"); // UserAgent authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Accept-Language"] = yield this.configuration.apiKey("Accept-Language"); // AcceptLanguage authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Fetch-Site"] = yield this.configuration.apiKey("Sec-Fetch-Site"); // SecFetchSite authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-twitter-auth-type"] = yield this.configuration.apiKey("x-twitter-auth-type"); // AuthType authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Ch-Ua-Mobile"] = yield this.configuration.apiKey("Sec-Ch-Ua-Mobile"); // SecChUaMobile authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Accept-Encoding"] = yield this.configuration.apiKey("Accept-Encoding"); // AcceptEncoding authentication
+            }
+            let urlPath = `/graphql/{pathQueryId}/BookmarkSearchTimeline`;
+            urlPath = urlPath.replace('{pathQueryId}', encodeURIComponent(String(requestParameters['pathQueryId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * search the account\'s bookmarks
+     */
+    getBookmarkSearchTimelineRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getBookmarkSearchTimelineRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, BookmarkSearchTimelineResponse_1.BookmarkSearchTimelineResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * search the account\'s bookmarks
+     */
+    getBookmarkSearchTimeline(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getBookmarkSearchTimelineRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getBookmarks without sending the request
      */
@@ -848,6 +965,121 @@ class TweetApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getExploreSidebar without sending the request
+     */
+    getExploreSidebarRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['pathQueryId'] == null) {
+                throw new runtime.RequiredError('pathQueryId', 'Required parameter "pathQueryId" was null or undefined when calling getExploreSidebar().');
+            }
+            if (requestParameters['features'] == null) {
+                throw new runtime.RequiredError('features', 'Required parameter "features" was null or undefined when calling getExploreSidebar().');
+            }
+            if (requestParameters['variables'] == null) {
+                throw new runtime.RequiredError('variables', 'Required parameter "variables" was null or undefined when calling getExploreSidebar().');
+            }
+            const queryParameters = {};
+            if (requestParameters['features'] != null) {
+                queryParameters['features'] = requestParameters['features'];
+            }
+            if (requestParameters['variables'] != null) {
+                queryParameters['variables'] = requestParameters['variables'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Accept"] = yield this.configuration.apiKey("Accept"); // Accept authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-twitter-client-language"] = yield this.configuration.apiKey("x-twitter-client-language"); // ClientLanguage authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Priority"] = yield this.configuration.apiKey("Priority"); // Priority authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Referer"] = yield this.configuration.apiKey("Referer"); // Referer authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Fetch-Dest"] = yield this.configuration.apiKey("Sec-Fetch-Dest"); // SecFetchDest authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Ch-Ua-Platform"] = yield this.configuration.apiKey("Sec-Ch-Ua-Platform"); // SecChUaPlatform authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Fetch-Mode"] = yield this.configuration.apiKey("Sec-Fetch-Mode"); // SecFetchMode authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-csrf-token"] = yield this.configuration.apiKey("x-csrf-token"); // CsrfToken authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-client-uuid"] = yield this.configuration.apiKey("x-client-uuid"); // ClientUuid authentication
+            }
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-guest-token"] = yield this.configuration.apiKey("x-guest-token"); // GuestToken authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Ch-Ua"] = yield this.configuration.apiKey("Sec-Ch-Ua"); // SecChUa authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-client-transaction-id"] = yield this.configuration.apiKey("x-client-transaction-id"); // ClientTransactionId authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-twitter-active-user"] = yield this.configuration.apiKey("x-twitter-active-user"); // ActiveUser authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["user-agent"] = yield this.configuration.apiKey("user-agent"); // UserAgent authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Accept-Language"] = yield this.configuration.apiKey("Accept-Language"); // AcceptLanguage authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Fetch-Site"] = yield this.configuration.apiKey("Sec-Fetch-Site"); // SecFetchSite authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["x-twitter-auth-type"] = yield this.configuration.apiKey("x-twitter-auth-type"); // AuthType authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Sec-Ch-Ua-Mobile"] = yield this.configuration.apiKey("Sec-Ch-Ua-Mobile"); // SecChUaMobile authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Accept-Encoding"] = yield this.configuration.apiKey("Accept-Encoding"); // AcceptEncoding authentication
+            }
+            let urlPath = `/graphql/{pathQueryId}/ExploreSidebar`;
+            urlPath = urlPath.replace('{pathQueryId}', encodeURIComponent(String(requestParameters['pathQueryId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * the explore sidebar (trends)
+     */
+    getExploreSidebarRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getExploreSidebarRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ExploreSidebarResponse_1.ExploreSidebarResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * the explore sidebar (trends)
+     */
+    getExploreSidebar(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getExploreSidebarRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getGenericTimelineById without sending the request
      */

package/dist/apis/UserListApi.d.ts

@@ -14,7 +14,9 @@ import { type FollowResponse } from '../models/FollowResponse';
 import { type ListMembersResponse } from '../models/ListMembersResponse';
 import { type ListRecommendedUsersResponse } from '../models/ListRecommendedUsersResponse';
 import { type ListResponse } from '../models/ListResponse';
+import { type ListSearchTimelineResponse } from '../models/ListSearchTimelineResponse';
 import { type ListSubscribersResponse } from '../models/ListSubscribersResponse';
+import { type ListsManagementPageTimelineResponse } from '../models/ListsManagementPageTimelineResponse';
 import { type TweetFavoritersResponse } from '../models/TweetFavoritersResponse';
 import { type TweetRetweetersResponse } from '../models/TweetRetweetersResponse';
 import { type UserTweetsResponse } from '../models/UserTweetsResponse';
@@ -32,6 +34,20 @@ export interface GetBlueVerifiedFollowersRequest {
      */
     features: string;
 }
+export interface GetCombinedListsRequest {
+    /**
+     *
+     */
+    pathQueryId: string;
+    /**
+     *
+     */
+    features: string;
+    /**
+     *
+     */
+    variables: string;
+}
 export interface GetFavoritersRequest {
     /**
      *
@@ -158,6 +174,20 @@ export interface GetListOwnershipsRequest {
      */
     features: string;
 }
+export interface GetListSearchTimelineRequest {
+    /**
+     *
+     */
+    pathQueryId: string;
+    /**
+     *
+     */
+    features: string;
+    /**
+     *
+     */
+    variables: string;
+}
 export interface GetListSubscribersRequest {
     /**
      *
@@ -172,6 +202,20 @@ export interface GetListSubscribersRequest {
      */
     features: string;
 }
+export interface GetListsManagementPageTimelineRequest {
+    /**
+     *
+     */
+    pathQueryId: string;
+    /**
+     *
+     */
+    features: string;
+    /**
+     *
+     */
+    variables: string;
+}
 export interface GetRetweetersRequest {
     /**
      *
@@ -202,6 +246,18 @@ export declare class UserListApi extends runtime.BaseAPI {
      * get blue verified followers
      */
     getBlueVerifiedFollowers(requestParameters: GetBlueVerifiedFollowersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FollowResponse>;
+    /**
+     * Creates request options for getCombinedLists without sending the request
+     */
+    getCombinedListsRequestOpts(requestParameters: GetCombinedListsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * lists a user owns or follows
+     */
+    getCombinedListsRaw(requestParameters: GetCombinedListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserTweetsResponse>>;
+    /**
+     * lists a user owns or follows
+     */
+    getCombinedLists(requestParameters: GetCombinedListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserTweetsResponse>;
     /**
      * Creates request options for getFavoriters without sending the request
      */
@@ -310,6 +366,18 @@ export declare class UserListApi extends runtime.BaseAPI {
      * get the lists a user owns (add/remove from Lists dialog)
      */
     getListOwnerships(requestParameters: GetListOwnershipsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserTweetsResponse>;
+    /**
+     * Creates request options for getListSearchTimeline without sending the request
+     */
+    getListSearchTimelineRequestOpts(requestParameters: GetListSearchTimelineRequest): Promise<runtime.RequestOpts>;
+    /**
+     * search lists
+     */
+    getListSearchTimelineRaw(requestParameters: GetListSearchTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSearchTimelineResponse>>;
+    /**
+     * search lists
+     */
+    getListSearchTimeline(requestParameters: GetListSearchTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSearchTimelineResponse>;
     /**
      * Creates request options for getListSubscribers without sending the request
      */
@@ -322,6 +390,18 @@ export declare class UserListApi extends runtime.BaseAPI {
      * get list subscribers (followers)
      */
     getListSubscribers(requestParameters: GetListSubscribersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSubscribersResponse>;
+    /**
+     * Creates request options for getListsManagementPageTimeline without sending the request
+     */
+    getListsManagementPageTimelineRequestOpts(requestParameters: GetListsManagementPageTimelineRequest): Promise<runtime.RequestOpts>;
+    /**
+     * the account\'s lists management page
+     */
+    getListsManagementPageTimelineRaw(requestParameters: GetListsManagementPageTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListsManagementPageTimelineResponse>>;
+    /**
+     * the account\'s lists management page
+     */
+    getListsManagementPageTimeline(requestParameters: GetListsManagementPageTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListsManagementPageTimelineResponse>;
     /**
      * Creates request options for getRetweeters without sending the request
      */