twitter-openapi-typescript-generated 0.0.4 → 0.0.6

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

@@ -0,0 +1,206 @@
+components:
+  schemas:
+    User:
+      properties:
+        __typename:
+          $ref: ./typename.yaml#/components/schemas/TypeName
+        affiliates_highlighted_label:
+          type: object
+        business_account:
+          type: object
+        has_graduated_access:
+          type: boolean
+        has_nft_avatar:
+          default: false
+          type: boolean
+        id:
+          pattern: ^[a-z\-]+[0-9]+$
+          type: string
+        is_blue_verified:
+          default: false
+          type: boolean
+        legacy:
+          $ref: '#/components/schemas/UserLegacy'
+        rest_id:
+          pattern: ^[0-9]+$
+          type: string
+        super_follow_eligible:
+          default: false
+          type: boolean
+        super_followed_by:
+          default: false
+          type: boolean
+        super_following:
+          default: false
+          type: boolean
+      required:
+      - __typename
+      - affiliates_highlighted_label
+      - id
+      - is_blue_verified
+      - legacy
+      - rest_id
+      - super_follow_eligible
+      - super_followed_by
+      - super_following
+    UserLegacy:
+      properties:
+        blocked_by:
+          default: false
+          type: boolean
+        blocking:
+          default: false
+          type: boolean
+        can_dm:
+          default: false
+          type: boolean
+        can_media_tag:
+          default: false
+          type: boolean
+        created_at:
+          $ref: ./general.yaml#/components/schemas/TwitterTimeFormat
+        default_profile:
+          default: false
+          type: boolean
+        default_profile_image:
+          default: false
+          type: boolean
+        description:
+          type: string
+        entities:
+          type: object
+        fast_followers_count:
+          type: integer
+        favourites_count:
+          default: 0
+          type: integer
+        follow_request_sent:
+          default: false
+          type: boolean
+        followed_by:
+          default: false
+          type: boolean
+        followers_count:
+          default: 0
+          type: integer
+        following:
+          default: false
+          type: boolean
+        friends_count:
+          default: 0
+          type: integer
+        has_custom_timelines:
+          default: false
+          type: boolean
+        is_translator:
+          default: false
+          type: boolean
+        listed_count:
+          default: 0
+          type: integer
+        location:
+          type: string
+        media_count:
+          default: 0
+          type: integer
+        muting:
+          default: false
+          type: boolean
+        name:
+          type: string
+        normal_followers_count:
+          default: 0
+          type: integer
+        notifications:
+          default: false
+          type: boolean
+        pinned_tweet_ids_str:
+          items:
+            type: string
+          type: array
+        possibly_sensitive:
+          default: false
+          type: boolean
+        profile_banner_extensions:
+          type: object
+        profile_banner_url:
+          format: uri
+          type: string
+        profile_image_extensions:
+          type: object
+        profile_image_url_https:
+          format: uri
+          type: string
+        profile_interstitial_type:
+          type: string
+        protected:
+          default: false
+          type: boolean
+        screen_name:
+          type: string
+        statuses_count:
+          default: 0
+          type: integer
+        translator_type:
+          type: string
+        url:
+          type: string
+        verified:
+          type: boolean
+        want_retweets:
+          default: false
+          type: boolean
+      required:
+      - blocked_by
+      - blocking
+      - can_dm
+      - can_media_tag
+      - created_at
+      - default_profile
+      - default_profile_image
+      - description
+      - entities
+      - fast_followers_count
+      - favourites_count
+      - follow_request_sent
+      - followed_by
+      - followers_count
+      - following
+      - friends_count
+      - has_custom_timelines
+      - is_translator
+      - listed_count
+      - location
+      - media_count
+      - 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
+      - translator_type
+      - verified
+      - want_retweets
+    UserResultCore:
+      properties:
+        user_results:
+          $ref: '#/components/schemas/UserResults'
+      required:
+      - user_results
+    UserResults:
+      properties:
+        result:
+          $ref: '#/components/schemas/User'
+      required:
+      - result
+info:
+  title: Twitter OpenAPI
+  version: 0.0.1
+openapi: 3.0.3
+paths: {}

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

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/Bookmarks:
+  /graphql/{pathQueryId}/Bookmarks:
     get:
       operationId: getBookmarks
       description: get bookmarks

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

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/Following:
+  /graphql/{pathQueryId}/Following:
     get:
       operationId: getFollowing
       description: get user list of following
@@ -18,7 +18,7 @@ paths:
       tags:
         - "user-list"
 
-  /graphql/{{queryId}}/Followers:
+  /graphql/{pathQueryId}/Followers:
     get:
       operationId: getFollowers
       description: get user list of followers

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

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/FavoriteTweet:
+  /graphql/{pathQueryId}/FavoriteTweet:
     post:
       operationId: postFavoriteTweet
       description: favorite Tweet
@@ -18,7 +18,7 @@ paths:
       tags:
         - "post"
 
-  /graphql/{{queryId}}/UnfavoriteTweet:
+  /graphql/{pathQueryId}/UnfavoriteTweet:
     post:
       operationId: postUnfavoriteTweet
       description: unfavorite Tweet
@@ -32,7 +32,7 @@ paths:
       tags:
         - "post"
 
-  /graphql/{{queryId}}/CreateRetweet:
+  /graphql/{pathQueryId}/CreateRetweet:
     post:
       operationId: postCreateRetweet
       description: create Retweet
@@ -46,7 +46,7 @@ paths:
       tags:
         - "post"
 
-  /graphql/{{queryId}}/DeleteRetweet:
+  /graphql/{pathQueryId}/DeleteRetweet:
     post:
       operationId: postDeleteRetweet
       description: delete Retweet
@@ -60,7 +60,7 @@ paths:
       tags:
         - "post"
 
-  /graphql/{{queryId}}/CreateTweet:
+  /graphql/{pathQueryId}/CreateTweet:
     post:
       operationId: postCreateTweet
       description: create Tweet
@@ -74,7 +74,7 @@ paths:
       tags:
         - "post"
 
-  /graphql/{{queryId}}/DeleteTweet:
+  /graphql/{pathQueryId}/DeleteTweet:
     post:
       operationId: postDeleteTweet
       description: delete Retweet

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

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/ProfileSpotlightsQuery:
+  /graphql/{pathQueryId}/ProfileSpotlightsQuery:
     get:
       operationId: getProfileSpotlightsQuery
       description: "get user by screen name"

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

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/HomeTimeline:
+  /graphql/{pathQueryId}/HomeTimeline:
     get:
       operationId: getHomeTimeline
       description: get tweet list of timeline
@@ -18,7 +18,7 @@ paths:
       tags:
         - "tweet"
 
-  /graphql/{{queryId}}/HomeLatestTimeline:
+  /graphql/{pathQueryId}/HomeLatestTimeline:
     get:
       operationId: getHomeLatestTimeline
       description: get tweet list of timeline
@@ -32,7 +32,7 @@ paths:
       tags:
         - "tweet"
 
-  /graphql/{{queryId}}/ListLatestTweetsTimeline:
+  /graphql/{pathQueryId}/ListLatestTweetsTimeline:
     get:
       operationId: getListLatestTweetsTimeline
       description: get tweet list of timeline

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

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/TweetDetail:
+  /graphql/{pathQueryId}/TweetDetail:
     get:
       operationId: getTweetDetail
       description: get TweetDetail

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

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/UserByScreenName:
+  /graphql/{pathQueryId}/UserByScreenName:
     get:
       operationId: getUserByScreenName
       description: "get user by screen name"

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

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/UserTweets:
+  /graphql/{pathQueryId}/UserTweets:
     get:
       operationId: getUserTweets
       description: "get user tweets"
@@ -18,7 +18,7 @@ paths:
       tags:
         - "tweet"
 
-  /graphql/{{queryId}}/UserTweetsAndReplies:
+  /graphql/{pathQueryId}/UserTweetsAndReplies:
     get:
       operationId: getUserTweetsAndReplies
       description: "get user replies tweets"
@@ -32,7 +32,7 @@ paths:
       tags:
         - "tweet"
 
-  /graphql/{{queryId}}/UserMedia:
+  /graphql/{pathQueryId}/UserMedia:
     get:
       operationId: getUserMedia
       description: "get user media tweets"
@@ -46,7 +46,7 @@ paths:
       tags:
         - "tweet"
 
-  /graphql/{{queryId}}/Likes:
+  /graphql/{pathQueryId}/Likes:
     get:
       operationId: getLikes
       description: "get user likes tweets"

package/twitter-openapi/src/openapi/resources/parameters.yaml

@@ -0,0 +1,15 @@
+openapi: 3.0.3
+info:
+  title: Twitter OpenAPI
+  version: 0.0.1
+
+paths: {}
+
+components:
+  parameters:
+    queryId:
+      name: queryId
+      in: path
+      required: true
+      schema:
+        type: string

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

@@ -53,6 +53,45 @@ components:
           pattern: "^[0-9]+$"
         core:
           $ref: "./user.yaml#/components/schemas/UserResultCore"
+        card:
+          type: object
+          properties:
+            rest_id:
+              type: string
+            legacy:
+              type: object
+              required:
+                - "binding_values"
+                - "name"
+                - "url"
+              properties:
+                name:
+                  type: string
+                url:
+                  type: string
+                binding_values:
+                  type: array
+                  items:
+                    type: object
+                    required:
+                      - "key"
+                      - "value"
+                    properties:
+                      key:
+                        type: string
+                      value:
+                        type: object
+                        required:
+                          - "type"
+                        properties:
+                          string_value:
+                            type: string
+                          boolean_value:
+                            type: boolean
+                          scribe_key:
+                            type: string
+                          type:
+                            type: string
         unmention_data:
           type: object # todo
         edit_control:
@@ -200,7 +239,25 @@ components:
     UserMention:
       type: object # todo
     Url:
-      type: object # todo
+      type: object
+      required:
+        - "url"
+        - "indices"
+        - "expanded_url"
+        - "display_url"
+      properties:
+        display_url:
+          type: string
+        expanded_url:
+          type: string
+          format: uri
+        url:
+          type: string
+          format: uri
+        indices:
+          type: array
+          items:
+            type: integer
 
     ExtendedEntities:
       required:

package/twitter-openapi/tools/build_config.py

@@ -10,11 +10,11 @@ class Config:
             "docs": {
                 "openapi": [AddSecuritySchemesOnSecuritySchemes()],
                 "schemas": [],
-                "other":[],
+                "other": [],
                 "request": {
                     key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
                         SetResponsesHeader(suffix=None),
+                        AddPathQueryIdOnParameters(split=-1),
                         AddParametersOnContent(
                             split=-1, contentType="application/json"
                         ),
@@ -23,8 +23,8 @@ class Config:
                 }
                 | {
                     key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
                         SetResponsesHeader(suffix=None),
+                        AddPathQueryIdOnParameters(split=-1),
                         AddParametersOnParameters(
                             split=-1,
                             schemaType=None,
@@ -58,12 +58,12 @@ class Config:
             "dart": {
                 "openapi": [],
                 "schemas": [],
-                "other":[],
+                "other": [],
                 "request": {
                     key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
                         AddSecuritySchemesOnHeader(split=-1),
                         SetResponsesHeader(suffix=None),
+                        AddPathQueryIdOnParameters(split=-1),
                         AddParametersOnParameters(
                             split=-1,
                             schemaType="string",
@@ -73,9 +73,9 @@ class Config:
                 }
                 | {
                     key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
                         AddSecuritySchemesOnHeader(split=-1),
                         SetResponsesHeader(suffix=None),
+                        AddPathQueryIdOnParameters(split=-1),
                         AddParametersOnBody(
                             split=-1,
                             schemaType=None,
@@ -112,11 +112,11 @@ class Config:
             "typescript": {
                 "openapi": [AddSecuritySchemesOnSecuritySchemes()],
                 "schemas": [],
-                "other":[],
+                "other": [],
                 "request": {
                     key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
                         SetResponsesHeader(suffix=None),
+                        AddPathQueryIdOnParameters(split=-1),
                         AddParametersOnParameters(
                             split=-1,
                             schemaType="string",
@@ -126,8 +126,8 @@ class Config:
                 }
                 | {
                     key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
                         SetResponsesHeader(suffix=None),
+                        AddPathQueryIdOnParameters(split=-1),
                         AddParametersOnBody(
                             split=-1,
                             schemaType=None,
@@ -162,11 +162,11 @@ class Config:
             "test": {
                 "openapi": [AddSecuritySchemesOnSecuritySchemes()],
                 "schemas": [],
-                "other":[],
+                "other": [],
                 "request": {
                     key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
                         SetResponsesHeader(suffix=None),
+                        AddPathQueryIdOnParameters(split=-1),
                         AddParametersOnParameters(
                             split=-1,
                             schemaType="string",
@@ -176,8 +176,8 @@ class Config:
                 }
                 | {
                     key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
                         SetResponsesHeader(suffix=None),
+                        AddPathQueryIdOnParameters(split=-1),
                         AddParametersOnParameters(
                             split=-1,
                             schemaType="string",

package/twitter-openapi/tools/hooks.py

@@ -58,15 +58,17 @@ class HookBase:
 
 
 class OpenapiHookBase(HookBase):
-    def hook(self, value: dict)->dict:
+    def hook(self, value: dict) -> dict:
         return value
 
+
 class OtherHookBase(HookBase):
-    def hook(self)->tuple[str, dict]:
-        return  "", {}
+    def hook(self) -> tuple[str, dict]:
+        return "", {}
+
 
 class SchemasHookBase(HookBase):
-    def hook(self, value: dict)->dict:
+    def hook(self, value: dict) -> dict:
         return value
 
 
@@ -78,7 +80,7 @@ class RequestHookBase(HookBase):
         super().__init__()
         self.split = split
 
-    def hook(self, path: str, value: dict)->tuple[str, dict]:
+    def hook(self, path: str, value: dict) -> tuple[str, dict]:
         value["parameters"] = value.get("parameters", [])
         self.path_name = "/".join(path.split("/")[self.split :])
         return path, value
@@ -123,7 +125,7 @@ class ReplaceQueryIdPlaceholder(RequestHookBase):
     def hook(self, path: str, value: dict):
         path, value = super().hook(path, value)
         new = self.PLACEHOLDER[self.path_name]["queryId"]
-        return path.replace(r"{{queryId}}", new), value
+        return path.replace(r"{pathQueryId}", new), value
 
 
 class SetResponsesHeader(RequestHookBase):
@@ -140,6 +142,28 @@ class SetResponsesHeader(RequestHookBase):
         return path, value
 
 
+class AddPathQueryIdOnParameters(RequestHookBase):
+    def __init__(self, split: str = 1):
+        super().__init__(split=split)
+
+    def hook(self, path: str, value: dict):
+        path, value = super().hook(path, value)
+        data = self.PLACEHOLDER[self.path_name]
+        value["parameters"].append(
+            {
+                "in": "path",
+                "name": "pathQueryId",
+                "required": True,
+                "schema": {
+                    "type": "string",
+                    "default": data["queryId"],
+                    "example": data["queryId"],
+                },
+            }
+        )
+        return path, value
+
+
 # OnParameters