@shotstack/schemas 1.1.2 → 1.3.0

package/dist/api.bundled.json

@@ -1062,10 +1062,24 @@
             "type": "string"
           },
           "scale": {
-            "description": "Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and  scaling images such as logos and watermarks.",
+            "description": "Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and scaling images such as logos and watermarks.",
             "type": "number",
             "example": 0
           },
+          "width": {
+            "description": "Set the width of the clip bounding box in pixels. This constrains the width of the clip, overriding the default behavior where clips fill the viewport width.",
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 3840,
+            "example": 800
+          },
+          "height": {
+            "description": "Set the height of the clip bounding box in pixels. This constrains the height of the clip, overriding the default behavior where clips fill the viewport height.",
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 2160,
+            "example": 600
+          },
           "position": {
             "description": "Place the asset in one of nine predefined positions of the viewport. This is most effective for when the asset is scaled and you want to position the element to a specific position. <ul>\n  <li>`top` - top (center)</li>\n  <li>`topRight` - top right</li>\n  <li>`right` - right (center)</li>\n  <li>`bottomRight` - bottom right</li>\n  <li>`bottom` - bottom (center)</li>\n  <li>`bottomLeft` - bottom left</li>\n  <li>`left` - left (center)</li>\n  <li>`topLeft` - top left</li>\n  <li>`center` - center</li>\n</ul>",
             "enum": [
@@ -1147,6 +1161,12 @@
           "transform": {
             "description": "A transformation lets you modify the visual properties of a clip. Available transformations are <b>rotate</b>, <b>skew</b> and <b>flip</b>. Transformations can be combined to create interesting new shapes and effects.",
             "$ref": "#/components/schemas/Transformation"
+          },
+          "alias": {
+            "description": "A unique identifier for this clip that can be used to reference it from other clips using the `alias://` protocol in asset sources. This is useful for features like auto-captioning where a caption asset needs to reference the audio from another clip.",
+            "type": "string",
+            "pattern": "^[A-Za-z0-9_-]+$",
+            "example": "MY_VIDEO_CLIP"
           }
         },
         "required": [
@@ -1250,6 +1270,7 @@
           "volumeEffect": {
             "description": "Preset volume effects to apply to the video asset <ul>\n  <li>`fadeIn` - fade volume in only</li>\n  <li>`fadeOut` - fade volume out only</li>\n  <li>`fadeInFadeOut` - fade volume in and out</li>\n</ul>",
             "enum": [
+              "none",
               "fadeIn",
               "fadeOut",
               "fadeInFadeOut"
@@ -1334,6 +1355,54 @@
           "alignment": {
             "description": "Alignment properties.",
             "$ref": "#/components/schemas/TextAlignment"
+          },
+          "stroke": {
+            "description": "Text stroke (outline) properties.",
+            "properties": {
+              "width": {
+                "description": "The width of the stroke in pixels.",
+                "type": "number",
+                "minimum": 0,
+                "maximum": 10,
+                "example": 2
+              },
+              "color": {
+                "description": "The stroke color using hexadecimal color notation.",
+                "type": "string",
+                "pattern": "^#[A-Fa-f0-9]{6}$",
+                "example": "#000000"
+              }
+            },
+            "type": "object"
+          },
+          "animation": {
+            "description": "Animation properties for text entrance effects.",
+            "properties": {
+              "preset": {
+                "description": "The animation preset to apply. <ul>\n  <li>`typewriter` - typewriter effect where characters appear one at a time</li>\n</ul>",
+                "type": "string",
+                "enum": [
+                  "typewriter"
+                ],
+                "example": "typewriter"
+              },
+              "duration": {
+                "description": "The duration of the animation in seconds.",
+                "type": "number",
+                "minimum": 0.1,
+                "maximum": 30,
+                "example": 2
+              }
+            },
+            "required": [
+              "preset"
+            ],
+            "type": "object"
+          },
+          "ellipsis": {
+            "description": "The string to display when text overflows its bounding box. Set to an ellipsis character or custom string to indicate truncated text.",
+            "type": "string",
+            "example": "..."
           }
         },
         "required": [
@@ -1364,7 +1433,7 @@
             "example": 800
           },
           "height": {
-            "description": "Set the height of the rich text asset bounding box in pixels. Text and elements will be masked if they  exceed the height of the bounding box. Minimum 1px, maximum 4096px.",
+            "description": "Set the height of the rich text asset bounding box in pixels. Text and elements will be masked if they exceed the height of the bounding box. Minimum 1px, maximum 4096px.",
             "type": "integer",
             "minimum": 1,
             "maximum": 4096,
@@ -1390,6 +1459,86 @@
             "description": "Background styling properties for the text bounding box.",
             "$ref": "#/components/schemas/RichTextBackground"
           },
+          "border": {
+            "description": "Border styling properties for the text bounding box.",
+            "properties": {
+              "width": {
+                "description": "The width of the border in pixels. Must be 0 or greater.",
+                "type": "number",
+                "minimum": 0,
+                "default": 0,
+                "example": 2
+              },
+              "color": {
+                "description": "The border color using hexadecimal color notation.",
+                "type": "string",
+                "pattern": "^#[A-Fa-f0-9]{6}$",
+                "default": "#000000",
+                "example": "#ff0000"
+              },
+              "opacity": {
+                "description": "The opacity of the border where 1 is opaque and 0 is transparent.",
+                "type": "number",
+                "minimum": 0,
+                "maximum": 1,
+                "default": 1,
+                "example": 0.8
+              },
+              "radius": {
+                "description": "The border radius in pixels for rounded corners. Must be 0 or greater.",
+                "type": "number",
+                "minimum": 0,
+                "default": 0,
+                "example": 10
+              }
+            },
+            "type": "object"
+          },
+          "padding": {
+            "description": "Padding inside the text bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
+            "oneOf": [
+              {
+                "type": "number",
+                "minimum": 0,
+                "description": "Padding in pixels applied to all sides.",
+                "example": 10
+              },
+              {
+                "description": "Padding properties for individual sides of the text bounding box.",
+                "properties": {
+                  "top": {
+                    "description": "Top padding in pixels.",
+                    "type": "number",
+                    "minimum": 0,
+                    "default": 0,
+                    "example": 10
+                  },
+                  "right": {
+                    "description": "Right padding in pixels.",
+                    "type": "number",
+                    "minimum": 0,
+                    "default": 0,
+                    "example": 10
+                  },
+                  "bottom": {
+                    "description": "Bottom padding in pixels.",
+                    "type": "number",
+                    "minimum": 0,
+                    "default": 0,
+                    "example": 10
+                  },
+                  "left": {
+                    "description": "Left padding in pixels.",
+                    "type": "number",
+                    "minimum": 0,
+                    "default": 0,
+                    "example": 10
+                  }
+                },
+                "type": "object"
+              }
+            ]
+          },
           "align": {
             "description": "Text alignment properties (horizontal and vertical).",
             "$ref": "#/components/schemas/RichTextAlignment"
@@ -1453,6 +1602,7 @@
           "effect": {
             "description": "The effect to apply to the audio asset <ul>\n  <li>`fadeIn` - fade volume in only</li>\n  <li>`fadeOut` - fade volume out only</li>\n  <li>`fadeInFadeOut` - fade volume in and out</li>\n</ul>",
             "enum": [
+              "none",
               "fadeIn",
               "fadeOut",
               "fadeInFadeOut"
@@ -1883,6 +2033,7 @@
           "in": {
             "description": "The transition in. Available transitions are:\n  <ul>\n    <li>`fade` - fade in</li>\n    <li>`reveal` - reveal from left to right</li>\n    <li>`wipeLeft` - fade across screen to the left</li>\n    <li>`wipeRight` - fade across screen to the right</li>\n    <li>`slideLeft` - move slightly left and fade in</li>\n    <li>`slideRight` - move slightly right and fade in</li>\n    <li>`slideUp` - move slightly up and fade in</li>\n    <li>`slideDown` - move slightly down and fade in</li>\n    <li>`carouselLeft` - slide in from right to left</li>\n    <li>`carouselRight` - slide in from left to right</li>\n    <li>`carouselUp` - slide in from bottom to top</li>\n    <li>`carouselDown` - slide in from top to bottom</li>\n    <li>`shuffleTopRight` - rotate in from top right</li>\n    <li>`shuffleRightTop` - rotate in from right top</li>\n    <li>`shuffleRightBottom` - rotate in from right bottom</li>\n    <li>`shuffleBottomRight` - rotate in from bottom right</li>\n    <li>`shuffleBottomLeft` - rotate in from bottom left</li>\n    <li>`shuffleLeftBottom` - rotate in from left bottom</li>\n    <li>`shuffleLeftTop` - rotate in from left top</li>\n    <li>`shuffleTopLeft` - rotate in from top left</li>\n    <li>`zoom` - fast zoom in</li>\n  </ul>\nThe transition speed can also be controlled by appending `Fast` or `Slow` to the transition, e.g. `fadeFast` or `CarouselLeftSlow`.",
             "enum": [
+              "none",
               "fade",
               "fadeSlow",
               "fadeFast",
@@ -1950,6 +2101,7 @@
           "out": {
             "description": "The transition out. Available transitions are:\n  <ul>\n    <li>`fade` - fade out</li>\n    <li>`reveal` - reveal from right to left</li>\n    <li>`wipeLeft` - fade across screen to the left</li>\n    <li>`wipeRight` - fade across screen to the right</li>\n    <li>`slideLeft` - move slightly left and fade out</li>\n    <li>`slideRight` - move slightly right and fade out</li>\n    <li>`slideUp` - move slightly up and fade out</li>\n    <li>`slideDown` - move slightly down and fade out</li>\n    <li>`carouselLeft` - slide out from right to left</li>\n    <li>`carouselRight` - slide out from left to right</li>\n    <li>`carouselUp` - slide out from bottom to top</li>\n    <li>`carouselDown` - slide out from top  to bottom</li>\n    <li>`shuffleTopRight` - rotate out from top right</li>\n    <li>`shuffleRightTop` - rotate out from right top</li>\n    <li>`shuffleRightBottom` - rotate out from right bottom</li>\n    <li>`shuffleBottomRight` - rotate out from bottom right</li>\n    <li>`shuffleBottomLeft` - rotate out from bottom left</li>\n    <li>`shuffleLeftBottom` - rotate out from left bottom</li>\n    <li>`shuffleLeftTop` - rotate out from left top</li>\n    <li>`shuffleTopLeft` - rotate out from top left</li>\n    <li>`zoom` - fast zoom out</li>\n  </ul>\nThe transition speed can also be controlled by appending `Fast` or `Slow` to the transition, e.g. `fadeFast` or `CarouselLeftSlow`.",
             "enum": [
+              "none",
               "fade",
               "fadeSlow",
               "fadeFast",
@@ -2141,7 +2293,7 @@
         }
       },
       "SkewTransformation": {
-        "description": "Skew a clip so its edges are sheared at an angle. Use values between 0 and 3. Over 3 the clip will be skewed almost flat.",
+        "description": "Skew a clip so its edges are sheared at an angle. Use values between -100 and 100. Values over 3 or under -3 will skew the clip almost flat.",
         "type": "object",
         "properties": {
           "x": {
@@ -2149,8 +2301,10 @@
             "oneOf": [
               {
                 "type": "number",
-                "description": "Range varies from 0 to 3. Positive numbers skew the asset right, negative left. The distance moved is relative to the width of the viewport - i.e. an X skew of 0.5 will skew the asset half the screen width to the right.",
+                "description": "Range varies from -100 to 100. Positive numbers skew the asset right, negative left. The distance moved is relative to the width of the viewport - i.e. an X skew of 0.5 will skew the asset half the screen width to the right.",
                 "format": "float",
+                "minimum": -100,
+                "maximum": 100,
                 "example": 0.5
               },
               {
@@ -2167,8 +2321,10 @@
             "oneOf": [
               {
                 "type": "number",
-                "description": "Range varies from 0 to 3. Positive numbers skew the asset up, negative down. The distance moved is relative to the height of the viewport - i.e. an Y skew of 0.5 will skew the asset half the screen height up.",
+                "description": "Range varies from -100 to 100. Positive numbers skew the asset up, negative down. The distance moved is relative to the height of the viewport - i.e. an Y skew of 0.5 will skew the asset half the screen height up.",
                 "format": "float",
+                "minimum": -100,
+                "maximum": 100,
                 "example": 0.5
               },
               {
@@ -2240,7 +2396,28 @@
           "color": {
             "description": "The background color using hexadecimal color notation.",
             "type": "string",
+            "pattern": "^#[A-Fa-f0-9]{6}$",
             "example": "#000000"
+          },
+          "opacity": {
+            "description": "The opacity of the background where 1 is opaque and 0 is transparent.",
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1,
+            "example": 0.8
+          },
+          "padding": {
+            "description": "Padding inside the background box in pixels.",
+            "type": "number",
+            "minimum": 0,
+            "maximum": 100,
+            "example": 10
+          },
+          "borderRadius": {
+            "description": "The border radius of the background box in pixels for rounded corners.",
+            "type": "number",
+            "minimum": 0,
+            "example": 5
           }
         },
         "type": "object"
@@ -2275,7 +2452,7 @@
         "description": "Font properties for rich text.",
         "properties": {
           "family": {
-            "description": "The font family name. This must be the Family name embedded in the font, i.e. \"Open Sans\". For custom fonts, use the family name specified in the customFonts array.",
+            "description": "The font family name. This must be the Family name embedded in the font, i.e. \"Open Sans\".",
             "type": "string",
             "example": "Open Sans",
             "default": "Open Sans"
@@ -2871,7 +3048,8 @@
               "mobile",
               "sd",
               "hd",
-              "1080"
+              "1080",
+              "4k"
             ],
             "type": "string"
           },
@@ -3021,6 +3199,57 @@
           },
           {
             "$ref": "#/components/schemas/VimeoDestination"
+          },
+          {
+            "description": "Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.",
+            "properties": {
+              "provider": {
+                "description": "The destination to send video to - set to `tiktok` for TikTok.",
+                "type": "string",
+                "default": "tiktok",
+                "example": "tiktok"
+              },
+              "options": {
+                "description": "Additional TikTok configuration options.",
+                "properties": {
+                  "title": {
+                    "description": "A title for the video that will be displayed on TikTok.",
+                    "type": "string",
+                    "maxLength": 150
+                  },
+                  "privacyLevel": {
+                    "description": "The privacy level for the video. Options are: <ul>\n  <li>`public` - video is visible to everyone</li>\n  <li>`friends` - video is visible to friends only</li>\n  <li>`private` - video is only visible to you</li>\n</ul>",
+                    "type": "string",
+                    "enum": [
+                      "public",
+                      "friends",
+                      "private"
+                    ],
+                    "default": "private"
+                  },
+                  "disableDuet": {
+                    "description": "Disable the Duet feature for this video.",
+                    "type": "boolean",
+                    "default": false
+                  },
+                  "disableStitch": {
+                    "description": "Disable the Stitch feature for this video.",
+                    "type": "boolean",
+                    "default": false
+                  },
+                  "disableComment": {
+                    "description": "Disable comments on this video.",
+                    "type": "boolean",
+                    "default": false
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object",
+            "required": [
+              "provider"
+            ]
           }
         ],
         "additionalProperties": false
@@ -3251,6 +3480,11 @@
           "privacy": {
             "description": "Options to control the visibility of videos and privacy features.",
             "$ref": "#/components/schemas/VimeoDestinationPrivacyOptions"
+          },
+          "folderUri": {
+            "description": "The Vimeo folder URI to upload the video to. The folder must already exist in your Vimeo account.",
+            "type": "string",
+            "example": "/users/12345678/projects/87654321"
           }
         }
       },