@volter/twin-tiktok 0.1.37 → 1.0.0

package/dist/business/spec/openapi.json

@@ -0,0 +1,1045 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+  "title": "TikTok API for Business: Accounts API and Discovery (v1.3)",
+  "version": "v1.3",
+  "description": "Written from the TikTok API for Business v1.3 documentation (spec/SOURCE.md): TikTok publishes no OpenAPI document of these endpoints."
+ },
+ "servers": [
+  {
+   "url": "https://business-api.tiktok.com"
+  }
+ ],
+ "paths": {
+  "/open_api/v1.3/tt_user/oauth2/token/": {
+   "post": {
+    "operationId": "ttUserOauth2Token",
+    "summary": "Get a TikTok account access token",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1738084387220481&language=ENGLISH"
+    },
+    "requestBody": {
+     "required": true,
+     "content": {
+      "application/json": {
+       "schema": {
+        "type": "object",
+        "properties": {
+         "client_id": {
+          "type": "string"
+         },
+         "client_secret": {
+          "type": "string"
+         },
+         "grant_type": {
+          "type": "string"
+         },
+         "auth_code": {
+          "type": "string"
+         },
+         "redirect_uri": {
+          "type": "string"
+         }
+        }
+       }
+      }
+     }
+    },
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object",
+           "properties": {
+            "access_token": {
+             "type": "string"
+            },
+            "token_type": {
+             "type": "string"
+            },
+            "scope": {
+             "type": "string"
+            },
+            "expires_in": {
+             "type": "integer"
+            },
+            "refresh_token": {
+             "type": "string"
+            },
+            "refresh_token_expires_in": {
+             "type": "integer"
+            },
+            "open_id": {
+             "type": "string"
+            }
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  },
+  "/open_api/v1.3/tt_user/oauth2/refresh_token/": {
+   "post": {
+    "operationId": "ttUserOauth2RefreshToken",
+    "summary": "Renew a TikTok account access token",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1738084387220481&language=ENGLISH"
+    },
+    "requestBody": {
+     "required": true,
+     "content": {
+      "application/json": {
+       "schema": {
+        "type": "object",
+        "properties": {
+         "client_id": {
+          "type": "string"
+         },
+         "client_secret": {
+          "type": "string"
+         },
+         "grant_type": {
+          "type": "string"
+         },
+         "refresh_token": {
+          "type": "string"
+         }
+        }
+       }
+      }
+     }
+    },
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object",
+           "properties": {
+            "access_token": {
+             "type": "string"
+            },
+            "token_type": {
+             "type": "string"
+            },
+            "scope": {
+             "type": "string"
+            },
+            "expires_in": {
+             "type": "integer"
+            },
+            "refresh_token": {
+             "type": "string"
+            },
+            "refresh_token_expires_in": {
+             "type": "integer"
+            },
+            "open_id": {
+             "type": "string"
+            }
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  },
+  "/open_api/v1.3/tt_user/oauth2/revoke/": {
+   "post": {
+    "operationId": "ttUserOauth2Revoke",
+    "summary": "Revoke a TikTok account access token",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1738084387220481&language=ENGLISH"
+    },
+    "requestBody": {
+     "required": true,
+     "content": {
+      "application/json": {
+       "schema": {
+        "type": "object",
+        "properties": {
+         "client_id": {
+          "type": "string"
+         },
+         "client_secret": {
+          "type": "string"
+         },
+         "access_token": {
+          "type": "string"
+         }
+        }
+       }
+      }
+     }
+    },
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object"
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  },
+  "/open_api/v1.3/tt_user/token_info/get/": {
+   "post": {
+    "operationId": "ttUserTokenInfoGet",
+    "summary": "Get the permission scopes in an access token",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1765927978092545&language=ENGLISH"
+    },
+    "requestBody": {
+     "required": true,
+     "content": {
+      "application/json": {
+       "schema": {
+        "type": "object",
+        "properties": {
+         "app_id": {
+          "type": "string"
+         },
+         "access_token": {
+          "type": "string"
+         }
+        }
+       }
+      }
+     }
+    },
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object"
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  },
+  "/open_api/v1.3/business/get/": {
+   "get": {
+    "operationId": "businessGet",
+    "summary": "Get profile data of a TikTok account",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1762228399168514&language=ENGLISH"
+    },
+    "parameters": [
+     {
+      "name": "Access-Token",
+      "in": "header",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "Access token authorized by TikTok creators"
+      }
+     },
+     {
+      "name": "business_id",
+      "in": "query",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "The TikTok account's open_id"
+      }
+     },
+     {
+      "name": "fields",
+      "in": "query",
+      "required": false,
+      "schema": {
+       "type": "string",
+       "description": "A JSON array of the fields to answer"
+      }
+     }
+    ],
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object",
+           "properties": {
+            "display_name": {
+             "type": "string"
+            },
+            "profile_image": {
+             "type": "string"
+            },
+            "username": {
+             "type": "string"
+            },
+            "profile_deep_link": {
+             "type": "string"
+            },
+            "bio_description": {
+             "type": "string"
+            },
+            "is_verified": {
+             "type": "boolean"
+            },
+            "followers_count": {
+             "type": "integer"
+            },
+            "following_count": {
+             "type": "integer"
+            },
+            "total_likes": {
+             "type": "integer"
+            },
+            "videos_count": {
+             "type": "integer"
+            }
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  },
+  "/open_api/v1.3/business/video/list/": {
+   "get": {
+    "operationId": "businessVideoList",
+    "summary": "Get post data of a TikTok account",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1762228421622786&language=ENGLISH"
+    },
+    "parameters": [
+     {
+      "name": "Access-Token",
+      "in": "header",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "Access token authorized by TikTok creators"
+      }
+     },
+     {
+      "name": "business_id",
+      "in": "query",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "The TikTok account's open_id"
+      }
+     },
+     {
+      "name": "fields",
+      "in": "query",
+      "required": false,
+      "schema": {
+       "type": "string",
+       "description": "A JSON array of the fields to answer"
+      }
+     },
+     {
+      "name": "cursor",
+      "in": "query",
+      "schema": {
+       "type": "integer"
+      }
+     },
+     {
+      "name": "max_count",
+      "in": "query",
+      "schema": {
+       "type": "integer"
+      }
+     }
+    ],
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object",
+           "properties": {
+            "videos": {
+             "type": "array",
+             "items": {
+              "type": "object",
+              "properties": {
+               "item_id": {
+                "type": "string"
+               },
+               "create_time": {
+                "type": "integer"
+               },
+               "thumbnail_url": {
+                "type": "string"
+               },
+               "share_url": {
+                "type": "string"
+               },
+               "embed_url": {
+                "type": "string"
+               },
+               "caption": {
+                "type": "string"
+               },
+               "video_duration": {
+                "type": "number"
+               },
+               "likes": {
+                "type": "integer"
+               },
+               "comments": {
+                "type": "integer"
+               },
+               "shares": {
+                "type": "integer"
+               },
+               "video_views": {
+                "type": "integer"
+               }
+              }
+             }
+            },
+            "cursor": {
+             "type": "integer"
+            },
+            "has_more": {
+             "type": "boolean"
+            }
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  },
+  "/open_api/v1.3/business/video/publish/": {
+   "post": {
+    "operationId": "businessVideoPublish",
+    "summary": "Publish a public video post to an owned account",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1762228496095234&language=ENGLISH"
+    },
+    "parameters": [
+     {
+      "name": "Access-Token",
+      "in": "header",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "Access token authorized by TikTok creators"
+      }
+     }
+    ],
+    "requestBody": {
+     "required": true,
+     "content": {
+      "application/json": {
+       "schema": {
+        "type": "object",
+        "properties": {
+         "business_id": {
+          "type": "string"
+         },
+         "video_url": {
+          "type": "string"
+         },
+         "custom_thumbnail_url": {
+          "type": "string"
+         },
+         "post_info": {
+          "type": "object",
+          "properties": {
+           "caption": {
+            "type": "string"
+           },
+           "title": {
+            "type": "string"
+           },
+           "privacy_level": {
+            "type": "string"
+           },
+           "is_brand_organic": {
+            "type": "boolean"
+           },
+           "is_branded_content": {
+            "type": "boolean"
+           },
+           "disable_comment": {
+            "type": "boolean"
+           },
+           "disable_duet": {
+            "type": "boolean"
+           },
+           "disable_stitch": {
+            "type": "boolean"
+           },
+           "is_ai_generated": {
+            "type": "boolean"
+           },
+           "upload_to_draft": {
+            "type": "boolean"
+           },
+           "is_draft": {
+            "type": "boolean"
+           },
+           "auto_add_music": {
+            "type": "boolean"
+           },
+           "thumbnail_offset": {
+            "type": "integer"
+           },
+           "location_id": {
+            "type": "string"
+           },
+           "location_name": {
+            "type": "string"
+           },
+           "music_sound_info": {
+            "type": "object"
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    },
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object",
+           "properties": {
+            "share_id": {
+             "type": "string"
+            }
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  },
+  "/open_api/v1.3/business/photo/publish/": {
+   "post": {
+    "operationId": "businessPhotoPublish",
+    "summary": "Publish a photo post to an owned account",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1803630424390658&language=ENGLISH"
+    },
+    "parameters": [
+     {
+      "name": "Access-Token",
+      "in": "header",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "Access token authorized by TikTok creators"
+      }
+     }
+    ],
+    "requestBody": {
+     "required": true,
+     "content": {
+      "application/json": {
+       "schema": {
+        "type": "object",
+        "properties": {
+         "business_id": {
+          "type": "string"
+         },
+         "photo_images": {
+          "type": "array",
+          "items": {
+           "type": "string"
+          },
+          "maxItems": 35
+         },
+         "photo_cover_index": {
+          "type": "integer"
+         },
+         "post_info": {
+          "type": "object",
+          "properties": {
+           "caption": {
+            "type": "string"
+           },
+           "title": {
+            "type": "string"
+           },
+           "privacy_level": {
+            "type": "string"
+           },
+           "is_brand_organic": {
+            "type": "boolean"
+           },
+           "is_branded_content": {
+            "type": "boolean"
+           },
+           "disable_comment": {
+            "type": "boolean"
+           },
+           "disable_duet": {
+            "type": "boolean"
+           },
+           "disable_stitch": {
+            "type": "boolean"
+           },
+           "is_ai_generated": {
+            "type": "boolean"
+           },
+           "upload_to_draft": {
+            "type": "boolean"
+           },
+           "is_draft": {
+            "type": "boolean"
+           },
+           "auto_add_music": {
+            "type": "boolean"
+           },
+           "thumbnail_offset": {
+            "type": "integer"
+           },
+           "location_id": {
+            "type": "string"
+           },
+           "location_name": {
+            "type": "string"
+           },
+           "music_sound_info": {
+            "type": "object"
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    },
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object",
+           "properties": {
+            "share_id": {
+             "type": "string"
+            }
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  },
+  "/open_api/v1.3/business/publish/status/": {
+   "get": {
+    "operationId": "businessPublishStatus",
+    "summary": "Get the publishing status of a TikTok post",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1816387106635778&language=ENGLISH"
+    },
+    "parameters": [
+     {
+      "name": "Access-Token",
+      "in": "header",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "Access token authorized by TikTok creators"
+      }
+     },
+     {
+      "name": "business_id",
+      "in": "query",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "The TikTok account's open_id"
+      }
+     },
+     {
+      "name": "publish_id",
+      "in": "query",
+      "required": true,
+      "schema": {
+       "type": "string"
+      }
+     }
+    ],
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object",
+           "properties": {
+            "status": {
+             "type": "string",
+             "enum": [
+              "PROCESSING_DOWNLOAD",
+              "PUBLISH_COMPLETE",
+              "FAILED",
+              "SEND_TO_USER_INBOX"
+             ]
+            },
+            "post_ids": {
+             "type": "array",
+             "items": {
+              "type": "string"
+             }
+            },
+            "reason": {
+             "type": "string"
+            }
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  },
+  "/open_api/v1.3/business/publish/location/": {
+   "get": {
+    "operationId": "businessPublishLocation",
+    "summary": "Get the location tags for a TikTok account",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1870580030749698&language=ENGLISH"
+    },
+    "parameters": [
+     {
+      "name": "Access-Token",
+      "in": "header",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "Access token authorized by TikTok creators"
+      }
+     },
+     {
+      "name": "business_id",
+      "in": "query",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "The TikTok account's open_id"
+      }
+     },
+     {
+      "name": "search_query",
+      "in": "query",
+      "required": true,
+      "schema": {
+       "type": "string"
+      }
+     }
+    ],
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object",
+           "properties": {
+            "locations": {
+             "type": "array",
+             "items": {
+              "type": "object",
+              "properties": {
+               "location_id": {
+                "type": "string"
+               },
+               "location_name": {
+                "type": "string"
+               },
+               "location_address": {
+                "type": "string"
+               }
+              }
+             }
+            }
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  },
+  "/open_api/v1.3/discovery/cml/trending_list/": {
+   "get": {
+    "operationId": "discoveryCmlTrendingList",
+    "summary": "Get popular tracks from the Commercial Music Library",
+    "externalDocs": {
+     "url": "https://business-api.tiktok.com/gateway/api/doc/client/node/get/v2/?identify_key=c0138ffadd90a955c1f0670a56fe348d1d40680b3c89461e09f78ed26785164b&doc_id=1825119063013505&language=ENGLISH"
+    },
+    "parameters": [
+     {
+      "name": "Access-Token",
+      "in": "header",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "Access token authorized by TikTok creators"
+      }
+     },
+     {
+      "name": "business_id",
+      "in": "query",
+      "required": true,
+      "schema": {
+       "type": "string",
+       "description": "The TikTok account's open_id"
+      }
+     },
+     {
+      "name": "genre",
+      "in": "query",
+      "schema": {
+       "type": "string"
+      }
+     }
+    ],
+    "responses": {
+     "200": {
+      "description": "{code, message, request_id, data}: code 0 on success; a refusal is a non-zero code, answered HTTP 200",
+      "content": {
+       "application/json": {
+        "schema": {
+         "type": "object",
+         "properties": {
+          "code": {
+           "type": "integer"
+          },
+          "message": {
+           "type": "string"
+          },
+          "request_id": {
+           "type": "string"
+          },
+          "data": {
+           "type": "object",
+           "properties": {
+            "list": {
+             "type": "array",
+             "items": {
+              "type": "object",
+              "properties": {
+               "commercial_music_id": {
+                "type": "string"
+               },
+               "commercial_music_name": {
+                "type": "string"
+               },
+               "artist": {
+                "type": "string"
+               },
+               "thumbnail_url": {
+                "type": "string"
+               },
+               "duration": {
+                "type": "integer"
+               },
+               "preview_url": {
+                "type": "string"
+               },
+               "full_duration_song_clip": {
+                "type": "object",
+                "properties": {
+                 "song_clip_id": {
+                  "type": "string"
+                 }
+                }
+               },
+               "trending_song_clip": {
+                "type": "object",
+                "properties": {
+                 "song_clip_id": {
+                  "type": "string"
+                 },
+                 "duration": {
+                  "type": "integer"
+                 },
+                 "preview_url": {
+                  "type": "string"
+                 }
+                }
+               }
+              }
+             }
+            }
+           }
+          }
+         }
+        }
+       }
+      }
+     }
+    }
+   }
+  }
+ }
+}