twitter-openapi-typescript-generated 0.0.7 → 0.0.9

package/src/models/UserResultByScreenNameResult.ts

@@ -52,10 +52,10 @@ export interface UserResultByScreenNameResult {
     legacy: UserResultByScreenNameLegacy;
     /**
      * 
-     * @type {object}
+     * @type {{ [key: string]: any; }}
      * @memberof UserResultByScreenNameResult
      */
-    profilemodules: object;
+    profilemodules: { [key: string]: any; };
     /**
      * 
      * @type {string}

package/src/models/UserResults.ts

@@ -13,12 +13,12 @@
  */
 
 import { exists, mapValues } from '../runtime';
-import type { User } from './User';
+import type { UserUnion } from './UserUnion';
 import {
-    UserFromJSON,
-    UserFromJSONTyped,
-    UserToJSON,
-} from './User';
+    UserUnionFromJSON,
+    UserUnionFromJSONTyped,
+    UserUnionToJSON,
+} from './UserUnion';
 
 /**
  * 
@@ -28,10 +28,10 @@ import {
 export interface UserResults {
     /**
      * 
-     * @type {User}
+     * @type {UserUnion}
      * @memberof UserResults
      */
-    result: User;
+    result: UserUnion;
 }
 
 /**
@@ -54,7 +54,7 @@ export function UserResultsFromJSONTyped(json: any, ignoreDiscriminator: boolean
     }
     return {
         
-        'result': UserFromJSON(json['result']),
+        'result': UserUnionFromJSON(json['result']),
     };
 }
 
@@ -67,7 +67,7 @@ export function UserResultsToJSON(value?: UserResults | null): any {
     }
     return {
         
-        'result': UserToJSON(value.result),
+        'result': UserUnionToJSON(value.result),
     };
 }
 

package/src/models/UserUnavailable.ts

@@ -0,0 +1,82 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Twitter OpenAPI
+ * Twitter OpenAPI(Swagger) specification
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: yuki@yuki0311.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { TypeName } from './TypeName';
+import {
+    TypeNameFromJSON,
+    TypeNameFromJSONTyped,
+    TypeNameToJSON,
+} from './TypeName';
+
+/**
+ * 
+ * @export
+ * @interface UserUnavailable
+ */
+export interface UserUnavailable {
+    /**
+     * 
+     * @type {TypeName}
+     * @memberof UserUnavailable
+     */
+    typename: TypeName;
+    /**
+     * 
+     * @type {string}
+     * @memberof UserUnavailable
+     */
+    reason: string;
+}
+
+/**
+ * Check if a given object implements the UserUnavailable interface.
+ */
+export function instanceOfUserUnavailable(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "typename" in value;
+    isInstance = isInstance && "reason" in value;
+
+    return isInstance;
+}
+
+export function UserUnavailableFromJSON(json: any): UserUnavailable {
+    return UserUnavailableFromJSONTyped(json, false);
+}
+
+export function UserUnavailableFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserUnavailable {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'typename': TypeNameFromJSON(json['__typename']),
+        'reason': json['reason'],
+    };
+}
+
+export function UserUnavailableToJSON(value?: UserUnavailable | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        '__typename': TypeNameToJSON(value.typename),
+        'reason': value.reason,
+    };
+}
+

package/src/models/UserUnion.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Twitter OpenAPI
+ * Twitter OpenAPI(Swagger) specification
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: yuki@yuki0311.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import {
+    User,
+    instanceOfUser,
+    UserFromJSON,
+    UserFromJSONTyped,
+    UserToJSON,
+} from './User';
+import {
+    UserUnavailable,
+    instanceOfUserUnavailable,
+    UserUnavailableFromJSON,
+    UserUnavailableFromJSONTyped,
+    UserUnavailableToJSON,
+} from './UserUnavailable';
+
+/**
+ * @type UserUnion
+ * 
+ * @export
+ */
+export type UserUnion = { typename: 'User' } & User | { typename: 'UserUnavailable' } & UserUnavailable;
+
+export function UserUnionFromJSON(json: any): UserUnion {
+    return UserUnionFromJSONTyped(json, false);
+}
+
+export function UserUnionFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserUnion {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    switch (json['__typename']) {
+        case 'User':
+            return {...UserFromJSONTyped(json, true), typename: 'User'};
+        case 'UserUnavailable':
+            return {...UserUnavailableFromJSONTyped(json, true), typename: 'UserUnavailable'};
+        default:
+            throw new Error(`No variant of UserUnion exists with 'typename=${json['__typename']}'`);
+    }
+}
+
+export function UserUnionToJSON(value?: UserUnion | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    switch (value['typename']) {
+        case 'User':
+            return UserToJSON(value);
+        case 'UserUnavailable':
+            return UserUnavailableToJSON(value);
+        default:
+            throw new Error(`No variant of UserUnion exists with 'typename=${value['typename']}'`);
+    }
+
+}
+

package/src/models/UsersResponse.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Twitter OpenAPI
+ * Twitter OpenAPI(Swagger) specification
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: yuki@yuki0311.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { UsersResponseData } from './UsersResponseData';
+import {
+    UsersResponseDataFromJSON,
+    UsersResponseDataFromJSONTyped,
+    UsersResponseDataToJSON,
+} from './UsersResponseData';
+
+/**
+ * 
+ * @export
+ * @interface UsersResponse
+ */
+export interface UsersResponse {
+    /**
+     * 
+     * @type {UsersResponseData}
+     * @memberof UsersResponse
+     */
+    data: UsersResponseData;
+}
+
+/**
+ * Check if a given object implements the UsersResponse interface.
+ */
+export function instanceOfUsersResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "data" in value;
+
+    return isInstance;
+}
+
+export function UsersResponseFromJSON(json: any): UsersResponse {
+    return UsersResponseFromJSONTyped(json, false);
+}
+
+export function UsersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UsersResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'data': UsersResponseDataFromJSON(json['data']),
+    };
+}
+
+export function UsersResponseToJSON(value?: UsersResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'data': UsersResponseDataToJSON(value.data),
+    };
+}
+

package/src/models/UsersResponseData.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Twitter OpenAPI
+ * Twitter OpenAPI(Swagger) specification
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: yuki@yuki0311.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { UserResults } from './UserResults';
+import {
+    UserResultsFromJSON,
+    UserResultsFromJSONTyped,
+    UserResultsToJSON,
+} from './UserResults';
+
+/**
+ * 
+ * @export
+ * @interface UsersResponseData
+ */
+export interface UsersResponseData {
+    /**
+     * 
+     * @type {Array<UserResults>}
+     * @memberof UsersResponseData
+     */
+    users: Array<UserResults>;
+}
+
+/**
+ * Check if a given object implements the UsersResponseData interface.
+ */
+export function instanceOfUsersResponseData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "users" in value;
+
+    return isInstance;
+}
+
+export function UsersResponseDataFromJSON(json: any): UsersResponseData {
+    return UsersResponseDataFromJSONTyped(json, false);
+}
+
+export function UsersResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UsersResponseData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'users': ((json['users'] as Array<any>).map(UserResultsFromJSON)),
+    };
+}
+
+export function UsersResponseDataToJSON(value?: UsersResponseData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'users': ((value.users as Array<any>).map(UserResultsToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -15,12 +15,15 @@ export * from './CreateTweet';
 export * from './CreateTweetResponse';
 export * from './CreateTweetResponseData';
 export * from './CreateTweetResponseResult';
+export * from './CursorType';
 export * from './DeleteRetweetResponse';
 export * from './DeleteRetweetResponseData';
 export * from './DeleteTweetResponse';
 export * from './DeleteTweetResponseData';
 export * from './DeleteTweetResponseResult';
 export * from './Entities';
+export * from './ErrorExtensions';
+export * from './Errors';
 export * from './ExtendedEntities';
 export * from './FavoriteTweet';
 export * from './FavoriteTweetResponseData';
@@ -29,45 +32,77 @@ export * from './FollowResponseData';
 export * from './FollowResponseResult';
 export * from './FollowResponseUser';
 export * from './FollowTimeline';
+export * from './GetBookmarks200Response';
+export * from './GetFavoriters200Response';
+export * from './GetFollowers200Response';
+export * from './GetHomeLatestTimeline200Response';
+export * from './GetLikes200Response';
+export * from './GetListLatestTweetsTimeline200Response';
+export * from './GetProfileSpotlightsQuery200Response';
+export * from './GetRetweeters200Response';
+export * from './GetSearchTimeline200Response';
+export * from './GetTweetDetail200Response';
+export * from './GetUserByRestId200Response';
+export * from './GetUserHighlightsTweets200Response';
+export * from './GetUsersByRestIds200Response';
 export * from './HomeTimelineHome';
 export * from './HomeTimelineResponseData';
 export * from './InstructionType';
 export * from './InstructionUnion';
 export * from './ItemContentUnion';
 export * from './ItemResult';
+export * from './ListLatestTweetsTimelineResponse';
 export * from './ListTweetsTimeline';
 export * from './ListTweetsTimelineData';
 export * from './ListTweetsTimelineList';
-export * from './ListTweetsTimelineResponse';
+export * from './Location';
 export * from './Media';
 export * from './MediaOriginalInfo';
+export * from './ModelError';
 export * from './ModuleEntry';
 export * from './ModuleItem';
 export * from './OneFactorLoginEligibility';
+export * from './Other200Response';
 export * from './OtherResponse';
+export * from './PostCreateRetweet200Response';
 export * from './PostCreateRetweetRequest';
 export * from './PostCreateRetweetRequestVariables';
+export * from './PostCreateTweet200Response';
 export * from './PostCreateTweetRequest';
 export * from './PostCreateTweetRequestFeatures';
 export * from './PostCreateTweetRequestVariables';
 export * from './PostCreateTweetRequestVariablesMedia';
+export * from './PostDeleteRetweet200Response';
 export * from './PostDeleteRetweetRequest';
 export * from './PostDeleteRetweetRequestVariables';
+export * from './PostDeleteTweet200Response';
 export * from './PostDeleteTweetRequest';
+export * from './PostFavoriteTweet200Response';
 export * from './PostFavoriteTweetRequest';
+export * from './PostUnfavoriteTweet200Response';
 export * from './PostUnfavoriteTweetRequest';
 export * from './ProfileResponse';
 export * from './ProfileResponseData';
 export * from './Retweet';
 export * from './RetweetLegacy';
+export * from './SearchByRawQuery';
+export * from './SearchTimeline';
+export * from './SearchTimelineData';
+export * from './SearchTimelineResponse';
 export * from './Session';
 export * from './SocialContext';
 export * from './Timeline';
 export * from './TimelineAddEntries';
 export * from './TimelineAddEntry';
+export * from './TimelineAddToModule';
 export * from './TimelineClearCache';
+export * from './TimelineMessagePrompt';
 export * from './TimelinePinEntry';
+export * from './TimelinePrompt';
+export * from './TimelineReplaceEntry';
 export * from './TimelineResponse';
+export * from './TimelineShowAlert';
+export * from './TimelineShowAlertRichText';
 export * from './TimelineTerminateTimeline';
 export * from './TimelineTimelineCursor';
 export * from './TimelineTimelineItem';
@@ -75,6 +110,7 @@ export * from './TimelineTimelineModule';
 export * from './TimelineTweet';
 export * from './TimelineUser';
 export * from './TimelineV2';
+export * from './Tracing';
 export * from './Tweet';
 export * from './TweetCard';
 export * from './TweetCardLegacy';
@@ -84,8 +120,12 @@ export * from './TweetDetailResponse';
 export * from './TweetDetailResponseData';
 export * from './TweetEditControl';
 export * from './TweetEditPrespective';
+export * from './TweetFavoritersResponse';
+export * from './TweetFavoritersResponseData';
 export * from './TweetLegacy';
 export * from './TweetLegacySelfThread';
+export * from './TweetRetweetersResponse';
+export * from './TweetRetweetersResponseData';
 export * from './TweetTombstone';
 export * from './TweetUnion';
 export * from './TweetViews';
@@ -96,6 +136,11 @@ export * from './UnfavoriteTweetResponseData';
 export * from './Url';
 export * from './User';
 export * from './UserFeatures';
+export * from './UserHighlightsTweetsData';
+export * from './UserHighlightsTweetsResponse';
+export * from './UserHighlightsTweetsResult';
+export * from './UserHighlightsTweetsTimeline';
+export * from './UserHighlightsTweetsUser';
 export * from './UserLegacy';
 export * from './UserResponse';
 export * from './UserResponseData';
@@ -108,3 +153,7 @@ export * from './UserTweetsData';
 export * from './UserTweetsResponse';
 export * from './UserTweetsResult';
 export * from './UserTweetsUser';
+export * from './UserUnavailable';
+export * from './UserUnion';
+export * from './UsersResponse';
+export * from './UsersResponseData';

package/tools/openapi-generator-config.yaml

@@ -1,7 +1,7 @@
 inputSpec: twitter-openapi/dist/compatible/openapi-3.0.yaml
 outputDir: .
 npmName: twitter-openapi-typescript-generated
-npmVersion: 0.0.7
+npmVersion: 0.0.9
 
 # withoutRuntimeChecks: false
 legacyDiscriminatorBehavior: false

package/tools/win/replace.py

@@ -29,7 +29,7 @@ package.update(
             "type": "git",
             "url": "https://github.com/fa0311/twitter-openapi-typescript.git",
         },
-        "keywords": ["twitter", "api", "typescript"],
+        "keywords": ["twitter", "api", "typescript", "scraper"],
     }
 )
 

package/twitter-openapi/.github/workflows/test-build.yaml

@@ -0,0 +1,87 @@
+name: build-test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      # Openapi Generator Setup
+      - name: Get OpenJDK 11
+        uses: actions/setup-java@v2
+        with:
+          distribution: "temurin"
+          java-version: 11
+
+      - name: Get Java version
+        run: java -version
+
+      - name: Get Openapi Generator cache file
+        id: openapi-generator-cache
+        run: echo "file=openapi-generator-cli.jar" >> $GITHUB_OUTPUT
+
+      - name: Openapi Generator cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.openapi-generator-cache.outputs.file }}
+          key: ${{ runner.os }}-openapi-generator-${{ hashFiles('openapi-generator-cli.jar') }}
+          restore-keys: |
+            ${{ runner.os }}-openapi-generator-
+
+      - name: Get Openapi Generator
+        run: |
+          wget https://github.com/fa0311/openapi-generator/releases/download/twitter_openapi_python_1.3.0/openapi-generator-cli.jar -O openapi-generator-cli.jar --no-verbose
+        if: steps.openapi-generator-cache.outputs.cache-hit != 'true'
+
+      # Python Setup
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          architecture: "x64"
+
+      - name: Get Python version
+        run: python -V
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+
+      - name: pip cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      # generate
+      - name: Build twitter-openapi
+        run: |
+          python tools/build.py
+
+      # clean up dependencies
+      - name: Clean up dependencies
+        run: |
+          pip uninstall -y -r requirements.txt
+
+      # generate
+      - name: Generate
+        run: |
+          java -jar openapi-generator-cli.jar generate -c test/python/openapi-generator-config.yaml -g python
+          java -jar openapi-generator-cli.jar generate -c test/dart-dio/openapi-generator-config.yaml -g dart-dio
+          java -jar openapi-generator-cli.jar generate -c test/typescript-fetch/openapi-generator-config.yaml -g typescript-fetch