@shotstack/schemas 1.3.1 → 1.3.3

package/dist/api.bundled.json

@@ -1127,8 +1127,9 @@
             "type": "string"
           },
           "filter": {
-            "description": "A filter effect to apply to the Clip. <ul>\n  <li>`blur` - blur the scene</li>\n  <li>`boost` - boost contrast and saturation</li>\n  <li>`contrast` - increase contrast</li>\n  <li>`darken` - darken the scene</li>\n  <li>`greyscale` - remove colour</li>\n  <li>`lighten` - lighten the scene</li>\n  <li>`muted` - reduce saturation and contrast</li>\n  <li>`negative` - negative colors</li>\n</ul>",
+            "description": "A filter effect to apply to the Clip. <ul>\n  <li>`none` - no filter applied</li>\n  <li>`blur` - blur the scene</li>\n  <li>`boost` - boost contrast and saturation</li>\n  <li>`contrast` - increase contrast</li>\n  <li>`darken` - darken the scene</li>\n  <li>`greyscale` - remove colour</li>\n  <li>`lighten` - lighten the scene</li>\n  <li>`muted` - reduce saturation and contrast</li>\n  <li>`negative` - negative colors</li>\n</ul>",
             "enum": [
+              "none",
               "blur",
               "boost",
               "contrast",
@@ -1180,7 +1181,21 @@
         "type": "object",
         "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.",
         "discriminator": {
-          "propertyName": "asset"
+          "propertyName": "type",
+          "mapping": {
+            "video": "#/components/schemas/VideoAsset",
+            "image": "#/components/schemas/ImageAsset",
+            "text": "#/components/schemas/TextAsset",
+            "rich-text": "#/components/schemas/RichTextAsset",
+            "audio": "#/components/schemas/AudioAsset",
+            "luma": "#/components/schemas/LumaAsset",
+            "caption": "#/components/schemas/CaptionAsset",
+            "html": "#/components/schemas/HtmlAsset",
+            "title": "#/components/schemas/TitleAsset",
+            "shape": "#/components/schemas/ShapeAsset",
+            "text-to-image": "#/components/schemas/TextToImageAsset",
+            "image-to-video": "#/components/schemas/ImageToVideoAsset"
+          }
         },
         "oneOf": [
           {
@@ -1227,6 +1242,9 @@
         "type": "object",
         "properties": {
           "type": {
+            "enum": [
+              "video"
+            ],
             "default": "video",
             "description": "The type of asset - set to `video` for videos.",
             "type": "string"
@@ -1302,6 +1320,9 @@
         "type": "object",
         "properties": {
           "type": {
+            "enum": [
+              "image"
+            ],
             "default": "image",
             "description": "The type of asset - set to `image` for images.",
             "type": "string"
@@ -1325,6 +1346,9 @@
         "type": "object",
         "properties": {
           "type": {
+            "enum": [
+              "text"
+            ],
             "default": "text",
             "description": "The type of asset - set to `text` for text.",
             "type": "string"
@@ -1415,6 +1439,9 @@
         "type": "object",
         "properties": {
           "type": {
+            "enum": [
+              "rich-text"
+            ],
             "default": "rich-text",
             "description": "The type of asset - set to `rich-text` for rich text.",
             "type": "string"
@@ -1433,10 +1460,6 @@
             "description": "Text style properties including spacing, line height, and transformations.",
             "$ref": "#/components/schemas/RichTextStyle"
           },
-          "stroke": {
-            "description": "Text stroke (outline) properties.",
-            "$ref": "#/components/schemas/RichTextStroke"
-          },
           "shadow": {
             "description": "Text shadow properties.",
             "$ref": "#/components/schemas/RichTextShadow"
@@ -1544,6 +1567,9 @@
         "type": "object",
         "properties": {
           "type": {
+            "enum": [
+              "audio"
+            ],
             "default": "audio",
             "description": "The type of asset - set to `audio` for audio assets.",
             "type": "string"
@@ -1606,6 +1632,9 @@
         "type": "object",
         "properties": {
           "type": {
+            "enum": [
+              "shape"
+            ],
             "default": "shape",
             "description": "The type of asset - set to `shape` for shape.",
             "type": "string"
@@ -1731,6 +1760,9 @@
         "type": "object",
         "properties": {
           "type": {
+            "enum": [
+              "luma"
+            ],
             "default": "luma",
             "description": "The type of asset - set to `luma` for luma mattes.",
             "type": "string"
@@ -1755,6 +1787,9 @@
         "type": "object",
         "properties": {
           "type": {
+            "enum": [
+              "caption"
+            ],
             "default": "caption",
             "description": "The type of asset - set to `caption` for captions.",
             "type": "string"
@@ -1827,9 +1862,7 @@
         },
         "required": [
           "type",
-          "prompt",
-          "width",
-          "height"
+          "prompt"
         ]
       },
       "ImageToVideoAsset": {
@@ -1886,6 +1919,9 @@
         "type": "object",
         "properties": {
           "type": {
+            "enum": [
+              "html"
+            ],
             "default": "html",
             "description": "The type of asset - set to `html` for HTML.",
             "type": "string"
@@ -1941,6 +1977,9 @@
         "type": "object",
         "properties": {
           "type": {
+            "enum": [
+              "title"
+            ],
             "default": "title",
             "description": "The type of asset - set to `title` for titles.",
             "type": "string"
@@ -2480,6 +2519,10 @@
             "maximum": 1,
             "default": 1,
             "example": 0.9
+          },
+          "stroke": {
+            "description": "Text stroke (outline) properties.",
+            "$ref": "#/components/schemas/RichTextStroke"
           }
         },
         "type": "object"

package/dist/schema.d.ts

@@ -559,6 +559,7 @@ export interface components {
             effect?: "zoomIn" | "zoomInSlow" | "zoomInFast" | "zoomOut" | "zoomOutSlow" | "zoomOutFast" | "slideLeft" | "slideLeftSlow" | "slideLeftFast" | "slideRight" | "slideRightSlow" | "slideRightFast" | "slideUp" | "slideUpSlow" | "slideUpFast" | "slideDown" | "slideDownSlow" | "slideDownFast";
             /**
              * @description A filter effect to apply to the Clip. <ul>
+             *       <li>`none` - no filter applied</li>
              *       <li>`blur` - blur the scene</li>
              *       <li>`boost` - boost contrast and saturation</li>
              *       <li>`contrast` - increase contrast</li>
@@ -571,7 +572,7 @@ export interface components {
              * @example greyscale
              * @enum {string}
              */
-            filter?: "blur" | "boost" | "contrast" | "darken" | "greyscale" | "lighten" | "muted" | "negative";
+            filter?: "none" | "blur" | "boost" | "contrast" | "darken" | "greyscale" | "lighten" | "muted" | "negative";
             /** @description Offset an asset on the horizontal axis (left or right). Use a number or an array of [Tween](./#tocs_tween) objects to create a custom animation. */
             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. */
@@ -587,10 +588,10 @@ export interface components {
         /** @description The VideoAsset is used to create video sequences from video files. The src must be a publicly accessible URL to a video resource such as an mp4 file. */
         VideoAsset: {
             /**
-             * @description The type of asset - set to `video` for videos.
-             * @default video
+             * @description The type of asset - set to `video` for videos. (enum property replaced by openapi-typescript)
+             * @enum {string}
              */
-            type: string;
+            type: "video";
             /**
              * @description The video source URL. The URL must be publicly accessible or include credentials.
              * @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/video.mp4
@@ -626,30 +627,20 @@ export interface components {
             speed?: number;
             crop?: components["schemas"]["Crop"];
             chromaKey?: components["schemas"]["ChromaKey"];
-            /**
-             * @description discriminator enum property added by openapi-typescript
-             * @enum {string}
-             */
-            asset: "VideoAsset";
         };
         /** @description The ImageAsset is used to create video from images to compose an image. The src must be a publicly accessible URL to an image resource such as a jpg or png file. */
         ImageAsset: {
             /**
-             * @description The type of asset - set to `image` for images.
-             * @default image
+             * @description The type of asset - set to `image` for images. (enum property replaced by openapi-typescript)
+             * @enum {string}
              */
-            type: string;
+            type: "image";
             /**
              * @description The image source URL. The URL must be publicly accessible or include credentials.
              * @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/image.jpg
              */
             src: string;
             crop?: components["schemas"]["Crop"];
-            /**
-             * @description discriminator enum property added by openapi-typescript
-             * @enum {string}
-             */
-            asset: "ImageAsset";
         };
         /**
          * @description The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
@@ -657,10 +648,10 @@ export interface components {
          */
         TextAsset: {
             /**
-             * @description The type of asset - set to `text` for text.
-             * @default text
+             * @description The type of asset - set to `text` for text. (enum property replaced by openapi-typescript)
+             * @enum {string}
              */
-            type: string;
+            type: "text";
             /**
              * @description The text string to display.
              * @example Hello World
@@ -716,11 +707,6 @@ export interface components {
              * @example ...
              */
             ellipsis?: string;
-            /**
-             * @description discriminator enum property added by openapi-typescript
-             * @enum {string}
-             */
-            asset: "TextAsset";
         };
         /**
          * @description The RichTextAsset provides advanced text rendering with support for custom fonts, gradients, shadows, strokes,
@@ -728,10 +714,10 @@ export interface components {
          */
         RichTextAsset: {
             /**
-             * @description The type of asset - set to `rich-text` for rich text.
-             * @default rich-text
+             * @description The type of asset - set to `rich-text` for rich text. (enum property replaced by openapi-typescript)
+             * @enum {string}
              */
-            type: string;
+            type: "rich-text";
             /**
              * @description The text string to display. Maximum 5000 characters.
              * @example Hello World
@@ -741,8 +727,6 @@ export interface components {
             font?: components["schemas"]["RichTextFont"];
             /** @description Text style properties including spacing, line height, and transformations. */
             style?: components["schemas"]["RichTextStyle"];
-            /** @description Text stroke (outline) properties. */
-            stroke?: components["schemas"]["RichTextStroke"];
             /** @description Text shadow properties. */
             shadow?: components["schemas"]["RichTextShadow"];
             /** @description Background styling properties for the text bounding box. */
@@ -805,19 +789,14 @@ export interface components {
             align?: components["schemas"]["RichTextAlignment"];
             /** @description Animation properties for text entrance effects. */
             animation?: components["schemas"]["RichTextAnimation"];
-            /**
-             * @description discriminator enum property added by openapi-typescript
-             * @enum {string}
-             */
-            asset: "RichTextAsset";
         };
         /** @description The AudioAsset is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such  as an mp3 file. */
         AudioAsset: {
             /**
-             * @description The type of asset - set to `audio` for audio assets.
-             * @default audio
+             * @description The type of asset - set to `audio` for audio assets. (enum property replaced by openapi-typescript)
+             * @enum {string}
              */
-            type: string;
+            type: "audio";
             /**
              * @description The audio source URL. The URL must be publicly accessible or include credentials.
              * @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/sound.mp3
@@ -842,11 +821,6 @@ export interface components {
              * @enum {string}
              */
             effect?: "none" | "fadeIn" | "fadeOut" | "fadeInFadeOut";
-            /**
-             * @description discriminator enum property added by openapi-typescript
-             * @enum {string}
-             */
-            asset: "AudioAsset";
         };
         /**
          * @description The ShapeAsset is used to add shapes to a video. The shape can be styled with a fill and a stroke.
@@ -854,10 +828,10 @@ export interface components {
          */
         ShapeAsset: {
             /**
-             * @description The type of asset - set to `shape` for shape.
-             * @default shape
+             * @description The type of asset - set to `shape` for shape. (enum property replaced by openapi-typescript)
+             * @enum {string}
              */
-            type: string;
+            type: "shape";
             /**
              * @description The shape to display.
              * @enum {string}
@@ -938,19 +912,14 @@ export interface components {
                  */
                 thickness: number;
             };
-            /**
-             * @description discriminator enum property added by openapi-typescript
-             * @enum {string}
-             */
-            asset: "ShapeAsset";
         };
         /** @description The LumaAsset is used to create luma matte masks, transitions and effects between other assets. A luma matte is a grey scale image or animated video where the black areas are transparent and the white areas solid. The luma matte animation should be provided as an mp4 video file. The src must be a publicly accessible URL to the file. */
         LumaAsset: {
             /**
-             * @description The type of asset - set to `luma` for luma mattes.
-             * @default luma
+             * @description The type of asset - set to `luma` for luma mattes. (enum property replaced by openapi-typescript)
+             * @enum {string}
              */
-            type: string;
+            type: "luma";
             /**
              * @description The luma matte source URL. The URL must be publicly accessible or include credentials.
              * @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/mask.mp4
@@ -958,11 +927,6 @@ export interface components {
             src: string;
             /** @description The start trim point of the luma matte clip, in seconds (defaults to 0). Videos will start from the in trim point. A luma matte video will play until the file ends or the Clip length is reached. */
             trim?: number;
-            /**
-             * @description discriminator enum property added by openapi-typescript
-             * @enum {string}
-             */
-            asset: "LumaAsset";
         };
         /**
          * @description The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will
@@ -977,10 +941,10 @@ export interface components {
          */
         CaptionAsset: {
             /**
-             * @description The type of asset - set to `caption` for captions.
-             * @default caption
+             * @description The type of asset - set to `caption` for captions. (enum property replaced by openapi-typescript)
+             * @enum {string}
              */
-            type: string;
+            type: "caption";
             /**
              * @description The URL to an SRT or VTT subtitles file. The URL must be publicly accessible or include credentials.
              * @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/captions.srt
@@ -1003,11 +967,6 @@ export interface components {
              * @example 1
              */
             speed?: number;
-            /**
-             * @description discriminator enum property added by openapi-typescript
-             * @enum {string}
-             */
-            asset: "CaptionAsset";
         };
         /** @description The TextToImageAsset lets you create a dynamic image from a text prompt. */
         TextToImageAsset: {
@@ -1026,12 +985,12 @@ export interface components {
              * @description The width of the image in pixels.
              * @example 512
              */
-            width: number;
+            width?: number;
             /**
              * @description The height of the image in pixels.
              * @example 512
              */
-            height: number;
+            height?: number;
             crop?: components["schemas"]["Crop"];
         };
         /** @description The ImageToVideoAsset lets you create a video from an image and a text prompt. */
@@ -1076,10 +1035,10 @@ export interface components {
          */
         HtmlAsset: {
             /**
-             * @description The type of asset - set to `html` for HTML.
-             * @default html
+             * @description The type of asset - set to `html` for HTML. (enum property replaced by openapi-typescript)
+             * @enum {string}
              */
-            type: string;
+            type: "html";
             /**
              * @description The HTML text string. See list of [supported HTML tags](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-html-tags).
              * @example <p>Hello <b>World</b></p>
@@ -1117,11 +1076,6 @@ export interface components {
              * @enum {string}
              */
             position?: "top" | "topRight" | "right" | "bottomRight" | "bottom" | "bottomLeft" | "left" | "topLeft" | "center";
-            /**
-             * @description discriminator enum property added by openapi-typescript
-             * @enum {string}
-             */
-            asset: "HtmlAsset";
         };
         /**
          * @deprecated
@@ -1131,10 +1085,10 @@ export interface components {
          */
         TitleAsset: {
             /**
-             * @description The type of asset - set to `title` for titles.
-             * @default title
+             * @description The type of asset - set to `title` for titles. (enum property replaced by openapi-typescript)
+             * @enum {string}
              */
-            type: string;
+            type: "title";
             /**
              * @description The title text string - i.e. "My Title".
              * @example Hello World
@@ -1193,11 +1147,6 @@ export interface components {
             position?: "top" | "topRight" | "right" | "bottomRight" | "bottom" | "bottomLeft" | "left" | "topLeft" | "center";
             /** @description Offset the location of the title relative to its position on the screen. */
             offset?: components["schemas"]["Offset"];
-            /**
-             * @description discriminator enum property added by openapi-typescript
-             * @enum {string}
-             */
-            asset: "TitleAsset";
         };
         /** @description In and out transitions for a clip - i.e. fade in and fade out */
         Transition: {
@@ -1440,6 +1389,8 @@ export interface components {
              * @example 0.9
              */
             opacity: number;
+            /** @description Text stroke (outline) properties. */
+            stroke?: components["schemas"]["RichTextStroke"];
         };
         /** @description Text style properties including spacing, line height, and transformations. */
         RichTextStyle: {