@shotstack/schemas 1.5.7 → 1.5.9

package/dist/api.bundled.json

@@ -910,8 +910,19 @@
               "mount"
             ],
             "deprecated": true
+          },
+          "instance": {
+            "description": "The render instance type to use for processing the edit. <ul>\n  <li>`s1` - standard instance (default)</li>\n  <li>`s2` - standard instance with more resources</li>\n  <li>`a1` - accelerated instance for faster rendering</li>\n</ul>",
+            "type": "string",
+            "enum": [
+              "s1",
+              "s2",
+              "a1"
+            ],
+            "default": "s1"
           }
         },
+        "additionalProperties": false,
         "required": [
           "timeline",
           "output"
@@ -949,6 +960,7 @@
             "type": "boolean"
           }
         },
+        "additionalProperties": false,
         "required": [
           "tracks"
         ],
@@ -978,6 +990,7 @@
             "type": "number"
           }
         },
+        "additionalProperties": false,
         "required": [
           "src"
         ],
@@ -992,6 +1005,7 @@
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/open-sans.ttf"
           }
         },
+        "additionalProperties": false,
         "required": [
           "src"
         ],
@@ -1009,6 +1023,7 @@
             }
           }
         },
+        "additionalProperties": false,
         "required": [
           "clips"
         ],
@@ -1188,6 +1203,7 @@
             "example": "MY_VIDEO_CLIP"
           }
         },
+        "additionalProperties": false,
         "required": [
           "asset",
           "start",
@@ -1341,6 +1357,7 @@
             "$ref": "#/components/schemas/ChromaKey"
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "src"
@@ -1369,6 +1386,7 @@
             "$ref": "#/components/schemas/Crop"
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "src"
@@ -1430,6 +1448,7 @@
                 "example": "#000000"
               }
             },
+            "additionalProperties": false,
             "type": "object"
           },
           "animation": {
@@ -1451,6 +1470,7 @@
                 "example": 2
               }
             },
+            "additionalProperties": false,
             "required": [
               "preset"
             ],
@@ -1462,6 +1482,7 @@
             "example": "..."
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "text"
@@ -1538,6 +1559,7 @@
                 "example": 10
               }
             },
+            "additionalProperties": false,
             "type": "object"
           },
           "padding": {
@@ -1581,6 +1603,7 @@
                     "example": 10
                   }
                 },
+                "additionalProperties": false,
                 "type": "object"
               }
             ]
@@ -1594,6 +1617,7 @@
             "$ref": "#/components/schemas/RichTextAnimation"
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "text"
@@ -1661,6 +1685,7 @@
             "type": "string"
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "src"
@@ -1711,7 +1736,8 @@
                 "type": "number",
                 "example": 1
               }
-            }
+            },
+            "additionalProperties": false
           },
           "stroke": {
             "description": "Specifies the stroke style of the shape.",
@@ -1727,7 +1753,8 @@
                 "type": "number",
                 "example": 0.8
               }
-            }
+            },
+            "additionalProperties": false
           },
           "rectangle": {
             "description": "Configuration settings for the rectangle shape. Required when `shape` is set to `rectangle`.",
@@ -1749,6 +1776,7 @@
                 "example": 20
               }
             },
+            "additionalProperties": false,
             "required": [
               "width",
               "height"
@@ -1764,6 +1792,7 @@
                 "example": 800
               }
             },
+            "additionalProperties": false,
             "required": [
               "radius"
             ]
@@ -1783,12 +1812,14 @@
                 "example": 4
               }
             },
+            "additionalProperties": false,
             "required": [
               "length",
               "thickness"
             ]
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "shape"
@@ -1818,6 +1849,7 @@
             "type": "number"
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "src"
@@ -1868,6 +1900,7 @@
             "example": 1
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "src"
@@ -1973,6 +2006,7 @@
             "example": 2
           }
         },
+        "additionalProperties": false,
         "required": [
           "type"
         ]
@@ -2007,6 +2041,7 @@
             "example": 0.98
           }
         },
+        "additionalProperties": false,
         "required": [
           "text",
           "start",
@@ -2038,7 +2073,8 @@
             "default": 1,
             "example": 1
           }
-        }
+        },
+        "additionalProperties": false
       },
       "RichCaptionActive": {
         "description": "Styling properties for the active/highlighted word.",
@@ -2060,7 +2096,8 @@
             "default": 1,
             "example": 1.2
           }
-        }
+        },
+        "additionalProperties": false
       },
       "RichCaptionWordAnimation": {
         "description": "Word-level animation properties for caption effects.",
@@ -2103,6 +2140,7 @@
             "example": "up"
           }
         },
+        "additionalProperties": false,
         "required": [
           "style"
         ]
@@ -2137,6 +2175,8 @@
             "$ref": "#/components/schemas/Crop"
           }
         },
+        "additionalProperties": false,
+        "type": "object",
         "required": [
           "type",
           "prompt"
@@ -2190,6 +2230,7 @@
             "$ref": "#/components/schemas/Crop"
           }
         },
+        "additionalProperties": false,
         "type": "object",
         "required": [
           "type",
@@ -2271,6 +2312,7 @@
             "type": "string"
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "text",
@@ -2330,6 +2372,7 @@
             "type": "string"
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "html"
@@ -2411,6 +2454,7 @@
             "$ref": "#/components/schemas/Offset"
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
           "text"
@@ -2479,6 +2523,7 @@
             "example": 300
           }
         },
+        "additionalProperties": false,
         "required": [
           "type"
         ],
@@ -2578,6 +2623,7 @@
       "SvgRectangleShape": {
         "description": "A rectangle shape with optional rounded corners.\nThe rectangle is defined by its width and height dimensions.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `rectangle`.",
@@ -2618,6 +2664,7 @@
       "SvgCircleShape": {
         "description": "A perfect circle shape defined by its radius.\nThe circle is centered at the shape's position.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `circle`.",
@@ -2642,6 +2689,7 @@
       "SvgEllipseShape": {
         "description": "An ellipse (oval) shape with separate horizontal and vertical radii.\nThe ellipse is centered at the shape's position.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `ellipse`.",
@@ -2674,6 +2722,7 @@
       "SvgLineShape": {
         "description": "A straight line shape with a specified length and thickness.\nThe line is drawn horizontally by default and can be rotated using transform.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `line`.",
@@ -2706,6 +2755,7 @@
       "SvgPolygonShape": {
         "description": "A regular polygon shape with a specified number of sides.\nExamples: triangle (3), square (4), pentagon (5), hexagon (6), etc.\nThe polygon is inscribed in a circle of the given radius.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `polygon`.",
@@ -2738,6 +2788,7 @@
       "SvgStarShape": {
         "description": "A star shape with a specified number of points.\nThe star is defined by outer and inner radii, creating the characteristic\npointed appearance.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `star`.",
@@ -2778,6 +2829,7 @@
       "SvgArrowShape": {
         "description": "An arrow shape pointing to the right by default.\nUse transform rotation to change direction.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `arrow`.",
@@ -2826,6 +2878,7 @@
       "SvgHeartShape": {
         "description": "A heart shape commonly used for love/like icons.\nThe heart is defined by a single size parameter.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `heart`.",
@@ -2850,6 +2903,7 @@
       "SvgCrossShape": {
         "description": "A cross or plus shape with equal or different arm lengths.\nCan be styled as a plus sign (+) or a cross (x with rotation).\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `cross`.",
@@ -2890,6 +2944,7 @@
       "SvgRingShape": {
         "description": "A ring (donut/annulus) shape - a circle with a circular hole in the center.\nThe ring is defined by outer and inner radii.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `ring`.",
@@ -2922,6 +2977,7 @@
       "SvgPathShape": {
         "description": "A custom shape defined by SVG path data.\nSupports all standard SVG path commands for creating complex shapes.\n\n**Path Commands:**\n- `M x y` / `m dx dy` - Move to (absolute/relative)\n- `L x y` / `l dx dy` - Line to\n- `H x` / `h dx` - Horizontal line to\n- `V y` / `v dy` - Vertical line to\n- `C x1 y1 x2 y2 x y` / `c` - Cubic Bezier curve\n- `S x2 y2 x y` / `s` - Smooth cubic Bezier\n- `Q x1 y1 x y` / `q` - Quadratic Bezier curve\n- `T x y` / `t` - Smooth quadratic Bezier\n- `A rx ry angle large-arc sweep x y` / `a` - Elliptical arc\n- `Z` / `z` - Close path\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The shape type - set to `path`.",
@@ -2968,6 +3024,7 @@
       "SvgSolidFill": {
         "description": "A solid color fill for SVG shapes.",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The fill type - set to `solid` for a single color fill.",
@@ -3001,6 +3058,7 @@
       "SvgLinearGradientFill": {
         "description": "A linear gradient fill that transitions colors along a straight line.\nThe gradient direction is controlled by the `angle` property.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The fill type - set to `linear` for a linear gradient fill.",
@@ -3042,6 +3100,7 @@
       "SvgRadialGradientFill": {
         "description": "A radial gradient fill that transitions colors radiating outward from a center point.\nThe gradient creates a circular or elliptical color transition.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "type": {
             "description": "The fill type - set to `radial` for a radial gradient fill.",
@@ -3075,6 +3134,7 @@
       "SvgGradientStop": {
         "description": "A color stop in a gradient. Each stop defines a color at a specific position\nalong the gradient vector. Gradients require at least 2 stops.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "offset": {
             "description": "Position of the color stop along the gradient vector.\n`0` represents the start and `1` represents the end of the gradient.\n",
@@ -3098,6 +3158,7 @@
       "SvgStroke": {
         "description": "Stroke (outline) properties for SVG shapes. The stroke defines how the outline\nof a shape is painted, including its color, width, and line style.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "color": {
             "description": "The stroke color using hexadecimal color notation.",
@@ -3167,6 +3228,7 @@
       "SvgShadow": {
         "description": "Drop shadow properties for SVG shapes. Creates a shadow effect behind the shape.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "offsetX": {
             "description": "Horizontal offset of the shadow in pixels.\nPositive values move the shadow to the right, negative to the left.\n",
@@ -3207,6 +3269,7 @@
       "SvgTransform": {
         "description": "Transformation properties for positioning, rotating, and scaling SVG shapes.\n",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "x": {
             "description": "The x-coordinate position of the shape in pixels.\nRelative to the top-left corner of the viewport.\n",
@@ -3394,6 +3457,7 @@
             "type": "string"
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "Offset": {
@@ -3440,6 +3504,7 @@
             ]
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "Crop": {
@@ -3476,11 +3541,13 @@
             "maximum": 1
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "Transformation": {
         "description": "Apply one or more transformations to a clip. Transformations alter the visual properties of a clip and can be combined to create new shapes and effects.",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "rotate": {
             "$ref": "#/components/schemas/RotateTransformation"
@@ -3496,6 +3563,7 @@
       "RotateTransformation": {
         "description": "Rotate a clip by the specified angle in degrees. Rotation origin is set based on the clips `position`.",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "angle": {
             "description": "Rotate a clip by the specified angle in degrees. Use a number or an array of [Tween](./#tocs_tween) objects to create a custom animation.",
@@ -3522,6 +3590,7 @@
       "SkewTransformation": {
         "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",
+        "additionalProperties": false,
         "properties": {
           "x": {
             "description": "Skew the clip along it's x axis.",
@@ -3568,6 +3637,7 @@
       "FlipTransformation": {
         "description": "Flip a clip vertically or horizontally. Acts as a mirror effect of the clip along the selected plane.",
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "horizontal": {
             "description": "Flip a clip horizontally.",
@@ -3615,6 +3685,7 @@
             "example": 0.85
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "TextBackground": {
@@ -3647,6 +3718,7 @@
             "example": 5
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "TextAlignment": {
@@ -3673,6 +3745,7 @@
             ]
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "RichTextFont": {
@@ -3722,6 +3795,7 @@
             "$ref": "#/components/schemas/RichTextStroke"
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "RichTextStyle": {
@@ -3776,6 +3850,7 @@
             "$ref": "#/components/schemas/RichTextGradient"
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "RichTextGradient": {
@@ -3823,13 +3898,15 @@
               "required": [
                 "offset",
                 "color"
-              ]
+              ],
+              "additionalProperties": false
             }
           }
         },
         "required": [
           "stops"
         ],
+        "additionalProperties": false,
         "type": "object"
       },
       "RichTextStroke": {
@@ -3858,6 +3935,7 @@
             "example": 0.8
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "RichTextShadow": {
@@ -3898,6 +3976,7 @@
             "example": 0.7
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "RichTextBackground": {
@@ -3925,6 +4004,7 @@
             "example": 10
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "RichTextAlignment": {
@@ -3953,6 +4033,7 @@
             "example": "middle"
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "RichTextAnimation": {
@@ -4002,6 +4083,7 @@
         "required": [
           "preset"
         ],
+        "additionalProperties": false,
         "type": "object"
       },
       "CaptionFont": {
@@ -4043,6 +4125,7 @@
             "example": 0.8
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "CaptionBackground": {
@@ -4069,6 +4152,7 @@
             "example": 18
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "CaptionMargin": {
@@ -4090,6 +4174,7 @@
             "example": 0.45
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "ChromaKey": {
@@ -4116,6 +4201,7 @@
             "example": 100
           }
         },
+        "additionalProperties": false,
         "required": [
           "color"
         ],
@@ -4187,6 +4273,7 @@
             ]
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "MergeField": {
@@ -4203,6 +4290,7 @@
             "example": "Jane"
           }
         },
+        "additionalProperties": false,
         "required": [
           "find",
           "replace"
@@ -4323,6 +4411,7 @@
             }
           }
         },
+        "additionalProperties": false,
         "required": [
           "format"
         ],
@@ -4346,6 +4435,7 @@
             "example": 800
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "Range": {
@@ -4366,6 +4456,7 @@
             "example": 6
           }
         },
+        "additionalProperties": false,
         "type": "object"
       },
       "Poster": {
@@ -4377,6 +4468,7 @@
             "example": 1
           }
         },
+        "additionalProperties": false,
         "required": [
           "capture"
         ],
@@ -4398,6 +4490,7 @@
             "example": 0.3
           }
         },
+        "additionalProperties": false,
         "required": [
           "capture",
           "scale"
@@ -4772,6 +4865,7 @@
             "$ref": "#/components/schemas/Edit"
           }
         },
+        "additionalProperties": false,
         "required": [
           "name"
         ],
@@ -4793,6 +4887,7 @@
             }
           }
         },
+        "additionalProperties": false,
         "required": [
           "id"
         ],

package/dist/schema.d.ts

@@ -448,6 +448,16 @@ export interface components {
              * @enum {string}
              */
             disk?: "local" | "mount";
+            /**
+             * @description The render instance type to use for processing the edit. <ul>
+             *       <li>`s1` - standard instance (default)</li>
+             *       <li>`s2` - standard instance with more resources</li>
+             *       <li>`a1` - accelerated instance for faster rendering</li>
+             *     </ul>
+             * @default s1
+             * @enum {string}
+             */
+            instance: "s1" | "s2" | "a1";
         };
         /** @description A timeline represents the contents of a video edit over time, an audio edit over time, in seconds, or an image layout. A timeline consists of layers called tracks. Tracks are composed of titles, images, audio, html or video segments referred to as clips which are placed along the track at specific starting point and lasting for a specific amount of time. */
         Timeline: {
@@ -1115,8 +1125,7 @@ export interface components {
         /** @description The TextToImageAsset lets you create a dynamic image from a text prompt. */
         TextToImageAsset: {
             /**
-             * @description The type of asset to generate - set to `text-to-image` for text-to-image.
-             * @default text-to-image
+             * @description The type of asset to generate - set to `text-to-image` for text-to-image. (enum property replaced by openapi-typescript)
              * @enum {string}
              */
             type: "text-to-image";