@shotstack/schemas 1.20.3 → 1.21.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.
package/dist/schema.d.ts CHANGED
@@ -2455,7 +2455,10 @@ export interface components {
2455
2455
  * @example tiktok
2456
2456
  */
2457
2457
  provider: string;
2458
- /** @description Additional TikTok configuration options. */
2458
+ /**
2459
+ * @deprecated
2460
+ * @description Additional TikTok configuration options.
2461
+ */
2459
2462
  options?: {
2460
2463
  /** @description A title for the video that will be displayed on TikTok. */
2461
2464
  title?: string;
@@ -2560,7 +2563,11 @@ export interface components {
2560
2563
  */
2561
2564
  exclude?: boolean;
2562
2565
  };
2563
- /** @description Send videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request. */
2566
+ /**
2567
+ * @deprecated
2568
+ * @description **Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.
2569
+ * Send videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.
2570
+ */
2564
2571
  MuxDestination: {
2565
2572
  /**
2566
2573
  * @description The destination to send video to - set to `mux` for Mux.
@@ -2571,7 +2578,11 @@ export interface components {
2571
2578
  /** @description Additional Mux configuration and features. */
2572
2579
  options?: components["schemas"]["MuxDestinationOptions"];
2573
2580
  };
2574
- /** @description Pass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options. */
2581
+ /**
2582
+ * @deprecated
2583
+ * @description **Notice: MuxDestinationOptions, like the Mux destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.
2584
+ * Pass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.
2585
+ */
2575
2586
  MuxDestinationOptions: {
2576
2587
  /** @description Sets the Mux `playback_policy` option. Value is an array of strings - use `public`, `signed`, or both. */
2577
2588
  playbackPolicy?: ("public" | "signed")[];
@@ -3501,7 +3512,7 @@ export interface components {
3501
3512
  */
3502
3513
  renderId?: string;
3503
3514
  /**
3504
- * @description The third party id of an asset transferred to an external provider, i.e. Mux, YouTube or S3. If the provider is Shotstack, the providerID is the same as the asset id.
3515
+ * @description The third party id of an asset transferred to an external provider, such as Vimeo or S3. If the provider is Shotstack, the providerID is the same as the asset id.
3505
3516
  * @example a4482cbf-e321-42a2-ac8b-947d26886840
3506
3517
  */
3507
3518
  providerId?: string;
@@ -290,7 +290,10 @@ exports.googleDriveDestinationGoogleDriveDestinationSchema = zod_1.z.object({
290
290
  }).strict();
291
291
  exports.googleDriveDestinationSchema = exports.googleDriveDestinationGoogleDriveDestinationSchema;
292
292
  /**
293
+ * **Notice: MuxDestinationOptions, like the Mux destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.
293
294
  * Pass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.
295
+ *
296
+ * @deprecated
294
297
  */
295
298
  exports.muxDestinationOptionsMuxDestinationOptionsSchema = zod_1.z.object({
296
299
  playbackPolicy: zod_1.z.optional(zod_1.z.array(zod_1.z.enum(['public', 'signed']))),
@@ -298,7 +301,10 @@ exports.muxDestinationOptionsMuxDestinationOptionsSchema = zod_1.z.object({
298
301
  }).strict();
299
302
  exports.muxDestinationOptionsSchema = exports.muxDestinationOptionsMuxDestinationOptionsSchema;
300
303
  /**
304
+ * **Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.
301
305
  * Send videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.
306
+ *
307
+ * @deprecated
302
308
  */
303
309
  exports.muxDestinationMuxDestinationSchema = zod_1.z.object({
304
310
  provider: zod_1.z.literal("mux"),
@@ -333,7 +339,10 @@ exports.shotstackDestinationShotstackDestinationSchema = zod_1.z.object({
333
339
  }).strict();
334
340
  exports.shotstackDestinationSchema = exports.shotstackDestinationShotstackDestinationSchema;
335
341
  /**
342
+ * **Notice: TiktokDestinationOptions, like the TikTok destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.
336
343
  * Pass additional options to control how TikTok publishes video.
344
+ *
345
+ * @deprecated
337
346
  */
338
347
  exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema = zod_1.z.object({
339
348
  title: zod_1.z.optional(zod_1.z.string().max(150)),
@@ -347,7 +356,10 @@ exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema = zod_1.z.object(
347
356
  disableComment: zod_1.z.optional(zod_1.z.boolean()).default(false)
348
357
  }).strict();
349
358
  /**
359
+ * **Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.
350
360
  * Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.
361
+ *
362
+ * @deprecated
351
363
  */
352
364
  exports.tiktokDestinationTiktokDestinationSchema = zod_1.z.object({
353
365
  provider: zod_1.z.literal("tiktok"),
@@ -269,7 +269,10 @@ export declare const googleDriveDestinationSchema: z.ZodObject<{
269
269
  }, z.core.$strict>>;
270
270
  }, z.core.$strict>;
271
271
  /**
272
+ * **Notice: MuxDestinationOptions, like the Mux destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.
272
273
  * Pass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.
274
+ *
275
+ * @deprecated
273
276
  */
274
277
  export declare const muxDestinationOptionsMuxDestinationOptionsSchema: z.ZodObject<{
275
278
  playbackPolicy: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -286,7 +289,10 @@ export declare const muxDestinationOptionsSchema: z.ZodObject<{
286
289
  passthrough: z.ZodOptional<z.ZodString>;
287
290
  }, z.core.$strict>;
288
291
  /**
292
+ * **Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.
289
293
  * Send videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.
294
+ *
295
+ * @deprecated
290
296
  */
291
297
  export declare const muxDestinationMuxDestinationSchema: z.ZodObject<{
292
298
  provider: z.ZodLiteral<"mux">;
@@ -360,7 +366,10 @@ export declare const shotstackDestinationSchema: z.ZodObject<{
360
366
  exclude: z.ZodOptional<z.ZodBoolean>;
361
367
  }, z.core.$strict>;
362
368
  /**
369
+ * **Notice: TiktokDestinationOptions, like the TikTok destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.
363
370
  * Pass additional options to control how TikTok publishes video.
371
+ *
372
+ * @deprecated
364
373
  */
365
374
  export declare const tiktokDestinationOptionsTiktokDestinationOptionsSchema: z.ZodObject<{
366
375
  title: z.ZodOptional<z.ZodString>;
@@ -374,7 +383,10 @@ export declare const tiktokDestinationOptionsTiktokDestinationOptionsSchema: z.Z
374
383
  disableComment: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
375
384
  }, z.core.$strict>;
376
385
  /**
386
+ * **Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.
377
387
  * Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.
388
+ *
389
+ * @deprecated
378
390
  */
379
391
  export declare const tiktokDestinationTiktokDestinationSchema: z.ZodObject<{
380
392
  provider: z.ZodLiteral<"tiktok">;
@@ -281,7 +281,10 @@ export const googleDriveDestinationGoogleDriveDestinationSchema = z.object({
281
281
  }).strict();
282
282
  export const googleDriveDestinationSchema = googleDriveDestinationGoogleDriveDestinationSchema;
283
283
  /**
284
+ * **Notice: MuxDestinationOptions, like the Mux destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.
284
285
  * Pass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.
286
+ *
287
+ * @deprecated
285
288
  */
286
289
  export const muxDestinationOptionsMuxDestinationOptionsSchema = z.object({
287
290
  playbackPolicy: z.optional(z.array(z.enum(['public', 'signed']))),
@@ -289,7 +292,10 @@ export const muxDestinationOptionsMuxDestinationOptionsSchema = z.object({
289
292
  }).strict();
290
293
  export const muxDestinationOptionsSchema = muxDestinationOptionsMuxDestinationOptionsSchema;
291
294
  /**
295
+ * **Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.
292
296
  * Send videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.
297
+ *
298
+ * @deprecated
293
299
  */
294
300
  export const muxDestinationMuxDestinationSchema = z.object({
295
301
  provider: z.literal("mux"),
@@ -324,7 +330,10 @@ export const shotstackDestinationShotstackDestinationSchema = z.object({
324
330
  }).strict();
325
331
  export const shotstackDestinationSchema = shotstackDestinationShotstackDestinationSchema;
326
332
  /**
333
+ * **Notice: TiktokDestinationOptions, like the TikTok destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.
327
334
  * Pass additional options to control how TikTok publishes video.
335
+ *
336
+ * @deprecated
328
337
  */
329
338
  export const tiktokDestinationOptionsTiktokDestinationOptionsSchema = z.object({
330
339
  title: z.optional(z.string().max(150)),
@@ -338,7 +347,10 @@ export const tiktokDestinationOptionsTiktokDestinationOptionsSchema = z.object({
338
347
  disableComment: z.optional(z.boolean()).default(false)
339
348
  }).strict();
340
349
  /**
350
+ * **Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.
341
351
  * Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.
352
+ *
353
+ * @deprecated
342
354
  */
343
355
  export const tiktokDestinationTiktokDestinationSchema = z.object({
344
356
  provider: z.literal("tiktok"),
@@ -217,7 +217,10 @@ export const googleDriveDestinationGoogleDriveDestinationSchema = z.object({
217
217
  export const googleDriveDestinationSchema = googleDriveDestinationGoogleDriveDestinationSchema;
218
218
 
219
219
  /**
220
+ * **Notice: MuxDestinationOptions, like the Mux destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.
220
221
  * Pass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.
222
+ *
223
+ * @deprecated
221
224
  */
222
225
  export const muxDestinationOptionsMuxDestinationOptionsSchema = z.object({
223
226
  playbackPolicy: z.optional(z.array(z.enum(['public', 'signed']))),
@@ -227,7 +230,10 @@ export const muxDestinationOptionsMuxDestinationOptionsSchema = z.object({
227
230
  export const muxDestinationOptionsSchema = muxDestinationOptionsMuxDestinationOptionsSchema;
228
231
 
229
232
  /**
233
+ * **Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.
230
234
  * Send videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.
235
+ *
236
+ * @deprecated
231
237
  */
232
238
  export const muxDestinationMuxDestinationSchema = z.object({
233
239
  provider: z.literal("mux"),
@@ -270,7 +276,10 @@ export const shotstackDestinationShotstackDestinationSchema = z.object({
270
276
  export const shotstackDestinationSchema = shotstackDestinationShotstackDestinationSchema;
271
277
 
272
278
  /**
279
+ * **Notice: TiktokDestinationOptions, like the TikTok destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.
273
280
  * Pass additional options to control how TikTok publishes video.
281
+ *
282
+ * @deprecated
274
283
  */
275
284
  export const tiktokDestinationOptionsTiktokDestinationOptionsSchema = z.object({
276
285
  title: z.optional(z.string().max(150)),
@@ -285,7 +294,10 @@ export const tiktokDestinationOptionsTiktokDestinationOptionsSchema = z.object({
285
294
  }).strict();
286
295
 
287
296
  /**
297
+ * **Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.
288
298
  * Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.
299
+ *
300
+ * @deprecated
289
301
  */
290
302
  export const tiktokDestinationTiktokDestinationSchema = z.object({
291
303
  provider: z.literal("tiktok"),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shotstack/schemas",
3
- "version": "1.20.3",
3
+ "version": "1.21.0",
4
4
  "description": "Centralized OpenAPI schemas and TypeScript types for Shotstack API",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",