twitter-openapi-typescript-generated 0.0.7 → 0.0.9

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

@@ -14,10 +14,44 @@ 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}/Favoriters:
+    get:
+      operationId: getFavoriters
+      description: get tweet favoriters
+      responses:
+        "200":
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: "#/components/schemas/TweetFavoritersResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
+      tags:
+        - "user-list"
+
+  /graphql/{pathQueryId}/Retweeters:
+    get:
+      operationId: getRetweeters
+      description: get tweet retweeters
+      responses:
+        "200":
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: "#/components/schemas/TweetRetweetersResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
+      tags:
+        - "user-list"
+
 components:
   schemas:
     TweetDetailResponse:
@@ -33,3 +67,31 @@ components:
       properties:
         threaded_conversation_with_injections_v2:
           $ref: "./../schemas/timeline.yaml#/components/schemas/Timeline"
+
+    TweetFavoritersResponse:
+      required:
+        - "data"
+      properties:
+        data:
+          $ref: "#/components/schemas/TweetFavoritersResponseData"
+
+    TweetFavoritersResponseData:
+      required:
+        - "favoriters_timeline"
+      properties:
+        favoriters_timeline:
+          $ref: "./../schemas/timeline.yaml#/components/schemas/TimelineV2"
+
+    TweetRetweetersResponse:
+      required:
+        - "data"
+      properties:
+        data:
+          $ref: "#/components/schemas/TweetRetweetersResponseData"
+
+    TweetRetweetersResponseData:
+      required:
+        - "retweeters_timeline"
+      properties:
+        retweeters_timeline:
+          $ref: "./../schemas/timeline.yaml#/components/schemas/TimelineV2"

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

@@ -14,10 +14,44 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/UserResponse"
+                oneOf:
+                  - $ref: "#/components/schemas/UserResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "user"
 
+  /graphql/{pathQueryId}/UserByRestId:
+    get:
+      operationId: getUserByRestId
+      description: "get user by rest id"
+      responses:
+        "200":
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: "#/components/schemas/UserResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
+      tags:
+        - "user"
+
+  /graphql/{pathQueryId}/UsersByRestIds:
+    get:
+      operationId: getUsersByRestIds
+      description: "get users by rest ids"
+      responses:
+        "200":
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: "#/components/schemas/UsersResponse"
+                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
+      tags:
+        - "users"
+
 components:
   schemas:
     UserResponse:
@@ -33,3 +67,19 @@ components:
       properties:
         user:
           $ref: "./../schemas/user.yaml#/components/schemas/UserResults"
+
+    UsersResponse:
+      required:
+        - "data"
+      properties:
+        data:
+          $ref: "#/components/schemas/UsersResponseData"
+
+    UsersResponseData:
+      required:
+        - "users"
+      properties:
+        users:
+          type: array
+          items:
+            $ref: "./../schemas/user.yaml#/components/schemas/UserResults"

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"

package/twitter-openapi/src/openapi/schemas/content.yaml

@@ -23,6 +23,10 @@ components:
       enum:
         [TimelineTimelineItem, TimelineTimelineCursor, TimelineTimelineModule]
 
+    CursorType:
+      type: string
+      enum: [Top, Bottom, ShowMore, ShowMoreThreads, Gap] # Gap???
+
     TimelineTimelineItem:
       required:
         - "__typename"
@@ -32,14 +36,15 @@ components:
         __typename:
           $ref: "./typename.yaml#/components/schemas/TypeName" # TimelineTimelineItem
         entryType:
-          type: string # enum
           $ref: "#/components/schemas/ContentEntryType" # TimelineTimelineItem
         itemContent:
           $ref: "#/components/schemas/ItemContentUnion"
         clientEventInfo:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         feedbackInfo:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
 
     TimelineTimelineModule:
       required:
@@ -50,9 +55,9 @@ components:
         - "clientEventInfo"
       properties:
         __typename:
+          type: string
           $ref: "./typename.yaml#/components/schemas/TypeName" # TimelineTimelineModule
         entryType:
-          type: string # enum
           $ref: "#/components/schemas/ContentEntryType" # TimelineTimelineCursor
         displayType:
           type: string # enum
@@ -61,12 +66,15 @@ components:
           items:
             $ref: "#/components/schemas/ModuleItem"
         footer:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         header:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
 
         clientEventInfo:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
 
     TimelineTimelineCursor:
       required:
@@ -77,14 +85,11 @@ components:
         __typename:
           $ref: "./typename.yaml#/components/schemas/TypeName" # TimelineTimelineCursor
         entryType:
-          type: string # enum
           $ref: "#/components/schemas/ContentEntryType" # null | TimelineTimelineCursor
         itemType:
-          type: string # enum
           $ref: "#/components/schemas/ContentEntryType" # null | TimelineTimelineCursor
         cursorType:
-          type: string
-          enum: [Top, Bottom, ShowMore, ShowMoreThreads, Gap] # Gap???
+          $ref: "#/components/schemas/CursorType"
         value:
           type: string
 
@@ -97,7 +102,7 @@ components:
       properties:
         entryId:
           type: string
-          pattern: '^[a-z\-]+[0-9]+$'
+          pattern: "^(([a-z]+|[0-9]+|[0-9a-f]+)(-|$))+"
         item:
           $ref: "#/components/schemas/ModuleEntry"
 
@@ -107,7 +112,8 @@ components:
         - "itemContent"
       properties:
         clientEventInfo:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         itemContent:
           $ref: "#/components/schemas/ItemContentUnion"
 
@@ -118,16 +124,28 @@ components:
         - $ref: "#/components/schemas/TimelineTweet"
         - $ref: "#/components/schemas/TimelineTimelineCursor"
         - $ref: "#/components/schemas/TimelineUser"
+        - $ref: "#/components/schemas/TimelinePrompt"
+        - $ref: "#/components/schemas/TimelineMessagePrompt"
+
       discriminator:
-        propertyName: itemType
+        propertyName: __typename
         mapping": # deprecated
           TimelineTweet: "#/components/schemas/TimelineTweet"
           TimelineTimelineCursor: "#/components/schemas/TimelineTimelineCursor"
           TimelineUser: "#/components/schemas/TimelineUser"
+          TimelinePrompt: "#/components/schemas/TimelinePrompt"
+          TimelineMessagePrompt: "#/components/schemas/TimelineMessagePrompt"
 
     ContentItemType:
       type: string
-      enum: [TimelineTweet, TimelineTimelineCursor, TimelineUser]
+      enum:
+        [
+          TimelineTweet,
+          TimelineTimelineCursor,
+          TimelineUser,
+          TimelinePrompt,
+          TimelineMessagePrompt,
+        ]
 
     TimelineTweet:
       required:
@@ -139,7 +157,6 @@ components:
         __typename:
           $ref: "./typename.yaml#/components/schemas/TypeName" # TimelineTweet
         itemType:
-          type: string # enum
           $ref: "#/components/schemas/ContentItemType" # TimelineTweet
         tweetDisplayType:
           type: string
@@ -148,7 +165,8 @@ components:
         SocialContext:
           $ref: "#/components/schemas/SocialContext"
         promotedMetadata:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
 
     TimelineUser:
       required:
@@ -161,7 +179,6 @@ components:
         __typename:
           $ref: "./typename.yaml#/components/schemas/TypeName" # TimelineUser
         itemType:
-          type: string # enum
           $ref: "#/components/schemas/ContentItemType" # TimelineUser
         SocialContext:
           $ref: "#/components/schemas/SocialContext"
@@ -188,3 +205,15 @@ components:
           type: string
         type:
           type: string # enum
+
+    TimelinePrompt:
+      properties:
+        __typename:
+          $ref: "./typename.yaml#/components/schemas/TypeName" # TimelinePrompt
+      additionalProperties: true # todo
+
+    TimelineMessagePrompt:
+      properties:
+        __typename:
+          $ref: "./typename.yaml#/components/schemas/TypeName" # TimelineMessagePrompt
+      additionalProperties: true # todo

package/twitter-openapi/src/openapi/schemas/error.yaml

@@ -0,0 +1,99 @@
+openapi: 3.0.3
+info:
+  title: Twitter OpenAPI
+  version: 0.0.1
+
+paths: {}
+components:
+  schemas:
+    Errors:
+      type: object
+      required:
+        - errors
+      properties:
+        errors:
+          type: array
+          items:
+            $ref: "#/components/schemas/Error"
+
+    Error:
+      type: object
+      required:
+        - message
+        - locations
+        - path
+        - extensions
+        - code
+        - kind
+        - name
+        - source
+        - retry_after
+        - tracing
+      properties:
+        message:
+          type: string
+        locations:
+          type: array
+          items:
+            $ref: "#/components/schemas/Location"
+        path:
+          type: array
+          items:
+            type: string
+        extensions:
+          $ref: "#/components/schemas/ErrorExtensions"
+        code:
+          type: integer
+        kind:
+          type: string
+        name:
+          type: string
+        source:
+          type: string
+        retry_after:
+          type: integer
+        tracing:
+          $ref: "#/components/schemas/Tracing"
+
+    Location:
+      type: object
+      required:
+        - line
+        - column
+      properties:
+        line:
+          type: integer
+        column:
+          type: integer
+
+    ErrorExtensions:
+      type: object
+      required:
+        - name
+        - source
+        - retry_after
+        - code
+        - kind
+        - tracing
+      properties:
+        name:
+          type: string
+        source:
+          type: string
+        retry_after:
+          type: integer
+        code:
+          type: integer
+        kind:
+          type: string
+        tracing:
+          $ref: "#/components/schemas/Tracing"
+
+    Tracing:
+      type: object
+      required:
+        - trace_id
+      properties:
+        trace_id:
+          type: string
+          pattern: "^[0-9a-f]{16}$"

package/twitter-openapi/src/openapi/schemas/instruction.yaml

@@ -9,15 +9,21 @@ components:
     InstructionUnion:
       oneOf:
         - $ref: "#/components/schemas/TimelineAddEntries"
+        - $ref: "#/components/schemas/TimelineAddToModule"
         - $ref: "#/components/schemas/TimelineClearCache"
         - $ref: "#/components/schemas/TimelinePinEntry"
+        - $ref: "#/components/schemas/TimelineReplaceEntry"
+        - $ref: "#/components/schemas/TimelineShowAlert"
         - $ref: "#/components/schemas/TimelineTerminateTimeline"
       discriminator:
         propertyName: type
         mapping": # deprecated
           TimelineAddEntries: "#/components/schemas/TimelineAddEntries"
+          TimelineAddToModule: "#/components/schemas/TimelineAddToModule"
           TimelineClearCache: "#/components/schemas/TimelineClearCache"
           TimelinePinEntry: "#/components/schemas/TimelinePinEntry"
+          TimelineReplaceEntry: "#/components/schemas/TimelineReplaceEntry"
+          TimelineShowAlert: "#/components/schemas/TimelineShowAlert"
           TimelineTerminateTimeline: "#/components/schemas/TimelineTerminateTimeline"
 
     InstructionType:
@@ -25,8 +31,11 @@ components:
       enum:
         [
           TimelineAddEntries,
+          TimelineAddToModule,
           TimelineClearCache,
           TimelinePinEntry,
+          TimelineReplaceEntry,
+          TimelineShowAlert,
           TimelineTerminateTimeline,
         ]
 
@@ -36,19 +45,34 @@ components:
         - entries
       properties:
         type:
-          type: string
           $ref: "#/components/schemas/InstructionType" # TimelineAddEntries
         entries:
           type: array
           items:
             $ref: "#/components/schemas/TimelineAddEntry"
 
-    TimelineClearCache:
+    TimelineAddToModule:
       required:
         - type
+        - moduleItems
+        - moduleEntryId
       properties:
         type:
+          $ref: "#/components/schemas/InstructionType" # TimelineAddToModule
+        moduleItems:
+          type: array
+          items:
+            $ref: "./content.yaml#/components/schemas/ModuleItem"
+        moduleEntryId:
           type: string
+        prepend:
+          type: boolean
+
+    TimelineClearCache:
+      required:
+        - type
+      properties:
+        type:
           $ref: "#/components/schemas/InstructionType" # TimelineClearCache
 
     TimelinePinEntry:
@@ -57,18 +81,68 @@ components:
         - entry
       properties:
         type:
-          type: string
           $ref: "#/components/schemas/InstructionType" # TimelinePinEntry
         entry:
           $ref: "#/components/schemas/TimelineAddEntry"
 
+    TimelineReplaceEntry:
+      required:
+        - type
+        - entry_id_to_replace
+        - entry
+      properties:
+        type:
+          $ref: "#/components/schemas/InstructionType" # TimelineReplaceEntry
+        entry_id_to_replace:
+          type: string
+        entry:
+          $ref: "#/components/schemas/TimelineAddEntry"
+
+    TimelineShowAlert:
+      required:
+        - type
+        - usersResults
+        - richText
+      properties:
+        type:
+          $ref: "#/components/schemas/InstructionType" # TimelineShowAlert
+        alertType:
+          type: string
+          enum: [NewTweets] # which else?
+        triggerDelayMs:
+          type: integer
+        displayDurationMs:
+          type: integer
+        usersResults:
+          type: array
+          items:
+            $ref: "./user.yaml#/components/schemas/UserResults"
+        richText:
+          type: object
+          properties:
+            text:
+              type: string
+            entities:
+              type: array
+              items:
+                type: object
+                additionalProperties: true # todo
+        iconDisplayInfo:
+          type: object
+          additionalProperties: true # todo
+        colorConfig:
+          type: object
+          additionalProperties: true # todo
+        displayLocation:
+          type: string
+          enum: [Top] # which else?
+
     TimelineTerminateTimeline:
       required:
         - type
         - direction
       properties:
         type:
-          type: string
           $ref: "#/components/schemas/InstructionType" # TimelineTerminateTimeline
         direction:
           type: string
@@ -84,7 +158,7 @@ components:
           $ref: "./content.yaml#/components/schemas/ContentUnion"
         entryId:
           type: string
-          pattern: '^[a-z\-]+[0-9]+$'
+          pattern: "^(([a-z]+|[0-9]+|[0-9a-f]+)(-|$))+"
         sortIndex:
           type: string
           pattern: "[0-9]+$"

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

@@ -22,6 +22,8 @@ components:
           items:
             $ref: "./../schemas/instruction.yaml#/components/schemas/InstructionUnion"
         metadata:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo
         responseObjects:
-          type: object # todo
+          type: object
+          additionalProperties: true # todo