@shotstack/schemas 1.17.0 → 1.18.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.
@@ -639,6 +639,189 @@
639
639
  }
640
640
  ]
641
641
  },
642
+ "/models": {
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",
645
+ "summary": "List Generation Models",
646
+ "operationId": "getModels",
647
+ "responses": {
648
+ "200": {
649
+ "description": "The available generation models.",
650
+ "content": {
651
+ "application/json": {
652
+ "schema": {
653
+ "description": "The generation models available to this account.",
654
+ "properties": {
655
+ "models": {
656
+ "description": "The available models.",
657
+ "type": "array",
658
+ "items": {
659
+ "$ref": "#/paths/~1models~1%7Bid%7D/get/responses/200/content/application~1json/schema"
660
+ }
661
+ }
662
+ },
663
+ "required": [
664
+ "models"
665
+ ],
666
+ "type": "object"
667
+ }
668
+ }
669
+ }
670
+ }
671
+ },
672
+ "security": [
673
+ {
674
+ "DeveloperKey": []
675
+ }
676
+ ],
677
+ "tags": [
678
+ "Edit"
679
+ ]
680
+ },
681
+ "parameters": [
682
+ {
683
+ "in": "query",
684
+ "name": "expand",
685
+ "required": false,
686
+ "description": "Set to `options` to include each model's option schema in the list. Omitted by default to keep the response small.",
687
+ "schema": {
688
+ "type": "string",
689
+ "enum": [
690
+ "options"
691
+ ]
692
+ },
693
+ "example": "options"
694
+ }
695
+ ]
696
+ },
697
+ "/models/{id}": {
698
+ "get": {
699
+ "description": "Get one generation model, including the JSON Schema for the options it accepts and\nwhat it costs in credits.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
700
+ "summary": "Get Generation Model",
701
+ "operationId": "getModel",
702
+ "responses": {
703
+ "200": {
704
+ "description": "The generation model, with its option schema.",
705
+ "content": {
706
+ "application/json": {
707
+ "schema": {
708
+ "description": "A generation model available to `prompt`-bearing image, video and audio assets, with the options it accepts and what it costs. Render a model picker and its option fields from this rather than hard coding a model list, so a newly launched model is available without a client release.",
709
+ "properties": {
710
+ "model": {
711
+ "description": "The identifier to set as the asset `model`. Carries no provider name, so routing can change without a public rename.",
712
+ "type": "string",
713
+ "example": "seedance-2.0"
714
+ },
715
+ "type": {
716
+ "description": "The asset type this model generates.",
717
+ "type": "string",
718
+ "enum": [
719
+ "image",
720
+ "video",
721
+ "audio"
722
+ ],
723
+ "example": "video"
724
+ },
725
+ "pricing": {
726
+ "description": "What one generation with this model costs.",
727
+ "properties": {
728
+ "unit": {
729
+ "description": "What one unit is. `render` means the whole generation counts as one unit, whatever its size.",
730
+ "type": "string",
731
+ "enum": [
732
+ "render",
733
+ "second",
734
+ "minute",
735
+ "thousandCharacters"
736
+ ],
737
+ "example": "second"
738
+ },
739
+ "credits": {
740
+ "description": "Credits per unit. A number when the rate is flat, or an object keyed by the values of the options named in `tieredBy`.",
741
+ "oneOf": [
742
+ {
743
+ "type": "number"
744
+ },
745
+ {
746
+ "type": "object",
747
+ "additionalProperties": true
748
+ }
749
+ ],
750
+ "example": {
751
+ "480p": 0.9375,
752
+ "720p": 1.8962,
753
+ "1080p": 4.2625
754
+ }
755
+ },
756
+ "tieredBy": {
757
+ "description": "The options whose values select the rate, outermost first. Absent when `credits` is a single number.",
758
+ "type": "array",
759
+ "items": {
760
+ "type": "string"
761
+ },
762
+ "example": [
763
+ "resolution"
764
+ ]
765
+ },
766
+ "minUnits": {
767
+ "description": "The fewest units a generation is charged for, when a model has a minimum charge.",
768
+ "type": "number",
769
+ "example": 0.1
770
+ },
771
+ "effectiveFrom": {
772
+ "description": "The date this rate took effect, or `legacy` for a rate that predates dated pricing.",
773
+ "type": "string",
774
+ "example": "2026-08-13"
775
+ }
776
+ },
777
+ "required": [
778
+ "unit",
779
+ "credits",
780
+ "effectiveFrom"
781
+ ],
782
+ "type": "object"
783
+ },
784
+ "options": {
785
+ "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.",
786
+ "type": "object",
787
+ "additionalProperties": true
788
+ }
789
+ },
790
+ "required": [
791
+ "model",
792
+ "type"
793
+ ],
794
+ "type": "object"
795
+ }
796
+ }
797
+ }
798
+ },
799
+ "404": {
800
+ "description": "No model exists with that identifier."
801
+ }
802
+ },
803
+ "security": [
804
+ {
805
+ "DeveloperKey": []
806
+ }
807
+ ],
808
+ "tags": [
809
+ "Edit"
810
+ ]
811
+ },
812
+ "parameters": [
813
+ {
814
+ "in": "path",
815
+ "name": "id",
816
+ "required": true,
817
+ "description": "The model identifier, as returned by the list endpoint.",
818
+ "schema": {
819
+ "type": "string"
820
+ },
821
+ "example": "seedance-2.0"
822
+ }
823
+ ]
824
+ },
642
825
  "/assets/{id}": {
643
826
  "get": {
644
827
  "responses": {
package/dist/schema.d.ts CHANGED
@@ -246,6 +246,71 @@ export interface paths {
246
246
  patch?: never;
247
247
  trace?: never;
248
248
  };
249
+ "/models": {
250
+ parameters: {
251
+ query?: {
252
+ /**
253
+ * @description Set to `options` to include each model's option schema in the list. Omitted by default to keep the response small.
254
+ * @example options
255
+ */
256
+ expand?: "options";
257
+ };
258
+ header?: never;
259
+ path?: never;
260
+ cookie?: never;
261
+ };
262
+ /**
263
+ * List Generation Models
264
+ * @description List the generation models available for `prompt`-bearing image, video and audio
265
+ * assets, with the options each accepts and what it costs in credits.
266
+ *
267
+ * Use this to populate a model picker and render its option fields, rather than
268
+ * hard coding a model list. A newly launched model appears here without any change
269
+ * on your side. Each entry carries the asset type it generates, so filter the list
270
+ * client side when a picker only needs one kind.
271
+ *
272
+ * Option schemas are omitted by default. Request them with `expand=options`.
273
+ *
274
+ * **Base URL:** <a href="#">https://api.shotstack.io/edit/{version}</a>
275
+ */
276
+ get: operations["getModels"];
277
+ put?: never;
278
+ post?: never;
279
+ delete?: never;
280
+ options?: never;
281
+ head?: never;
282
+ patch?: never;
283
+ trace?: never;
284
+ };
285
+ "/models/{id}": {
286
+ parameters: {
287
+ query?: never;
288
+ header?: never;
289
+ path: {
290
+ /**
291
+ * @description The model identifier, as returned by the list endpoint.
292
+ * @example seedance-2.0
293
+ */
294
+ id: string;
295
+ };
296
+ cookie?: never;
297
+ };
298
+ /**
299
+ * Get Generation Model
300
+ * @description Get one generation model, including the JSON Schema for the options it accepts and
301
+ * what it costs in credits.
302
+ *
303
+ * **Base URL:** <a href="#">https://api.shotstack.io/edit/{version}</a>
304
+ */
305
+ get: operations["getModel"];
306
+ put?: never;
307
+ post?: never;
308
+ delete?: never;
309
+ options?: never;
310
+ head?: never;
311
+ patch?: never;
312
+ trace?: never;
313
+ };
249
314
  "/assets/{id}": {
250
315
  parameters: {
251
316
  query?: never;
@@ -3912,6 +3977,121 @@ export interface operations {
3912
3977
  };
3913
3978
  };
3914
3979
  };
3980
+ getModels: {
3981
+ parameters: {
3982
+ query?: {
3983
+ /**
3984
+ * @description Set to `options` to include each model's option schema in the list. Omitted by default to keep the response small.
3985
+ * @example options
3986
+ */
3987
+ expand?: "options";
3988
+ };
3989
+ header?: never;
3990
+ path?: never;
3991
+ cookie?: never;
3992
+ };
3993
+ requestBody?: never;
3994
+ responses: {
3995
+ /** @description The available generation models. */
3996
+ 200: {
3997
+ headers: {
3998
+ [name: string]: unknown;
3999
+ };
4000
+ content: {
4001
+ "application/json": {
4002
+ /** @description The available models. */
4003
+ models: paths["/models/{id}"]["get"]["responses"]["200"]["content"]["application/json"]["schema"][];
4004
+ };
4005
+ };
4006
+ };
4007
+ };
4008
+ };
4009
+ getModel: {
4010
+ parameters: {
4011
+ query?: never;
4012
+ header?: never;
4013
+ path: {
4014
+ /**
4015
+ * @description The model identifier, as returned by the list endpoint.
4016
+ * @example seedance-2.0
4017
+ */
4018
+ id: string;
4019
+ };
4020
+ cookie?: never;
4021
+ };
4022
+ requestBody?: never;
4023
+ responses: {
4024
+ /** @description The generation model, with its option schema. */
4025
+ 200: {
4026
+ headers: {
4027
+ [name: string]: unknown;
4028
+ };
4029
+ content: {
4030
+ "application/json": {
4031
+ /**
4032
+ * @description The identifier to set as the asset `model`. Carries no provider name, so routing can change without a public rename.
4033
+ * @example seedance-2.0
4034
+ */
4035
+ model: string;
4036
+ /**
4037
+ * @description The asset type this model generates.
4038
+ * @example video
4039
+ * @enum {string}
4040
+ */
4041
+ type: "image" | "video" | "audio";
4042
+ /** @description What one generation with this model costs. */
4043
+ pricing?: {
4044
+ /**
4045
+ * @description What one unit is. `render` means the whole generation counts as one unit, whatever its size.
4046
+ * @example second
4047
+ * @enum {string}
4048
+ */
4049
+ unit: "render" | "second" | "minute" | "thousandCharacters";
4050
+ /**
4051
+ * @description Credits per unit. A number when the rate is flat, or an object keyed by the values of the options named in `tieredBy`.
4052
+ * @example {
4053
+ * "480p": 0.9375,
4054
+ * "720p": 1.8962,
4055
+ * "1080p": 4.2625
4056
+ * }
4057
+ */
4058
+ credits: number | {
4059
+ [key: string]: unknown;
4060
+ };
4061
+ /**
4062
+ * @description The options whose values select the rate, outermost first. Absent when `credits` is a single number.
4063
+ * @example [
4064
+ * "resolution"
4065
+ * ]
4066
+ */
4067
+ tieredBy?: string[];
4068
+ /**
4069
+ * @description The fewest units a generation is charged for, when a model has a minimum charge.
4070
+ * @example 0.1
4071
+ */
4072
+ minUnits?: number;
4073
+ /**
4074
+ * @description The date this rate took effect, or `legacy` for a rate that predates dated pricing.
4075
+ * @example 2026-08-13
4076
+ */
4077
+ effectiveFrom: string;
4078
+ };
4079
+ /** @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. */
4080
+ options?: {
4081
+ [key: string]: unknown;
4082
+ };
4083
+ };
4084
+ };
4085
+ };
4086
+ /** @description No model exists with that identifier. */
4087
+ 404: {
4088
+ headers: {
4089
+ [name: string]: unknown;
4090
+ };
4091
+ content?: never;
4092
+ };
4093
+ };
4094
+ };
3915
4095
  getAsset: {
3916
4096
  parameters: {
3917
4097
  query?: never;
@@ -1,12 +1,13 @@
1
1
  "use strict";
2
2
  // This file is auto-generated by @hey-api/openapi-ts
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.shotstackDestinationSchema = exports.shotstackDestinationShotstackDestinationSchema = exports.s3DestinationSchema = exports.s3DestinationS3DestinationSchema = exports.s3DestinationOptionsSchema = exports.s3DestinationOptionsS3DestinationOptionsSchema = exports.muxDestinationSchema = exports.muxDestinationMuxDestinationSchema = exports.muxDestinationOptionsSchema = exports.muxDestinationOptionsMuxDestinationOptionsSchema = exports.googleDriveDestinationSchema = exports.googleDriveDestinationGoogleDriveDestinationSchema = exports.googleDriveDestinationOptionsSchema = exports.googleDriveDestinationOptionsGoogleDriveDestinationOptionsSchema = exports.googleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationGoogleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationOptionsSchema = exports.googleCloudStorageDestinationOptionsGoogleCloudStorageDestinationOptionsSchema = exports.azureBlobStorageDestinationAzureBlobStorageDestinationSchema = exports.azureBlobStorageDestinationOptionsAzureBlobStorageDestinationOptionsSchema = exports.akamaiNetStorageDestinationAkamaiNetStorageDestinationSchema = exports.akamaiNetStorageDestinationOptionsAkamaiNetStorageDestinationOptionsSchema = exports.cropSchema = exports.cropCropSchema = exports.chromaKeySchema = exports.chromakeyChromaKeySchema = exports.captionAssetSchema = exports.captionassetCaptionAssetSchema = exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema = exports.captionFontSchema = exports.captionpropertiesCaptionFontSchema = exports.captionBackgroundSchema = exports.captionpropertiesCaptionBackgroundSchema = exports.uploadRootSchema = exports.templatesrenderRootSchema = exports.templatesidRootSchema = exports.templatesRootSchema = exports.sourcesidRootSchema = exports.sourcesRootSchema = exports.renderidRootSchema = exports.renderRootSchema = exports.probeRootSchema = exports.generateidRootSchema = exports.generateRootSchema = exports.assetsrenderidRootSchema = exports.assetsidRootSchema = exports.assetsRootSchema = exports.sourceRootSchema = exports.editRootSchema = void 0;
5
- exports.lumaAssetSchema = exports.lumaassetLumaAssetSchema = exports.transcriptionSchema = exports.transcriptionTranscriptionSchema = exports.speedSchema = exports.speedSpeedSchema = exports.uploadResponseSchema = exports.uploadresponseUploadResponseSchema = exports.uploadResponseDataSchema = exports.uploadresponsedataUploadResponseDataSchema = exports.uploadResponseAttributesSchema = exports.uploadresponseattributesUploadResponseAttributesSchema = exports.queuedSourceResponseSchema = exports.queuedsourceresponseQueuedSourceResponseSchema = exports.queuedSourceResponseDataSchema = exports.queuedsourceresponsedataQueuedSourceResponseDataSchema = exports.ingestErrorResponseSchema = exports.ingesterrorresponseIngestErrorResponseSchema = exports.ingestErrorResponseDataSchema = exports.ingesterrorresponsedataIngestErrorResponseDataSchema = exports.enhancementsSchema = exports.enhancementsEnhancementsSchema = exports.audioEnhancementSchema = exports.audioEnhancementAudioEnhancementSchema = exports.dolbyEnhancementSchema = exports.dolbyEnhancementDolbyEnhancementSchema = exports.dolbyEnhancementOptionsSchema = exports.dolbyEnhancementOptionsDolbyEnhancementOptionsSchema = exports.imageToVideoAssetSchema = exports.imagetovideoassetImageToVideoAssetSchema = exports.imageAssetSchema = exports.imageassetImageAssetSchema = exports.htmlAssetSchema = exports.htmlassetHtmlAssetSchema = exports.html5AssetSchema = exports.html5AssetHtml5AssetSchema = exports.fontSchema = exports.fontFontSchema = exports.flipTransformationSchema = exports.fliptransformationFlipTransformationSchema = exports.destinationsSchema = exports.destinationsDestinationsSchema = exports.vimeoDestinationSchema = exports.vimeoDestinationVimeoDestinationSchema = exports.vimeoDestinationOptionsSchema = exports.vimeoDestinationOptionsVimeoDestinationOptionsSchema = exports.vimeoDestinationPrivacyOptionsSchema = exports.vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema = exports.tiktokDestinationTiktokDestinationSchema = exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema = void 0;
6
- exports.richtextpropertiesRichTextStrokeSchema = exports.richTextShadowSchema = exports.richtextpropertiesRichTextShadowSchema = exports.richtextpropertiesRichTextPaddingSchema = exports.richcaptionpropertiesRichCaptionStyleSchema = exports.richTextGradientSchema = exports.richtextpropertiesRichTextGradientSchema = exports.richtextpropertiesRichTextBorderSchema = exports.richTextBackgroundSchema = exports.richtextpropertiesRichTextBackgroundSchema = exports.richTextAnimationSchema = exports.richtextpropertiesRichTextAnimationSchema = exports.richTextAlignmentSchema = exports.richtextpropertiesRichTextAlignmentSchema = exports.richcaptionpropertiesRichCaptionFontSchema = exports.richCaptionAnimationSchema = exports.richcaptionpropertiesRichCaptionAnimationSchema = exports.richCaptionActiveFontSchema = exports.richcaptionpropertiesRichCaptionActiveFontSchema = exports.templateResponseSchema = exports.templateresponseTemplateResponseSchema = exports.templateResponseDataSchema = exports.templateresponsedataTemplateResponseDataSchema = exports.templateListResponseSchema = exports.templatelistresponseTemplateListResponseSchema = exports.templateListResponseDataSchema = exports.templatelistresponsedataTemplateListResponseDataSchema = exports.templateListResponseItemSchema = exports.templatelistresponseitemTemplateListResponseItemSchema = exports.queuedResponseSchema = exports.queuedresponseQueuedResponseSchema = exports.queuedResponseDataSchema = exports.queuedresponsedataQueuedResponseDataSchema = exports.probeResponseSchema = exports.proberesponseProbeResponseSchema = exports.generationresponseGenerationResponseSchema = exports.assetResponseSchema = exports.assetresponseAssetResponseSchema = exports.assetRenderResponseSchema = exports.assetrenderresponseAssetRenderResponseSchema = exports.assetResponseDataSchema = exports.assetresponsedataAssetResponseDataSchema = exports.assetResponseAttributesSchema = exports.assetresponseattributesAssetResponseAttributesSchema = exports.rangeSchema = exports.rangeRangeSchema = exports.posterSchema = exports.posterPosterSchema = exports.mergeFieldSchema = exports.mergefieldMergeFieldSchema = void 0;
7
- exports.textpropertiesTextAnimationSchema = exports.textAlignmentSchema = exports.textpropertiesTextAlignmentSchema = exports.templateRenderSchema = exports.templaterenderTemplateRenderSchema = exports.svgAssetSchema = exports.svgassetSvgAssetSchema = exports.soundtrackSchema = exports.soundtrackSoundtrackSchema = exports.sourceSchema = exports.sourceSourceSchema = exports.sourceResponseSchema = exports.sourceresponseSourceResponseSchema = exports.sourceListResponseSchema = exports.sourcelistresponseSourceListResponseSchema = exports.sourceResponseDataSchema = exports.sourceresponsedataSourceResponseDataSchema = exports.sourceResponseAttributesSchema = exports.sourceresponseattributesSourceResponseAttributesSchema = exports.outputsResponseSchema = exports.outputsresponseOutputsResponseSchema = exports.renditionResponseAttributesSchema = exports.renditionresponseattributesRenditionResponseAttributesSchema = exports.outputsSchema = exports.outputsOutputsSchema = exports.renditionSchema = exports.renditionRenditionSchema = exports.sizeSchema = exports.sizeSizeSchema = exports.shapeAssetSchema = exports.shapeassetShapeAssetSchema = exports.transferSchema = exports.transferTransferSchema = exports.transferResponseSchema = exports.transferresponseTransferResponseSchema = exports.transferResponseDataSchema = exports.transferresponsedataTransferResponseDataSchema = exports.transferResponseAttributesSchema = exports.transferresponseattributesTransferResponseAttributesSchema = exports.richTextAssetSchema = exports.richtextassetRichTextAssetSchema = exports.richTextStyleSchema = exports.richtextpropertiesRichTextStyleSchema = exports.richTextFontSchema = exports.richtextpropertiesRichTextFontSchema = exports.richCaptionAssetSchema = exports.richcaptionassetRichCaptionAssetSchema = exports.richCaptionActiveSchema = exports.richcaptionpropertiesRichCaptionActiveSchema = exports.richTextStrokeSchema = void 0;
8
- exports.templatedataresponseTemplateDataResponseSchema = exports.templateDataResponseDataSchema = exports.templatedataresponsedataTemplateDataResponseDataSchema = exports.renderResponseSchema = exports.renderresponseRenderResponseSchema = exports.renderResponseDataSchema = exports.renderresponsedataRenderResponseDataSchema = exports.editSchema = exports.editEditSchema = exports.timelineSchema = exports.timelineTimelineSchema = exports.trackSchema = exports.trackTrackSchema = exports.clipSchema = exports.clipClipSchema = exports.assetSchema = exports.assetAssetSchema = exports.videoAssetSchema = exports.videoassetVideoAssetSchema = exports.transformationSchema = exports.transformationTransformationSchema = exports.titleAssetSchema = exports.titleassetTitleAssetSchema = exports.textToSpeechAssetSchema = exports.texttospeechassetTextToSpeechAssetSchema = exports.skewTransformationSchema = exports.skewtransformationSkewTransformationSchema = exports.rotateTransformationSchema = exports.rotatetransformationRotateTransformationSchema = exports.offsetSchema = exports.offsetOffsetSchema = exports.audioAssetSchema = exports.audioassetAudioAssetSchema = exports.tweenSchema = exports.tweenTweenSchema = exports.transitionSchema = exports.transitionTransitionSchema = exports.outputSchema = exports.outputOutputSchema = exports.thumbnailSchema = exports.thumbnailThumbnailSchema = exports.textToImageAssetSchema = exports.texttoimageassetTextToImageAssetSchema = exports.textAssetSchema = exports.textassetTextAssetSchema = exports.textpropertiesTextStrokeSchema = exports.textFontSchema = exports.textpropertiesTextFontSchema = exports.textBackgroundSchema = exports.textpropertiesTextBackgroundSchema = void 0;
9
- exports.getUploadSignedUrlResponse = exports.getUploadSignedUrlRequest = exports.getSourceResponse = exports.getSourceRequest = exports.deleteSourceResponse = exports.deleteSourceRequest = exports.postSourceResponse = exports.postSourceRequest = exports.getSourcesResponse = exports.getSourcesRequest = exports.postServeAssetResponse = exports.postServeAssetRequest = exports.getAssetByRenderIdResponse = exports.getAssetByRenderIdRequest = exports.getAssetResponse = exports.getAssetRequest = exports.deleteAssetResponse = exports.deleteAssetRequest = exports.getGenerateResponse = exports.getGenerateRequest = exports.postGenerateResponse = exports.postGenerateRequest = exports.probeResponse = exports.probeRequest = exports.postTemplateRenderResponse = exports.postTemplateRenderRequest = exports.putTemplateResponse = exports.putTemplateRequest = exports.getTemplateResponse = exports.getTemplateRequest = exports.deleteTemplateResponse = exports.deleteTemplateRequest = exports.postTemplateResponse = exports.postTemplateRequest = exports.getTemplatesResponse = exports.getTemplatesRequest = exports.getRenderResponse = exports.getRenderRequest = exports.postRenderResponse = exports.postRenderRequest = exports.templateSchema = exports.templateTemplateSchema = exports.templateDataResponseSchema = void 0;
4
+ exports.s3DestinationSchema = exports.s3DestinationS3DestinationSchema = exports.s3DestinationOptionsSchema = exports.s3DestinationOptionsS3DestinationOptionsSchema = exports.muxDestinationSchema = exports.muxDestinationMuxDestinationSchema = exports.muxDestinationOptionsSchema = exports.muxDestinationOptionsMuxDestinationOptionsSchema = exports.googleDriveDestinationSchema = exports.googleDriveDestinationGoogleDriveDestinationSchema = exports.googleDriveDestinationOptionsSchema = exports.googleDriveDestinationOptionsGoogleDriveDestinationOptionsSchema = exports.googleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationGoogleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationOptionsSchema = exports.googleCloudStorageDestinationOptionsGoogleCloudStorageDestinationOptionsSchema = exports.azureBlobStorageDestinationAzureBlobStorageDestinationSchema = exports.azureBlobStorageDestinationOptionsAzureBlobStorageDestinationOptionsSchema = exports.akamaiNetStorageDestinationAkamaiNetStorageDestinationSchema = exports.akamaiNetStorageDestinationOptionsAkamaiNetStorageDestinationOptionsSchema = exports.cropSchema = exports.cropCropSchema = exports.chromaKeySchema = exports.chromakeyChromaKeySchema = exports.captionAssetSchema = exports.captionassetCaptionAssetSchema = exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema = exports.captionFontSchema = exports.captionpropertiesCaptionFontSchema = exports.captionBackgroundSchema = exports.captionpropertiesCaptionBackgroundSchema = exports.uploadRootSchema = exports.templatesrenderRootSchema = exports.templatesidRootSchema = exports.templatesRootSchema = exports.sourcesidRootSchema = exports.sourcesRootSchema = exports.renderidRootSchema = exports.renderRootSchema = exports.probeRootSchema = exports.modelsidRootSchema = exports.modelsRootSchema = exports.generateidRootSchema = exports.generateRootSchema = exports.assetsrenderidRootSchema = exports.assetsidRootSchema = exports.assetsRootSchema = exports.sourceRootSchema = exports.editRootSchema = void 0;
5
+ exports.speedSchema = exports.speedSpeedSchema = exports.uploadResponseSchema = exports.uploadresponseUploadResponseSchema = exports.uploadResponseDataSchema = exports.uploadresponsedataUploadResponseDataSchema = exports.uploadResponseAttributesSchema = exports.uploadresponseattributesUploadResponseAttributesSchema = exports.queuedSourceResponseSchema = exports.queuedsourceresponseQueuedSourceResponseSchema = exports.queuedSourceResponseDataSchema = exports.queuedsourceresponsedataQueuedSourceResponseDataSchema = exports.ingestErrorResponseSchema = exports.ingesterrorresponseIngestErrorResponseSchema = exports.ingestErrorResponseDataSchema = exports.ingesterrorresponsedataIngestErrorResponseDataSchema = exports.enhancementsSchema = exports.enhancementsEnhancementsSchema = exports.audioEnhancementSchema = exports.audioEnhancementAudioEnhancementSchema = exports.dolbyEnhancementSchema = exports.dolbyEnhancementDolbyEnhancementSchema = exports.dolbyEnhancementOptionsSchema = exports.dolbyEnhancementOptionsDolbyEnhancementOptionsSchema = exports.imageToVideoAssetSchema = exports.imagetovideoassetImageToVideoAssetSchema = exports.imageAssetSchema = exports.imageassetImageAssetSchema = exports.htmlAssetSchema = exports.htmlassetHtmlAssetSchema = exports.html5AssetSchema = exports.html5AssetHtml5AssetSchema = exports.generationmodelGenerationModelSchema = exports.generationmodelpricingGenerationModelPricingSchema = exports.fontSchema = exports.fontFontSchema = exports.flipTransformationSchema = exports.fliptransformationFlipTransformationSchema = exports.destinationsSchema = exports.destinationsDestinationsSchema = exports.vimeoDestinationSchema = exports.vimeoDestinationVimeoDestinationSchema = exports.vimeoDestinationOptionsSchema = exports.vimeoDestinationOptionsVimeoDestinationOptionsSchema = exports.vimeoDestinationPrivacyOptionsSchema = exports.vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema = exports.tiktokDestinationTiktokDestinationSchema = exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema = exports.shotstackDestinationSchema = exports.shotstackDestinationShotstackDestinationSchema = void 0;
6
+ exports.richTextGradientSchema = exports.richtextpropertiesRichTextGradientSchema = exports.richtextpropertiesRichTextBorderSchema = exports.richTextBackgroundSchema = exports.richtextpropertiesRichTextBackgroundSchema = exports.richTextAnimationSchema = exports.richtextpropertiesRichTextAnimationSchema = exports.richTextAlignmentSchema = exports.richtextpropertiesRichTextAlignmentSchema = exports.richcaptionpropertiesRichCaptionFontSchema = exports.richCaptionAnimationSchema = exports.richcaptionpropertiesRichCaptionAnimationSchema = exports.richCaptionActiveFontSchema = exports.richcaptionpropertiesRichCaptionActiveFontSchema = exports.templateResponseSchema = exports.templateresponseTemplateResponseSchema = exports.templateResponseDataSchema = exports.templateresponsedataTemplateResponseDataSchema = exports.templateListResponseSchema = exports.templatelistresponseTemplateListResponseSchema = exports.templateListResponseDataSchema = exports.templatelistresponsedataTemplateListResponseDataSchema = exports.templateListResponseItemSchema = exports.templatelistresponseitemTemplateListResponseItemSchema = exports.queuedResponseSchema = exports.queuedresponseQueuedResponseSchema = exports.queuedResponseDataSchema = exports.queuedresponsedataQueuedResponseDataSchema = exports.probeResponseSchema = exports.proberesponseProbeResponseSchema = exports.generationresponseGenerationResponseSchema = exports.generationmodellistresponseGenerationModelListResponseSchema = exports.assetResponseSchema = exports.assetresponseAssetResponseSchema = exports.assetRenderResponseSchema = exports.assetrenderresponseAssetRenderResponseSchema = exports.assetResponseDataSchema = exports.assetresponsedataAssetResponseDataSchema = exports.assetResponseAttributesSchema = exports.assetresponseattributesAssetResponseAttributesSchema = exports.rangeSchema = exports.rangeRangeSchema = exports.posterSchema = exports.posterPosterSchema = exports.mergeFieldSchema = exports.mergefieldMergeFieldSchema = exports.lumaAssetSchema = exports.lumaassetLumaAssetSchema = exports.transcriptionSchema = exports.transcriptionTranscriptionSchema = void 0;
7
+ exports.svgAssetSchema = exports.svgassetSvgAssetSchema = exports.soundtrackSchema = exports.soundtrackSoundtrackSchema = exports.sourceSchema = exports.sourceSourceSchema = exports.sourceResponseSchema = exports.sourceresponseSourceResponseSchema = exports.sourceListResponseSchema = exports.sourcelistresponseSourceListResponseSchema = exports.sourceResponseDataSchema = exports.sourceresponsedataSourceResponseDataSchema = exports.sourceResponseAttributesSchema = exports.sourceresponseattributesSourceResponseAttributesSchema = exports.outputsResponseSchema = exports.outputsresponseOutputsResponseSchema = exports.renditionResponseAttributesSchema = exports.renditionresponseattributesRenditionResponseAttributesSchema = exports.outputsSchema = exports.outputsOutputsSchema = exports.renditionSchema = exports.renditionRenditionSchema = exports.sizeSchema = exports.sizeSizeSchema = exports.shapeAssetSchema = exports.shapeassetShapeAssetSchema = exports.transferSchema = exports.transferTransferSchema = exports.transferResponseSchema = exports.transferresponseTransferResponseSchema = exports.transferResponseDataSchema = exports.transferresponsedataTransferResponseDataSchema = exports.transferResponseAttributesSchema = exports.transferresponseattributesTransferResponseAttributesSchema = exports.richTextAssetSchema = exports.richtextassetRichTextAssetSchema = exports.richTextStyleSchema = exports.richtextpropertiesRichTextStyleSchema = exports.richTextFontSchema = exports.richtextpropertiesRichTextFontSchema = exports.richCaptionAssetSchema = exports.richcaptionassetRichCaptionAssetSchema = exports.richCaptionActiveSchema = exports.richcaptionpropertiesRichCaptionActiveSchema = exports.richTextStrokeSchema = exports.richtextpropertiesRichTextStrokeSchema = exports.richTextShadowSchema = exports.richtextpropertiesRichTextShadowSchema = exports.richtextpropertiesRichTextPaddingSchema = exports.richcaptionpropertiesRichCaptionStyleSchema = void 0;
8
+ exports.renderResponseDataSchema = exports.renderresponsedataRenderResponseDataSchema = exports.editSchema = exports.editEditSchema = exports.timelineSchema = exports.timelineTimelineSchema = exports.trackSchema = exports.trackTrackSchema = exports.clipSchema = exports.clipClipSchema = exports.assetSchema = exports.assetAssetSchema = exports.videoAssetSchema = exports.videoassetVideoAssetSchema = exports.transformationSchema = exports.transformationTransformationSchema = exports.titleAssetSchema = exports.titleassetTitleAssetSchema = exports.textToSpeechAssetSchema = exports.texttospeechassetTextToSpeechAssetSchema = exports.skewTransformationSchema = exports.skewtransformationSkewTransformationSchema = exports.rotateTransformationSchema = exports.rotatetransformationRotateTransformationSchema = exports.offsetSchema = exports.offsetOffsetSchema = exports.audioAssetSchema = exports.audioassetAudioAssetSchema = exports.tweenSchema = exports.tweenTweenSchema = exports.transitionSchema = exports.transitionTransitionSchema = exports.outputSchema = exports.outputOutputSchema = exports.thumbnailSchema = exports.thumbnailThumbnailSchema = exports.textToImageAssetSchema = exports.texttoimageassetTextToImageAssetSchema = exports.textAssetSchema = exports.textassetTextAssetSchema = exports.textpropertiesTextStrokeSchema = exports.textFontSchema = exports.textpropertiesTextFontSchema = exports.textBackgroundSchema = exports.textpropertiesTextBackgroundSchema = exports.textpropertiesTextAnimationSchema = exports.textAlignmentSchema = exports.textpropertiesTextAlignmentSchema = exports.templateRenderSchema = exports.templaterenderTemplateRenderSchema = void 0;
9
+ exports.getSourceResponse = exports.getSourceRequest = exports.deleteSourceResponse = exports.deleteSourceRequest = exports.postSourceResponse = exports.postSourceRequest = exports.getSourcesResponse = exports.getSourcesRequest = exports.postServeAssetResponse = exports.postServeAssetRequest = exports.getAssetByRenderIdResponse = exports.getAssetByRenderIdRequest = exports.getAssetResponse = exports.getAssetRequest = exports.deleteAssetResponse = exports.deleteAssetRequest = exports.getModelResponse = exports.getModelRequest = exports.getModelsResponse = exports.getModelsRequest = exports.getGenerateResponse = exports.getGenerateRequest = exports.postGenerateResponse = exports.postGenerateRequest = exports.probeResponse = exports.probeRequest = exports.postTemplateRenderResponse = exports.postTemplateRenderRequest = exports.putTemplateResponse = exports.putTemplateRequest = exports.getTemplateResponse = exports.getTemplateRequest = exports.deleteTemplateResponse = exports.deleteTemplateRequest = exports.postTemplateResponse = exports.postTemplateRequest = exports.getTemplatesResponse = exports.getTemplatesRequest = exports.getRenderResponse = exports.getRenderRequest = exports.postRenderResponse = exports.postRenderRequest = exports.templateSchema = exports.templateTemplateSchema = exports.templateDataResponseSchema = exports.templatedataresponseTemplateDataResponseSchema = exports.templateDataResponseDataSchema = exports.templatedataresponsedataTemplateDataResponseDataSchema = exports.renderResponseSchema = exports.renderresponseRenderResponseSchema = void 0;
10
+ exports.getUploadSignedUrlResponse = exports.getUploadSignedUrlRequest = void 0;
10
11
  const zod_1 = require("zod");
11
12
  exports.editRootSchema = zod_1.z.unknown();
12
13
  exports.sourceRootSchema = zod_1.z.unknown();
@@ -15,6 +16,8 @@ exports.assetsidRootSchema = zod_1.z.unknown();
15
16
  exports.assetsrenderidRootSchema = zod_1.z.unknown();
16
17
  exports.generateRootSchema = zod_1.z.unknown();
17
18
  exports.generateidRootSchema = zod_1.z.unknown();
19
+ exports.modelsRootSchema = zod_1.z.unknown();
20
+ exports.modelsidRootSchema = zod_1.z.unknown();
18
21
  exports.probeRootSchema = zod_1.z.unknown();
19
22
  exports.renderRootSchema = zod_1.z.unknown();
20
23
  exports.renderidRootSchema = zod_1.z.unknown();
@@ -421,6 +424,49 @@ exports.fontFontSchema = zod_1.z.object({
421
424
  src: zod_1.z.string()
422
425
  }).strict();
423
426
  exports.fontSchema = exports.fontFontSchema;
427
+ /**
428
+ * What one generation costs, in credits. There is no formula to evaluate: multiply the rate by the number of units the generation consumes. Where a model charges differently per option value, `credits` is an object keyed by that value and `tieredBy` names the option that selects it.
429
+ */
430
+ exports.generationmodelpricingGenerationModelPricingSchema = zod_1.z.object({
431
+ unit: zod_1.z.enum([
432
+ 'render',
433
+ 'second',
434
+ 'minute',
435
+ 'thousandCharacters'
436
+ ]),
437
+ credits: zod_1.z.union([
438
+ zod_1.z.union([zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
439
+ return undefined; if (Array.isArray(v))
440
+ return v; if (typeof v === 'string') {
441
+ if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
442
+ return v;
443
+ return Number(v);
444
+ } return v; }), zod_1.z.number()), zod_1.z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
445
+ zod_1.z.record(zod_1.z.string(), zod_1.z.unknown())
446
+ ]),
447
+ tieredBy: zod_1.z.optional(zod_1.z.array(zod_1.z.string())),
448
+ minUnits: zod_1.z.optional(zod_1.z.union([zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
449
+ return undefined; if (Array.isArray(v))
450
+ return v; if (typeof v === 'string') {
451
+ if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
452
+ return v;
453
+ return Number(v);
454
+ } return v; }), zod_1.z.number()), zod_1.z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
455
+ effectiveFrom: zod_1.z.string()
456
+ }).strict();
457
+ /**
458
+ * A generation model available to `prompt`-bearing image, video and audio assets, with the options it accepts and what it costs. Render a model picker and its option fields from this rather than hard coding a model list, so a newly launched model is available without a client release.
459
+ */
460
+ exports.generationmodelGenerationModelSchema = zod_1.z.object({
461
+ model: zod_1.z.string(),
462
+ type: zod_1.z.enum([
463
+ 'image',
464
+ 'video',
465
+ 'audio'
466
+ ]),
467
+ pricing: zod_1.z.optional(exports.generationmodelpricingGenerationModelPricingSchema),
468
+ options: zod_1.z.optional(zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()))
469
+ }).strict();
424
470
  /**
425
471
  * The Html5Asset renders full HTML5/CSS3/JS.
426
472
  *
@@ -759,6 +805,12 @@ exports.assetresponseAssetResponseSchema = zod_1.z.object({
759
805
  data: exports.assetresponsedataAssetResponseDataSchema
760
806
  }).strict();
761
807
  exports.assetResponseSchema = exports.assetresponseAssetResponseSchema;
808
+ /**
809
+ * The generation models available to this account.
810
+ */
811
+ exports.generationmodellistresponseGenerationModelListResponseSchema = zod_1.z.object({
812
+ models: zod_1.z.array(exports.generationmodelGenerationModelSchema)
813
+ }).strict();
762
814
  /**
763
815
  * The status of an on-demand asset generation job. Completed jobs include the public URL of the generated asset.
764
816
  */
@@ -2890,6 +2942,28 @@ exports.getGenerateRequest = zod_1.z.object({
2890
2942
  * The generation job has finished (done or failed).
2891
2943
  */
2892
2944
  exports.getGenerateResponse = exports.generationresponseGenerationResponseSchema;
2945
+ exports.getModelsRequest = zod_1.z.object({
2946
+ body: zod_1.z.optional(zod_1.z.never()),
2947
+ path: zod_1.z.optional(zod_1.z.never()),
2948
+ query: zod_1.z.optional(zod_1.z.object({
2949
+ expand: zod_1.z.optional(zod_1.z.enum(['options']))
2950
+ }))
2951
+ }).strict();
2952
+ /**
2953
+ * The available generation models.
2954
+ */
2955
+ exports.getModelsResponse = exports.generationmodellistresponseGenerationModelListResponseSchema;
2956
+ exports.getModelRequest = zod_1.z.object({
2957
+ body: zod_1.z.optional(zod_1.z.never()),
2958
+ path: zod_1.z.object({
2959
+ id: zod_1.z.string()
2960
+ }),
2961
+ query: zod_1.z.optional(zod_1.z.never())
2962
+ }).strict();
2963
+ /**
2964
+ * The generation model, with its option schema.
2965
+ */
2966
+ exports.getModelResponse = exports.generationmodelGenerationModelSchema;
2893
2967
  exports.deleteAssetRequest = zod_1.z.object({
2894
2968
  body: zod_1.z.optional(zod_1.z.never()),
2895
2969
  path: zod_1.z.object({
@@ -6,6 +6,8 @@ export declare const assetsidRootSchema: z.ZodUnknown;
6
6
  export declare const assetsrenderidRootSchema: z.ZodUnknown;
7
7
  export declare const generateRootSchema: z.ZodUnknown;
8
8
  export declare const generateidRootSchema: z.ZodUnknown;
9
+ export declare const modelsRootSchema: z.ZodUnknown;
10
+ export declare const modelsidRootSchema: z.ZodUnknown;
9
11
  export declare const probeRootSchema: z.ZodUnknown;
10
12
  export declare const renderRootSchema: z.ZodUnknown;
11
13
  export declare const renderidRootSchema: z.ZodUnknown;
@@ -754,6 +756,45 @@ export declare const fontFontSchema: z.ZodObject<{
754
756
  export declare const fontSchema: z.ZodObject<{
755
757
  src: z.ZodString;
756
758
  }, z.core.$strict>;
759
+ /**
760
+ * What one generation costs, in credits. There is no formula to evaluate: multiply the rate by the number of units the generation consumes. Where a model charges differently per option value, `credits` is an object keyed by that value and `tieredBy` names the option that selects it.
761
+ */
762
+ export declare const generationmodelpricingGenerationModelPricingSchema: z.ZodObject<{
763
+ unit: z.ZodEnum<{
764
+ render: "render";
765
+ second: "second";
766
+ minute: "minute";
767
+ thousandCharacters: "thousandCharacters";
768
+ }>;
769
+ credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
770
+ tieredBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
771
+ minUnits: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>>;
772
+ effectiveFrom: z.ZodString;
773
+ }, z.core.$strict>;
774
+ /**
775
+ * A generation model available to `prompt`-bearing image, video and audio assets, with the options it accepts and what it costs. Render a model picker and its option fields from this rather than hard coding a model list, so a newly launched model is available without a client release.
776
+ */
777
+ export declare const generationmodelGenerationModelSchema: z.ZodObject<{
778
+ model: z.ZodString;
779
+ type: z.ZodEnum<{
780
+ image: "image";
781
+ video: "video";
782
+ audio: "audio";
783
+ }>;
784
+ pricing: z.ZodOptional<z.ZodObject<{
785
+ unit: z.ZodEnum<{
786
+ render: "render";
787
+ second: "second";
788
+ minute: "minute";
789
+ thousandCharacters: "thousandCharacters";
790
+ }>;
791
+ credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
792
+ tieredBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
793
+ minUnits: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>>;
794
+ effectiveFrom: z.ZodString;
795
+ }, z.core.$strict>>;
796
+ options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
797
+ }, z.core.$strict>;
757
798
  /**
758
799
  * The Html5Asset renders full HTML5/CSS3/JS.
759
800
  *
@@ -1439,6 +1480,32 @@ export declare const assetResponseSchema: z.ZodObject<{
1439
1480
  }, z.core.$strict>;
1440
1481
  }, z.core.$strict>;
1441
1482
  }, z.core.$strict>;
1483
+ /**
1484
+ * The generation models available to this account.
1485
+ */
1486
+ export declare const generationmodellistresponseGenerationModelListResponseSchema: z.ZodObject<{
1487
+ models: z.ZodArray<z.ZodObject<{
1488
+ model: z.ZodString;
1489
+ type: z.ZodEnum<{
1490
+ image: "image";
1491
+ video: "video";
1492
+ audio: "audio";
1493
+ }>;
1494
+ pricing: z.ZodOptional<z.ZodObject<{
1495
+ unit: z.ZodEnum<{
1496
+ render: "render";
1497
+ second: "second";
1498
+ minute: "minute";
1499
+ thousandCharacters: "thousandCharacters";
1500
+ }>;
1501
+ credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
1502
+ tieredBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
1503
+ minUnits: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>>;
1504
+ effectiveFrom: z.ZodString;
1505
+ }, z.core.$strict>>;
1506
+ options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1507
+ }, z.core.$strict>>;
1508
+ }, z.core.$strict>;
1442
1509
  /**
1443
1510
  * The status of an on-demand asset generation job. Completed jobs include the public URL of the generated asset.
1444
1511
  */
@@ -60401,6 +60468,72 @@ export declare const getGenerateResponse: z.ZodObject<{
60401
60468
  url: z.ZodOptional<z.ZodString>;
60402
60469
  error: z.ZodOptional<z.ZodString>;
60403
60470
  }, z.core.$strict>;
60471
+ export declare const getModelsRequest: z.ZodObject<{
60472
+ body: z.ZodOptional<z.ZodNever>;
60473
+ path: z.ZodOptional<z.ZodNever>;
60474
+ query: z.ZodOptional<z.ZodObject<{
60475
+ expand: z.ZodOptional<z.ZodEnum<{
60476
+ options: "options";
60477
+ }>>;
60478
+ }, z.core.$strip>>;
60479
+ }, z.core.$strict>;
60480
+ /**
60481
+ * The available generation models.
60482
+ */
60483
+ export declare const getModelsResponse: z.ZodObject<{
60484
+ models: z.ZodArray<z.ZodObject<{
60485
+ model: z.ZodString;
60486
+ type: z.ZodEnum<{
60487
+ image: "image";
60488
+ video: "video";
60489
+ audio: "audio";
60490
+ }>;
60491
+ pricing: z.ZodOptional<z.ZodObject<{
60492
+ unit: z.ZodEnum<{
60493
+ render: "render";
60494
+ second: "second";
60495
+ minute: "minute";
60496
+ thousandCharacters: "thousandCharacters";
60497
+ }>;
60498
+ credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
60499
+ tieredBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
60500
+ minUnits: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>>;
60501
+ effectiveFrom: z.ZodString;
60502
+ }, z.core.$strict>>;
60503
+ options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
60504
+ }, z.core.$strict>>;
60505
+ }, z.core.$strict>;
60506
+ export declare const getModelRequest: z.ZodObject<{
60507
+ body: z.ZodOptional<z.ZodNever>;
60508
+ path: z.ZodObject<{
60509
+ id: z.ZodString;
60510
+ }, z.core.$strip>;
60511
+ query: z.ZodOptional<z.ZodNever>;
60512
+ }, z.core.$strict>;
60513
+ /**
60514
+ * The generation model, with its option schema.
60515
+ */
60516
+ export declare const getModelResponse: z.ZodObject<{
60517
+ model: z.ZodString;
60518
+ type: z.ZodEnum<{
60519
+ image: "image";
60520
+ video: "video";
60521
+ audio: "audio";
60522
+ }>;
60523
+ pricing: z.ZodOptional<z.ZodObject<{
60524
+ unit: z.ZodEnum<{
60525
+ render: "render";
60526
+ second: "second";
60527
+ minute: "minute";
60528
+ thousandCharacters: "thousandCharacters";
60529
+ }>;
60530
+ credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
60531
+ tieredBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
60532
+ minUnits: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>>;
60533
+ effectiveFrom: z.ZodString;
60534
+ }, z.core.$strict>>;
60535
+ options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
60536
+ }, z.core.$strict>;
60404
60537
  export declare const deleteAssetRequest: z.ZodObject<{
60405
60538
  body: z.ZodOptional<z.ZodNever>;
60406
60539
  path: z.ZodObject<{
@@ -7,6 +7,8 @@ export const assetsidRootSchema = z.unknown();
7
7
  export const assetsrenderidRootSchema = z.unknown();
8
8
  export const generateRootSchema = z.unknown();
9
9
  export const generateidRootSchema = z.unknown();
10
+ export const modelsRootSchema = z.unknown();
11
+ export const modelsidRootSchema = z.unknown();
10
12
  export const probeRootSchema = z.unknown();
11
13
  export const renderRootSchema = z.unknown();
12
14
  export const renderidRootSchema = z.unknown();
@@ -413,6 +415,49 @@ export const fontFontSchema = z.object({
413
415
  src: z.string()
414
416
  }).strict();
415
417
  export const fontSchema = fontFontSchema;
418
+ /**
419
+ * What one generation costs, in credits. There is no formula to evaluate: multiply the rate by the number of units the generation consumes. Where a model charges differently per option value, `credits` is an object keyed by that value and `tieredBy` names the option that selects it.
420
+ */
421
+ export const generationmodelpricingGenerationModelPricingSchema = z.object({
422
+ unit: z.enum([
423
+ 'render',
424
+ 'second',
425
+ 'minute',
426
+ 'thousandCharacters'
427
+ ]),
428
+ credits: z.union([
429
+ z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
430
+ return undefined; if (Array.isArray(v))
431
+ return v; if (typeof v === 'string') {
432
+ if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
433
+ return v;
434
+ return Number(v);
435
+ } return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
436
+ z.record(z.string(), z.unknown())
437
+ ]),
438
+ tieredBy: z.optional(z.array(z.string())),
439
+ minUnits: z.optional(z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
440
+ return undefined; if (Array.isArray(v))
441
+ return v; if (typeof v === 'string') {
442
+ if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
443
+ return v;
444
+ return Number(v);
445
+ } return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
446
+ effectiveFrom: z.string()
447
+ }).strict();
448
+ /**
449
+ * A generation model available to `prompt`-bearing image, video and audio assets, with the options it accepts and what it costs. Render a model picker and its option fields from this rather than hard coding a model list, so a newly launched model is available without a client release.
450
+ */
451
+ export const generationmodelGenerationModelSchema = z.object({
452
+ model: z.string(),
453
+ type: z.enum([
454
+ 'image',
455
+ 'video',
456
+ 'audio'
457
+ ]),
458
+ pricing: z.optional(generationmodelpricingGenerationModelPricingSchema),
459
+ options: z.optional(z.record(z.string(), z.unknown()))
460
+ }).strict();
416
461
  /**
417
462
  * The Html5Asset renders full HTML5/CSS3/JS.
418
463
  *
@@ -751,6 +796,12 @@ export const assetresponseAssetResponseSchema = z.object({
751
796
  data: assetresponsedataAssetResponseDataSchema
752
797
  }).strict();
753
798
  export const assetResponseSchema = assetresponseAssetResponseSchema;
799
+ /**
800
+ * The generation models available to this account.
801
+ */
802
+ export const generationmodellistresponseGenerationModelListResponseSchema = z.object({
803
+ models: z.array(generationmodelGenerationModelSchema)
804
+ }).strict();
754
805
  /**
755
806
  * The status of an on-demand asset generation job. Completed jobs include the public URL of the generated asset.
756
807
  */
@@ -2882,6 +2933,28 @@ export const getGenerateRequest = z.object({
2882
2933
  * The generation job has finished (done or failed).
2883
2934
  */
2884
2935
  export const getGenerateResponse = generationresponseGenerationResponseSchema;
2936
+ export const getModelsRequest = z.object({
2937
+ body: z.optional(z.never()),
2938
+ path: z.optional(z.never()),
2939
+ query: z.optional(z.object({
2940
+ expand: z.optional(z.enum(['options']))
2941
+ }))
2942
+ }).strict();
2943
+ /**
2944
+ * The available generation models.
2945
+ */
2946
+ export const getModelsResponse = generationmodellistresponseGenerationModelListResponseSchema;
2947
+ export const getModelRequest = z.object({
2948
+ body: z.optional(z.never()),
2949
+ path: z.object({
2950
+ id: z.string()
2951
+ }),
2952
+ query: z.optional(z.never())
2953
+ }).strict();
2954
+ /**
2955
+ * The generation model, with its option schema.
2956
+ */
2957
+ export const getModelResponse = generationmodelGenerationModelSchema;
2885
2958
  export const deleteAssetRequest = z.object({
2886
2959
  body: z.optional(z.never()),
2887
2960
  path: z.object({
@@ -16,6 +16,10 @@ export const generateRootSchema = z.unknown();
16
16
 
17
17
  export const generateidRootSchema = z.unknown();
18
18
 
19
+ export const modelsRootSchema = z.unknown();
20
+
21
+ export const modelsidRootSchema = z.unknown();
22
+
19
23
  export const probeRootSchema = z.unknown();
20
24
 
21
25
  export const renderRootSchema = z.unknown();
@@ -371,6 +375,39 @@ export const fontFontSchema = z.object({
371
375
 
372
376
  export const fontSchema = fontFontSchema;
373
377
 
378
+ /**
379
+ * What one generation costs, in credits. There is no formula to evaluate: multiply the rate by the number of units the generation consumes. Where a model charges differently per option value, `credits` is an object keyed by that value and `tieredBy` names the option that selects it.
380
+ */
381
+ export const generationmodelpricingGenerationModelPricingSchema = z.object({
382
+ unit: z.enum([
383
+ 'render',
384
+ 'second',
385
+ 'minute',
386
+ 'thousandCharacters'
387
+ ]),
388
+ credits: z.union([
389
+ z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
390
+ z.record(z.string(), z.unknown())
391
+ ]),
392
+ tieredBy: z.optional(z.array(z.string())),
393
+ minUnits: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
394
+ effectiveFrom: z.string()
395
+ }).strict();
396
+
397
+ /**
398
+ * A generation model available to `prompt`-bearing image, video and audio assets, with the options it accepts and what it costs. Render a model picker and its option fields from this rather than hard coding a model list, so a newly launched model is available without a client release.
399
+ */
400
+ export const generationmodelGenerationModelSchema = z.object({
401
+ model: z.string(),
402
+ type: z.enum([
403
+ 'image',
404
+ 'video',
405
+ 'audio'
406
+ ]),
407
+ pricing: z.optional(generationmodelpricingGenerationModelPricingSchema),
408
+ options: z.optional(z.record(z.string(), z.unknown()))
409
+ }).strict();
410
+
374
411
  /**
375
412
  * The Html5Asset renders full HTML5/CSS3/JS.
376
413
  *
@@ -711,6 +748,13 @@ export const assetresponseAssetResponseSchema = z.object({
711
748
 
712
749
  export const assetResponseSchema = assetresponseAssetResponseSchema;
713
750
 
751
+ /**
752
+ * The generation models available to this account.
753
+ */
754
+ export const generationmodellistresponseGenerationModelListResponseSchema = z.object({
755
+ models: z.array(generationmodelGenerationModelSchema)
756
+ }).strict();
757
+
714
758
  /**
715
759
  * The status of an on-demand asset generation job. Completed jobs include the public URL of the generated asset.
716
760
  */
@@ -2428,6 +2472,32 @@ export const getGenerateRequest = z.object({
2428
2472
  */
2429
2473
  export const getGenerateResponse = generationresponseGenerationResponseSchema;
2430
2474
 
2475
+ export const getModelsRequest = z.object({
2476
+ body: z.optional(z.never()),
2477
+ path: z.optional(z.never()),
2478
+ query: z.optional(z.object({
2479
+ expand: z.optional(z.enum(['options']))
2480
+ }))
2481
+ }).strict();
2482
+
2483
+ /**
2484
+ * The available generation models.
2485
+ */
2486
+ export const getModelsResponse = generationmodellistresponseGenerationModelListResponseSchema;
2487
+
2488
+ export const getModelRequest = z.object({
2489
+ body: z.optional(z.never()),
2490
+ path: z.object({
2491
+ id: z.string()
2492
+ }),
2493
+ query: z.optional(z.never())
2494
+ }).strict();
2495
+
2496
+ /**
2497
+ * The generation model, with its option schema.
2498
+ */
2499
+ export const getModelResponse = generationmodelGenerationModelSchema;
2500
+
2431
2501
  export const deleteAssetRequest = z.object({
2432
2502
  body: z.optional(z.never()),
2433
2503
  path: z.object({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shotstack/schemas",
3
- "version": "1.17.0",
3
+ "version": "1.18.0",
4
4
  "description": "Centralized OpenAPI schemas and TypeScript types for Shotstack API",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",