@shotstack/schemas 1.18.4 → 1.19.0

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.
@@ -641,7 +641,7 @@
641
641
  },
642
642
  "/models": {
643
643
  "get": {
644
- "description": "List the generation models available for `prompt`-bearing image, video and audio\nassets, with the options each accepts and what it costs in credits.\n\nUse this to populate a model picker and render its option fields, rather than\nhard coding a model list. A newly launched model appears here without any change\non your side. Each entry carries the asset type it generates, so filter the list\nclient side when a picker only needs one kind.\n\nOption schemas are omitted by default. Request them with `expand=options`.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
644
+ "description": "List the generation models available for `prompt`-bearing image, video and audio\nassets, with the options each accepts and what it costs in credits.\n\nUse this to populate a model picker and render its option fields, rather than\nhard coding a model list. A newly launched model appears here without any change\non your side. Each entry carries the asset type it generates, so filter the list\nclient side when a picker only needs one kind.\n\nOption schemas are omitted by default. Request them with `expand=options`.\n\nEach model's `available` reflects the plan of the account behind the calling API\nkey, so offer only the models it marks available.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
645
645
  "summary": "List Generation Models",
646
646
  "operationId": "getModels",
647
647
  "responses": {
@@ -833,6 +833,21 @@
833
833
  "description": "JSON Schema for the model's `options` object. Only returned for a single model, or for a list requested with `expand=options`. Values outside this schema are rejected.",
834
834
  "type": "object",
835
835
  "additionalProperties": true
836
+ },
837
+ "available": {
838
+ "description": "Whether the account behind the calling API key can generate with this model. Omitted when that cannot be determined; treat a missing value as unknown, not as available. Generation requests are checked either way.",
839
+ "type": "boolean",
840
+ "example": false
841
+ },
842
+ "unavailableReason": {
843
+ "description": "Why `available` is false. `AiCapabilityNotIncluded`: the account's plan does not include this kind of generation. `AiDisabled`: AI generation is turned off for the account. `AiAccessUnavailable`: access could not be confirmed; try again later.",
844
+ "type": "string",
845
+ "enum": [
846
+ "AiCapabilityNotIncluded",
847
+ "AiDisabled",
848
+ "AiAccessUnavailable"
849
+ ],
850
+ "example": "AiCapabilityNotIncluded"
836
851
  }
837
852
  },
838
853
  "required": [
package/dist/schema.d.ts CHANGED
@@ -271,6 +271,9 @@ export interface paths {
271
271
  *
272
272
  * Option schemas are omitted by default. Request them with `expand=options`.
273
273
  *
274
+ * Each model's `available` reflects the plan of the account behind the calling API
275
+ * key, so offer only the models it marks available.
276
+ *
274
277
  * **Base URL:** <a href="#">https://api.shotstack.io/edit/{version}</a>
275
278
  */
276
279
  get: operations["getModels"];
@@ -4120,6 +4123,17 @@ export interface operations {
4120
4123
  options?: {
4121
4124
  [key: string]: unknown;
4122
4125
  };
4126
+ /**
4127
+ * @description Whether the account behind the calling API key can generate with this model. Omitted when that cannot be determined; treat a missing value as unknown, not as available. Generation requests are checked either way.
4128
+ * @example false
4129
+ */
4130
+ available?: boolean;
4131
+ /**
4132
+ * @description Why `available` is false. `AiCapabilityNotIncluded`: the account's plan does not include this kind of generation. `AiDisabled`: AI generation is turned off for the account. `AiAccessUnavailable`: access could not be confirmed; try again later.
4133
+ * @example AiCapabilityNotIncluded
4134
+ * @enum {string}
4135
+ */
4136
+ unavailableReason?: "AiCapabilityNotIncluded" | "AiDisabled" | "AiAccessUnavailable";
4123
4137
  };
4124
4138
  };
4125
4139
  };
@@ -493,7 +493,13 @@ exports.generationmodelGenerationModelSchema = zod_1.z.object({
493
493
  name: zod_1.z.optional(zod_1.z.string()),
494
494
  description: zod_1.z.optional(zod_1.z.string()),
495
495
  pricing: zod_1.z.optional(exports.generationmodelpricingGenerationModelPricingSchema),
496
- options: zod_1.z.optional(zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()))
496
+ options: zod_1.z.optional(zod_1.z.record(zod_1.z.string(), zod_1.z.unknown())),
497
+ available: zod_1.z.optional(zod_1.z.boolean()),
498
+ unavailableReason: zod_1.z.optional(zod_1.z.enum([
499
+ 'AiCapabilityNotIncluded',
500
+ 'AiDisabled',
501
+ 'AiAccessUnavailable'
502
+ ]))
497
503
  }).strict();
498
504
  /**
499
505
  * The Html5Asset renders full HTML5/CSS3/JS.
@@ -818,6 +818,12 @@ export declare const generationmodelGenerationModelSchema: z.ZodObject<{
818
818
  effectiveFrom: z.ZodString;
819
819
  }, z.core.$strict>>;
820
820
  options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
821
+ available: z.ZodOptional<z.ZodBoolean>;
822
+ unavailableReason: z.ZodOptional<z.ZodEnum<{
823
+ AiCapabilityNotIncluded: "AiCapabilityNotIncluded";
824
+ AiDisabled: "AiDisabled";
825
+ AiAccessUnavailable: "AiAccessUnavailable";
826
+ }>>;
821
827
  }, z.core.$strict>;
822
828
  /**
823
829
  * The Html5Asset renders full HTML5/CSS3/JS.
@@ -1540,6 +1546,12 @@ export declare const generationmodellistresponseGenerationModelListResponseSchem
1540
1546
  effectiveFrom: z.ZodString;
1541
1547
  }, z.core.$strict>>;
1542
1548
  options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1549
+ available: z.ZodOptional<z.ZodBoolean>;
1550
+ unavailableReason: z.ZodOptional<z.ZodEnum<{
1551
+ AiCapabilityNotIncluded: "AiCapabilityNotIncluded";
1552
+ AiDisabled: "AiDisabled";
1553
+ AiAccessUnavailable: "AiAccessUnavailable";
1554
+ }>>;
1543
1555
  }, z.core.$strict>>;
1544
1556
  }, z.core.$strict>;
1545
1557
  /**
@@ -60554,6 +60566,12 @@ export declare const getModelsResponse: z.ZodObject<{
60554
60566
  effectiveFrom: z.ZodString;
60555
60567
  }, z.core.$strict>>;
60556
60568
  options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
60569
+ available: z.ZodOptional<z.ZodBoolean>;
60570
+ unavailableReason: z.ZodOptional<z.ZodEnum<{
60571
+ AiCapabilityNotIncluded: "AiCapabilityNotIncluded";
60572
+ AiDisabled: "AiDisabled";
60573
+ AiAccessUnavailable: "AiAccessUnavailable";
60574
+ }>>;
60557
60575
  }, z.core.$strict>>;
60558
60576
  }, z.core.$strict>;
60559
60577
  export declare const getModelRequest: z.ZodObject<{
@@ -60597,6 +60615,12 @@ export declare const getModelResponse: z.ZodObject<{
60597
60615
  effectiveFrom: z.ZodString;
60598
60616
  }, z.core.$strict>>;
60599
60617
  options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
60618
+ available: z.ZodOptional<z.ZodBoolean>;
60619
+ unavailableReason: z.ZodOptional<z.ZodEnum<{
60620
+ AiCapabilityNotIncluded: "AiCapabilityNotIncluded";
60621
+ AiDisabled: "AiDisabled";
60622
+ AiAccessUnavailable: "AiAccessUnavailable";
60623
+ }>>;
60600
60624
  }, z.core.$strict>;
60601
60625
  export declare const deleteAssetRequest: z.ZodObject<{
60602
60626
  body: z.ZodOptional<z.ZodNever>;
@@ -484,7 +484,13 @@ export const generationmodelGenerationModelSchema = z.object({
484
484
  name: z.optional(z.string()),
485
485
  description: z.optional(z.string()),
486
486
  pricing: z.optional(generationmodelpricingGenerationModelPricingSchema),
487
- options: z.optional(z.record(z.string(), z.unknown()))
487
+ options: z.optional(z.record(z.string(), z.unknown())),
488
+ available: z.optional(z.boolean()),
489
+ unavailableReason: z.optional(z.enum([
490
+ 'AiCapabilityNotIncluded',
491
+ 'AiDisabled',
492
+ 'AiAccessUnavailable'
493
+ ]))
488
494
  }).strict();
489
495
  /**
490
496
  * The Html5Asset renders full HTML5/CSS3/JS.
@@ -415,7 +415,13 @@ export const generationmodelGenerationModelSchema = z.object({
415
415
  name: z.optional(z.string()),
416
416
  description: z.optional(z.string()),
417
417
  pricing: z.optional(generationmodelpricingGenerationModelPricingSchema),
418
- options: z.optional(z.record(z.string(), z.unknown()))
418
+ options: z.optional(z.record(z.string(), z.unknown())),
419
+ available: z.optional(z.boolean()),
420
+ unavailableReason: z.optional(z.enum([
421
+ 'AiCapabilityNotIncluded',
422
+ 'AiDisabled',
423
+ 'AiAccessUnavailable'
424
+ ]))
419
425
  }).strict();
420
426
 
421
427
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shotstack/schemas",
3
- "version": "1.18.4",
3
+ "version": "1.19.0",
4
4
  "description": "Centralized OpenAPI schemas and TypeScript types for Shotstack API",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",