twitter-openapi-typescript-generated 0.0.8 → 0.0.10

package/twitter-openapi/dist/docs/schemas/user.yaml

@@ -5,8 +5,10 @@ components:
         __typename:
           $ref: ./typename.yaml#/components/schemas/TypeName
         affiliates_highlighted_label:
+          additionalProperties: true
           type: object
         business_account:
+          additionalProperties: true
           type: object
         has_graduated_access:
           type: boolean
@@ -14,7 +16,7 @@ components:
           default: false
           type: boolean
         id:
-          pattern: ^[a-z\-]+[0-9]+$
+          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
           type: string
         is_blue_verified:
           default: false
@@ -68,6 +70,7 @@ components:
         description:
           type: string
         entities:
+          additionalProperties: true
           type: object
         fast_followers_count:
           type: integer
@@ -162,10 +165,7 @@ components:
       - entities
       - fast_followers_count
       - favourites_count
-      - follow_request_sent
-      - followed_by
       - followers_count
-      - following
       - friends_count
       - has_custom_timelines
       - is_translator
@@ -175,12 +175,10 @@ components:
       - muting
       - name
       - normal_followers_count
-      - notifications
       - pinned_tweet_ids_str
       - possibly_sensitive
       - profile_image_url_https
       - profile_interstitial_type
-      - protected
       - screen_name
       - status
       - statuses_count
@@ -196,9 +194,27 @@ components:
     UserResults:
       properties:
         result:
-          $ref: '#/components/schemas/User'
+          $ref: '#/components/schemas/UserUnion'
       required:
       - result
+    UserUnavailable:
+      properties:
+        __typename:
+          $ref: ./typename.yaml#/components/schemas/TypeName
+        reason:
+          type: string
+      required:
+      - __typename
+      - reason
+    UserUnion:
+      discriminator:
+        mapping":
+          User: '#/components/schemas/User'
+          UserUnavailable: '#/components/schemas/UserUnavailable'
+        propertyName: __typename
+      oneOf:
+      - $ref: '#/components/schemas/User'
+      - $ref: '#/components/schemas/UserUnavailable'
 info:
   title: Twitter OpenAPI
   version: 0.0.1

package/twitter-openapi/src/config/placeholder.json

@@ -115,13 +115,15 @@
       "highlights_tweets_tab_ui_enabled": true,
       "creator_subscriptions_tweet_preview_api_enabled": true,
       "responsive_web_graphql_skip_user_profile_image_extensions_enabled": false,
-      "responsive_web_graphql_timeline_navigation_enabled":true
+      "responsive_web_graphql_timeline_navigation_enabled": true
     }
   },
   "UsersByRestIds": {
     "queryId": "GD4q8bBE2i6cqWw2iT74Gg",
     "variables": {
-      "userIds": ["44196397"]
+      "userIds": [
+        "44196397"
+      ]
     },
     "features": {
       "responsive_web_graphql_exclude_directive_enabled": true,
@@ -201,6 +203,41 @@
       "responsive_web_enhance_cards_enabled": false
     }
   },
+  "UserHighlightsTweets": {
+    "queryId": "sTveqh05FMMAFfDNpRc_Jg",
+    "variables": {
+      "userId": "44196397",
+      "count": 20,
+      "includePromotedContent": true,
+      "withVoice": true
+    },
+    "features": {
+      "rweb_lists_timeline_redesign_enabled": true,
+      "responsive_web_graphql_exclude_directive_enabled": true,
+      "verified_phone_label_enabled": false,
+      "creator_subscriptions_tweet_preview_api_enabled": true,
+      "responsive_web_graphql_timeline_navigation_enabled": true,
+      "responsive_web_graphql_skip_user_profile_image_extensions_enabled": false,
+      "tweetypie_unmention_optimization_enabled": true,
+      "responsive_web_edit_tweet_api_enabled": true,
+      "graphql_is_translatable_rweb_tweet_is_translatable_enabled": true,
+      "view_counts_everywhere_api_enabled": true,
+      "longform_notetweets_consumption_enabled": true,
+      "responsive_web_twitter_article_tweet_consumption_enabled": false,
+      "tweet_awards_web_tipping_enabled": false,
+      "freedom_of_speech_not_reach_fetch_enabled": true,
+      "standardized_nudges_misinfo": true,
+      "tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled": true,
+      "longform_notetweets_rich_text_read_enabled": true,
+      "longform_notetweets_inline_media_enabled": true,
+      "responsive_web_media_download_video_enabled": false,
+      "responsive_web_enhance_cards_enabled": false
+    },
+    "fieldToggles": {
+      "withAuxiliaryUserLabels": false,
+      "withArticleRichContentState": false
+    }
+  },
   "UserMedia": {
     "queryId": "YqiE3JL1KNgf9nSljYdxaA",
     "variables": {
@@ -330,6 +367,36 @@
       "responsive_web_enhance_cards_enabled": false
     }
   },
+  "TweetResultByRestId": {
+    "queryId": "0hWvDhmW8YQ-S_ib3azIrw",
+    "variables": {
+      "tweetId": "1691730070669517096",
+      "withCommunity": false,
+      "includePromotedContent": false,
+      "withVoice": false
+    },
+    "features": {
+      "creator_subscriptions_tweet_preview_api_enabled": true,
+      "tweetypie_unmention_optimization_enabled": true,
+      "responsive_web_edit_tweet_api_enabled": true,
+      "graphql_is_translatable_rweb_tweet_is_translatable_enabled": true,
+      "view_counts_everywhere_api_enabled": true,
+      "longform_notetweets_consumption_enabled": true,
+      "responsive_web_twitter_article_tweet_consumption_enabled": false,
+      "tweet_awards_web_tipping_enabled": false,
+      "freedom_of_speech_not_reach_fetch_enabled": true,
+      "standardized_nudges_misinfo": true,
+      "tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled": true,
+      "longform_notetweets_rich_text_read_enabled": true,
+      "longform_notetweets_inline_media_enabled": true,
+      "responsive_web_graphql_exclude_directive_enabled": true,
+      "verified_phone_label_enabled": false,
+      "responsive_web_media_download_video_enabled": false,
+      "responsive_web_graphql_skip_user_profile_image_extensions_enabled": false,
+      "responsive_web_graphql_timeline_navigation_enabled": true,
+      "responsive_web_enhance_cards_enabled": false
+    }
+  },
   "SearchTimeline": {
     "queryId": "L1VfBERtzc3VkBBT0YAYHA",
     "variables": {
@@ -687,4 +754,4 @@
     "include_ext_edit_control": true,
     "ext": "mediaStats,highlightedLabel,hasNftAvatar,voiceInfo,birdwatchPivot,enrichments,superFollowMetadata,unmentionInfo,editControl,vibe"
   }
-}
+}

package/twitter-openapi/src/openapi/openapi-3.0.yaml

@@ -56,11 +56,13 @@ security:
   - AuthType: []
 tags:
   - name: user
-    description: response User
+    description: Responses containing User objects.
+  - name: users
+    description: Responses containing List[User] objects.
   - name: user-list
-    description: response User list
+    description: Responses containing instruction objects.
   - name: tweet
-    description: response tweet
+    description: Responses containing instruction objects.
   - name: post
     description: post
   - name: v1.1-get

package/twitter-openapi/src/openapi/paths/bookmarks.yaml

@@ -14,7 +14,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/BookmarksResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/BookmarksResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "tweet"
 

package/twitter-openapi/src/openapi/paths/follow.yaml

@@ -14,7 +14,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/FollowResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/FollowResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "user-list"
 
@@ -28,7 +30,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/FollowResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/FollowResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "user-list"
 
@@ -42,7 +46,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/FollowResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/FollowResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "user-list"
 

package/twitter-openapi/src/openapi/paths/other.yaml

@@ -14,7 +14,8 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/OtherResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/OtherResponse"
       tags:
         - "other"
 

package/twitter-openapi/src/openapi/paths/post.yaml

@@ -14,7 +14,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/FavoriteTweetResponseData"
+                oneOf:
+                  - $ref: "#/components/schemas/FavoriteTweetResponseData"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "post"
 
@@ -28,7 +30,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/UnfavoriteTweetResponseData"
+                oneOf:
+                  - $ref: "#/components/schemas/UnfavoriteTweetResponseData"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "post"
 
@@ -42,7 +46,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/CreateRetweetResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/CreateRetweetResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "post"
 
@@ -56,7 +62,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/DeleteRetweetResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/DeleteRetweetResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "post"
 
@@ -70,7 +78,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/CreateTweetResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/CreateTweetResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "post"
 
@@ -84,7 +94,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/DeleteTweetResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/DeleteTweetResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "post"
 

package/twitter-openapi/src/openapi/paths/profile.yaml

@@ -14,7 +14,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/ProfileResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/ProfileResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
 
 components:
   schemas:
@@ -39,7 +41,7 @@ components:
       properties:
         id:
           type: string
-          pattern: "^[0-9a-zA-Z]+$"
+          pattern: "^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$" # base64
         result:
           $ref: "#/components/schemas/UserResultByScreenNameResult"
 
@@ -59,7 +61,8 @@ components:
         legacy:
           $ref: "#/components/schemas/UserResultByScreenNameLegacy"
         profilemodules:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         rest_id:
           type: string
           pattern: "^[0-9]+$"

package/twitter-openapi/src/openapi/paths/timeline.yaml

@@ -14,7 +14,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/TimelineResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/TimelineResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "tweet"
 
@@ -28,7 +30,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/TimelineResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/TimelineResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "tweet"
 
@@ -42,7 +46,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/ListLatestTweetsTimelineResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/ListLatestTweetsTimelineResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "tweet"
 
@@ -56,7 +62,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/SearchTimelineResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/SearchTimelineResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "tweet"
 

package/twitter-openapi/src/openapi/paths/tweet.yaml

@@ -14,13 +14,31 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/TweetDetailResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/TweetDetailResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "tweet"
 
+  /graphql/{pathQueryId}/TweetResultByRestId:
+    get:
+      operationId: getTweetResultByRestId
+      description: get TweetResultByRestId
+      responses:
+        "200":
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: "#/components/schemas/TweetResultByRestIdResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
+      # tags:
+      #   - "tweet"
+
   /graphql/{pathQueryId}/Favoriters:
     get:
-      operationId: getTweetFavoriters
+      operationId: getFavoriters
       description: get tweet favoriters
       responses:
         "200":
@@ -28,13 +46,15 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/TweetFavoritersResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/TweetFavoritersResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "user-list"
 
   /graphql/{pathQueryId}/Retweeters:
     get:
-      operationId: getTweetRetweeters
+      operationId: getRetweeters
       description: get tweet retweeters
       responses:
         "200":
@@ -42,7 +62,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/TweetRetweetersResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/TweetRetweetersResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "user-list"
 
@@ -62,6 +84,20 @@ components:
         threaded_conversation_with_injections_v2:
           $ref: "./../schemas/timeline.yaml#/components/schemas/Timeline"
 
+    TweetResultByRestIdResponse:
+      required:
+        - "data"
+      properties:
+        data:
+          $ref: "#/components/schemas/TweetResultByRestIdData"
+
+    TweetResultByRestIdData:
+      required:
+        - "tweetResult"
+      properties:
+        tweetResult:
+          $ref: "./../schemas/content.yaml#/components/schemas/ItemResult"
+
     TweetFavoritersResponse:
       required:
         - "data"

package/twitter-openapi/src/openapi/paths/user.yaml

@@ -14,7 +14,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/UserResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/UserResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "user"
 
@@ -28,7 +30,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/UserResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/UserResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "user"
 
@@ -42,9 +46,11 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/UsersResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/UsersResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
-        - "user"
+        - "users"
 
 components:
   schemas:

package/twitter-openapi/src/openapi/paths/usertweets.yaml

@@ -14,7 +14,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/UserTweetsResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/UserTweetsResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "tweet"
 
@@ -28,7 +30,25 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/UserTweetsResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/UserTweetsResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
+      tags:
+        - "tweet"
+
+  /graphql/{pathQueryId}/UserHighlightsTweets:
+    get:
+      operationId: getUserHighlightsTweets
+      description: "get user highlights tweets"
+      responses:
+        "200":
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: "#/components/schemas/UserHighlightsTweetsResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "tweet"
 
@@ -42,7 +62,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/UserTweetsResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/UserTweetsResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "tweet"
 
@@ -56,7 +78,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/UserTweetsResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/UserTweetsResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "tweet"
 
@@ -92,3 +116,41 @@ components:
           $ref: "./../schemas/typename.yaml#/components/schemas/TypeName" # User
         timeline_v2:
           $ref: "./../schemas/timeline.yaml#/components/schemas/TimelineV2"
+
+    UserHighlightsTweetsResponse:
+      required:
+        - "data"
+      properties:
+        data:
+          $ref: "#/components/schemas/UserHighlightsTweetsData"
+
+    UserHighlightsTweetsData:
+      required:
+        - "user"
+      properties:
+        user:
+          $ref: "#/components/schemas/UserHighlightsTweetsUser"
+
+    UserHighlightsTweetsUser:
+      required:
+        - "result"
+      properties:
+        result:
+          $ref: "#/components/schemas/UserHighlightsTweetsResult"
+
+    UserHighlightsTweetsResult:
+      required:
+        - "timeline"
+        - "__typename"
+      properties:
+        timeline:
+          $ref: "#/components/schemas/UserHighlightsTweetsTimeline"
+        __typename:
+          $ref: "./../schemas/typename.yaml#/components/schemas/TypeName" # User
+
+    UserHighlightsTweetsTimeline:
+      required:
+        - "timeline"
+      properties:
+        timeline:
+          $ref: "./../schemas/timeline.yaml#/components/schemas/Timeline"