@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.
@@ -53,7 +53,7 @@
53
53
  },
54
54
  {
55
55
  "name": "Serve",
56
- "description": "Assets generated by the Edit API or uploaded via the Ingest API are sent to the Serve API. The Serve API includes a simple hosting service with a CDN or you can send assets to third party services like AWS S3 or Mux. The Serve API includes endpoints to look up assets, where they are hosted and their status."
56
+ "description": "Assets generated by the Edit API or uploaded via the Ingest API are sent to the Serve API. The Serve API includes a simple hosting service with a CDN or you can send assets to third party services like AWS S3 or Google Cloud Storage. The Serve API includes endpoints to look up assets, where they are hosted and their status."
57
57
  },
58
58
  {
59
59
  "name": "Ingest",
@@ -4374,7 +4374,8 @@
4374
4374
  "$ref": "#/components/schemas/VimeoDestination"
4375
4375
  },
4376
4376
  {
4377
- "description": "Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.",
4377
+ "deprecated": true,
4378
+ "description": "**Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.",
4378
4379
  "properties": {
4379
4380
  "provider": {
4380
4381
  "description": "The destination to send video to - set to `tiktok` for TikTok.",
@@ -4384,6 +4385,7 @@
4384
4385
  },
4385
4386
  "options": {
4386
4387
  "description": "Additional TikTok configuration options.",
4388
+ "deprecated": true,
4387
4389
  "properties": {
4388
4390
  "title": {
4389
4391
  "description": "A title for the video that will be displayed on TikTok.",
@@ -4540,7 +4542,8 @@
4540
4542
  ]
4541
4543
  },
4542
4544
  "MuxDestination": {
4543
- "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.",
4545
+ "deprecated": true,
4546
+ "description": "**Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend 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.",
4544
4547
  "properties": {
4545
4548
  "provider": {
4546
4549
  "description": "The destination to send video to - set to `mux` for Mux.",
@@ -4559,7 +4562,8 @@
4559
4562
  ]
4560
4563
  },
4561
4564
  "MuxDestinationOptions": {
4562
- "description": "Pass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.",
4565
+ "deprecated": true,
4566
+ "description": "**Notice: MuxDestinationOptions, like the Mux destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.\nPass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.",
4563
4567
  "properties": {
4564
4568
  "playbackPolicy": {
4565
4569
  "description": "Sets the Mux `playback_policy` option. Value is an array of strings - use `public`, `signed`, or both.",
@@ -5894,7 +5898,7 @@
5894
5898
  "example": "2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7"
5895
5899
  },
5896
5900
  "providerId": {
5897
- "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.",
5901
+ "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.",
5898
5902
  "type": "string",
5899
5903
  "example": "a4482cbf-e321-42a2-ac8b-947d26886840"
5900
5904
  },
@@ -679,7 +679,8 @@
679
679
  "$ref": "#/$defs/VimeoDestination"
680
680
  },
681
681
  {
682
- "description": "Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.",
682
+ "deprecated": true,
683
+ "description": "**Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.",
683
684
  "properties": {
684
685
  "provider": {
685
686
  "description": "The destination to send video to - set to `tiktok` for TikTok.",
@@ -691,6 +692,7 @@
691
692
  },
692
693
  "options": {
693
694
  "description": "Additional TikTok configuration options.",
695
+ "deprecated": true,
694
696
  "properties": {
695
697
  "title": {
696
698
  "description": "A title for the video that will be displayed on TikTok.",
@@ -1271,7 +1273,8 @@
1271
1273
  ]
1272
1274
  },
1273
1275
  "MuxDestination": {
1274
- "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.",
1276
+ "deprecated": true,
1277
+ "description": "**Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend 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.",
1275
1278
  "properties": {
1276
1279
  "provider": {
1277
1280
  "description": "The destination to send video to - set to `mux` for Mux.",
@@ -1292,7 +1295,8 @@
1292
1295
  ]
1293
1296
  },
1294
1297
  "MuxDestinationOptions": {
1295
- "description": "Pass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.",
1298
+ "deprecated": true,
1299
+ "description": "**Notice: MuxDestinationOptions, like the Mux destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.\nPass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.",
1296
1300
  "properties": {
1297
1301
  "playbackPolicy": {
1298
1302
  "description": "Sets the Mux `playback_policy` option. Value is an array of strings - use `public`, `signed`, or both.",