twitter-openapi-typescript-generated 0.0.11 → 0.0.13

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

@@ -125,6 +125,7 @@ components:
         - $ref: "#/components/schemas/TimelineUser"
         - $ref: "#/components/schemas/TimelinePrompt"
         - $ref: "#/components/schemas/TimelineMessagePrompt"
+        - $ref: "#/components/schemas/TimelineCommunity"
 
       discriminator:
         propertyName: __typename
@@ -134,6 +135,7 @@ components:
           TimelineUser: "#/components/schemas/TimelineUser"
           TimelinePrompt: "#/components/schemas/TimelinePrompt"
           TimelineMessagePrompt: "#/components/schemas/TimelineMessagePrompt"
+          TimelineCommunity: "#/components/schemas/TimelineCommunity"
 
     ContentItemType:
       type: string
@@ -144,6 +146,7 @@ components:
           TimelineUser,
           TimelinePrompt,
           TimelineMessagePrompt,
+          TimelineCommunity,
         ]
 
     TimelineTweet:
@@ -188,7 +191,6 @@ components:
           $ref: "./user.yaml#/components/schemas/UserResults"
 
     ItemResult:
-      required:
       properties:
         __typename:
           $ref: "./typename.yaml#/components/schemas/TypeName" # null | TimelineTweet
@@ -217,6 +219,12 @@ components:
           $ref: "./typename.yaml#/components/schemas/TypeName" # TimelineMessagePrompt
       additionalProperties: true # todo
 
+    TimelineCommunity:
+      properties:
+        __typename:
+          $ref: "./typename.yaml#/components/schemas/TypeName" # TimelineCommunity
+      additionalProperties: true # todo
+
     ClientEventInfo:
       properties:
         component:

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

@@ -8,5 +8,5 @@ components:
   schemas:
     TwitterTimeFormat:
       type: string
-      pattern: "^(Sun|Mon|Tue|Wed|Thu|Fri|Sat) (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) (0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]) ([+-][0-9]{4}) ([0-9]{4})$"
-      example: "Sat Dec 31 23:59:59 +0000 2023"
+      pattern: "^(Sun|Mon|Tue|Wed|Thu|Fri|Sat) (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) (0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3])(: ?)([0-5][0-9])(: ?)([0-5][0-9]) ([+-][0-9]{4}) ([0-9]{4})$"
+      example: "Sat Dec 31 23:59:59 +0000 2023" # Wed Sep 20 02: 55: 44 +0000 2023

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

@@ -256,7 +256,6 @@ components:
         - ctaBehavior
         - callbacks
         - clientEventInfo
-        - buttonStyle
       properties:
         Text:
           type: string

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

@@ -52,6 +52,8 @@ components:
         rest_id:
           type: string
           pattern: "^[0-9]+$"
+        birdwatch_pivot:
+          $ref: "#/components/schemas/BirdwatchPivot"
         core:
           $ref: "./user.yaml#/components/schemas/UserResultCore"
         card:
@@ -74,6 +76,10 @@ components:
           $ref: "#/components/schemas/TweetView"
         quoted_status_result:
           $ref: "./content.yaml#/components/schemas/ItemResult"
+        note_tweet:
+          $ref: "#/components/schemas/NoteTweet"
+        quick_promote_eligibility:
+          type: object
 
     TweetEditControl:
       properties:
@@ -134,6 +140,165 @@ components:
           type: string
           enum: [EnabledWithCount]
 
+    NoteTweet:
+      required:
+        - "is_expandable"
+        - "note_tweet_results"
+      properties:
+        is_expandable:
+          type: boolean
+        note_tweet_results:
+          $ref: "#/components/schemas/NoteTweetResult"
+
+    NoteTweetResult:
+      required:
+        - "result"
+      properties:
+        result:
+          $ref: "#/components/schemas/NoteTweetResultData"
+
+    NoteTweetResultData:
+      required:
+        - "entity_set"
+        - "id"
+        - "text"
+      properties:
+        entity_set:
+          $ref: "#/components/schemas/Entities"
+        id:
+          type: string
+          pattern: "^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$" # base64
+        media:
+          $ref: "#/components/schemas/NoteTweetResultMedia"
+        richtext:
+          $ref: "#/components/schemas/NoteTweetResultRichText"
+        text:
+          type: string
+
+    NoteTweetResultMedia:
+      required:
+        - "inline_media"
+      properties:
+        inline_media:
+          type: array
+          items:
+            type: object
+    NoteTweetResultRichText:
+      required:
+        - "richtext_tags"
+      properties:
+        richtext_tags:
+          type: array
+          items:
+            $ref: "#/components/schemas/NoteTweetResultRichTextTag"
+
+    NoteTweetResultRichTextTag:
+      required:
+        - "from_index"
+        - "to_index"
+        - "richtext_types"
+      properties:
+        from_index:
+          type: integer
+        to_index:
+          type: integer
+        richtext_types:
+          type: array
+          items:
+            type: string
+            enum: [Bold, Italic]
+
+    BirdwatchPivot:
+      required:
+        - "destinationUrl"
+        - "footer"
+        - "note"
+        - "subtitle"
+        - "title"
+        - "shorttitle"
+        - "iconType"
+      properties:
+        destinationUrl:
+          type: string
+          format: uri
+        footer:
+          $ref: "#/components/schemas/BirdwatchPivotFooter"
+        note:
+          $ref: "#/components/schemas/BirdwatchPivotNote"
+        subtitle:
+          $ref: "#/components/schemas/BirdwatchPivotSubtitle"
+        title:
+          type: string
+        shorttitle:
+          type: string
+        visualStyle:
+          type: string
+          enum: [Default]
+        iconType:
+          type: string
+          enum: [BirdwatchV1Icon]
+
+    BirdwatchPivotFooter:
+      required:
+        - "text"
+        - "entities"
+      properties:
+        text:
+          type: string
+        entities:
+          type: array
+          items:
+            $ref: "#/components/schemas/BirdwatchEntity"
+
+    BirdwatchEntity:
+      required:
+        - "fromIndex"
+        - "toIndex"
+        - "ref"
+      properties:
+        fromIndex:
+          type: integer
+        toIndex:
+          type: integer
+        ref:
+          $ref: "#/components/schemas/BirdwatchEntityRef"
+
+    BirdwatchEntityRef:
+      required:
+        - "type"
+        - "url"
+        - "urlType"
+      properties:
+        type:
+          type: string
+          enum: [TimelineUrl]
+        url:
+          type: string
+          format: uri
+        urlType:
+          type: string
+          enum: [ExternalUrl]
+
+    BirdwatchPivotNote:
+      required:
+        - "rest_id"
+      properties:
+        rest_id:
+          type: string
+          pattern: "^[0-9]+$"
+
+    BirdwatchPivotSubtitle:
+      required:
+        - "text"
+        - "entities"
+      properties:
+        text:
+          type: string
+        entities:
+          type: array
+          items:
+            $ref: "#/components/schemas/BirdwatchEntity"
+
     TweetCard:
       properties:
         rest_id:
@@ -378,7 +543,7 @@ components:
         - "media_url_https"
         - "type"
         - "url"
-        - "ext_media_availability"
+        # - "ext_media_availability"
         # - "features"
         - "sizes"
         - "original_info"
@@ -500,9 +665,11 @@ components:
       # required:
       #   - "status"
       properties:
+        reason:
+          type: string # enum Dmcaed
         status:
           type: string
-          enum: [Available]
+          enum: [Available, Unavailable]
 
     MediaSizes:
       required:

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

@@ -18,6 +18,7 @@ components:
           TweetTombstone,
           TimelinePrompt,
           TimelineMessagePrompt,
+          TimelineCommunity,
           TweetUnavailable,
           Tweet,
           User,

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

@@ -13,8 +13,6 @@ components:
           $ref: "#/components/schemas/UserResults"
 
     UserResults:
-      required:
-        - "result"
       properties:
         result:
           $ref: "#/components/schemas/UserUnion"

package/twitter-openapi/test/python/test_serialize.py

@@ -256,5 +256,29 @@ if __name__ == "__main__":
         error_dump(e)
         error_count += 1
 
+    try:
+        logger.info(f"Try: Self TweetDetail Test")
+        kwargs = get_kwargs("TweetDetail", {"focalTweetId": "1720975693524377759"})
+        res = pt.TweetApi(api_client).get_tweet_detail_with_http_info(**kwargs)
+        data = res.data.to_dict()
+
+        rate = match_rate(data, json.loads(res.raw_data))
+        logger.info(f"Match rate: {rate}")
+    except Exception as e:
+        error_dump(e)
+        error_count += 1
+
+    try:
+        logger.info(f"Try: Self TweetDetail Test")
+        kwargs = get_kwargs("TweetDetail", {"focalTweetId": "1720818185186791678"})
+        res = pt.TweetApi(api_client).get_tweet_detail_with_http_info(**kwargs)
+        data = res.data.to_dict()
+
+        rate = match_rate(data, json.loads(res.raw_data))
+        logger.info(f"Match rate: {rate}")
+    except Exception as e:
+        error_dump(e)
+        error_count += 1
+
     if error_count > 0:
         exit(1)

package/twitter-openapi/tools/build.py

@@ -1,79 +1,83 @@
 import os
 import glob
-import json
 import yaml
 import shutil
-import copy
-import re
 from build_config import Config
-from hooks import OpenapiHookBase, RequestHookBase, SchemasHookBase,OtherHookBase
+from hooks import OpenapiHookBase, RequestHookBase, SchemasHookBase, OtherHookBase
 from tqdm import tqdm
 
 
+def replace_ref(x):
+    if isinstance(x, dict):
+        return {
+            key: "#" + value.split("#")[-1] if key == "$ref" else replace_ref(value)
+            for key, value in x.items()
+        }
+    elif isinstance(x, list):
+        return [replace_ref(value) for value in x]
+    return x
+
+
 print("=== Build Start ===")
 
 
 config = Config()
 
 
-try:
-    shutil.rmtree("dist")
-except:
-    pass
-
-for lang, profile in tqdm(config.main().items(), leave=False):
-    dist_replace = lambda x: x.replace(
-        config.INPUT_DIR, config.OUTPUT_DIR.format(lang), 1
-    )
+shutil.rmtree("dist", ignore_errors=True)
 
-    for dir in glob.glob(os.path.join(config.INPUT_DIR, "**/")):
-        os.makedirs(dist_replace(dir), exist_ok=True)
 
+for lang, profile in tqdm(config.main().items(), leave=False):
     paths = {}
+    schemas = {}
     files = glob.glob(os.path.join(config.INPUT_DIR, "**/*.yaml"))
     for file in tqdm(files, leave=False):
         file = file.replace(os.path.sep, "/")
         with open(file, mode="r", encoding="utf-8") as f:
             load = yaml.safe_load(f)
+
+        # RequestHookBase hook
         for path in list(load["paths"]):
             for method in list(load["paths"][path]):
+                key, value = path, load["paths"][path][method]
                 for tag in list(load["paths"][path][method].get("tags", ["default"])):
-                    key, value = path, load["paths"][path][method]
                     for hook in profile["request"][tag]:
                         hook: RequestHookBase
                         key, value = hook.hook(key, value)
-                    load["paths"][path][method] = value
-                    load["paths"][key] = load["paths"].pop(path)
+                paths.update({key: {}})
+                paths[key].update({method: value})
 
-                    escape = key.replace("/", "~1")
-                    relative = file.replace(config.INPUT_DIR, "", 1)
-                    paths.update({key: {"$ref": f".{relative}#/paths/{escape}"}})
+        # SchemasHookBase hook
         for name in list(load.get("components", {}).get("schemas", {})):
             value = load["components"]["schemas"][name]
             for hook in profile["schemas"]:
                 hook: SchemasHookBase
                 value = hook.hook(value)
-            load["components"]["schemas"][name] = value
+            schemas.update({name: value})
+
+        # OtherHookBase hook
         if file == "src/openapi/paths/other.yaml":
             for hook in profile["other"]:
                 hook: OtherHookBase
                 key, value = hook.hook()
-                load["components"]["schemas"][key] = value
-                load["components"]["schemas"]["OtherResponse"]["properties"][key] = {
-                    "$ref": f"#/components/schemas/{key}"
-                }
-        with open(dist_replace(file), mode="w+", encoding="utf-8") as f:
-            f.write(yaml.dump(load))
+                schemas["OtherResponse"]["properties"].append({key: value})
 
     file = "src/openapi/openapi-3.0.yaml"
+
     with open(file, mode="r", encoding="utf-8") as f:
         openapi = yaml.safe_load(f)
-    for path in paths:
-        openapi["paths"] = paths
+
+    # OpenapiHookBase hook
     for hook in profile["openapi"]:
         hook: OpenapiHookBase
         openapi = hook.hook(openapi)
-    with open(dist_replace(file), mode="w+", encoding="utf-8") as f:
+
+    openapi["paths"] = replace_ref(paths)
+    openapi["components"]["schemas"] = replace_ref(schemas)
+    output = config.OUTPUT_DIR.format(lang)
+    os.makedirs(output, exist_ok=True)
+
+    with open(output + "/openapi-3.0.yaml", mode="w+", encoding="utf-8") as f:
         f.write(yaml.dump(openapi))
 
 print("=== Build End ===")

package/twitter-openapi/tools/build_config.py

@@ -8,26 +8,19 @@ class Config:
     def hooks_generator(self, queryParameterJson=True):
         # https://stackoverflow.com/questions/34820064/defining-an-api-with-swagger-get-call-that-uses-json-in-parameters/45223964
         if queryParameterJson:
+            # ["parameters"][0]["content"]["application/json"]["schema"]
             getParamHook = AddParametersOnContent(
                 split=-1,
                 contentType="application/json",
                 ignoreKeys=["queryId"],
             )
-            postParamHook = AddParametersOnParameters(
-                split=-1,
-                schemaType=None,
-            )
         else:
+            # ["parameters"][0]["schema"]
             getParamHook = AddParametersOnParameters(
                 split=-1,
                 schemaType="string",
                 ignoreKeys=["queryId"],
             )
-            postParamHook = AddParametersOnBody(
-                split=-1,
-                schemaType=None,
-                contentType="application/json",
-            )
 
         return {
             "openapi": [AddSecuritySchemesOnSecuritySchemes()],
@@ -45,7 +38,11 @@ class Config:
                 key: [
                     SetResponsesHeader(suffix=None),
                     AddPathQueryIdOnParameters(split=-1),
-                    postParamHook,
+                    AddParametersOnBody(
+                        split=-1,
+                        schemaType=None,
+                        contentType="application/json",
+                    ),
                 ]
                 for key in ["post"]
             }

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

@@ -1,107 +0,0 @@
-components:
-  schemas:
-    BookmarksResponse:
-      properties:
-        data:
-          $ref: '#/components/schemas/BookmarksResponseData'
-      required:
-      - data
-    BookmarksResponseData:
-      properties:
-        bookmark_timeline_v2:
-          $ref: '#/components/schemas/BookmarksTimeline'
-      required:
-      - bookmark_timeline_v2
-    BookmarksTimeline:
-      properties:
-        timeline:
-          $ref: ./../schemas/timeline.yaml#/components/schemas/Timeline
-      required:
-      - timeline
-info:
-  title: Twitter OpenAPI
-  version: 0.0.1
-openapi: 3.0.3
-paths:
-  /graphql/{pathQueryId}/Bookmarks:
-    get:
-      description: get bookmarks
-      operationId: getBookmarks
-      parameters:
-      - in: path
-        name: pathQueryId
-        required: true
-        schema:
-          default: tmd4ifV8RHltzn8ymGg1aw
-          example: tmd4ifV8RHltzn8ymGg1aw
-          type: string
-      - in: query
-        name: variables
-        required: true
-        schema:
-          default: '{"count": 20, "includePromotedContent": true}'
-          example: '{"count": 20, "includePromotedContent": true}'
-          type: string
-      - in: query
-        name: features
-        required: true
-        schema:
-          default: '{"graphql_timeline_v2_bookmark_timeline": true, "blue_business_profile_image_shape_enabled":
-            true, "responsive_web_graphql_exclude_directive_enabled": true, "verified_phone_label_enabled":
-            false, "responsive_web_graphql_timeline_navigation_enabled": true, "responsive_web_graphql_skip_user_profile_image_extensions_enabled":
-            false, "tweetypie_unmention_optimization_enabled": true, "vibe_api_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, "tweet_awards_web_tipping_enabled": false, "freedom_of_speech_not_reach_fetch_enabled":
-            false, "standardized_nudges_misinfo": true, "tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled":
-            false, "interactive_text_enabled": true, "responsive_web_text_conversations_enabled":
-            false, "longform_notetweets_rich_text_read_enabled": true, "responsive_web_enhance_cards_enabled":
-            false}'
-          example: '{"graphql_timeline_v2_bookmark_timeline": true, "blue_business_profile_image_shape_enabled":
-            true, "responsive_web_graphql_exclude_directive_enabled": true, "verified_phone_label_enabled":
-            false, "responsive_web_graphql_timeline_navigation_enabled": true, "responsive_web_graphql_skip_user_profile_image_extensions_enabled":
-            false, "tweetypie_unmention_optimization_enabled": true, "vibe_api_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, "tweet_awards_web_tipping_enabled": false, "freedom_of_speech_not_reach_fetch_enabled":
-            false, "standardized_nudges_misinfo": true, "tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled":
-            false, "interactive_text_enabled": true, "responsive_web_text_conversations_enabled":
-            false, "longform_notetweets_rich_text_read_enabled": true, "responsive_web_enhance_cards_enabled":
-            false}'
-          type: string
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                oneOf:
-                - $ref: '#/components/schemas/BookmarksResponse'
-                - $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
-      tags:
-      - tweet