@shotstack/schemas 1.18.2 → 1.18.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/schema.d.ts CHANGED
@@ -289,7 +289,7 @@ export interface paths {
289
289
  path: {
290
290
  /**
291
291
  * @description The model identifier, as returned by the list endpoint.
292
- * @example seedance-2.0
292
+ * @example seedance-2.0-text-to-video
293
293
  */
294
294
  id: string;
295
295
  };
@@ -709,8 +709,8 @@ export interface components {
709
709
  */
710
710
  prompt?: string;
711
711
  /**
712
- * @description The generation model to use when `prompt` is set (e.g. `shotstack-itv-mini`, `ray-flash-2`, `seedance-2.0`). Defaults to `seedance-2.0` if omitted. Each model's available options are defined by the model registry.
713
- * @example seedance-2.0
712
+ * @description The generation model to use when `prompt` is set (e.g. `seedance-2.0-text-to-video`). Defaults to `seedance-2.0-text-to-video` if omitted. `GET /models` lists what is available and the options each accepts.
713
+ * @example seedance-2.0-text-to-video
714
714
  */
715
715
  model?: string;
716
716
  /**
@@ -1395,7 +1395,7 @@ export interface components {
1395
1395
  * @deprecated
1396
1396
  * @description **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
1397
1397
  * with `prompt`, a `model` that accepts a starting image, and that image in
1398
- * `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
1398
+ * `options.inputSrc` — for example `seedance-2.0-image-to-video`.** This type continues to
1399
1399
  * function and is internally rewritten to VideoAsset; no behaviour change for
1400
1400
  * existing integrations.
1401
1401
  *
@@ -4019,7 +4019,7 @@ export interface operations {
4019
4019
  path: {
4020
4020
  /**
4021
4021
  * @description The model identifier, as returned by the list endpoint.
4022
- * @example seedance-2.0
4022
+ * @example seedance-2.0-text-to-video
4023
4023
  */
4024
4024
  id: string;
4025
4025
  };
@@ -4036,7 +4036,7 @@ export interface operations {
4036
4036
  "application/json": {
4037
4037
  /**
4038
4038
  * @description The identifier to set as the asset `model`. Carries no provider name, so routing can change without a public rename.
4039
- * @example seedance-2.0
4039
+ * @example seedance-2.0-text-to-video
4040
4040
  */
4041
4041
  model: string;
4042
4042
  /**
@@ -4045,6 +4045,16 @@ export interface operations {
4045
4045
  * @enum {string}
4046
4046
  */
4047
4047
  type: "image" | "video" | "audio";
4048
+ /**
4049
+ * @description The model's display name, for a model picker.
4050
+ * @example Seedance 2.0 · Text to video
4051
+ */
4052
+ name?: string;
4053
+ /**
4054
+ * @description What the model is suited to, in a sentence or two.
4055
+ * @example Generate cinematic video with realistic motion, prompt-directed camera movement and optional synchronised audio.
4056
+ */
4057
+ description?: string;
4048
4058
  /** @description What one generation with this model costs. */
4049
4059
  pricing?: {
4050
4060
  /**
@@ -490,6 +490,8 @@ exports.generationmodelGenerationModelSchema = zod_1.z.object({
490
490
  'video',
491
491
  'audio'
492
492
  ]),
493
+ name: zod_1.z.optional(zod_1.z.string()),
494
+ description: zod_1.z.optional(zod_1.z.string()),
493
495
  pricing: zod_1.z.optional(exports.generationmodelpricingGenerationModelPricingSchema),
494
496
  options: zod_1.z.optional(zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()))
495
497
  }).strict();
@@ -582,7 +584,7 @@ exports.imageAssetSchema = exports.imageassetImageAssetSchema;
582
584
  /**
583
585
  * **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
584
586
  * with `prompt`, a `model` that accepts a starting image, and that image in
585
- * `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
587
+ * `options.inputSrc` — for example `seedance-2.0-image-to-video`.** This type continues to
586
588
  * function and is internally rewritten to VideoAsset; no behaviour change for
587
589
  * existing integrations.
588
590
  *
@@ -794,6 +794,8 @@ export declare const generationmodelGenerationModelSchema: z.ZodObject<{
794
794
  video: "video";
795
795
  audio: "audio";
796
796
  }>;
797
+ name: z.ZodOptional<z.ZodString>;
798
+ description: z.ZodOptional<z.ZodString>;
797
799
  pricing: z.ZodOptional<z.ZodObject<{
798
800
  credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
799
801
  tieredBy: z.ZodOptional<z.ZodObject<{
@@ -936,7 +938,7 @@ export declare const imageAssetSchema: z.ZodObject<{
936
938
  /**
937
939
  * **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
938
940
  * with `prompt`, a `model` that accepts a starting image, and that image in
939
- * `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
941
+ * `options.inputSrc` — for example `seedance-2.0-image-to-video`.** This type continues to
940
942
  * function and is internally rewritten to VideoAsset; no behaviour change for
941
943
  * existing integrations.
942
944
  *
@@ -1514,6 +1516,8 @@ export declare const generationmodellistresponseGenerationModelListResponseSchem
1514
1516
  video: "video";
1515
1517
  audio: "audio";
1516
1518
  }>;
1519
+ name: z.ZodOptional<z.ZodString>;
1520
+ description: z.ZodOptional<z.ZodString>;
1517
1521
  pricing: z.ZodOptional<z.ZodObject<{
1518
1522
  credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
1519
1523
  tieredBy: z.ZodOptional<z.ZodObject<{
@@ -60526,6 +60530,8 @@ export declare const getModelsResponse: z.ZodObject<{
60526
60530
  video: "video";
60527
60531
  audio: "audio";
60528
60532
  }>;
60533
+ name: z.ZodOptional<z.ZodString>;
60534
+ description: z.ZodOptional<z.ZodString>;
60529
60535
  pricing: z.ZodOptional<z.ZodObject<{
60530
60536
  credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
60531
60537
  tieredBy: z.ZodOptional<z.ZodObject<{
@@ -60567,6 +60573,8 @@ export declare const getModelResponse: z.ZodObject<{
60567
60573
  video: "video";
60568
60574
  audio: "audio";
60569
60575
  }>;
60576
+ name: z.ZodOptional<z.ZodString>;
60577
+ description: z.ZodOptional<z.ZodString>;
60570
60578
  pricing: z.ZodOptional<z.ZodObject<{
60571
60579
  credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
60572
60580
  tieredBy: z.ZodOptional<z.ZodObject<{
@@ -481,6 +481,8 @@ export const generationmodelGenerationModelSchema = z.object({
481
481
  'video',
482
482
  'audio'
483
483
  ]),
484
+ name: z.optional(z.string()),
485
+ description: z.optional(z.string()),
484
486
  pricing: z.optional(generationmodelpricingGenerationModelPricingSchema),
485
487
  options: z.optional(z.record(z.string(), z.unknown()))
486
488
  }).strict();
@@ -573,7 +575,7 @@ export const imageAssetSchema = imageassetImageAssetSchema;
573
575
  /**
574
576
  * **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
575
577
  * with `prompt`, a `model` that accepts a starting image, and that image in
576
- * `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
578
+ * `options.inputSrc` — for example `seedance-2.0-image-to-video`.** This type continues to
577
579
  * function and is internally rewritten to VideoAsset; no behaviour change for
578
580
  * existing integrations.
579
581
  *
@@ -412,6 +412,8 @@ export const generationmodelGenerationModelSchema = z.object({
412
412
  'video',
413
413
  'audio'
414
414
  ]),
415
+ name: z.optional(z.string()),
416
+ description: z.optional(z.string()),
415
417
  pricing: z.optional(generationmodelpricingGenerationModelPricingSchema),
416
418
  options: z.optional(z.record(z.string(), z.unknown()))
417
419
  }).strict();
@@ -499,7 +501,7 @@ export const imageAssetSchema = imageassetImageAssetSchema;
499
501
  /**
500
502
  * **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
501
503
  * with `prompt`, a `model` that accepts a starting image, and that image in
502
- * `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
504
+ * `options.inputSrc` — for example `seedance-2.0-image-to-video`.** This type continues to
503
505
  * function and is internally rewritten to VideoAsset; no behaviour change for
504
506
  * existing integrations.
505
507
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shotstack/schemas",
3
- "version": "1.18.2",
3
+ "version": "1.18.4",
4
4
  "description": "Centralized OpenAPI schemas and TypeScript types for Shotstack API",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",