@shotstack/schemas 1.5.9 → 1.7.0

package/dist/schema.d.ts

@@ -457,7 +457,7 @@ export interface components {
              * @default s1
              * @enum {string}
              */
-            instance: "s1" | "s2" | "a1";
+            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: {
@@ -748,25 +748,25 @@ export interface components {
                  * @default 0
                  * @example 2
                  */
-                width: number;
+                width?: number;
                 /**
                  * @description The border color using hexadecimal color notation.
                  * @default #000000
                  * @example #ff0000
                  */
-                color: string;
+                color?: string;
                 /**
                  * @description The opacity of the border where 1 is opaque and 0 is transparent.
                  * @default 1
                  * @example 0.8
                  */
-                opacity: number;
+                opacity?: number;
                 /**
                  * @description The border radius in pixels for rounded corners. Must be 0 or greater.
                  * @default 0
                  * @example 10
                  */
-                radius: number;
+                radius?: number;
             };
             /** @description Padding inside the text bounding box. Can be a single number (applied to all sides) or an object with individual sides. */
             padding?: number | {
@@ -775,25 +775,25 @@ export interface components {
                  * @default 0
                  * @example 10
                  */
-                top: number;
+                top?: number;
                 /**
                  * @description Right padding in pixels.
                  * @default 0
                  * @example 10
                  */
-                right: number;
+                right?: number;
                 /**
                  * @description Bottom padding in pixels.
                  * @default 0
                  * @example 10
                  */
-                bottom: number;
+                bottom?: number;
                 /**
                  * @description Left padding in pixels.
                  * @default 0
                  * @example 10
                  */
-                left: number;
+                left?: number;
             };
             /** @description Text alignment properties (horizontal and vertical). */
             align?: components["schemas"]["RichTextAlignment"];
@@ -1020,19 +1020,19 @@ export interface components {
              * @example bottom
              * @enum {string}
              */
-            position: "top" | "center" | "bottom";
+            position?: "top" | "center" | "bottom";
             /**
              * @description Maximum width of the caption as a ratio of the frame width. Must be between 0.1 and 1.
              * @default 0.9
              * @example 0.85
              */
-            maxWidth: number;
+            maxWidth?: number;
             /**
              * @description Maximum number of lines to display at once. Must be between 1 and 10.
              * @default 2
              * @example 2
              */
-            maxLines: number;
+            maxLines?: number;
         };
         /** @description Word-level timing information for caption animation. */
         WordTiming: {
@@ -1064,7 +1064,7 @@ export interface components {
              * @default #ffff00
              * @example #ffff00
              */
-            color: string;
+            color?: string;
             /**
              * @description The background color behind the active word using hexadecimal color notation.
              * @example #000000
@@ -1075,7 +1075,7 @@ export interface components {
              * @default 1
              * @example 1
              */
-            opacity: number;
+            opacity?: number;
         };
         /** @description Styling properties for the active/highlighted word. */
         RichCaptionActive: {
@@ -1088,7 +1088,7 @@ export interface components {
              * @default 1
              * @example 1.2
              */
-            scale: number;
+            scale?: number;
         };
         /** @description Word-level animation properties for caption effects. */
         RichCaptionWordAnimation: {
@@ -1113,14 +1113,14 @@ export interface components {
              * @default 1
              * @example 1
              */
-            speed: number;
+            speed?: number;
             /**
              * @description Direction for directional animations (slide). Only applicable when style is `slide`.
              * @default up
              * @example up
              * @enum {string}
              */
-            direction: "left" | "right" | "up" | "down";
+            direction?: "left" | "right" | "up" | "down";
         };
         /** @description The TextToImageAsset lets you create a dynamic image from a text prompt. */
         TextToImageAsset: {
@@ -1203,7 +1203,7 @@ export interface components {
              * @description Set the voice to newscaster mode.
              * @default false
              */
-            newscaster: boolean;
+            newscaster?: boolean;
             /** @description The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the trim point. The audio will play until the file ends or the Clip length is reached. */
             trim?: number;
             /** @description Set the volume of the audio clip. Use a number or an array of [Tween](./#tocs_tween) objects to create custom volume transitions. */
@@ -1498,7 +1498,7 @@ export interface components {
              * @default 1
              * @example 1
              */
-            opacity: number;
+            opacity?: number;
             /**
              * @description The width of the bounding box in pixels.
              *     If specified, the shape may be scaled to fit within this width.
@@ -1550,7 +1550,7 @@ export interface components {
              * @default 0
              * @example 10
              */
-            cornerRadius: number;
+            cornerRadius?: number;
         };
         /**
          * @description A perfect circle shape defined by its radius.
@@ -1814,7 +1814,7 @@ export interface components {
              * @default 1
              * @example 0.8
              */
-            opacity: number;
+            opacity?: number;
         };
         /**
          * @description A linear gradient fill that transitions colors along a straight line.
@@ -1832,7 +1832,7 @@ export interface components {
              * @default 0
              * @example 45
              */
-            angle: number;
+            angle?: number;
             /**
              * @description Array of color stops that define the gradient colors and their positions.
              *     Must have at least 2 stops. Offsets should increase from 0 to 1.
@@ -1843,7 +1843,7 @@ export interface components {
              * @default 1
              * @example 1
              */
-            opacity: number;
+            opacity?: number;
         };
         /**
          * @description A radial gradient fill that transitions colors radiating outward from a center point.
@@ -1865,7 +1865,7 @@ export interface components {
              * @default 1
              * @example 1
              */
-            opacity: number;
+            opacity?: number;
         };
         /**
          * @description A color stop in a gradient. Each stop defines a color at a specific position
@@ -1894,20 +1894,20 @@ export interface components {
              * @default #000000
              * @example #2c3e50
              */
-            color: string;
+            color?: string;
             /**
              * @description The width of the stroke in pixels. Must be greater than 0.
              *     Larger values create thicker outlines.
              * @default 1
              * @example 2
              */
-            width: number;
+            width?: number;
             /**
              * @description The opacity of the stroke where `1` is opaque and `0` is transparent.
              * @default 1
              * @example 1
              */
-            opacity: number;
+            opacity?: number;
             /**
              * @description The shape at the end of open paths (lines, polylines, unclosed paths).
              *     <ul>
@@ -1919,7 +1919,7 @@ export interface components {
              * @example round
              * @enum {string}
              */
-            lineCap: "butt" | "round" | "square";
+            lineCap?: "butt" | "round" | "square";
             /**
              * @description The shape at the corners where two lines meet.
              *     <ul>
@@ -1931,7 +1931,7 @@ export interface components {
              * @example round
              * @enum {string}
              */
-            lineJoin: "miter" | "round" | "bevel";
+            lineJoin?: "miter" | "round" | "bevel";
             /**
              * @description Pattern of dashes and gaps for the stroke. An array of numbers where
              *     odd indices are dash lengths and even indices are gap lengths.
@@ -1949,7 +1949,7 @@ export interface components {
              * @default 0
              * @example 5
              */
-            dashOffset: number;
+            dashOffset?: number;
         };
         /** @description Drop shadow properties for SVG shapes. Creates a shadow effect behind the shape. */
         SvgShadow: {
@@ -1959,32 +1959,32 @@ export interface components {
              * @default 0
              * @example 4
              */
-            offsetX: number;
+            offsetX?: number;
             /**
              * @description Vertical offset of the shadow in pixels.
              *     Positive values move the shadow down, negative values move it up.
              * @default 0
              * @example 4
              */
-            offsetY: number;
+            offsetY?: number;
             /**
              * @description The blur radius of the shadow in pixels. Must be 0 or greater.
              * @default 0
              * @example 8
              */
-            blur: number;
+            blur?: number;
             /**
              * @description The shadow color using hexadecimal color notation.
              * @default #000000
              * @example #000000
              */
-            color: string;
+            color?: string;
             /**
              * @description The opacity of the shadow where `1` is opaque and `0` is transparent.
              * @default 0.5
              * @example 0.3
              */
-            opacity: number;
+            opacity?: number;
         };
         /** @description Transformation properties for positioning, rotating, and scaling SVG shapes. */
         SvgTransform: {
@@ -1994,42 +1994,42 @@ export interface components {
              * @default 0
              * @example 100
              */
-            x: number;
+            x?: number;
             /**
              * @description The y-coordinate position of the shape in pixels.
              *     Relative to the top-left corner of the viewport.
              * @default 0
              * @example 100
              */
-            y: number;
+            y?: number;
             /**
              * @description Rotation angle in degrees. Positive values rotate clockwise,
              *     negative values rotate counter-clockwise. Range: -360 to 360.
              * @default 0
              * @example 45
              */
-            rotation: number;
+            rotation?: number;
             /**
              * @description Scale factor for the shape. `1` is original size, `2` is double size,
              *     `0.5` is half size. Must be greater than 0.
              * @default 1
              * @example 1.5
              */
-            scale: number;
+            scale?: number;
             /**
              * @description The x-coordinate of the transformation origin as a value from 0 to 1.
              *     `0` is the left edge, `0.5` is the center, `1` is the right edge.
              * @default 0.5
              * @example 0.5
              */
-            originX: number;
+            originX?: number;
             /**
              * @description The y-coordinate of the transformation origin as a value from 0 to 1.
              *     `0` is the top edge, `0.5` is the center, `1` is the bottom edge.
              * @default 0.5
              * @example 0.5
              */
-            originY: number;
+            originY?: number;
         };
         /** @description In and out transitions for a clip - i.e. fade in and fade out */
         Transition: {
@@ -2241,30 +2241,30 @@ export interface components {
              * @default Open Sans
              * @example Open Sans
              */
-            family: string;
+            family?: string;
             /**
              * @description The size of the font in pixels (px). Must be between 1 and 500.
              * @default 24
              * @example 48
              */
-            size: number;
+            size?: number;
             /**
              * @description The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest).
              * @default 400
              */
-            weight: unknown;
+            weight?: unknown;
             /**
              * @description The text color using hexadecimal color notation.
              * @default #000000
              * @example #ff0000
              */
-            color: string;
+            color?: string;
             /**
              * @description The opacity of the text where 1 is opaque and 0 is transparent.
              * @default 1
              * @example 0.9
              */
-            opacity: number;
+            opacity?: number;
             /**
              * @description The background color behind the text using hexadecimal color notation.
              * @example #000000
@@ -2280,33 +2280,33 @@ export interface components {
              * @default 0
              * @example 2
              */
-            letterSpacing: number;
+            letterSpacing?: number;
             /**
              * @description Additional spacing between words in pixels. A value of 0 uses the font's natural space width.
              * @default 0
              * @example 10
              */
-            wordSpacing: number;
+            wordSpacing?: number;
             /**
              * @description The line height as a multiplier of the font size. Must be between 0 and 10.
              * @default 1.2
              * @example 1.5
              */
-            lineHeight: number;
+            lineHeight?: number;
             /**
              * @description Text transformation to apply.
              * @default none
              * @example uppercase
              * @enum {string}
              */
-            textTransform: "none" | "uppercase" | "lowercase" | "capitalize";
+            textTransform?: "none" | "uppercase" | "lowercase" | "capitalize";
             /**
              * @description Text decoration to apply.
              * @default none
              * @example underline
              * @enum {string}
              */
-            textDecoration: "none" | "underline" | "line-through";
+            textDecoration?: "none" | "underline" | "line-through";
             /** @description Gradient fill for text instead of solid color. */
             gradient?: components["schemas"]["RichTextGradient"];
         };
@@ -2318,13 +2318,13 @@ export interface components {
              * @example linear
              * @enum {string}
              */
-            type: "linear" | "radial";
+            type?: "linear" | "radial";
             /**
              * @description The angle of the gradient in degrees (for linear gradients). Must be between 0 and 360.
              * @default 0
              * @example 45
              */
-            angle: number;
+            angle?: number;
             /** @description Gradient color stops. Must have at least 2 stops. */
             stops: {
                 /**
@@ -2346,19 +2346,19 @@ export interface components {
              * @default 0
              * @example 2
              */
-            width: number;
+            width?: number;
             /**
              * @description The stroke color using hexadecimal color notation.
              * @default #000000
              * @example #000000
              */
-            color: string;
+            color?: string;
             /**
              * @description The opacity of the stroke where 1 is opaque and 0 is transparent.
              * @default 1
              * @example 0.8
              */
-            opacity: number;
+            opacity?: number;
         };
         /** @description Text shadow properties. */
         RichTextShadow: {
@@ -2367,31 +2367,31 @@ export interface components {
              * @default 0
              * @example 4
              */
-            offsetX: number;
+            offsetX?: number;
             /**
              * @description Vertical offset of the shadow in pixels. Positive values move down, negative up.
              * @default 0
              * @example 4
              */
-            offsetY: number;
+            offsetY?: number;
             /**
              * @description The blur radius of the shadow in pixels. Must be 0 or greater.
              * @default 0
              * @example 8
              */
-            blur: number;
+            blur?: number;
             /**
              * @description The shadow color using hexadecimal color notation.
              * @default #000000
              * @example #000000
              */
-            color: string;
+            color?: string;
             /**
              * @description The opacity of the shadow where 1 is opaque and 0 is transparent.
              * @default 0.5
              * @example 0.7
              */
-            opacity: number;
+            opacity?: number;
         };
         /** @description Background styling properties for the text bounding box. */
         RichTextBackground: {
@@ -2405,13 +2405,13 @@ export interface components {
              * @default 1
              * @example 0.5
              */
-            opacity: number;
+            opacity?: number;
             /**
              * @description The border radius of the background box in pixels. Must be 0 or greater.
              * @default 0
              * @example 10
              */
-            borderRadius: number;
+            borderRadius?: number;
         };
         /** @description Text alignment properties (horizontal and vertical). */
         RichTextAlignment: {
@@ -2421,14 +2421,14 @@ export interface components {
              * @example center
              * @enum {string}
              */
-            horizontal: "left" | "center" | "right";
+            horizontal?: "left" | "center" | "right";
             /**
              * @description The vertical alignment of the text within the bounding box.
              * @default middle
              * @example middle
              * @enum {string}
              */
-            vertical: "top" | "middle" | "bottom";
+            vertical?: "top" | "middle" | "bottom";
         };
         /** @description Animation properties for text entrance effects. */
         RichTextAnimation: {
@@ -2799,22 +2799,22 @@ export interface components {
                  * @default private
                  * @enum {string}
                  */
-                privacyLevel: "public" | "friends" | "private";
+                privacyLevel?: "public" | "friends" | "private";
                 /**
                  * @description Disable the Duet feature for this video.
                  * @default false
                  */
-                disableDuet: boolean;
+                disableDuet?: boolean;
                 /**
                  * @description Disable the Stitch feature for this video.
                  * @default false
                  */
-                disableStitch: boolean;
+                disableStitch?: boolean;
                 /**
                  * @description Disable comments on this video.
                  * @default false
                  */
-                disableComment: boolean;
+                disableComment?: boolean;
             };
         };
         /** @description Send videos and assets to the  [Shotstack hosting and CDN](https://shotstack.io/docs/guide/serving-assets/destinations/shotstack/) service.  This destination is enabled by default. */
@@ -3450,12 +3450,12 @@ export interface components {
              * @default en-US
              * @enum {string}
              */
-            language: "cmn-CN" | "da-DK" | "de-DE" | "en-AU" | "en-GB" | "en-IN" | "en-US" | "es-ES" | "es-MX" | "es-US" | "fr-CA" | "fr-FR" | "it-IT" | "ja-JP" | "hi-IN" | "ko-KR" | "nb-NO" | "nl-NL" | "pl-PL" | "pt-BR" | "pt-PT" | "sv-SE" | "en-NZ" | "en-ZA" | "ca-ES" | "de-AT" | "yue-CN" | "ar-AE" | "fi-FI";
+            language?: "cmn-CN" | "da-DK" | "de-DE" | "en-AU" | "en-GB" | "en-IN" | "en-US" | "es-ES" | "es-MX" | "es-US" | "fr-CA" | "fr-FR" | "it-IT" | "ja-JP" | "hi-IN" | "ko-KR" | "nb-NO" | "nl-NL" | "pl-PL" | "pt-BR" | "pt-PT" | "sv-SE" | "en-NZ" | "en-ZA" | "ca-ES" | "de-AT" | "yue-CN" | "ar-AE" | "fi-FI";
             /**
              * @description Set the voice to newscaster mode.<br /><br /> *Only Matthew and Joanna for US English (en-US), Lupe for US Spanish (es-US), and Amy for British English (en-GB) are available in the newscaster voice.
              * @default false
              */
-            newscaster: boolean;
+            newscaster?: boolean;
         };
         /** @description Options for the Shotstack text-to-image service. Set a text prompt to generate an image from. The output will be  generated as a PNG file available at the URL returned in the response. */
         ShotstackTextToImageOptions: {
@@ -3499,13 +3499,13 @@ export interface components {
              * @default 1.8
              * @example 1.8
              */
-            guidanceScale: number;
+            guidanceScale?: number;
             /**
              * @description The amount of motion in the video. A number between 1 and 255.
              * @default 127
              * @example 127
              */
-            motion: number;
+            motion?: number;
         };
         /** @description Options for the Shotstack text-generator service. Set a text prompt that will be used to generate a new body of text. The output will be generated as a text (txt) file available at the URL returned in the response. */
         ShotstackTextGeneratorOptions: {
@@ -3875,7 +3875,7 @@ export interface components {
              * @example stable-diffusion-xl-1024-v1-0
              * @enum {string}
              */
-            engine: "stable-diffusion-xl-1024-v0-9" | "stable-diffusion-xl-1024-v1-0" | "stable-diffusion-v1-6" | "stable-diffusion-512-v2-1" | "stable-diffusion-xl-beta-v2-2-2";
+            engine?: "stable-diffusion-xl-1024-v0-9" | "stable-diffusion-xl-1024-v1-0" | "stable-diffusion-v1-6" | "stable-diffusion-512-v2-1" | "stable-diffusion-xl-beta-v2-2-2";
             /**
              * @description The width of the image in pixels. Must be divisible by 64.
              * @example 512
@@ -3891,19 +3891,19 @@ export interface components {
              * @default 30
              * @example 30
              */
-            steps: number;
+            steps?: number;
             /**
              * @description Using the same seed can help you create images that look similar. Set to 0 for a random seed. A number between 0 and 4294967295.
              * @default 0
              * @example 0
              */
-            seed: number;
+            seed?: number;
             /**
              * @description Determines how closely the generated image will match the prompt. Lower numbers allow for more creative freedom. A number between 0 and 35.
              * @default 7
              * @example 7
              */
-            cfgScale: number;
+            cfgScale?: number;
             /**
              * @description Apply a preset to generate an image in a particular style. Select from the list of available presets: <ul>
              *       <li>`3d-model`</li>