twitter-openapi-typescript-generated 0.0.8 → 0.0.9

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/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,6 +32,19 @@ 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';
@@ -39,22 +55,31 @@ export * from './ListLatestTweetsTimelineResponse';
 export * from './ListTweetsTimeline';
 export * from './ListTweetsTimelineData';
 export * from './ListTweetsTimelineList';
+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';
@@ -85,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';
@@ -110,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';
@@ -122,5 +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.8
+npmVersion: 0.0.9
 
 # withoutRuntimeChecks: false
 legacyDiscriminatorBehavior: false

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

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

@@ -0,0 +1,100 @@
+name: test-python
+
+on:
+  pull_request_target:
+    types: [labeled]
+  workflow_dispatch:
+
+jobs:
+  build_and_preview:
+    runs-on: ubuntu-latest
+    name: Test
+    if: contains(github.event.pull_request.labels.*.name, 'safe to test')
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: "${{ github.event.pull_request.merge_commit_sha }}"
+
+      # 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 Python client
+        run: |
+          java -jar openapi-generator-cli.jar generate -c test/python/openapi-generator-config.yaml -g python
+
+      # test
+      - name: Test Python client
+        run: |
+          pip install ./python_generated
+
+      - name: Run Python client test
+        run: |
+          python test/python/test_serialize.py
+        env:
+          TWITTER_SESSION: ${{ secrets.TWITTER_SESSION }}
+          ERROR_UNCATCHED: "False"
+          SLEEP_TIME: 2
+          CUESOR_TEST_COUNT: 5

package/twitter-openapi/.vscode/launch.json

@@ -0,0 +1,25 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "build",
+      "type": "python",
+      "request": "launch",
+      "program": "tools/build.py",
+      "console": "integratedTerminal",
+      "justMyCode": true
+    },
+    {
+      "name": "test",
+      "type": "python",
+      "request": "launch",
+      "program": "test/python/test_serialize.py",
+      "console": "integratedTerminal",
+      "justMyCode": false,
+      "preLaunchTask": "build-task",
+      "env": {
+        "ERROR_UNCATCHED": "True"
+      }
+    }
+  ]
+}

package/twitter-openapi/.vscode/settings.json

@@ -4,6 +4,6 @@
   "yaml.validate": true,
   "yaml.hover": true,
   "yaml.schemas": {
-    "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json": "twitter-openapi/**/*.yaml"
+    "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json": "src/**/*.yaml"
   }
 }

package/twitter-openapi/.vscode/tasks.json

@@ -0,0 +1,45 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "build-task",
+      "type": "shell",
+      "linux": {
+        "command": [
+          "python3 tools/build.py;",
+          "java -jar openapi-generator-cli.jar generate -c test/python/openapi-generator-config.yaml -g python;",
+          "python3 -m pip install ./python_generated;"
+        ]
+      },
+      "windows": {
+        "command": [
+          ".venv/Scripts/activate;",
+          "python tools/build.py;",
+          "java -jar openapi-generator-cli.jar generate -c test/python/openapi-generator-config.yaml -g python;",
+          "python -m pip install ./python_generated;"
+        ]
+      }
+    },
+    {
+      "label": "init-venv",
+      "type": "shell",
+      "runOptions": {
+        "runOn": "folderOpen"
+      },
+      "linux": {
+        "command": [
+          "python3 -m venv .venv;",
+          ".venv/bin/python3 -m pip install -r requirements.txt;",
+          "wget https://github.com/fa0311/openapi-generator/releases/download/twitter_openapi_python_1.3.0/openapi-generator-cli.jar -O openapi-generator-cli.jar;"
+        ]
+      },
+      "windows": {
+        "command": [
+          "python -m venv .venv;",
+          ".venv/Scripts/python -m pip install -r requirements.txt;",
+          "Invoke-WebRequest https://github.com/fa0311/openapi-generator/releases/download/twitter_openapi_python_1.3.0/openapi-generator-cli.jar -OutFile openapi-generator-cli.jar;"
+        ]
+      }
+    }
+  ]
+}

package/twitter-openapi/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# CONTRIBUTING
+
+- `src` *.yaml files should be written according to the [v3.0/schema.json](https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json)
+- `dist` Do not rewrite this file as it is an automatically generated OpenAPI file.
+- `dist` Do not include this in the pull request due to potential conflicts.
+
+Users using vscode can build and test with the GUI.
+[.vscode/launch.json](.vscode/launch.json) is a configuration file for vscode.
+
+## Good first issues
+
+- Add a new endpoint
+- Add type to `type: object # todo`

package/twitter-openapi/README.md

@@ -2,6 +2,7 @@
 
 Twitter OpenAPI(Swagger) specification
 
+- [Python](https://github.com/fa0311/twitter_openapi_python)
 - [Dart](https://github.com/fa0311/twitter_openapi_dart)
 - [TypeScript](https://github.com/fa0311/twitter-openapi-typescript)
 - [React Documents](https://github.com/fa0311/twitter-openapi-docs)
@@ -20,8 +21,7 @@ Note that the license also inherits to the output.
 
 ## Contribute
 
-- `src` *.yaml files should be written according to the [v3.0/schema.json](https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json)
-- `dist` Do not rewrite this file as it is an automatically generated OpenAPI file.
+[CONTRIBUTING.md](./CONTRIBUTING.md)
 
 ### build
 

package/twitter-openapi/dist/compatible/openapi-3.0.yaml

@@ -110,6 +110,8 @@ paths:
     $ref: ./paths/user.yaml#/paths/~1graphql~1{pathQueryId}~1UserByRestId
   /graphql/{pathQueryId}/UserByScreenName:
     $ref: ./paths/user.yaml#/paths/~1graphql~1{pathQueryId}~1UserByScreenName
+  /graphql/{pathQueryId}/UserHighlightsTweets:
+    $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1UserHighlightsTweets
   /graphql/{pathQueryId}/UserMedia:
     $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1UserMedia
   /graphql/{pathQueryId}/UserTweets:
@@ -133,11 +135,13 @@ security:
 servers:
 - url: https://twitter.com/i/api
 tags:
-- description: response User
+- description: Responses containing User objects.
   name: user
-- description: response User list
+- description: Responses containing List[User] objects.
+  name: users
+- description: Responses containing instruction objects.
   name: user-list
-- description: response tweet
+- description: Responses containing instruction objects.
   name: tweet
 - description: post
   name: post

package/twitter-openapi/dist/compatible/paths/bookmarks.yaml

@@ -74,7 +74,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/BookmarksResponse'
+                oneOf:
+                - $ref: '#/components/schemas/BookmarksResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:

package/twitter-openapi/dist/compatible/paths/follow.yaml

@@ -91,7 +91,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FollowResponse'
+                oneOf:
+                - $ref: '#/components/schemas/FollowResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -182,7 +184,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FollowResponse'
+                oneOf:
+                - $ref: '#/components/schemas/FollowResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -264,7 +268,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FollowResponse'
+                oneOf:
+                - $ref: '#/components/schemas/FollowResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash: