@shotstack/schemas 1.6.0 → 1.7.1

package/dist/json-schema/vimeo-destination.json

@@ -0,0 +1,178 @@
+{
+  "name": "VimeoDestination",
+  "strict": true,
+  "schema": {
+    "description": "Send videos to [Vimeo](https://shotstack.io/docs/guide/serving-assets/destinations/vimeo/) video hosting and streaming service. Vimeo credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/vimeo), not in the request.",
+    "properties": {
+      "provider": {
+        "description": "The destination to send video to - set to `vimeo` for Vimeo.",
+        "type": "string",
+        "enum": [
+          "vimeo"
+        ]
+      },
+      "options": {
+        "anyOf": [
+          {
+            "description": "Additional Vimeo configuration and features.",
+            "$ref": "#/$defs/VimeoDestinationOptions"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "type": "object",
+    "required": [
+      "provider",
+      "options"
+    ],
+    "additionalProperties": false,
+    "$defs": {
+      "VimeoDestinationOptions": {
+        "description": "Pass additional options to control how Vimeo publishes video, including name, description and privacy settings.",
+        "properties": {
+          "name": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "A name or title for the video that will be displayed on the Vimeo website."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "description": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "A description of the video that will be displayed on the Vimeo website."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "privacy": {
+            "anyOf": [
+              {
+                "description": "Options to control the visibility of videos and privacy features.",
+                "$ref": "#/$defs/VimeoDestinationPrivacyOptions"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "folderUri": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The Vimeo folder URI to upload the video to. The folder must already exist in your Vimeo account."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "name",
+          "description",
+          "privacy",
+          "folderUri"
+        ]
+      },
+      "VimeoDestinationPrivacyOptions": {
+        "description": "Options to control the visibility of videos and privacy features.",
+        "properties": {
+          "view": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Set who can view the videos. Available options are: <ul>\n  <li>`anybody` - Anyone can view the video.</li>\n  <li>`nobody` - Only the video owner can view the video.</li>\n  <li>`contacts` - Only contacts can view the video.</li>\n  <li>`password` - A password is required to view the video.</li>\n  <li>`unlisted` - The video is not listed on Vimeo.</li>\n</ul>",
+                "enum": [
+                  "anybody",
+                  "nobody",
+                  "contacts",
+                  "password",
+                  "unlisted"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "embed": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Set who can embed the video. Available options are: <ul>\n  <li>`public` - Anyone can embed the video.</li>\n  <li>`private` - Only the video owner can embed the video.</li>\n  <li>`whitelist` - Only whitelisted domains can embed the video.</li>\n</ul>",
+                "enum": [
+                  "public",
+                  "private",
+                  "whitelist"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "comments": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Set who can comment on the video. Available options are: <ul>\n  <li>`anybody` - Anyone can comment on the video.</li>\n  <li>`nobody` - Only the video owner can comment on the video.</li>\n  <li>`contacts` - Only contacts can comment on the video.</li>\n</ul>",
+                "enum": [
+                  "anybody",
+                  "nobody",
+                  "contacts"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "download": {
+            "anyOf": [
+              {
+                "type": "boolean",
+                "description": "Set whether the video can be downloaded."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "add": {
+            "anyOf": [
+              {
+                "type": "boolean",
+                "description": "Set whether other users can add the video to their collections."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "view",
+          "embed",
+          "comments",
+          "download",
+          "add"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/word-timing.json

@@ -0,0 +1,44 @@
+{
+  "name": "WordTiming",
+  "strict": true,
+  "schema": {
+    "description": "Word-level timing information for caption animation.",
+    "type": "object",
+    "properties": {
+      "text": {
+        "description": "The word text to display.",
+        "type": "string"
+      },
+      "start": {
+        "description": "Start time of the word in milliseconds.",
+        "type": "number",
+        "minimum": 0
+      },
+      "end": {
+        "description": "End time of the word in milliseconds.",
+        "type": "number",
+        "minimum": 0
+      },
+      "confidence": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Speech-to-text confidence score between 0 and 1.",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "text",
+      "start",
+      "end",
+      "confidence"
+    ]
+  }
+}