twitter-openapi-typescript-generated 0.0.8 → 0.0.10

package/twitter-openapi/dist/compatible/schemas/tweet.yaml

@@ -36,6 +36,7 @@ components:
       required:
       - media
     Hashtag:
+      additionalProperties: true
       type: object
     Media:
       properties:
@@ -46,6 +47,7 @@ components:
           format: uri
           type: string
         ext_media_availability:
+          additionalProperties: true
           type: object
         id_str:
           pattern: ^[0-9]+$
@@ -64,6 +66,7 @@ components:
           properties:
             focus_rects:
               items:
+                additionalProperties: true
                 type: object
               type: array
             height:
@@ -72,6 +75,7 @@ components:
               type: integer
           type: object
         sizes:
+          additionalProperties: true
           type: object
         type:
           type: string
@@ -89,6 +93,7 @@ components:
       - sizes
       - original_info
     Symbol:
+      additionalProperties: true
       type: object
     Tweet:
       properties:
@@ -169,6 +174,7 @@ components:
           pattern: ^[0-9]+$
           type: string
         unmention_data:
+          additionalProperties: true
           type: object
         views:
           properties:
@@ -182,7 +188,6 @@ components:
       - rest_id
       - core
       - edit_control
-      - edit_prespective
       - is_translatable
       - legacy
       - views
@@ -264,6 +269,7 @@ components:
       - user_id_str
       - id_str
     TweetTombstone:
+      additionalProperties: true
       properties:
         __typename:
           $ref: ./typename.yaml#/components/schemas/TypeName
@@ -308,6 +314,7 @@ components:
       - display_url
       type: object
     UserMention:
+      additionalProperties: true
       type: object
 info:
   title: Twitter OpenAPI

package/twitter-openapi/dist/compatible/schemas/typename.yaml

@@ -9,8 +9,11 @@ components:
       - TweetWithVisibilityResults
       - TimelineTimelineModule
       - TweetTombstone
+      - TimelinePrompt
+      - TimelineMessagePrompt
       - Tweet
       - User
+      - UserUnavailable
       type: string
 info:
   title: Twitter OpenAPI

package/twitter-openapi/dist/compatible/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/dist/docs/openapi-3.0.yaml

@@ -104,12 +104,16 @@ paths:
     $ref: ./paths/timeline.yaml#/paths/~1graphql~1{pathQueryId}~1SearchTimeline
   /graphql/{pathQueryId}/TweetDetail:
     $ref: ./paths/tweet.yaml#/paths/~1graphql~1{pathQueryId}~1TweetDetail
+  /graphql/{pathQueryId}/TweetResultByRestId:
+    $ref: ./paths/tweet.yaml#/paths/~1graphql~1{pathQueryId}~1TweetResultByRestId
   /graphql/{pathQueryId}/UnfavoriteTweet:
     $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1UnfavoriteTweet
   /graphql/{pathQueryId}/UserByRestId:
     $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 +137,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/docs/paths/bookmarks.yaml

@@ -168,7 +168,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/docs/paths/follow.yaml

@@ -183,7 +183,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:
@@ -376,7 +378,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:
@@ -550,7 +554,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:

package/twitter-openapi/dist/docs/paths/other.yaml

@@ -90,7 +90,8 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/OtherResponse'
+                oneOf:
+                - $ref: '#/components/schemas/OtherResponse'
           description: Successful operation
       tags:
       - other

package/twitter-openapi/dist/docs/paths/post.yaml

@@ -177,7 +177,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CreateRetweetResponse'
+                oneOf:
+                - $ref: '#/components/schemas/CreateRetweetResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -369,7 +371,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CreateTweetResponse'
+                oneOf:
+                - $ref: '#/components/schemas/CreateTweetResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -439,7 +443,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/DeleteRetweetResponse'
+                oneOf:
+                - $ref: '#/components/schemas/DeleteRetweetResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -509,7 +515,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/DeleteTweetResponse'
+                oneOf:
+                - $ref: '#/components/schemas/DeleteTweetResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -579,7 +587,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FavoriteTweetResponseData'
+                oneOf:
+                - $ref: '#/components/schemas/FavoriteTweetResponseData'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -649,7 +659,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UnfavoriteTweetResponseData'
+                oneOf:
+                - $ref: '#/components/schemas/UnfavoriteTweetResponseData'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:

package/twitter-openapi/dist/docs/paths/profile.yaml

@@ -15,7 +15,7 @@ components:
     UserResultByScreenName:
       properties:
         id:
-          pattern: ^[0-9a-zA-Z]+$
+          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
           type: string
         result:
           $ref: '#/components/schemas/UserResultByScreenNameResult'
@@ -48,6 +48,7 @@ components:
         legacy:
           $ref: '#/components/schemas/UserResultByScreenNameLegacy'
         profilemodules:
+          additionalProperties: true
           type: object
         rest_id:
           pattern: ^[0-9]+$
@@ -102,7 +103,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ProfileResponse'
+                oneOf:
+                - $ref: '#/components/schemas/ProfileResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:

package/twitter-openapi/dist/docs/paths/timeline.yaml

@@ -221,7 +221,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/TimelineResponse'
+                oneOf:
+                - $ref: '#/components/schemas/TimelineResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -405,7 +407,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/TimelineResponse'
+                oneOf:
+                - $ref: '#/components/schemas/TimelineResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -574,7 +578,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ListLatestTweetsTimelineResponse'
+                oneOf:
+                - $ref: '#/components/schemas/ListLatestTweetsTimelineResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -772,7 +778,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/SearchTimelineResponse'
+                oneOf:
+                - $ref: '#/components/schemas/SearchTimelineResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:

package/twitter-openapi/dist/docs/paths/tweet.yaml

@@ -24,6 +24,18 @@ components:
           $ref: ./../schemas/timeline.yaml#/components/schemas/TimelineV2
       required:
       - favoriters_timeline
+    TweetResultByRestIdData:
+      properties:
+        tweetResult:
+          $ref: ./../schemas/content.yaml#/components/schemas/ItemResult
+      required:
+      - tweetResult
+    TweetResultByRestIdResponse:
+      properties:
+        data:
+          $ref: '#/components/schemas/TweetResultByRestIdData'
+      required:
+      - data
     TweetRetweetersResponse:
       properties:
         data:
@@ -44,7 +56,7 @@ paths:
   /graphql/{pathQueryId}/Favoriters:
     get:
       description: get tweet favoriters
-      operationId: getTweetFavoriters
+      operationId: getFavoriters
       parameters:
       - in: path
         name: pathQueryId
@@ -191,7 +203,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/TweetFavoritersResponse'
+                oneOf:
+                - $ref: '#/components/schemas/TweetFavoritersResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -223,7 +237,7 @@ paths:
   /graphql/{pathQueryId}/Retweeters:
     get:
       description: get tweet retweeters
-      operationId: getTweetRetweeters
+      operationId: getRetweeters
       parameters:
       - in: path
         name: pathQueryId
@@ -370,7 +384,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/TweetRetweetersResponse'
+                oneOf:
+                - $ref: '#/components/schemas/TweetRetweetersResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -569,7 +585,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/TweetDetailResponse'
+                oneOf:
+                - $ref: '#/components/schemas/TweetDetailResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -598,3 +616,182 @@ paths:
                 type: string
       tags:
       - tweet
+  /graphql/{pathQueryId}/TweetResultByRestId:
+    get:
+      description: get TweetResultByRestId
+      operationId: getTweetResultByRestId
+      parameters:
+      - in: path
+        name: pathQueryId
+        required: true
+        schema:
+          default: 0hWvDhmW8YQ-S_ib3azIrw
+          example: 0hWvDhmW8YQ-S_ib3azIrw
+          type: string
+      - content:
+          application/json:
+            schema:
+              properties:
+                includePromotedContent:
+                  default: false
+                  example: false
+                  type: boolean
+                tweetId:
+                  default: '1691730070669517096'
+                  example: '1691730070669517096'
+                  type: string
+                withCommunity:
+                  default: false
+                  example: false
+                  type: boolean
+                withVoice:
+                  default: false
+                  example: false
+                  type: boolean
+              required:
+              - tweetId
+              - withCommunity
+              - includePromotedContent
+              - withVoice
+              type: object
+        in: query
+        name: variables
+        required: true
+      - content:
+          application/json:
+            schema:
+              properties:
+                creator_subscriptions_tweet_preview_api_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                freedom_of_speech_not_reach_fetch_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                graphql_is_translatable_rweb_tweet_is_translatable_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                longform_notetweets_consumption_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                longform_notetweets_inline_media_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                longform_notetweets_rich_text_read_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                responsive_web_edit_tweet_api_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                responsive_web_enhance_cards_enabled:
+                  default: false
+                  example: false
+                  type: boolean
+                responsive_web_graphql_exclude_directive_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                responsive_web_graphql_skip_user_profile_image_extensions_enabled:
+                  default: false
+                  example: false
+                  type: boolean
+                responsive_web_graphql_timeline_navigation_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                responsive_web_media_download_video_enabled:
+                  default: false
+                  example: false
+                  type: boolean
+                responsive_web_twitter_article_tweet_consumption_enabled:
+                  default: false
+                  example: false
+                  type: boolean
+                standardized_nudges_misinfo:
+                  default: true
+                  example: true
+                  type: boolean
+                tweet_awards_web_tipping_enabled:
+                  default: false
+                  example: false
+                  type: boolean
+                tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                tweetypie_unmention_optimization_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+                verified_phone_label_enabled:
+                  default: false
+                  example: false
+                  type: boolean
+                view_counts_everywhere_api_enabled:
+                  default: true
+                  example: true
+                  type: boolean
+              required:
+              - creator_subscriptions_tweet_preview_api_enabled
+              - tweetypie_unmention_optimization_enabled
+              - responsive_web_edit_tweet_api_enabled
+              - graphql_is_translatable_rweb_tweet_is_translatable_enabled
+              - view_counts_everywhere_api_enabled
+              - longform_notetweets_consumption_enabled
+              - responsive_web_twitter_article_tweet_consumption_enabled
+              - tweet_awards_web_tipping_enabled
+              - freedom_of_speech_not_reach_fetch_enabled
+              - standardized_nudges_misinfo
+              - tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled
+              - longform_notetweets_rich_text_read_enabled
+              - longform_notetweets_inline_media_enabled
+              - responsive_web_graphql_exclude_directive_enabled
+              - verified_phone_label_enabled
+              - responsive_web_media_download_video_enabled
+              - responsive_web_graphql_skip_user_profile_image_extensions_enabled
+              - responsive_web_graphql_timeline_navigation_enabled
+              - responsive_web_enhance_cards_enabled
+              type: object
+        in: query
+        name: features
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                oneOf:
+                - $ref: '#/components/schemas/TweetResultByRestIdResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
+          description: Successful operation
+          headers:
+            x-connection-hash:
+              schema:
+                type: string
+            x-rate-limit-limit:
+              schema:
+                type: integer
+            x-rate-limit-remaining:
+              schema:
+                type: integer
+            x-rate-limit-reset:
+              schema:
+                type: integer
+            x-response-time:
+              schema:
+                type: integer
+            x-tfe-preserve-body:
+              schema:
+                type: boolean
+            x-transaction-id:
+              schema:
+                type: string
+            x-twitter-response-tags:
+              schema:
+                type: string

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

@@ -111,7 +111,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UserResponse'
+                oneOf:
+                - $ref: '#/components/schemas/UserResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -210,7 +212,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UserResponse'
+                oneOf:
+                - $ref: '#/components/schemas/UserResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -301,7 +305,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UsersResponse'
+                oneOf:
+                - $ref: '#/components/schemas/UsersResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -329,4 +335,4 @@ paths:
               schema:
                 type: string
       tags:
-      - user
+      - users