@shotstack/schemas 1.1.1 → 1.3.0

package/dist/schema.d.ts

@@ -513,10 +513,20 @@ export interface components {
              */
             fit?: "cover" | "contain" | "crop" | "none";
             /**
-             * @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.
              * @example 0
              */
             scale?: number;
+            /**
+             * @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.
+             * @example 800
+             */
+            width?: number;
+            /**
+             * @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.
+             * @example 600
+             */
+            height?: number;
             /**
              * @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>
              *       <li>`top` - top (center)</li>
@@ -566,6 +576,11 @@ export interface components {
             opacity?: number | components["schemas"]["Tween"][];
             /** @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. */
             transform?: components["schemas"]["Transformation"];
+            /**
+             * @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.
+             * @example MY_VIDEO_CLIP
+             */
+            alias?: string;
         };
         /** @description The type of asset to display for the duration of the Clip, i.e. a video clip or an image. Choose from one of the available asset types below. */
         Asset: components["schemas"]["VideoAsset"] | components["schemas"]["ImageAsset"] | components["schemas"]["TextAsset"] | components["schemas"]["RichTextAsset"] | components["schemas"]["AudioAsset"] | components["schemas"]["LumaAsset"] | components["schemas"]["CaptionAsset"] | components["schemas"]["HtmlAsset"] | components["schemas"]["TitleAsset"] | components["schemas"]["ShapeAsset"] | components["schemas"]["TextToImageAsset"] | components["schemas"]["ImageToVideoAsset"];
@@ -602,7 +617,7 @@ export interface components {
              *     </ul>
              * @enum {string}
              */
-            volumeEffect?: "fadeIn" | "fadeOut" | "fadeInFadeOut";
+            volumeEffect?: "none" | "fadeIn" | "fadeOut" | "fadeInFadeOut";
             /**
              * Format: float
              * @description Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to  adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).
@@ -667,6 +682,40 @@ export interface components {
             background?: components["schemas"]["TextBackground"];
             /** @description Alignment properties. */
             alignment?: components["schemas"]["TextAlignment"];
+            /** @description Text stroke (outline) properties. */
+            stroke?: {
+                /**
+                 * @description The width of the stroke in pixels.
+                 * @example 2
+                 */
+                width?: number;
+                /**
+                 * @description The stroke color using hexadecimal color notation.
+                 * @example #000000
+                 */
+                color?: string;
+            };
+            /** @description Animation properties for text entrance effects. */
+            animation?: {
+                /**
+                 * @description The animation preset to apply. <ul>
+                 *       <li>`typewriter` - typewriter effect where characters appear one at a time</li>
+                 *     </ul>
+                 * @example typewriter
+                 * @enum {string}
+                 */
+                preset: "typewriter";
+                /**
+                 * @description The duration of the animation in seconds.
+                 * @example 2
+                 */
+                duration?: number;
+            };
+            /**
+             * @description The string to display when text overflows its bounding box. Set to an ellipsis character or custom string to indicate truncated text.
+             * @example ...
+             */
+            ellipsis?: string;
             /**
              * @description discriminator enum property added by openapi-typescript
              * @enum {string}
@@ -694,7 +743,7 @@ export interface components {
              */
             width?: number;
             /**
-             * @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.
              * @example 600
              */
             height?: number;
@@ -708,6 +757,60 @@ export interface components {
             shadow?: components["schemas"]["RichTextShadow"];
             /** @description Background styling properties for the text bounding box. */
             background?: components["schemas"]["RichTextBackground"];
+            /** @description Border styling properties for the text bounding box. */
+            border?: {
+                /**
+                 * @description The width of the border in pixels. Must be 0 or greater.
+                 * @default 0
+                 * @example 2
+                 */
+                width: number;
+                /**
+                 * @description The border color using hexadecimal color notation.
+                 * @default #000000
+                 * @example #ff0000
+                 */
+                color: string;
+                /**
+                 * @description The opacity of the border where 1 is opaque and 0 is transparent.
+                 * @default 1
+                 * @example 0.8
+                 */
+                opacity: number;
+                /**
+                 * @description The border radius in pixels for rounded corners. Must be 0 or greater.
+                 * @default 0
+                 * @example 10
+                 */
+                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 | {
+                /**
+                 * @description Top padding in pixels.
+                 * @default 0
+                 * @example 10
+                 */
+                top: number;
+                /**
+                 * @description Right padding in pixels.
+                 * @default 0
+                 * @example 10
+                 */
+                right: number;
+                /**
+                 * @description Bottom padding in pixels.
+                 * @default 0
+                 * @example 10
+                 */
+                bottom: number;
+                /**
+                 * @description Left padding in pixels.
+                 * @default 0
+                 * @example 10
+                 */
+                left: number;
+            };
             /** @description Text alignment properties (horizontal and vertical). */
             align?: components["schemas"]["RichTextAlignment"];
             /** @description Animation properties for text entrance effects. */
@@ -748,7 +851,7 @@ export interface components {
              *     </ul>
              * @enum {string}
              */
-            effect?: "fadeIn" | "fadeOut" | "fadeInFadeOut";
+            effect?: "none" | "fadeIn" | "fadeOut" | "fadeInFadeOut";
             /**
              * @description discriminator enum property added by openapi-typescript
              * @enum {string}
@@ -1136,7 +1239,7 @@ export interface components {
              *     The transition speed can also be controlled by appending `Fast` or `Slow` to the transition, e.g. `fadeFast` or `CarouselLeftSlow`.
              * @enum {string}
              */
-            in?: "fade" | "fadeSlow" | "fadeFast" | "reveal" | "revealSlow" | "revealFast" | "wipeLeft" | "wipeLeftSlow" | "wipeLeftFast" | "wipeRight" | "wipeRightSlow" | "wipeRightFast" | "slideLeft" | "slideLeftSlow" | "slideLeftFast" | "slideRight" | "slideRightSlow" | "slideRightFast" | "slideUp" | "slideUpSlow" | "slideUpFast" | "slideDown" | "slideDownSlow" | "slideDownFast" | "carouselLeft" | "carouselLeftSlow" | "carouselLeftFast" | "carouselRight" | "carouselRightSlow" | "carouselRightFast" | "carouselUp" | "carouselUpSlow" | "carouselUpFast" | "carouselDown" | "carouselDownSlow" | "carouselDownFast" | "shuffleTopRight" | "shuffleTopRightSlow" | "shuffleTopRightFast" | "shuffleRightTop" | "shuffleRightTopSlow" | "shuffleRightTopFast" | "shuffleRightBottom" | "shuffleRightBottomSlow" | "shuffleRightBottomFast" | "shuffleBottomRight" | "shuffleBottomRightSlow" | "shuffleBottomRightFast" | "shuffleBottomLeft" | "shuffleBottomLeftSlow" | "shuffleBottomLeftFast" | "shuffleLeftBottom" | "shuffleLeftBottomSlow" | "shuffleLeftBottomFast" | "shuffleLeftTop" | "shuffleLeftTopSlow" | "shuffleLeftTopFast" | "shuffleTopLeft" | "shuffleTopLeftSlow" | "shuffleTopLeftFast" | "zoom";
+            in?: "none" | "fade" | "fadeSlow" | "fadeFast" | "reveal" | "revealSlow" | "revealFast" | "wipeLeft" | "wipeLeftSlow" | "wipeLeftFast" | "wipeRight" | "wipeRightSlow" | "wipeRightFast" | "slideLeft" | "slideLeftSlow" | "slideLeftFast" | "slideRight" | "slideRightSlow" | "slideRightFast" | "slideUp" | "slideUpSlow" | "slideUpFast" | "slideDown" | "slideDownSlow" | "slideDownFast" | "carouselLeft" | "carouselLeftSlow" | "carouselLeftFast" | "carouselRight" | "carouselRightSlow" | "carouselRightFast" | "carouselUp" | "carouselUpSlow" | "carouselUpFast" | "carouselDown" | "carouselDownSlow" | "carouselDownFast" | "shuffleTopRight" | "shuffleTopRightSlow" | "shuffleTopRightFast" | "shuffleRightTop" | "shuffleRightTopSlow" | "shuffleRightTopFast" | "shuffleRightBottom" | "shuffleRightBottomSlow" | "shuffleRightBottomFast" | "shuffleBottomRight" | "shuffleBottomRightSlow" | "shuffleBottomRightFast" | "shuffleBottomLeft" | "shuffleBottomLeftSlow" | "shuffleBottomLeftFast" | "shuffleLeftBottom" | "shuffleLeftBottomSlow" | "shuffleLeftBottomFast" | "shuffleLeftTop" | "shuffleLeftTopSlow" | "shuffleLeftTopFast" | "shuffleTopLeft" | "shuffleTopLeftSlow" | "shuffleTopLeftFast" | "zoom";
             /**
              * @description The transition out. Available transitions are:
              *       <ul>
@@ -1165,7 +1268,7 @@ export interface components {
              *     The transition speed can also be controlled by appending `Fast` or `Slow` to the transition, e.g. `fadeFast` or `CarouselLeftSlow`.
              * @enum {string}
              */
-            out?: "fade" | "fadeSlow" | "fadeFast" | "reveal" | "revealSlow" | "revealFast" | "wipeLeft" | "wipeLeftSlow" | "wipeLeftFast" | "wipeRight" | "wipeRightSlow" | "wipeRightFast" | "slideLeft" | "slideLeftSlow" | "slideLeftFast" | "slideRight" | "slideRightSlow" | "slideRightFast" | "slideUp" | "slideUpSlow" | "slideUpFast" | "slideDown" | "slideDownSlow" | "slideDownFast" | "carouselLeft" | "carouselLeftSlow" | "carouselLeftFast" | "carouselRight" | "carouselRightSlow" | "carouselRightFast" | "carouselUp" | "carouselUpSlow" | "carouselUpFast" | "carouselDown" | "carouselDownSlow" | "carouselDownFast" | "shuffleTopRight" | "shuffleTopRightSlow" | "shuffleTopRightFast" | "shuffleRightTop" | "shuffleRightTopSlow" | "shuffleRightTopFast" | "shuffleRightBottom" | "shuffleRightBottomSlow" | "shuffleRightBottomFast" | "shuffleBottomRight" | "shuffleBottomRightSlow" | "shuffleBottomRightFast" | "shuffleBottomLeft" | "shuffleBottomLeftSlow" | "shuffleBottomLeftFast" | "shuffleLeftBottom" | "shuffleLeftBottomSlow" | "shuffleLeftBottomFast" | "shuffleLeftTop" | "shuffleLeftTopSlow" | "shuffleLeftTopFast" | "shuffleTopLeft" | "shuffleTopLeftSlow" | "shuffleTopLeftFast" | "zoom";
+            out?: "none" | "fade" | "fadeSlow" | "fadeFast" | "reveal" | "revealSlow" | "revealFast" | "wipeLeft" | "wipeLeftSlow" | "wipeLeftFast" | "wipeRight" | "wipeRightSlow" | "wipeRightFast" | "slideLeft" | "slideLeftSlow" | "slideLeftFast" | "slideRight" | "slideRightSlow" | "slideRightFast" | "slideUp" | "slideUpSlow" | "slideUpFast" | "slideDown" | "slideDownSlow" | "slideDownFast" | "carouselLeft" | "carouselLeftSlow" | "carouselLeftFast" | "carouselRight" | "carouselRightSlow" | "carouselRightFast" | "carouselUp" | "carouselUpSlow" | "carouselUpFast" | "carouselDown" | "carouselDownSlow" | "carouselDownFast" | "shuffleTopRight" | "shuffleTopRightSlow" | "shuffleTopRightFast" | "shuffleRightTop" | "shuffleRightTopSlow" | "shuffleRightTopFast" | "shuffleRightBottom" | "shuffleRightBottomSlow" | "shuffleRightBottomFast" | "shuffleBottomRight" | "shuffleBottomRightSlow" | "shuffleBottomRightFast" | "shuffleBottomLeft" | "shuffleBottomLeftSlow" | "shuffleBottomLeftFast" | "shuffleLeftBottom" | "shuffleLeftBottomSlow" | "shuffleLeftBottomFast" | "shuffleLeftTop" | "shuffleLeftTopSlow" | "shuffleLeftTopFast" | "shuffleTopLeft" | "shuffleTopLeftSlow" | "shuffleTopLeftFast" | "zoom";
         };
         /** @description Offsets the position of an asset horizontally or vertically by a relative distance. */
         Offset: {
@@ -1210,7 +1313,7 @@ export interface components {
             /** @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. */
             angle?: number | components["schemas"]["Tween"][];
         };
-        /** @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. */
         SkewTransformation: {
             /** @description Skew the clip along it's x axis. */
             x?: number | components["schemas"]["Tween"][];
@@ -1270,6 +1373,21 @@ export interface components {
              * @example #000000
              */
             color?: string;
+            /**
+             * @description The opacity of the background where 1 is opaque and 0 is transparent.
+             * @example 0.8
+             */
+            opacity?: number;
+            /**
+             * @description Padding inside the background box in pixels.
+             * @example 10
+             */
+            padding?: number;
+            /**
+             * @description The border radius of the background box in pixels for rounded corners.
+             * @example 5
+             */
+            borderRadius?: number;
         };
         /** @description Horizontal and vertical alignment properties for text. */
         TextAlignment: {
@@ -1297,7 +1415,7 @@ export interface components {
         /** @description Font properties for rich text. */
         RichTextFont: {
             /**
-             * @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".
              * @default Open Sans
              * @example Open Sans
              */
@@ -1754,7 +1872,7 @@ export interface components {
              *     </ul>
              * @enum {string}
              */
-            scaleTo?: "preview" | "mobile" | "sd" | "hd" | "1080";
+            scaleTo?: "preview" | "mobile" | "sd" | "hd" | "1080" | "4k";
             /**
              * @description Adjust the output quality of the video, image or audio. Adjusting quality affects  render speed, download speeds and storage requirements due to file size. The default `medium` provides the most optimized choice for all three  factors. <ul>
              *       <li>`verylow` - reduced quality, smallest file size</li>
@@ -1839,7 +1957,44 @@ export interface components {
          *
          *     By default all ingested and generated assets are automatically sent to the [Shotstack hosting destination](https://shotstack.io/docs/guide/serving-assets/hosting/). You can [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from by setting the Shotstack destination **exclude** property to **true**.
          */
-        Destinations: components["schemas"]["ShotstackDestination"] | components["schemas"]["MuxDestination"] | components["schemas"]["S3Destination"] | components["schemas"]["GoogleCloudStorageDestination"] | components["schemas"]["GoogleDriveDestination"] | components["schemas"]["VimeoDestination"];
+        Destinations: components["schemas"]["ShotstackDestination"] | components["schemas"]["MuxDestination"] | components["schemas"]["S3Destination"] | components["schemas"]["GoogleCloudStorageDestination"] | components["schemas"]["GoogleDriveDestination"] | components["schemas"]["VimeoDestination"] | {
+            /**
+             * @description The destination to send video to - set to `tiktok` for TikTok.
+             * @default tiktok
+             * @example tiktok
+             */
+            provider: string;
+            /** @description Additional TikTok configuration options. */
+            options?: {
+                /** @description A title for the video that will be displayed on TikTok. */
+                title?: string;
+                /**
+                 * @description The privacy level for the video. Options are: <ul>
+                 *       <li>`public` - video is visible to everyone</li>
+                 *       <li>`friends` - video is visible to friends only</li>
+                 *       <li>`private` - video is only visible to you</li>
+                 *     </ul>
+                 * @default private
+                 * @enum {string}
+                 */
+                privacyLevel: "public" | "friends" | "private";
+                /**
+                 * @description Disable the Duet feature for this video.
+                 * @default false
+                 */
+                disableDuet: boolean;
+                /**
+                 * @description Disable the Stitch feature for this video.
+                 * @default false
+                 */
+                disableStitch: boolean;
+                /**
+                 * @description Disable comments on this video.
+                 * @default false
+                 */
+                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. */
         ShotstackDestination: {
             /**
@@ -1983,6 +2138,11 @@ export interface components {
             description?: string;
             /** @description Options to control the visibility of videos and privacy features. */
             privacy?: components["schemas"]["VimeoDestinationPrivacyOptions"];
+            /**
+             * @description The Vimeo folder URI to upload the video to. The folder must already exist in your Vimeo account.
+             * @example /users/12345678/projects/87654321
+             */
+            folderUri?: string;
         };
         /** @description Options to control the visibility of videos and privacy features. */
         VimeoDestinationPrivacyOptions: {