From 2c0c050e30f11a6887025affa82c96cd81cec9af Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sun, 25 Oct 2026 13:29:50 +0100 Subject: [PATCH] Update App Store Connect OpenAPI specification document to v4.5.1 of the API in the service target. --- Sources/ASConnectService/openapi.json | 9887 ++++++++++++++++++++++++- 1 file changed, 9830 insertions(+), 57 deletions(-) diff --git a/Sources/ASConnectService/openapi.json b/Sources/ASConnectService/openapi.json index 39de26d49a..8155521033 100644 --- a/Sources/ASConnectService/openapi.json +++ b/Sources/ASConnectService/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "App Store Connect API", - "version": "4.5", + "version": "4.5.1", "x-platforms": { "app_store_connect_api": "App Store Connect API" } @@ -3019,6 +3019,1800 @@ } ] }, + "/v1/appAssetLibraries/{id}": { + "get": { + "tags": [ + "AppAssetLibraries" + ], + "operationId": "appAssetLibraries_getInstance", + "parameters": [ + { + "name": "fields[appAssetLibraries]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraries", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "images", + "videos" + ] + } + }, + "style": "form", + "explode": false, + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single AppAssetLibrary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraryImages": { + "post": { + "tags": [ + "AppAssetLibraryImages" + ], + "operationId": "appAssetLibraryImages_createInstance", + "requestBody": { + "description": "AppAssetLibraryImage representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryImageCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Single AppAssetLibraryImage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryImageResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/appAssetLibraryImages/{id}": { + "get": { + "tags": [ + "AppAssetLibraryImages" + ], + "operationId": "appAssetLibraryImages_getInstance", + "parameters": [ + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "placements" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single AppAssetLibraryImage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryImageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "patch": { + "tags": [ + "AppAssetLibraryImages" + ], + "operationId": "appAssetLibraryImages_updateInstance", + "requestBody": { + "description": "AppAssetLibraryImage representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryImageUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single AppAssetLibraryImage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryImageResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "AppAssetLibraryImages" + ], + "operationId": "appAssetLibraryImages_deleteInstance", + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "Success (no content)" + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraryPlacementOrderingRequests": { + "post": { + "tags": [ + "AppAssetLibraryPlacementOrderingRequests" + ], + "operationId": "appAssetLibraryPlacementOrderingRequests_createInstance", + "parameters": [ + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "orderedPlacements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[orderedPlacements]", + "in": "query", + "description": "maximum number of related orderedPlacements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "fields[appAssetLibraryPlacementOrderingRequests]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacementOrderingRequests", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "orderedPlacements" + ] + } + }, + "style": "form", + "explode": false + } + ], + "requestBody": { + "description": "AppAssetLibraryPlacementOrderingRequest representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementOrderingRequestCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Single AppAssetLibraryPlacementOrderingRequest", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementOrderingRequestResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/appAssetLibraryPlacements": { + "post": { + "tags": [ + "AppAssetLibraryPlacements" + ], + "operationId": "appAssetLibraryPlacements_createInstance", + "requestBody": { + "description": "AppAssetLibraryPlacement representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Single AppAssetLibraryPlacement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/appAssetLibraryPlacements/{id}": { + "get": { + "tags": [ + "AppAssetLibraryPlacements" + ], + "operationId": "appAssetLibraryPlacements_getInstance", + "parameters": [ + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[appEventLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false, + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single AppAssetLibraryPlacement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "AppAssetLibraryPlacements" + ], + "operationId": "appAssetLibraryPlacements_deleteInstance", + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "Success (no content)" + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraryRefData": { + "get": { + "tags": [ + "AppAssetLibraryRefData" + ], + "operationId": "appAssetLibraryRefData_getCollection", + "parameters": [ + { + "name": "filter[placementTypes]", + "in": "query", + "description": "filter by attribute 'placementTypes'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "filter[placementProfileGroups]", + "in": "query", + "description": "filter by attribute 'placementProfileGroups'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "filter[features]", + "in": "query", + "description": "filter by attribute 'features'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "filter[specs]", + "in": "query", + "description": "filter by specs", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[appAssetLibraryRefData]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryRefData", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "features", + "placementProfileGroups", + "imageSpecs", + "videoSpecs", + "placementTypes", + "displayClasses" + ] + } + }, + "style": "form", + "explode": false, + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of AppAssetLibraryRefData", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryRefDataResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/appAssetLibraryRefData/{id}": { + "get": { + "tags": [ + "AppAssetLibraryRefData" + ], + "operationId": "appAssetLibraryRefData_getInstance", + "parameters": [ + { + "name": "fields[appAssetLibraryRefData]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryRefData", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "features", + "placementProfileGroups", + "imageSpecs", + "videoSpecs", + "placementTypes", + "displayClasses" + ] + } + }, + "style": "form", + "explode": false, + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single AppAssetLibraryRefDatum", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryRefDatumResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraryVideos": { + "post": { + "tags": [ + "AppAssetLibraryVideos" + ], + "operationId": "appAssetLibraryVideos_createInstance", + "requestBody": { + "description": "AppAssetLibraryVideo representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryVideoCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Single AppAssetLibraryVideo", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryVideoResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/appAssetLibraryVideos/{id}": { + "get": { + "tags": [ + "AppAssetLibraryVideos" + ], + "operationId": "appAssetLibraryVideos_getInstance", + "parameters": [ + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "placements" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single AppAssetLibraryVideo", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryVideoResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "patch": { + "tags": [ + "AppAssetLibraryVideos" + ], + "operationId": "appAssetLibraryVideos_updateInstance", + "requestBody": { + "description": "AppAssetLibraryVideo representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryVideoUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single AppAssetLibraryVideo", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryVideoResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "AppAssetLibraryVideos" + ], + "operationId": "appAssetLibraryVideos_deleteInstance", + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "Success (no content)" + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, "/v2/appAvailabilities": { "post": { "tags": [ @@ -5948,6 +7742,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -6199,7 +7994,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -6270,6 +8066,35 @@ "explode": false, "required": false }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, { "name": "include", "in": "query", @@ -6282,7 +8107,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -6312,6 +8138,17 @@ "style": "form", "required": false }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, { "name": "limit[searchKeywords]", "in": "query", @@ -6714,7 +8551,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -7106,6 +8944,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -7851,6 +9690,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -8214,6 +10054,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -8513,7 +10354,8 @@ "longDescription", "appEvent", "appEventScreenshots", - "appEventVideoClips" + "appEventVideoClips", + "placements" ] } }, @@ -8599,6 +10441,35 @@ "explode": false, "required": false }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, { "name": "include", "in": "query", @@ -8610,7 +10481,8 @@ "enum": [ "appEvent", "appEventScreenshots", - "appEventVideoClips" + "appEventVideoClips", + "placements" ] } }, @@ -8639,6 +10511,17 @@ }, "style": "form", "required": false + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false } ], "responses": { @@ -9014,7 +10897,8 @@ "longDescription", "appEvent", "appEventScreenshots", - "appEventVideoClips" + "appEventVideoClips", + "placements" ] } }, @@ -9416,7 +11300,8 @@ "longDescription", "appEvent", "appEventScreenshots", - "appEventVideoClips" + "appEventVideoClips", + "placements" ] } }, @@ -9818,7 +11703,8 @@ "longDescription", "appEvent", "appEventScreenshots", - "appEventVideoClips" + "appEventVideoClips", + "placements" ] } }, @@ -10601,6 +12487,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -11051,7 +12938,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -11073,7 +12961,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -11093,7 +12982,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -11787,6 +13677,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -12089,6 +13980,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -12396,7 +14288,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -12418,7 +14311,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -12438,7 +14332,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -13939,7 +15834,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -14012,6 +15908,35 @@ "explode": false, "required": false }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, { "name": "include", "in": "query", @@ -14023,7 +15948,8 @@ "enum": [ "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -14052,6 +15978,17 @@ }, "style": "form", "required": false + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false } ], "responses": { @@ -14352,7 +16289,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -14812,6 +16750,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -15738,7 +17677,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -15828,6 +17768,35 @@ "explode": false, "required": false }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, { "name": "include", "in": "query", @@ -15840,7 +17809,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -15870,6 +17840,17 @@ "style": "form", "required": false }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, { "name": "limit[searchKeywords]", "in": "query", @@ -16839,6 +18820,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -16870,7 +18852,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -17806,6 +19789,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -18818,6 +20802,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -21128,6 +23113,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -22147,6 +24133,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -22420,6 +24407,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -22792,6 +24780,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -22978,6 +24967,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -25082,6 +27072,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -25475,6 +27466,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -25950,6 +27942,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -26129,6 +28122,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -27013,6 +29007,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -27398,6 +29393,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -29352,6 +31348,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -29917,6 +31914,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -30836,6 +32834,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -31178,6 +33177,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -33276,6 +35276,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -33523,6 +35524,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -35850,6 +37852,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -44288,6 +46291,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -59769,6 +61773,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -61965,6 +63970,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -62361,6 +64367,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -63618,6 +65625,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -63853,6 +65861,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -65514,6 +67523,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -65541,6 +67551,8 @@ "appStoreVersionExperiment", "appStoreVersionExperimentV2", "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", "backgroundAssetVersion", "gameCenterAchievementVersion", "gameCenterActivityVersion", @@ -65895,6 +67907,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -65922,6 +67935,8 @@ "appStoreVersionExperiment", "appStoreVersionExperimentV2", "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", "backgroundAssetVersion", "gameCenterAchievementVersion", "gameCenterActivityVersion", @@ -76078,6 +78093,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -76363,6 +78379,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -76708,6 +78725,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -76903,6 +78921,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -77542,6 +79561,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -79636,6 +81656,1842 @@ } ] }, + "/v1/appAssetLibraries/{id}/relationships/images": { + "get": { + "tags": [ + "AppAssetLibraries" + ], + "operationId": "appAssetLibraries_images_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryImagesLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraries/{id}/images": { + "get": { + "tags": [ + "AppAssetLibraries" + ], + "operationId": "appAssetLibraries_images_getToManyRelated", + "parameters": [ + { + "name": "filter[category]", + "in": "query", + "description": "filter by attribute 'category'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "CREATIVE_ASSETS", + "APP_SCREENSHOTS_AND_PREVIEWS" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "AWAITING_UPLOAD", + "UPLOAD_COMPLETE", + "FAILED", + "COMPLETE", + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "ACCEPTED", + "APPROVED", + "REJECTED", + "ARCHIVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[referenceName]", + "in": "query", + "description": "filter by attribute 'referenceName'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[specId]", + "in": "query", + "description": "filter by attribute 'specId'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "referenceName", + "-referenceName" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of AppAssetLibraryImages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryImagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraries/{id}/relationships/videos": { + "get": { + "tags": [ + "AppAssetLibraries" + ], + "operationId": "appAssetLibraries_videos_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryVideosLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraries/{id}/videos": { + "get": { + "tags": [ + "AppAssetLibraries" + ], + "operationId": "appAssetLibraries_videos_getToManyRelated", + "parameters": [ + { + "name": "filter[category]", + "in": "query", + "description": "filter by attribute 'category'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "CREATIVE_ASSETS", + "APP_SCREENSHOTS_AND_PREVIEWS" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "AWAITING_UPLOAD", + "UPLOAD_COMPLETE", + "FAILED", + "COMPLETE", + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "ACCEPTED", + "APPROVED", + "REJECTED", + "ARCHIVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[referenceName]", + "in": "query", + "description": "filter by attribute 'referenceName'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[specId]", + "in": "query", + "description": "filter by attribute 'specId'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "referenceName", + "-referenceName" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of AppAssetLibraryVideos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryVideosResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraryImages/{id}/relationships/placements": { + "get": { + "tags": [ + "AppAssetLibraryImages" + ], + "operationId": "appAssetLibraryImages_placements_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryImagePlacementsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraryImages/{id}/placements": { + "get": { + "tags": [ + "AppAssetLibraryImages" + ], + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "parameters": [ + { + "name": "filter[placementType]", + "in": "query", + "description": "filter by attribute 'placementType'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[placementGroup]", + "in": "query", + "description": "filter by attribute 'placementGroup'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[video]", + "in": "query", + "description": "filter by id(s) of related 'video'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appEventLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appEventLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appCustomProductPageLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "placementGroupPosition", + "-placementGroupPosition" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appEventLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of AppAssetLibraryPlacements", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraryVideos/{id}/relationships/placements": { + "get": { + "tags": [ + "AppAssetLibraryVideos" + ], + "operationId": "appAssetLibraryVideos_placements_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryVideoPlacementsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraryVideos/{id}/placements": { + "get": { + "tags": [ + "AppAssetLibraryVideos" + ], + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "parameters": [ + { + "name": "filter[placementType]", + "in": "query", + "description": "filter by attribute 'placementType'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[placementGroup]", + "in": "query", + "description": "filter by attribute 'placementGroup'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[image]", + "in": "query", + "description": "filter by id(s) of related 'image'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appEventLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appEventLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appCustomProductPageLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "placementGroupPosition", + "-placementGroupPosition" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appEventLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of AppAssetLibraryPlacements", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, "/v2/appAvailabilities/{id}/relationships/territoryAvailabilities": { "get": { "tags": [ @@ -81272,6 +85128,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -81302,7 +85159,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -82541,7 +86399,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -82562,7 +86421,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -82581,7 +86441,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -82945,7 +86806,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -82966,7 +86828,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -82985,7 +86848,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -83132,6 +86996,550 @@ } ] }, + "/v1/appCustomProductPageLocalizations/{id}/relationships/placements": { + "get": { + "tags": [ + "AppCustomProductPageLocalizations" + ], + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCustomProductPageLocalizationPlacementsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appCustomProductPageLocalizations/{id}/placements": { + "get": { + "tags": [ + "AppCustomProductPageLocalizations" + ], + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "parameters": [ + { + "name": "filter[placementType]", + "in": "query", + "description": "filter by attribute 'placementType'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[placementGroup]", + "in": "query", + "description": "filter by attribute 'placementGroup'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[image]", + "in": "query", + "description": "filter by id(s) of related 'image'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[video]", + "in": "query", + "description": "filter by id(s) of related 'video'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appEventLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appEventLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "placementGroupPosition", + "-placementGroupPosition" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appEventLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of AppAssetLibraryPlacements", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, "/v1/appCustomProductPageLocalizations/{id}/relationships/searchKeywords": { "get": { "tags": [ @@ -83671,7 +88079,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -83751,6 +88160,34 @@ "style": "form", "explode": false }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "limit", "in": "query", @@ -83773,7 +88210,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -83809,6 +88247,16 @@ "maximum": 50 }, "style": "form" + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -84065,7 +88513,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -84338,6 +88787,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -84861,7 +89311,8 @@ "longDescription", "appEvent", "appEventScreenshots", - "appEventVideoClips" + "appEventVideoClips", + "placements" ] } }, @@ -85113,7 +89564,8 @@ "longDescription", "appEvent", "appEventScreenshots", - "appEventVideoClips" + "appEventVideoClips", + "placements" ] } }, @@ -85223,6 +89675,550 @@ } ] }, + "/v1/appEventLocalizations/{id}/relationships/placements": { + "get": { + "tags": [ + "AppEventLocalizations" + ], + "operationId": "appEventLocalizations_placements_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppEventLocalizationPlacementsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appEventLocalizations/{id}/placements": { + "get": { + "tags": [ + "AppEventLocalizations" + ], + "operationId": "appEventLocalizations_placements_getToManyRelated", + "parameters": [ + { + "name": "filter[placementType]", + "in": "query", + "description": "filter by attribute 'placementType'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[placementGroup]", + "in": "query", + "description": "filter by attribute 'placementGroup'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[image]", + "in": "query", + "description": "filter by id(s) of related 'image'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[video]", + "in": "query", + "description": "filter by id(s) of related 'video'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appCustomProductPageLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "placementGroupPosition", + "-placementGroupPosition" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appEventLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of AppAssetLibraryPlacements", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, "/v1/appEvents/{id}/relationships/localizations": { "get": { "tags": [ @@ -85339,7 +90335,8 @@ "longDescription", "appEvent", "appEventScreenshots", - "appEventVideoClips" + "appEventVideoClips", + "placements" ] } }, @@ -85421,6 +90418,34 @@ "style": "form", "explode": false }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "limit", "in": "query", @@ -85442,7 +90467,8 @@ "enum": [ "appEvent", "appEventScreenshots", - "appEventVideoClips" + "appEventVideoClips", + "placements" ] } }, @@ -85468,6 +90494,16 @@ "maximum": 50 }, "style": "form" + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -88076,6 +93112,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -89782,7 +94819,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -89803,7 +94841,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -89822,7 +94861,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -90186,7 +95226,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -90207,7 +95248,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -90226,7 +95268,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -90373,6 +95416,550 @@ } ] }, + "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/relationships/placements": { + "get": { + "tags": [ + "AppStoreVersionExperimentTreatmentLocalizations" + ], + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalizationPlacementsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/placements": { + "get": { + "tags": [ + "AppStoreVersionExperimentTreatmentLocalizations" + ], + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "parameters": [ + { + "name": "filter[placementType]", + "in": "query", + "description": "filter by attribute 'placementType'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[placementGroup]", + "in": "query", + "description": "filter by attribute 'placementGroup'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[image]", + "in": "query", + "description": "filter by id(s) of related 'image'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[video]", + "in": "query", + "description": "filter by id(s) of related 'video'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appEventLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appEventLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appCustomProductPageLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "placementGroupPosition", + "-placementGroupPosition" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appEventLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of AppAssetLibraryPlacements", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, "/v1/appStoreVersionExperimentTreatments/{id}/relationships/appStoreVersionExperimentTreatmentLocalizations": { "get": { "tags": [ @@ -90499,7 +96086,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -90568,6 +96156,34 @@ "style": "form", "explode": false }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "limit", "in": "query", @@ -90589,7 +96205,8 @@ "enum": [ "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -90615,6 +96232,16 @@ "maximum": 50 }, "style": "form" + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -90855,7 +96482,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -91141,7 +96769,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -91460,7 +97089,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -91481,7 +97111,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -91500,7 +97131,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -91864,7 +97496,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -91885,7 +97518,8 @@ "appCustomProductPageVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -91904,7 +97538,8 @@ "locale", "appStoreVersionExperimentTreatment", "appScreenshotSets", - "appPreviewSets" + "appPreviewSets", + "placements" ] } }, @@ -92051,6 +97686,550 @@ } ] }, + "/v1/appStoreVersionLocalizations/{id}/relationships/placements": { + "get": { + "tags": [ + "AppStoreVersionLocalizations" + ], + "operationId": "appStoreVersionLocalizations_placements_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppStoreVersionLocalizationPlacementsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appStoreVersionLocalizations/{id}/placements": { + "get": { + "tags": [ + "AppStoreVersionLocalizations" + ], + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "parameters": [ + { + "name": "filter[placementType]", + "in": "query", + "description": "filter by attribute 'placementType'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[placementGroup]", + "in": "query", + "description": "filter by attribute 'placementGroup'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[image]", + "in": "query", + "description": "filter by id(s) of related 'image'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[video]", + "in": "query", + "description": "filter by id(s) of related 'video'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appEventLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appEventLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appCustomProductPageLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "placementGroupPosition", + "-placementGroupPosition" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appEventLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of AppAssetLibraryPlacements", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, "/v1/appStoreVersionLocalizations/{id}/relationships/searchKeywords": { "get": { "tags": [ @@ -93912,6 +100091,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -94243,7 +100423,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -94342,6 +100523,34 @@ "style": "form", "explode": false }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "limit", "in": "query", @@ -94364,7 +100573,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -94400,6 +100610,16 @@ "maximum": 50 }, "style": "form" + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -97800,6 +104020,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -98139,6 +104360,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -98510,6 +104732,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -98879,7 +105102,8 @@ "longDescription", "appEvent", "appEventScreenshots", - "appEventVideoClips" + "appEventVideoClips", + "placements" ] } }, @@ -99193,6 +105417,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -99604,6 +105829,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -99909,6 +106135,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -100283,6 +106510,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -100792,6 +107020,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -100822,7 +107051,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -101456,6 +107686,190 @@ } ] }, + "/v1/apps/{id}/relationships/assetLibrary": { + "get": { + "tags": [ + "Apps" + ], + "operationId": "apps_assetLibrary_getToOneRelationship", + "parameters": [], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryLinkageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/assetLibrary": { + "get": { + "tags": [ + "Apps" + ], + "operationId": "apps_assetLibrary_getToOneRelated", + "parameters": [ + { + "name": "fields[appAssetLibraries]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraries", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "images", + "videos" + ] + } + }, + "style": "form", + "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single AppAssetLibrary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, "/v1/apps/{id}/relationships/backgroundAssets": { "get": { "tags": [ @@ -101718,6 +108132,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -104410,6 +110825,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -105691,6 +112107,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -106532,6 +112949,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -106895,6 +113313,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -108814,6 +115233,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -108840,6 +115260,8 @@ "appStoreVersionExperiment", "appStoreVersionExperimentV2", "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", "backgroundAssetVersion", "gameCenterAchievementVersion", "gameCenterActivityVersion", @@ -110013,6 +116435,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -110967,6 +117390,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -111205,6 +117629,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -112042,6 +118467,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -113456,6 +119882,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -113800,6 +120227,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -115049,6 +121477,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -116540,6 +122969,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -117108,6 +123538,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -117138,7 +123569,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -119617,6 +126049,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -122193,6 +128626,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -123191,6 +129625,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -131198,6 +137633,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -131228,7 +137664,8 @@ "appStoreVersion", "appScreenshotSets", "appPreviewSets", - "searchKeywords" + "searchKeywords", + "placements" ] } }, @@ -140322,6 +146759,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -142524,6 +148962,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -159395,6 +165834,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -160439,6 +166879,8 @@ "appStoreVersionExperiment", "appStoreVersionExperimentV2", "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", "backgroundAssetVersion", "gameCenterAchievementVersion", "gameCenterActivityVersion", @@ -160566,6 +167008,62 @@ "style": "form", "explode": false }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "fields[backgroundAssetVersions]", "in": "query", @@ -160779,6 +167277,8 @@ "appStoreVersionExperiment", "appStoreVersionExperimentV2", "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", "backgroundAssetVersion", "gameCenterAchievementVersion", "gameCenterActivityVersion", @@ -169992,6 +176492,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -170527,6 +177028,7 @@ "marketplaceSearchDetail", "buildUploads", "backgroundAssets", + "assetLibrary", "betaFeedbackScreenshotSubmissions", "betaFeedbackCrashSubmissions", "searchKeywords", @@ -175880,6 +182382,2442 @@ "data" ] }, + "AppAssetLibrary": { + "type": "object", + "title": "AppAssetLibrary", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraries" + ] + }, + "id": { + "type": "string" + }, + "relationships": { + "type": "object", + "properties": { + "images": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + } + } + }, + "videos": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + } + } + } + } + }, + "links": { + "$ref": "#/components/schemas/ResourceLinks" + } + }, + "required": [ + "id", + "type" + ] + }, + "AppAssetLibraryResponse": { + "type": "object", + "title": "AppAssetLibraryResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAssetLibrary" + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryImage": { + "type": "object", + "title": "AppAssetLibraryImage", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryImages" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageAwaitingUploadAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageUploadCompleteAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageFailedAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageReadyForReviewAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageWaitingForReviewAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageInReviewAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageAcceptedAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageApprovedAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageRejectedAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryImageArchivedAttributes" + } + ], + "discriminator": { + "propertyName": "state", + "mapping": { + "UPLOAD_COMPLETE": "#/components/schemas/AppAssetLibraryImageUploadCompleteAttributes", + "COMPLETE": "#/components/schemas/AppAssetLibraryImageCommonAttributes", + "IN_REVIEW": "#/components/schemas/AppAssetLibraryImageInReviewAttributes", + "ACCEPTED": "#/components/schemas/AppAssetLibraryImageAcceptedAttributes", + "FAILED": "#/components/schemas/AppAssetLibraryImageFailedAttributes", + "AWAITING_UPLOAD": "#/components/schemas/AppAssetLibraryImageAwaitingUploadAttributes", + "PREPARE_FOR_SUBMISSION": "#/components/schemas/AppAssetLibraryImageCommonAttributes", + "READY_FOR_REVIEW": "#/components/schemas/AppAssetLibraryImageReadyForReviewAttributes", + "ARCHIVED": "#/components/schemas/AppAssetLibraryImageArchivedAttributes", + "APPROVED": "#/components/schemas/AppAssetLibraryImageApprovedAttributes", + "WAITING_FOR_REVIEW": "#/components/schemas/AppAssetLibraryImageWaitingForReviewAttributes", + "REJECTED": "#/components/schemas/AppAssetLibraryImageRejectedAttributes" + } + } + }, + "relationships": { + "type": "object", + "properties": { + "placements": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + } + }, + "links": { + "$ref": "#/components/schemas/ResourceLinks" + } + }, + "required": [ + "id", + "type" + ] + }, + "AppAssetLibraryImageCommonAttributes": { + "type": "object", + "title": "AppAssetLibraryImageCommonAttributes", + "properties": { + "category": { + "$ref": "#/components/schemas/AppAssetLibraryAssetCategory" + }, + "createdDate": { + "type": "string", + "format": "date-time" + }, + "lastModifiedDate": { + "type": "string", + "format": "date-time" + }, + "fileName": { + "type": "string" + }, + "fileSize": { + "type": "integer", + "format": "int64", + "maximum": 9007199254740991, + "minimum": 1 + }, + "imageAsset": { + "$ref": "#/components/schemas/ImageAsset" + }, + "referenceName": { + "type": "string" + }, + "specId": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/AppAssetLibraryAssetState" + }, + "stateDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateDetail" + } + } + }, + "required": [ + "state" + ] + }, + "AppAssetLibraryImageAcceptedAttributes": { + "title": "AppAssetLibraryImageAcceptedAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryImageApprovedAttributes": { + "title": "AppAssetLibraryImageApprovedAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryImageArchivedAttributes": { + "title": "AppAssetLibraryImageArchivedAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryImageAwaitingUploadAttributes": { + "title": "AppAssetLibraryImageAwaitingUploadAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "type": "object", + "properties": { + "uploadOperations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UploadOperation" + } + } + } + } + ] + }, + "AppAssetLibraryImageFailedAttributes": { + "title": "AppAssetLibraryImageFailedAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "type": "object", + "properties": { + "uploadOperations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UploadOperation" + } + } + } + } + ] + }, + "AppAssetLibraryImageInReviewAttributes": { + "title": "AppAssetLibraryImageInReviewAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryImageReadyForReviewAttributes": { + "title": "AppAssetLibraryImageReadyForReviewAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryImageRejectedAttributes": { + "title": "AppAssetLibraryImageRejectedAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryImageUploadCompleteAttributes": { + "title": "AppAssetLibraryImageUploadCompleteAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "type": "object", + "properties": { + "uploadOperations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UploadOperation" + } + } + } + } + ] + }, + "AppAssetLibraryImageWaitingForReviewAttributes": { + "title": "AppAssetLibraryImageWaitingForReviewAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImageCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryImagesResponse": { + "type": "object", + "title": "AppAssetLibraryImagesResponse", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryImage" + } + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryImageResponse": { + "type": "object", + "title": "AppAssetLibraryImageResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAssetLibraryImage" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + } + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryImageCreateRequest": { + "type": "object", + "title": "AppAssetLibraryImageCreateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryImages" + ] + }, + "attributes": { + "type": "object", + "properties": { + "category": { + "$ref": "#/components/schemas/AppAssetLibraryAssetCategory" + }, + "fileName": { + "type": "string" + }, + "fileSize": { + "type": "integer", + "format": "int64", + "maximum": 9007199254740991, + "minimum": 1 + }, + "referenceName": { + "type": "string", + "nullable": true + } + }, + "required": [ + "fileName", + "fileSize", + "category" + ] + }, + "relationships": { + "type": "object", + "properties": { + "assetLibrary": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraries" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "placements": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + }, + "required": [ + "assetLibrary" + ] + } + }, + "required": [ + "relationships", + "attributes", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "AppAssetLibraryImageUpdateRequest": { + "type": "object", + "title": "AppAssetLibraryImageUpdateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryImages" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "archived": { + "type": "boolean", + "nullable": true + }, + "referenceName": { + "type": "string", + "nullable": true + }, + "uploaded": { + "type": "boolean", + "nullable": true + } + } + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "AppAssetLibraryPlacementOrderingRequest": { + "type": "object", + "title": "AppAssetLibraryPlacementOrderingRequest", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacementOrderingRequests" + ] + }, + "id": { + "type": "string" + }, + "relationships": { + "type": "object", + "properties": { + "orderedPlacements": { + "type": "object", + "properties": { + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + } + }, + "links": { + "$ref": "#/components/schemas/ResourceLinks" + } + }, + "required": [ + "id", + "type" + ] + }, + "AppAssetLibraryPlacementOrderingRequestResponse": { + "type": "object", + "title": "AppAssetLibraryPlacementOrderingRequestResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementOrderingRequest" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + } + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryPlacementOrderingRequestCreateRequest": { + "type": "object", + "title": "AppAssetLibraryPlacementOrderingRequestCreateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacementOrderingRequests" + ] + }, + "attributes": { + "type": "object", + "properties": { + "placementGroup": { + "type": "string", + "nullable": true + } + } + }, + "relationships": { + "type": "object", + "properties": { + "orderedPlacements": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + }, + "appStoreVersionLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appStoreVersionLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appCustomProductPageLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appCustomProductPageLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appStoreVersionExperimentTreatmentLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appStoreVersionExperimentTreatmentLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + } + }, + "anyOf": [ + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementGroup" + ] + }, + "relationships": { + "type": "object", + "required": [ + "orderedPlacements", + "appStoreVersionLocalization" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + }, + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementGroup" + ] + }, + "relationships": { + "type": "object", + "required": [ + "orderedPlacements", + "appCustomProductPageLocalization" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + }, + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementGroup" + ] + }, + "relationships": { + "type": "object", + "required": [ + "orderedPlacements", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + } + ], + "required": [ + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "AppAssetLibraryPlacement": { + "type": "object", + "title": "AppAssetLibraryPlacement", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "mediaType": { + "$ref": "#/components/schemas/AppAssetLibraryMediaType" + }, + "placementType": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementType" + }, + "placementGroup": { + "type": "string" + }, + "createdDate": { + "type": "string", + "format": "date-time" + }, + "lastModifiedDate": { + "type": "string", + "format": "date-time" + }, + "state": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementState" + }, + "stateDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateDetail" + } + } + } + }, + "relationships": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacementImageRelationships" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryPlacementVideoRelationships" + } + ], + "discriminator": { + "propertyName": "mediaType", + "mapping": { + "IMAGE": "#/components/schemas/AppAssetLibraryPlacementImageRelationships", + "VIDEO": "#/components/schemas/AppAssetLibraryPlacementVideoRelationships" + } + } + }, + "links": { + "$ref": "#/components/schemas/ResourceLinks" + } + }, + "required": [ + "id", + "type" + ] + }, + "AppAssetLibraryPlacementCommonRelationships": { + "type": "object", + "title": "AppAssetLibraryPlacementCommonRelationships", + "properties": { + "appEventLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appEventLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appStoreVersionLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appStoreVersionLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appCustomProductPageLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appCustomProductPageLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appStoreVersionExperimentTreatmentLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appStoreVersionExperimentTreatmentLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + }, + "AppAssetLibraryPlacementCommonAttributes": { + "type": "object", + "title": "AppAssetLibraryPlacementCommonAttributes", + "properties": { + "mediaType": { + "$ref": "#/components/schemas/AppAssetLibraryMediaType" + }, + "placementType": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementType" + }, + "placementGroup": { + "type": "string" + }, + "createdDate": { + "type": "string", + "format": "date-time" + }, + "lastModifiedDate": { + "type": "string", + "format": "date-time" + }, + "state": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementState" + }, + "stateDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateDetail" + } + } + } + }, + "AppAssetLibraryPlacementVideoAttributes": { + "title": "AppAssetLibraryPlacementVideoAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacementCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryPlacementImageRelationships": { + "title": "AppAssetLibraryPlacementImageRelationships", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacementCommonRelationships" + }, + { + "type": "object", + "properties": { + "image": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryImages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + } + ] + }, + "AppAssetLibraryPlacementVideoRelationships": { + "title": "AppAssetLibraryPlacementVideoRelationships", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacementCommonRelationships" + }, + { + "type": "object", + "properties": { + "video": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryVideos" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + } + ] + }, + "AppAssetLibraryPlacementsResponse": { + "type": "object", + "title": "AppAssetLibraryPlacementsResponse", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + } + }, + "included": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImage" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideo" + }, + { + "$ref": "#/components/schemas/AppCustomProductPageLocalization" + }, + { + "$ref": "#/components/schemas/AppEventLocalization" + }, + { + "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalization" + }, + { + "$ref": "#/components/schemas/AppStoreVersionLocalization" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "appStoreVersionLocalizations": "#/components/schemas/AppStoreVersionLocalization", + "appAssetLibraryImages": "#/components/schemas/AppAssetLibraryImage", + "appCustomProductPageLocalizations": "#/components/schemas/AppCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalizations": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalization", + "appAssetLibraryVideos": "#/components/schemas/AppAssetLibraryVideo", + "appEventLocalizations": "#/components/schemas/AppEventLocalization" + } + } + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryPlacementResponse": { + "type": "object", + "title": "AppAssetLibraryPlacementResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + }, + "included": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImage" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideo" + }, + { + "$ref": "#/components/schemas/AppCustomProductPageLocalization" + }, + { + "$ref": "#/components/schemas/AppEventLocalization" + }, + { + "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalization" + }, + { + "$ref": "#/components/schemas/AppStoreVersionLocalization" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "appStoreVersionLocalizations": "#/components/schemas/AppStoreVersionLocalization", + "appAssetLibraryImages": "#/components/schemas/AppAssetLibraryImage", + "appCustomProductPageLocalizations": "#/components/schemas/AppCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalizations": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalization", + "appAssetLibraryVideos": "#/components/schemas/AppAssetLibraryVideo", + "appEventLocalizations": "#/components/schemas/AppEventLocalization" + } + } + } + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryPlacementCreateRequest": { + "type": "object", + "title": "AppAssetLibraryPlacementCreateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "attributes": { + "type": "object", + "properties": { + "placementType": { + "nullable": true, + "$ref": "#/components/schemas/AppAssetLibraryPlacementType" + }, + "placementGroup": { + "type": "string", + "nullable": true + } + } + }, + "relationships": { + "type": "object", + "properties": { + "image": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryImages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "video": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryVideos" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appEventLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appEventLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appStoreVersionLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appStoreVersionLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appCustomProductPageLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appCustomProductPageLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appStoreVersionExperimentTreatmentLocalization": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appStoreVersionExperimentTreatmentLocalizations" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + } + }, + "anyOf": [ + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementType" + ] + }, + "relationships": { + "type": "object", + "required": [ + "image", + "appEventLocalization" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + }, + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementType" + ] + }, + "relationships": { + "type": "object", + "required": [ + "image", + "appStoreVersionLocalization" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + }, + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementType" + ] + }, + "relationships": { + "type": "object", + "required": [ + "image", + "appCustomProductPageLocalization" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + }, + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementType" + ] + }, + "relationships": { + "type": "object", + "required": [ + "image", + "appStoreVersionExperimentTreatmentLocalization" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + }, + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementType" + ] + }, + "relationships": { + "type": "object", + "required": [ + "appEventLocalization", + "video" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + }, + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementType" + ] + }, + "relationships": { + "type": "object", + "required": [ + "video", + "appStoreVersionLocalization" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + }, + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementType" + ] + }, + "relationships": { + "type": "object", + "required": [ + "appCustomProductPageLocalization", + "video" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + }, + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementType" + ] + }, + "relationships": { + "type": "object", + "required": [ + "appStoreVersionExperimentTreatmentLocalization", + "video" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + } + ], + "required": [ + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "AppAssetLibraryRefDatum": { + "type": "object", + "title": "AppAssetLibraryRefDatum", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryRefData" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "features": { + "type": "array", + "items": { + "type": "object", + "properties": { + "featureId": { + "$ref": "#/components/schemas/AppAssetLibraryFeature" + }, + "placementPolicies": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placementType": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementType" + }, + "groupLimits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "maxCount": { + "type": "integer" + } + } + } + } + } + } + } + } + } + }, + "placementProfileGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placementProfileGroupId": { + "type": "string" + }, + "platform": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementPlatform" + }, + "displayClassId": { + "$ref": "#/components/schemas/AppAssetLibraryDisplayClass" + } + } + } + }, + "imageSpecs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specId": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "dimensions": { + "type": "object", + "properties": { + "minWidth": { + "type": "integer" + }, + "maxWidth": { + "type": "integer" + }, + "minHeight": { + "type": "integer" + }, + "maxHeight": { + "type": "integer" + } + } + }, + "aspectRatio": { + "type": "string" + }, + "compatiblePlacementTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementType" + } + }, + "alphaAllowed": { + "type": "boolean" + }, + "fileExtensions": { + "type": "array", + "items": { + "type": "string" + } + }, + "maxFileSize": { + "type": "integer", + "format": "int64", + "maximum": 9007199254740991, + "minimum": 1 + }, + "mimeTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "universalAsset": { + "type": "boolean" + } + } + } + }, + "videoSpecs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specId": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "dimensions": { + "type": "object", + "properties": { + "minWidth": { + "type": "integer" + }, + "maxWidth": { + "type": "integer" + }, + "minHeight": { + "type": "integer" + }, + "maxHeight": { + "type": "integer" + } + } + }, + "aspectRatio": { + "type": "string" + }, + "compatiblePlacementTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementType" + } + }, + "frameRates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "minFps": { + "type": "integer" + }, + "maxFps": { + "type": "integer" + } + } + } + }, + "duration": { + "type": "object", + "properties": { + "min": { + "type": "string", + "format": "duration" + }, + "max": { + "type": "string", + "format": "duration" + } + } + }, + "audioRequired": { + "type": "boolean" + }, + "fileExtensions": { + "type": "array", + "items": { + "type": "string" + } + }, + "maxFileSize": { + "type": "integer", + "format": "int64", + "maximum": 9007199254740991, + "minimum": 1 + }, + "mimeTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "universalAsset": { + "type": "boolean" + } + } + } + }, + "placementTypes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placementTypeId": { + "$ref": "#/components/schemas/AppAssetLibraryPlacementType" + }, + "acceptsAssetCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryAssetCategory" + } + }, + "specMappings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placementGroupId": { + "type": "string" + }, + "specs": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "displayClasses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "displayClassId": { + "$ref": "#/components/schemas/AppAssetLibraryDisplayClass" + }, + "deviceFamily": { + "$ref": "#/components/schemas/DeviceFamily" + }, + "screenDimensions": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "links": { + "$ref": "#/components/schemas/ResourceLinks" + } + }, + "required": [ + "id", + "type" + ] + }, + "AppAssetLibraryRefDataResponse": { + "type": "object", + "title": "AppAssetLibraryRefDataResponse", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryRefDatum" + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryRefDatumResponse": { + "type": "object", + "title": "AppAssetLibraryRefDatumResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAssetLibraryRefDatum" + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryVideo": { + "type": "object", + "title": "AppAssetLibraryVideo", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryVideos" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoAwaitingUploadAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoUploadCompleteAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoFailedAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoReadyForReviewAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoWaitingForReviewAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoInReviewAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoAcceptedAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoApprovedAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoRejectedAttributes" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideoArchivedAttributes" + } + ], + "discriminator": { + "propertyName": "state", + "mapping": { + "UPLOAD_COMPLETE": "#/components/schemas/AppAssetLibraryVideoUploadCompleteAttributes", + "COMPLETE": "#/components/schemas/AppAssetLibraryVideoCommonAttributes", + "IN_REVIEW": "#/components/schemas/AppAssetLibraryVideoInReviewAttributes", + "ACCEPTED": "#/components/schemas/AppAssetLibraryVideoAcceptedAttributes", + "FAILED": "#/components/schemas/AppAssetLibraryVideoFailedAttributes", + "AWAITING_UPLOAD": "#/components/schemas/AppAssetLibraryVideoAwaitingUploadAttributes", + "PREPARE_FOR_SUBMISSION": "#/components/schemas/AppAssetLibraryVideoCommonAttributes", + "READY_FOR_REVIEW": "#/components/schemas/AppAssetLibraryVideoReadyForReviewAttributes", + "ARCHIVED": "#/components/schemas/AppAssetLibraryVideoArchivedAttributes", + "APPROVED": "#/components/schemas/AppAssetLibraryVideoApprovedAttributes", + "WAITING_FOR_REVIEW": "#/components/schemas/AppAssetLibraryVideoWaitingForReviewAttributes", + "REJECTED": "#/components/schemas/AppAssetLibraryVideoRejectedAttributes" + } + } + }, + "relationships": { + "type": "object", + "properties": { + "placements": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + } + }, + "links": { + "$ref": "#/components/schemas/ResourceLinks" + } + }, + "required": [ + "id", + "type" + ] + }, + "AppAssetLibraryVideoCommonAttributes": { + "type": "object", + "title": "AppAssetLibraryVideoCommonAttributes", + "properties": { + "category": { + "$ref": "#/components/schemas/AppAssetLibraryAssetCategory" + }, + "createdDate": { + "type": "string", + "format": "date-time" + }, + "lastModifiedDate": { + "type": "string", + "format": "date-time" + }, + "fileName": { + "type": "string" + }, + "fileSize": { + "type": "integer", + "format": "int64", + "maximum": 9007199254740991, + "minimum": 1 + }, + "previewFrameImage": { + "$ref": "#/components/schemas/PreviewFrameImage" + }, + "previewFrameTimeCode": { + "type": "string" + }, + "referenceName": { + "type": "string" + }, + "specId": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/AppAssetLibraryAssetState" + }, + "stateDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateDetail" + } + }, + "videoAsset": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "state" + ] + }, + "AppAssetLibraryVideoAcceptedAttributes": { + "title": "AppAssetLibraryVideoAcceptedAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryVideoApprovedAttributes": { + "title": "AppAssetLibraryVideoApprovedAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryVideoArchivedAttributes": { + "title": "AppAssetLibraryVideoArchivedAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryVideoAwaitingUploadAttributes": { + "title": "AppAssetLibraryVideoAwaitingUploadAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "type": "object", + "properties": { + "uploadOperations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UploadOperation" + } + } + } + } + ] + }, + "AppAssetLibraryVideoFailedAttributes": { + "title": "AppAssetLibraryVideoFailedAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "type": "object", + "properties": { + "uploadOperations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UploadOperation" + } + } + } + } + ] + }, + "AppAssetLibraryVideoInReviewAttributes": { + "title": "AppAssetLibraryVideoInReviewAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryVideoReadyForReviewAttributes": { + "title": "AppAssetLibraryVideoReadyForReviewAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryVideoRejectedAttributes": { + "title": "AppAssetLibraryVideoRejectedAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryVideoUploadCompleteAttributes": { + "title": "AppAssetLibraryVideoUploadCompleteAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "type": "object", + "properties": { + "uploadOperations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UploadOperation" + } + } + } + } + ] + }, + "AppAssetLibraryVideoWaitingForReviewAttributes": { + "title": "AppAssetLibraryVideoWaitingForReviewAttributes", + "allOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryVideoCommonAttributes" + }, + { + "type": "object" + } + ] + }, + "AppAssetLibraryVideosResponse": { + "type": "object", + "title": "AppAssetLibraryVideosResponse", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryVideo" + } + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryVideoResponse": { + "type": "object", + "title": "AppAssetLibraryVideoResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAssetLibraryVideo" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + } + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryVideoCreateRequest": { + "type": "object", + "title": "AppAssetLibraryVideoCreateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryVideos" + ] + }, + "attributes": { + "type": "object", + "properties": { + "category": { + "$ref": "#/components/schemas/AppAssetLibraryAssetCategory" + }, + "fileName": { + "type": "string" + }, + "fileSize": { + "type": "integer", + "format": "int64", + "maximum": 9007199254740991, + "minimum": 1 + }, + "previewFrameTimeCode": { + "type": "string", + "nullable": true + }, + "referenceName": { + "type": "string", + "nullable": true + } + }, + "required": [ + "fileName", + "fileSize", + "category" + ] + }, + "relationships": { + "type": "object", + "properties": { + "assetLibrary": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraries" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "placements": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + }, + "required": [ + "assetLibrary" + ] + } + }, + "required": [ + "relationships", + "attributes", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "AppAssetLibraryVideoUpdateRequest": { + "type": "object", + "title": "AppAssetLibraryVideoUpdateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryVideos" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "archived": { + "type": "boolean", + "nullable": true + }, + "previewFrameTimeCode": { + "type": "string", + "nullable": true + }, + "referenceName": { + "type": "string", + "nullable": true + }, + "uploaded": { + "type": "boolean", + "nullable": true + } + } + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "data" + ] + }, "AppAvailabilityV2": { "type": "object", "title": "AppAvailabilityV2", @@ -179011,6 +187949,38 @@ } } } + }, + "placements": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } } }, @@ -179075,6 +188045,32 @@ ] } } + }, + "placements": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } } } @@ -179098,6 +188094,9 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + }, { "$ref": "#/components/schemas/AppCustomProductPageVersion" }, @@ -179115,6 +188114,7 @@ "propertyName": "type", "mapping": { "appScreenshotSets": "#/components/schemas/AppScreenshotSet", + "appAssetLibraryPlacements": "#/components/schemas/AppAssetLibraryPlacement", "appKeywords": "#/components/schemas/AppKeyword", "appCustomProductPageVersions": "#/components/schemas/AppCustomProductPageVersion", "appPreviewSets": "#/components/schemas/AppPreviewSet" @@ -179145,6 +188145,9 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + }, { "$ref": "#/components/schemas/AppCustomProductPageVersion" }, @@ -179162,6 +188165,7 @@ "propertyName": "type", "mapping": { "appScreenshotSets": "#/components/schemas/AppScreenshotSet", + "appAssetLibraryPlacements": "#/components/schemas/AppAssetLibraryPlacement", "appKeywords": "#/components/schemas/AppKeyword", "appCustomProductPageVersions": "#/components/schemas/AppCustomProductPageVersion", "appPreviewSets": "#/components/schemas/AppPreviewSet" @@ -179234,6 +188238,32 @@ "required": [ "data" ] + }, + "placements": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } }, "required": [ @@ -180701,6 +189731,38 @@ } } } + }, + "placements": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } } }, @@ -180727,6 +189789,9 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + }, { "$ref": "#/components/schemas/AppEventScreenshot" }, @@ -180742,6 +189807,7 @@ "mapping": { "appEvents": "#/components/schemas/AppEvent", "appEventVideoClips": "#/components/schemas/AppEventVideoClip", + "appAssetLibraryPlacements": "#/components/schemas/AppAssetLibraryPlacement", "appEventScreenshots": "#/components/schemas/AppEventScreenshot" } } @@ -180770,6 +189836,9 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + }, { "$ref": "#/components/schemas/AppEventScreenshot" }, @@ -180785,6 +189854,7 @@ "mapping": { "appEvents": "#/components/schemas/AppEvent", "appEventVideoClips": "#/components/schemas/AppEventVideoClip", + "appAssetLibraryPlacements": "#/components/schemas/AppAssetLibraryPlacement", "appEventScreenshots": "#/components/schemas/AppEventScreenshot" } } @@ -180863,6 +189933,32 @@ "required": [ "data" ] + }, + "placements": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } }, "required": [ @@ -185336,6 +194432,38 @@ } } } + }, + "placements": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } } }, @@ -185362,6 +194490,9 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + }, { "$ref": "#/components/schemas/AppPreviewSet" }, @@ -185377,6 +194508,7 @@ "mapping": { "appScreenshotSets": "#/components/schemas/AppScreenshotSet", "appStoreVersionExperimentTreatments": "#/components/schemas/AppStoreVersionExperimentTreatment", + "appAssetLibraryPlacements": "#/components/schemas/AppAssetLibraryPlacement", "appPreviewSets": "#/components/schemas/AppPreviewSet" } } @@ -185405,6 +194537,9 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + }, { "$ref": "#/components/schemas/AppPreviewSet" }, @@ -185420,6 +194555,7 @@ "mapping": { "appScreenshotSets": "#/components/schemas/AppScreenshotSet", "appStoreVersionExperimentTreatments": "#/components/schemas/AppStoreVersionExperimentTreatment", + "appAssetLibraryPlacements": "#/components/schemas/AppAssetLibraryPlacement", "appPreviewSets": "#/components/schemas/AppPreviewSet" } } @@ -185486,6 +194622,32 @@ "required": [ "data" ] + }, + "placements": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } }, "required": [ @@ -186697,6 +195859,38 @@ } } } + }, + "placements": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } } }, @@ -186723,6 +195917,9 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + }, { "$ref": "#/components/schemas/AppKeyword" }, @@ -186741,6 +195938,7 @@ "mapping": { "appScreenshotSets": "#/components/schemas/AppScreenshotSet", "appStoreVersions": "#/components/schemas/AppStoreVersion", + "appAssetLibraryPlacements": "#/components/schemas/AppAssetLibraryPlacement", "appKeywords": "#/components/schemas/AppKeyword", "appPreviewSets": "#/components/schemas/AppPreviewSet" } @@ -186770,6 +195968,9 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryPlacement" + }, { "$ref": "#/components/schemas/AppKeyword" }, @@ -186788,6 +195989,7 @@ "mapping": { "appScreenshotSets": "#/components/schemas/AppScreenshotSet", "appStoreVersions": "#/components/schemas/AppStoreVersion", + "appAssetLibraryPlacements": "#/components/schemas/AppAssetLibraryPlacement", "appKeywords": "#/components/schemas/AppKeyword", "appPreviewSets": "#/components/schemas/AppPreviewSet" } @@ -186881,6 +196083,32 @@ "required": [ "data" ] + }, + "placements": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } }, "required": [ @@ -189312,6 +198540,14 @@ } } }, + "assetLibrary": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + } + } + }, "betaFeedbackScreenshotSubmissions": { "type": "object", "properties": { @@ -222148,6 +231384,52 @@ } } }, + "appAssetLibraryImage": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryImages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appAssetLibraryVideo": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryVideos" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, "backgroundAssetVersion": { "type": "object", "properties": { @@ -222380,6 +231662,12 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImage" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideo" + }, { "$ref": "#/components/schemas/AppCustomProductPageVersion" }, @@ -222423,6 +231711,7 @@ "discriminator": { "propertyName": "type", "mapping": { + "appAssetLibraryImages": "#/components/schemas/AppAssetLibraryImage", "appEvents": "#/components/schemas/AppEvent", "gameCenterAchievementVersions": "#/components/schemas/GameCenterAchievementVersionV2", "appStoreVersionExperiments": "#/components/schemas/AppStoreVersionExperiment", @@ -222432,6 +231721,7 @@ "gameCenterChallengeVersions": "#/components/schemas/GameCenterChallengeVersion", "subscriptionGroupVersions": "#/components/schemas/SubscriptionGroupVersion", "appStoreVersions": "#/components/schemas/AppStoreVersion", + "appAssetLibraryVideos": "#/components/schemas/AppAssetLibraryVideo", "backgroundAssetVersions": "#/components/schemas/BackgroundAssetVersion", "gameCenterLeaderboardSetVersions": "#/components/schemas/GameCenterLeaderboardSetVersionV2", "appCustomProductPageVersions": "#/components/schemas/AppCustomProductPageVersion", @@ -222463,6 +231753,12 @@ "type": "array", "items": { "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImage" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideo" + }, { "$ref": "#/components/schemas/AppCustomProductPageVersion" }, @@ -222506,6 +231802,7 @@ "discriminator": { "propertyName": "type", "mapping": { + "appAssetLibraryImages": "#/components/schemas/AppAssetLibraryImage", "appEvents": "#/components/schemas/AppEvent", "gameCenterAchievementVersions": "#/components/schemas/GameCenterAchievementVersionV2", "appStoreVersionExperiments": "#/components/schemas/AppStoreVersionExperiment", @@ -222515,6 +231812,7 @@ "gameCenterChallengeVersions": "#/components/schemas/GameCenterChallengeVersion", "subscriptionGroupVersions": "#/components/schemas/SubscriptionGroupVersion", "appStoreVersions": "#/components/schemas/AppStoreVersion", + "appAssetLibraryVideos": "#/components/schemas/AppAssetLibraryVideo", "backgroundAssetVersions": "#/components/schemas/BackgroundAssetVersion", "gameCenterLeaderboardSetVersions": "#/components/schemas/GameCenterLeaderboardSetVersionV2", "appCustomProductPageVersions": "#/components/schemas/AppCustomProductPageVersion", @@ -222689,6 +231987,52 @@ } } }, + "appAssetLibraryImage": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryImages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "appAssetLibraryVideo": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryVideos" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, "backgroundAssetVersion": { "type": "object", "properties": { @@ -233670,6 +243014,150 @@ "links" ] }, + "AppAssetLibraryImagesLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryImages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryVideosLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryVideos" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryImagePlacementsLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "AppAssetLibraryVideoPlacementsLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, "AppAvailabilityV2TerritoryAvailabilitiesLinkagesResponse": { "type": "object", "properties": { @@ -234106,6 +243594,42 @@ "links" ] }, + "AppCustomProductPageLocalizationPlacementsLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, "AppCustomProductPageLocalizationSearchKeywordsLinkagesResponse": { "type": "object", "properties": { @@ -234422,6 +243946,42 @@ "links" ] }, + "AppEventLocalizationPlacementsLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, "AppEventLocalizationsLinkagesResponse": { "type": "object", "properties": { @@ -235116,6 +244676,42 @@ "links" ] }, + "AppStoreVersionExperimentTreatmentLocalizationPlacementsLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, "AppStoreVersionExperimentTreatmentAppStoreVersionExperimentTreatmentLocalizationsLinkagesResponse": { "type": "object", "properties": { @@ -235297,6 +244893,42 @@ "links" ] }, + "AppStoreVersionLocalizationPlacementsLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, "AppStoreVersionLocalizationSearchKeywordsLinkagesResponse": { "type": "object", "properties": { @@ -236390,6 +246022,36 @@ "links" ] }, + "AppAssetLibraryLinkageResponse": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraries" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, "AppBackgroundAssetsLinkagesResponse": { "type": "object", "properties": { @@ -246459,6 +256121,117 @@ } } }, + "AppAssetLibraryAssetCategory": { + "type": "string", + "enum": [ + "CREATIVE_ASSETS", + "APP_SCREENSHOTS_AND_PREVIEWS" + ] + }, + "AppAssetLibraryAssetState": { + "type": "string", + "enum": [ + "AWAITING_UPLOAD", + "UPLOAD_COMPLETE", + "FAILED", + "COMPLETE", + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "ACCEPTED", + "APPROVED", + "REJECTED", + "ARCHIVED" + ] + }, + "AppAssetLibraryDisplayClass": { + "type": "string", + "enum": [ + "DEFAULT", + "WATCH_ULTRA", + "WATCH_SERIES_10", + "WATCH_SERIES_7", + "WATCH_SERIES_4", + "WATCH_SERIES_3", + "IPHONE_DUO", + "IPHONE_DYNAMIC_ISLAND_LARGE_DISPLAY", + "IPHONE_DYNAMIC_ISLAND_MEDIUM_DISPLAY", + "IPHONE_FACE_ID_LARGE_DISPLAY", + "IPHONE_FACE_ID_MEDIUM_DISPLAY", + "IPHONE_HOME_BUTTON_LARGE_DISPLAY", + "IPHONE_HOME_BUTTON_MEDIUM_DISPLAY", + "IPHONE_HOME_BUTTON_40_DISPLAY", + "IPHONE_HOME_BUTTON_35_DISPLAY", + "IPAD_13_DISPLAY", + "IPAD_11_DISPLAY", + "IPAD_129_DISPLAY", + "IPAD_105_DISPLAY", + "IPAD_97_DISPLAY" + ] + }, + "AppAssetLibraryFeature": { + "type": "string", + "enum": [ + "APP_STORE_VERSIONS", + "CUSTOM_PRODUCT_PAGES", + "PRODUCT_PAGE_OPTIMIZATIONS", + "IN_APP_EVENTS", + "IN_APP_PURCHASES", + "SUBSCRIPTIONS", + "RETENTION_MESSAGING", + "GAME_CENTER", + "APP_CLIPS", + "APPLE_ADS" + ] + }, + "AppAssetLibraryMediaType": { + "type": "string", + "enum": [ + "IMAGE", + "VIDEO" + ] + }, + "AppAssetLibraryPlacementPlatform": { + "type": "string", + "enum": [ + "IPHONE_APP_STORE", + "IPAD_APP_STORE", + "WATCH_APP_STORE", + "IMESSAGE_APP_STORE", + "VISION_PRO_APP_STORE", + "MAC_APP_STORE", + "TV_APP_STORE", + "ANY" + ] + }, + "AppAssetLibraryPlacementState": { + "type": "string", + "enum": [ + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" + ] + }, + "AppAssetLibraryPlacementType": { + "type": "string", + "enum": [ + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" + ] + }, "AppClipAction": { "type": "string", "enum": [