addedInput schema / $defs
Added value: +{
+ "actions": {
+ "description": "The orders to place, one per media. Maximum 1000 per request, and the\nrequest body must stay under 2 MB -- whichever limit is reached first. An\noversized body is rejected with a `413` and no order in it is placed.\n\nEvery order is priced and placed independently: one failing (an\nineligible media, an account without a saved card, a language that\nalready has a localization) does not stop the rest of the batch.\n\nUse `job` instead to order for a whole folder, channel, or account.\n",
+ "items": {
+ "description": "A single paid order within a bulk purchase request.",
+ "properties": {
+ "id": {
+ "description": "The hashed ID of the media to order for. Always the media's own ID: what\nthe order produces does not exist yet.\n",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Always `purchase`. This endpoint places orders only; to create, update,\nor delete records in bulk use the Create Bulk Actions endpoint, which\ndoes not accept `purchase`.\n",
+ "enum": [
+ "purchase"
+ ],
+ "type": "string"
+ },
+ "payload": {
+ "description": "Order options. The accepted fields depend on the resource type and match\nthe corresponding single-media endpoint's request body. Omit it to take\nevery default.\n\n`captions` accepts `automated` (order computer-generated captions\ninstead of human-reviewed ones), `rush` (one business day turnaround\ninstead of four, human-reviewed only, at a higher per-minute rate), and\n`automatically_enable` (show the captions on the video as soon as they\nare ready). Each is treated as `false` when omitted or unrecognized.\nWhat each option costs depends on the account's plan and billing\nsettings.\n\n`localization` requires `output_language`, a 3-character IETF language\ncode, and accepts `auto_enable` (default `true`).\n\n`extended_audio_description` accepts `enabled` (default `true`),\n`ai_enabled` (default `true`), `ietf_language_tag` (default `eng`), and\n`order_instructions`.\n\n`text_translation` requires `target_language` and accepts\n`source_language` (which transcript to translate from, defaulting to the\nmedia's own language). Use the bibliographic ISO 639-2 form or a\nsupported regional or script IETF tag for either value.\n",
+ "type": "object",
+ "unevaluatedProperties": true
+ },
+ "resource_type": {
+ "$ref": "#/$defs/resource_type"
+ }
+ },
+ "required": [
+ "operation",
+ "resource_type",
+ "id"
+ ],
+ "type": "object",
+ "unevaluatedProperties": false
+ },
+ "maxItems": 1000,
+ "minItems": 1,
+ "type": "array"
+ },
+ "job": {
+ "description": "One order placed for many media, named by a parent (`scope`) or listed\nexplicitly (`ids`), so ordering captions for a folder of 47 videos takes one\njob rather than 47 orders.\n\nA `scope` resolves to exactly what List Media returns for that parent,\nincluding media in the folder's subfolders and **archived** media, and to at\nmost 5000 media -- beyond that the job is rejected rather than truncated.\n\nThe job attempts one order for every media it resolves to. Ineligible media\nfail individually without placing an order; successful orders are metered\nand may incur charges according to the account's plan. Confirm the scope and\npotential cost with the customer before submitting. Not available to external\ncontacts.\n",
+ "properties": {
+ "ids": {
+ "description": "The media to order for, named explicitly. Use this instead of `scope`\nwhen the media do not share a parent. Give either `scope` or `ids`, never\nboth.\n",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 1000,
+ "minItems": 1,
+ "type": "array"
+ },
+ "operation": {
+ "description": "Always `purchase`.",
+ "enum": [
+ "purchase"
+ ],
+ "type": "string"
+ },
+ "payload": {
+ "description": "Order options applied to every matching media, in the same shape a single\norder's payload takes for this resource type.\n",
+ "type": "object",
+ "unevaluatedProperties": true
+ },
+ "resource_type": {
+ "$ref": "#/$defs/resource_type"
+ },
+ "scope": {
+ "description": "The parent whose media the order applies to. An order always addresses the\nmedia, so the valid parent types are the same for every resource type here.\n",
+ "properties": {
+ "id": {
+ "description": "The parent's hashed ID. Required for every scope type except `account`.\n",
+ "type": "string"
+ },
+ "type": {
+ "description": "The kind of parent `id` names. Required, because a hashed ID does not say\nwhat it belongs to -- the same value could name a folder or a channel.\nUse `account` to order for every media in the account.\n",
+ "enum": [
+ "account",
+ "folder",
+ "subfolder",
+ "channel"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "unevaluatedProperties": false
+ }
+ },
+ "required": [
+ "operation",
+ "resource_type"
+ ],
+ "type": "object",
+ "unevaluatedProperties": false
+ },
+ "resource_type": {
+ "description": "What to order for the media.\n\n`captions` orders Wistia-generated English captions -- computer-generated\nor human-reviewed. `localization` orders a dubbed, language-specific\nversion of the media. `extended_audio_description` orders an extended\naudio description track. `text_translation` translates the media's\nexisting transcript into another language, leaving the audio alone.\n",
+ "enum": [
+ "captions",
+ "localization",
+ "extended_audio_description",
+ "text_translation"
+ ],
+ "type": "string"
+ }
+}
addedInput schema / properties / actions / $ref
Added value: +"#/$defs/actions"
removedInput schema / properties / actions / description
Removed value: -"The orders to place, one per media. Maximum 1000 per request, and the\nrequest body must stay under 2 MB -- whichever limit is reached first. An\noversized body is rejected with a `413` and no order in it is placed.\n\nEvery order is priced and placed independently: one failing (an\nineligible media, an account without a saved card, a language that\nalready has a localization) does not stop the rest of the batch.\n\nUse `job` instead to order for a whole folder, channel, or account.\n"
removedInput schema / properties / actions / items
Removed value: -{
- "description": "A single paid order within a bulk purchase request.",
- "properties": {
- "id": {
- "description": "The hashed ID of the media to order for. Always the media's own ID: what\nthe order produces does not exist yet.\n",
- "type": "string"
- },
- "operation": {
- "description": "Always `purchase`. This endpoint places orders only; to create, update,\nor delete records in bulk use the Create Bulk Actions endpoint, which\ndoes not accept `purchase`.\n",
- "enum": [
- "purchase"
- ],
- "type": "string"
- },
- "payload": {
- "description": "Order options. The accepted fields depend on the resource type and match\nthe corresponding single-media endpoint's request body. Omit it to take\nevery default.\n\n`captions` accepts `automated` (order computer-generated captions\ninstead of human-reviewed ones), `rush` (one business day turnaround\ninstead of four, human-reviewed only, at a higher per-minute rate), and\n`automatically_enable` (show the captions on the video as soon as they\nare ready). Each is treated as `false` when omitted or unrecognized.\nWhat each option costs depends on the account's plan and billing\nsettings.\n\n`localization` requires `output_language`, a 3-character IETF language\ncode, and accepts `auto_enable` (default `true`).\n\n`extended_audio_description` accepts `enabled` (default `true`),\n`ai_enabled` (default `true`), `ietf_language_tag` (default `eng`), and\n`order_instructions`.\n\n`text_translation` requires `target_language` and accepts\n`source_language` (which transcript to translate from, defaulting to the\nmedia's own language). Use the bibliographic ISO 639-2 form or a\nsupported regional or script IETF tag for either value.\n",
- "type": "object",
- "unevaluatedProperties": true
- },
- "resource_type": {
- "description": "What to order for the media.\n\n`captions` orders Wistia-generated English captions -- computer-generated\nor human-reviewed. `localization` orders a dubbed, language-specific\nversion of the media. `extended_audio_description` orders an extended\naudio description track. `text_translation` translates the media's\nexisting transcript into another language, leaving the audio alone.\n",
- "enum": [
- "captions",
- "localization",
- "extended_audio_description",
- "text_translation"
- ],
- "type": "string"
- }
- },
- "required": [
- "operation",
- "resource_type",
- "id"
- ],
- "type": "object",
- "unevaluatedProperties": false
-}
removedInput schema / properties / actions / maxItems
Removed value: -1000
removedInput schema / properties / actions / minItems
Removed value: -1
removedInput schema / properties / actions / type
Removed value: -"array"
changedInput schema / properties / confirm / description
Previous value: -"Must be true for the specific user-requested write."New value: +"Set true only when the user asked for exactly this action."
addedInput schema / properties / job / $ref
Added value: +"#/$defs/job"
removedInput schema / properties / job / description
Removed value: -"One order placed for many media, named by a parent (`scope`) or listed\nexplicitly (`ids`), so ordering captions for a folder of 47 videos takes one\njob rather than 47 orders.\n\nA `scope` resolves to exactly what List Media returns for that parent,\nincluding media in the folder's subfolders and **archived** media, and to at\nmost 5000 media -- beyond that the job is rejected rather than truncated.\n\nThe job attempts one order for every media it resolves to. Ineligible media\nfail individually without placing an order; successful orders are metered\nand may incur charges according to the account's plan. Confirm the scope and\npotential cost with the customer before submitting. Not available to external\ncontacts.\n"
removedInput schema / properties / job / properties
Removed value: -{
- "ids": {
- "description": "The media to order for, named explicitly. Use this instead of `scope`\nwhen the media do not share a parent. Give either `scope` or `ids`, never\nboth.\n",
- "items": {
- "type": "string"
- },
- "maxItems": 1000,
- "minItems": 1,
- "type": "array"
- },
- "operation": {
- "description": "Always `purchase`.",
- "enum": [
- "purchase"
- ],
- "type": "string"
- },
- "payload": {
- "description": "Order options applied to every matching media, in the same shape a single\norder's payload takes for this resource type.\n",
- "type": "object",
- "unevaluatedProperties": true
- },
- "resource_type": {
- "description": "What to order for the media.\n\n`captions` orders Wistia-generated English captions -- computer-generated\nor human-reviewed. `localization` orders a dubbed, language-specific\nversion of the media. `extended_audio_description` orders an extended\naudio description track. `text_translation` translates the media's\nexisting transcript into another language, leaving the audio alone.\n",
- "enum": [
- "captions",
- "localization",
- "extended_audio_description",
- "text_translation"
- ],
- "type": "string"
- },
- "scope": {
- "description": "The parent whose media the order applies to. An order always addresses the\nmedia, so the valid parent types are the same for every resource type here.\n",
- "properties": {
- "id": {
- "description": "The parent's hashed ID. Required for every scope type except `account`.\n",
- "type": "string"
- },
- "type": {
- "description": "The kind of parent `id` names. Required, because a hashed ID does not say\nwhat it belongs to -- the same value could name a folder or a channel.\nUse `account` to order for every media in the account.\n",
- "enum": [
- "account",
- "folder",
- "subfolder",
- "channel"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object",
- "unevaluatedProperties": false
- }
-}
removedInput schema / properties / job / required
Removed value: -[
- "operation",
- "resource_type"
-]
removedInput schema / properties / job / type
Removed value: -"object"
removedInput schema / properties / job / unevaluatedProperties
Removed value: -false
addedInput schema / properties / payload / properties / actions / $ref
Added value: +"#/$defs/actions"
removedInput schema / properties / payload / properties / actions / description
Removed value: -"The orders to place, one per media. Maximum 1000 per request, and the\nrequest body must stay under 2 MB -- whichever limit is reached first. An\noversized body is rejected with a `413` and no order in it is placed.\n\nEvery order is priced and placed independently: one failing (an\nineligible media, an account without a saved card, a language that\nalready has a localization) does not stop the rest of the batch.\n\nUse `job` instead to order for a whole folder, channel, or account.\n"
removedInput schema / properties / payload / properties / actions / items
Removed value: -{
- "description": "A single paid order within a bulk purchase request.",
- "properties": {
- "id": {
- "description": "The hashed ID of the media to order for. Always the media's own ID: what\nthe order produces does not exist yet.\n",
- "type": "string"
- },
- "operation": {
- "description": "Always `purchase`. This endpoint places orders only; to create, update,\nor delete records in bulk use the Create Bulk Actions endpoint, which\ndoes not accept `purchase`.\n",
- "enum": [
- "purchase"
- ],
- "type": "string"
- },
- "payload": {
- "description": "Order options. The accepted fields depend on the resource type and match\nthe corresponding single-media endpoint's request body. Omit it to take\nevery default.\n\n`captions` accepts `automated` (order computer-generated captions\ninstead of human-reviewed ones), `rush` (one business day turnaround\ninstead of four, human-reviewed only, at a higher per-minute rate), and\n`automatically_enable` (show the captions on the video as soon as they\nare ready). Each is treated as `false` when omitted or unrecognized.\nWhat each option costs depends on the account's plan and billing\nsettings.\n\n`localization` requires `output_language`, a 3-character IETF language\ncode, and accepts `auto_enable` (default `true`).\n\n`extended_audio_description` accepts `enabled` (default `true`),\n`ai_enabled` (default `true`), `ietf_language_tag` (default `eng`), and\n`order_instructions`.\n\n`text_translation` requires `target_language` and accepts\n`source_language` (which transcript to translate from, defaulting to the\nmedia's own language). Use the bibliographic ISO 639-2 form or a\nsupported regional or script IETF tag for either value.\n",
- "type": "object",
- "unevaluatedProperties": true
- },
- "resource_type": {
- "description": "What to order for the media.\n\n`captions` orders Wistia-generated English captions -- computer-generated\nor human-reviewed. `localization` orders a dubbed, language-specific\nversion of the media. `extended_audio_description` orders an extended\naudio description track. `text_translation` translates the media's\nexisting transcript into another language, leaving the audio alone.\n",
- "enum": [
- "captions",
- "localization",
- "extended_audio_description",
- "text_translation"
- ],
- "type": "string"
- }
- },
- "required": [
- "operation",
- "resource_type",
- "id"
- ],
- "type": "object",
- "unevaluatedProperties": false
-}
removedInput schema / properties / payload / properties / actions / maxItems
Removed value: -1000
removedInput schema / properties / payload / properties / actions / minItems
Removed value: -1
removedInput schema / properties / payload / properties / actions / type
Removed value: -"array"
addedInput schema / properties / payload / properties / job / $ref
Added value: +"#/$defs/job"
removedInput schema / properties / payload / properties / job / description
Removed value: -"One order placed for many media, named by a parent (`scope`) or listed\nexplicitly (`ids`), so ordering captions for a folder of 47 videos takes one\njob rather than 47 orders.\n\nA `scope` resolves to exactly what List Media returns for that parent,\nincluding media in the folder's subfolders and **archived** media, and to at\nmost 5000 media -- beyond that the job is rejected rather than truncated.\n\nThe job attempts one order for every media it resolves to. Ineligible media\nfail individually without placing an order; successful orders are metered\nand may incur charges according to the account's plan. Confirm the scope and\npotential cost with the customer before submitting. Not available to external\ncontacts.\n"
removedInput schema / properties / payload / properties / job / properties
Removed value: -{
- "ids": {
- "description": "The media to order for, named explicitly. Use this instead of `scope`\nwhen the media do not share a parent. Give either `scope` or `ids`, never\nboth.\n",
- "items": {
- "type": "string"
- },
- "maxItems": 1000,
- "minItems": 1,
- "type": "array"
- },
- "operation": {
- "description": "Always `purchase`.",
- "enum": [
- "purchase"
- ],
- "type": "string"
- },
- "payload": {
- "description": "Order options applied to every matching media, in the same shape a single\norder's payload takes for this resource type.\n",
- "type": "object",
- "unevaluatedProperties": true
- },
- "resource_type": {
- "description": "What to order for the media.\n\n`captions` orders Wistia-generated English captions -- computer-generated\nor human-reviewed. `localization` orders a dubbed, language-specific\nversion of the media. `extended_audio_description` orders an extended\naudio description track. `text_translation` translates the media's\nexisting transcript into another language, leaving the audio alone.\n",
- "enum": [
- "captions",
- "localization",
- "extended_audio_description",
- "text_translation"
- ],
- "type": "string"
- },
- "scope": {
- "description": "The parent whose media the order applies to. An order always addresses the\nmedia, so the valid parent types are the same for every resource type here.\n",
- "properties": {
- "id": {
- "description": "The parent's hashed ID. Required for every scope type except `account`.\n",
- "type": "string"
- },
- "type": {
- "description": "The kind of parent `id` names. Required, because a hashed ID does not say\nwhat it belongs to -- the same value could name a folder or a channel.\nUse `account` to order for every media in the account.\n",
- "enum": [
- "account",
- "folder",
- "subfolder",
- "channel"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object",
- "unevaluatedProperties": false
- }
-}
removedInput schema / properties / payload / properties / job / required
Removed value: -[
- "operation",
- "resource_type"
-]
removedInput schema / properties / payload / properties / job / type
Removed value: -"object"
removedInput schema / properties / payload / properties / job / unevaluatedProperties
Removed value: -false