From 4f393855c991f0b570fdecda1a2411a9a7b0a022 Mon Sep 17 00:00:00 2001 From: Kanishka <123kanishka@gmail.com> Date: Sun, 18 Jul 2021 13:21:39 +0530 Subject: [PATCH] add apple appstore connector [slalpha5] --- openapi/apple.appstore/.gitignore | 1 + openapi/apple.appstore/Ballerina.toml | 11 + openapi/apple.appstore/Dependencies.toml | 11 + openapi/apple.appstore/Package.md | 17 + openapi/apple.appstore/client.bal | 1613 ++ openapi/apple.appstore/openapi.yaml | 27425 +++++++++++++++++++++ openapi/apple.appstore/types.bal | 3078 +++ 7 files changed, 32156 insertions(+) create mode 100644 openapi/apple.appstore/.gitignore create mode 100644 openapi/apple.appstore/Ballerina.toml create mode 100644 openapi/apple.appstore/Dependencies.toml create mode 100644 openapi/apple.appstore/Package.md create mode 100644 openapi/apple.appstore/client.bal create mode 100644 openapi/apple.appstore/openapi.yaml create mode 100644 openapi/apple.appstore/types.bal diff --git a/openapi/apple.appstore/.gitignore b/openapi/apple.appstore/.gitignore new file mode 100644 index 000000000..eb5a316cb --- /dev/null +++ b/openapi/apple.appstore/.gitignore @@ -0,0 +1 @@ +target diff --git a/openapi/apple.appstore/Ballerina.toml b/openapi/apple.appstore/Ballerina.toml new file mode 100644 index 000000000..f83c7c895 --- /dev/null +++ b/openapi/apple.appstore/Ballerina.toml @@ -0,0 +1,11 @@ +[package] +license = ["Apache-2.0"] +keywords = ["apple", "appstore", "ios"] +org = "ballerinax" +name = "apple.appstore" +repository = "https://github.com/ballerina-platform/ballerinax-openapi-connectors" +version = "0.1.0-SNAPSHOT" +authors = ["Ballerina"] + +[build-options] +observabilityIncluded = true \ No newline at end of file diff --git a/openapi/apple.appstore/Dependencies.toml b/openapi/apple.appstore/Dependencies.toml new file mode 100644 index 000000000..1d6708b76 --- /dev/null +++ b/openapi/apple.appstore/Dependencies.toml @@ -0,0 +1,11 @@ +[[dependency]] +org = "ballerina" +name = "http" +version = "1.1.0-alpha8" + +[[dependency]] +org = "ballerina" +name = "url" +version = "1.1.0-alpha8" + + diff --git a/openapi/apple.appstore/Package.md b/openapi/apple.appstore/Package.md new file mode 100644 index 000000000..79712590e --- /dev/null +++ b/openapi/apple.appstore/Package.md @@ -0,0 +1,17 @@ +Connects to Apple App Store Connect API from Ballerina + +#### Compatibility +| | Version | +|-------------------------------|-----------------------| +| Ballerina Language Version | **Swan Lake Alpha 5** | +| API Version | **1.4.1** | + +### Package Overview +The `apple.appstore` is a [Ballerina](https://ballerina.io/) connector for *Apple App Store*. +This package provides the capability to easily access *Apple App Store API*. +### Report Issues +To report bugs, request new features, start new discussions, view project boards, etc., go to the [Ballerina connector repository](https://github.com/ballerina-platform/ballerinax-openapi-connectors) +### Useful Links +- Discuss code changes of the Ballerina project in [ballerina-dev@googlegroups.com](mailto:ballerina-dev@googlegroups.com). +- Chat live with us via our [Slack channel](https://ballerina.io/community/slack/). +- Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag diff --git a/openapi/apple.appstore/client.bal b/openapi/apple.appstore/client.bal new file mode 100644 index 000000000..89bacb732 --- /dev/null +++ b/openapi/apple.appstore/client.bal @@ -0,0 +1,1613 @@ +// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +import ballerina/http; +import ballerina/url; +import ballerina/lang.'string; + +public type ClientConfig record { + http:BearerTokenConfig authConfig; + http:ClientSecureSocket secureSocketConfig?; +}; + +# + clientEp - Connector http endpoint +public client class Client { + http:Client clientEp; + # Client initialization. + # + # + clientConfig - Client configuration details + # + serviceUrl - Connector server URL + # + return - Returns error at failure of client initialization + public isolated function init(ClientConfig clientConfig, string serviceUrl = "https://api.appstoreconnect.apple.com/") returns error? { + http:ClientSecureSocket? secureSocketConfig = clientConfig?.secureSocketConfig; + http:Client httpEp = check new (serviceUrl, { auth: clientConfig.authConfig, secureSocket: secureSocketConfig }); + self.clientEp = httpEp; + } + # + # + filterPlatforms - filter by attribute 'platforms' + # + existsParent - filter by existence or non-existence of related 'parent' + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + limitSubcategories - maximum number of related subcategories returned (when they are included) + # + return - List of AppCategories + remote isolated function appcategoriesGetCollection(string[]? filterPlatforms = (), string[]? existsParent = (), string[]? fieldsAppcategories = (), int? 'limit = (), string[]? include = (), int? limitSubcategories = ()) returns AppCategoriesResponse|error { + string path = string `/v1/appCategories`; + map queryParam = {"filter[platforms]": filterPlatforms, "exists[parent]": existsParent, "fields[appCategories]": fieldsAppcategories, "limit": 'limit, "include": include, "limit[subcategories]": limitSubcategories}; + path = path + check getPathForQueryParam(queryParam); + AppCategoriesResponse response = check self.clientEp-> get(path, targetType = AppCategoriesResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + include - comma-separated list of relationships to include + # + limitSubcategories - maximum number of related subcategories returned (when they are included) + # + return - Single AppCategory + remote isolated function appcategoriesGetInstance(string id, string[]? fieldsAppcategories = (), string[]? include = (), int? limitSubcategories = ()) returns AppCategoryResponse|error { + string path = string `/v1/appCategories/${id}`; + map queryParam = {"fields[appCategories]": fieldsAppcategories, "include": include, "limit[subcategories]": limitSubcategories}; + path = path + check getPathForQueryParam(queryParam); + AppCategoryResponse response = check self.clientEp-> get(path, targetType = AppCategoryResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppinfos - the fields to include for returned resources of type appInfos + # + include - comma-separated list of relationships to include + # + fieldsAgeratingdeclarations - the fields to include for returned resources of type ageRatingDeclarations + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + fieldsAppinfolocalizations - the fields to include for returned resources of type appInfoLocalizations + # + limitAppinfolocalizations - maximum number of related appInfoLocalizations returned (when they are included) + # + return - Single AppInfo + remote isolated function appinfosGetInstance(string id, string[]? fieldsAppinfos = (), string[]? include = (), string[]? fieldsAgeratingdeclarations = (), string[]? fieldsAppcategories = (), string[]? fieldsAppinfolocalizations = (), int? limitAppinfolocalizations = ()) returns AppInfoResponse|error { + string path = string `/v1/appInfos/${id}`; + map queryParam = {"fields[appInfos]": fieldsAppinfos, "include": include, "fields[ageRatingDeclarations]": fieldsAgeratingdeclarations, "fields[appCategories]": fieldsAppcategories, "fields[appInfoLocalizations]": fieldsAppinfolocalizations, "limit[appInfoLocalizations]": limitAppinfolocalizations}; + path = path + check getPathForQueryParam(queryParam); + AppInfoResponse response = check self.clientEp-> get(path, targetType = AppInfoResponse); + return response; + } + # + # + id - the id of the requested resource + # + payload - AppInfo representation + # + return - Single AppInfo + remote isolated function appinfosUpdateInstance(string id, AppInfoUpdateRequest payload) returns AppInfoResponse|error { + string path = string `/v1/appInfos/${id}`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + AppInfoResponse response = check self.clientEp->patch(path, request, targetType=AppInfoResponse); + return response; + } + # + # + filterPricetier - filter by id(s) of related 'priceTier' + # + filterTerritory - filter by id(s) of related 'territory' + # + fieldsApppricepoints - the fields to include for returned resources of type appPricePoints + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + fieldsTerritories - the fields to include for returned resources of type territories + # + return - List of AppPricePoints + remote isolated function apppricepointsGetCollection(string[]? filterPricetier = (), string[]? filterTerritory = (), string[]? fieldsApppricepoints = (), int? 'limit = (), string[]? include = (), string[]? fieldsTerritories = ()) returns AppPricePointsResponse|error { + string path = string `/v1/appPricePoints`; + map queryParam = {"filter[priceTier]": filterPricetier, "filter[territory]": filterTerritory, "fields[appPricePoints]": fieldsApppricepoints, "limit": 'limit, "include": include, "fields[territories]": fieldsTerritories}; + path = path + check getPathForQueryParam(queryParam); + AppPricePointsResponse response = check self.clientEp-> get(path, targetType = AppPricePointsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsApppricepoints - the fields to include for returned resources of type appPricePoints + # + include - comma-separated list of relationships to include + # + fieldsTerritories - the fields to include for returned resources of type territories + # + return - Single AppPricePoint + remote isolated function apppricepointsGetInstance(string id, string[]? fieldsApppricepoints = (), string[]? include = (), string[]? fieldsTerritories = ()) returns AppPricePointResponse|error { + string path = string `/v1/appPricePoints/${id}`; + map queryParam = {"fields[appPricePoints]": fieldsApppricepoints, "include": include, "fields[territories]": fieldsTerritories}; + path = path + check getPathForQueryParam(queryParam); + AppPricePointResponse response = check self.clientEp-> get(path, targetType = AppPricePointResponse); + return response; + } + # + # + filterId - filter by id(s) + # + fieldsApppricetiers - the fields to include for returned resources of type appPriceTiers + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + fieldsApppricepoints - the fields to include for returned resources of type appPricePoints + # + limitPricepoints - maximum number of related pricePoints returned (when they are included) + # + return - List of AppPriceTiers + remote isolated function apppricetiersGetCollection(string[]? filterId = (), string[]? fieldsApppricetiers = (), int? 'limit = (), string[]? include = (), string[]? fieldsApppricepoints = (), int? limitPricepoints = ()) returns AppPriceTiersResponse|error { + string path = string `/v1/appPriceTiers`; + map queryParam = {"filter[id]": filterId, "fields[appPriceTiers]": fieldsApppricetiers, "limit": 'limit, "include": include, "fields[appPricePoints]": fieldsApppricepoints, "limit[pricePoints]": limitPricepoints}; + path = path + check getPathForQueryParam(queryParam); + AppPriceTiersResponse response = check self.clientEp-> get(path, targetType = AppPriceTiersResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsApppricetiers - the fields to include for returned resources of type appPriceTiers + # + include - comma-separated list of relationships to include + # + fieldsApppricepoints - the fields to include for returned resources of type appPricePoints + # + limitPricepoints - maximum number of related pricePoints returned (when they are included) + # + return - Single AppPriceTier + remote isolated function apppricetiersGetInstance(string id, string[]? fieldsApppricetiers = (), string[]? include = (), string[]? fieldsApppricepoints = (), int? limitPricepoints = ()) returns AppPriceTierResponse|error { + string path = string `/v1/appPriceTiers/${id}`; + map queryParam = {"fields[appPriceTiers]": fieldsApppricetiers, "include": include, "fields[appPricePoints]": fieldsApppricepoints, "limit[pricePoints]": limitPricepoints}; + path = path + check getPathForQueryParam(queryParam); + AppPriceTierResponse response = check self.clientEp-> get(path, targetType = AppPriceTierResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppprices - the fields to include for returned resources of type appPrices + # + include - comma-separated list of relationships to include + # + return - Single AppPrice + remote isolated function apppricesGetInstance(string id, string[]? fieldsAppprices = (), string[]? include = ()) returns AppPriceResponse|error { + string path = string `/v1/appPrices/${id}`; + map queryParam = {"fields[appPrices]": fieldsAppprices, "include": include}; + path = path + check getPathForQueryParam(queryParam); + AppPriceResponse response = check self.clientEp-> get(path, targetType = AppPriceResponse); + return response; + } + # + # + payload - AppScreenshot representation + # + return - Single AppScreenshot + remote isolated function appscreenshotsCreateInstance(AppScreenshotCreateRequest payload) returns AppScreenshotResponse|error { + string path = string `/v1/appScreenshots`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + AppScreenshotResponse response = check self.clientEp->post(path, request, targetType=AppScreenshotResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppscreenshots - the fields to include for returned resources of type appScreenshots + # + include - comma-separated list of relationships to include + # + return - Single AppScreenshot + remote isolated function appscreenshotsGetInstance(string id, string[]? fieldsAppscreenshots = (), string[]? include = ()) returns AppScreenshotResponse|error { + string path = string `/v1/appScreenshots/${id}`; + map queryParam = {"fields[appScreenshots]": fieldsAppscreenshots, "include": include}; + path = path + check getPathForQueryParam(queryParam); + AppScreenshotResponse response = check self.clientEp-> get(path, targetType = AppScreenshotResponse); + return response; + } + # + # + id - the id of the requested resource + # + return - Success (no content) + remote isolated function appscreenshotsDeleteInstance(string id) returns http:Response|error { + string path = string `/v1/appScreenshots/${id}`; + http:Request request = new; + //TODO: Update the request as needed; + http:Response response = check self.clientEp-> delete(path, request, targetType = http:Response); + return response; + } + # + # + id - the id of the requested resource + # + payload - AppScreenshot representation + # + return - Single AppScreenshot + remote isolated function appscreenshotsUpdateInstance(string id, AppScreenshotUpdateRequest payload) returns AppScreenshotResponse|error { + string path = string `/v1/appScreenshots/${id}`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + AppScreenshotResponse response = check self.clientEp->patch(path, request, targetType=AppScreenshotResponse); + return response; + } + # + # + filterAppstoreversionsAppstorestate - filter by attribute 'appStoreVersions.appStoreState' + # + filterAppstoreversionsPlatform - filter by attribute 'appStoreVersions.platform' + # + filterBundleid - filter by attribute 'bundleId' + # + filterName - filter by attribute 'name' + # + filterSku - filter by attribute 'sku' + # + filterAppstoreversions - filter by id(s) of related 'appStoreVersions' + # + filterId - filter by id(s) + # + existsGamecenterenabledversions - filter by existence or non-existence of related 'gameCenterEnabledVersions' + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsApps - the fields to include for returned resources of type apps + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + fieldsBetagroups - the fields to include for returned resources of type betaGroups + # + fieldsPerfpowermetrics - the fields to include for returned resources of type perfPowerMetrics + # + fieldsAppinfos - the fields to include for returned resources of type appInfos + # + fieldsApppreorders - the fields to include for returned resources of type appPreOrders + # + fieldsPrereleaseversions - the fields to include for returned resources of type preReleaseVersions + # + fieldsAppprices - the fields to include for returned resources of type appPrices + # + fieldsInapppurchases - the fields to include for returned resources of type inAppPurchases + # + fieldsBetaappreviewdetails - the fields to include for returned resources of type betaAppReviewDetails + # + fieldsTerritories - the fields to include for returned resources of type territories + # + fieldsGamecenterenabledversions - the fields to include for returned resources of type gameCenterEnabledVersions + # + fieldsAppstoreversions - the fields to include for returned resources of type appStoreVersions + # + fieldsBuilds - the fields to include for returned resources of type builds + # + fieldsBetaapplocalizations - the fields to include for returned resources of type betaAppLocalizations + # + fieldsBetalicenseagreements - the fields to include for returned resources of type betaLicenseAgreements + # + fieldsEnduserlicenseagreements - the fields to include for returned resources of type endUserLicenseAgreements + # + limitAppinfos - maximum number of related appInfos returned (when they are included) + # + limitAppstoreversions - maximum number of related appStoreVersions returned (when they are included) + # + limitAvailableterritories - maximum number of related availableTerritories returned (when they are included) + # + limitBetaapplocalizations - maximum number of related betaAppLocalizations returned (when they are included) + # + limitBetagroups - maximum number of related betaGroups returned (when they are included) + # + limitBuilds - maximum number of related builds returned (when they are included) + # + limitGamecenterenabledversions - maximum number of related gameCenterEnabledVersions returned (when they are included) + # + limitInapppurchases - maximum number of related inAppPurchases returned (when they are included) + # + limitPrereleaseversions - maximum number of related preReleaseVersions returned (when they are included) + # + limitPrices - maximum number of related prices returned (when they are included) + # + return - List of Apps + remote isolated function appsGetCollection(string[]? filterAppstoreversionsAppstorestate = (), string[]? filterAppstoreversionsPlatform = (), string[]? filterBundleid = (), string[]? filterName = (), string[]? filterSku = (), string[]? filterAppstoreversions = (), string[]? filterId = (), string[]? existsGamecenterenabledversions = (), string[]? sort = (), string[]? fieldsApps = (), int? 'limit = (), string[]? include = (), string[]? fieldsBetagroups = (), string[]? fieldsPerfpowermetrics = (), string[]? fieldsAppinfos = (), string[]? fieldsApppreorders = (), string[]? fieldsPrereleaseversions = (), string[]? fieldsAppprices = (), string[]? fieldsInapppurchases = (), string[]? fieldsBetaappreviewdetails = (), string[]? fieldsTerritories = (), string[]? fieldsGamecenterenabledversions = (), string[]? fieldsAppstoreversions = (), string[]? fieldsBuilds = (), string[]? fieldsBetaapplocalizations = (), string[]? fieldsBetalicenseagreements = (), string[]? fieldsEnduserlicenseagreements = (), int? limitAppinfos = (), int? limitAppstoreversions = (), int? limitAvailableterritories = (), int? limitBetaapplocalizations = (), int? limitBetagroups = (), int? limitBuilds = (), int? limitGamecenterenabledversions = (), int? limitInapppurchases = (), int? limitPrereleaseversions = (), int? limitPrices = ()) returns AppsResponse|error { + string path = string `/v1/apps`; + map queryParam = {"filter[appStoreVersions.appStoreState]": filterAppstoreversionsAppstorestate, "filter[appStoreVersions.platform]": filterAppstoreversionsPlatform, "filter[bundleId]": filterBundleid, "filter[name]": filterName, "filter[sku]": filterSku, "filter[appStoreVersions]": filterAppstoreversions, "filter[id]": filterId, "exists[gameCenterEnabledVersions]": existsGamecenterenabledversions, "sort": sort, "fields[apps]": fieldsApps, "limit": 'limit, "include": include, "fields[betaGroups]": fieldsBetagroups, "fields[perfPowerMetrics]": fieldsPerfpowermetrics, "fields[appInfos]": fieldsAppinfos, "fields[appPreOrders]": fieldsApppreorders, "fields[preReleaseVersions]": fieldsPrereleaseversions, "fields[appPrices]": fieldsAppprices, "fields[inAppPurchases]": fieldsInapppurchases, "fields[betaAppReviewDetails]": fieldsBetaappreviewdetails, "fields[territories]": fieldsTerritories, "fields[gameCenterEnabledVersions]": fieldsGamecenterenabledversions, "fields[appStoreVersions]": fieldsAppstoreversions, "fields[builds]": fieldsBuilds, "fields[betaAppLocalizations]": fieldsBetaapplocalizations, "fields[betaLicenseAgreements]": fieldsBetalicenseagreements, "fields[endUserLicenseAgreements]": fieldsEnduserlicenseagreements, "limit[appInfos]": limitAppinfos, "limit[appStoreVersions]": limitAppstoreversions, "limit[availableTerritories]": limitAvailableterritories, "limit[betaAppLocalizations]": limitBetaapplocalizations, "limit[betaGroups]": limitBetagroups, "limit[builds]": limitBuilds, "limit[gameCenterEnabledVersions]": limitGamecenterenabledversions, "limit[inAppPurchases]": limitInapppurchases, "limit[preReleaseVersions]": limitPrereleaseversions, "limit[prices]": limitPrices}; + path = path + check getPathForQueryParam(queryParam); + AppsResponse response = check self.clientEp-> get(path, targetType = AppsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsApps - the fields to include for returned resources of type apps + # + include - comma-separated list of relationships to include + # + fieldsBetagroups - the fields to include for returned resources of type betaGroups + # + fieldsPerfpowermetrics - the fields to include for returned resources of type perfPowerMetrics + # + fieldsAppinfos - the fields to include for returned resources of type appInfos + # + fieldsApppreorders - the fields to include for returned resources of type appPreOrders + # + fieldsPrereleaseversions - the fields to include for returned resources of type preReleaseVersions + # + fieldsAppprices - the fields to include for returned resources of type appPrices + # + fieldsInapppurchases - the fields to include for returned resources of type inAppPurchases + # + fieldsBetaappreviewdetails - the fields to include for returned resources of type betaAppReviewDetails + # + fieldsTerritories - the fields to include for returned resources of type territories + # + fieldsGamecenterenabledversions - the fields to include for returned resources of type gameCenterEnabledVersions + # + fieldsAppstoreversions - the fields to include for returned resources of type appStoreVersions + # + fieldsBuilds - the fields to include for returned resources of type builds + # + fieldsBetaapplocalizations - the fields to include for returned resources of type betaAppLocalizations + # + fieldsBetalicenseagreements - the fields to include for returned resources of type betaLicenseAgreements + # + fieldsEnduserlicenseagreements - the fields to include for returned resources of type endUserLicenseAgreements + # + limitAppinfos - maximum number of related appInfos returned (when they are included) + # + limitAppstoreversions - maximum number of related appStoreVersions returned (when they are included) + # + limitAvailableterritories - maximum number of related availableTerritories returned (when they are included) + # + limitBetaapplocalizations - maximum number of related betaAppLocalizations returned (when they are included) + # + limitBetagroups - maximum number of related betaGroups returned (when they are included) + # + limitBuilds - maximum number of related builds returned (when they are included) + # + limitGamecenterenabledversions - maximum number of related gameCenterEnabledVersions returned (when they are included) + # + limitInapppurchases - maximum number of related inAppPurchases returned (when they are included) + # + limitPrereleaseversions - maximum number of related preReleaseVersions returned (when they are included) + # + limitPrices - maximum number of related prices returned (when they are included) + # + return - Single App + remote isolated function appsGetInstance(string id, string[]? fieldsApps = (), string[]? include = (), string[]? fieldsBetagroups = (), string[]? fieldsPerfpowermetrics = (), string[]? fieldsAppinfos = (), string[]? fieldsApppreorders = (), string[]? fieldsPrereleaseversions = (), string[]? fieldsAppprices = (), string[]? fieldsInapppurchases = (), string[]? fieldsBetaappreviewdetails = (), string[]? fieldsTerritories = (), string[]? fieldsGamecenterenabledversions = (), string[]? fieldsAppstoreversions = (), string[]? fieldsBuilds = (), string[]? fieldsBetaapplocalizations = (), string[]? fieldsBetalicenseagreements = (), string[]? fieldsEnduserlicenseagreements = (), int? limitAppinfos = (), int? limitAppstoreversions = (), int? limitAvailableterritories = (), int? limitBetaapplocalizations = (), int? limitBetagroups = (), int? limitBuilds = (), int? limitGamecenterenabledversions = (), int? limitInapppurchases = (), int? limitPrereleaseversions = (), int? limitPrices = ()) returns AppResponse|error { + string path = string `/v1/apps/${id}`; + map queryParam = {"fields[apps]": fieldsApps, "include": include, "fields[betaGroups]": fieldsBetagroups, "fields[perfPowerMetrics]": fieldsPerfpowermetrics, "fields[appInfos]": fieldsAppinfos, "fields[appPreOrders]": fieldsApppreorders, "fields[preReleaseVersions]": fieldsPrereleaseversions, "fields[appPrices]": fieldsAppprices, "fields[inAppPurchases]": fieldsInapppurchases, "fields[betaAppReviewDetails]": fieldsBetaappreviewdetails, "fields[territories]": fieldsTerritories, "fields[gameCenterEnabledVersions]": fieldsGamecenterenabledversions, "fields[appStoreVersions]": fieldsAppstoreversions, "fields[builds]": fieldsBuilds, "fields[betaAppLocalizations]": fieldsBetaapplocalizations, "fields[betaLicenseAgreements]": fieldsBetalicenseagreements, "fields[endUserLicenseAgreements]": fieldsEnduserlicenseagreements, "limit[appInfos]": limitAppinfos, "limit[appStoreVersions]": limitAppstoreversions, "limit[availableTerritories]": limitAvailableterritories, "limit[betaAppLocalizations]": limitBetaapplocalizations, "limit[betaGroups]": limitBetagroups, "limit[builds]": limitBuilds, "limit[gameCenterEnabledVersions]": limitGamecenterenabledversions, "limit[inAppPurchases]": limitInapppurchases, "limit[preReleaseVersions]": limitPrereleaseversions, "limit[prices]": limitPrices}; + path = path + check getPathForQueryParam(queryParam); + AppResponse response = check self.clientEp-> get(path, targetType = AppResponse); + return response; + } + # + # + id - the id of the requested resource + # + payload - App representation + # + return - Single App + remote isolated function appsUpdateInstance(string id, AppUpdateRequest payload) returns AppResponse|error { + string path = string `/v1/apps/${id}`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + AppResponse response = check self.clientEp->patch(path, request, targetType=AppResponse); + return response; + } + # + # + filterBetaappreviewsubmissionBetareviewstate - filter by attribute 'betaAppReviewSubmission.betaReviewState' + # + filterExpired - filter by attribute 'expired' + # + filterPrereleaseversionPlatform - filter by attribute 'preReleaseVersion.platform' + # + filterPrereleaseversionVersion - filter by attribute 'preReleaseVersion.version' + # + filterProcessingstate - filter by attribute 'processingState' + # + filterUsesnonexemptencryption - filter by attribute 'usesNonExemptEncryption' + # + filterVersion - filter by attribute 'version' + # + filterApp - filter by id(s) of related 'app' + # + filterAppstoreversion - filter by id(s) of related 'appStoreVersion' + # + filterBetagroups - filter by id(s) of related 'betaGroups' + # + filterPrereleaseversion - filter by id(s) of related 'preReleaseVersion' + # + filterId - filter by id(s) + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsBuilds - the fields to include for returned resources of type builds + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + fieldsAppencryptiondeclarations - the fields to include for returned resources of type appEncryptionDeclarations + # + fieldsBetaappreviewsubmissions - the fields to include for returned resources of type betaAppReviewSubmissions + # + fieldsBuildbetadetails - the fields to include for returned resources of type buildBetaDetails + # + fieldsBuildicons - the fields to include for returned resources of type buildIcons + # + fieldsPerfpowermetrics - the fields to include for returned resources of type perfPowerMetrics + # + fieldsPrereleaseversions - the fields to include for returned resources of type preReleaseVersions + # + fieldsAppstoreversions - the fields to include for returned resources of type appStoreVersions + # + fieldsDiagnosticsignatures - the fields to include for returned resources of type diagnosticSignatures + # + fieldsBetatesters - the fields to include for returned resources of type betaTesters + # + fieldsBetabuildlocalizations - the fields to include for returned resources of type betaBuildLocalizations + # + fieldsApps - the fields to include for returned resources of type apps + # + limitBetabuildlocalizations - maximum number of related betaBuildLocalizations returned (when they are included) + # + limitIcons - maximum number of related icons returned (when they are included) + # + limitIndividualtesters - maximum number of related individualTesters returned (when they are included) + # + return - List of Builds + remote isolated function buildsGetCollection(string[]? filterBetaappreviewsubmissionBetareviewstate = (), string[]? filterExpired = (), string[]? filterPrereleaseversionPlatform = (), string[]? filterPrereleaseversionVersion = (), string[]? filterProcessingstate = (), string[]? filterUsesnonexemptencryption = (), string[]? filterVersion = (), string[]? filterApp = (), string[]? filterAppstoreversion = (), string[]? filterBetagroups = (), string[]? filterPrereleaseversion = (), string[]? filterId = (), string[]? sort = (), string[]? fieldsBuilds = (), int? 'limit = (), string[]? include = (), string[]? fieldsAppencryptiondeclarations = (), string[]? fieldsBetaappreviewsubmissions = (), string[]? fieldsBuildbetadetails = (), string[]? fieldsBuildicons = (), string[]? fieldsPerfpowermetrics = (), string[]? fieldsPrereleaseversions = (), string[]? fieldsAppstoreversions = (), string[]? fieldsDiagnosticsignatures = (), string[]? fieldsBetatesters = (), string[]? fieldsBetabuildlocalizations = (), string[]? fieldsApps = (), int? limitBetabuildlocalizations = (), int? limitIcons = (), int? limitIndividualtesters = ()) returns BuildsResponse|error { + string path = string `/v1/builds`; + map queryParam = {"filter[betaAppReviewSubmission.betaReviewState]": filterBetaappreviewsubmissionBetareviewstate, "filter[expired]": filterExpired, "filter[preReleaseVersion.platform]": filterPrereleaseversionPlatform, "filter[preReleaseVersion.version]": filterPrereleaseversionVersion, "filter[processingState]": filterProcessingstate, "filter[usesNonExemptEncryption]": filterUsesnonexemptencryption, "filter[version]": filterVersion, "filter[app]": filterApp, "filter[appStoreVersion]": filterAppstoreversion, "filter[betaGroups]": filterBetagroups, "filter[preReleaseVersion]": filterPrereleaseversion, "filter[id]": filterId, "sort": sort, "fields[builds]": fieldsBuilds, "limit": 'limit, "include": include, "fields[appEncryptionDeclarations]": fieldsAppencryptiondeclarations, "fields[betaAppReviewSubmissions]": fieldsBetaappreviewsubmissions, "fields[buildBetaDetails]": fieldsBuildbetadetails, "fields[buildIcons]": fieldsBuildicons, "fields[perfPowerMetrics]": fieldsPerfpowermetrics, "fields[preReleaseVersions]": fieldsPrereleaseversions, "fields[appStoreVersions]": fieldsAppstoreversions, "fields[diagnosticSignatures]": fieldsDiagnosticsignatures, "fields[betaTesters]": fieldsBetatesters, "fields[betaBuildLocalizations]": fieldsBetabuildlocalizations, "fields[apps]": fieldsApps, "limit[betaBuildLocalizations]": limitBetabuildlocalizations, "limit[icons]": limitIcons, "limit[individualTesters]": limitIndividualtesters}; + path = path + check getPathForQueryParam(queryParam); + BuildsResponse response = check self.clientEp-> get(path, targetType = BuildsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBuilds - the fields to include for returned resources of type builds + # + include - comma-separated list of relationships to include + # + fieldsAppencryptiondeclarations - the fields to include for returned resources of type appEncryptionDeclarations + # + fieldsBetaappreviewsubmissions - the fields to include for returned resources of type betaAppReviewSubmissions + # + fieldsBuildbetadetails - the fields to include for returned resources of type buildBetaDetails + # + fieldsBuildicons - the fields to include for returned resources of type buildIcons + # + fieldsPerfpowermetrics - the fields to include for returned resources of type perfPowerMetrics + # + fieldsPrereleaseversions - the fields to include for returned resources of type preReleaseVersions + # + fieldsAppstoreversions - the fields to include for returned resources of type appStoreVersions + # + fieldsDiagnosticsignatures - the fields to include for returned resources of type diagnosticSignatures + # + fieldsBetatesters - the fields to include for returned resources of type betaTesters + # + fieldsBetabuildlocalizations - the fields to include for returned resources of type betaBuildLocalizations + # + fieldsApps - the fields to include for returned resources of type apps + # + limitBetabuildlocalizations - maximum number of related betaBuildLocalizations returned (when they are included) + # + limitIcons - maximum number of related icons returned (when they are included) + # + limitIndividualtesters - maximum number of related individualTesters returned (when they are included) + # + return - Single Build + remote isolated function buildsGetInstance(string id, string[]? fieldsBuilds = (), string[]? include = (), string[]? fieldsAppencryptiondeclarations = (), string[]? fieldsBetaappreviewsubmissions = (), string[]? fieldsBuildbetadetails = (), string[]? fieldsBuildicons = (), string[]? fieldsPerfpowermetrics = (), string[]? fieldsPrereleaseversions = (), string[]? fieldsAppstoreversions = (), string[]? fieldsDiagnosticsignatures = (), string[]? fieldsBetatesters = (), string[]? fieldsBetabuildlocalizations = (), string[]? fieldsApps = (), int? limitBetabuildlocalizations = (), int? limitIcons = (), int? limitIndividualtesters = ()) returns BuildResponse|error { + string path = string `/v1/builds/${id}`; + map queryParam = {"fields[builds]": fieldsBuilds, "include": include, "fields[appEncryptionDeclarations]": fieldsAppencryptiondeclarations, "fields[betaAppReviewSubmissions]": fieldsBetaappreviewsubmissions, "fields[buildBetaDetails]": fieldsBuildbetadetails, "fields[buildIcons]": fieldsBuildicons, "fields[perfPowerMetrics]": fieldsPerfpowermetrics, "fields[preReleaseVersions]": fieldsPrereleaseversions, "fields[appStoreVersions]": fieldsAppstoreversions, "fields[diagnosticSignatures]": fieldsDiagnosticsignatures, "fields[betaTesters]": fieldsBetatesters, "fields[betaBuildLocalizations]": fieldsBetabuildlocalizations, "fields[apps]": fieldsApps, "limit[betaBuildLocalizations]": limitBetabuildlocalizations, "limit[icons]": limitIcons, "limit[individualTesters]": limitIndividualtesters}; + path = path + check getPathForQueryParam(queryParam); + BuildResponse response = check self.clientEp-> get(path, targetType = BuildResponse); + return response; + } + # + # + id - the id of the requested resource + # + payload - Build representation + # + return - Single Build + remote isolated function buildsUpdateInstance(string id, BuildUpdateRequest payload) returns BuildResponse|error { + string path = string `/v1/builds/${id}`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + BuildResponse response = check self.clientEp->patch(path, request, targetType=BuildResponse); + return response; + } + # + # + filterIdentifier - filter by attribute 'identifier' + # + filterName - filter by attribute 'name' + # + filterPlatform - filter by attribute 'platform' + # + filterSeedid - filter by attribute 'seedId' + # + filterId - filter by id(s) + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsBundleids - the fields to include for returned resources of type bundleIds + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + fieldsBundleidcapabilities - the fields to include for returned resources of type bundleIdCapabilities + # + fieldsProfiles - the fields to include for returned resources of type profiles + # + fieldsApps - the fields to include for returned resources of type apps + # + limitBundleidcapabilities - maximum number of related bundleIdCapabilities returned (when they are included) + # + limitProfiles - maximum number of related profiles returned (when they are included) + # + return - List of BundleIds + remote isolated function bundleidsGetCollection(string[]? filterIdentifier = (), string[]? filterName = (), string[]? filterPlatform = (), string[]? filterSeedid = (), string[]? filterId = (), string[]? sort = (), string[]? fieldsBundleids = (), int? 'limit = (), string[]? include = (), string[]? fieldsBundleidcapabilities = (), string[]? fieldsProfiles = (), string[]? fieldsApps = (), int? limitBundleidcapabilities = (), int? limitProfiles = ()) returns BundleIdsResponse|error { + string path = string `/v1/bundleIds`; + map queryParam = {"filter[identifier]": filterIdentifier, "filter[name]": filterName, "filter[platform]": filterPlatform, "filter[seedId]": filterSeedid, "filter[id]": filterId, "sort": sort, "fields[bundleIds]": fieldsBundleids, "limit": 'limit, "include": include, "fields[bundleIdCapabilities]": fieldsBundleidcapabilities, "fields[profiles]": fieldsProfiles, "fields[apps]": fieldsApps, "limit[bundleIdCapabilities]": limitBundleidcapabilities, "limit[profiles]": limitProfiles}; + path = path + check getPathForQueryParam(queryParam); + BundleIdsResponse response = check self.clientEp-> get(path, targetType = BundleIdsResponse); + return response; + } + # + # + payload - BundleId representation + # + return - Single BundleId + remote isolated function bundleidsCreateInstance(BundleIdCreateRequest payload) returns BundleIdResponse|error { + string path = string `/v1/bundleIds`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + BundleIdResponse response = check self.clientEp->post(path, request, targetType=BundleIdResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBundleids - the fields to include for returned resources of type bundleIds + # + include - comma-separated list of relationships to include + # + fieldsBundleidcapabilities - the fields to include for returned resources of type bundleIdCapabilities + # + fieldsProfiles - the fields to include for returned resources of type profiles + # + fieldsApps - the fields to include for returned resources of type apps + # + limitBundleidcapabilities - maximum number of related bundleIdCapabilities returned (when they are included) + # + limitProfiles - maximum number of related profiles returned (when they are included) + # + return - Single BundleId + remote isolated function bundleidsGetInstance(string id, string[]? fieldsBundleids = (), string[]? include = (), string[]? fieldsBundleidcapabilities = (), string[]? fieldsProfiles = (), string[]? fieldsApps = (), int? limitBundleidcapabilities = (), int? limitProfiles = ()) returns BundleIdResponse|error { + string path = string `/v1/bundleIds/${id}`; + map queryParam = {"fields[bundleIds]": fieldsBundleids, "include": include, "fields[bundleIdCapabilities]": fieldsBundleidcapabilities, "fields[profiles]": fieldsProfiles, "fields[apps]": fieldsApps, "limit[bundleIdCapabilities]": limitBundleidcapabilities, "limit[profiles]": limitProfiles}; + path = path + check getPathForQueryParam(queryParam); + BundleIdResponse response = check self.clientEp-> get(path, targetType = BundleIdResponse); + return response; + } + # + # + id - the id of the requested resource + # + return - Success (no content) + remote isolated function bundleidsDeleteInstance(string id) returns http:Response|error { + string path = string `/v1/bundleIds/${id}`; + http:Request request = new; + //TODO: Update the request as needed; + http:Response response = check self.clientEp-> delete(path, request, targetType = http:Response); + return response; + } + # + # + id - the id of the requested resource + # + payload - BundleId representation + # + return - Single BundleId + remote isolated function bundleidsUpdateInstance(string id, BundleIdUpdateRequest payload) returns BundleIdResponse|error { + string path = string `/v1/bundleIds/${id}`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + BundleIdResponse response = check self.clientEp->patch(path, request, targetType=BundleIdResponse); + return response; + } + # + # + filterCertificatetype - filter by attribute 'certificateType' + # + filterDisplayname - filter by attribute 'displayName' + # + filterSerialnumber - filter by attribute 'serialNumber' + # + filterId - filter by id(s) + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsCertificates - the fields to include for returned resources of type certificates + # + 'limit - maximum resources per page + # + return - List of Certificates + remote isolated function certificatesGetCollection(string[]? filterCertificatetype = (), string[]? filterDisplayname = (), string[]? filterSerialnumber = (), string[]? filterId = (), string[]? sort = (), string[]? fieldsCertificates = (), int? 'limit = ()) returns CertificatesResponse|error { + string path = string `/v1/certificates`; + map queryParam = {"filter[certificateType]": filterCertificatetype, "filter[displayName]": filterDisplayname, "filter[serialNumber]": filterSerialnumber, "filter[id]": filterId, "sort": sort, "fields[certificates]": fieldsCertificates, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + CertificatesResponse response = check self.clientEp-> get(path, targetType = CertificatesResponse); + return response; + } + # + # + payload - Certificate representation + # + return - Single Certificate + remote isolated function certificatesCreateInstance(CertificateCreateRequest payload) returns CertificateResponse|error { + string path = string `/v1/certificates`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + CertificateResponse response = check self.clientEp->post(path, request, targetType=CertificateResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsCertificates - the fields to include for returned resources of type certificates + # + return - Single Certificate + remote isolated function certificatesGetInstance(string id, string[]? fieldsCertificates = ()) returns CertificateResponse|error { + string path = string `/v1/certificates/${id}`; + map queryParam = {"fields[certificates]": fieldsCertificates}; + path = path + check getPathForQueryParam(queryParam); + CertificateResponse response = check self.clientEp-> get(path, targetType = CertificateResponse); + return response; + } + # + # + id - the id of the requested resource + # + return - Success (no content) + remote isolated function certificatesDeleteInstance(string id) returns http:Response|error { + string path = string `/v1/certificates/${id}`; + http:Request request = new; + //TODO: Update the request as needed; + http:Response response = check self.clientEp-> delete(path, request, targetType = http:Response); + return response; + } + # + # + filterName - filter by attribute 'name' + # + filterPlatform - filter by attribute 'platform' + # + filterStatus - filter by attribute 'status' + # + filterUdid - filter by attribute 'udid' + # + filterId - filter by id(s) + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsDevices - the fields to include for returned resources of type devices + # + 'limit - maximum resources per page + # + return - List of Devices + remote isolated function devicesGetCollection(string[]? filterName = (), string[]? filterPlatform = (), string[]? filterStatus = (), string[]? filterUdid = (), string[]? filterId = (), string[]? sort = (), string[]? fieldsDevices = (), int? 'limit = ()) returns DevicesResponse|error { + string path = string `/v1/devices`; + map queryParam = {"filter[name]": filterName, "filter[platform]": filterPlatform, "filter[status]": filterStatus, "filter[udid]": filterUdid, "filter[id]": filterId, "sort": sort, "fields[devices]": fieldsDevices, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + DevicesResponse response = check self.clientEp-> get(path, targetType = DevicesResponse); + return response; + } + # + # + payload - Device representation + # + return - Single Device + remote isolated function devicesCreateInstance(DeviceCreateRequest payload) returns DeviceResponse|error { + string path = string `/v1/devices`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + DeviceResponse response = check self.clientEp->post(path, request, targetType=DeviceResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsDevices - the fields to include for returned resources of type devices + # + return - Single Device + remote isolated function devicesGetInstance(string id, string[]? fieldsDevices = ()) returns DeviceResponse|error { + string path = string `/v1/devices/${id}`; + map queryParam = {"fields[devices]": fieldsDevices}; + path = path + check getPathForQueryParam(queryParam); + DeviceResponse response = check self.clientEp-> get(path, targetType = DeviceResponse); + return response; + } + # + # + id - the id of the requested resource + # + payload - Device representation + # + return - Single Device + remote isolated function devicesUpdateInstance(string id, DeviceUpdateRequest payload) returns DeviceResponse|error { + string path = string `/v1/devices/${id}`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + DeviceResponse response = check self.clientEp->patch(path, request, targetType=DeviceResponse); + return response; + } + # + # + payload - EndUserLicenseAgreement representation + # + return - Single EndUserLicenseAgreement + remote isolated function enduserlicenseagreementsCreateInstance(EndUserLicenseAgreementCreateRequest payload) returns EndUserLicenseAgreementResponse|error { + string path = string `/v1/endUserLicenseAgreements`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + EndUserLicenseAgreementResponse response = check self.clientEp->post(path, request, targetType=EndUserLicenseAgreementResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsEnduserlicenseagreements - the fields to include for returned resources of type endUserLicenseAgreements + # + include - comma-separated list of relationships to include + # + fieldsTerritories - the fields to include for returned resources of type territories + # + limitTerritories - maximum number of related territories returned (when they are included) + # + return - Single EndUserLicenseAgreement + remote isolated function enduserlicenseagreementsGetInstance(string id, string[]? fieldsEnduserlicenseagreements = (), string[]? include = (), string[]? fieldsTerritories = (), int? limitTerritories = ()) returns EndUserLicenseAgreementResponse|error { + string path = string `/v1/endUserLicenseAgreements/${id}`; + map queryParam = {"fields[endUserLicenseAgreements]": fieldsEnduserlicenseagreements, "include": include, "fields[territories]": fieldsTerritories, "limit[territories]": limitTerritories}; + path = path + check getPathForQueryParam(queryParam); + EndUserLicenseAgreementResponse response = check self.clientEp-> get(path, targetType = EndUserLicenseAgreementResponse); + return response; + } + # + # + id - the id of the requested resource + # + return - Success (no content) + remote isolated function enduserlicenseagreementsDeleteInstance(string id) returns http:Response|error { + string path = string `/v1/endUserLicenseAgreements/${id}`; + http:Request request = new; + //TODO: Update the request as needed; + http:Response response = check self.clientEp-> delete(path, request, targetType = http:Response); + return response; + } + # + # + id - the id of the requested resource + # + payload - EndUserLicenseAgreement representation + # + return - Single EndUserLicenseAgreement + remote isolated function enduserlicenseagreementsUpdateInstance(string id, EndUserLicenseAgreementUpdateRequest payload) returns EndUserLicenseAgreementResponse|error { + string path = string `/v1/endUserLicenseAgreements/${id}`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + EndUserLicenseAgreementResponse response = check self.clientEp->patch(path, request, targetType=EndUserLicenseAgreementResponse); + return response; + } + # + # + filterRegioncode - filter by attribute 'regionCode' + # + filterReportdate - filter by attribute 'reportDate' + # + filterReporttype - filter by attribute 'reportType' + # + filterVendornumber - filter by attribute 'vendorNumber' + # + return - List of FinanceReports + remote isolated function financereportsGetCollection(string[] filterRegioncode, string[] filterReportdate, string[] filterReporttype, string[] filterVendornumber) returns string|error { + string path = string `/v1/financeReports`; + map queryParam = {"filter[regionCode]": filterRegioncode, "filter[reportDate]": filterReportdate, "filter[reportType]": filterReporttype, "filter[vendorNumber]": filterVendornumber}; + path = path + check getPathForQueryParam(queryParam); + string response = check self.clientEp-> get(path, targetType = string); + return response; + } + # + # + id - the id of the requested resource + # + fieldsInapppurchases - the fields to include for returned resources of type inAppPurchases + # + include - comma-separated list of relationships to include + # + limitApps - maximum number of related apps returned (when they are included) + # + return - Single InAppPurchase + remote isolated function inapppurchasesGetInstance(string id, string[]? fieldsInapppurchases = (), string[]? include = (), int? limitApps = ()) returns InAppPurchaseResponse|error { + string path = string `/v1/inAppPurchases/${id}`; + map queryParam = {"fields[inAppPurchases]": fieldsInapppurchases, "include": include, "limit[apps]": limitApps}; + path = path + check getPathForQueryParam(queryParam); + InAppPurchaseResponse response = check self.clientEp-> get(path, targetType = InAppPurchaseResponse); + return response; + } + # + # + filterName - filter by attribute 'name' + # + filterProfilestate - filter by attribute 'profileState' + # + filterProfiletype - filter by attribute 'profileType' + # + filterId - filter by id(s) + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsProfiles - the fields to include for returned resources of type profiles + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + fieldsCertificates - the fields to include for returned resources of type certificates + # + fieldsDevices - the fields to include for returned resources of type devices + # + fieldsBundleids - the fields to include for returned resources of type bundleIds + # + limitCertificates - maximum number of related certificates returned (when they are included) + # + limitDevices - maximum number of related devices returned (when they are included) + # + return - List of Profiles + remote isolated function profilesGetCollection(string[]? filterName = (), string[]? filterProfilestate = (), string[]? filterProfiletype = (), string[]? filterId = (), string[]? sort = (), string[]? fieldsProfiles = (), int? 'limit = (), string[]? include = (), string[]? fieldsCertificates = (), string[]? fieldsDevices = (), string[]? fieldsBundleids = (), int? limitCertificates = (), int? limitDevices = ()) returns ProfilesResponse|error { + string path = string `/v1/profiles`; + map queryParam = {"filter[name]": filterName, "filter[profileState]": filterProfilestate, "filter[profileType]": filterProfiletype, "filter[id]": filterId, "sort": sort, "fields[profiles]": fieldsProfiles, "limit": 'limit, "include": include, "fields[certificates]": fieldsCertificates, "fields[devices]": fieldsDevices, "fields[bundleIds]": fieldsBundleids, "limit[certificates]": limitCertificates, "limit[devices]": limitDevices}; + path = path + check getPathForQueryParam(queryParam); + ProfilesResponse response = check self.clientEp-> get(path, targetType = ProfilesResponse); + return response; + } + # + # + payload - Profile representation + # + return - Single Profile + remote isolated function profilesCreateInstance(ProfileCreateRequest payload) returns ProfileResponse|error { + string path = string `/v1/profiles`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + ProfileResponse response = check self.clientEp->post(path, request, targetType=ProfileResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsProfiles - the fields to include for returned resources of type profiles + # + include - comma-separated list of relationships to include + # + fieldsCertificates - the fields to include for returned resources of type certificates + # + fieldsDevices - the fields to include for returned resources of type devices + # + fieldsBundleids - the fields to include for returned resources of type bundleIds + # + limitCertificates - maximum number of related certificates returned (when they are included) + # + limitDevices - maximum number of related devices returned (when they are included) + # + return - Single Profile + remote isolated function profilesGetInstance(string id, string[]? fieldsProfiles = (), string[]? include = (), string[]? fieldsCertificates = (), string[]? fieldsDevices = (), string[]? fieldsBundleids = (), int? limitCertificates = (), int? limitDevices = ()) returns ProfileResponse|error { + string path = string `/v1/profiles/${id}`; + map queryParam = {"fields[profiles]": fieldsProfiles, "include": include, "fields[certificates]": fieldsCertificates, "fields[devices]": fieldsDevices, "fields[bundleIds]": fieldsBundleids, "limit[certificates]": limitCertificates, "limit[devices]": limitDevices}; + path = path + check getPathForQueryParam(queryParam); + ProfileResponse response = check self.clientEp-> get(path, targetType = ProfileResponse); + return response; + } + # + # + id - the id of the requested resource + # + return - Success (no content) + remote isolated function profilesDeleteInstance(string id) returns http:Response|error { + string path = string `/v1/profiles/${id}`; + http:Request request = new; + //TODO: Update the request as needed; + http:Response response = check self.clientEp-> delete(path, request, targetType = http:Response); + return response; + } + # + # + filterEmail - filter by attribute 'email' + # + filterRoles - filter by attribute 'roles' + # + filterVisibleapps - filter by id(s) of related 'visibleApps' + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsUserinvitations - the fields to include for returned resources of type userInvitations + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + fieldsApps - the fields to include for returned resources of type apps + # + limitVisibleapps - maximum number of related visibleApps returned (when they are included) + # + return - List of UserInvitations + remote isolated function userinvitationsGetCollection(string[]? filterEmail = (), string[]? filterRoles = (), string[]? filterVisibleapps = (), string[]? sort = (), string[]? fieldsUserinvitations = (), int? 'limit = (), string[]? include = (), string[]? fieldsApps = (), int? limitVisibleapps = ()) returns UserInvitationsResponse|error { + string path = string `/v1/userInvitations`; + map queryParam = {"filter[email]": filterEmail, "filter[roles]": filterRoles, "filter[visibleApps]": filterVisibleapps, "sort": sort, "fields[userInvitations]": fieldsUserinvitations, "limit": 'limit, "include": include, "fields[apps]": fieldsApps, "limit[visibleApps]": limitVisibleapps}; + path = path + check getPathForQueryParam(queryParam); + UserInvitationsResponse response = check self.clientEp-> get(path, targetType = UserInvitationsResponse); + return response; + } + # + # + payload - UserInvitation representation + # + return - Single UserInvitation + remote isolated function userinvitationsCreateInstance(UserInvitationCreateRequest payload) returns UserInvitationResponse|error { + string path = string `/v1/userInvitations`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + UserInvitationResponse response = check self.clientEp->post(path, request, targetType=UserInvitationResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsUserinvitations - the fields to include for returned resources of type userInvitations + # + include - comma-separated list of relationships to include + # + fieldsApps - the fields to include for returned resources of type apps + # + limitVisibleapps - maximum number of related visibleApps returned (when they are included) + # + return - Single UserInvitation + remote isolated function userinvitationsGetInstance(string id, string[]? fieldsUserinvitations = (), string[]? include = (), string[]? fieldsApps = (), int? limitVisibleapps = ()) returns UserInvitationResponse|error { + string path = string `/v1/userInvitations/${id}`; + map queryParam = {"fields[userInvitations]": fieldsUserinvitations, "include": include, "fields[apps]": fieldsApps, "limit[visibleApps]": limitVisibleapps}; + path = path + check getPathForQueryParam(queryParam); + UserInvitationResponse response = check self.clientEp-> get(path, targetType = UserInvitationResponse); + return response; + } + # + # + id - the id of the requested resource + # + return - Success (no content) + remote isolated function userinvitationsDeleteInstance(string id) returns http:Response|error { + string path = string `/v1/userInvitations/${id}`; + http:Request request = new; + //TODO: Update the request as needed; + http:Response response = check self.clientEp-> delete(path, request, targetType = http:Response); + return response; + } + # + # + filterRoles - filter by attribute 'roles' + # + filterUsername - filter by attribute 'username' + # + filterVisibleapps - filter by id(s) of related 'visibleApps' + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsUsers - the fields to include for returned resources of type users + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + fieldsApps - the fields to include for returned resources of type apps + # + limitVisibleapps - maximum number of related visibleApps returned (when they are included) + # + return - List of Users + remote isolated function usersGetCollection(string[]? filterRoles = (), string[]? filterUsername = (), string[]? filterVisibleapps = (), string[]? sort = (), string[]? fieldsUsers = (), int? 'limit = (), string[]? include = (), string[]? fieldsApps = (), int? limitVisibleapps = ()) returns UsersResponse|error { + string path = string `/v1/users`; + map queryParam = {"filter[roles]": filterRoles, "filter[username]": filterUsername, "filter[visibleApps]": filterVisibleapps, "sort": sort, "fields[users]": fieldsUsers, "limit": 'limit, "include": include, "fields[apps]": fieldsApps, "limit[visibleApps]": limitVisibleapps}; + path = path + check getPathForQueryParam(queryParam); + UsersResponse response = check self.clientEp-> get(path, targetType = UsersResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsUsers - the fields to include for returned resources of type users + # + include - comma-separated list of relationships to include + # + fieldsApps - the fields to include for returned resources of type apps + # + limitVisibleapps - maximum number of related visibleApps returned (when they are included) + # + return - Single User + remote isolated function usersGetInstance(string id, string[]? fieldsUsers = (), string[]? include = (), string[]? fieldsApps = (), int? limitVisibleapps = ()) returns UserResponse|error { + string path = string `/v1/users/${id}`; + map queryParam = {"fields[users]": fieldsUsers, "include": include, "fields[apps]": fieldsApps, "limit[visibleApps]": limitVisibleapps}; + path = path + check getPathForQueryParam(queryParam); + UserResponse response = check self.clientEp-> get(path, targetType = UserResponse); + return response; + } + # + # + id - the id of the requested resource + # + return - Success (no content) + remote isolated function usersDeleteInstance(string id) returns http:Response|error { + string path = string `/v1/users/${id}`; + http:Request request = new; + //TODO: Update the request as needed; + http:Response response = check self.clientEp-> delete(path, request, targetType = http:Response); + return response; + } + # + # + id - the id of the requested resource + # + payload - User representation + # + return - Single User + remote isolated function usersUpdateInstance(string id, UserUpdateRequest payload) returns UserResponse|error { + string path = string `/v1/users/${id}`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + UserResponse response = check self.clientEp->patch(path, request, targetType=UserResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + return - Related resource + remote isolated function appcategoriesParentGetToOneRelated(string id, string[]? fieldsAppcategories = ()) returns AppCategoryResponse|error { + string path = string `/v1/appCategories/${id}/parent`; + map queryParam = {"fields[appCategories]": fieldsAppcategories}; + path = path + check getPathForQueryParam(queryParam); + AppCategoryResponse response = check self.clientEp-> get(path, targetType = AppCategoryResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function appcategoriesSubcategoriesGetToManyRelated(string id, string[]? fieldsAppcategories = (), int? 'limit = ()) returns AppCategoriesResponse|error { + string path = string `/v1/appCategories/${id}/subcategories`; + map queryParam = {"fields[appCategories]": fieldsAppcategories, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + AppCategoriesResponse response = check self.clientEp-> get(path, targetType = AppCategoriesResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAgeratingdeclarations - the fields to include for returned resources of type ageRatingDeclarations + # + return - Related resource + remote isolated function appinfosAgeratingdeclarationGetToOneRelated(string id, string[]? fieldsAgeratingdeclarations = ()) returns AgeRatingDeclarationResponse|error { + string path = string `/v1/appInfos/${id}/ageRatingDeclaration`; + map queryParam = {"fields[ageRatingDeclarations]": fieldsAgeratingdeclarations}; + path = path + check getPathForQueryParam(queryParam); + AgeRatingDeclarationResponse response = check self.clientEp-> get(path, targetType = AgeRatingDeclarationResponse); + return response; + } + # + # + id - the id of the requested resource + # + filterLocale - filter by attribute 'locale' + # + fieldsAppinfos - the fields to include for returned resources of type appInfos + # + fieldsAppinfolocalizations - the fields to include for returned resources of type appInfoLocalizations + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + return - List of related resources + remote isolated function appinfosAppinfolocalizationsGetToManyRelated(string id, string[]? filterLocale = (), string[]? fieldsAppinfos = (), string[]? fieldsAppinfolocalizations = (), int? 'limit = (), string[]? include = ()) returns AppInfoLocalizationsResponse|error { + string path = string `/v1/appInfos/${id}/appInfoLocalizations`; + map queryParam = {"filter[locale]": filterLocale, "fields[appInfos]": fieldsAppinfos, "fields[appInfoLocalizations]": fieldsAppinfolocalizations, "limit": 'limit, "include": include}; + path = path + check getPathForQueryParam(queryParam); + AppInfoLocalizationsResponse response = check self.clientEp-> get(path, targetType = AppInfoLocalizationsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + return - Related resource + remote isolated function appinfosPrimarycategoryGetToOneRelated(string id, string[]? fieldsAppcategories = ()) returns AppCategoryResponse|error { + string path = string `/v1/appInfos/${id}/primaryCategory`; + map queryParam = {"fields[appCategories]": fieldsAppcategories}; + path = path + check getPathForQueryParam(queryParam); + AppCategoryResponse response = check self.clientEp-> get(path, targetType = AppCategoryResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + return - Related resource + remote isolated function appinfosPrimarysubcategoryoneGetToOneRelated(string id, string[]? fieldsAppcategories = ()) returns AppCategoryResponse|error { + string path = string `/v1/appInfos/${id}/primarySubcategoryOne`; + map queryParam = {"fields[appCategories]": fieldsAppcategories}; + path = path + check getPathForQueryParam(queryParam); + AppCategoryResponse response = check self.clientEp-> get(path, targetType = AppCategoryResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + return - Related resource + remote isolated function appinfosPrimarysubcategorytwoGetToOneRelated(string id, string[]? fieldsAppcategories = ()) returns AppCategoryResponse|error { + string path = string `/v1/appInfos/${id}/primarySubcategoryTwo`; + map queryParam = {"fields[appCategories]": fieldsAppcategories}; + path = path + check getPathForQueryParam(queryParam); + AppCategoryResponse response = check self.clientEp-> get(path, targetType = AppCategoryResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + return - Related resource + remote isolated function appinfosSecondarycategoryGetToOneRelated(string id, string[]? fieldsAppcategories = ()) returns AppCategoryResponse|error { + string path = string `/v1/appInfos/${id}/secondaryCategory`; + map queryParam = {"fields[appCategories]": fieldsAppcategories}; + path = path + check getPathForQueryParam(queryParam); + AppCategoryResponse response = check self.clientEp-> get(path, targetType = AppCategoryResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + return - Related resource + remote isolated function appinfosSecondarysubcategoryoneGetToOneRelated(string id, string[]? fieldsAppcategories = ()) returns AppCategoryResponse|error { + string path = string `/v1/appInfos/${id}/secondarySubcategoryOne`; + map queryParam = {"fields[appCategories]": fieldsAppcategories}; + path = path + check getPathForQueryParam(queryParam); + AppCategoryResponse response = check self.clientEp-> get(path, targetType = AppCategoryResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + return - Related resource + remote isolated function appinfosSecondarysubcategorytwoGetToOneRelated(string id, string[]? fieldsAppcategories = ()) returns AppCategoryResponse|error { + string path = string `/v1/appInfos/${id}/secondarySubcategoryTwo`; + map queryParam = {"fields[appCategories]": fieldsAppcategories}; + path = path + check getPathForQueryParam(queryParam); + AppCategoryResponse response = check self.clientEp-> get(path, targetType = AppCategoryResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsTerritories - the fields to include for returned resources of type territories + # + return - Related resource + remote isolated function apppricepointsTerritoryGetToOneRelated(string id, string[]? fieldsTerritories = ()) returns TerritoryResponse|error { + string path = string `/v1/appPricePoints/${id}/territory`; + map queryParam = {"fields[territories]": fieldsTerritories}; + path = path + check getPathForQueryParam(queryParam); + TerritoryResponse response = check self.clientEp-> get(path, targetType = TerritoryResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsApppricepoints - the fields to include for returned resources of type appPricePoints + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function apppricetiersPricepointsGetToManyRelated(string id, string[]? fieldsApppricepoints = (), int? 'limit = ()) returns AppPricePointsResponse|error { + string path = string `/v1/appPriceTiers/${id}/pricePoints`; + map queryParam = {"fields[appPricePoints]": fieldsApppricepoints, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + AppPricePointsResponse response = check self.clientEp-> get(path, targetType = AppPricePointsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAgeratingdeclarations - the fields to include for returned resources of type ageRatingDeclarations + # + fieldsAppinfos - the fields to include for returned resources of type appInfos + # + fieldsAppcategories - the fields to include for returned resources of type appCategories + # + fieldsAppinfolocalizations - the fields to include for returned resources of type appInfoLocalizations + # + fieldsApps - the fields to include for returned resources of type apps + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + return - List of related resources + remote isolated function appsAppinfosGetToManyRelated(string id, string[]? fieldsAgeratingdeclarations = (), string[]? fieldsAppinfos = (), string[]? fieldsAppcategories = (), string[]? fieldsAppinfolocalizations = (), string[]? fieldsApps = (), int? 'limit = (), string[]? include = ()) returns AppInfosResponse|error { + string path = string `/v1/apps/${id}/appInfos`; + map queryParam = {"fields[ageRatingDeclarations]": fieldsAgeratingdeclarations, "fields[appInfos]": fieldsAppinfos, "fields[appCategories]": fieldsAppcategories, "fields[appInfoLocalizations]": fieldsAppinfolocalizations, "fields[apps]": fieldsApps, "limit": 'limit, "include": include}; + path = path + check getPathForQueryParam(queryParam); + AppInfosResponse response = check self.clientEp-> get(path, targetType = AppInfosResponse); + return response; + } + # + # + id - the id of the requested resource + # + filterAppstorestate - filter by attribute 'appStoreState' + # + filterPlatform - filter by attribute 'platform' + # + filterVersionstring - filter by attribute 'versionString' + # + filterId - filter by id(s) + # + fieldsIdfadeclarations - the fields to include for returned resources of type idfaDeclarations + # + fieldsAppstoreversionlocalizations - the fields to include for returned resources of type appStoreVersionLocalizations + # + fieldsRoutingappcoverages - the fields to include for returned resources of type routingAppCoverages + # + fieldsAppstoreversionphasedreleases - the fields to include for returned resources of type appStoreVersionPhasedReleases + # + fieldsAgeratingdeclarations - the fields to include for returned resources of type ageRatingDeclarations + # + fieldsAppstorereviewdetails - the fields to include for returned resources of type appStoreReviewDetails + # + fieldsAppstoreversions - the fields to include for returned resources of type appStoreVersions + # + fieldsBuilds - the fields to include for returned resources of type builds + # + fieldsAppstoreversionsubmissions - the fields to include for returned resources of type appStoreVersionSubmissions + # + fieldsApps - the fields to include for returned resources of type apps + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + return - List of related resources + remote isolated function appsAppstoreversionsGetToManyRelated(string id, string[]? filterAppstorestate = (), string[]? filterPlatform = (), string[]? filterVersionstring = (), string[]? filterId = (), string[]? fieldsIdfadeclarations = (), string[]? fieldsAppstoreversionlocalizations = (), string[]? fieldsRoutingappcoverages = (), string[]? fieldsAppstoreversionphasedreleases = (), string[]? fieldsAgeratingdeclarations = (), string[]? fieldsAppstorereviewdetails = (), string[]? fieldsAppstoreversions = (), string[]? fieldsBuilds = (), string[]? fieldsAppstoreversionsubmissions = (), string[]? fieldsApps = (), int? 'limit = (), string[]? include = ()) returns AppStoreVersionsResponse|error { + string path = string `/v1/apps/${id}/appStoreVersions`; + map queryParam = {"filter[appStoreState]": filterAppstorestate, "filter[platform]": filterPlatform, "filter[versionString]": filterVersionstring, "filter[id]": filterId, "fields[idfaDeclarations]": fieldsIdfadeclarations, "fields[appStoreVersionLocalizations]": fieldsAppstoreversionlocalizations, "fields[routingAppCoverages]": fieldsRoutingappcoverages, "fields[appStoreVersionPhasedReleases]": fieldsAppstoreversionphasedreleases, "fields[ageRatingDeclarations]": fieldsAgeratingdeclarations, "fields[appStoreReviewDetails]": fieldsAppstorereviewdetails, "fields[appStoreVersions]": fieldsAppstoreversions, "fields[builds]": fieldsBuilds, "fields[appStoreVersionSubmissions]": fieldsAppstoreversionsubmissions, "fields[apps]": fieldsApps, "limit": 'limit, "include": include}; + path = path + check getPathForQueryParam(queryParam); + AppStoreVersionsResponse response = check self.clientEp-> get(path, targetType = AppStoreVersionsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsTerritories - the fields to include for returned resources of type territories + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function appsAvailableterritoriesGetToManyRelated(string id, string[]? fieldsTerritories = (), int? 'limit = ()) returns TerritoriesResponse|error { + string path = string `/v1/apps/${id}/availableTerritories`; + map queryParam = {"fields[territories]": fieldsTerritories, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + TerritoriesResponse response = check self.clientEp-> get(path, targetType = TerritoriesResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBetaapplocalizations - the fields to include for returned resources of type betaAppLocalizations + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function appsBetaapplocalizationsGetToManyRelated(string id, string[]? fieldsBetaapplocalizations = (), int? 'limit = ()) returns BetaAppLocalizationsResponse|error { + string path = string `/v1/apps/${id}/betaAppLocalizations`; + map queryParam = {"fields[betaAppLocalizations]": fieldsBetaapplocalizations, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + BetaAppLocalizationsResponse response = check self.clientEp-> get(path, targetType = BetaAppLocalizationsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBetaappreviewdetails - the fields to include for returned resources of type betaAppReviewDetails + # + return - Related resource + remote isolated function appsBetaappreviewdetailGetToOneRelated(string id, string[]? fieldsBetaappreviewdetails = ()) returns BetaAppReviewDetailResponse|error { + string path = string `/v1/apps/${id}/betaAppReviewDetail`; + map queryParam = {"fields[betaAppReviewDetails]": fieldsBetaappreviewdetails}; + path = path + check getPathForQueryParam(queryParam); + BetaAppReviewDetailResponse response = check self.clientEp-> get(path, targetType = BetaAppReviewDetailResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBetagroups - the fields to include for returned resources of type betaGroups + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function appsBetagroupsGetToManyRelated(string id, string[]? fieldsBetagroups = (), int? 'limit = ()) returns BetaGroupsResponse|error { + string path = string `/v1/apps/${id}/betaGroups`; + map queryParam = {"fields[betaGroups]": fieldsBetagroups, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + BetaGroupsResponse response = check self.clientEp-> get(path, targetType = BetaGroupsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBetalicenseagreements - the fields to include for returned resources of type betaLicenseAgreements + # + return - Related resource + remote isolated function appsBetalicenseagreementGetToOneRelated(string id, string[]? fieldsBetalicenseagreements = ()) returns BetaLicenseAgreementResponse|error { + string path = string `/v1/apps/${id}/betaLicenseAgreement`; + map queryParam = {"fields[betaLicenseAgreements]": fieldsBetalicenseagreements}; + path = path + check getPathForQueryParam(queryParam); + BetaLicenseAgreementResponse response = check self.clientEp-> get(path, targetType = BetaLicenseAgreementResponse); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function appsBetatestersDeleteToManyRelationship(string id, AppBetaTestersLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/apps/${id}/relationships/betaTesters`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->delete(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBuilds - the fields to include for returned resources of type builds + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function appsBuildsGetToManyRelated(string id, string[]? fieldsBuilds = (), int? 'limit = ()) returns BuildsResponse|error { + string path = string `/v1/apps/${id}/builds`; + map queryParam = {"fields[builds]": fieldsBuilds, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + BuildsResponse response = check self.clientEp-> get(path, targetType = BuildsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsEnduserlicenseagreements - the fields to include for returned resources of type endUserLicenseAgreements + # + return - Related resource + remote isolated function appsEnduserlicenseagreementGetToOneRelated(string id, string[]? fieldsEnduserlicenseagreements = ()) returns EndUserLicenseAgreementResponse|error { + string path = string `/v1/apps/${id}/endUserLicenseAgreement`; + map queryParam = {"fields[endUserLicenseAgreements]": fieldsEnduserlicenseagreements}; + path = path + check getPathForQueryParam(queryParam); + EndUserLicenseAgreementResponse response = check self.clientEp-> get(path, targetType = EndUserLicenseAgreementResponse); + return response; + } + # + # + id - the id of the requested resource + # + filterPlatform - filter by attribute 'platform' + # + filterVersionstring - filter by attribute 'versionString' + # + filterId - filter by id(s) + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsGamecenterenabledversions - the fields to include for returned resources of type gameCenterEnabledVersions + # + fieldsApps - the fields to include for returned resources of type apps + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + return - List of related resources + remote isolated function appsGamecenterenabledversionsGetToManyRelated(string id, string[]? filterPlatform = (), string[]? filterVersionstring = (), string[]? filterId = (), string[]? sort = (), string[]? fieldsGamecenterenabledversions = (), string[]? fieldsApps = (), int? 'limit = (), string[]? include = ()) returns GameCenterEnabledVersionsResponse|error { + string path = string `/v1/apps/${id}/gameCenterEnabledVersions`; + map queryParam = {"filter[platform]": filterPlatform, "filter[versionString]": filterVersionstring, "filter[id]": filterId, "sort": sort, "fields[gameCenterEnabledVersions]": fieldsGamecenterenabledversions, "fields[apps]": fieldsApps, "limit": 'limit, "include": include}; + path = path + check getPathForQueryParam(queryParam); + GameCenterEnabledVersionsResponse response = check self.clientEp-> get(path, targetType = GameCenterEnabledVersionsResponse); + return response; + } + # + # + id - the id of the requested resource + # + filterInapppurchasetype - filter by attribute 'inAppPurchaseType' + # + filterCanbesubmitted - filter by canBeSubmitted + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsInapppurchases - the fields to include for returned resources of type inAppPurchases + # + fieldsApps - the fields to include for returned resources of type apps + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + return - List of related resources + remote isolated function appsInapppurchasesGetToManyRelated(string id, string[]? filterInapppurchasetype = (), string[]? filterCanbesubmitted = (), string[]? sort = (), string[]? fieldsInapppurchases = (), string[]? fieldsApps = (), int? 'limit = (), string[]? include = ()) returns InAppPurchasesResponse|error { + string path = string `/v1/apps/${id}/inAppPurchases`; + map queryParam = {"filter[inAppPurchaseType]": filterInapppurchasetype, "filter[canBeSubmitted]": filterCanbesubmitted, "sort": sort, "fields[inAppPurchases]": fieldsInapppurchases, "fields[apps]": fieldsApps, "limit": 'limit, "include": include}; + path = path + check getPathForQueryParam(queryParam); + InAppPurchasesResponse response = check self.clientEp-> get(path, targetType = InAppPurchasesResponse); + return response; + } + # + # + id - the id of the requested resource + # + filterDevicetype - filter by attribute 'deviceType' + # + filterMetrictype - filter by attribute 'metricType' + # + filterPlatform - filter by attribute 'platform' + # + return - List of related resources + remote isolated function appsPerfpowermetricsGetToManyRelated(string id, string[]? filterDevicetype = (), string[]? filterMetrictype = (), string[]? filterPlatform = ()) returns PerfPowerMetricsResponse|error { + string path = string `/v1/apps/${id}/perfPowerMetrics`; + map queryParam = {"filter[deviceType]": filterDevicetype, "filter[metricType]": filterMetrictype, "filter[platform]": filterPlatform}; + path = path + check getPathForQueryParam(queryParam); + PerfPowerMetricsResponse response = check self.clientEp-> get(path, targetType = PerfPowerMetricsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsApppreorders - the fields to include for returned resources of type appPreOrders + # + return - Related resource + remote isolated function appsPreorderGetToOneRelated(string id, string[]? fieldsApppreorders = ()) returns AppPreOrderResponse|error { + string path = string `/v1/apps/${id}/preOrder`; + map queryParam = {"fields[appPreOrders]": fieldsApppreorders}; + path = path + check getPathForQueryParam(queryParam); + AppPreOrderResponse response = check self.clientEp-> get(path, targetType = AppPreOrderResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsPrereleaseversions - the fields to include for returned resources of type preReleaseVersions + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function appsPrereleaseversionsGetToManyRelated(string id, string[]? fieldsPrereleaseversions = (), int? 'limit = ()) returns PreReleaseVersionsResponse|error { + string path = string `/v1/apps/${id}/preReleaseVersions`; + map queryParam = {"fields[preReleaseVersions]": fieldsPrereleaseversions, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + PreReleaseVersionsResponse response = check self.clientEp-> get(path, targetType = PreReleaseVersionsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppprices - the fields to include for returned resources of type appPrices + # + fieldsApppricetiers - the fields to include for returned resources of type appPriceTiers + # + fieldsApps - the fields to include for returned resources of type apps + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + return - List of related resources + remote isolated function appsPricesGetToManyRelated(string id, string[]? fieldsAppprices = (), string[]? fieldsApppricetiers = (), string[]? fieldsApps = (), int? 'limit = (), string[]? include = ()) returns AppPricesResponse|error { + string path = string `/v1/apps/${id}/prices`; + map queryParam = {"fields[appPrices]": fieldsAppprices, "fields[appPriceTiers]": fieldsApppricetiers, "fields[apps]": fieldsApps, "limit": 'limit, "include": include}; + path = path + check getPathForQueryParam(queryParam); + AppPricesResponse response = check self.clientEp-> get(path, targetType = AppPricesResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsApps - the fields to include for returned resources of type apps + # + return - Related resource + remote isolated function buildsAppGetToOneRelated(string id, string[]? fieldsApps = ()) returns AppResponse|error { + string path = string `/v1/builds/${id}/app`; + map queryParam = {"fields[apps]": fieldsApps}; + path = path + check getPathForQueryParam(queryParam); + AppResponse response = check self.clientEp-> get(path, targetType = AppResponse); + return response; + } + # + # + id - the id of the requested resource + # + return - Related linkage + remote isolated function buildsAppencryptiondeclarationGetToOneRelationship(string id) returns BuildAppEncryptionDeclarationLinkageResponse|error { + string path = string `/v1/builds/${id}/relationships/appEncryptionDeclaration`; + BuildAppEncryptionDeclarationLinkageResponse response = check self.clientEp-> get(path, targetType = BuildAppEncryptionDeclarationLinkageResponse); + return response; + } + # + # + id - the id of the requested resource + # + payload - Related linkage + # + return - Success (no content) + remote isolated function buildsAppencryptiondeclarationUpdateToOneRelationship(string id, BuildAppEncryptionDeclarationLinkageRequest payload) returns http:Response|error { + string path = string `/v1/builds/${id}/relationships/appEncryptionDeclaration`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->patch(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppencryptiondeclarations - the fields to include for returned resources of type appEncryptionDeclarations + # + return - Related resource + remote isolated function buildsAppencryptiondeclarationGetToOneRelated(string id, string[]? fieldsAppencryptiondeclarations = ()) returns AppEncryptionDeclarationResponse|error { + string path = string `/v1/builds/${id}/appEncryptionDeclaration`; + map queryParam = {"fields[appEncryptionDeclarations]": fieldsAppencryptiondeclarations}; + path = path + check getPathForQueryParam(queryParam); + AppEncryptionDeclarationResponse response = check self.clientEp-> get(path, targetType = AppEncryptionDeclarationResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsAppstoreversions - the fields to include for returned resources of type appStoreVersions + # + return - Related resource + remote isolated function buildsAppstoreversionGetToOneRelated(string id, string[]? fieldsAppstoreversions = ()) returns AppStoreVersionResponse|error { + string path = string `/v1/builds/${id}/appStoreVersion`; + map queryParam = {"fields[appStoreVersions]": fieldsAppstoreversions}; + path = path + check getPathForQueryParam(queryParam); + AppStoreVersionResponse response = check self.clientEp-> get(path, targetType = AppStoreVersionResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBetaappreviewsubmissions - the fields to include for returned resources of type betaAppReviewSubmissions + # + return - Related resource + remote isolated function buildsBetaappreviewsubmissionGetToOneRelated(string id, string[]? fieldsBetaappreviewsubmissions = ()) returns BetaAppReviewSubmissionResponse|error { + string path = string `/v1/builds/${id}/betaAppReviewSubmission`; + map queryParam = {"fields[betaAppReviewSubmissions]": fieldsBetaappreviewsubmissions}; + path = path + check getPathForQueryParam(queryParam); + BetaAppReviewSubmissionResponse response = check self.clientEp-> get(path, targetType = BetaAppReviewSubmissionResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBetabuildlocalizations - the fields to include for returned resources of type betaBuildLocalizations + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function buildsBetabuildlocalizationsGetToManyRelated(string id, string[]? fieldsBetabuildlocalizations = (), int? 'limit = ()) returns BetaBuildLocalizationsResponse|error { + string path = string `/v1/builds/${id}/betaBuildLocalizations`; + map queryParam = {"fields[betaBuildLocalizations]": fieldsBetabuildlocalizations, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + BetaBuildLocalizationsResponse response = check self.clientEp-> get(path, targetType = BetaBuildLocalizationsResponse); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function buildsBetagroupsCreateToManyRelationship(string id, BuildBetaGroupsLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/builds/${id}/relationships/betaGroups`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->post(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function buildsBetagroupsDeleteToManyRelationship(string id, BuildBetaGroupsLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/builds/${id}/relationships/betaGroups`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->delete(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBuildbetadetails - the fields to include for returned resources of type buildBetaDetails + # + return - Related resource + remote isolated function buildsBuildbetadetailGetToOneRelated(string id, string[]? fieldsBuildbetadetails = ()) returns BuildBetaDetailResponse|error { + string path = string `/v1/builds/${id}/buildBetaDetail`; + map queryParam = {"fields[buildBetaDetails]": fieldsBuildbetadetails}; + path = path + check getPathForQueryParam(queryParam); + BuildBetaDetailResponse response = check self.clientEp-> get(path, targetType = BuildBetaDetailResponse); + return response; + } + # + # + id - the id of the requested resource + # + filterDiagnostictype - filter by attribute 'diagnosticType' + # + fieldsDiagnosticsignatures - the fields to include for returned resources of type diagnosticSignatures + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function buildsDiagnosticsignaturesGetToManyRelated(string id, string[]? filterDiagnostictype = (), string[]? fieldsDiagnosticsignatures = (), int? 'limit = ()) returns DiagnosticSignaturesResponse|error { + string path = string `/v1/builds/${id}/diagnosticSignatures`; + map queryParam = {"filter[diagnosticType]": filterDiagnostictype, "fields[diagnosticSignatures]": fieldsDiagnosticsignatures, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + DiagnosticSignaturesResponse response = check self.clientEp-> get(path, targetType = DiagnosticSignaturesResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBuildicons - the fields to include for returned resources of type buildIcons + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function buildsIconsGetToManyRelated(string id, string[]? fieldsBuildicons = (), int? 'limit = ()) returns BuildIconsResponse|error { + string path = string `/v1/builds/${id}/icons`; + map queryParam = {"fields[buildIcons]": fieldsBuildicons, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + BuildIconsResponse response = check self.clientEp-> get(path, targetType = BuildIconsResponse); + return response; + } + # + # + id - the id of the requested resource + # + 'limit - maximum resources per page + # + return - List of related linkages + remote isolated function buildsIndividualtestersGetToManyRelationship(string id, int? 'limit = ()) returns BuildIndividualTestersLinkagesResponse|error { + string path = string `/v1/builds/${id}/relationships/individualTesters`; + map queryParam = {"limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + BuildIndividualTestersLinkagesResponse response = check self.clientEp-> get(path, targetType = BuildIndividualTestersLinkagesResponse); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function buildsIndividualtestersCreateToManyRelationship(string id, BuildIndividualTestersLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/builds/${id}/relationships/individualTesters`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->post(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function buildsIndividualtestersDeleteToManyRelationship(string id, BuildIndividualTestersLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/builds/${id}/relationships/individualTesters`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->delete(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBetatesters - the fields to include for returned resources of type betaTesters + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function buildsIndividualtestersGetToManyRelated(string id, string[]? fieldsBetatesters = (), int? 'limit = ()) returns BetaTestersResponse|error { + string path = string `/v1/builds/${id}/individualTesters`; + map queryParam = {"fields[betaTesters]": fieldsBetatesters, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + BetaTestersResponse response = check self.clientEp-> get(path, targetType = BetaTestersResponse); + return response; + } + # + # + id - the id of the requested resource + # + filterDevicetype - filter by attribute 'deviceType' + # + filterMetrictype - filter by attribute 'metricType' + # + filterPlatform - filter by attribute 'platform' + # + return - List of related resources + remote isolated function buildsPerfpowermetricsGetToManyRelated(string id, string[]? filterDevicetype = (), string[]? filterMetrictype = (), string[]? filterPlatform = ()) returns PerfPowerMetricsResponse|error { + string path = string `/v1/builds/${id}/perfPowerMetrics`; + map queryParam = {"filter[deviceType]": filterDevicetype, "filter[metricType]": filterMetrictype, "filter[platform]": filterPlatform}; + path = path + check getPathForQueryParam(queryParam); + PerfPowerMetricsResponse response = check self.clientEp-> get(path, targetType = PerfPowerMetricsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsPrereleaseversions - the fields to include for returned resources of type preReleaseVersions + # + return - Related resource + remote isolated function buildsPrereleaseversionGetToOneRelated(string id, string[]? fieldsPrereleaseversions = ()) returns PrereleaseVersionResponse|error { + string path = string `/v1/builds/${id}/preReleaseVersion`; + map queryParam = {"fields[preReleaseVersions]": fieldsPrereleaseversions}; + path = path + check getPathForQueryParam(queryParam); + PrereleaseVersionResponse response = check self.clientEp-> get(path, targetType = PrereleaseVersionResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsApps - the fields to include for returned resources of type apps + # + return - Related resource + remote isolated function bundleidsAppGetToOneRelated(string id, string[]? fieldsApps = ()) returns AppResponse|error { + string path = string `/v1/bundleIds/${id}/app`; + map queryParam = {"fields[apps]": fieldsApps}; + path = path + check getPathForQueryParam(queryParam); + AppResponse response = check self.clientEp-> get(path, targetType = AppResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBundleidcapabilities - the fields to include for returned resources of type bundleIdCapabilities + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function bundleidsBundleidcapabilitiesGetToManyRelated(string id, string[]? fieldsBundleidcapabilities = (), int? 'limit = ()) returns BundleIdCapabilitiesResponse|error { + string path = string `/v1/bundleIds/${id}/bundleIdCapabilities`; + map queryParam = {"fields[bundleIdCapabilities]": fieldsBundleidcapabilities, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + BundleIdCapabilitiesResponse response = check self.clientEp-> get(path, targetType = BundleIdCapabilitiesResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsProfiles - the fields to include for returned resources of type profiles + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function bundleidsProfilesGetToManyRelated(string id, string[]? fieldsProfiles = (), int? 'limit = ()) returns ProfilesResponse|error { + string path = string `/v1/bundleIds/${id}/profiles`; + map queryParam = {"fields[profiles]": fieldsProfiles, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + ProfilesResponse response = check self.clientEp-> get(path, targetType = ProfilesResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsTerritories - the fields to include for returned resources of type territories + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function enduserlicenseagreementsTerritoriesGetToManyRelated(string id, string[]? fieldsTerritories = (), int? 'limit = ()) returns TerritoriesResponse|error { + string path = string `/v1/endUserLicenseAgreements/${id}/territories`; + map queryParam = {"fields[territories]": fieldsTerritories, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + TerritoriesResponse response = check self.clientEp-> get(path, targetType = TerritoriesResponse); + return response; + } + # + # + id - the id of the requested resource + # + 'limit - maximum resources per page + # + return - List of related linkages + remote isolated function gamecenterenabledversionsCompatibleversionsGetToManyRelationship(string id, int? 'limit = ()) returns GameCenterEnabledVersionCompatibleVersionsLinkagesResponse|error { + string path = string `/v1/gameCenterEnabledVersions/${id}/relationships/compatibleVersions`; + map queryParam = {"limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + GameCenterEnabledVersionCompatibleVersionsLinkagesResponse response = check self.clientEp-> get(path, targetType = GameCenterEnabledVersionCompatibleVersionsLinkagesResponse); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function gamecenterenabledversionsCompatibleversionsCreateToManyRelationship(string id, GameCenterEnabledVersionCompatibleVersionsLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/gameCenterEnabledVersions/${id}/relationships/compatibleVersions`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->post(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function gamecenterenabledversionsCompatibleversionsDeleteToManyRelationship(string id, GameCenterEnabledVersionCompatibleVersionsLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/gameCenterEnabledVersions/${id}/relationships/compatibleVersions`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->delete(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function gamecenterenabledversionsCompatibleversionsReplaceToManyRelationship(string id, GameCenterEnabledVersionCompatibleVersionsLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/gameCenterEnabledVersions/${id}/relationships/compatibleVersions`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->patch(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + filterPlatform - filter by attribute 'platform' + # + filterVersionstring - filter by attribute 'versionString' + # + filterApp - filter by id(s) of related 'app' + # + filterId - filter by id(s) + # + sort - comma-separated list of sort expressions; resources will be sorted as specified + # + fieldsGamecenterenabledversions - the fields to include for returned resources of type gameCenterEnabledVersions + # + fieldsApps - the fields to include for returned resources of type apps + # + 'limit - maximum resources per page + # + include - comma-separated list of relationships to include + # + return - List of related resources + remote isolated function gamecenterenabledversionsCompatibleversionsGetToManyRelated(string id, string[]? filterPlatform = (), string[]? filterVersionstring = (), string[]? filterApp = (), string[]? filterId = (), string[]? sort = (), string[]? fieldsGamecenterenabledversions = (), string[]? fieldsApps = (), int? 'limit = (), string[]? include = ()) returns GameCenterEnabledVersionsResponse|error { + string path = string `/v1/gameCenterEnabledVersions/${id}/compatibleVersions`; + map queryParam = {"filter[platform]": filterPlatform, "filter[versionString]": filterVersionstring, "filter[app]": filterApp, "filter[id]": filterId, "sort": sort, "fields[gameCenterEnabledVersions]": fieldsGamecenterenabledversions, "fields[apps]": fieldsApps, "limit": 'limit, "include": include}; + path = path + check getPathForQueryParam(queryParam); + GameCenterEnabledVersionsResponse response = check self.clientEp-> get(path, targetType = GameCenterEnabledVersionsResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsBundleids - the fields to include for returned resources of type bundleIds + # + return - Related resource + remote isolated function profilesBundleidGetToOneRelated(string id, string[]? fieldsBundleids = ()) returns BundleIdResponse|error { + string path = string `/v1/profiles/${id}/bundleId`; + map queryParam = {"fields[bundleIds]": fieldsBundleids}; + path = path + check getPathForQueryParam(queryParam); + BundleIdResponse response = check self.clientEp-> get(path, targetType = BundleIdResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsCertificates - the fields to include for returned resources of type certificates + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function profilesCertificatesGetToManyRelated(string id, string[]? fieldsCertificates = (), int? 'limit = ()) returns CertificatesResponse|error { + string path = string `/v1/profiles/${id}/certificates`; + map queryParam = {"fields[certificates]": fieldsCertificates, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + CertificatesResponse response = check self.clientEp-> get(path, targetType = CertificatesResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsDevices - the fields to include for returned resources of type devices + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function profilesDevicesGetToManyRelated(string id, string[]? fieldsDevices = (), int? 'limit = ()) returns DevicesResponse|error { + string path = string `/v1/profiles/${id}/devices`; + map queryParam = {"fields[devices]": fieldsDevices, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + DevicesResponse response = check self.clientEp-> get(path, targetType = DevicesResponse); + return response; + } + # + # + id - the id of the requested resource + # + fieldsApps - the fields to include for returned resources of type apps + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function userinvitationsVisibleappsGetToManyRelated(string id, string[]? fieldsApps = (), int? 'limit = ()) returns AppsResponse|error { + string path = string `/v1/userInvitations/${id}/visibleApps`; + map queryParam = {"fields[apps]": fieldsApps, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + AppsResponse response = check self.clientEp-> get(path, targetType = AppsResponse); + return response; + } + # + # + id - the id of the requested resource + # + 'limit - maximum resources per page + # + return - List of related linkages + remote isolated function usersVisibleappsGetToManyRelationship(string id, int? 'limit = ()) returns UserVisibleAppsLinkagesResponse|error { + string path = string `/v1/users/${id}/relationships/visibleApps`; + map queryParam = {"limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + UserVisibleAppsLinkagesResponse response = check self.clientEp-> get(path, targetType = UserVisibleAppsLinkagesResponse); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function usersVisibleappsCreateToManyRelationship(string id, UserVisibleAppsLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/users/${id}/relationships/visibleApps`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->post(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function usersVisibleappsDeleteToManyRelationship(string id, UserVisibleAppsLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/users/${id}/relationships/visibleApps`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->delete(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + payload - List of related linkages + # + return - Success (no content) + remote isolated function usersVisibleappsReplaceToManyRelationship(string id, UserVisibleAppsLinkagesRequest payload) returns http:Response|error { + string path = string `/v1/users/${id}/relationships/visibleApps`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody); + http:Response response = check self.clientEp->patch(path, request, targetType=http:Response); + return response; + } + # + # + id - the id of the requested resource + # + fieldsApps - the fields to include for returned resources of type apps + # + 'limit - maximum resources per page + # + return - List of related resources + remote isolated function usersVisibleappsGetToManyRelated(string id, string[]? fieldsApps = (), int? 'limit = ()) returns AppsResponse|error { + string path = string `/v1/users/${id}/visibleApps`; + map queryParam = {"fields[apps]": fieldsApps, "limit": 'limit}; + path = path + check getPathForQueryParam(queryParam); + AppsResponse response = check self.clientEp-> get(path, targetType = AppsResponse); + return response; + } +} + +# Generate query path with query parameter. +# +# + queryParam - Query parameter map +# + return - Returns generated Path or error at failure of client initialization +isolated function getPathForQueryParam(map queryParam) returns string|error { + string[] param = []; + param[param.length()] = "?"; + foreach var [key, value] in queryParam.entries() { + if value is () { + _ = queryParam.remove(key); + } else { + if string:startsWith( key, "'") { + param[param.length()] = string:substring(key, 1, key.length()); + } else { + param[param.length()] = key; + } + param[param.length()] = "="; + if value is string { + string updateV = check url:encode(value, "UTF-8"); + param[param.length()] = updateV; + } else { + param[param.length()] = value.toString(); + } + param[param.length()] = "&"; + } + } + _ = param.remove(param.length()-1); + if param.length() == 1 { + _ = param.remove(0); + } + string restOfPath = string:'join("", ...param); + return restOfPath; +} diff --git a/openapi/apple.appstore/openapi.yaml b/openapi/apple.appstore/openapi.yaml new file mode 100644 index 000000000..f9c7eca5b --- /dev/null +++ b/openapi/apple.appstore/openapi.yaml @@ -0,0 +1,27425 @@ +openapi: 3.0.1 +x-important: 'IMPORTANT: This OpenAPI Specification is only for use in accordance with the terms of the Apple Developer Program License Agreement and terms for the use of the App Store Connect API. You may not use this OpenAPI Specification unless you have agreed to the Apple Developer Program License Agreement, and You acknowledge and agree that the App Store Connect API (and use of this Specification in connection therewith) is for internal development, testing and reporting purposes within your team and not to provide services to any third parties or for any other use.' +externalDocs: + description: App Store Connect API Documentation + url: 'https://developer.apple.com/documentation/appstoreconnectapi' +info: + title: App Store Connect API + version: 1.4.1 + x-platform: app_store_connect_api +servers: + - url: 'https://api.appstoreconnect.apple.com/' +paths: + '/v1/ageRatingDeclarations/{id}': + patch: + tags: + - AgeRatingDeclarations + operationId: ageRatingDeclarations-update_instance + requestBody: + description: AgeRatingDeclaration representation + content: + application/json: + schema: + $ref: '#/components/schemas/AgeRatingDeclarationUpdateRequest' + required: true + responses: + '200': + description: Single AgeRatingDeclaration + content: + application/json: + schema: + $ref: '#/components/schemas/AgeRatingDeclarationResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appCategories: + get: + tags: + - AppCategories + operationId: appCategories-get_collection + parameters: + - name: 'filter[platforms]' + in: query + description: filter by attribute 'platforms' + schema: + type: array + items: + type: string + enum: + - IOS + - MAC_OS + - TV_OS + style: form + explode: false + required: false + - name: 'exists[parent]' + in: query + description: filter by existence or non-existence of related 'parent' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + required: 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: + - parent + - subcategories + style: form + explode: false + required: false + - name: 'limit[subcategories]' + in: query + description: maximum number of related subcategories returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: List of AppCategories + content: + application/json: + schema: + $ref: '#/components/schemas/AppCategoriesResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appCategories/{id}': + get: + tags: + - AppCategories + operationId: appCategories-get_instance + parameters: + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + 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: + - parent + - subcategories + style: form + explode: false + required: false + - name: 'limit[subcategories]' + in: query + description: maximum number of related subcategories returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single AppCategory + content: + application/json: + schema: + $ref: '#/components/schemas/AppCategoryResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + /v1/appEncryptionDeclarations: + get: + tags: + - AppEncryptionDeclarations + operationId: appEncryptionDeclarations-get_collection + parameters: + - name: 'filter[platform]' + in: query + description: filter by attribute 'platform' + schema: + type: array + items: + type: string + enum: + - IOS + - MAC_OS + - TV_OS + style: form + explode: false + required: false + - name: 'filter[app]' + in: query + description: filter by id(s) of related 'app' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[builds]' + in: query + description: filter by id(s) of related 'builds' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'fields[appEncryptionDeclarations]' + in: query + description: the fields to include for returned resources of type appEncryptionDeclarations + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclarationState + - availableOnFrenchStore + - builds + - codeValue + - containsProprietaryCryptography + - containsThirdPartyCryptography + - documentName + - documentType + - documentUrl + - exempt + - platform + - uploadedDate + - usesEncryption + style: form + explode: false + required: 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: + - app + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + responses: + '200': + description: List of AppEncryptionDeclarations + content: + application/json: + schema: + $ref: '#/components/schemas/AppEncryptionDeclarationsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appEncryptionDeclarations/{id}': + get: + tags: + - AppEncryptionDeclarations + operationId: appEncryptionDeclarations-get_instance + parameters: + - name: 'fields[appEncryptionDeclarations]' + in: query + description: the fields to include for returned resources of type appEncryptionDeclarations + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclarationState + - availableOnFrenchStore + - builds + - codeValue + - containsProprietaryCryptography + - containsThirdPartyCryptography + - documentName + - documentType + - documentUrl + - exempt + - platform + - uploadedDate + - usesEncryption + 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: + - app + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + responses: + '200': + description: Single AppEncryptionDeclaration + content: + application/json: + schema: + $ref: '#/components/schemas/AppEncryptionDeclarationResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + /v1/appInfoLocalizations: + post: + tags: + - AppInfoLocalizations + operationId: appInfoLocalizations-create_instance + requestBody: + description: AppInfoLocalization representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppInfoLocalizationCreateRequest' + required: true + responses: + '201': + description: Single AppInfoLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/AppInfoLocalizationResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appInfoLocalizations/{id}': + get: + tags: + - AppInfoLocalizations + operationId: appInfoLocalizations-get_instance + parameters: + - name: 'fields[appInfoLocalizations]' + in: query + description: the fields to include for returned resources of type appInfoLocalizations + schema: + type: array + items: + type: string + enum: + - appInfo + - locale + - name + - privacyPolicyText + - privacyPolicyUrl + - subtitle + 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: + - appInfo + style: form + explode: false + required: false + responses: + '200': + description: Single AppInfoLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/AppInfoLocalizationResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppInfoLocalizations + operationId: appInfoLocalizations-update_instance + requestBody: + description: AppInfoLocalization representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppInfoLocalizationUpdateRequest' + required: true + responses: + '200': + description: Single AppInfoLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/AppInfoLocalizationResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - AppInfoLocalizations + operationId: appInfoLocalizations-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appInfos/{id}': + get: + tags: + - AppInfos + operationId: appInfos-get_instance + parameters: + - name: 'fields[appInfos]' + in: query + description: the fields to include for returned resources of type appInfos + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appInfoLocalizations + - appStoreAgeRating + - appStoreState + - brazilAgeRating + - kidsAgeBand + - primaryCategory + - primarySubcategoryOne + - primarySubcategoryTwo + - secondaryCategory + - secondarySubcategoryOne + - secondarySubcategoryTwo + 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: + - ageRatingDeclaration + - app + - appInfoLocalizations + - primaryCategory + - primarySubcategoryOne + - primarySubcategoryTwo + - secondaryCategory + - secondarySubcategoryOne + - secondarySubcategoryTwo + style: form + explode: false + required: false + - name: 'fields[ageRatingDeclarations]' + in: query + description: the fields to include for returned resources of type ageRatingDeclarations + schema: + type: array + items: + type: string + enum: + - alcoholTobaccoOrDrugUseOrReferences + - contests + - gambling + - gamblingAndContests + - gamblingSimulated + - horrorOrFearThemes + - kidsAgeBand + - matureOrSuggestiveThemes + - medicalOrTreatmentInformation + - profanityOrCrudeHumor + - seventeenPlus + - sexualContentGraphicAndNudity + - sexualContentOrNudity + - unrestrictedWebAccess + - violenceCartoonOrFantasy + - violenceRealistic + - violenceRealisticProlongedGraphicOrSadistic + style: form + explode: false + required: false + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + required: false + - name: 'fields[appInfoLocalizations]' + in: query + description: the fields to include for returned resources of type appInfoLocalizations + schema: + type: array + items: + type: string + enum: + - appInfo + - locale + - name + - privacyPolicyText + - privacyPolicyUrl + - subtitle + style: form + explode: false + required: false + - name: 'limit[appInfoLocalizations]' + in: query + description: maximum number of related appInfoLocalizations returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single AppInfo + content: + application/json: + schema: + $ref: '#/components/schemas/AppInfoResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppInfos + operationId: appInfos-update_instance + requestBody: + description: AppInfo representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppInfoUpdateRequest' + required: true + responses: + '200': + description: Single AppInfo + content: + application/json: + schema: + $ref: '#/components/schemas/AppInfoResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appPreOrders: + post: + tags: + - AppPreOrders + operationId: appPreOrders-create_instance + requestBody: + description: AppPreOrder representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreOrderCreateRequest' + required: true + responses: + '201': + description: Single AppPreOrder + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreOrderResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appPreOrders/{id}': + get: + tags: + - AppPreOrders + operationId: appPreOrders-get_instance + parameters: + - name: 'fields[appPreOrders]' + in: query + description: the fields to include for returned resources of type appPreOrders + schema: + type: array + items: + type: string + enum: + - app + - appReleaseDate + - preOrderAvailableDate + 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: + - app + style: form + explode: false + required: false + responses: + '200': + description: Single AppPreOrder + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreOrderResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppPreOrders + operationId: appPreOrders-update_instance + requestBody: + description: AppPreOrder representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreOrderUpdateRequest' + required: true + responses: + '200': + description: Single AppPreOrder + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreOrderResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - AppPreOrders + operationId: appPreOrders-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appPreviewSets: + post: + tags: + - AppPreviewSets + operationId: appPreviewSets-create_instance + requestBody: + description: AppPreviewSet representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewSetCreateRequest' + required: true + responses: + '201': + description: Single AppPreviewSet + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewSetResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appPreviewSets/{id}': + get: + tags: + - AppPreviewSets + operationId: appPreviewSets-get_instance + parameters: + - name: 'fields[appPreviewSets]' + in: query + description: the fields to include for returned resources of type appPreviewSets + schema: + type: array + items: + type: string + enum: + - appPreviews + - appStoreVersionLocalization + - previewType + 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: + - appPreviews + - appStoreVersionLocalization + style: form + explode: false + required: false + - name: 'fields[appPreviews]' + in: query + description: the fields to include for returned resources of type appPreviews + schema: + type: array + items: + type: string + enum: + - appPreviewSet + - assetDeliveryState + - fileName + - fileSize + - mimeType + - previewFrameTimeCode + - previewImage + - sourceFileChecksum + - uploadOperations + - uploaded + - videoUrl + style: form + explode: false + required: false + - name: 'limit[appPreviews]' + in: query + description: maximum number of related appPreviews returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single AppPreviewSet + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewSetResponse' + '400': + description: Parameter 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' + delete: + tags: + - AppPreviewSets + operationId: appPreviewSets-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appPreviews: + post: + tags: + - AppPreviews + operationId: appPreviews-create_instance + requestBody: + description: AppPreview representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewCreateRequest' + required: true + responses: + '201': + description: Single AppPreview + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appPreviews/{id}': + get: + tags: + - AppPreviews + operationId: appPreviews-get_instance + parameters: + - name: 'fields[appPreviews]' + in: query + description: the fields to include for returned resources of type appPreviews + schema: + type: array + items: + type: string + enum: + - appPreviewSet + - assetDeliveryState + - fileName + - fileSize + - mimeType + - previewFrameTimeCode + - previewImage + - sourceFileChecksum + - uploadOperations + - uploaded + - videoUrl + 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: + - appPreviewSet + style: form + explode: false + required: false + responses: + '200': + description: Single AppPreview + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppPreviews + operationId: appPreviews-update_instance + requestBody: + description: AppPreview representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewUpdateRequest' + required: true + responses: + '200': + description: Single AppPreview + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - AppPreviews + operationId: appPreviews-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appPricePoints: + get: + tags: + - AppPricePoints + operationId: appPricePoints-get_collection + parameters: + - name: 'filter[priceTier]' + in: query + description: filter by id(s) of related 'priceTier' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[territory]' + in: query + description: filter by id(s) of related 'territory' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'fields[appPricePoints]' + in: query + description: the fields to include for returned resources of type appPricePoints + schema: + type: array + items: + type: string + enum: + - customerPrice + - priceTier + - proceeds + - territory + style: form + explode: false + required: 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: + - priceTier + - territory + style: form + explode: false + required: false + - name: 'fields[territories]' + in: query + description: the fields to include for returned resources of type territories + schema: + type: array + items: + type: string + enum: + - currency + style: form + explode: false + required: false + responses: + '200': + description: List of AppPricePoints + content: + application/json: + schema: + $ref: '#/components/schemas/AppPricePointsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appPricePoints/{id}': + get: + tags: + - AppPricePoints + operationId: appPricePoints-get_instance + parameters: + - name: 'fields[appPricePoints]' + in: query + description: the fields to include for returned resources of type appPricePoints + schema: + type: array + items: + type: string + enum: + - customerPrice + - priceTier + - proceeds + - territory + 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: + - priceTier + - territory + style: form + explode: false + required: false + - name: 'fields[territories]' + in: query + description: the fields to include for returned resources of type territories + schema: + type: array + items: + type: string + enum: + - currency + style: form + explode: false + required: false + responses: + '200': + description: Single AppPricePoint + content: + application/json: + schema: + $ref: '#/components/schemas/AppPricePointResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + /v1/appPriceTiers: + get: + tags: + - AppPriceTiers + operationId: appPriceTiers-get_collection + parameters: + - name: 'filter[id]' + in: query + description: filter by id(s) + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'fields[appPriceTiers]' + in: query + description: the fields to include for returned resources of type appPriceTiers + schema: + type: array + items: + type: string + enum: + - pricePoints + style: form + explode: false + required: 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: + - pricePoints + style: form + explode: false + required: false + - name: 'fields[appPricePoints]' + in: query + description: the fields to include for returned resources of type appPricePoints + schema: + type: array + items: + type: string + enum: + - customerPrice + - priceTier + - proceeds + - territory + style: form + explode: false + required: false + - name: 'limit[pricePoints]' + in: query + description: maximum number of related pricePoints returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: List of AppPriceTiers + content: + application/json: + schema: + $ref: '#/components/schemas/AppPriceTiersResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appPriceTiers/{id}': + get: + tags: + - AppPriceTiers + operationId: appPriceTiers-get_instance + parameters: + - name: 'fields[appPriceTiers]' + in: query + description: the fields to include for returned resources of type appPriceTiers + schema: + type: array + items: + type: string + enum: + - pricePoints + 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: + - pricePoints + style: form + explode: false + required: false + - name: 'fields[appPricePoints]' + in: query + description: the fields to include for returned resources of type appPricePoints + schema: + type: array + items: + type: string + enum: + - customerPrice + - priceTier + - proceeds + - territory + style: form + explode: false + required: false + - name: 'limit[pricePoints]' + in: query + description: maximum number of related pricePoints returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single AppPriceTier + content: + application/json: + schema: + $ref: '#/components/schemas/AppPriceTierResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appPrices/{id}': + get: + tags: + - AppPrices + operationId: appPrices-get_instance + parameters: + - name: 'fields[appPrices]' + in: query + description: the fields to include for returned resources of type appPrices + schema: + type: array + items: + type: string + enum: + - app + - priceTier + 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: + - app + - priceTier + style: form + explode: false + required: false + responses: + '200': + description: Single AppPrice + content: + application/json: + schema: + $ref: '#/components/schemas/AppPriceResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + /v1/appScreenshotSets: + post: + tags: + - AppScreenshotSets + operationId: appScreenshotSets-create_instance + requestBody: + description: AppScreenshotSet representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotSetCreateRequest' + required: true + responses: + '201': + description: Single AppScreenshotSet + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotSetResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appScreenshotSets/{id}': + get: + tags: + - AppScreenshotSets + operationId: appScreenshotSets-get_instance + parameters: + - name: 'fields[appScreenshotSets]' + in: query + description: the fields to include for returned resources of type appScreenshotSets + schema: + type: array + items: + type: string + enum: + - appScreenshots + - appStoreVersionLocalization + - screenshotDisplayType + 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: + - appScreenshots + - appStoreVersionLocalization + style: form + explode: false + required: false + - name: 'fields[appScreenshots]' + in: query + description: the fields to include for returned resources of type appScreenshots + schema: + type: array + items: + type: string + enum: + - appScreenshotSet + - assetDeliveryState + - assetToken + - assetType + - fileName + - fileSize + - imageAsset + - sourceFileChecksum + - uploadOperations + - uploaded + style: form + explode: false + required: false + - name: 'limit[appScreenshots]' + in: query + description: maximum number of related appScreenshots returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single AppScreenshotSet + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotSetResponse' + '400': + description: Parameter 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' + delete: + tags: + - AppScreenshotSets + operationId: appScreenshotSets-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appScreenshots: + post: + tags: + - AppScreenshots + operationId: appScreenshots-create_instance + requestBody: + description: AppScreenshot representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotCreateRequest' + required: true + responses: + '201': + description: Single AppScreenshot + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appScreenshots/{id}': + get: + tags: + - AppScreenshots + operationId: appScreenshots-get_instance + parameters: + - name: 'fields[appScreenshots]' + in: query + description: the fields to include for returned resources of type appScreenshots + schema: + type: array + items: + type: string + enum: + - appScreenshotSet + - assetDeliveryState + - assetToken + - assetType + - fileName + - fileSize + - imageAsset + - sourceFileChecksum + - uploadOperations + - uploaded + 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: + - appScreenshotSet + style: form + explode: false + required: false + responses: + '200': + description: Single AppScreenshot + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppScreenshots + operationId: appScreenshots-update_instance + requestBody: + description: AppScreenshot representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotUpdateRequest' + required: true + responses: + '200': + description: Single AppScreenshot + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - AppScreenshots + operationId: appScreenshots-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appStoreReviewAttachments: + post: + tags: + - AppStoreReviewAttachments + operationId: appStoreReviewAttachments-create_instance + requestBody: + description: AppStoreReviewAttachment representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewAttachmentCreateRequest' + required: true + responses: + '201': + description: Single AppStoreReviewAttachment + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewAttachmentResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appStoreReviewAttachments/{id}': + get: + tags: + - AppStoreReviewAttachments + operationId: appStoreReviewAttachments-get_instance + parameters: + - name: 'fields[appStoreReviewAttachments]' + in: query + description: the fields to include for returned resources of type appStoreReviewAttachments + schema: + type: array + items: + type: string + enum: + - appStoreReviewDetail + - assetDeliveryState + - fileName + - fileSize + - sourceFileChecksum + - uploadOperations + - uploaded + 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: + - appStoreReviewDetail + style: form + explode: false + required: false + responses: + '200': + description: Single AppStoreReviewAttachment + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewAttachmentResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppStoreReviewAttachments + operationId: appStoreReviewAttachments-update_instance + requestBody: + description: AppStoreReviewAttachment representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewAttachmentUpdateRequest' + required: true + responses: + '200': + description: Single AppStoreReviewAttachment + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewAttachmentResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - AppStoreReviewAttachments + operationId: appStoreReviewAttachments-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appStoreReviewDetails: + post: + tags: + - AppStoreReviewDetails + operationId: appStoreReviewDetails-create_instance + requestBody: + description: AppStoreReviewDetail representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewDetailCreateRequest' + required: true + responses: + '201': + description: Single AppStoreReviewDetail + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewDetailResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appStoreReviewDetails/{id}': + get: + tags: + - AppStoreReviewDetails + operationId: appStoreReviewDetails-get_instance + parameters: + - name: 'fields[appStoreReviewDetails]' + in: query + description: the fields to include for returned resources of type appStoreReviewDetails + schema: + type: array + items: + type: string + enum: + - appStoreReviewAttachments + - appStoreVersion + - contactEmail + - contactFirstName + - contactLastName + - contactPhone + - demoAccountName + - demoAccountPassword + - demoAccountRequired + - notes + 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: + - appStoreReviewAttachments + - appStoreVersion + style: form + explode: false + required: false + - name: 'fields[appStoreReviewAttachments]' + in: query + description: the fields to include for returned resources of type appStoreReviewAttachments + schema: + type: array + items: + type: string + enum: + - appStoreReviewDetail + - assetDeliveryState + - fileName + - fileSize + - sourceFileChecksum + - uploadOperations + - uploaded + style: form + explode: false + required: false + - name: 'limit[appStoreReviewAttachments]' + in: query + description: maximum number of related appStoreReviewAttachments returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single AppStoreReviewDetail + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewDetailResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppStoreReviewDetails + operationId: appStoreReviewDetails-update_instance + requestBody: + description: AppStoreReviewDetail representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewDetailUpdateRequest' + required: true + responses: + '200': + description: Single AppStoreReviewDetail + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewDetailResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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: + post: + tags: + - AppStoreVersionLocalizations + operationId: appStoreVersionLocalizations-create_instance + requestBody: + description: AppStoreVersionLocalization representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionLocalizationCreateRequest' + required: true + responses: + '201': + description: Single AppStoreVersionLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionLocalizationResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appStoreVersionLocalizations/{id}': + get: + tags: + - AppStoreVersionLocalizations + operationId: appStoreVersionLocalizations-get_instance + parameters: + - name: 'fields[appStoreVersionLocalizations]' + in: query + description: the fields to include for returned resources of type appStoreVersionLocalizations + schema: + type: array + items: + type: string + enum: + - appPreviewSets + - appScreenshotSets + - appStoreVersion + - description + - keywords + - locale + - marketingUrl + - promotionalText + - supportUrl + - whatsNew + 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: + - appPreviewSets + - appScreenshotSets + - appStoreVersion + style: form + explode: false + required: false + - name: 'fields[appScreenshotSets]' + in: query + description: the fields to include for returned resources of type appScreenshotSets + schema: + type: array + items: + type: string + enum: + - appScreenshots + - appStoreVersionLocalization + - screenshotDisplayType + style: form + explode: false + required: false + - name: 'fields[appPreviewSets]' + in: query + description: the fields to include for returned resources of type appPreviewSets + schema: + type: array + items: + type: string + enum: + - appPreviews + - appStoreVersionLocalization + - previewType + style: form + explode: false + required: false + - name: 'limit[appPreviewSets]' + in: query + description: maximum number of related appPreviewSets returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[appScreenshotSets]' + in: query + description: maximum number of related appScreenshotSets returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single AppStoreVersionLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionLocalizationResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppStoreVersionLocalizations + operationId: appStoreVersionLocalizations-update_instance + requestBody: + description: AppStoreVersionLocalization representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionLocalizationUpdateRequest' + required: true + responses: + '200': + description: Single AppStoreVersionLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionLocalizationResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - AppStoreVersionLocalizations + operationId: appStoreVersionLocalizations-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appStoreVersionPhasedReleases: + post: + tags: + - AppStoreVersionPhasedReleases + operationId: appStoreVersionPhasedReleases-create_instance + requestBody: + description: AppStoreVersionPhasedRelease representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionPhasedReleaseCreateRequest' + required: true + responses: + '201': + description: Single AppStoreVersionPhasedRelease + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionPhasedReleaseResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appStoreVersionPhasedReleases/{id}': + patch: + tags: + - AppStoreVersionPhasedReleases + operationId: appStoreVersionPhasedReleases-update_instance + requestBody: + description: AppStoreVersionPhasedRelease representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionPhasedReleaseUpdateRequest' + required: true + responses: + '200': + description: Single AppStoreVersionPhasedRelease + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionPhasedReleaseResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - AppStoreVersionPhasedReleases + operationId: appStoreVersionPhasedReleases-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appStoreVersionSubmissions: + post: + tags: + - AppStoreVersionSubmissions + operationId: appStoreVersionSubmissions-create_instance + requestBody: + description: AppStoreVersionSubmission representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionSubmissionCreateRequest' + required: true + responses: + '201': + description: Single AppStoreVersionSubmission + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionSubmissionResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appStoreVersionSubmissions/{id}': + delete: + tags: + - AppStoreVersionSubmissions + operationId: appStoreVersionSubmissions-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appStoreVersions: + post: + tags: + - AppStoreVersions + operationId: appStoreVersions-create_instance + requestBody: + description: AppStoreVersion representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionCreateRequest' + required: true + responses: + '201': + description: Single AppStoreVersion + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/appStoreVersions/{id}': + get: + tags: + - AppStoreVersions + operationId: appStoreVersions-get_instance + parameters: + - name: 'fields[appStoreVersions]' + in: query + description: the fields to include for returned resources of type appStoreVersions + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreState + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - copyright + - createdDate + - downloadable + - earliestReleaseDate + - idfaDeclaration + - platform + - releaseType + - routingAppCoverage + - usesIdfa + - versionString + 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: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - idfaDeclaration + - routingAppCoverage + 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: + - appPreviewSets + - appScreenshotSets + - appStoreVersion + - description + - keywords + - locale + - marketingUrl + - promotionalText + - supportUrl + - whatsNew + style: form + explode: false + required: false + - name: 'fields[idfaDeclarations]' + in: query + description: the fields to include for returned resources of type idfaDeclarations + schema: + type: array + items: + type: string + enum: + - appStoreVersion + - attributesActionWithPreviousAd + - attributesAppInstallationToPreviousAd + - honorsLimitedAdTracking + - servesAds + style: form + explode: false + required: false + - name: 'fields[routingAppCoverages]' + in: query + description: the fields to include for returned resources of type routingAppCoverages + schema: + type: array + items: + type: string + enum: + - appStoreVersion + - assetDeliveryState + - fileName + - fileSize + - sourceFileChecksum + - uploadOperations + - uploaded + style: form + explode: false + required: false + - name: 'fields[appStoreVersionPhasedReleases]' + in: query + description: the fields to include for returned resources of type appStoreVersionPhasedReleases + schema: + type: array + items: + type: string + enum: + - appStoreVersion + - currentDayNumber + - phasedReleaseState + - startDate + - totalPauseDuration + style: form + explode: false + required: false + - name: 'fields[ageRatingDeclarations]' + in: query + deprecated: true + description: the fields to include for returned resources of type ageRatingDeclarations + schema: + type: array + items: + type: string + enum: + - alcoholTobaccoOrDrugUseOrReferences + - gamblingAndContests + - gamblingSimulated + - horrorOrFearThemes + - kidsAgeBand + - matureOrSuggestiveThemes + - medicalOrTreatmentInformation + - profanityOrCrudeHumor + - sexualContentGraphicAndNudity + - sexualContentOrNudity + - unrestrictedWebAccess + - violenceCartoonOrFantasy + - violenceRealistic + - violenceRealisticProlongedGraphicOrSadistic + style: form + explode: false + required: false + - name: 'fields[appStoreReviewDetails]' + in: query + description: the fields to include for returned resources of type appStoreReviewDetails + schema: + type: array + items: + type: string + enum: + - appStoreReviewAttachments + - appStoreVersion + - contactEmail + - contactFirstName + - contactLastName + - contactPhone + - demoAccountName + - demoAccountPassword + - demoAccountRequired + - notes + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + - name: 'fields[appStoreVersionSubmissions]' + in: query + description: the fields to include for returned resources of type appStoreVersionSubmissions + schema: + type: array + items: + type: string + enum: + - appStoreVersion + style: form + explode: false + required: false + - name: 'limit[appStoreVersionLocalizations]' + in: query + description: maximum number of related appStoreVersionLocalizations returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single AppStoreVersion + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppStoreVersions + operationId: appStoreVersions-update_instance + requestBody: + description: AppStoreVersion representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionUpdateRequest' + required: true + responses: + '200': + description: Single AppStoreVersion + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - AppStoreVersions + operationId: appStoreVersions-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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: + get: + tags: + - Apps + operationId: apps-get_collection + parameters: + - name: 'filter[appStoreVersions.appStoreState]' + in: query + description: filter by attribute 'appStoreVersions.appStoreState' + schema: + type: array + items: + type: string + enum: + - DEVELOPER_REMOVED_FROM_SALE + - DEVELOPER_REJECTED + - IN_REVIEW + - INVALID_BINARY + - METADATA_REJECTED + - PENDING_APPLE_RELEASE + - PENDING_CONTRACT + - PENDING_DEVELOPER_RELEASE + - PREPARE_FOR_SUBMISSION + - PREORDER_READY_FOR_SALE + - PROCESSING_FOR_APP_STORE + - READY_FOR_SALE + - REJECTED + - REMOVED_FROM_SALE + - WAITING_FOR_EXPORT_COMPLIANCE + - WAITING_FOR_REVIEW + - REPLACED_WITH_NEW_VERSION + style: form + explode: false + required: false + - name: 'filter[appStoreVersions.platform]' + in: query + description: filter by attribute 'appStoreVersions.platform' + schema: + type: array + items: + type: string + enum: + - IOS + - MAC_OS + - TV_OS + style: form + explode: false + required: false + - name: 'filter[bundleId]' + in: query + description: filter by attribute 'bundleId' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[name]' + in: query + description: filter by attribute 'name' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[sku]' + in: query + description: filter by attribute 'sku' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[appStoreVersions]' + in: query + description: filter by id(s) of related 'appStoreVersions' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[id]' + in: query + description: filter by id(s) + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'exists[gameCenterEnabledVersions]' + in: query + description: filter by existence or non-existence of related 'gameCenterEnabledVersions' + schema: + type: array + items: + type: string + style: form + explode: false + required: 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: + - bundleId + - '-bundleId' + - name + - '-name' + - sku + - '-sku' + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: 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: + - appInfos + - appStoreVersions + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - builds + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - preOrder + - preReleaseVersions + - prices + style: form + explode: false + required: false + - name: 'fields[betaGroups]' + in: query + description: the fields to include for returned resources of type betaGroups + schema: + type: array + items: + type: string + enum: + - app + - betaTesters + - builds + - createdDate + - feedbackEnabled + - isInternalGroup + - name + - publicLink + - publicLinkEnabled + - publicLinkId + - publicLinkLimit + - publicLinkLimitEnabled + style: form + explode: false + required: false + - name: 'fields[perfPowerMetrics]' + in: query + description: the fields to include for returned resources of type perfPowerMetrics + schema: + type: array + items: + type: string + enum: + - deviceType + - metricType + - platform + style: form + explode: false + required: false + - name: 'fields[appInfos]' + in: query + description: the fields to include for returned resources of type appInfos + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appInfoLocalizations + - appStoreAgeRating + - appStoreState + - brazilAgeRating + - kidsAgeBand + - primaryCategory + - primarySubcategoryOne + - primarySubcategoryTwo + - secondaryCategory + - secondarySubcategoryOne + - secondarySubcategoryTwo + style: form + explode: false + required: false + - name: 'fields[appPreOrders]' + in: query + description: the fields to include for returned resources of type appPreOrders + schema: + type: array + items: + type: string + enum: + - app + - appReleaseDate + - preOrderAvailableDate + style: form + explode: false + required: false + - name: 'fields[preReleaseVersions]' + in: query + description: the fields to include for returned resources of type preReleaseVersions + schema: + type: array + items: + type: string + enum: + - app + - builds + - platform + - version + style: form + explode: false + required: false + - name: 'fields[appPrices]' + in: query + description: the fields to include for returned resources of type appPrices + schema: + type: array + items: + type: string + enum: + - app + - priceTier + style: form + explode: false + required: false + - name: 'fields[inAppPurchases]' + in: query + description: the fields to include for returned resources of type inAppPurchases + schema: + type: array + items: + type: string + enum: + - apps + - inAppPurchaseType + - productId + - referenceName + - state + style: form + explode: false + required: false + - name: 'fields[betaAppReviewDetails]' + in: query + description: the fields to include for returned resources of type betaAppReviewDetails + schema: + type: array + items: + type: string + enum: + - app + - contactEmail + - contactFirstName + - contactLastName + - contactPhone + - demoAccountName + - demoAccountPassword + - demoAccountRequired + - notes + style: form + explode: false + required: false + - name: 'fields[territories]' + in: query + description: the fields to include for returned resources of type territories + schema: + type: array + items: + type: string + enum: + - currency + style: form + explode: false + required: false + - name: 'fields[gameCenterEnabledVersions]' + in: query + description: the fields to include for returned resources of type gameCenterEnabledVersions + schema: + type: array + items: + type: string + enum: + - app + - compatibleVersions + - iconAsset + - platform + - versionString + style: form + explode: false + required: false + - name: 'fields[appStoreVersions]' + in: query + description: the fields to include for returned resources of type appStoreVersions + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreState + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - copyright + - createdDate + - downloadable + - earliestReleaseDate + - idfaDeclaration + - platform + - releaseType + - routingAppCoverage + - usesIdfa + - versionString + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + - name: 'fields[betaAppLocalizations]' + in: query + description: the fields to include for returned resources of type betaAppLocalizations + schema: + type: array + items: + type: string + enum: + - app + - description + - feedbackEmail + - locale + - marketingUrl + - privacyPolicyUrl + - tvOsPrivacyPolicy + style: form + explode: false + required: false + - name: 'fields[betaLicenseAgreements]' + in: query + description: the fields to include for returned resources of type betaLicenseAgreements + schema: + type: array + items: + type: string + enum: + - agreementText + - app + style: form + explode: false + required: false + - name: 'fields[endUserLicenseAgreements]' + in: query + description: the fields to include for returned resources of type endUserLicenseAgreements + schema: + type: array + items: + type: string + enum: + - agreementText + - app + - territories + style: form + explode: false + required: false + - name: 'limit[appInfos]' + in: query + description: maximum number of related appInfos returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[appStoreVersions]' + in: query + description: maximum number of related appStoreVersions returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[availableTerritories]' + in: query + description: maximum number of related availableTerritories returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[betaAppLocalizations]' + in: query + description: maximum number of related betaAppLocalizations returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[betaGroups]' + in: query + description: maximum number of related betaGroups returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[builds]' + in: query + description: maximum number of related builds returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[gameCenterEnabledVersions]' + in: query + description: maximum number of related gameCenterEnabledVersions returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[inAppPurchases]' + in: query + description: maximum number of related inAppPurchases returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[preReleaseVersions]' + in: query + description: maximum number of related preReleaseVersions returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[prices]' + in: query + description: maximum number of related prices returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: List of Apps + content: + application/json: + schema: + $ref: '#/components/schemas/AppsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/apps/{id}': + get: + tags: + - Apps + operationId: apps-get_instance + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + 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: + - appInfos + - appStoreVersions + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - builds + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - preOrder + - preReleaseVersions + - prices + style: form + explode: false + required: false + - name: 'fields[betaGroups]' + in: query + description: the fields to include for returned resources of type betaGroups + schema: + type: array + items: + type: string + enum: + - app + - betaTesters + - builds + - createdDate + - feedbackEnabled + - isInternalGroup + - name + - publicLink + - publicLinkEnabled + - publicLinkId + - publicLinkLimit + - publicLinkLimitEnabled + style: form + explode: false + required: false + - name: 'fields[perfPowerMetrics]' + in: query + description: the fields to include for returned resources of type perfPowerMetrics + schema: + type: array + items: + type: string + enum: + - deviceType + - metricType + - platform + style: form + explode: false + required: false + - name: 'fields[appInfos]' + in: query + description: the fields to include for returned resources of type appInfos + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appInfoLocalizations + - appStoreAgeRating + - appStoreState + - brazilAgeRating + - kidsAgeBand + - primaryCategory + - primarySubcategoryOne + - primarySubcategoryTwo + - secondaryCategory + - secondarySubcategoryOne + - secondarySubcategoryTwo + style: form + explode: false + required: false + - name: 'fields[appPreOrders]' + in: query + description: the fields to include for returned resources of type appPreOrders + schema: + type: array + items: + type: string + enum: + - app + - appReleaseDate + - preOrderAvailableDate + style: form + explode: false + required: false + - name: 'fields[preReleaseVersions]' + in: query + description: the fields to include for returned resources of type preReleaseVersions + schema: + type: array + items: + type: string + enum: + - app + - builds + - platform + - version + style: form + explode: false + required: false + - name: 'fields[appPrices]' + in: query + description: the fields to include for returned resources of type appPrices + schema: + type: array + items: + type: string + enum: + - app + - priceTier + style: form + explode: false + required: false + - name: 'fields[inAppPurchases]' + in: query + description: the fields to include for returned resources of type inAppPurchases + schema: + type: array + items: + type: string + enum: + - apps + - inAppPurchaseType + - productId + - referenceName + - state + style: form + explode: false + required: false + - name: 'fields[betaAppReviewDetails]' + in: query + description: the fields to include for returned resources of type betaAppReviewDetails + schema: + type: array + items: + type: string + enum: + - app + - contactEmail + - contactFirstName + - contactLastName + - contactPhone + - demoAccountName + - demoAccountPassword + - demoAccountRequired + - notes + style: form + explode: false + required: false + - name: 'fields[territories]' + in: query + description: the fields to include for returned resources of type territories + schema: + type: array + items: + type: string + enum: + - currency + style: form + explode: false + required: false + - name: 'fields[gameCenterEnabledVersions]' + in: query + description: the fields to include for returned resources of type gameCenterEnabledVersions + schema: + type: array + items: + type: string + enum: + - app + - compatibleVersions + - iconAsset + - platform + - versionString + style: form + explode: false + required: false + - name: 'fields[appStoreVersions]' + in: query + description: the fields to include for returned resources of type appStoreVersions + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreState + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - copyright + - createdDate + - downloadable + - earliestReleaseDate + - idfaDeclaration + - platform + - releaseType + - routingAppCoverage + - usesIdfa + - versionString + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + - name: 'fields[betaAppLocalizations]' + in: query + description: the fields to include for returned resources of type betaAppLocalizations + schema: + type: array + items: + type: string + enum: + - app + - description + - feedbackEmail + - locale + - marketingUrl + - privacyPolicyUrl + - tvOsPrivacyPolicy + style: form + explode: false + required: false + - name: 'fields[betaLicenseAgreements]' + in: query + description: the fields to include for returned resources of type betaLicenseAgreements + schema: + type: array + items: + type: string + enum: + - agreementText + - app + style: form + explode: false + required: false + - name: 'fields[endUserLicenseAgreements]' + in: query + description: the fields to include for returned resources of type endUserLicenseAgreements + schema: + type: array + items: + type: string + enum: + - agreementText + - app + - territories + style: form + explode: false + required: false + - name: 'limit[appInfos]' + in: query + description: maximum number of related appInfos returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[appStoreVersions]' + in: query + description: maximum number of related appStoreVersions returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[availableTerritories]' + in: query + description: maximum number of related availableTerritories returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[betaAppLocalizations]' + in: query + description: maximum number of related betaAppLocalizations returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[betaGroups]' + in: query + description: maximum number of related betaGroups returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[builds]' + in: query + description: maximum number of related builds returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[gameCenterEnabledVersions]' + in: query + description: maximum number of related gameCenterEnabledVersions returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[inAppPurchases]' + in: query + description: maximum number of related inAppPurchases returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[preReleaseVersions]' + in: query + description: maximum number of related preReleaseVersions returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[prices]' + in: query + description: maximum number of related prices returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single App + content: + application/json: + schema: + $ref: '#/components/schemas/AppResponse' + '400': + description: Parameter 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' + patch: + tags: + - Apps + operationId: apps-update_instance + requestBody: + description: App representation + content: + application/json: + schema: + $ref: '#/components/schemas/AppUpdateRequest' + required: true + responses: + '200': + description: Single App + content: + application/json: + schema: + $ref: '#/components/schemas/AppResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/betaAppLocalizations: + get: + tags: + - BetaAppLocalizations + operationId: betaAppLocalizations-get_collection + parameters: + - name: 'filter[locale]' + in: query + description: filter by attribute 'locale' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[app]' + in: query + description: filter by id(s) of related 'app' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'fields[betaAppLocalizations]' + in: query + description: the fields to include for returned resources of type betaAppLocalizations + schema: + type: array + items: + type: string + enum: + - app + - description + - feedbackEmail + - locale + - marketingUrl + - privacyPolicyUrl + - tvOsPrivacyPolicy + style: form + explode: false + required: 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: + - app + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + responses: + '200': + description: List of BetaAppLocalizations + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppLocalizationsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + post: + tags: + - BetaAppLocalizations + operationId: betaAppLocalizations-create_instance + requestBody: + description: BetaAppLocalization representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppLocalizationCreateRequest' + required: true + responses: + '201': + description: Single BetaAppLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppLocalizationResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/betaAppLocalizations/{id}': + get: + tags: + - BetaAppLocalizations + operationId: betaAppLocalizations-get_instance + parameters: + - name: 'fields[betaAppLocalizations]' + in: query + description: the fields to include for returned resources of type betaAppLocalizations + schema: + type: array + items: + type: string + enum: + - app + - description + - feedbackEmail + - locale + - marketingUrl + - privacyPolicyUrl + - tvOsPrivacyPolicy + 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: + - app + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + responses: + '200': + description: Single BetaAppLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppLocalizationResponse' + '400': + description: Parameter 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' + patch: + tags: + - BetaAppLocalizations + operationId: betaAppLocalizations-update_instance + requestBody: + description: BetaAppLocalization representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppLocalizationUpdateRequest' + required: true + responses: + '200': + description: Single BetaAppLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppLocalizationResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - BetaAppLocalizations + operationId: betaAppLocalizations-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/betaAppReviewDetails: + get: + tags: + - BetaAppReviewDetails + operationId: betaAppReviewDetails-get_collection + parameters: + - name: 'filter[app]' + in: query + description: filter by id(s) of related 'app' + schema: + type: array + items: + type: string + style: form + explode: false + required: true + - name: 'fields[betaAppReviewDetails]' + in: query + description: the fields to include for returned resources of type betaAppReviewDetails + schema: + type: array + items: + type: string + enum: + - app + - contactEmail + - contactFirstName + - contactLastName + - contactPhone + - demoAccountName + - demoAccountPassword + - demoAccountRequired + - notes + style: form + explode: false + required: 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: + - app + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + responses: + '200': + description: List of BetaAppReviewDetails + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppReviewDetailsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/betaAppReviewDetails/{id}': + get: + tags: + - BetaAppReviewDetails + operationId: betaAppReviewDetails-get_instance + parameters: + - name: 'fields[betaAppReviewDetails]' + in: query + description: the fields to include for returned resources of type betaAppReviewDetails + schema: + type: array + items: + type: string + enum: + - app + - contactEmail + - contactFirstName + - contactLastName + - contactPhone + - demoAccountName + - demoAccountPassword + - demoAccountRequired + - notes + 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: + - app + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + responses: + '200': + description: Single BetaAppReviewDetail + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppReviewDetailResponse' + '400': + description: Parameter 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' + patch: + tags: + - BetaAppReviewDetails + operationId: betaAppReviewDetails-update_instance + requestBody: + description: BetaAppReviewDetail representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppReviewDetailUpdateRequest' + required: true + responses: + '200': + description: Single BetaAppReviewDetail + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppReviewDetailResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/betaAppReviewSubmissions: + get: + tags: + - BetaAppReviewSubmissions + operationId: betaAppReviewSubmissions-get_collection + parameters: + - name: 'filter[betaReviewState]' + in: query + description: filter by attribute 'betaReviewState' + schema: + type: array + items: + type: string + enum: + - WAITING_FOR_REVIEW + - IN_REVIEW + - REJECTED + - APPROVED + style: form + explode: false + required: false + - name: 'filter[build]' + in: query + description: filter by id(s) of related 'build' + schema: + type: array + items: + type: string + style: form + explode: false + required: true + - name: 'fields[betaAppReviewSubmissions]' + in: query + description: the fields to include for returned resources of type betaAppReviewSubmissions + schema: + type: array + items: + type: string + enum: + - betaReviewState + - build + style: form + explode: false + required: 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: + - build + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + responses: + '200': + description: List of BetaAppReviewSubmissions + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppReviewSubmissionsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + post: + tags: + - BetaAppReviewSubmissions + operationId: betaAppReviewSubmissions-create_instance + requestBody: + description: BetaAppReviewSubmission representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppReviewSubmissionCreateRequest' + required: true + responses: + '201': + description: Single BetaAppReviewSubmission + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppReviewSubmissionResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/betaAppReviewSubmissions/{id}': + get: + tags: + - BetaAppReviewSubmissions + operationId: betaAppReviewSubmissions-get_instance + parameters: + - name: 'fields[betaAppReviewSubmissions]' + in: query + description: the fields to include for returned resources of type betaAppReviewSubmissions + schema: + type: array + items: + type: string + enum: + - betaReviewState + - build + 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: + - build + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + responses: + '200': + description: Single BetaAppReviewSubmission + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppReviewSubmissionResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + /v1/betaBuildLocalizations: + get: + tags: + - BetaBuildLocalizations + operationId: betaBuildLocalizations-get_collection + parameters: + - name: 'filter[locale]' + in: query + description: filter by attribute 'locale' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[build]' + in: query + description: filter by id(s) of related 'build' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'fields[betaBuildLocalizations]' + in: query + description: the fields to include for returned resources of type betaBuildLocalizations + schema: + type: array + items: + type: string + enum: + - build + - locale + - whatsNew + style: form + explode: false + required: 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: + - build + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + responses: + '200': + description: List of BetaBuildLocalizations + content: + application/json: + schema: + $ref: '#/components/schemas/BetaBuildLocalizationsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + post: + tags: + - BetaBuildLocalizations + operationId: betaBuildLocalizations-create_instance + requestBody: + description: BetaBuildLocalization representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaBuildLocalizationCreateRequest' + required: true + responses: + '201': + description: Single BetaBuildLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/BetaBuildLocalizationResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/betaBuildLocalizations/{id}': + get: + tags: + - BetaBuildLocalizations + operationId: betaBuildLocalizations-get_instance + parameters: + - name: 'fields[betaBuildLocalizations]' + in: query + description: the fields to include for returned resources of type betaBuildLocalizations + schema: + type: array + items: + type: string + enum: + - build + - locale + - whatsNew + 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: + - build + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + responses: + '200': + description: Single BetaBuildLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/BetaBuildLocalizationResponse' + '400': + description: Parameter 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' + patch: + tags: + - BetaBuildLocalizations + operationId: betaBuildLocalizations-update_instance + requestBody: + description: BetaBuildLocalization representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaBuildLocalizationUpdateRequest' + required: true + responses: + '200': + description: Single BetaBuildLocalization + content: + application/json: + schema: + $ref: '#/components/schemas/BetaBuildLocalizationResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - BetaBuildLocalizations + operationId: betaBuildLocalizations-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/betaGroups: + get: + tags: + - BetaGroups + operationId: betaGroups-get_collection + parameters: + - name: 'filter[isInternalGroup]' + in: query + description: filter by attribute 'isInternalGroup' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[name]' + in: query + description: filter by attribute 'name' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[publicLink]' + in: query + description: filter by attribute 'publicLink' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[publicLinkEnabled]' + in: query + description: filter by attribute 'publicLinkEnabled' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[publicLinkLimitEnabled]' + in: query + description: filter by attribute 'publicLinkLimitEnabled' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[app]' + in: query + description: filter by id(s) of related 'app' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[builds]' + in: query + description: filter by id(s) of related 'builds' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[id]' + in: query + description: filter by id(s) + schema: + type: array + items: + type: string + style: form + explode: false + required: 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' + - name + - '-name' + - publicLinkEnabled + - '-publicLinkEnabled' + - publicLinkLimit + - '-publicLinkLimit' + style: form + explode: false + required: false + - name: 'fields[betaGroups]' + in: query + description: the fields to include for returned resources of type betaGroups + schema: + type: array + items: + type: string + enum: + - app + - betaTesters + - builds + - createdDate + - feedbackEnabled + - isInternalGroup + - name + - publicLink + - publicLinkEnabled + - publicLinkId + - publicLinkLimit + - publicLinkLimitEnabled + style: form + explode: false + required: 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: + - app + - betaTesters + - builds + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + - name: 'fields[betaTesters]' + in: query + description: the fields to include for returned resources of type betaTesters + schema: + type: array + items: + type: string + enum: + - apps + - betaGroups + - builds + - email + - firstName + - inviteType + - lastName + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[betaTesters]' + in: query + description: maximum number of related betaTesters returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[builds]' + in: query + description: maximum number of related builds returned (when they are included) + schema: + type: integer + maximum: 1000 + style: form + required: false + responses: + '200': + description: List of BetaGroups + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + post: + tags: + - BetaGroups + operationId: betaGroups-create_instance + requestBody: + description: BetaGroup representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupCreateRequest' + required: true + responses: + '201': + description: Single BetaGroup + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/betaGroups/{id}': + get: + tags: + - BetaGroups + operationId: betaGroups-get_instance + parameters: + - name: 'fields[betaGroups]' + in: query + description: the fields to include for returned resources of type betaGroups + schema: + type: array + items: + type: string + enum: + - app + - betaTesters + - builds + - createdDate + - feedbackEnabled + - isInternalGroup + - name + - publicLink + - publicLinkEnabled + - publicLinkId + - publicLinkLimit + - publicLinkLimitEnabled + 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: + - app + - betaTesters + - builds + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + - name: 'fields[betaTesters]' + in: query + description: the fields to include for returned resources of type betaTesters + schema: + type: array + items: + type: string + enum: + - apps + - betaGroups + - builds + - email + - firstName + - inviteType + - lastName + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[betaTesters]' + in: query + description: maximum number of related betaTesters returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[builds]' + in: query + description: maximum number of related builds returned (when they are included) + schema: + type: integer + maximum: 1000 + style: form + required: false + responses: + '200': + description: Single BetaGroup + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupResponse' + '400': + description: Parameter 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' + patch: + tags: + - BetaGroups + operationId: betaGroups-update_instance + requestBody: + description: BetaGroup representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupUpdateRequest' + required: true + responses: + '200': + description: Single BetaGroup + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - BetaGroups + operationId: betaGroups-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/betaLicenseAgreements: + get: + tags: + - BetaLicenseAgreements + operationId: betaLicenseAgreements-get_collection + parameters: + - name: 'filter[app]' + in: query + description: filter by id(s) of related 'app' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'fields[betaLicenseAgreements]' + in: query + description: the fields to include for returned resources of type betaLicenseAgreements + schema: + type: array + items: + type: string + enum: + - agreementText + - app + style: form + explode: false + required: 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: + - app + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + responses: + '200': + description: List of BetaLicenseAgreements + content: + application/json: + schema: + $ref: '#/components/schemas/BetaLicenseAgreementsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/betaLicenseAgreements/{id}': + get: + tags: + - BetaLicenseAgreements + operationId: betaLicenseAgreements-get_instance + parameters: + - name: 'fields[betaLicenseAgreements]' + in: query + description: the fields to include for returned resources of type betaLicenseAgreements + schema: + type: array + items: + type: string + enum: + - agreementText + - app + 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: + - app + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + responses: + '200': + description: Single BetaLicenseAgreement + content: + application/json: + schema: + $ref: '#/components/schemas/BetaLicenseAgreementResponse' + '400': + description: Parameter 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' + patch: + tags: + - BetaLicenseAgreements + operationId: betaLicenseAgreements-update_instance + requestBody: + description: BetaLicenseAgreement representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaLicenseAgreementUpdateRequest' + required: true + responses: + '200': + description: Single BetaLicenseAgreement + content: + application/json: + schema: + $ref: '#/components/schemas/BetaLicenseAgreementResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/betaTesterInvitations: + post: + tags: + - BetaTesterInvitations + operationId: betaTesterInvitations-create_instance + requestBody: + description: BetaTesterInvitation representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterInvitationCreateRequest' + required: true + responses: + '201': + description: Single BetaTesterInvitation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterInvitationResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /v1/betaTesters: + get: + tags: + - BetaTesters + operationId: betaTesters-get_collection + parameters: + - name: 'filter[email]' + in: query + description: filter by attribute 'email' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[firstName]' + in: query + description: filter by attribute 'firstName' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[inviteType]' + in: query + description: filter by attribute 'inviteType' + schema: + type: array + items: + type: string + enum: + - EMAIL + - PUBLIC_LINK + style: form + explode: false + required: false + - name: 'filter[lastName]' + in: query + description: filter by attribute 'lastName' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[apps]' + in: query + description: filter by id(s) of related 'apps' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[betaGroups]' + in: query + description: filter by id(s) of related 'betaGroups' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[builds]' + in: query + description: filter by id(s) of related 'builds' + schema: + type: array + items: + type: string + style: form + explode: false + required: 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: + - email + - '-email' + - firstName + - '-firstName' + - inviteType + - '-inviteType' + - lastName + - '-lastName' + style: form + explode: false + required: false + - name: 'fields[betaTesters]' + in: query + description: the fields to include for returned resources of type betaTesters + schema: + type: array + items: + type: string + enum: + - apps + - betaGroups + - builds + - email + - firstName + - inviteType + - lastName + style: form + explode: false + required: 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: + - apps + - betaGroups + - builds + style: form + explode: false + required: false + - name: 'fields[betaGroups]' + in: query + description: the fields to include for returned resources of type betaGroups + schema: + type: array + items: + type: string + enum: + - app + - betaTesters + - builds + - createdDate + - feedbackEnabled + - isInternalGroup + - name + - publicLink + - publicLinkEnabled + - publicLinkId + - publicLinkLimit + - publicLinkLimitEnabled + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[apps]' + in: query + description: maximum number of related apps returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[betaGroups]' + in: query + description: maximum number of related betaGroups returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[builds]' + in: query + description: maximum number of related builds returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: List of BetaTesters + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTestersResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + post: + tags: + - BetaTesters + operationId: betaTesters-create_instance + requestBody: + description: BetaTester representation + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterCreateRequest' + required: true + responses: + '201': + description: Single BetaTester + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/betaTesters/{id}': + get: + tags: + - BetaTesters + operationId: betaTesters-get_instance + parameters: + - name: 'fields[betaTesters]' + in: query + description: the fields to include for returned resources of type betaTesters + schema: + type: array + items: + type: string + enum: + - apps + - betaGroups + - builds + - email + - firstName + - inviteType + - lastName + 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: + - apps + - betaGroups + - builds + style: form + explode: false + required: false + - name: 'fields[betaGroups]' + in: query + description: the fields to include for returned resources of type betaGroups + schema: + type: array + items: + type: string + enum: + - app + - betaTesters + - builds + - createdDate + - feedbackEnabled + - isInternalGroup + - name + - publicLink + - publicLinkEnabled + - publicLinkId + - publicLinkLimit + - publicLinkLimitEnabled + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[apps]' + in: query + description: maximum number of related apps returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[betaGroups]' + in: query + description: maximum number of related betaGroups returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[builds]' + in: query + description: maximum number of related builds returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single BetaTester + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterResponse' + '400': + description: Parameter 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' + delete: + tags: + - BetaTesters + operationId: betaTesters-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/buildBetaDetails: + get: + tags: + - BuildBetaDetails + operationId: buildBetaDetails-get_collection + parameters: + - name: 'filter[build]' + in: query + description: filter by id(s) of related 'build' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[id]' + in: query + description: filter by id(s) + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'fields[buildBetaDetails]' + in: query + description: the fields to include for returned resources of type buildBetaDetails + schema: + type: array + items: + type: string + enum: + - autoNotifyEnabled + - build + - externalBuildState + - internalBuildState + style: form + explode: false + required: 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: + - build + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + responses: + '200': + description: List of BuildBetaDetails + content: + application/json: + schema: + $ref: '#/components/schemas/BuildBetaDetailsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/buildBetaDetails/{id}': + get: + tags: + - BuildBetaDetails + operationId: buildBetaDetails-get_instance + parameters: + - name: 'fields[buildBetaDetails]' + in: query + description: the fields to include for returned resources of type buildBetaDetails + schema: + type: array + items: + type: string + enum: + - autoNotifyEnabled + - build + - externalBuildState + - internalBuildState + 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: + - build + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + responses: + '200': + description: Single BuildBetaDetail + content: + application/json: + schema: + $ref: '#/components/schemas/BuildBetaDetailResponse' + '400': + description: Parameter 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' + patch: + tags: + - BuildBetaDetails + operationId: buildBetaDetails-update_instance + requestBody: + description: BuildBetaDetail representation + content: + application/json: + schema: + $ref: '#/components/schemas/BuildBetaDetailUpdateRequest' + required: true + responses: + '200': + description: Single BuildBetaDetail + content: + application/json: + schema: + $ref: '#/components/schemas/BuildBetaDetailResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/buildBetaNotifications: + post: + tags: + - BuildBetaNotifications + operationId: buildBetaNotifications-create_instance + requestBody: + description: BuildBetaNotification representation + content: + application/json: + schema: + $ref: '#/components/schemas/BuildBetaNotificationCreateRequest' + required: true + responses: + '201': + description: Single BuildBetaNotification + content: + application/json: + schema: + $ref: '#/components/schemas/BuildBetaNotificationResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /v1/builds: + get: + tags: + - Builds + operationId: builds-get_collection + parameters: + - name: 'filter[betaAppReviewSubmission.betaReviewState]' + in: query + description: filter by attribute 'betaAppReviewSubmission.betaReviewState' + schema: + type: array + items: + type: string + enum: + - WAITING_FOR_REVIEW + - IN_REVIEW + - REJECTED + - APPROVED + style: form + explode: false + required: false + - name: 'filter[expired]' + in: query + description: filter by attribute 'expired' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[preReleaseVersion.platform]' + in: query + description: filter by attribute 'preReleaseVersion.platform' + schema: + type: array + items: + type: string + enum: + - IOS + - MAC_OS + - TV_OS + style: form + explode: false + required: false + - name: 'filter[preReleaseVersion.version]' + in: query + description: filter by attribute 'preReleaseVersion.version' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[processingState]' + in: query + description: filter by attribute 'processingState' + schema: + type: array + items: + type: string + enum: + - PROCESSING + - FAILED + - INVALID + - VALID + style: form + explode: false + required: false + - name: 'filter[usesNonExemptEncryption]' + in: query + description: filter by attribute 'usesNonExemptEncryption' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[version]' + in: query + description: filter by attribute 'version' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[app]' + in: query + description: filter by id(s) of related 'app' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[appStoreVersion]' + in: query + description: filter by id(s) of related 'appStoreVersion' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[betaGroups]' + in: query + description: filter by id(s) of related 'betaGroups' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[preReleaseVersion]' + in: query + description: filter by id(s) of related 'preReleaseVersion' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[id]' + in: query + description: filter by id(s) + schema: + type: array + items: + type: string + style: form + explode: false + required: 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: + - preReleaseVersion + - '-preReleaseVersion' + - uploadedDate + - '-uploadedDate' + - version + - '-version' + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: 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: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - buildBetaDetail + - icons + - individualTesters + - preReleaseVersion + style: form + explode: false + required: false + - name: 'fields[appEncryptionDeclarations]' + in: query + description: the fields to include for returned resources of type appEncryptionDeclarations + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclarationState + - availableOnFrenchStore + - builds + - codeValue + - containsProprietaryCryptography + - containsThirdPartyCryptography + - documentName + - documentType + - documentUrl + - exempt + - platform + - uploadedDate + - usesEncryption + style: form + explode: false + required: false + - name: 'fields[betaAppReviewSubmissions]' + in: query + description: the fields to include for returned resources of type betaAppReviewSubmissions + schema: + type: array + items: + type: string + enum: + - betaReviewState + - build + style: form + explode: false + required: false + - name: 'fields[buildBetaDetails]' + in: query + description: the fields to include for returned resources of type buildBetaDetails + schema: + type: array + items: + type: string + enum: + - autoNotifyEnabled + - build + - externalBuildState + - internalBuildState + style: form + explode: false + required: false + - name: 'fields[buildIcons]' + in: query + description: the fields to include for returned resources of type buildIcons + schema: + type: array + items: + type: string + enum: + - iconAsset + - iconType + style: form + explode: false + required: false + - name: 'fields[perfPowerMetrics]' + in: query + description: the fields to include for returned resources of type perfPowerMetrics + schema: + type: array + items: + type: string + enum: + - deviceType + - metricType + - platform + style: form + explode: false + required: false + - name: 'fields[preReleaseVersions]' + in: query + description: the fields to include for returned resources of type preReleaseVersions + schema: + type: array + items: + type: string + enum: + - app + - builds + - platform + - version + style: form + explode: false + required: false + - name: 'fields[appStoreVersions]' + in: query + description: the fields to include for returned resources of type appStoreVersions + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreState + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - copyright + - createdDate + - downloadable + - earliestReleaseDate + - idfaDeclaration + - platform + - releaseType + - routingAppCoverage + - usesIdfa + - versionString + style: form + explode: false + required: false + - name: 'fields[diagnosticSignatures]' + in: query + description: the fields to include for returned resources of type diagnosticSignatures + schema: + type: array + items: + type: string + enum: + - diagnosticType + - logs + - signature + - weight + style: form + explode: false + required: false + - name: 'fields[betaTesters]' + in: query + description: the fields to include for returned resources of type betaTesters + schema: + type: array + items: + type: string + enum: + - apps + - betaGroups + - builds + - email + - firstName + - inviteType + - lastName + style: form + explode: false + required: false + - name: 'fields[betaBuildLocalizations]' + in: query + description: the fields to include for returned resources of type betaBuildLocalizations + schema: + type: array + items: + type: string + enum: + - build + - locale + - whatsNew + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[betaBuildLocalizations]' + in: query + description: maximum number of related betaBuildLocalizations returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[icons]' + in: query + description: maximum number of related icons returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[individualTesters]' + in: query + description: maximum number of related individualTesters returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: List of Builds + content: + application/json: + schema: + $ref: '#/components/schemas/BuildsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/builds/{id}': + get: + tags: + - Builds + operationId: builds-get_instance + parameters: + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + 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: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - buildBetaDetail + - icons + - individualTesters + - preReleaseVersion + style: form + explode: false + required: false + - name: 'fields[appEncryptionDeclarations]' + in: query + description: the fields to include for returned resources of type appEncryptionDeclarations + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclarationState + - availableOnFrenchStore + - builds + - codeValue + - containsProprietaryCryptography + - containsThirdPartyCryptography + - documentName + - documentType + - documentUrl + - exempt + - platform + - uploadedDate + - usesEncryption + style: form + explode: false + required: false + - name: 'fields[betaAppReviewSubmissions]' + in: query + description: the fields to include for returned resources of type betaAppReviewSubmissions + schema: + type: array + items: + type: string + enum: + - betaReviewState + - build + style: form + explode: false + required: false + - name: 'fields[buildBetaDetails]' + in: query + description: the fields to include for returned resources of type buildBetaDetails + schema: + type: array + items: + type: string + enum: + - autoNotifyEnabled + - build + - externalBuildState + - internalBuildState + style: form + explode: false + required: false + - name: 'fields[buildIcons]' + in: query + description: the fields to include for returned resources of type buildIcons + schema: + type: array + items: + type: string + enum: + - iconAsset + - iconType + style: form + explode: false + required: false + - name: 'fields[perfPowerMetrics]' + in: query + description: the fields to include for returned resources of type perfPowerMetrics + schema: + type: array + items: + type: string + enum: + - deviceType + - metricType + - platform + style: form + explode: false + required: false + - name: 'fields[preReleaseVersions]' + in: query + description: the fields to include for returned resources of type preReleaseVersions + schema: + type: array + items: + type: string + enum: + - app + - builds + - platform + - version + style: form + explode: false + required: false + - name: 'fields[appStoreVersions]' + in: query + description: the fields to include for returned resources of type appStoreVersions + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreState + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - copyright + - createdDate + - downloadable + - earliestReleaseDate + - idfaDeclaration + - platform + - releaseType + - routingAppCoverage + - usesIdfa + - versionString + style: form + explode: false + required: false + - name: 'fields[diagnosticSignatures]' + in: query + description: the fields to include for returned resources of type diagnosticSignatures + schema: + type: array + items: + type: string + enum: + - diagnosticType + - logs + - signature + - weight + style: form + explode: false + required: false + - name: 'fields[betaTesters]' + in: query + description: the fields to include for returned resources of type betaTesters + schema: + type: array + items: + type: string + enum: + - apps + - betaGroups + - builds + - email + - firstName + - inviteType + - lastName + style: form + explode: false + required: false + - name: 'fields[betaBuildLocalizations]' + in: query + description: the fields to include for returned resources of type betaBuildLocalizations + schema: + type: array + items: + type: string + enum: + - build + - locale + - whatsNew + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[betaBuildLocalizations]' + in: query + description: maximum number of related betaBuildLocalizations returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[icons]' + in: query + description: maximum number of related icons returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[individualTesters]' + in: query + description: maximum number of related individualTesters returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single Build + content: + application/json: + schema: + $ref: '#/components/schemas/BuildResponse' + '400': + description: Parameter 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' + patch: + tags: + - Builds + operationId: builds-update_instance + requestBody: + description: Build representation + content: + application/json: + schema: + $ref: '#/components/schemas/BuildUpdateRequest' + required: true + responses: + '200': + description: Single Build + content: + application/json: + schema: + $ref: '#/components/schemas/BuildResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/bundleIdCapabilities: + post: + tags: + - BundleIdCapabilities + operationId: bundleIdCapabilities-create_instance + requestBody: + description: BundleIdCapability representation + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdCapabilityCreateRequest' + required: true + responses: + '201': + description: Single BundleIdCapability + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdCapabilityResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/bundleIdCapabilities/{id}': + patch: + tags: + - BundleIdCapabilities + operationId: bundleIdCapabilities-update_instance + requestBody: + description: BundleIdCapability representation + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdCapabilityUpdateRequest' + required: true + responses: + '200': + description: Single BundleIdCapability + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdCapabilityResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - BundleIdCapabilities + operationId: bundleIdCapabilities-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/bundleIds: + get: + tags: + - BundleIds + operationId: bundleIds-get_collection + parameters: + - name: 'filter[identifier]' + in: query + description: filter by attribute 'identifier' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[name]' + in: query + description: filter by attribute 'name' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[platform]' + in: query + description: filter by attribute 'platform' + schema: + type: array + items: + type: string + enum: + - IOS + - MAC_OS + style: form + explode: false + required: false + - name: 'filter[seedId]' + in: query + description: filter by attribute 'seedId' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[id]' + in: query + description: filter by id(s) + schema: + type: array + items: + type: string + style: form + explode: false + required: 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: + - id + - '-id' + - identifier + - '-identifier' + - name + - '-name' + - platform + - '-platform' + - seedId + - '-seedId' + style: form + explode: false + required: false + - name: 'fields[bundleIds]' + in: query + description: the fields to include for returned resources of type bundleIds + schema: + type: array + items: + type: string + enum: + - app + - bundleIdCapabilities + - identifier + - name + - platform + - profiles + - seedId + style: form + explode: false + required: 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: + - app + - bundleIdCapabilities + - profiles + style: form + explode: false + required: false + - name: 'fields[bundleIdCapabilities]' + in: query + description: the fields to include for returned resources of type bundleIdCapabilities + schema: + type: array + items: + type: string + enum: + - bundleId + - capabilityType + - settings + style: form + explode: false + required: false + - name: 'fields[profiles]' + in: query + description: the fields to include for returned resources of type profiles + schema: + type: array + items: + type: string + enum: + - bundleId + - certificates + - createdDate + - devices + - expirationDate + - name + - platform + - profileContent + - profileState + - profileType + - uuid + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[bundleIdCapabilities]' + in: query + description: maximum number of related bundleIdCapabilities returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[profiles]' + in: query + description: maximum number of related profiles returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: List of BundleIds + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + post: + tags: + - BundleIds + operationId: bundleIds-create_instance + requestBody: + description: BundleId representation + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdCreateRequest' + required: true + responses: + '201': + description: Single BundleId + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/bundleIds/{id}': + get: + tags: + - BundleIds + operationId: bundleIds-get_instance + parameters: + - name: 'fields[bundleIds]' + in: query + description: the fields to include for returned resources of type bundleIds + schema: + type: array + items: + type: string + enum: + - app + - bundleIdCapabilities + - identifier + - name + - platform + - profiles + - seedId + 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: + - app + - bundleIdCapabilities + - profiles + style: form + explode: false + required: false + - name: 'fields[bundleIdCapabilities]' + in: query + description: the fields to include for returned resources of type bundleIdCapabilities + schema: + type: array + items: + type: string + enum: + - bundleId + - capabilityType + - settings + style: form + explode: false + required: false + - name: 'fields[profiles]' + in: query + description: the fields to include for returned resources of type profiles + schema: + type: array + items: + type: string + enum: + - bundleId + - certificates + - createdDate + - devices + - expirationDate + - name + - platform + - profileContent + - profileState + - profileType + - uuid + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[bundleIdCapabilities]' + in: query + description: maximum number of related bundleIdCapabilities returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[profiles]' + in: query + description: maximum number of related profiles returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single BundleId + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdResponse' + '400': + description: Parameter 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' + patch: + tags: + - BundleIds + operationId: bundleIds-update_instance + requestBody: + description: BundleId representation + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdUpdateRequest' + required: true + responses: + '200': + description: Single BundleId + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - BundleIds + operationId: bundleIds-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/certificates: + get: + tags: + - Certificates + operationId: certificates-get_collection + parameters: + - name: 'filter[certificateType]' + in: query + description: filter by attribute 'certificateType' + schema: + type: array + items: + type: string + enum: + - IOS_DEVELOPMENT + - IOS_DISTRIBUTION + - MAC_APP_DISTRIBUTION + - MAC_INSTALLER_DISTRIBUTION + - MAC_APP_DEVELOPMENT + - DEVELOPER_ID_KEXT + - DEVELOPER_ID_APPLICATION + - DEVELOPMENT + - DISTRIBUTION + style: form + explode: false + required: false + - name: 'filter[displayName]' + in: query + description: filter by attribute 'displayName' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[serialNumber]' + in: query + description: filter by attribute 'serialNumber' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[id]' + in: query + description: filter by id(s) + schema: + type: array + items: + type: string + style: form + explode: false + required: 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: + - certificateType + - '-certificateType' + - displayName + - '-displayName' + - id + - '-id' + - serialNumber + - '-serialNumber' + style: form + explode: false + required: false + - name: 'fields[certificates]' + in: query + description: the fields to include for returned resources of type certificates + schema: + type: array + items: + type: string + enum: + - certificateContent + - certificateType + - csrContent + - displayName + - expirationDate + - name + - platform + - serialNumber + style: form + explode: false + required: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of Certificates + content: + application/json: + schema: + $ref: '#/components/schemas/CertificatesResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + post: + tags: + - Certificates + operationId: certificates-create_instance + requestBody: + description: Certificate representation + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateCreateRequest' + required: true + responses: + '201': + description: Single Certificate + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/certificates/{id}': + get: + tags: + - Certificates + operationId: certificates-get_instance + parameters: + - name: 'fields[certificates]' + in: query + description: the fields to include for returned resources of type certificates + schema: + type: array + items: + type: string + enum: + - certificateContent + - certificateType + - csrContent + - displayName + - expirationDate + - name + - platform + - serialNumber + style: form + explode: false + required: false + responses: + '200': + description: Single Certificate + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateResponse' + '400': + description: Parameter 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' + delete: + tags: + - Certificates + operationId: certificates-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/devices: + get: + tags: + - Devices + operationId: devices-get_collection + parameters: + - name: 'filter[name]' + in: query + description: filter by attribute 'name' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[platform]' + in: query + description: filter by attribute 'platform' + schema: + type: array + items: + type: string + enum: + - IOS + - MAC_OS + style: form + explode: false + required: false + - name: 'filter[status]' + in: query + description: filter by attribute 'status' + schema: + type: array + items: + type: string + enum: + - ENABLED + - DISABLED + style: form + explode: false + required: false + - name: 'filter[udid]' + in: query + description: filter by attribute 'udid' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[id]' + in: query + description: filter by id(s) + schema: + type: array + items: + type: string + style: form + explode: false + required: 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: + - id + - '-id' + - name + - '-name' + - platform + - '-platform' + - status + - '-status' + - udid + - '-udid' + style: form + explode: false + required: false + - name: 'fields[devices]' + in: query + description: the fields to include for returned resources of type devices + schema: + type: array + items: + type: string + enum: + - addedDate + - deviceClass + - model + - name + - platform + - status + - udid + style: form + explode: false + required: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of Devices + content: + application/json: + schema: + $ref: '#/components/schemas/DevicesResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + post: + tags: + - Devices + operationId: devices-create_instance + requestBody: + description: Device representation + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceCreateRequest' + required: true + responses: + '201': + description: Single Device + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/devices/{id}': + get: + tags: + - Devices + operationId: devices-get_instance + parameters: + - name: 'fields[devices]' + in: query + description: the fields to include for returned resources of type devices + schema: + type: array + items: + type: string + enum: + - addedDate + - deviceClass + - model + - name + - platform + - status + - udid + style: form + explode: false + required: false + responses: + '200': + description: Single Device + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceResponse' + '400': + description: Parameter 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' + patch: + tags: + - Devices + operationId: devices-update_instance + requestBody: + description: Device representation + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceUpdateRequest' + required: true + responses: + '200': + description: Single Device + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/endUserLicenseAgreements: + post: + tags: + - EndUserLicenseAgreements + operationId: endUserLicenseAgreements-create_instance + requestBody: + description: EndUserLicenseAgreement representation + content: + application/json: + schema: + $ref: '#/components/schemas/EndUserLicenseAgreementCreateRequest' + required: true + responses: + '201': + description: Single EndUserLicenseAgreement + content: + application/json: + schema: + $ref: '#/components/schemas/EndUserLicenseAgreementResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/endUserLicenseAgreements/{id}': + get: + tags: + - EndUserLicenseAgreements + operationId: endUserLicenseAgreements-get_instance + parameters: + - name: 'fields[endUserLicenseAgreements]' + in: query + description: the fields to include for returned resources of type endUserLicenseAgreements + schema: + type: array + items: + type: string + enum: + - agreementText + - app + - territories + 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: + - app + - territories + style: form + explode: false + required: false + - name: 'fields[territories]' + in: query + description: the fields to include for returned resources of type territories + schema: + type: array + items: + type: string + enum: + - currency + style: form + explode: false + required: false + - name: 'limit[territories]' + in: query + description: maximum number of related territories returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single EndUserLicenseAgreement + content: + application/json: + schema: + $ref: '#/components/schemas/EndUserLicenseAgreementResponse' + '400': + description: Parameter 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' + patch: + tags: + - EndUserLicenseAgreements + operationId: endUserLicenseAgreements-update_instance + requestBody: + description: EndUserLicenseAgreement representation + content: + application/json: + schema: + $ref: '#/components/schemas/EndUserLicenseAgreementUpdateRequest' + required: true + responses: + '200': + description: Single EndUserLicenseAgreement + content: + application/json: + schema: + $ref: '#/components/schemas/EndUserLicenseAgreementResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - EndUserLicenseAgreements + operationId: endUserLicenseAgreements-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/financeReports: + get: + tags: + - FinanceReports + operationId: financeReports-get_collection + parameters: + - name: 'filter[regionCode]' + in: query + description: filter by attribute 'regionCode' + schema: + type: array + items: + type: string + style: form + explode: false + required: true + - name: 'filter[reportDate]' + in: query + description: filter by attribute 'reportDate' + schema: + type: array + items: + type: string + style: form + explode: false + required: true + - name: 'filter[reportType]' + in: query + description: filter by attribute 'reportType' + schema: + type: array + items: + type: string + enum: + - FINANCIAL + - FINANCE_DETAIL + style: form + explode: false + required: true + - name: 'filter[vendorNumber]' + in: query + description: filter by attribute 'vendorNumber' + schema: + type: array + items: + type: string + style: form + explode: false + required: true + responses: + '200': + description: List of FinanceReports + content: + gzip: + schema: + type: string + format: binary + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /v1/idfaDeclarations: + post: + tags: + - IdfaDeclarations + operationId: idfaDeclarations-create_instance + requestBody: + description: IdfaDeclaration representation + content: + application/json: + schema: + $ref: '#/components/schemas/IdfaDeclarationCreateRequest' + required: true + responses: + '201': + description: Single IdfaDeclaration + content: + application/json: + schema: + $ref: '#/components/schemas/IdfaDeclarationResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/idfaDeclarations/{id}': + patch: + tags: + - IdfaDeclarations + operationId: idfaDeclarations-update_instance + requestBody: + description: IdfaDeclaration representation + content: + application/json: + schema: + $ref: '#/components/schemas/IdfaDeclarationUpdateRequest' + required: true + responses: + '200': + description: Single IdfaDeclaration + content: + application/json: + schema: + $ref: '#/components/schemas/IdfaDeclarationResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - IdfaDeclarations + operationId: idfaDeclarations-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/inAppPurchases/{id}': + get: + tags: + - InAppPurchases + operationId: inAppPurchases-get_instance + parameters: + - name: 'fields[inAppPurchases]' + in: query + description: the fields to include for returned resources of type inAppPurchases + schema: + type: array + items: + type: string + enum: + - apps + - inAppPurchaseType + - productId + - referenceName + - state + 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: + - apps + style: form + explode: false + required: false + - name: 'limit[apps]' + in: query + description: maximum number of related apps returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single InAppPurchase + content: + application/json: + schema: + $ref: '#/components/schemas/InAppPurchaseResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + /v1/preReleaseVersions: + get: + tags: + - PreReleaseVersions + operationId: preReleaseVersions-get_collection + parameters: + - name: 'filter[builds.expired]' + in: query + description: filter by attribute 'builds.expired' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[builds.processingState]' + in: query + description: filter by attribute 'builds.processingState' + schema: + type: array + items: + type: string + enum: + - PROCESSING + - FAILED + - INVALID + - VALID + style: form + explode: false + required: false + - name: 'filter[platform]' + in: query + description: filter by attribute 'platform' + schema: + type: array + items: + type: string + enum: + - IOS + - MAC_OS + - TV_OS + style: form + explode: false + required: false + - name: 'filter[version]' + in: query + description: filter by attribute 'version' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[app]' + in: query + description: filter by id(s) of related 'app' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[builds]' + in: query + description: filter by id(s) of related 'builds' + schema: + type: array + items: + type: string + style: form + explode: false + required: 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: + - version + - '-version' + style: form + explode: false + required: false + - name: 'fields[preReleaseVersions]' + in: query + description: the fields to include for returned resources of type preReleaseVersions + schema: + type: array + items: + type: string + enum: + - app + - builds + - platform + - version + style: form + explode: false + required: 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: + - app + - builds + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[builds]' + in: query + description: maximum number of related builds returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: List of PreReleaseVersions + content: + application/json: + schema: + $ref: '#/components/schemas/PreReleaseVersionsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/preReleaseVersions/{id}': + get: + tags: + - PreReleaseVersions + operationId: preReleaseVersions-get_instance + parameters: + - name: 'fields[preReleaseVersions]' + in: query + description: the fields to include for returned resources of type preReleaseVersions + schema: + type: array + items: + type: string + enum: + - app + - builds + - platform + - version + 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: + - app + - builds + style: form + explode: false + required: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[builds]' + in: query + description: maximum number of related builds returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single PrereleaseVersion + content: + application/json: + schema: + $ref: '#/components/schemas/PrereleaseVersionResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + /v1/profiles: + get: + tags: + - Profiles + operationId: profiles-get_collection + parameters: + - name: 'filter[name]' + in: query + description: filter by attribute 'name' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[profileState]' + in: query + description: filter by attribute 'profileState' + schema: + type: array + items: + type: string + enum: + - ACTIVE + - INVALID + style: form + explode: false + required: false + - name: 'filter[profileType]' + in: query + description: filter by attribute 'profileType' + schema: + type: array + items: + type: string + enum: + - IOS_APP_DEVELOPMENT + - IOS_APP_STORE + - IOS_APP_ADHOC + - IOS_APP_INHOUSE + - MAC_APP_DEVELOPMENT + - MAC_APP_STORE + - MAC_APP_DIRECT + - TVOS_APP_DEVELOPMENT + - TVOS_APP_STORE + - TVOS_APP_ADHOC + - TVOS_APP_INHOUSE + - MAC_CATALYST_APP_DEVELOPMENT + - MAC_CATALYST_APP_STORE + - MAC_CATALYST_APP_DIRECT + style: form + explode: false + required: false + - name: 'filter[id]' + in: query + description: filter by id(s) + schema: + type: array + items: + type: string + style: form + explode: false + required: 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: + - id + - '-id' + - name + - '-name' + - profileState + - '-profileState' + - profileType + - '-profileType' + style: form + explode: false + required: false + - name: 'fields[profiles]' + in: query + description: the fields to include for returned resources of type profiles + schema: + type: array + items: + type: string + enum: + - bundleId + - certificates + - createdDate + - devices + - expirationDate + - name + - platform + - profileContent + - profileState + - profileType + - uuid + style: form + explode: false + required: 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: + - bundleId + - certificates + - devices + style: form + explode: false + required: false + - name: 'fields[certificates]' + in: query + description: the fields to include for returned resources of type certificates + schema: + type: array + items: + type: string + enum: + - certificateContent + - certificateType + - csrContent + - displayName + - expirationDate + - name + - platform + - serialNumber + style: form + explode: false + required: false + - name: 'fields[devices]' + in: query + description: the fields to include for returned resources of type devices + schema: + type: array + items: + type: string + enum: + - addedDate + - deviceClass + - model + - name + - platform + - status + - udid + style: form + explode: false + required: false + - name: 'fields[bundleIds]' + in: query + description: the fields to include for returned resources of type bundleIds + schema: + type: array + items: + type: string + enum: + - app + - bundleIdCapabilities + - identifier + - name + - platform + - profiles + - seedId + style: form + explode: false + required: false + - name: 'limit[certificates]' + in: query + description: maximum number of related certificates returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[devices]' + in: query + description: maximum number of related devices returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: List of Profiles + content: + application/json: + schema: + $ref: '#/components/schemas/ProfilesResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + post: + tags: + - Profiles + operationId: profiles-create_instance + requestBody: + description: Profile representation + content: + application/json: + schema: + $ref: '#/components/schemas/ProfileCreateRequest' + required: true + responses: + '201': + description: Single Profile + content: + application/json: + schema: + $ref: '#/components/schemas/ProfileResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/profiles/{id}': + get: + tags: + - Profiles + operationId: profiles-get_instance + parameters: + - name: 'fields[profiles]' + in: query + description: the fields to include for returned resources of type profiles + schema: + type: array + items: + type: string + enum: + - bundleId + - certificates + - createdDate + - devices + - expirationDate + - name + - platform + - profileContent + - profileState + - profileType + - uuid + 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: + - bundleId + - certificates + - devices + style: form + explode: false + required: false + - name: 'fields[certificates]' + in: query + description: the fields to include for returned resources of type certificates + schema: + type: array + items: + type: string + enum: + - certificateContent + - certificateType + - csrContent + - displayName + - expirationDate + - name + - platform + - serialNumber + style: form + explode: false + required: false + - name: 'fields[devices]' + in: query + description: the fields to include for returned resources of type devices + schema: + type: array + items: + type: string + enum: + - addedDate + - deviceClass + - model + - name + - platform + - status + - udid + style: form + explode: false + required: false + - name: 'fields[bundleIds]' + in: query + description: the fields to include for returned resources of type bundleIds + schema: + type: array + items: + type: string + enum: + - app + - bundleIdCapabilities + - identifier + - name + - platform + - profiles + - seedId + style: form + explode: false + required: false + - name: 'limit[certificates]' + in: query + description: maximum number of related certificates returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + - name: 'limit[devices]' + in: query + description: maximum number of related devices returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single Profile + content: + application/json: + schema: + $ref: '#/components/schemas/ProfileResponse' + '400': + description: Parameter 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' + delete: + tags: + - Profiles + operationId: profiles-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/routingAppCoverages: + post: + tags: + - RoutingAppCoverages + operationId: routingAppCoverages-create_instance + requestBody: + description: RoutingAppCoverage representation + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAppCoverageCreateRequest' + required: true + responses: + '201': + description: Single RoutingAppCoverage + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAppCoverageResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/routingAppCoverages/{id}': + get: + tags: + - RoutingAppCoverages + operationId: routingAppCoverages-get_instance + parameters: + - name: 'fields[routingAppCoverages]' + in: query + description: the fields to include for returned resources of type routingAppCoverages + schema: + type: array + items: + type: string + enum: + - appStoreVersion + - assetDeliveryState + - fileName + - fileSize + - sourceFileChecksum + - uploadOperations + - uploaded + 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: + - appStoreVersion + style: form + explode: false + required: false + responses: + '200': + description: Single RoutingAppCoverage + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAppCoverageResponse' + '400': + description: Parameter 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' + patch: + tags: + - RoutingAppCoverages + operationId: routingAppCoverages-update_instance + requestBody: + description: RoutingAppCoverage representation + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAppCoverageUpdateRequest' + required: true + responses: + '200': + description: Single RoutingAppCoverage + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAppCoverageResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - RoutingAppCoverages + operationId: routingAppCoverages-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/salesReports: + get: + tags: + - SalesReports + operationId: salesReports-get_collection + parameters: + - name: 'filter[frequency]' + in: query + description: filter by attribute 'frequency' + schema: + type: array + items: + type: string + enum: + - DAILY + - WEEKLY + - MONTHLY + - YEARLY + style: form + explode: false + required: true + - name: 'filter[reportDate]' + in: query + description: filter by attribute 'reportDate' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[reportSubType]' + in: query + description: filter by attribute 'reportSubType' + schema: + type: array + items: + type: string + enum: + - SUMMARY + - DETAILED + - OPT_IN + style: form + explode: false + required: true + - name: 'filter[reportType]' + in: query + description: filter by attribute 'reportType' + schema: + type: array + items: + type: string + enum: + - SALES + - PRE_ORDER + - NEWSSTAND + - SUBSCRIPTION + - SUBSCRIPTION_EVENT + - SUBSCRIBER + style: form + explode: false + required: true + - name: 'filter[vendorNumber]' + in: query + description: filter by attribute 'vendorNumber' + schema: + type: array + items: + type: string + style: form + explode: false + required: true + - name: 'filter[version]' + in: query + description: filter by attribute 'version' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + responses: + '200': + description: List of SalesReports + content: + gzip: + schema: + type: string + format: binary + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /v1/territories: + get: + tags: + - Territories + operationId: territories-get_collection + parameters: + - name: 'fields[territories]' + in: query + description: the fields to include for returned resources of type territories + schema: + type: array + items: + type: string + enum: + - currency + style: form + explode: false + required: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of Territories + content: + application/json: + schema: + $ref: '#/components/schemas/TerritoriesResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /v1/userInvitations: + get: + tags: + - UserInvitations + operationId: userInvitations-get_collection + parameters: + - name: 'filter[email]' + in: query + description: filter by attribute 'email' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[roles]' + in: query + description: filter by attribute 'roles' + schema: + type: array + items: + type: string + enum: + - ADMIN + - FINANCE + - TECHNICAL + - ACCOUNT_HOLDER + - READ_ONLY + - SALES + - MARKETING + - APP_MANAGER + - DEVELOPER + - ACCESS_TO_REPORTS + - CUSTOMER_SUPPORT + - CREATE_APPS + - CLOUD_MANAGED_DEVELOPER_ID + - CLOUD_MANAGED_APP_DISTRIBUTION + style: form + explode: false + required: false + - name: 'filter[visibleApps]' + in: query + description: filter by id(s) of related 'visibleApps' + schema: + type: array + items: + type: string + style: form + explode: false + required: 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: + - email + - '-email' + - lastName + - '-lastName' + style: form + explode: false + required: false + - name: 'fields[userInvitations]' + in: query + description: the fields to include for returned resources of type userInvitations + schema: + type: array + items: + type: string + enum: + - allAppsVisible + - email + - expirationDate + - firstName + - lastName + - provisioningAllowed + - roles + - visibleApps + style: form + explode: false + required: 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: + - visibleApps + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[visibleApps]' + in: query + description: maximum number of related visibleApps returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: List of UserInvitations + content: + application/json: + schema: + $ref: '#/components/schemas/UserInvitationsResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + post: + tags: + - UserInvitations + operationId: userInvitations-create_instance + requestBody: + description: UserInvitation representation + content: + application/json: + schema: + $ref: '#/components/schemas/UserInvitationCreateRequest' + required: true + responses: + '201': + description: Single UserInvitation + content: + application/json: + schema: + $ref: '#/components/schemas/UserInvitationResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/userInvitations/{id}': + get: + tags: + - UserInvitations + operationId: userInvitations-get_instance + parameters: + - name: 'fields[userInvitations]' + in: query + description: the fields to include for returned resources of type userInvitations + schema: + type: array + items: + type: string + enum: + - allAppsVisible + - email + - expirationDate + - firstName + - lastName + - provisioningAllowed + - roles + - visibleApps + 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: + - visibleApps + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[visibleApps]' + in: query + description: maximum number of related visibleApps returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single UserInvitation + content: + application/json: + schema: + $ref: '#/components/schemas/UserInvitationResponse' + '400': + description: Parameter 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' + delete: + tags: + - UserInvitations + operationId: userInvitations-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/users: + get: + tags: + - Users + operationId: users-get_collection + parameters: + - name: 'filter[roles]' + in: query + description: filter by attribute 'roles' + schema: + type: array + items: + type: string + enum: + - ADMIN + - FINANCE + - TECHNICAL + - ACCOUNT_HOLDER + - READ_ONLY + - SALES + - MARKETING + - APP_MANAGER + - DEVELOPER + - ACCESS_TO_REPORTS + - CUSTOMER_SUPPORT + - CREATE_APPS + - CLOUD_MANAGED_DEVELOPER_ID + - CLOUD_MANAGED_APP_DISTRIBUTION + style: form + explode: false + required: false + - name: 'filter[username]' + in: query + description: filter by attribute 'username' + schema: + type: array + items: + type: string + style: form + explode: false + required: false + - name: 'filter[visibleApps]' + in: query + description: filter by id(s) of related 'visibleApps' + schema: + type: array + items: + type: string + style: form + explode: false + required: 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: + - lastName + - '-lastName' + - username + - '-username' + style: form + explode: false + required: false + - name: 'fields[users]' + in: query + description: the fields to include for returned resources of type users + schema: + type: array + items: + type: string + enum: + - allAppsVisible + - firstName + - lastName + - provisioningAllowed + - roles + - username + - visibleApps + style: form + explode: false + required: 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: + - visibleApps + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[visibleApps]' + in: query + description: maximum number of related visibleApps returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: List of Users + content: + application/json: + schema: + $ref: '#/components/schemas/UsersResponse' + '400': + description: Parameter error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '/v1/users/{id}': + get: + tags: + - Users + operationId: users-get_instance + parameters: + - name: 'fields[users]' + in: query + description: the fields to include for returned resources of type users + schema: + type: array + items: + type: string + enum: + - allAppsVisible + - firstName + - lastName + - provisioningAllowed + - roles + - username + - visibleApps + 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: + - visibleApps + style: form + explode: false + required: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + required: false + - name: 'limit[visibleApps]' + in: query + description: maximum number of related visibleApps returned (when they are included) + schema: + type: integer + maximum: 50 + style: form + required: false + responses: + '200': + description: Single User + content: + application/json: + schema: + $ref: '#/components/schemas/UserResponse' + '400': + description: Parameter 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' + patch: + tags: + - Users + operationId: users-update_instance + requestBody: + description: User representation + content: + application/json: + schema: + $ref: '#/components/schemas/UserUpdateRequest' + required: true + responses: + '200': + description: Single User + content: + application/json: + schema: + $ref: '#/components/schemas/UserResponse' + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - Users + operationId: users-delete_instance + responses: + '204': + description: Success (no content) + '400': + description: Parameter 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' + '409': + description: Request entity error(s) + 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/appCategories/{id}/parent': + get: + tags: + - AppCategories + operationId: appCategories-parent-get_to_one_related + parameters: + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppCategoryResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appCategories/{id}/subcategories': + get: + tags: + - AppCategories + operationId: appCategories-subcategories-get_to_many_related + parameters: + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppCategoriesResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appEncryptionDeclarations/{id}/app': + get: + tags: + - AppEncryptionDeclarations + operationId: appEncryptionDeclarations-app-get_to_one_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appEncryptionDeclarations/{id}/relationships/builds': + post: + tags: + - AppEncryptionDeclarations + operationId: appEncryptionDeclarations-builds-create_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/AppEncryptionDeclarationBuildsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/appInfos/{id}/ageRatingDeclaration': + get: + tags: + - AppInfos + operationId: appInfos-ageRatingDeclaration-get_to_one_related + parameters: + - name: 'fields[ageRatingDeclarations]' + in: query + description: the fields to include for returned resources of type ageRatingDeclarations + schema: + type: array + items: + type: string + enum: + - alcoholTobaccoOrDrugUseOrReferences + - contests + - gambling + - gamblingAndContests + - gamblingSimulated + - horrorOrFearThemes + - kidsAgeBand + - matureOrSuggestiveThemes + - medicalOrTreatmentInformation + - profanityOrCrudeHumor + - seventeenPlus + - sexualContentGraphicAndNudity + - sexualContentOrNudity + - unrestrictedWebAccess + - violenceCartoonOrFantasy + - violenceRealistic + - violenceRealisticProlongedGraphicOrSadistic + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AgeRatingDeclarationResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appInfos/{id}/appInfoLocalizations': + get: + tags: + - AppInfos + operationId: appInfos-appInfoLocalizations-get_to_many_related + parameters: + - name: 'filter[locale]' + in: query + description: filter by attribute 'locale' + schema: + type: array + items: + type: string + style: form + explode: false + - name: 'fields[appInfos]' + in: query + description: the fields to include for returned resources of type appInfos + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appInfoLocalizations + - appStoreAgeRating + - appStoreState + - brazilAgeRating + - kidsAgeBand + - primaryCategory + - primarySubcategoryOne + - primarySubcategoryTwo + - secondaryCategory + - secondarySubcategoryOne + - secondarySubcategoryTwo + style: form + explode: false + - name: 'fields[appInfoLocalizations]' + in: query + description: the fields to include for returned resources of type appInfoLocalizations + schema: + type: array + items: + type: string + enum: + - appInfo + - locale + - name + - privacyPolicyText + - privacyPolicyUrl + - subtitle + 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: + - appInfo + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppInfoLocalizationsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appInfos/{id}/primaryCategory': + get: + tags: + - AppInfos + operationId: appInfos-primaryCategory-get_to_one_related + parameters: + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppCategoryResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appInfos/{id}/primarySubcategoryOne': + get: + tags: + - AppInfos + operationId: appInfos-primarySubcategoryOne-get_to_one_related + parameters: + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppCategoryResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appInfos/{id}/primarySubcategoryTwo': + get: + tags: + - AppInfos + operationId: appInfos-primarySubcategoryTwo-get_to_one_related + parameters: + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppCategoryResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appInfos/{id}/secondaryCategory': + get: + tags: + - AppInfos + operationId: appInfos-secondaryCategory-get_to_one_related + parameters: + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppCategoryResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appInfos/{id}/secondarySubcategoryOne': + get: + tags: + - AppInfos + operationId: appInfos-secondarySubcategoryOne-get_to_one_related + parameters: + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppCategoryResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appInfos/{id}/secondarySubcategoryTwo': + get: + tags: + - AppInfos + operationId: appInfos-secondarySubcategoryTwo-get_to_one_related + parameters: + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppCategoryResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appPreviewSets/{id}/relationships/appPreviews': + get: + tags: + - AppPreviewSets + operationId: appPreviewSets-appPreviews-get_to_many_relationship + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewSetAppPreviewsLinkagesResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppPreviewSets + operationId: appPreviewSets-appPreviews-replace_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewSetAppPreviewsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/appPreviewSets/{id}/appPreviews': + get: + tags: + - AppPreviewSets + operationId: appPreviewSets-appPreviews-get_to_many_related + parameters: + - name: 'fields[appPreviews]' + in: query + description: the fields to include for returned resources of type appPreviews + schema: + type: array + items: + type: string + enum: + - appPreviewSet + - assetDeliveryState + - fileName + - fileSize + - mimeType + - previewFrameTimeCode + - previewImage + - sourceFileChecksum + - uploadOperations + - uploaded + - videoUrl + style: form + explode: false + - name: 'fields[appPreviewSets]' + in: query + description: the fields to include for returned resources of type appPreviewSets + schema: + type: array + items: + type: string + enum: + - appPreviews + - appStoreVersionLocalization + - previewType + 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: + - appPreviewSet + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appPricePoints/{id}/territory': + get: + tags: + - AppPricePoints + operationId: appPricePoints-territory-get_to_one_related + parameters: + - name: 'fields[territories]' + in: query + description: the fields to include for returned resources of type territories + schema: + type: array + items: + type: string + enum: + - currency + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/TerritoryResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appPriceTiers/{id}/pricePoints': + get: + tags: + - AppPriceTiers + operationId: appPriceTiers-pricePoints-get_to_many_related + parameters: + - name: 'fields[appPricePoints]' + in: query + description: the fields to include for returned resources of type appPricePoints + schema: + type: array + items: + type: string + enum: + - customerPrice + - priceTier + - proceeds + - territory + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppPricePointsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appScreenshotSets/{id}/relationships/appScreenshots': + get: + tags: + - AppScreenshotSets + operationId: appScreenshotSets-appScreenshots-get_to_many_relationship + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotSetAppScreenshotsLinkagesResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppScreenshotSets + operationId: appScreenshotSets-appScreenshots-replace_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotSetAppScreenshotsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/appScreenshotSets/{id}/appScreenshots': + get: + tags: + - AppScreenshotSets + operationId: appScreenshotSets-appScreenshots-get_to_many_related + parameters: + - name: 'fields[appScreenshotSets]' + in: query + description: the fields to include for returned resources of type appScreenshotSets + schema: + type: array + items: + type: string + enum: + - appScreenshots + - appStoreVersionLocalization + - screenshotDisplayType + style: form + explode: false + - name: 'fields[appScreenshots]' + in: query + description: the fields to include for returned resources of type appScreenshots + schema: + type: array + items: + type: string + enum: + - appScreenshotSet + - assetDeliveryState + - assetToken + - assetType + - fileName + - fileSize + - imageAsset + - sourceFileChecksum + - uploadOperations + - uploaded + 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: + - appScreenshotSet + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreReviewDetails/{id}/appStoreReviewAttachments': + get: + tags: + - AppStoreReviewDetails + operationId: appStoreReviewDetails-appStoreReviewAttachments-get_to_many_related + parameters: + - name: 'fields[appStoreReviewDetails]' + in: query + description: the fields to include for returned resources of type appStoreReviewDetails + schema: + type: array + items: + type: string + enum: + - appStoreReviewAttachments + - appStoreVersion + - contactEmail + - contactFirstName + - contactLastName + - contactPhone + - demoAccountName + - demoAccountPassword + - demoAccountRequired + - notes + style: form + explode: false + - name: 'fields[appStoreReviewAttachments]' + in: query + description: the fields to include for returned resources of type appStoreReviewAttachments + schema: + type: array + items: + type: string + enum: + - appStoreReviewDetail + - assetDeliveryState + - fileName + - fileSize + - sourceFileChecksum + - uploadOperations + - uploaded + 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: + - appStoreReviewDetail + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewAttachmentsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreVersionLocalizations/{id}/appPreviewSets': + get: + tags: + - AppStoreVersionLocalizations + operationId: appStoreVersionLocalizations-appPreviewSets-get_to_many_related + parameters: + - name: 'filter[previewType]' + in: query + description: filter by attribute 'previewType' + schema: + type: array + items: + type: string + enum: + - IPHONE_65 + - IPHONE_58 + - IPHONE_55 + - IPHONE_47 + - IPHONE_40 + - IPHONE_35 + - IPAD_PRO_3GEN_129 + - IPAD_PRO_3GEN_11 + - IPAD_PRO_129 + - IPAD_105 + - IPAD_97 + - DESKTOP + - WATCH_SERIES_4 + - WATCH_SERIES_3 + - APPLE_TV + 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: + - appPreviewSets + - appScreenshotSets + - appStoreVersion + - description + - keywords + - locale + - marketingUrl + - promotionalText + - supportUrl + - whatsNew + style: form + explode: false + - name: 'fields[appPreviews]' + in: query + description: the fields to include for returned resources of type appPreviews + schema: + type: array + items: + type: string + enum: + - appPreviewSet + - assetDeliveryState + - fileName + - fileSize + - mimeType + - previewFrameTimeCode + - previewImage + - sourceFileChecksum + - uploadOperations + - uploaded + - videoUrl + style: form + explode: false + - name: 'fields[appPreviewSets]' + in: query + description: the fields to include for returned resources of type appPreviewSets + schema: + type: array + items: + type: string + enum: + - appPreviews + - appStoreVersionLocalization + - previewType + 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: + - appPreviews + - appStoreVersionLocalization + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreviewSetsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreVersionLocalizations/{id}/appScreenshotSets': + get: + tags: + - AppStoreVersionLocalizations + operationId: appStoreVersionLocalizations-appScreenshotSets-get_to_many_related + parameters: + - name: 'filter[screenshotDisplayType]' + in: query + description: filter by attribute 'screenshotDisplayType' + schema: + type: array + items: + type: string + enum: + - APP_IPHONE_65 + - APP_IPHONE_58 + - APP_IPHONE_55 + - APP_IPHONE_47 + - APP_IPHONE_40 + - APP_IPHONE_35 + - APP_IPAD_PRO_3GEN_129 + - APP_IPAD_PRO_3GEN_11 + - APP_IPAD_PRO_129 + - APP_IPAD_105 + - APP_IPAD_97 + - APP_DESKTOP + - APP_WATCH_SERIES_4 + - APP_WATCH_SERIES_3 + - APP_APPLE_TV + - IMESSAGE_APP_IPHONE_65 + - IMESSAGE_APP_IPHONE_58 + - IMESSAGE_APP_IPHONE_55 + - IMESSAGE_APP_IPHONE_47 + - IMESSAGE_APP_IPHONE_40 + - IMESSAGE_APP_IPAD_PRO_3GEN_129 + - IMESSAGE_APP_IPAD_PRO_3GEN_11 + - IMESSAGE_APP_IPAD_PRO_129 + - IMESSAGE_APP_IPAD_105 + - IMESSAGE_APP_IPAD_97 + 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: + - appPreviewSets + - appScreenshotSets + - appStoreVersion + - description + - keywords + - locale + - marketingUrl + - promotionalText + - supportUrl + - whatsNew + style: form + explode: false + - name: 'fields[appScreenshotSets]' + in: query + description: the fields to include for returned resources of type appScreenshotSets + schema: + type: array + items: + type: string + enum: + - appScreenshots + - appStoreVersionLocalization + - screenshotDisplayType + style: form + explode: false + - name: 'fields[appScreenshots]' + in: query + description: the fields to include for returned resources of type appScreenshots + schema: + type: array + items: + type: string + enum: + - appScreenshotSet + - assetDeliveryState + - assetToken + - assetType + - fileName + - fileSize + - imageAsset + - sourceFileChecksum + - uploadOperations + - uploaded + 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: + - appScreenshots + - appStoreVersionLocalization + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppScreenshotSetsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreVersions/{id}/ageRatingDeclaration': + get: + deprecated: true + tags: + - AppStoreVersions + operationId: appStoreVersions-ageRatingDeclaration-get_to_one_related + parameters: + - name: 'fields[ageRatingDeclarations]' + in: query + deprecated: true + description: the fields to include for returned resources of type ageRatingDeclarations + schema: + type: array + items: + type: string + enum: + - alcoholTobaccoOrDrugUseOrReferences + - gamblingAndContests + - gamblingSimulated + - horrorOrFearThemes + - kidsAgeBand + - matureOrSuggestiveThemes + - medicalOrTreatmentInformation + - profanityOrCrudeHumor + - sexualContentGraphicAndNudity + - sexualContentOrNudity + - unrestrictedWebAccess + - violenceCartoonOrFantasy + - violenceRealistic + - violenceRealisticProlongedGraphicOrSadistic + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AgeRatingDeclarationResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreVersions/{id}/appStoreReviewDetail': + get: + tags: + - AppStoreVersions + operationId: appStoreVersions-appStoreReviewDetail-get_to_one_related + parameters: + - name: 'fields[appStoreReviewDetails]' + in: query + description: the fields to include for returned resources of type appStoreReviewDetails + schema: + type: array + items: + type: string + enum: + - appStoreReviewAttachments + - appStoreVersion + - contactEmail + - contactFirstName + - contactLastName + - contactPhone + - demoAccountName + - demoAccountPassword + - demoAccountRequired + - notes + style: form + explode: false + - name: 'fields[appStoreVersions]' + in: query + description: the fields to include for returned resources of type appStoreVersions + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreState + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - copyright + - createdDate + - downloadable + - earliestReleaseDate + - idfaDeclaration + - platform + - releaseType + - routingAppCoverage + - usesIdfa + - versionString + style: form + explode: false + - name: 'fields[appStoreReviewAttachments]' + in: query + description: the fields to include for returned resources of type appStoreReviewAttachments + schema: + type: array + items: + type: string + enum: + - appStoreReviewDetail + - assetDeliveryState + - fileName + - fileSize + - sourceFileChecksum + - uploadOperations + - uploaded + style: form + explode: false + - name: include + in: query + description: comma-separated list of relationships to include + schema: + type: array + items: + type: string + enum: + - appStoreReviewAttachments + - appStoreVersion + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreReviewDetailResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreVersions/{id}/appStoreVersionLocalizations': + get: + tags: + - AppStoreVersions + operationId: appStoreVersions-appStoreVersionLocalizations-get_to_many_related + parameters: + - name: 'fields[appStoreVersionLocalizations]' + in: query + description: the fields to include for returned resources of type appStoreVersionLocalizations + schema: + type: array + items: + type: string + enum: + - appPreviewSets + - appScreenshotSets + - appStoreVersion + - description + - keywords + - locale + - marketingUrl + - promotionalText + - supportUrl + - whatsNew + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionLocalizationsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreVersions/{id}/appStoreVersionPhasedRelease': + get: + tags: + - AppStoreVersions + operationId: appStoreVersions-appStoreVersionPhasedRelease-get_to_one_related + parameters: + - name: 'fields[appStoreVersionPhasedReleases]' + in: query + description: the fields to include for returned resources of type appStoreVersionPhasedReleases + schema: + type: array + items: + type: string + enum: + - appStoreVersion + - currentDayNumber + - phasedReleaseState + - startDate + - totalPauseDuration + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionPhasedReleaseResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreVersions/{id}/appStoreVersionSubmission': + get: + tags: + - AppStoreVersions + operationId: appStoreVersions-appStoreVersionSubmission-get_to_one_related + parameters: + - name: 'fields[appStoreVersions]' + in: query + description: the fields to include for returned resources of type appStoreVersions + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreState + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - copyright + - createdDate + - downloadable + - earliestReleaseDate + - idfaDeclaration + - platform + - releaseType + - routingAppCoverage + - usesIdfa + - versionString + style: form + explode: false + - name: 'fields[appStoreVersionSubmissions]' + in: query + description: the fields to include for returned resources of type appStoreVersionSubmissions + schema: + type: array + items: + type: string + enum: + - appStoreVersion + style: form + explode: false + - name: include + in: query + description: comma-separated list of relationships to include + schema: + type: array + items: + type: string + enum: + - appStoreVersion + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionSubmissionResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreVersions/{id}/relationships/build': + get: + tags: + - AppStoreVersions + operationId: appStoreVersions-build-get_to_one_relationship + parameters: [] + responses: + '200': + description: Related linkage + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionBuildLinkageResponse' + '400': + description: Parameter 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' + patch: + tags: + - AppStoreVersions + operationId: appStoreVersions-build-update_to_one_relationship + requestBody: + description: Related linkage + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionBuildLinkageRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/appStoreVersions/{id}/build': + get: + tags: + - AppStoreVersions + operationId: appStoreVersions-build-get_to_one_related + parameters: + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/BuildResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreVersions/{id}/idfaDeclaration': + get: + tags: + - AppStoreVersions + operationId: appStoreVersions-idfaDeclaration-get_to_one_related + parameters: + - name: 'fields[idfaDeclarations]' + in: query + description: the fields to include for returned resources of type idfaDeclarations + schema: + type: array + items: + type: string + enum: + - appStoreVersion + - attributesActionWithPreviousAd + - attributesAppInstallationToPreviousAd + - honorsLimitedAdTracking + - servesAds + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/IdfaDeclarationResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/appStoreVersions/{id}/routingAppCoverage': + get: + tags: + - AppStoreVersions + operationId: appStoreVersions-routingAppCoverage-get_to_one_related + parameters: + - name: 'fields[routingAppCoverages]' + in: query + description: the fields to include for returned resources of type routingAppCoverages + schema: + type: array + items: + type: string + enum: + - appStoreVersion + - assetDeliveryState + - fileName + - fileSize + - sourceFileChecksum + - uploadOperations + - uploaded + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAppCoverageResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/appInfos': + get: + tags: + - Apps + operationId: apps-appInfos-get_to_many_related + parameters: + - name: 'fields[ageRatingDeclarations]' + in: query + description: the fields to include for returned resources of type ageRatingDeclarations + schema: + type: array + items: + type: string + enum: + - alcoholTobaccoOrDrugUseOrReferences + - contests + - gambling + - gamblingAndContests + - gamblingSimulated + - horrorOrFearThemes + - kidsAgeBand + - matureOrSuggestiveThemes + - medicalOrTreatmentInformation + - profanityOrCrudeHumor + - seventeenPlus + - sexualContentGraphicAndNudity + - sexualContentOrNudity + - unrestrictedWebAccess + - violenceCartoonOrFantasy + - violenceRealistic + - violenceRealisticProlongedGraphicOrSadistic + style: form + explode: false + - name: 'fields[appInfos]' + in: query + description: the fields to include for returned resources of type appInfos + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appInfoLocalizations + - appStoreAgeRating + - appStoreState + - brazilAgeRating + - kidsAgeBand + - primaryCategory + - primarySubcategoryOne + - primarySubcategoryTwo + - secondaryCategory + - secondarySubcategoryOne + - secondarySubcategoryTwo + style: form + explode: false + - name: 'fields[appCategories]' + in: query + description: the fields to include for returned resources of type appCategories + schema: + type: array + items: + type: string + enum: + - parent + - platforms + - subcategories + style: form + explode: false + - name: 'fields[appInfoLocalizations]' + in: query + description: the fields to include for returned resources of type appInfoLocalizations + schema: + type: array + items: + type: string + enum: + - appInfo + - locale + - name + - privacyPolicyText + - privacyPolicyUrl + - subtitle + style: form + explode: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + 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: + - app + - appInfoLocalizations + - primaryCategory + - primarySubcategoryOne + - primarySubcategoryTwo + - secondaryCategory + - secondarySubcategoryOne + - secondarySubcategoryTwo + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppInfosResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/appStoreVersions': + get: + tags: + - Apps + operationId: apps-appStoreVersions-get_to_many_related + parameters: + - name: 'filter[appStoreState]' + in: query + description: filter by attribute 'appStoreState' + schema: + type: array + items: + type: string + enum: + - DEVELOPER_REMOVED_FROM_SALE + - DEVELOPER_REJECTED + - IN_REVIEW + - INVALID_BINARY + - METADATA_REJECTED + - PENDING_APPLE_RELEASE + - PENDING_CONTRACT + - PENDING_DEVELOPER_RELEASE + - PREPARE_FOR_SUBMISSION + - PREORDER_READY_FOR_SALE + - PROCESSING_FOR_APP_STORE + - READY_FOR_SALE + - REJECTED + - REMOVED_FROM_SALE + - WAITING_FOR_EXPORT_COMPLIANCE + - WAITING_FOR_REVIEW + - REPLACED_WITH_NEW_VERSION + style: form + explode: false + - name: 'filter[platform]' + in: query + description: filter by attribute 'platform' + schema: + type: array + items: + type: string + enum: + - IOS + - MAC_OS + - TV_OS + style: form + explode: false + - name: 'filter[versionString]' + in: query + description: filter by attribute 'versionString' + 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: 'fields[idfaDeclarations]' + in: query + description: the fields to include for returned resources of type idfaDeclarations + schema: + type: array + items: + type: string + enum: + - appStoreVersion + - attributesActionWithPreviousAd + - attributesAppInstallationToPreviousAd + - honorsLimitedAdTracking + - servesAds + 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: + - appPreviewSets + - appScreenshotSets + - appStoreVersion + - description + - keywords + - locale + - marketingUrl + - promotionalText + - supportUrl + - whatsNew + style: form + explode: false + - name: 'fields[routingAppCoverages]' + in: query + description: the fields to include for returned resources of type routingAppCoverages + schema: + type: array + items: + type: string + enum: + - appStoreVersion + - assetDeliveryState + - fileName + - fileSize + - sourceFileChecksum + - uploadOperations + - uploaded + style: form + explode: false + - name: 'fields[appStoreVersionPhasedReleases]' + in: query + description: the fields to include for returned resources of type appStoreVersionPhasedReleases + schema: + type: array + items: + type: string + enum: + - appStoreVersion + - currentDayNumber + - phasedReleaseState + - startDate + - totalPauseDuration + style: form + explode: false + - name: 'fields[ageRatingDeclarations]' + in: query + description: the fields to include for returned resources of type ageRatingDeclarations + schema: + type: array + items: + type: string + enum: + - alcoholTobaccoOrDrugUseOrReferences + - gamblingAndContests + - gamblingSimulated + - horrorOrFearThemes + - kidsAgeBand + - matureOrSuggestiveThemes + - medicalOrTreatmentInformation + - profanityOrCrudeHumor + - sexualContentGraphicAndNudity + - sexualContentOrNudity + - unrestrictedWebAccess + - violenceCartoonOrFantasy + - violenceRealistic + - violenceRealisticProlongedGraphicOrSadistic + style: form + explode: false + - name: 'fields[appStoreReviewDetails]' + in: query + description: the fields to include for returned resources of type appStoreReviewDetails + schema: + type: array + items: + type: string + enum: + - appStoreReviewAttachments + - appStoreVersion + - contactEmail + - contactFirstName + - contactLastName + - contactPhone + - demoAccountName + - demoAccountPassword + - demoAccountRequired + - notes + style: form + explode: false + - name: 'fields[appStoreVersions]' + in: query + description: the fields to include for returned resources of type appStoreVersions + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreState + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - copyright + - createdDate + - downloadable + - earliestReleaseDate + - idfaDeclaration + - platform + - releaseType + - routingAppCoverage + - usesIdfa + - versionString + style: form + explode: false + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + - name: 'fields[appStoreVersionSubmissions]' + in: query + description: the fields to include for returned resources of type appStoreVersionSubmissions + schema: + type: array + items: + type: string + enum: + - appStoreVersion + style: form + explode: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + 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: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - idfaDeclaration + - routingAppCoverage + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/availableTerritories': + get: + tags: + - Apps + operationId: apps-availableTerritories-get_to_many_related + parameters: + - name: 'fields[territories]' + in: query + description: the fields to include for returned resources of type territories + schema: + type: array + items: + type: string + enum: + - currency + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/TerritoriesResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/betaAppLocalizations': + get: + tags: + - Apps + operationId: apps-betaAppLocalizations-get_to_many_related + parameters: + - name: 'fields[betaAppLocalizations]' + in: query + description: the fields to include for returned resources of type betaAppLocalizations + schema: + type: array + items: + type: string + enum: + - app + - description + - feedbackEmail + - locale + - marketingUrl + - privacyPolicyUrl + - tvOsPrivacyPolicy + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppLocalizationsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/betaAppReviewDetail': + get: + tags: + - Apps + operationId: apps-betaAppReviewDetail-get_to_one_related + parameters: + - name: 'fields[betaAppReviewDetails]' + in: query + description: the fields to include for returned resources of type betaAppReviewDetails + schema: + type: array + items: + type: string + enum: + - app + - contactEmail + - contactFirstName + - contactLastName + - contactPhone + - demoAccountName + - demoAccountPassword + - demoAccountRequired + - notes + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppReviewDetailResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/betaGroups': + get: + tags: + - Apps + operationId: apps-betaGroups-get_to_many_related + parameters: + - name: 'fields[betaGroups]' + in: query + description: the fields to include for returned resources of type betaGroups + schema: + type: array + items: + type: string + enum: + - app + - betaTesters + - builds + - createdDate + - feedbackEnabled + - isInternalGroup + - name + - publicLink + - publicLinkEnabled + - publicLinkId + - publicLinkLimit + - publicLinkLimitEnabled + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/betaLicenseAgreement': + get: + tags: + - Apps + operationId: apps-betaLicenseAgreement-get_to_one_related + parameters: + - name: 'fields[betaLicenseAgreements]' + in: query + description: the fields to include for returned resources of type betaLicenseAgreements + schema: + type: array + items: + type: string + enum: + - agreementText + - app + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/BetaLicenseAgreementResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/relationships/betaTesters': + delete: + tags: + - Apps + operationId: apps-betaTesters-delete_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/AppBetaTestersLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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}/builds': + get: + tags: + - Apps + operationId: apps-builds-get_to_many_related + parameters: + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BuildsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/endUserLicenseAgreement': + get: + tags: + - Apps + operationId: apps-endUserLicenseAgreement-get_to_one_related + parameters: + - name: 'fields[endUserLicenseAgreements]' + in: query + description: the fields to include for returned resources of type endUserLicenseAgreements + schema: + type: array + items: + type: string + enum: + - agreementText + - app + - territories + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/EndUserLicenseAgreementResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/gameCenterEnabledVersions': + get: + tags: + - Apps + operationId: apps-gameCenterEnabledVersions-get_to_many_related + parameters: + - name: 'filter[platform]' + in: query + description: filter by attribute 'platform' + schema: + type: array + items: + type: string + enum: + - IOS + - MAC_OS + - TV_OS + style: form + explode: false + - name: 'filter[versionString]' + in: query + description: filter by attribute 'versionString' + 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: + - versionString + - '-versionString' + style: form + explode: false + - name: 'fields[gameCenterEnabledVersions]' + in: query + description: the fields to include for returned resources of type gameCenterEnabledVersions + schema: + type: array + items: + type: string + enum: + - app + - compatibleVersions + - iconAsset + - platform + - versionString + style: form + explode: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + 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: + - app + - compatibleVersions + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/GameCenterEnabledVersionsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/inAppPurchases': + get: + tags: + - Apps + operationId: apps-inAppPurchases-get_to_many_related + parameters: + - name: 'filter[inAppPurchaseType]' + in: query + description: filter by attribute 'inAppPurchaseType' + schema: + type: array + items: + type: string + enum: + - AUTOMATICALLY_RENEWABLE_SUBSCRIPTION + - NON_CONSUMABLE + - CONSUMABLE + - NON_RENEWING_SUBSCRIPTION + - FREE_SUBSCRIPTION + style: form + explode: false + - name: 'filter[canBeSubmitted]' + in: query + description: filter by canBeSubmitted + 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: + - inAppPurchaseType + - '-inAppPurchaseType' + - productId + - '-productId' + - referenceName + - '-referenceName' + style: form + explode: false + - name: 'fields[inAppPurchases]' + in: query + description: the fields to include for returned resources of type inAppPurchases + schema: + type: array + items: + type: string + enum: + - apps + - inAppPurchaseType + - productId + - referenceName + - state + style: form + explode: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + 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: + - apps + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/InAppPurchasesResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/perfPowerMetrics': + get: + tags: + - Apps + operationId: apps-perfPowerMetrics-get_to_many_related + parameters: + - name: 'filter[deviceType]' + in: query + description: filter by attribute 'deviceType' + schema: + type: array + items: + type: string + style: form + explode: false + - name: 'filter[metricType]' + in: query + description: filter by attribute 'metricType' + schema: + type: array + items: + type: string + enum: + - DISK + - HANG + - BATTERY + - LAUNCH + - MEMORY + - ANIMATION + - TERMINATION + style: form + explode: false + - name: 'filter[platform]' + in: query + description: filter by attribute 'platform' + schema: + type: array + items: + type: string + enum: + - IOS + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/PerfPowerMetricsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/preOrder': + get: + tags: + - Apps + operationId: apps-preOrder-get_to_one_related + parameters: + - name: 'fields[appPreOrders]' + in: query + description: the fields to include for returned resources of type appPreOrders + schema: + type: array + items: + type: string + enum: + - app + - appReleaseDate + - preOrderAvailableDate + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppPreOrderResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/preReleaseVersions': + get: + tags: + - Apps + operationId: apps-preReleaseVersions-get_to_many_related + parameters: + - name: 'fields[preReleaseVersions]' + in: query + description: the fields to include for returned resources of type preReleaseVersions + schema: + type: array + items: + type: string + enum: + - app + - builds + - platform + - version + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/PreReleaseVersionsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/apps/{id}/prices': + get: + tags: + - Apps + operationId: apps-prices-get_to_many_related + parameters: + - name: 'fields[appPrices]' + in: query + description: the fields to include for returned resources of type appPrices + schema: + type: array + items: + type: string + enum: + - app + - priceTier + style: form + explode: false + - name: 'fields[appPriceTiers]' + in: query + description: the fields to include for returned resources of type appPriceTiers + schema: + type: array + items: + type: string + enum: + - pricePoints + style: form + explode: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + 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: + - app + - priceTier + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppPricesResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaAppLocalizations/{id}/app': + get: + tags: + - BetaAppLocalizations + operationId: betaAppLocalizations-app-get_to_one_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaAppReviewDetails/{id}/app': + get: + tags: + - BetaAppReviewDetails + operationId: betaAppReviewDetails-app-get_to_one_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaAppReviewSubmissions/{id}/build': + get: + tags: + - BetaAppReviewSubmissions + operationId: betaAppReviewSubmissions-build-get_to_one_related + parameters: + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/BuildResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaBuildLocalizations/{id}/build': + get: + tags: + - BetaBuildLocalizations + operationId: betaBuildLocalizations-build-get_to_one_related + parameters: + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/BuildResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaGroups/{id}/app': + get: + tags: + - BetaGroups + operationId: betaGroups-app-get_to_one_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaGroups/{id}/relationships/betaTesters': + get: + tags: + - BetaGroups + operationId: betaGroups-betaTesters-get_to_many_relationship + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupBetaTestersLinkagesResponse' + '400': + description: Parameter 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' + post: + tags: + - BetaGroups + operationId: betaGroups-betaTesters-create_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupBetaTestersLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - BetaGroups + operationId: betaGroups-betaTesters-delete_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupBetaTestersLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/betaGroups/{id}/betaTesters': + get: + tags: + - BetaGroups + operationId: betaGroups-betaTesters-get_to_many_related + parameters: + - name: 'fields[betaTesters]' + in: query + description: the fields to include for returned resources of type betaTesters + schema: + type: array + items: + type: string + enum: + - apps + - betaGroups + - builds + - email + - firstName + - inviteType + - lastName + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTestersResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaGroups/{id}/relationships/builds': + get: + tags: + - BetaGroups + operationId: betaGroups-builds-get_to_many_relationship + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupBuildsLinkagesResponse' + '400': + description: Parameter 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' + post: + tags: + - BetaGroups + operationId: betaGroups-builds-create_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupBuildsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - BetaGroups + operationId: betaGroups-builds-delete_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupBuildsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/betaGroups/{id}/builds': + get: + tags: + - BetaGroups + operationId: betaGroups-builds-get_to_many_related + parameters: + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BuildsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaLicenseAgreements/{id}/app': + get: + tags: + - BetaLicenseAgreements + operationId: betaLicenseAgreements-app-get_to_one_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaTesters/{id}/relationships/apps': + get: + tags: + - BetaTesters + operationId: betaTesters-apps-get_to_many_relationship + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterAppsLinkagesResponse' + '400': + description: Parameter 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' + delete: + tags: + - BetaTesters + operationId: betaTesters-apps-delete_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterAppsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/betaTesters/{id}/apps': + get: + tags: + - BetaTesters + operationId: betaTesters-apps-get_to_many_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaTesters/{id}/relationships/betaGroups': + get: + tags: + - BetaTesters + operationId: betaTesters-betaGroups-get_to_many_relationship + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterBetaGroupsLinkagesResponse' + '400': + description: Parameter 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' + post: + tags: + - BetaTesters + operationId: betaTesters-betaGroups-create_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterBetaGroupsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - BetaTesters + operationId: betaTesters-betaGroups-delete_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterBetaGroupsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/betaTesters/{id}/betaGroups': + get: + tags: + - BetaTesters + operationId: betaTesters-betaGroups-get_to_many_related + parameters: + - name: 'fields[betaGroups]' + in: query + description: the fields to include for returned resources of type betaGroups + schema: + type: array + items: + type: string + enum: + - app + - betaTesters + - builds + - createdDate + - feedbackEnabled + - isInternalGroup + - name + - publicLink + - publicLinkEnabled + - publicLinkId + - publicLinkLimit + - publicLinkLimitEnabled + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BetaGroupsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/betaTesters/{id}/relationships/builds': + get: + tags: + - BetaTesters + operationId: betaTesters-builds-get_to_many_relationship + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterBuildsLinkagesResponse' + '400': + description: Parameter 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' + post: + tags: + - BetaTesters + operationId: betaTesters-builds-create_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterBuildsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - BetaTesters + operationId: betaTesters-builds-delete_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTesterBuildsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/betaTesters/{id}/builds': + get: + tags: + - BetaTesters + operationId: betaTesters-builds-get_to_many_related + parameters: + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BuildsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/buildBetaDetails/{id}/build': + get: + tags: + - BuildBetaDetails + operationId: buildBetaDetails-build-get_to_one_related + parameters: + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/BuildResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/app': + get: + tags: + - Builds + operationId: builds-app-get_to_one_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/relationships/appEncryptionDeclaration': + get: + tags: + - Builds + operationId: builds-appEncryptionDeclaration-get_to_one_relationship + parameters: [] + responses: + '200': + description: Related linkage + content: + application/json: + schema: + $ref: '#/components/schemas/BuildAppEncryptionDeclarationLinkageResponse' + '400': + description: Parameter 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' + patch: + tags: + - Builds + operationId: builds-appEncryptionDeclaration-update_to_one_relationship + requestBody: + description: Related linkage + content: + application/json: + schema: + $ref: '#/components/schemas/BuildAppEncryptionDeclarationLinkageRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/builds/{id}/appEncryptionDeclaration': + get: + tags: + - Builds + operationId: builds-appEncryptionDeclaration-get_to_one_related + parameters: + - name: 'fields[appEncryptionDeclarations]' + in: query + description: the fields to include for returned resources of type appEncryptionDeclarations + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclarationState + - availableOnFrenchStore + - builds + - codeValue + - containsProprietaryCryptography + - containsThirdPartyCryptography + - documentName + - documentType + - documentUrl + - exempt + - platform + - uploadedDate + - usesEncryption + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppEncryptionDeclarationResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/appStoreVersion': + get: + tags: + - Builds + operationId: builds-appStoreVersion-get_to_one_related + parameters: + - name: 'fields[appStoreVersions]' + in: query + description: the fields to include for returned resources of type appStoreVersions + schema: + type: array + items: + type: string + enum: + - ageRatingDeclaration + - app + - appStoreReviewDetail + - appStoreState + - appStoreVersionLocalizations + - appStoreVersionPhasedRelease + - appStoreVersionSubmission + - build + - copyright + - createdDate + - downloadable + - earliestReleaseDate + - idfaDeclaration + - platform + - releaseType + - routingAppCoverage + - usesIdfa + - versionString + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppStoreVersionResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/betaAppReviewSubmission': + get: + tags: + - Builds + operationId: builds-betaAppReviewSubmission-get_to_one_related + parameters: + - name: 'fields[betaAppReviewSubmissions]' + in: query + description: the fields to include for returned resources of type betaAppReviewSubmissions + schema: + type: array + items: + type: string + enum: + - betaReviewState + - build + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/BetaAppReviewSubmissionResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/betaBuildLocalizations': + get: + tags: + - Builds + operationId: builds-betaBuildLocalizations-get_to_many_related + parameters: + - name: 'fields[betaBuildLocalizations]' + in: query + description: the fields to include for returned resources of type betaBuildLocalizations + schema: + type: array + items: + type: string + enum: + - build + - locale + - whatsNew + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BetaBuildLocalizationsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/relationships/betaGroups': + post: + tags: + - Builds + operationId: builds-betaGroups-create_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BuildBetaGroupsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - Builds + operationId: builds-betaGroups-delete_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BuildBetaGroupsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/builds/{id}/buildBetaDetail': + get: + tags: + - Builds + operationId: builds-buildBetaDetail-get_to_one_related + parameters: + - name: 'fields[buildBetaDetails]' + in: query + description: the fields to include for returned resources of type buildBetaDetails + schema: + type: array + items: + type: string + enum: + - autoNotifyEnabled + - build + - externalBuildState + - internalBuildState + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/BuildBetaDetailResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/diagnosticSignatures': + get: + tags: + - Builds + operationId: builds-diagnosticSignatures-get_to_many_related + parameters: + - name: 'filter[diagnosticType]' + in: query + description: filter by attribute 'diagnosticType' + schema: + type: array + items: + type: string + enum: + - DISK_WRITES + style: form + explode: false + - name: 'fields[diagnosticSignatures]' + in: query + description: the fields to include for returned resources of type diagnosticSignatures + schema: + type: array + items: + type: string + enum: + - diagnosticType + - logs + - signature + - weight + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/DiagnosticSignaturesResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/icons': + get: + tags: + - Builds + operationId: builds-icons-get_to_many_related + parameters: + - name: 'fields[buildIcons]' + in: query + description: the fields to include for returned resources of type buildIcons + schema: + type: array + items: + type: string + enum: + - iconAsset + - iconType + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BuildIconsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/relationships/individualTesters': + get: + tags: + - Builds + operationId: builds-individualTesters-get_to_many_relationship + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BuildIndividualTestersLinkagesResponse' + '400': + description: Parameter 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' + post: + tags: + - Builds + operationId: builds-individualTesters-create_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BuildIndividualTestersLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - Builds + operationId: builds-individualTesters-delete_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/BuildIndividualTestersLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/builds/{id}/individualTesters': + get: + tags: + - Builds + operationId: builds-individualTesters-get_to_many_related + parameters: + - name: 'fields[betaTesters]' + in: query + description: the fields to include for returned resources of type betaTesters + schema: + type: array + items: + type: string + enum: + - apps + - betaGroups + - builds + - email + - firstName + - inviteType + - lastName + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BetaTestersResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/perfPowerMetrics': + get: + tags: + - Builds + operationId: builds-perfPowerMetrics-get_to_many_related + parameters: + - name: 'filter[deviceType]' + in: query + description: filter by attribute 'deviceType' + schema: + type: array + items: + type: string + style: form + explode: false + - name: 'filter[metricType]' + in: query + description: filter by attribute 'metricType' + schema: + type: array + items: + type: string + enum: + - DISK + - HANG + - BATTERY + - LAUNCH + - MEMORY + - ANIMATION + - TERMINATION + style: form + explode: false + - name: 'filter[platform]' + in: query + description: filter by attribute 'platform' + schema: + type: array + items: + type: string + enum: + - IOS + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/PerfPowerMetricsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/builds/{id}/preReleaseVersion': + get: + tags: + - Builds + operationId: builds-preReleaseVersion-get_to_one_related + parameters: + - name: 'fields[preReleaseVersions]' + in: query + description: the fields to include for returned resources of type preReleaseVersions + schema: + type: array + items: + type: string + enum: + - app + - builds + - platform + - version + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/PrereleaseVersionResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/bundleIds/{id}/app': + get: + tags: + - BundleIds + operationId: bundleIds-app-get_to_one_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/bundleIds/{id}/bundleIdCapabilities': + get: + tags: + - BundleIds + operationId: bundleIds-bundleIdCapabilities-get_to_many_related + parameters: + - name: 'fields[bundleIdCapabilities]' + in: query + description: the fields to include for returned resources of type bundleIdCapabilities + schema: + type: array + items: + type: string + enum: + - bundleId + - capabilityType + - settings + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdCapabilitiesResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/bundleIds/{id}/profiles': + get: + tags: + - BundleIds + operationId: bundleIds-profiles-get_to_many_related + parameters: + - name: 'fields[profiles]' + in: query + description: the fields to include for returned resources of type profiles + schema: + type: array + items: + type: string + enum: + - bundleId + - certificates + - createdDate + - devices + - expirationDate + - name + - platform + - profileContent + - profileState + - profileType + - uuid + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/ProfilesResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/diagnosticSignatures/{id}/logs': + get: + tags: + - DiagnosticSignatures + operationId: diagnosticSignatures-logs-get_to_many_related + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/DiagnosticLogsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/endUserLicenseAgreements/{id}/territories': + get: + tags: + - EndUserLicenseAgreements + operationId: endUserLicenseAgreements-territories-get_to_many_related + parameters: + - name: 'fields[territories]' + in: query + description: the fields to include for returned resources of type territories + schema: + type: array + items: + type: string + enum: + - currency + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/TerritoriesResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/gameCenterEnabledVersions/{id}/relationships/compatibleVersions': + get: + tags: + - GameCenterEnabledVersions + operationId: gameCenterEnabledVersions-compatibleVersions-get_to_many_relationship + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesResponse' + '400': + description: Parameter 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' + post: + tags: + - GameCenterEnabledVersions + operationId: gameCenterEnabledVersions-compatibleVersions-create_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + patch: + tags: + - GameCenterEnabledVersions + operationId: gameCenterEnabledVersions-compatibleVersions-replace_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - GameCenterEnabledVersions + operationId: gameCenterEnabledVersions-compatibleVersions-delete_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/gameCenterEnabledVersions/{id}/compatibleVersions': + get: + tags: + - GameCenterEnabledVersions + operationId: gameCenterEnabledVersions-compatibleVersions-get_to_many_related + parameters: + - name: 'filter[platform]' + in: query + description: filter by attribute 'platform' + schema: + type: array + items: + type: string + enum: + - IOS + - MAC_OS + - TV_OS + style: form + explode: false + - name: 'filter[versionString]' + in: query + description: filter by attribute 'versionString' + schema: + type: array + items: + type: string + style: form + explode: false + - name: 'filter[app]' + in: query + description: filter by id(s) of related 'app' + 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: + - versionString + - '-versionString' + style: form + explode: false + - name: 'fields[gameCenterEnabledVersions]' + in: query + description: the fields to include for returned resources of type gameCenterEnabledVersions + schema: + type: array + items: + type: string + enum: + - app + - compatibleVersions + - iconAsset + - platform + - versionString + style: form + explode: false + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + 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: + - app + - compatibleVersions + style: form + explode: false + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/GameCenterEnabledVersionsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/preReleaseVersions/{id}/app': + get: + tags: + - PreReleaseVersions + operationId: preReleaseVersions-app-get_to_one_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/preReleaseVersions/{id}/builds': + get: + tags: + - PreReleaseVersions + operationId: preReleaseVersions-builds-get_to_many_related + parameters: + - name: 'fields[builds]' + in: query + description: the fields to include for returned resources of type builds + schema: + type: array + items: + type: string + enum: + - app + - appEncryptionDeclaration + - appStoreVersion + - betaAppReviewSubmission + - betaBuildLocalizations + - betaGroups + - buildBetaDetail + - diagnosticSignatures + - expirationDate + - expired + - iconAssetToken + - icons + - individualTesters + - minOsVersion + - perfPowerMetrics + - preReleaseVersion + - processingState + - uploadedDate + - usesNonExemptEncryption + - version + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/BuildsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/profiles/{id}/bundleId': + get: + tags: + - Profiles + operationId: profiles-bundleId-get_to_one_related + parameters: + - name: 'fields[bundleIds]' + in: query + description: the fields to include for returned resources of type bundleIds + schema: + type: array + items: + type: string + enum: + - app + - bundleIdCapabilities + - identifier + - name + - platform + - profiles + - seedId + style: form + explode: false + responses: + '200': + description: Related resource + content: + application/json: + schema: + $ref: '#/components/schemas/BundleIdResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/profiles/{id}/certificates': + get: + tags: + - Profiles + operationId: profiles-certificates-get_to_many_related + parameters: + - name: 'fields[certificates]' + in: query + description: the fields to include for returned resources of type certificates + schema: + type: array + items: + type: string + enum: + - certificateContent + - certificateType + - csrContent + - displayName + - expirationDate + - name + - platform + - serialNumber + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/CertificatesResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/profiles/{id}/devices': + get: + tags: + - Profiles + operationId: profiles-devices-get_to_many_related + parameters: + - name: 'fields[devices]' + in: query + description: the fields to include for returned resources of type devices + schema: + type: array + items: + type: string + enum: + - addedDate + - deviceClass + - model + - name + - platform + - status + - udid + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/DevicesResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/userInvitations/{id}/visibleApps': + get: + tags: + - UserInvitations + operationId: userInvitations-visibleApps-get_to_many_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true + '/v1/users/{id}/relationships/visibleApps': + get: + tags: + - Users + operationId: users-visibleApps-get_to_many_relationship + parameters: + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/UserVisibleAppsLinkagesResponse' + '400': + description: Parameter 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' + post: + tags: + - Users + operationId: users-visibleApps-create_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/UserVisibleAppsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + patch: + tags: + - Users + operationId: users-visibleApps-replace_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/UserVisibleAppsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - Users + operationId: users-visibleApps-delete_to_many_relationship + requestBody: + description: List of related linkages + content: + application/json: + schema: + $ref: '#/components/schemas/UserVisibleAppsLinkagesRequest' + required: true + responses: + '204': + description: Success (no content) + '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' + '409': + description: Request entity error(s) + 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/users/{id}/visibleApps': + get: + tags: + - Users + operationId: users-visibleApps-get_to_many_related + parameters: + - name: 'fields[apps]' + in: query + description: the fields to include for returned resources of type apps + schema: + type: array + items: + type: string + enum: + - appInfos + - appStoreVersions + - availableInNewTerritories + - availableTerritories + - betaAppLocalizations + - betaAppReviewDetail + - betaGroups + - betaLicenseAgreement + - betaTesters + - builds + - bundleId + - contentRightsDeclaration + - endUserLicenseAgreement + - gameCenterEnabledVersions + - inAppPurchases + - isOrEverWasMadeForKids + - name + - perfPowerMetrics + - preOrder + - preReleaseVersions + - prices + - primaryLocale + - sku + style: form + explode: false + - name: limit + in: query + description: maximum resources per page + schema: + type: integer + maximum: 200 + style: form + responses: + '200': + description: List of related resources + content: + application/json: + schema: + $ref: '#/components/schemas/AppsResponse' + '400': + description: Parameter 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' + parameters: + - name: id + in: path + description: the id of the requested resource + schema: + type: string + style: simple + required: true +components: + schemas: + AgeRatingDeclaration: + type: object + title: AgeRatingDeclaration + properties: + type: + type: string + enum: + - ageRatingDeclarations + id: + type: string + attributes: + type: object + properties: + alcoholTobaccoOrDrugUseOrReferences: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + contests: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + gamblingAndContests: + deprecated: true + type: boolean + gambling: + type: boolean + gamblingSimulated: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + kidsAgeBand: + $ref: '#/components/schemas/KidsAgeBand' + medicalOrTreatmentInformation: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + profanityOrCrudeHumor: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + sexualContentGraphicAndNudity: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + sexualContentOrNudity: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + seventeenPlus: + type: boolean + horrorOrFearThemes: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + matureOrSuggestiveThemes: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + unrestrictedWebAccess: + type: boolean + violenceCartoonOrFantasy: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + violenceRealisticProlongedGraphicOrSadistic: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + violenceRealistic: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AgeRatingDeclarationResponse: + type: object + title: AgeRatingDeclarationResponse + properties: + data: + $ref: '#/components/schemas/AgeRatingDeclaration' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AgeRatingDeclarationUpdateRequest: + type: object + title: AgeRatingDeclarationUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - ageRatingDeclarations + id: + type: string + attributes: + type: object + properties: + alcoholTobaccoOrDrugUseOrReferences: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + contests: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + gamblingAndContests: + deprecated: true + type: boolean + gambling: + type: boolean + gamblingSimulated: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + kidsAgeBand: + $ref: '#/components/schemas/KidsAgeBand' + medicalOrTreatmentInformation: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + profanityOrCrudeHumor: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + sexualContentGraphicAndNudity: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + sexualContentOrNudity: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + seventeenPlus: + type: boolean + horrorOrFearThemes: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + matureOrSuggestiveThemes: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + unrestrictedWebAccess: + type: boolean + violenceCartoonOrFantasy: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + violenceRealisticProlongedGraphicOrSadistic: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + violenceRealistic: + type: string + enum: + - NONE + - INFREQUENT_OR_MILD + - FREQUENT_OR_INTENSE + required: + - id + - type + required: + - data + AppCategory: + type: object + title: AppCategory + properties: + type: + type: string + enum: + - appCategories + id: + type: string + attributes: + type: object + properties: + platforms: + type: array + items: + $ref: '#/components/schemas/Platform' + relationships: + type: object + properties: + subcategories: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + parent: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppCategoriesResponse: + type: object + title: AppCategoriesResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppCategory' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppCategoryResponse: + type: object + title: AppCategoryResponse + properties: + data: + $ref: '#/components/schemas/AppCategory' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppEncryptionDeclaration: + type: object + title: AppEncryptionDeclaration + properties: + type: + type: string + enum: + - appEncryptionDeclarations + id: + type: string + attributes: + type: object + properties: + usesEncryption: + type: boolean + exempt: + type: boolean + containsProprietaryCryptography: + type: boolean + containsThirdPartyCryptography: + type: boolean + availableOnFrenchStore: + type: boolean + platform: + $ref: '#/components/schemas/Platform' + uploadedDate: + type: string + format: date-time + documentUrl: + type: string + documentName: + type: string + documentType: + type: string + appEncryptionDeclarationState: + $ref: '#/components/schemas/AppEncryptionDeclarationState' + codeValue: + type: string + relationships: + type: object + properties: + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppEncryptionDeclarationsResponse: + type: object + title: AppEncryptionDeclarationsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppEncryptionDeclaration' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppEncryptionDeclarationResponse: + type: object + title: AppEncryptionDeclarationResponse + properties: + data: + $ref: '#/components/schemas/AppEncryptionDeclaration' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppInfoLocalization: + type: object + title: AppInfoLocalization + properties: + type: + type: string + enum: + - appInfoLocalizations + id: + type: string + attributes: + type: object + properties: + locale: + type: string + name: + type: string + subtitle: + type: string + privacyPolicyUrl: + type: string + privacyPolicyText: + type: string + relationships: + type: object + properties: + appInfo: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appInfos + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppInfoLocalizationsResponse: + type: object + title: AppInfoLocalizationsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppInfoLocalization' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppInfoLocalizationResponse: + type: object + title: AppInfoLocalizationResponse + properties: + data: + $ref: '#/components/schemas/AppInfoLocalization' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppInfoLocalizationCreateRequest: + type: object + title: AppInfoLocalizationCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appInfoLocalizations + attributes: + type: object + properties: + locale: + type: string + name: + type: string + subtitle: + type: string + privacyPolicyUrl: + type: string + privacyPolicyText: + type: string + required: + - locale + relationships: + type: object + properties: + appInfo: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appInfos + id: + type: string + required: + - id + - type + required: + - data + required: + - appInfo + required: + - relationships + - attributes + - type + required: + - data + AppInfoLocalizationUpdateRequest: + type: object + title: AppInfoLocalizationUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appInfoLocalizations + id: + type: string + attributes: + type: object + properties: + name: + type: string + subtitle: + type: string + privacyPolicyUrl: + type: string + privacyPolicyText: + type: string + required: + - id + - type + required: + - data + AppInfo: + type: object + title: AppInfo + properties: + type: + type: string + enum: + - appInfos + id: + type: string + attributes: + type: object + properties: + appStoreState: + $ref: '#/components/schemas/AppStoreVersionState' + appStoreAgeRating: + $ref: '#/components/schemas/AppStoreAgeRating' + brazilAgeRating: + $ref: '#/components/schemas/BrazilAgeRating' + kidsAgeBand: + $ref: '#/components/schemas/KidsAgeBand' + relationships: + type: object + properties: + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + ageRatingDeclaration: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - ageRatingDeclarations + id: + type: string + required: + - id + - type + appInfoLocalizations: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appInfoLocalizations + id: + type: string + required: + - id + - type + primaryCategory: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + primarySubcategoryOne: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + primarySubcategoryTwo: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + secondaryCategory: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + secondarySubcategoryOne: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + secondarySubcategoryTwo: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppInfosResponse: + type: object + title: AppInfosResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppInfo' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AppInfoLocalization' + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppInfoResponse: + type: object + title: AppInfoResponse + properties: + data: + $ref: '#/components/schemas/AppInfo' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AppInfoLocalization' + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + - $ref: '#/components/schemas/AppCategory' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppInfoUpdateRequest: + type: object + title: AppInfoUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appInfos + id: + type: string + relationships: + type: object + properties: + primaryCategory: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + primarySubcategoryOne: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + primarySubcategoryTwo: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + secondaryCategory: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + secondarySubcategoryOne: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + secondarySubcategoryTwo: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appCategories + id: + type: string + required: + - id + - type + required: + - id + - type + required: + - data + AppPreOrder: + type: object + title: AppPreOrder + properties: + type: + type: string + enum: + - appPreOrders + id: + type: string + attributes: + type: object + properties: + preOrderAvailableDate: + type: string + format: date + appReleaseDate: + type: string + format: date + relationships: + type: object + properties: + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppPreOrderResponse: + type: object + title: AppPreOrderResponse + properties: + data: + $ref: '#/components/schemas/AppPreOrder' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppPreOrderCreateRequest: + type: object + title: AppPreOrderCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appPreOrders + attributes: + type: object + properties: + appReleaseDate: + type: string + format: date + relationships: + type: object + properties: + app: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + required: + - data + required: + - app + required: + - relationships + - type + required: + - data + AppPreOrderUpdateRequest: + type: object + title: AppPreOrderUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appPreOrders + id: + type: string + attributes: + type: object + properties: + appReleaseDate: + type: string + format: date + required: + - id + - type + required: + - data + AppPreviewSet: + type: object + title: AppPreviewSet + properties: + type: + type: string + enum: + - appPreviewSets + id: + type: string + attributes: + type: object + properties: + previewType: + $ref: '#/components/schemas/PreviewType' + relationships: + type: object + properties: + appStoreVersionLocalization: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionLocalizations + id: + type: string + required: + - id + - type + appPreviews: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appPreviews + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppPreviewSetsResponse: + type: object + title: AppPreviewSetsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppPreviewSet' + included: + type: array + items: + $ref: '#/components/schemas/AppPreview' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppPreviewSetResponse: + type: object + title: AppPreviewSetResponse + properties: + data: + $ref: '#/components/schemas/AppPreviewSet' + included: + type: array + items: + $ref: '#/components/schemas/AppPreview' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppPreviewSetCreateRequest: + type: object + title: AppPreviewSetCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appPreviewSets + attributes: + type: object + properties: + previewType: + $ref: '#/components/schemas/PreviewType' + required: + - previewType + relationships: + type: object + properties: + appStoreVersionLocalization: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionLocalizations + id: + type: string + required: + - id + - type + required: + - data + required: + - appStoreVersionLocalization + required: + - relationships + - attributes + - type + required: + - data + AppPreview: + type: object + title: AppPreview + properties: + type: + type: string + enum: + - appPreviews + id: + type: string + attributes: + type: object + properties: + fileSize: + type: integer + fileName: + type: string + sourceFileChecksum: + type: string + previewFrameTimeCode: + type: string + mimeType: + type: string + videoUrl: + type: string + previewImage: + $ref: '#/components/schemas/ImageAsset' + uploadOperations: + type: array + items: + $ref: '#/components/schemas/UploadOperation' + assetDeliveryState: + $ref: '#/components/schemas/AppMediaAssetState' + relationships: + type: object + properties: + appPreviewSet: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appPreviewSets + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppPreviewsResponse: + type: object + title: AppPreviewsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppPreview' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppPreviewResponse: + type: object + title: AppPreviewResponse + properties: + data: + $ref: '#/components/schemas/AppPreview' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppPreviewCreateRequest: + type: object + title: AppPreviewCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appPreviews + attributes: + type: object + properties: + fileSize: + type: integer + fileName: + type: string + previewFrameTimeCode: + type: string + mimeType: + type: string + required: + - fileName + - fileSize + relationships: + type: object + properties: + appPreviewSet: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appPreviewSets + id: + type: string + required: + - id + - type + required: + - data + required: + - appPreviewSet + required: + - relationships + - attributes + - type + required: + - data + AppPreviewUpdateRequest: + type: object + title: AppPreviewUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appPreviews + id: + type: string + attributes: + type: object + properties: + sourceFileChecksum: + type: string + previewFrameTimeCode: + type: string + uploaded: + type: boolean + required: + - id + - type + required: + - data + AppPricePoint: + type: object + title: AppPricePoint + properties: + type: + type: string + enum: + - appPricePoints + id: + type: string + attributes: + type: object + properties: + customerPrice: + type: string + proceeds: + type: string + relationships: + type: object + properties: + priceTier: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appPriceTiers + id: + type: string + required: + - id + - type + territory: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - territories + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppPricePointsResponse: + type: object + title: AppPricePointsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppPricePoint' + included: + type: array + items: + $ref: '#/components/schemas/Territory' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppPricePointResponse: + type: object + title: AppPricePointResponse + properties: + data: + $ref: '#/components/schemas/AppPricePoint' + included: + type: array + items: + $ref: '#/components/schemas/Territory' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppPriceTier: + type: object + title: AppPriceTier + properties: + type: + type: string + enum: + - appPriceTiers + id: + type: string + relationships: + type: object + properties: + pricePoints: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appPricePoints + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppPriceTiersResponse: + type: object + title: AppPriceTiersResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppPriceTier' + included: + type: array + items: + $ref: '#/components/schemas/AppPricePoint' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppPriceTierResponse: + type: object + title: AppPriceTierResponse + properties: + data: + $ref: '#/components/schemas/AppPriceTier' + included: + type: array + items: + $ref: '#/components/schemas/AppPricePoint' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppPrice: + type: object + title: AppPrice + properties: + type: + type: string + enum: + - appPrices + id: + type: string + relationships: + type: object + properties: + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + priceTier: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appPriceTiers + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppPricesResponse: + type: object + title: AppPricesResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppPrice' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppPriceResponse: + type: object + title: AppPriceResponse + properties: + data: + $ref: '#/components/schemas/AppPrice' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppScreenshotSet: + type: object + title: AppScreenshotSet + properties: + type: + type: string + enum: + - appScreenshotSets + id: + type: string + attributes: + type: object + properties: + screenshotDisplayType: + $ref: '#/components/schemas/ScreenshotDisplayType' + relationships: + type: object + properties: + appStoreVersionLocalization: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionLocalizations + id: + type: string + required: + - id + - type + appScreenshots: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appScreenshots + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppScreenshotSetsResponse: + type: object + title: AppScreenshotSetsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppScreenshotSet' + included: + type: array + items: + $ref: '#/components/schemas/AppScreenshot' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppScreenshotSetResponse: + type: object + title: AppScreenshotSetResponse + properties: + data: + $ref: '#/components/schemas/AppScreenshotSet' + included: + type: array + items: + $ref: '#/components/schemas/AppScreenshot' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppScreenshotSetCreateRequest: + type: object + title: AppScreenshotSetCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appScreenshotSets + attributes: + type: object + properties: + screenshotDisplayType: + $ref: '#/components/schemas/ScreenshotDisplayType' + required: + - screenshotDisplayType + relationships: + type: object + properties: + appStoreVersionLocalization: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionLocalizations + id: + type: string + required: + - id + - type + required: + - data + required: + - appStoreVersionLocalization + required: + - relationships + - attributes + - type + required: + - data + AppScreenshot: + type: object + title: AppScreenshot + properties: + type: + type: string + enum: + - appScreenshots + id: + type: string + attributes: + type: object + properties: + fileSize: + type: integer + fileName: + type: string + sourceFileChecksum: + type: string + imageAsset: + $ref: '#/components/schemas/ImageAsset' + assetToken: + type: string + assetType: + type: string + uploadOperations: + type: array + items: + $ref: '#/components/schemas/UploadOperation' + assetDeliveryState: + $ref: '#/components/schemas/AppMediaAssetState' + relationships: + type: object + properties: + appScreenshotSet: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appScreenshotSets + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppScreenshotsResponse: + type: object + title: AppScreenshotsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppScreenshot' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppScreenshotResponse: + type: object + title: AppScreenshotResponse + properties: + data: + $ref: '#/components/schemas/AppScreenshot' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppScreenshotCreateRequest: + type: object + title: AppScreenshotCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appScreenshots + attributes: + type: object + properties: + fileSize: + type: integer + fileName: + type: string + required: + - fileName + - fileSize + relationships: + type: object + properties: + appScreenshotSet: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appScreenshotSets + id: + type: string + required: + - id + - type + required: + - data + required: + - appScreenshotSet + required: + - relationships + - attributes + - type + required: + - data + AppScreenshotUpdateRequest: + type: object + title: AppScreenshotUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appScreenshots + id: + type: string + attributes: + type: object + properties: + sourceFileChecksum: + type: string + uploaded: + type: boolean + required: + - id + - type + required: + - data + AppStoreReviewAttachment: + type: object + title: AppStoreReviewAttachment + properties: + type: + type: string + enum: + - appStoreReviewAttachments + id: + type: string + attributes: + type: object + properties: + fileSize: + type: integer + fileName: + type: string + sourceFileChecksum: + type: string + uploadOperations: + type: array + items: + $ref: '#/components/schemas/UploadOperation' + assetDeliveryState: + $ref: '#/components/schemas/AppMediaAssetState' + relationships: + type: object + properties: + appStoreReviewDetail: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreReviewDetails + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppStoreReviewAttachmentsResponse: + type: object + title: AppStoreReviewAttachmentsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppStoreReviewAttachment' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppStoreReviewAttachmentResponse: + type: object + title: AppStoreReviewAttachmentResponse + properties: + data: + $ref: '#/components/schemas/AppStoreReviewAttachment' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppStoreReviewAttachmentCreateRequest: + type: object + title: AppStoreReviewAttachmentCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreReviewAttachments + attributes: + type: object + properties: + fileSize: + type: integer + fileName: + type: string + required: + - fileName + - fileSize + relationships: + type: object + properties: + appStoreReviewDetail: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreReviewDetails + id: + type: string + required: + - id + - type + required: + - data + required: + - appStoreReviewDetail + required: + - relationships + - attributes + - type + required: + - data + AppStoreReviewAttachmentUpdateRequest: + type: object + title: AppStoreReviewAttachmentUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreReviewAttachments + id: + type: string + attributes: + type: object + properties: + sourceFileChecksum: + type: string + uploaded: + type: boolean + required: + - id + - type + required: + - data + AppStoreReviewDetail: + type: object + title: AppStoreReviewDetail + properties: + type: + type: string + enum: + - appStoreReviewDetails + id: + type: string + attributes: + type: object + properties: + contactFirstName: + type: string + contactLastName: + type: string + contactPhone: + type: string + contactEmail: + type: string + demoAccountName: + type: string + demoAccountPassword: + type: string + demoAccountRequired: + type: boolean + notes: + type: string + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + appStoreReviewAttachments: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appStoreReviewAttachments + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppStoreReviewDetailResponse: + type: object + title: AppStoreReviewDetailResponse + properties: + data: + $ref: '#/components/schemas/AppStoreReviewDetail' + included: + type: array + items: + $ref: '#/components/schemas/AppStoreReviewAttachment' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppStoreReviewDetailCreateRequest: + type: object + title: AppStoreReviewDetailCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreReviewDetails + attributes: + type: object + properties: + contactFirstName: + type: string + contactLastName: + type: string + contactPhone: + type: string + contactEmail: + type: string + demoAccountName: + type: string + demoAccountPassword: + type: string + demoAccountRequired: + type: boolean + notes: + type: string + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + required: + - data + required: + - appStoreVersion + required: + - relationships + - type + required: + - data + AppStoreReviewDetailUpdateRequest: + type: object + title: AppStoreReviewDetailUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreReviewDetails + id: + type: string + attributes: + type: object + properties: + contactFirstName: + type: string + contactLastName: + type: string + contactPhone: + type: string + contactEmail: + type: string + demoAccountName: + type: string + demoAccountPassword: + type: string + demoAccountRequired: + type: boolean + notes: + type: string + required: + - id + - type + required: + - data + AppStoreVersionLocalization: + type: object + title: AppStoreVersionLocalization + properties: + type: + type: string + enum: + - appStoreVersionLocalizations + id: + type: string + attributes: + type: object + properties: + description: + type: string + locale: + type: string + keywords: + type: string + marketingUrl: + type: string + format: uri + promotionalText: + type: string + supportUrl: + type: string + format: uri + whatsNew: + type: string + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + appScreenshotSets: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appScreenshotSets + id: + type: string + required: + - id + - type + appPreviewSets: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appPreviewSets + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppStoreVersionLocalizationsResponse: + type: object + title: AppStoreVersionLocalizationsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppStoreVersionLocalization' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AppScreenshotSet' + - $ref: '#/components/schemas/AppPreviewSet' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppStoreVersionLocalizationResponse: + type: object + title: AppStoreVersionLocalizationResponse + properties: + data: + $ref: '#/components/schemas/AppStoreVersionLocalization' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AppScreenshotSet' + - $ref: '#/components/schemas/AppPreviewSet' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppStoreVersionLocalizationCreateRequest: + type: object + title: AppStoreVersionLocalizationCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionLocalizations + attributes: + type: object + properties: + description: + type: string + locale: + type: string + keywords: + type: string + marketingUrl: + type: string + format: uri + promotionalText: + type: string + supportUrl: + type: string + format: uri + whatsNew: + type: string + required: + - locale + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + required: + - data + required: + - appStoreVersion + required: + - relationships + - attributes + - type + required: + - data + AppStoreVersionLocalizationUpdateRequest: + type: object + title: AppStoreVersionLocalizationUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionLocalizations + id: + type: string + attributes: + type: object + properties: + description: + type: string + keywords: + type: string + marketingUrl: + type: string + format: uri + promotionalText: + type: string + supportUrl: + type: string + format: uri + whatsNew: + type: string + required: + - id + - type + required: + - data + AppStoreVersionPhasedRelease: + type: object + title: AppStoreVersionPhasedRelease + properties: + type: + type: string + enum: + - appStoreVersionPhasedReleases + id: + type: string + attributes: + type: object + properties: + phasedReleaseState: + $ref: '#/components/schemas/PhasedReleaseState' + startDate: + type: string + format: date-time + totalPauseDuration: + type: integer + currentDayNumber: + type: integer + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppStoreVersionPhasedReleaseResponse: + type: object + title: AppStoreVersionPhasedReleaseResponse + properties: + data: + $ref: '#/components/schemas/AppStoreVersionPhasedRelease' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppStoreVersionPhasedReleaseCreateRequest: + type: object + title: AppStoreVersionPhasedReleaseCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionPhasedReleases + attributes: + type: object + properties: + phasedReleaseState: + $ref: '#/components/schemas/PhasedReleaseState' + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + required: + - data + required: + - appStoreVersion + required: + - relationships + - type + required: + - data + AppStoreVersionPhasedReleaseUpdateRequest: + type: object + title: AppStoreVersionPhasedReleaseUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionPhasedReleases + id: + type: string + attributes: + type: object + properties: + phasedReleaseState: + $ref: '#/components/schemas/PhasedReleaseState' + required: + - id + - type + required: + - data + AppStoreVersionSubmission: + type: object + title: AppStoreVersionSubmission + properties: + type: + type: string + enum: + - appStoreVersionSubmissions + id: + type: string + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppStoreVersionSubmissionResponse: + type: object + title: AppStoreVersionSubmissionResponse + properties: + data: + $ref: '#/components/schemas/AppStoreVersionSubmission' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppStoreVersionSubmissionCreateRequest: + type: object + title: AppStoreVersionSubmissionCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionSubmissions + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + required: + - data + required: + - appStoreVersion + required: + - relationships + - type + required: + - data + AppStoreVersion: + type: object + title: AppStoreVersion + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + attributes: + type: object + properties: + platform: + $ref: '#/components/schemas/Platform' + versionString: + type: string + appStoreState: + $ref: '#/components/schemas/AppStoreVersionState' + copyright: + type: string + releaseType: + type: string + enum: + - MANUAL + - AFTER_APPROVAL + - SCHEDULED + earliestReleaseDate: + type: string + format: date-time + usesIdfa: + type: boolean + downloadable: + type: boolean + createdDate: + type: string + format: date-time + relationships: + type: object + properties: + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + ageRatingDeclaration: + deprecated: true + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - ageRatingDeclarations + id: + type: string + required: + - id + - type + appStoreVersionLocalizations: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appStoreVersionLocalizations + id: + type: string + required: + - id + - type + build: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + appStoreVersionPhasedRelease: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionPhasedReleases + id: + type: string + required: + - id + - type + routingAppCoverage: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - routingAppCoverages + id: + type: string + required: + - id + - type + appStoreReviewDetail: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreReviewDetails + id: + type: string + required: + - id + - type + appStoreVersionSubmission: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersionSubmissions + id: + type: string + required: + - id + - type + idfaDeclaration: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - idfaDeclarations + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppStoreVersionsResponse: + type: object + title: AppStoreVersionsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/AppStoreVersion' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AgeRatingDeclaration' + - $ref: '#/components/schemas/AppStoreVersionLocalization' + - $ref: '#/components/schemas/Build' + - $ref: '#/components/schemas/AppStoreVersionPhasedRelease' + - $ref: '#/components/schemas/RoutingAppCoverage' + - $ref: '#/components/schemas/AppStoreReviewDetail' + - $ref: '#/components/schemas/AppStoreVersionSubmission' + - $ref: '#/components/schemas/IdfaDeclaration' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppStoreVersionResponse: + type: object + title: AppStoreVersionResponse + properties: + data: + $ref: '#/components/schemas/AppStoreVersion' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AgeRatingDeclaration' + - $ref: '#/components/schemas/AppStoreVersionLocalization' + - $ref: '#/components/schemas/Build' + - $ref: '#/components/schemas/AppStoreVersionPhasedRelease' + - $ref: '#/components/schemas/RoutingAppCoverage' + - $ref: '#/components/schemas/AppStoreReviewDetail' + - $ref: '#/components/schemas/AppStoreVersionSubmission' + - $ref: '#/components/schemas/IdfaDeclaration' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppStoreVersionCreateRequest: + type: object + title: AppStoreVersionCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + attributes: + type: object + properties: + platform: + $ref: '#/components/schemas/Platform' + versionString: + type: string + copyright: + type: string + releaseType: + type: string + enum: + - MANUAL + - AFTER_APPROVAL + - SCHEDULED + earliestReleaseDate: + type: string + format: date-time + usesIdfa: + type: boolean + required: + - versionString + - platform + relationships: + type: object + properties: + app: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + required: + - data + build: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + required: + - app + required: + - relationships + - attributes + - type + required: + - data + AppStoreVersionUpdateRequest: + type: object + title: AppStoreVersionUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + attributes: + type: object + properties: + versionString: + type: string + copyright: + type: string + releaseType: + type: string + enum: + - MANUAL + - AFTER_APPROVAL + - SCHEDULED + earliestReleaseDate: + type: string + format: date-time + usesIdfa: + type: boolean + downloadable: + type: boolean + relationships: + type: object + properties: + build: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + required: + - id + - type + required: + - data + App: + type: object + title: App + properties: + type: + type: string + enum: + - apps + id: + type: string + attributes: + type: object + properties: + name: + type: string + bundleId: + type: string + sku: + type: string + primaryLocale: + type: string + isOrEverWasMadeForKids: + type: boolean + availableInNewTerritories: + type: boolean + contentRightsDeclaration: + type: string + enum: + - DOES_NOT_USE_THIRD_PARTY_CONTENT + - USES_THIRD_PARTY_CONTENT + relationships: + type: object + properties: + betaGroups: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaGroups + id: + type: string + required: + - id + - type + appStoreVersions: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + preReleaseVersions: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - preReleaseVersions + id: + type: string + required: + - id + - type + betaAppLocalizations: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaAppLocalizations + id: + type: string + required: + - id + - type + builds: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + betaLicenseAgreement: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - betaLicenseAgreements + id: + type: string + required: + - id + - type + betaAppReviewDetail: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - betaAppReviewDetails + id: + type: string + required: + - id + - type + appInfos: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appInfos + id: + type: string + required: + - id + - type + endUserLicenseAgreement: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - endUserLicenseAgreements + id: + type: string + required: + - id + - type + preOrder: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appPreOrders + id: + type: string + required: + - id + - type + prices: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appPrices + id: + type: string + required: + - id + - type + availableTerritories: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - territories + id: + type: string + required: + - id + - type + inAppPurchases: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - inAppPurchases + id: + type: string + required: + - id + - type + gameCenterEnabledVersions: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - gameCenterEnabledVersions + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + AppsResponse: + type: object + title: AppsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/App' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/BetaGroup' + - $ref: '#/components/schemas/AppStoreVersion' + - $ref: '#/components/schemas/PrereleaseVersion' + - $ref: '#/components/schemas/BetaAppLocalization' + - $ref: '#/components/schemas/Build' + - $ref: '#/components/schemas/BetaLicenseAgreement' + - $ref: '#/components/schemas/BetaAppReviewDetail' + - $ref: '#/components/schemas/AppInfo' + - $ref: '#/components/schemas/EndUserLicenseAgreement' + - $ref: '#/components/schemas/AppPreOrder' + - $ref: '#/components/schemas/AppPrice' + - $ref: '#/components/schemas/Territory' + - $ref: '#/components/schemas/InAppPurchase' + - $ref: '#/components/schemas/GameCenterEnabledVersion' + - $ref: '#/components/schemas/PerfPowerMetric' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppResponse: + type: object + title: AppResponse + properties: + data: + $ref: '#/components/schemas/App' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/BetaGroup' + - $ref: '#/components/schemas/AppStoreVersion' + - $ref: '#/components/schemas/PrereleaseVersion' + - $ref: '#/components/schemas/BetaAppLocalization' + - $ref: '#/components/schemas/Build' + - $ref: '#/components/schemas/BetaLicenseAgreement' + - $ref: '#/components/schemas/BetaAppReviewDetail' + - $ref: '#/components/schemas/AppInfo' + - $ref: '#/components/schemas/EndUserLicenseAgreement' + - $ref: '#/components/schemas/AppPreOrder' + - $ref: '#/components/schemas/AppPrice' + - $ref: '#/components/schemas/Territory' + - $ref: '#/components/schemas/InAppPurchase' + - $ref: '#/components/schemas/GameCenterEnabledVersion' + - $ref: '#/components/schemas/PerfPowerMetric' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppUpdateRequest: + type: object + title: AppUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + attributes: + type: object + properties: + bundleId: + type: string + primaryLocale: + type: string + availableInNewTerritories: + type: boolean + contentRightsDeclaration: + type: string + enum: + - DOES_NOT_USE_THIRD_PARTY_CONTENT + - USES_THIRD_PARTY_CONTENT + relationships: + type: object + properties: + prices: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appPrices + id: + type: string + required: + - id + - type + availableTerritories: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - territories + id: + type: string + required: + - id + - type + required: + - id + - type + required: + - data + BetaAppLocalization: + type: object + title: BetaAppLocalization + properties: + type: + type: string + enum: + - betaAppLocalizations + id: + type: string + attributes: + type: object + properties: + feedbackEmail: + type: string + marketingUrl: + type: string + privacyPolicyUrl: + type: string + tvOsPrivacyPolicy: + type: string + description: + type: string + locale: + type: string + relationships: + type: object + properties: + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BetaAppLocalizationsResponse: + type: object + title: BetaAppLocalizationsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BetaAppLocalization' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaAppLocalizationResponse: + type: object + title: BetaAppLocalizationResponse + properties: + data: + $ref: '#/components/schemas/BetaAppLocalization' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BetaAppLocalizationCreateRequest: + type: object + title: BetaAppLocalizationCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaAppLocalizations + attributes: + type: object + properties: + feedbackEmail: + type: string + marketingUrl: + type: string + privacyPolicyUrl: + type: string + tvOsPrivacyPolicy: + type: string + description: + type: string + locale: + type: string + required: + - locale + relationships: + type: object + properties: + app: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + required: + - data + required: + - app + required: + - relationships + - attributes + - type + required: + - data + BetaAppLocalizationUpdateRequest: + type: object + title: BetaAppLocalizationUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaAppLocalizations + id: + type: string + attributes: + type: object + properties: + feedbackEmail: + type: string + marketingUrl: + type: string + privacyPolicyUrl: + type: string + tvOsPrivacyPolicy: + type: string + description: + type: string + required: + - id + - type + required: + - data + BetaAppReviewDetail: + type: object + title: BetaAppReviewDetail + properties: + type: + type: string + enum: + - betaAppReviewDetails + id: + type: string + attributes: + type: object + properties: + contactFirstName: + type: string + contactLastName: + type: string + contactPhone: + type: string + contactEmail: + type: string + demoAccountName: + type: string + demoAccountPassword: + type: string + demoAccountRequired: + type: boolean + notes: + type: string + relationships: + type: object + properties: + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BetaAppReviewDetailsResponse: + type: object + title: BetaAppReviewDetailsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BetaAppReviewDetail' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaAppReviewDetailResponse: + type: object + title: BetaAppReviewDetailResponse + properties: + data: + $ref: '#/components/schemas/BetaAppReviewDetail' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BetaAppReviewDetailUpdateRequest: + type: object + title: BetaAppReviewDetailUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaAppReviewDetails + id: + type: string + attributes: + type: object + properties: + contactFirstName: + type: string + contactLastName: + type: string + contactPhone: + type: string + contactEmail: + type: string + demoAccountName: + type: string + demoAccountPassword: + type: string + demoAccountRequired: + type: boolean + notes: + type: string + required: + - id + - type + required: + - data + BetaAppReviewSubmission: + type: object + title: BetaAppReviewSubmission + properties: + type: + type: string + enum: + - betaAppReviewSubmissions + id: + type: string + attributes: + type: object + properties: + betaReviewState: + $ref: '#/components/schemas/BetaReviewState' + relationships: + type: object + properties: + build: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BetaAppReviewSubmissionsResponse: + type: object + title: BetaAppReviewSubmissionsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BetaAppReviewSubmission' + included: + type: array + items: + $ref: '#/components/schemas/Build' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaAppReviewSubmissionResponse: + type: object + title: BetaAppReviewSubmissionResponse + properties: + data: + $ref: '#/components/schemas/BetaAppReviewSubmission' + included: + type: array + items: + $ref: '#/components/schemas/Build' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BetaAppReviewSubmissionCreateRequest: + type: object + title: BetaAppReviewSubmissionCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaAppReviewSubmissions + relationships: + type: object + properties: + build: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + required: + - data + required: + - build + required: + - relationships + - type + required: + - data + BetaBuildLocalization: + type: object + title: BetaBuildLocalization + properties: + type: + type: string + enum: + - betaBuildLocalizations + id: + type: string + attributes: + type: object + properties: + whatsNew: + type: string + locale: + type: string + relationships: + type: object + properties: + build: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BetaBuildLocalizationsResponse: + type: object + title: BetaBuildLocalizationsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BetaBuildLocalization' + included: + type: array + items: + $ref: '#/components/schemas/Build' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaBuildLocalizationResponse: + type: object + title: BetaBuildLocalizationResponse + properties: + data: + $ref: '#/components/schemas/BetaBuildLocalization' + included: + type: array + items: + $ref: '#/components/schemas/Build' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BetaBuildLocalizationCreateRequest: + type: object + title: BetaBuildLocalizationCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaBuildLocalizations + attributes: + type: object + properties: + whatsNew: + type: string + locale: + type: string + required: + - locale + relationships: + type: object + properties: + build: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + required: + - data + required: + - build + required: + - relationships + - attributes + - type + required: + - data + BetaBuildLocalizationUpdateRequest: + type: object + title: BetaBuildLocalizationUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaBuildLocalizations + id: + type: string + attributes: + type: object + properties: + whatsNew: + type: string + required: + - id + - type + required: + - data + BetaGroup: + type: object + title: BetaGroup + properties: + type: + type: string + enum: + - betaGroups + id: + type: string + attributes: + type: object + properties: + name: + type: string + createdDate: + type: string + format: date-time + isInternalGroup: + type: boolean + publicLinkEnabled: + type: boolean + publicLinkId: + type: string + publicLinkLimitEnabled: + type: boolean + publicLinkLimit: + type: integer + publicLink: + type: string + feedbackEnabled: + type: boolean + relationships: + type: object + properties: + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + builds: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + betaTesters: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaTesters + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BetaGroupsResponse: + type: object + title: BetaGroupsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BetaGroup' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/App' + - $ref: '#/components/schemas/Build' + - $ref: '#/components/schemas/BetaTester' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaGroupResponse: + type: object + title: BetaGroupResponse + properties: + data: + $ref: '#/components/schemas/BetaGroup' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/App' + - $ref: '#/components/schemas/Build' + - $ref: '#/components/schemas/BetaTester' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BetaGroupCreateRequest: + type: object + title: BetaGroupCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaGroups + attributes: + type: object + properties: + name: + type: string + publicLinkEnabled: + type: boolean + publicLinkLimitEnabled: + type: boolean + publicLinkLimit: + type: integer + feedbackEnabled: + type: boolean + required: + - name + relationships: + type: object + properties: + app: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + required: + - data + builds: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + betaTesters: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaTesters + id: + type: string + required: + - id + - type + required: + - app + required: + - relationships + - attributes + - type + required: + - data + BetaGroupUpdateRequest: + type: object + title: BetaGroupUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaGroups + id: + type: string + attributes: + type: object + properties: + name: + type: string + publicLinkEnabled: + type: boolean + publicLinkLimitEnabled: + type: boolean + publicLinkLimit: + type: integer + feedbackEnabled: + type: boolean + required: + - id + - type + required: + - data + BetaLicenseAgreement: + type: object + title: BetaLicenseAgreement + properties: + type: + type: string + enum: + - betaLicenseAgreements + id: + type: string + attributes: + type: object + properties: + agreementText: + type: string + relationships: + type: object + properties: + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BetaLicenseAgreementsResponse: + type: object + title: BetaLicenseAgreementsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BetaLicenseAgreement' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaLicenseAgreementResponse: + type: object + title: BetaLicenseAgreementResponse + properties: + data: + $ref: '#/components/schemas/BetaLicenseAgreement' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BetaLicenseAgreementUpdateRequest: + type: object + title: BetaLicenseAgreementUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaLicenseAgreements + id: + type: string + attributes: + type: object + properties: + agreementText: + type: string + required: + - id + - type + required: + - data + BetaTesterInvitation: + type: object + title: BetaTesterInvitation + properties: + type: + type: string + enum: + - betaTesterInvitations + id: + type: string + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BetaTesterInvitationResponse: + type: object + title: BetaTesterInvitationResponse + properties: + data: + $ref: '#/components/schemas/BetaTesterInvitation' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BetaTesterInvitationCreateRequest: + type: object + title: BetaTesterInvitationCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaTesterInvitations + relationships: + type: object + properties: + betaTester: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaTesters + id: + type: string + required: + - id + - type + required: + - data + app: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + required: + - data + required: + - app + - betaTester + required: + - relationships + - type + required: + - data + BetaTester: + type: object + title: BetaTester + properties: + type: + type: string + enum: + - betaTesters + id: + type: string + attributes: + type: object + properties: + firstName: + type: string + lastName: + type: string + email: + type: string + format: email + inviteType: + $ref: '#/components/schemas/BetaInviteType' + relationships: + type: object + properties: + apps: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + betaGroups: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaGroups + id: + type: string + required: + - id + - type + builds: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BetaTestersResponse: + type: object + title: BetaTestersResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BetaTester' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/App' + - $ref: '#/components/schemas/BetaGroup' + - $ref: '#/components/schemas/Build' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaTesterResponse: + type: object + title: BetaTesterResponse + properties: + data: + $ref: '#/components/schemas/BetaTester' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/App' + - $ref: '#/components/schemas/BetaGroup' + - $ref: '#/components/schemas/Build' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BetaTesterCreateRequest: + type: object + title: BetaTesterCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - betaTesters + attributes: + type: object + properties: + firstName: + type: string + lastName: + type: string + email: + type: string + format: email + required: + - email + relationships: + type: object + properties: + betaGroups: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaGroups + id: + type: string + required: + - id + - type + builds: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + required: + - attributes + - type + required: + - data + BuildBetaDetail: + type: object + title: BuildBetaDetail + properties: + type: + type: string + enum: + - buildBetaDetails + id: + type: string + attributes: + type: object + properties: + autoNotifyEnabled: + type: boolean + internalBuildState: + $ref: '#/components/schemas/InternalBetaState' + externalBuildState: + $ref: '#/components/schemas/ExternalBetaState' + relationships: + type: object + properties: + build: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BuildBetaDetailsResponse: + type: object + title: BuildBetaDetailsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BuildBetaDetail' + included: + type: array + items: + $ref: '#/components/schemas/Build' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BuildBetaDetailResponse: + type: object + title: BuildBetaDetailResponse + properties: + data: + $ref: '#/components/schemas/BuildBetaDetail' + included: + type: array + items: + $ref: '#/components/schemas/Build' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BuildBetaDetailUpdateRequest: + type: object + title: BuildBetaDetailUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - buildBetaDetails + id: + type: string + attributes: + type: object + properties: + autoNotifyEnabled: + type: boolean + required: + - id + - type + required: + - data + BuildBetaNotification: + type: object + title: BuildBetaNotification + properties: + type: + type: string + enum: + - buildBetaNotifications + id: + type: string + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BuildBetaNotificationResponse: + type: object + title: BuildBetaNotificationResponse + properties: + data: + $ref: '#/components/schemas/BuildBetaNotification' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BuildBetaNotificationCreateRequest: + type: object + title: BuildBetaNotificationCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - buildBetaNotifications + relationships: + type: object + properties: + build: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + required: + - data + required: + - build + required: + - relationships + - type + required: + - data + BuildIcon: + type: object + title: BuildIcon + properties: + type: + type: string + enum: + - buildIcons + id: + type: string + attributes: + type: object + properties: + iconAsset: + $ref: '#/components/schemas/ImageAsset' + iconType: + $ref: '#/components/schemas/IconAssetType' + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BuildIconsResponse: + type: object + title: BuildIconsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BuildIcon' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + Build: + type: object + title: Build + properties: + type: + type: string + enum: + - builds + id: + type: string + attributes: + type: object + properties: + version: + type: string + uploadedDate: + type: string + format: date-time + expirationDate: + type: string + format: date-time + expired: + type: boolean + minOsVersion: + type: string + iconAssetToken: + $ref: '#/components/schemas/ImageAsset' + processingState: + type: string + enum: + - PROCESSING + - FAILED + - INVALID + - VALID + usesNonExemptEncryption: + type: boolean + relationships: + type: object + properties: + preReleaseVersion: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - preReleaseVersions + id: + type: string + required: + - id + - type + individualTesters: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaTesters + id: + type: string + required: + - id + - type + betaBuildLocalizations: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaBuildLocalizations + id: + type: string + required: + - id + - type + appEncryptionDeclaration: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appEncryptionDeclarations + id: + type: string + required: + - id + - type + betaAppReviewSubmission: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - betaAppReviewSubmissions + id: + type: string + required: + - id + - type + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + buildBetaDetail: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - buildBetaDetails + id: + type: string + required: + - id + - type + appStoreVersion: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + icons: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - buildIcons + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BuildsResponse: + type: object + title: BuildsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/Build' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/PrereleaseVersion' + - $ref: '#/components/schemas/BetaTester' + - $ref: '#/components/schemas/BetaBuildLocalization' + - $ref: '#/components/schemas/AppEncryptionDeclaration' + - $ref: '#/components/schemas/BetaAppReviewSubmission' + - $ref: '#/components/schemas/App' + - $ref: '#/components/schemas/BuildBetaDetail' + - $ref: '#/components/schemas/AppStoreVersion' + - $ref: '#/components/schemas/BuildIcon' + - $ref: '#/components/schemas/PerfPowerMetric' + - $ref: '#/components/schemas/DiagnosticSignature' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BuildResponse: + type: object + title: BuildResponse + properties: + data: + $ref: '#/components/schemas/Build' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/PrereleaseVersion' + - $ref: '#/components/schemas/BetaTester' + - $ref: '#/components/schemas/BetaBuildLocalization' + - $ref: '#/components/schemas/AppEncryptionDeclaration' + - $ref: '#/components/schemas/BetaAppReviewSubmission' + - $ref: '#/components/schemas/App' + - $ref: '#/components/schemas/BuildBetaDetail' + - $ref: '#/components/schemas/AppStoreVersion' + - $ref: '#/components/schemas/BuildIcon' + - $ref: '#/components/schemas/PerfPowerMetric' + - $ref: '#/components/schemas/DiagnosticSignature' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BuildUpdateRequest: + type: object + title: BuildUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + attributes: + type: object + properties: + expired: + type: boolean + usesNonExemptEncryption: + type: boolean + relationships: + type: object + properties: + appEncryptionDeclaration: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appEncryptionDeclarations + id: + type: string + required: + - id + - type + required: + - id + - type + required: + - data + BundleIdCapability: + type: object + title: BundleIdCapability + properties: + type: + type: string + enum: + - bundleIdCapabilities + id: + type: string + attributes: + type: object + properties: + capabilityType: + $ref: '#/components/schemas/CapabilityType' + settings: + type: array + items: + $ref: '#/components/schemas/CapabilitySetting' + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BundleIdCapabilitiesResponse: + type: object + title: BundleIdCapabilitiesResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BundleIdCapability' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BundleIdCapabilityResponse: + type: object + title: BundleIdCapabilityResponse + properties: + data: + $ref: '#/components/schemas/BundleIdCapability' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BundleIdCapabilityCreateRequest: + type: object + title: BundleIdCapabilityCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - bundleIdCapabilities + attributes: + type: object + properties: + capabilityType: + $ref: '#/components/schemas/CapabilityType' + settings: + type: array + items: + $ref: '#/components/schemas/CapabilitySetting' + required: + - capabilityType + relationships: + type: object + properties: + bundleId: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - bundleIds + id: + type: string + required: + - id + - type + required: + - data + required: + - bundleId + required: + - relationships + - attributes + - type + required: + - data + BundleIdCapabilityUpdateRequest: + type: object + title: BundleIdCapabilityUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - bundleIdCapabilities + id: + type: string + attributes: + type: object + properties: + capabilityType: + $ref: '#/components/schemas/CapabilityType' + settings: + type: array + items: + $ref: '#/components/schemas/CapabilitySetting' + required: + - id + - type + required: + - data + BundleId: + type: object + title: BundleId + properties: + type: + type: string + enum: + - bundleIds + id: + type: string + attributes: + type: object + properties: + name: + type: string + platform: + $ref: '#/components/schemas/BundleIdPlatform' + identifier: + type: string + seedId: + type: string + relationships: + type: object + properties: + profiles: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - profiles + id: + type: string + required: + - id + - type + bundleIdCapabilities: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - bundleIdCapabilities + id: + type: string + required: + - id + - type + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + BundleIdsResponse: + type: object + title: BundleIdsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/BundleId' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/Profile' + - $ref: '#/components/schemas/BundleIdCapability' + - $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BundleIdResponse: + type: object + title: BundleIdResponse + properties: + data: + $ref: '#/components/schemas/BundleId' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/Profile' + - $ref: '#/components/schemas/BundleIdCapability' + - $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BundleIdCreateRequest: + type: object + title: BundleIdCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - bundleIds + attributes: + type: object + properties: + name: + type: string + platform: + $ref: '#/components/schemas/BundleIdPlatform' + identifier: + type: string + seedId: + type: string + required: + - identifier + - name + - platform + required: + - attributes + - type + required: + - data + BundleIdUpdateRequest: + type: object + title: BundleIdUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - bundleIds + id: + type: string + attributes: + type: object + properties: + name: + type: string + required: + - id + - type + required: + - data + Certificate: + type: object + title: Certificate + properties: + type: + type: string + enum: + - certificates + id: + type: string + attributes: + type: object + properties: + name: + type: string + certificateType: + $ref: '#/components/schemas/CertificateType' + displayName: + type: string + serialNumber: + type: string + platform: + $ref: '#/components/schemas/BundleIdPlatform' + expirationDate: + type: string + format: date-time + certificateContent: + type: string + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + CertificatesResponse: + type: object + title: CertificatesResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/Certificate' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + CertificateResponse: + type: object + title: CertificateResponse + properties: + data: + $ref: '#/components/schemas/Certificate' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + CertificateCreateRequest: + type: object + title: CertificateCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - certificates + attributes: + type: object + properties: + csrContent: + type: string + certificateType: + $ref: '#/components/schemas/CertificateType' + required: + - csrContent + - certificateType + required: + - attributes + - type + required: + - data + Device: + type: object + title: Device + properties: + type: + type: string + enum: + - devices + id: + type: string + attributes: + type: object + properties: + name: + type: string + platform: + $ref: '#/components/schemas/BundleIdPlatform' + udid: + type: string + deviceClass: + type: string + enum: + - APPLE_WATCH + - IPAD + - IPHONE + - IPOD + - APPLE_TV + - MAC + status: + type: string + enum: + - ENABLED + - DISABLED + model: + type: string + addedDate: + type: string + format: date-time + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + DevicesResponse: + type: object + title: DevicesResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/Device' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + DeviceResponse: + type: object + title: DeviceResponse + properties: + data: + $ref: '#/components/schemas/Device' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + DeviceCreateRequest: + type: object + title: DeviceCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - devices + attributes: + type: object + properties: + name: + type: string + platform: + $ref: '#/components/schemas/BundleIdPlatform' + udid: + type: string + required: + - name + - udid + - platform + required: + - attributes + - type + required: + - data + DeviceUpdateRequest: + type: object + title: DeviceUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - devices + id: + type: string + attributes: + type: object + properties: + name: + type: string + status: + type: string + enum: + - ENABLED + - DISABLED + required: + - id + - type + required: + - data + DiagnosticLog: + type: object + title: DiagnosticLog + properties: + type: + type: string + enum: + - diagnosticLogs + id: + type: string + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + DiagnosticLogsResponse: + type: object + title: DiagnosticLogsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/DiagnosticLog' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + DiagnosticSignature: + type: object + title: DiagnosticSignature + properties: + type: + type: string + enum: + - diagnosticSignatures + id: + type: string + attributes: + type: object + properties: + diagnosticType: + type: string + enum: + - DISK_WRITES + signature: + type: string + weight: + type: number + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + DiagnosticSignaturesResponse: + type: object + title: DiagnosticSignaturesResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/DiagnosticSignature' + included: + type: array + items: + $ref: '#/components/schemas/DiagnosticLog' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + EndUserLicenseAgreement: + type: object + title: EndUserLicenseAgreement + properties: + type: + type: string + enum: + - endUserLicenseAgreements + id: + type: string + attributes: + type: object + properties: + agreementText: + type: string + relationships: + type: object + properties: + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + territories: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - territories + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + EndUserLicenseAgreementResponse: + type: object + title: EndUserLicenseAgreementResponse + properties: + data: + $ref: '#/components/schemas/EndUserLicenseAgreement' + included: + type: array + items: + $ref: '#/components/schemas/Territory' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + EndUserLicenseAgreementCreateRequest: + type: object + title: EndUserLicenseAgreementCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - endUserLicenseAgreements + attributes: + type: object + properties: + agreementText: + type: string + required: + - agreementText + relationships: + type: object + properties: + app: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + required: + - data + territories: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - territories + id: + type: string + required: + - id + - type + required: + - data + required: + - app + - territories + required: + - relationships + - attributes + - type + required: + - data + EndUserLicenseAgreementUpdateRequest: + type: object + title: EndUserLicenseAgreementUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - endUserLicenseAgreements + id: + type: string + attributes: + type: object + properties: + agreementText: + type: string + relationships: + type: object + properties: + territories: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - territories + id: + type: string + required: + - id + - type + required: + - id + - type + required: + - data + GameCenterEnabledVersion: + type: object + title: GameCenterEnabledVersion + properties: + type: + type: string + enum: + - gameCenterEnabledVersions + id: + type: string + attributes: + type: object + properties: + platform: + $ref: '#/components/schemas/Platform' + versionString: + type: string + iconAsset: + $ref: '#/components/schemas/ImageAsset' + relationships: + type: object + properties: + compatibleVersions: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - gameCenterEnabledVersions + id: + type: string + required: + - id + - type + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + GameCenterEnabledVersionsResponse: + type: object + title: GameCenterEnabledVersionsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/GameCenterEnabledVersion' + included: + type: array + items: + $ref: '#/components/schemas/GameCenterEnabledVersion' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + IdfaDeclaration: + type: object + title: IdfaDeclaration + properties: + type: + type: string + enum: + - idfaDeclarations + id: + type: string + attributes: + type: object + properties: + servesAds: + type: boolean + attributesAppInstallationToPreviousAd: + type: boolean + attributesActionWithPreviousAd: + type: boolean + honorsLimitedAdTracking: + type: boolean + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + IdfaDeclarationResponse: + type: object + title: IdfaDeclarationResponse + properties: + data: + $ref: '#/components/schemas/IdfaDeclaration' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + IdfaDeclarationCreateRequest: + type: object + title: IdfaDeclarationCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - idfaDeclarations + attributes: + type: object + properties: + servesAds: + type: boolean + attributesAppInstallationToPreviousAd: + type: boolean + attributesActionWithPreviousAd: + type: boolean + honorsLimitedAdTracking: + type: boolean + required: + - attributesAppInstallationToPreviousAd + - servesAds + - attributesActionWithPreviousAd + - honorsLimitedAdTracking + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + required: + - data + required: + - appStoreVersion + required: + - relationships + - attributes + - type + required: + - data + IdfaDeclarationUpdateRequest: + type: object + title: IdfaDeclarationUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - idfaDeclarations + id: + type: string + attributes: + type: object + properties: + servesAds: + type: boolean + attributesAppInstallationToPreviousAd: + type: boolean + attributesActionWithPreviousAd: + type: boolean + honorsLimitedAdTracking: + type: boolean + required: + - id + - type + required: + - data + InAppPurchase: + type: object + title: InAppPurchase + properties: + type: + type: string + enum: + - inAppPurchases + id: + type: string + attributes: + type: object + properties: + referenceName: + type: string + productId: + type: string + inAppPurchaseType: + type: string + enum: + - AUTOMATICALLY_RENEWABLE_SUBSCRIPTION + - NON_CONSUMABLE + - CONSUMABLE + - NON_RENEWING_SUBSCRIPTION + - FREE_SUBSCRIPTION + state: + type: string + enum: + - CREATED + - DEVELOPER_SIGNED_OFF + - DEVELOPER_ACTION_NEEDED + - DELETION_IN_PROGRESS + - APPROVED + - DELETED + - REMOVED_FROM_SALE + - DEVELOPER_REMOVED_FROM_SALE + - WAITING_FOR_UPLOAD + - PROCESSING_CONTENT + - REPLACED + - REJECTED + - WAITING_FOR_SCREENSHOT + - PREPARE_FOR_SUBMISSION + - MISSING_METADATA + - READY_TO_SUBMIT + - WAITING_FOR_REVIEW + - IN_REVIEW + - PENDING_DEVELOPER_RELEASE + relationships: + type: object + properties: + apps: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + InAppPurchasesResponse: + type: object + title: InAppPurchasesResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/InAppPurchase' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + InAppPurchaseResponse: + type: object + title: InAppPurchaseResponse + properties: + data: + $ref: '#/components/schemas/InAppPurchase' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + PerfPowerMetric: + type: object + title: PerfPowerMetric + properties: + type: + type: string + enum: + - perfPowerMetrics + id: + type: string + attributes: + type: object + properties: + platform: + type: string + enum: + - IOS + metricType: + type: string + enum: + - DISK + - HANG + - BATTERY + - LAUNCH + - MEMORY + - ANIMATION + - TERMINATION + deviceType: + type: string + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + PerfPowerMetricsResponse: + type: object + title: PerfPowerMetricsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/PerfPowerMetric' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + PrereleaseVersion: + type: object + title: PrereleaseVersion + properties: + type: + type: string + enum: + - preReleaseVersions + id: + type: string + attributes: + type: object + properties: + version: + type: string + platform: + $ref: '#/components/schemas/Platform' + relationships: + type: object + properties: + builds: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + app: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + PreReleaseVersionsResponse: + type: object + title: PreReleaseVersionsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/PrereleaseVersion' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/Build' + - $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + PrereleaseVersionResponse: + type: object + title: PrereleaseVersionResponse + properties: + data: + $ref: '#/components/schemas/PrereleaseVersion' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/Build' + - $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + Profile: + type: object + title: Profile + properties: + type: + type: string + enum: + - profiles + id: + type: string + attributes: + type: object + properties: + name: + type: string + platform: + $ref: '#/components/schemas/BundleIdPlatform' + profileType: + type: string + enum: + - IOS_APP_DEVELOPMENT + - IOS_APP_STORE + - IOS_APP_ADHOC + - IOS_APP_INHOUSE + - MAC_APP_DEVELOPMENT + - MAC_APP_STORE + - MAC_APP_DIRECT + - TVOS_APP_DEVELOPMENT + - TVOS_APP_STORE + - TVOS_APP_ADHOC + - TVOS_APP_INHOUSE + - MAC_CATALYST_APP_DEVELOPMENT + - MAC_CATALYST_APP_STORE + - MAC_CATALYST_APP_DIRECT + profileState: + type: string + enum: + - ACTIVE + - INVALID + profileContent: + type: string + uuid: + type: string + createdDate: + type: string + format: date-time + expirationDate: + type: string + format: date-time + relationships: + type: object + properties: + bundleId: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - bundleIds + id: + type: string + required: + - id + - type + devices: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - devices + id: + type: string + required: + - id + - type + certificates: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - certificates + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + ProfilesResponse: + type: object + title: ProfilesResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/Profile' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/BundleId' + - $ref: '#/components/schemas/Device' + - $ref: '#/components/schemas/Certificate' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + ProfileResponse: + type: object + title: ProfileResponse + properties: + data: + $ref: '#/components/schemas/Profile' + included: + type: array + items: + oneOf: + - $ref: '#/components/schemas/BundleId' + - $ref: '#/components/schemas/Device' + - $ref: '#/components/schemas/Certificate' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + ProfileCreateRequest: + type: object + title: ProfileCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - profiles + attributes: + type: object + properties: + name: + type: string + profileType: + type: string + enum: + - IOS_APP_DEVELOPMENT + - IOS_APP_STORE + - IOS_APP_ADHOC + - IOS_APP_INHOUSE + - MAC_APP_DEVELOPMENT + - MAC_APP_STORE + - MAC_APP_DIRECT + - TVOS_APP_DEVELOPMENT + - TVOS_APP_STORE + - TVOS_APP_ADHOC + - TVOS_APP_INHOUSE + - MAC_CATALYST_APP_DEVELOPMENT + - MAC_CATALYST_APP_STORE + - MAC_CATALYST_APP_DIRECT + required: + - profileType + - name + relationships: + type: object + properties: + bundleId: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - bundleIds + id: + type: string + required: + - id + - type + required: + - data + devices: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - devices + id: + type: string + required: + - id + - type + certificates: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - certificates + id: + type: string + required: + - id + - type + required: + - data + required: + - certificates + - bundleId + required: + - relationships + - attributes + - type + required: + - data + RoutingAppCoverage: + type: object + title: RoutingAppCoverage + properties: + type: + type: string + enum: + - routingAppCoverages + id: + type: string + attributes: + type: object + properties: + fileSize: + type: integer + fileName: + type: string + sourceFileChecksum: + type: string + uploadOperations: + type: array + items: + $ref: '#/components/schemas/UploadOperation' + assetDeliveryState: + $ref: '#/components/schemas/AppMediaAssetState' + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + RoutingAppCoverageResponse: + type: object + title: RoutingAppCoverageResponse + properties: + data: + $ref: '#/components/schemas/RoutingAppCoverage' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + RoutingAppCoverageCreateRequest: + type: object + title: RoutingAppCoverageCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - routingAppCoverages + attributes: + type: object + properties: + fileSize: + type: integer + fileName: + type: string + required: + - fileName + - fileSize + relationships: + type: object + properties: + appStoreVersion: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appStoreVersions + id: + type: string + required: + - id + - type + required: + - data + required: + - appStoreVersion + required: + - relationships + - attributes + - type + required: + - data + RoutingAppCoverageUpdateRequest: + type: object + title: RoutingAppCoverageUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - routingAppCoverages + id: + type: string + attributes: + type: object + properties: + sourceFileChecksum: + type: string + uploaded: + type: boolean + required: + - id + - type + required: + - data + Territory: + type: object + title: Territory + properties: + type: + type: string + enum: + - territories + id: + type: string + attributes: + type: object + properties: + currency: + type: string + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + TerritoriesResponse: + type: object + title: TerritoriesResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/Territory' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + TerritoryResponse: + type: object + title: TerritoryResponse + properties: + data: + $ref: '#/components/schemas/Territory' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + UserInvitation: + type: object + title: UserInvitation + properties: + type: + type: string + enum: + - userInvitations + id: + type: string + attributes: + type: object + properties: + email: + type: string + format: email + firstName: + type: string + lastName: + type: string + expirationDate: + type: string + format: date-time + roles: + type: array + items: + $ref: '#/components/schemas/UserRole' + allAppsVisible: + type: boolean + provisioningAllowed: + type: boolean + relationships: + type: object + properties: + visibleApps: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + UserInvitationsResponse: + type: object + title: UserInvitationsResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/UserInvitation' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + UserInvitationResponse: + type: object + title: UserInvitationResponse + properties: + data: + $ref: '#/components/schemas/UserInvitation' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + UserInvitationCreateRequest: + type: object + title: UserInvitationCreateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - userInvitations + attributes: + type: object + properties: + email: + type: string + format: email + firstName: + type: string + lastName: + type: string + roles: + type: array + items: + $ref: '#/components/schemas/UserRole' + allAppsVisible: + type: boolean + provisioningAllowed: + type: boolean + required: + - firstName + - lastName + - roles + - email + relationships: + type: object + properties: + visibleApps: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + required: + - attributes + - type + required: + - data + User: + type: object + title: User + properties: + type: + type: string + enum: + - users + id: + type: string + attributes: + type: object + properties: + username: + type: string + firstName: + type: string + lastName: + type: string + roles: + type: array + items: + $ref: '#/components/schemas/UserRole' + allAppsVisible: + type: boolean + provisioningAllowed: + type: boolean + relationships: + type: object + properties: + visibleApps: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri-reference + related: + type: string + format: uri-reference + meta: + $ref: '#/components/schemas/PagingInformation' + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/ResourceLinks' + required: + - links + - id + - type + UsersResponse: + type: object + title: UsersResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/User' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + UserResponse: + type: object + title: UserResponse + properties: + data: + $ref: '#/components/schemas/User' + included: + type: array + items: + $ref: '#/components/schemas/App' + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + UserUpdateRequest: + type: object + title: UserUpdateRequest + properties: + data: + type: object + properties: + type: + type: string + enum: + - users + id: + type: string + attributes: + type: object + properties: + roles: + type: array + items: + $ref: '#/components/schemas/UserRole' + allAppsVisible: + type: boolean + provisioningAllowed: + type: boolean + relationships: + type: object + properties: + visibleApps: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + required: + - id + - type + required: + - data + AppEncryptionDeclarationBuildsLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + required: + - data + AppPreviewSetAppPreviewsLinkagesResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appPreviews + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppPreviewSetAppPreviewsLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appPreviews + id: + type: string + required: + - id + - type + required: + - data + AppScreenshotSetAppScreenshotsLinkagesResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appScreenshots + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + AppScreenshotSetAppScreenshotsLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - appScreenshots + id: + type: string + required: + - id + - type + required: + - data + AppStoreVersionBuildLinkageResponse: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + AppStoreVersionBuildLinkageRequest: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + required: + - data + AppBetaTestersLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaTesters + id: + type: string + required: + - id + - type + required: + - data + BetaGroupBetaTestersLinkagesResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaTesters + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaGroupBetaTestersLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaTesters + id: + type: string + required: + - id + - type + required: + - data + BetaGroupBuildsLinkagesResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaGroupBuildsLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + required: + - data + BetaTesterAppsLinkagesResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaTesterAppsLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + required: + - data + BetaTesterBetaGroupsLinkagesResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaGroups + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaTesterBetaGroupsLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaGroups + id: + type: string + required: + - id + - type + required: + - data + BetaTesterBuildsLinkagesResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BetaTesterBuildsLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - builds + id: + type: string + required: + - id + - type + required: + - data + BuildAppEncryptionDeclarationLinkageResponse: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appEncryptionDeclarations + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/DocumentLinks' + required: + - data + - links + BuildAppEncryptionDeclarationLinkageRequest: + type: object + properties: + data: + type: object + properties: + type: + type: string + enum: + - appEncryptionDeclarations + id: + type: string + required: + - id + - type + required: + - data + BuildBetaGroupsLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaGroups + id: + type: string + required: + - id + - type + required: + - data + BuildIndividualTestersLinkagesResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaTesters + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + BuildIndividualTestersLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - betaTesters + id: + type: string + required: + - id + - type + required: + - data + GameCenterEnabledVersionCompatibleVersionsLinkagesResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - gameCenterEnabledVersions + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + GameCenterEnabledVersionCompatibleVersionsLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - gameCenterEnabledVersions + id: + type: string + required: + - id + - type + required: + - data + UserVisibleAppsLinkagesResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + links: + $ref: '#/components/schemas/PagedDocumentLinks' + meta: + $ref: '#/components/schemas/PagingInformation' + required: + - data + - links + UserVisibleAppsLinkagesRequest: + type: object + properties: + data: + type: array + items: + type: object + properties: + type: + type: string + enum: + - apps + id: + type: string + required: + - id + - type + required: + - data + ErrorResponse: + type: object + properties: + errors: + type: array + items: + type: object + properties: + id: + type: string + status: + type: string + code: + type: string + title: + type: string + detail: + type: string + source: + oneOf: + - type: object + title: JsonPointer + properties: + pointer: + type: string + - type: object + title: Parameter + properties: + parameter: + type: string + required: + - code + - detail + - title + - status + PagedDocumentLinks: + type: object + properties: + self: + type: string + format: uri-reference + first: + type: string + format: uri-reference + next: + type: string + format: uri-reference + required: + - self + PagingInformation: + type: object + properties: + paging: + type: object + properties: + total: + type: integer + limit: + type: integer + required: + - total + - limit + required: + - paging + DocumentLinks: + type: object + properties: + self: + type: string + format: uri-reference + required: + - self + ResourceLinks: + type: object + properties: + self: + type: string + format: uri-reference + required: + - self + AppEncryptionDeclarationState: + type: string + enum: + - IN_REVIEW + - APPROVED + - REJECTED + - INVALID + - EXPIRED + AppMediaAssetState: + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/AppMediaStateError' + warnings: + type: array + items: + $ref: '#/components/schemas/AppMediaStateError' + state: + type: string + enum: + - AWAITING_UPLOAD + - UPLOAD_COMPLETE + - COMPLETE + - FAILED + AppMediaStateError: + type: object + properties: + code: + type: string + description: + type: string + AppStoreAgeRating: + type: string + enum: + - FOUR_PLUS + - NINE_PLUS + - TWELVE_PLUS + - SEVENTEEN_PLUS + AppStoreVersionState: + type: string + enum: + - DEVELOPER_REMOVED_FROM_SALE + - DEVELOPER_REJECTED + - IN_REVIEW + - INVALID_BINARY + - METADATA_REJECTED + - PENDING_APPLE_RELEASE + - PENDING_CONTRACT + - PENDING_DEVELOPER_RELEASE + - PREPARE_FOR_SUBMISSION + - PREORDER_READY_FOR_SALE + - PROCESSING_FOR_APP_STORE + - READY_FOR_SALE + - REJECTED + - REMOVED_FROM_SALE + - WAITING_FOR_EXPORT_COMPLIANCE + - WAITING_FOR_REVIEW + - REPLACED_WITH_NEW_VERSION + BetaInviteType: + type: string + enum: + - EMAIL + - PUBLIC_LINK + BetaReviewState: + type: string + enum: + - WAITING_FOR_REVIEW + - IN_REVIEW + - REJECTED + - APPROVED + BrazilAgeRating: + type: string + enum: + - L + - TEN + - TWELVE + - FOURTEEN + - SIXTEEN + - EIGHTEEN + BundleIdPlatform: + type: string + enum: + - IOS + - MAC_OS + CapabilityOption: + type: object + properties: + key: + type: string + enum: + - XCODE_5 + - XCODE_6 + - COMPLETE_PROTECTION + - PROTECTED_UNLESS_OPEN + - PROTECTED_UNTIL_FIRST_USER_AUTH + - PRIMARY_APP_CONSENT + name: + type: string + description: + type: string + enabledByDefault: + type: boolean + enabled: + type: boolean + supportsWildcard: + type: boolean + CapabilitySetting: + type: object + properties: + key: + type: string + enum: + - ICLOUD_VERSION + - DATA_PROTECTION_PERMISSION_LEVEL + - APPLE_ID_AUTH_APP_CONSENT + name: + type: string + description: + type: string + enabledByDefault: + type: boolean + visible: + type: boolean + allowedInstances: + type: string + enum: + - ENTRY + - SINGLE + - MULTIPLE + minInstances: + type: integer + options: + type: array + items: + $ref: '#/components/schemas/CapabilityOption' + CapabilityType: + type: string + enum: + - ICLOUD + - IN_APP_PURCHASE + - GAME_CENTER + - PUSH_NOTIFICATIONS + - WALLET + - INTER_APP_AUDIO + - MAPS + - ASSOCIATED_DOMAINS + - PERSONAL_VPN + - APP_GROUPS + - HEALTHKIT + - HOMEKIT + - WIRELESS_ACCESSORY_CONFIGURATION + - APPLE_PAY + - DATA_PROTECTION + - SIRIKIT + - NETWORK_EXTENSIONS + - MULTIPATH + - HOT_SPOT + - NFC_TAG_READING + - CLASSKIT + - AUTOFILL_CREDENTIAL_PROVIDER + - ACCESS_WIFI_INFORMATION + - NETWORK_CUSTOM_PROTOCOL + - COREMEDIA_HLS_LOW_LATENCY + - SYSTEM_EXTENSION_INSTALL + - USER_MANAGEMENT + - APPLE_ID_AUTH + CertificateType: + type: string + enum: + - IOS_DEVELOPMENT + - IOS_DISTRIBUTION + - MAC_APP_DISTRIBUTION + - MAC_INSTALLER_DISTRIBUTION + - MAC_APP_DEVELOPMENT + - DEVELOPER_ID_KEXT + - DEVELOPER_ID_APPLICATION + - DEVELOPMENT + - DISTRIBUTION + ExternalBetaState: + type: string + enum: + - PROCESSING + - PROCESSING_EXCEPTION + - MISSING_EXPORT_COMPLIANCE + - READY_FOR_BETA_TESTING + - IN_BETA_TESTING + - EXPIRED + - READY_FOR_BETA_SUBMISSION + - IN_EXPORT_COMPLIANCE_REVIEW + - WAITING_FOR_BETA_REVIEW + - IN_BETA_REVIEW + - BETA_REJECTED + - BETA_APPROVED + IconAssetType: + type: string + enum: + - APP_STORE + - MESSAGES_APP_STORE + - WATCH_APP_STORE + - TV_OS_HOME_SCREEN + - TV_OS_TOP_SHELF + ImageAsset: + type: object + properties: + templateUrl: + type: string + width: + type: integer + height: + type: integer + InternalBetaState: + type: string + enum: + - PROCESSING + - PROCESSING_EXCEPTION + - MISSING_EXPORT_COMPLIANCE + - READY_FOR_BETA_TESTING + - IN_BETA_TESTING + - EXPIRED + - IN_EXPORT_COMPLIANCE_REVIEW + KidsAgeBand: + type: string + enum: + - FIVE_AND_UNDER + - SIX_TO_EIGHT + - NINE_TO_ELEVEN + PhasedReleaseState: + type: string + enum: + - INACTIVE + - ACTIVE + - PAUSED + - COMPLETE + Platform: + type: string + enum: + - IOS + - MAC_OS + - TV_OS + PreviewType: + type: string + enum: + - IPHONE_65 + - IPHONE_58 + - IPHONE_55 + - IPHONE_47 + - IPHONE_40 + - IPHONE_35 + - IPAD_PRO_3GEN_129 + - IPAD_PRO_3GEN_11 + - IPAD_PRO_129 + - IPAD_105 + - IPAD_97 + - DESKTOP + - WATCH_SERIES_4 + - WATCH_SERIES_3 + - APPLE_TV + ScreenshotDisplayType: + type: string + enum: + - APP_IPHONE_65 + - APP_IPHONE_58 + - APP_IPHONE_55 + - APP_IPHONE_47 + - APP_IPHONE_40 + - APP_IPHONE_35 + - APP_IPAD_PRO_3GEN_129 + - APP_IPAD_PRO_3GEN_11 + - APP_IPAD_PRO_129 + - APP_IPAD_105 + - APP_IPAD_97 + - APP_DESKTOP + - APP_WATCH_SERIES_4 + - APP_WATCH_SERIES_3 + - APP_APPLE_TV + - IMESSAGE_APP_IPHONE_65 + - IMESSAGE_APP_IPHONE_58 + - IMESSAGE_APP_IPHONE_55 + - IMESSAGE_APP_IPHONE_47 + - IMESSAGE_APP_IPHONE_40 + - IMESSAGE_APP_IPAD_PRO_3GEN_129 + - IMESSAGE_APP_IPAD_PRO_3GEN_11 + - IMESSAGE_APP_IPAD_PRO_129 + - IMESSAGE_APP_IPAD_105 + - IMESSAGE_APP_IPAD_97 + UploadOperation: + type: object + properties: + method: + type: string + url: + type: string + length: + type: integer + offset: + type: integer + requestHeaders: + type: array + items: + $ref: '#/components/schemas/UploadOperationHeader' + UploadOperationHeader: + type: object + properties: + name: + type: string + value: + type: string + UserRole: + type: string + enum: + - ADMIN + - FINANCE + - TECHNICAL + - ACCOUNT_HOLDER + - READ_ONLY + - SALES + - MARKETING + - APP_MANAGER + - DEVELOPER + - ACCESS_TO_REPORTS + - CUSTOMER_SUPPORT + - CREATE_APPS + - CLOUD_MANAGED_DEVELOPER_ID + - CLOUD_MANAGED_APP_DISTRIBUTION + securitySchemes: + itc-bearer-token: + type: http + scheme: bearer + bearerFormat: JWT +security: + - itc-bearer-token: [] diff --git a/openapi/apple.appstore/types.bal b/openapi/apple.appstore/types.bal new file mode 100644 index 000000000..1d1ded61c --- /dev/null +++ b/openapi/apple.appstore/types.bal @@ -0,0 +1,3078 @@ +// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +public type IdfaDeclarationCreateRequest record { + IdfadeclarationcreaterequestData data; +}; + +public type AppEncryptionDeclarationBuildsLinkagesRequest record { + AppstoreversionRelationshipsBuildData[] data; +}; + +public type InapppurchaseAttributes record { + string referenceName?; + string productId?; + string inAppPurchaseType?; + string state?; +}; + +public type AppPreviewsResponse record { + AppPreview[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BuildIcon record { + string 'type; + string id; + BuildiconAttributes attributes?; + ResourceLinks links; +}; + +public type AppRelationshipsBetaappreviewdetailData record { + string 'type; + string id; +}; + +public type BundleidcreaterequestDataAttributes record { + string name; + BundleIdPlatform platform; + string identifier; + string seedId?; +}; + +public type IconAssetType string; + +public type BetaTestersResponse record { + BetaTester[] data; + App|BetaGroup|Build[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type ApppreordercreaterequestDataRelationships record { + ApppreordercreaterequestDataRelationshipsApp app; +}; + +public type BetabuildlocalizationupdaterequestData record { + string 'type; + string id; + BetabuildlocalizationupdaterequestDataAttributes attributes?; +}; + +public type BetaLicenseAgreementsResponse record { + BetaLicenseAgreement[] data; + App[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppstorereviewdetailAttributes record { + string contactFirstName?; + string contactLastName?; + string contactPhone?; + string contactEmail?; + string demoAccountName?; + string demoAccountPassword?; + boolean demoAccountRequired?; + string notes?; +}; + +public type BetaappreviewdetailupdaterequestData record { + string 'type; + string id; + AppstorereviewdetailAttributes attributes?; +}; + +public type AppEncryptionDeclaration record { + string 'type; + string id; + AppencryptiondeclarationAttributes attributes?; + AppencryptiondeclarationRelationships relationships?; + ResourceLinks links; +}; + +public type AppstoreversionRelationshipsIdfadeclaration record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppstoreversionRelationshipsIdfadeclarationData data?; +}; + +public type AppscreenshotsetAttributes record { + ScreenshotDisplayType screenshotDisplayType?; +}; + +public type ApppreorderAttributes record { + string preOrderAvailableDate?; + string appReleaseDate?; +}; + +public type ProfileRelationshipsDevicesData record { + string 'type; + string id; +}; + +public type UserInvitationCreateRequest record { + UserinvitationcreaterequestData data; +}; + +public type BetaapplocalizationAttributes record { + string feedbackEmail?; + string marketingUrl?; + string privacyPolicyUrl?; + string tvOsPrivacyPolicy?; + string description?; + string locale?; +}; + +public type AppupdaterequestDataRelationships record { + AppupdaterequestDataRelationshipsPrices prices?; + AppupdaterequestDataRelationshipsAvailableterritories availableTerritories?; +}; + +public type AppinfolocalizationAttributes record { + string locale?; + string name?; + string subtitle?; + string privacyPolicyUrl?; + string privacyPolicyText?; +}; + +public type AppinfoRelationshipsAppinfolocalizationsData record { + string 'type; + string id; +}; + +public type BuildRelationshipsBetabuildlocalizationsData record { + string 'type; + string id; +}; + +public type BetaAppReviewDetailResponse record { + BetaAppReviewDetail data; + App[] included?; + DocumentLinks links; +}; + +public type AppRelationshipsEnduserlicenseagreementData record { + string 'type; + string id; +}; + +public type AppstorereviewattachmentRelationshipsAppstorereviewdetail record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppstorereviewattachmentRelationshipsAppstorereviewdetailData data?; +}; + +public type AppScreenshotsResponse record { + AppScreenshot[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type EndUserLicenseAgreementUpdateRequest record { + EnduserlicenseagreementupdaterequestData data; +}; + +public type BuildbetadetailupdaterequestDataAttributes record { + boolean autoNotifyEnabled?; +}; + +public type AppinfolocalizationupdaterequestData record { + string 'type; + string id; + AppinfolocalizationupdaterequestDataAttributes attributes?; +}; + +public type BundleIdCreateRequest record { + BundleidcreaterequestData data; +}; + +public type BetaTesterAppsLinkagesResponse record { + AppencryptiondeclarationRelationshipsAppData[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetaAppLocalizationCreateRequest record { + BetaapplocalizationcreaterequestData data; +}; + +public type GameCenterEnabledVersionCompatibleVersionsLinkagesResponse record { + AppRelationshipsGamecenterenabledversionsData[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppstorereviewdetailRelationshipsAppstoreversionData record { + string 'type; + string id; +}; + +public type AppStoreVersionSubmissionCreateRequest record { + AppstoreversionsubmissioncreaterequestData data; +}; + +public type ExternalBetaState string; + +public type PrereleaseversionRelationships record { + AppRelationshipsBuilds builds?; + AppencryptiondeclarationRelationshipsApp app?; +}; + +public type AppRelationshipsPreorderData record { + string 'type; + string id; +}; + +public type AppscreenshotsetcreaterequestDataAttributes record { + ScreenshotDisplayType screenshotDisplayType; +}; + +public type AppInfoLocalizationCreateRequest record { + AppinfolocalizationcreaterequestData data; +}; + +public type AppstoreversionRelationshipsBuild record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppstoreversionRelationshipsBuildData data?; +}; + +public type AppstoreversionRelationshipsAppstoreversionlocalizations record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + ApppreviewsetRelationshipsAppstoreversionlocalizationData[] data?; +}; + +public type AppinfolocalizationupdaterequestDataAttributes record { + string name?; + string subtitle?; + string privacyPolicyUrl?; + string privacyPolicyText?; +}; + +public type ApppreviewRelationshipsApppreviewset record { + AppcategoryRelationshipsSubcategoriesLinks links?; + ApppreviewRelationshipsApppreviewsetData data?; +}; + +public type BetaGroupBetaTestersLinkagesRequest record { + BetagroupRelationshipsBetatestersData[] data; +}; + +public type AppScreenshotSetResponse record { + AppScreenshotSet data; + AppScreenshot[] included?; + DocumentLinks links; +}; + +public type ErrorResponse record { + ErrorresponseErrors[] errors?; +}; + +public type BetatesterRelationshipsApps record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppencryptiondeclarationRelationshipsAppData[] data?; +}; + +public type GameCenterEnabledVersionCompatibleVersionsLinkagesRequest record { + AppRelationshipsGamecenterenabledversionsData[] data; +}; + +public type AppRelationshipsPrices record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppRelationshipsPricesData[] data?; +}; + +public type BundleidRelationshipsProfiles record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + BundleidRelationshipsProfilesData[] data?; +}; + +public type AppstoreversionRelationshipsAppstoreversionphasedrelease record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppstoreversionRelationshipsAppstoreversionphasedreleaseData data?; +}; + +public type EndUserLicenseAgreement record { + string 'type; + string id; + BetalicenseagreementAttributes attributes?; + EnduserlicenseagreementRelationships relationships?; + ResourceLinks links; +}; + +public type AppRelationshipsEnduserlicenseagreement record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppRelationshipsEnduserlicenseagreementData data?; +}; + +public type BuildupdaterequestDataAttributes record { + boolean expired?; + boolean usesNonExemptEncryption?; +}; + +public type AppStoreVersionLocalizationCreateRequest record { + AppstoreversionlocalizationcreaterequestData data; +}; + +public type BundleidcapabilitycreaterequestDataAttributes record { + CapabilityType capabilityType; + CapabilitySetting[] settings?; +}; + +public type BetaTesterBuildsLinkagesRequest record { + AppstoreversionRelationshipsBuildData[] data; +}; + +public type AppstoreversionupdaterequestDataRelationships record { + AppstoreversioncreaterequestDataRelationshipsBuild build?; +}; + +public type AppscreenshotcreaterequestDataAttributes record { + int fileSize; + string fileName; +}; + +public type BuildIconsResponse record { + BuildIcon[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type ApppricetierRelationships record { + ApppricetierRelationshipsPricepoints pricePoints?; +}; + +public type AppscreenshotcreaterequestData record { + string 'type; + AppscreenshotcreaterequestDataAttributes attributes; + AppscreenshotcreaterequestDataRelationships relationships; +}; + +public type AppStoreReviewDetailResponse record { + AppStoreReviewDetail data; + AppStoreReviewAttachment[] included?; + DocumentLinks links; +}; + +public type BetaTesterResponse record { + BetaTester data; + App|BetaGroup|Build[] included?; + DocumentLinks links; +}; + +public type BetaGroupBuildsLinkagesRequest record { + AppstoreversionRelationshipsBuildData[] data; +}; + +public type AppInfoUpdateRequest record { + AppinfoupdaterequestData data; +}; + +public type AppStoreVersionLocalization record { + string 'type; + string id; + AppstoreversionlocalizationAttributes attributes?; + AppstoreversionlocalizationRelationships relationships?; + ResourceLinks links; +}; + +public type TerritoryResponse record { + Territory data; + DocumentLinks links; +}; + +public type ApppreviewcreaterequestDataRelationshipsApppreviewset record { + ApppreviewRelationshipsApppreviewsetData data; +}; + +public type BundleidcapabilitycreaterequestDataRelationshipsBundleidData record { + string 'type; + string id; +}; + +public type AppStoreAgeRating string; + +public type AppStoreVersionPhasedReleaseCreateRequest record { + AppstoreversionphasedreleasecreaterequestData data; +}; + +public type BetaBuildLocalization record { + string 'type; + string id; + BetabuildlocalizationAttributes attributes?; + BetaappreviewsubmissionRelationships relationships?; + ResourceLinks links; +}; + +public type AppPreviewUpdateRequest record { + ApppreviewupdaterequestData data; +}; + +public type UserinvitationRelationships record { + BetatesterRelationshipsApps visibleApps?; +}; + +public type ProfileResponse record { + Profile data; + BundleId|Device|Certificate[] included?; + DocumentLinks links; +}; + +public type BetaAppLocalizationsResponse record { + BetaAppLocalization[] data; + App[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type CertificateType string; + +public type AppStoreVersionLocalizationsResponse record { + AppStoreVersionLocalization[] data; + AppScreenshotSet|AppPreviewSet[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetaapplocalizationcreaterequestDataAttributes record { + string feedbackEmail?; + string marketingUrl?; + string privacyPolicyUrl?; + string tvOsPrivacyPolicy?; + string description?; + string locale; +}; + +public type UploadOperationHeader record { + string name?; + string value?; +}; + +public type AppupdaterequestDataRelationshipsAvailableterritories record { + ApppricepointRelationshipsTerritoryData[] data?; +}; + +public type UserVisibleAppsLinkagesRequest record { + AppencryptiondeclarationRelationshipsAppData[] data; +}; + +public type AppStoreReviewAttachmentUpdateRequest record { + AppstorereviewattachmentupdaterequestData data; +}; + +public type DeviceUpdateRequest record { + DeviceupdaterequestData data; +}; + +public type ApppricetierRelationshipsPricepointsData record { + string 'type; + string id; +}; + +public type AppPriceTier record { + string 'type; + string id; + ApppricetierRelationships relationships?; + ResourceLinks links; +}; + +public type AppscreenshotsetcreaterequestData record { + string 'type; + AppscreenshotsetcreaterequestDataAttributes attributes; + ApppreviewsetcreaterequestDataRelationships relationships; +}; + +public type AppstorereviewattachmentRelationships record { + AppstorereviewattachmentRelationshipsAppstorereviewdetail appStoreReviewDetail?; +}; + +public type AppinfoRelationshipsAgeratingdeclaration record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppinfoRelationshipsAgeratingdeclarationData data?; +}; + +public type UserinvitationAttributes record { + string email?; + string firstName?; + string lastName?; + string expirationDate?; + UserRole[] roles?; + boolean allAppsVisible?; + boolean provisioningAllowed?; +}; + +public type AppstorereviewattachmentcreaterequestDataRelationships record { + AppstorereviewattachmentcreaterequestDataRelationshipsAppstorereviewdetail appStoreReviewDetail; +}; + +public type AppupdaterequestDataAttributes record { + string bundleId?; + string primaryLocale?; + boolean availableInNewTerritories?; + string contentRightsDeclaration?; +}; + +public type ApppreorderupdaterequestData record { + string 'type; + string id; + ApppreordercreaterequestDataAttributes attributes?; +}; + +public type AppstorereviewdetailcreaterequestDataRelationships record { + AppstorereviewdetailcreaterequestDataRelationshipsAppstoreversion appStoreVersion; +}; + +public type AppstoreversionlocalizationupdaterequestData record { + string 'type; + string id; + AppstoreversionlocalizationupdaterequestDataAttributes attributes?; +}; + +public type BuildRelationshipsBuildbetadetail record { + AppcategoryRelationshipsSubcategoriesLinks links?; + BuildRelationshipsBuildbetadetailData data?; +}; + +public type ResourceLinks record { + string self; +}; + +public type BetatesterRelationships record { + BetatesterRelationshipsApps apps?; + AppRelationshipsBetagroups betaGroups?; + AppRelationshipsBuilds builds?; +}; + +public type DevicecreaterequestData record { + string 'type; + DevicecreaterequestDataAttributes attributes; +}; + +public type BetaBuildLocalizationResponse record { + BetaBuildLocalization data; + Build[] included?; + DocumentLinks links; +}; + +public type AppScreenshotSetAppScreenshotsLinkagesResponse record { + AppscreenshotsetRelationshipsAppscreenshotsData[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type ApppreviewcreaterequestDataAttributes record { + int fileSize; + string fileName; + string previewFrameTimeCode?; + string mimeType?; +}; + +public type AppstoreversioncreaterequestDataRelationships record { + ApppreordercreaterequestDataRelationshipsApp app; + AppstoreversioncreaterequestDataRelationshipsBuild build?; +}; + +public type AppcategoryRelationshipsSubcategories record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppcategoryRelationshipsSubcategoriesData[] data?; +}; + +public type AppscreenshotRelationshipsAppscreenshotset record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppscreenshotRelationshipsAppscreenshotsetData data?; +}; + +public type BetaLicenseAgreementUpdateRequest record { + BetalicenseagreementupdaterequestData data; +}; + +public type AppstorereviewdetailRelationshipsAppstorereviewattachmentsData record { + string 'type; + string id; +}; + +public type AppstoreversionlocalizationupdaterequestDataAttributes record { + string description?; + string keywords?; + string marketingUrl?; + string promotionalText?; + string supportUrl?; + string whatsNew?; +}; + +public type BundleidcreaterequestData record { + string 'type; + BundleidcreaterequestDataAttributes attributes; +}; + +public type UserRole string; + +public type GamecenterenabledversionAttributes record { + Platform platform?; + string versionString?; + ImageAsset iconAsset?; +}; + +public type ProfilecreaterequestDataRelationshipsCertificates record { + ProfileRelationshipsCertificatesData[] data; +}; + +public type AppinfoRelationshipsAgeratingdeclarationData record { + string 'type; + string id; +}; + +public type BetagroupRelationshipsBetatestersData record { + string 'type; + string id; +}; + +public type BetaTesterInvitationCreateRequest record { + BetatesterinvitationcreaterequestData data; +}; + +public type BuildIndividualTestersLinkagesResponse record { + BetagroupRelationshipsBetatestersData[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppRelationshipsInapppurchasesData record { + string 'type; + string id; +}; + +public type BuildiconAttributes record { + ImageAsset iconAsset?; + IconAssetType iconType?; +}; + +public type BuildbetanotificationcreaterequestData record { + string 'type; + BetaappreviewsubmissioncreaterequestDataRelationships relationships; +}; + +public type AppinfoupdaterequestData record { + string 'type; + string id; + AppinfoupdaterequestDataRelationships relationships?; +}; + +public type AppRelationshipsPrereleaseversionsData record { + string 'type; + string id; +}; + +public type BetabuildlocalizationcreaterequestData record { + string 'type; + BetabuildlocalizationcreaterequestDataAttributes attributes; + BetaappreviewsubmissioncreaterequestDataRelationships relationships; +}; + +public type AppCategory record { + string 'type; + string id; + AppcategoryAttributes attributes?; + AppcategoryRelationships relationships?; + ResourceLinks links; +}; + +public type AppStoreReviewDetailCreateRequest record { + AppstorereviewdetailcreaterequestData data; +}; + +public type BetaTesterBuildsLinkagesResponse record { + AppstoreversionRelationshipsBuildData[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppstoreversionRelationshipsAppstoreversionphasedreleaseData record { + string 'type; + string id; +}; + +public type AppPricesResponse record { + AppPrice[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type DiagnosticSignature record { + string 'type; + string id; + DiagnosticsignatureAttributes attributes?; + ResourceLinks links; +}; + +public type AppStoreVersionState string; + +public type AppinfolocalizationRelationshipsAppinfo record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppinfolocalizationRelationshipsAppinfoData data?; +}; + +public type PaginginformationPaging record { + int total; + int 'limit; +}; + +public type AppPreviewSetsResponse record { + AppPreviewSet[] data; + AppPreview[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppupdaterequestData record { + string 'type; + string id; + AppupdaterequestDataAttributes attributes?; + AppupdaterequestDataRelationships relationships?; +}; + +public type AppInfoLocalizationResponse record { + AppInfoLocalization data; + DocumentLinks links; +}; + +public type AppStoreReviewAttachmentCreateRequest record { + AppstorereviewattachmentcreaterequestData data; +}; + +public type AppBetaTestersLinkagesRequest record { + BetagroupRelationshipsBetatestersData[] data; +}; + +public type AppPreOrderUpdateRequest record { + ApppreorderupdaterequestData data; +}; + +public type AppStoreVersionPhasedReleaseUpdateRequest record { + AppstoreversionphasedreleaseupdaterequestData data; +}; + +public type AppPreviewSet record { + string 'type; + string id; + ApppreviewsetAttributes attributes?; + ApppreviewsetRelationships relationships?; + ResourceLinks links; +}; + +public type BetaGroup record { + string 'type; + string id; + BetagroupAttributes attributes?; + BetagroupRelationships relationships?; + ResourceLinks links; +}; + +public type AppscreenshotcreaterequestDataRelationshipsAppscreenshotset record { + AppscreenshotRelationshipsAppscreenshotsetData data; +}; + +public type BundleIdPlatform string; + +public type UserVisibleAppsLinkagesResponse record { + AppencryptiondeclarationRelationshipsAppData[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BuildRelationshipsAppencryptiondeclaration record { + AppcategoryRelationshipsSubcategoriesLinks links?; + BuildRelationshipsAppencryptiondeclarationData data?; +}; + +public type ApppreviewcreaterequestDataRelationships record { + ApppreviewcreaterequestDataRelationshipsApppreviewset appPreviewSet; +}; + +public type AppStoreVersionBuildLinkageResponse record { + AppstoreversionRelationshipsBuildData data; + DocumentLinks links; +}; + +public type AppstorereviewdetailRelationshipsAppstorereviewattachments record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppstorereviewdetailRelationshipsAppstorereviewattachmentsData[] data?; +}; + +public type AppScreenshot record { + string 'type; + string id; + AppscreenshotAttributes attributes?; + AppscreenshotRelationships relationships?; + ResourceLinks links; +}; + +public type Profile record { + string 'type; + string id; + ProfileAttributes attributes?; + ProfileRelationships relationships?; + ResourceLinks links; +}; + +public type BuildBetaGroupsLinkagesRequest record { + AppRelationshipsBetagroupsData[] data; +}; + +public type AppInfoLocalization record { + string 'type; + string id; + AppinfolocalizationAttributes attributes?; + AppinfolocalizationRelationships relationships?; + ResourceLinks links; +}; + +public type AppstoreversionRelationships record { + AppencryptiondeclarationRelationshipsApp app?; + AppinfoRelationshipsAgeratingdeclaration ageRatingDeclaration?; + AppstoreversionRelationshipsAppstoreversionlocalizations appStoreVersionLocalizations?; + AppstoreversionRelationshipsBuild build?; + AppstoreversionRelationshipsAppstoreversionphasedrelease appStoreVersionPhasedRelease?; + AppstoreversionRelationshipsRoutingappcoverage routingAppCoverage?; + AppstorereviewattachmentRelationshipsAppstorereviewdetail appStoreReviewDetail?; + AppstoreversionRelationshipsAppstoreversionsubmission appStoreVersionSubmission?; + AppstoreversionRelationshipsIdfadeclaration idfaDeclaration?; +}; + +public type AppEncryptionDeclarationResponse record { + AppEncryptionDeclaration data; + App[] included?; + DocumentLinks links; +}; + +public type BetaGroupUpdateRequest record { + BetagroupupdaterequestData data; +}; + +public type InternalBetaState string; + +public type ApppreviewsetRelationshipsApppreviewsData record { + string 'type; + string id; +}; + +public type IdfadeclarationcreaterequestDataAttributes record { + boolean servesAds; + boolean attributesAppInstallationToPreviousAd; + boolean attributesActionWithPreviousAd; + boolean honorsLimitedAdTracking; +}; + +public type AppscreenshotcreaterequestDataRelationships record { + AppscreenshotcreaterequestDataRelationshipsAppscreenshotset appScreenshotSet; +}; + +public type BetaAppLocalizationResponse record { + BetaAppLocalization data; + App[] included?; + DocumentLinks links; +}; + +public type DeviceAttributes record { + string name?; + BundleIdPlatform platform?; + string udid?; + string deviceClass?; + string status?; + string model?; + string addedDate?; +}; + +public type AppstoreversionsubmissionRelationships record { + AppstorereviewdetailRelationshipsAppstoreversion appStoreVersion?; +}; + +public type ImageAsset record { + string templateUrl?; + int width?; + int height?; +}; + +public type EnduserlicenseagreementcreaterequestDataRelationships record { + ApppreordercreaterequestDataRelationshipsApp app; + EnduserlicenseagreementcreaterequestDataRelationshipsTerritories territories; +}; + +public type BundleidcapabilityAttributes record { + CapabilityType capabilityType?; + CapabilitySetting[] settings?; +}; + +public type UserinvitationcreaterequestDataAttributes record { + string email; + string firstName; + string lastName; + UserRole[] roles; + boolean allAppsVisible?; + boolean provisioningAllowed?; +}; + +public type BetaAppReviewDetailsResponse record { + BetaAppReviewDetail[] data; + App[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppinfolocalizationcreaterequestData record { + string 'type; + AppinfolocalizationcreaterequestDataAttributes attributes; + AppinfolocalizationcreaterequestDataRelationships relationships; +}; + +public type ScreenshotDisplayType string; + +public type AppcategoryAttributes record { + Platform[] platforms?; +}; + +public type KidsAgeBand string; + +public type AppRelationshipsBetalicenseagreementData record { + string 'type; + string id; +}; + +public type PreviewType string; + +public type BetalicenseagreementAttributes record { + string agreementText?; +}; + +public type BetalicenseagreementupdaterequestData record { + string 'type; + string id; + BetalicenseagreementAttributes attributes?; +}; + +public type BundleIdResponse record { + BundleId data; + Profile|BundleIdCapability|App[] included?; + DocumentLinks links; +}; + +public type AppPricePoint record { + string 'type; + string id; + ApppricepointAttributes attributes?; + ApppricepointRelationships relationships?; + ResourceLinks links; +}; + +public type BundleidRelationshipsBundleidcapabilities record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + BundleidRelationshipsBundleidcapabilitiesData[] data?; +}; + +public type PrereleaseversionAttributes record { + string 'version?; + Platform platform?; +}; + +public type ProfilecreaterequestData record { + string 'type; + ProfilecreaterequestDataAttributes attributes; + ProfilecreaterequestDataRelationships relationships; +}; + +public type ApppreviewsetcreaterequestDataRelationships record { + ApppreviewsetcreaterequestDataRelationshipsAppstoreversionlocalization appStoreVersionLocalization; +}; + +public type BetatesterAttributes record { + string firstName?; + string lastName?; + string email?; + BetaInviteType inviteType?; +}; + +public type AgeratingdeclarationupdaterequestData record { + string 'type; + string id; + AgeratingdeclarationAttributes attributes?; +}; + +public type BetaappreviewsubmissioncreaterequestDataRelationships record { + BetaappreviewsubmissioncreaterequestDataRelationshipsBuild build; +}; + +public type BundleidRelationshipsBundleidcapabilitiesData record { + string 'type; + string id; +}; + +public type AppscreenshotRelationships record { + AppscreenshotRelationshipsAppscreenshotset appScreenshotSet?; +}; + +public type CapabilitySetting record { + string 'key?; + string name?; + string description?; + boolean enabledByDefault?; + boolean visible?; + string allowedInstances?; + int minInstances?; + CapabilityOption[] options?; +}; + +public type ApppricepointRelationshipsPricetierData record { + string 'type; + string id; +}; + +public type DeviceResponse record { + Device data; + DocumentLinks links; +}; + +public type Build record { + string 'type; + string id; + BuildAttributes attributes?; + BuildRelationships relationships?; + ResourceLinks links; +}; + +public type UserInvitation record { + string 'type; + string id; + UserinvitationAttributes attributes?; + UserinvitationRelationships relationships?; + ResourceLinks links; +}; + +public type ApppreviewsetcreaterequestDataRelationshipsAppstoreversionlocalization record { + ApppreviewsetRelationshipsAppstoreversionlocalizationData data; +}; + +public type DeviceupdaterequestDataAttributes record { + string name?; + string status?; +}; + +public type AppScreenshotSet record { + string 'type; + string id; + AppscreenshotsetAttributes attributes?; + AppscreenshotsetRelationships relationships?; + ResourceLinks links; +}; + +public type AppStoreReviewDetailUpdateRequest record { + AppstorereviewdetailupdaterequestData data; +}; + +public type AppencryptiondeclarationRelationshipsApp record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppencryptiondeclarationRelationshipsAppData data?; +}; + +public type RoutingAppCoverage record { + string 'type; + string id; + AppstorereviewattachmentAttributes attributes?; + AppstoreversionsubmissionRelationships relationships?; + ResourceLinks links; +}; + +public type BetabuildlocalizationcreaterequestDataAttributes record { + string whatsNew?; + string locale; +}; + +public type BuildResponse record { + Build data; + PrereleaseVersion|BetaTester|BetaBuildLocalization|AppEncryptionDeclaration|BetaAppReviewSubmission|App|BuildBetaDetail|AppStoreVersion|BuildIcon|PerfPowerMetric|DiagnosticSignature[] included?; + DocumentLinks links; +}; + +public type AppstoreversionphasedreleaseupdaterequestData record { + string 'type; + string id; + AppstoreversionphasedreleasecreaterequestDataAttributes attributes?; +}; + +public type PrereleaseVersionResponse record { + PrereleaseVersion data; + Build|App[] included?; + DocumentLinks links; +}; + +public type AppCategoryResponse record { + AppCategory data; + AppCategory|AppCategory[] included?; + DocumentLinks links; +}; + +public type InapppurchaseRelationships record { + BetatesterRelationshipsApps apps?; +}; + +public type BundleIdCapability record { + string 'type; + string id; + BundleidcapabilityAttributes attributes?; + ResourceLinks links; +}; + +public type ApppreviewsetcreaterequestDataAttributes record { + PreviewType previewType; +}; + +public type InAppPurchasesResponse record { + InAppPurchase[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppInfo record { + string 'type; + string id; + AppinfoAttributes attributes?; + AppinfoRelationships relationships?; + ResourceLinks links; +}; + +public type AppupdaterequestDataRelationshipsPrices record { + AppRelationshipsPricesData[] data?; +}; + +public type BetaBuildLocalizationCreateRequest record { + BetabuildlocalizationcreaterequestData data; +}; + +public type BetaBuildLocalizationUpdateRequest record { + BetabuildlocalizationupdaterequestData data; +}; + +public type BuildAttributes record { + string 'version?; + string uploadedDate?; + string expirationDate?; + boolean expired?; + string minOsVersion?; + ImageAsset iconAssetToken?; + string processingState?; + boolean usesNonExemptEncryption?; +}; + +public type ApppricepointRelationshipsPricetier record { + AppcategoryRelationshipsSubcategoriesLinks links?; + ApppricepointRelationshipsPricetierData data?; +}; + +public type ProfileRelationshipsBundleid record { + AppcategoryRelationshipsSubcategoriesLinks links?; + BundleidcapabilitycreaterequestDataRelationshipsBundleidData data?; +}; + +public type ErrorresponseErrors record { + string id?; + string status; + string code; + string title; + string detail; + record {}|record {} 'source?; +}; + +public type AgeRatingDeclarationUpdateRequest record { + AgeratingdeclarationupdaterequestData data; +}; + +public type AppstorereviewattachmentcreaterequestDataRelationshipsAppstorereviewdetail record { + AppstorereviewattachmentRelationshipsAppstorereviewdetailData data; +}; + +public type AppstorereviewdetailcreaterequestData record { + string 'type; + AppstorereviewdetailAttributes attributes?; + AppstorereviewdetailcreaterequestDataRelationships relationships; +}; + +public type GamecenterenabledversionRelationships record { + AppRelationshipsGamecenterenabledversions compatibleVersions?; + AppencryptiondeclarationRelationshipsApp app?; +}; + +public type UsersResponse record { + User[] data; + App[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type PrereleaseVersion record { + string 'type; + string id; + PrereleaseversionAttributes attributes?; + PrereleaseversionRelationships relationships?; + ResourceLinks links; +}; + +public type BetaBuildLocalizationsResponse record { + BetaBuildLocalization[] data; + Build[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppstorereviewattachmentAttributes record { + int fileSize?; + string fileName?; + string sourceFileChecksum?; + UploadOperation[] uploadOperations?; + AppMediaAssetState assetDeliveryState?; +}; + +public type BuildRelationshipsBetabuildlocalizations record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + BuildRelationshipsBetabuildlocalizationsData[] data?; +}; + +public type PhasedReleaseState string; + +public type AppPriceResponse record { + AppPrice data; + DocumentLinks links; +}; + +public type DeviceupdaterequestData record { + string 'type; + string id; + DeviceupdaterequestDataAttributes attributes?; +}; + +public type ApppreordercreaterequestDataRelationshipsApp record { + AppencryptiondeclarationRelationshipsAppData data; +}; + +public type BetaappreviewsubmissioncreaterequestDataRelationshipsBuild record { + AppstoreversionRelationshipsBuildData data; +}; + +public type BetaAppLocalizationUpdateRequest record { + BetaapplocalizationupdaterequestData data; +}; + +public type CertificatecreaterequestData record { + string 'type; + CertificatecreaterequestDataAttributes attributes; +}; + +public type BetaAppReviewDetail record { + string 'type; + string id; + AppstorereviewdetailAttributes attributes?; + AppencryptiondeclarationRelationships relationships?; + ResourceLinks links; +}; + +public type AppStoreVersionBuildLinkageRequest record { + AppstoreversionRelationshipsBuildData data; +}; + +public type AppPreview record { + string 'type; + string id; + ApppreviewAttributes attributes?; + ApppreviewRelationships relationships?; + ResourceLinks links; +}; + +public type ApppreviewsetRelationshipsApppreviews record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + ApppreviewsetRelationshipsApppreviewsData[] data?; +}; + +public type AppstoreversionphasedreleaseAttributes record { + PhasedReleaseState phasedReleaseState?; + string startDate?; + int totalPauseDuration?; + int currentDayNumber?; +}; + +public type BundleidcapabilitycreaterequestDataRelationships record { + BundleidcapabilitycreaterequestDataRelationshipsBundleid bundleId; +}; + +public type AppscreenshotsetRelationships record { + ApppreviewsetRelationshipsAppstoreversionlocalization appStoreVersionLocalization?; + AppscreenshotsetRelationshipsAppscreenshots appScreenshots?; +}; + +public type BetatesterinvitationcreaterequestDataRelationships record { + BetatesterinvitationcreaterequestDataRelationshipsBetatester betaTester; + ApppreordercreaterequestDataRelationshipsApp app; +}; + +public type EnduserlicenseagreementcreaterequestDataRelationshipsTerritories record { + ApppricepointRelationshipsTerritoryData[] data; +}; + +public type ApppreviewcreaterequestData record { + string 'type; + ApppreviewcreaterequestDataAttributes attributes; + ApppreviewcreaterequestDataRelationships relationships; +}; + +public type BundleidupdaterequestData record { + string 'type; + string id; + BundleidupdaterequestDataAttributes attributes?; +}; + +public type AppstoreversioncreaterequestDataAttributes record { + Platform platform; + string versionString; + string copyright?; + string releaseType?; + string earliestReleaseDate?; + boolean usesIdfa?; +}; + +public type AppScreenshotSetAppScreenshotsLinkagesRequest record { + AppscreenshotsetRelationshipsAppscreenshotsData[] data; +}; + +public type AppPriceTiersResponse record { + AppPriceTier[] data; + AppPricePoint[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppstorereviewdetailRelationshipsAppstoreversion record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppstorereviewdetailRelationshipsAppstoreversionData data?; +}; + +public type AppRelationshipsPrereleaseversions record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppRelationshipsPrereleaseversionsData[] data?; +}; + +public type AppRelationshipsAppstoreversions record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppstorereviewdetailRelationshipsAppstoreversionData[] data?; +}; + +public type App record { + string 'type; + string id; + AppAttributes attributes?; + AppRelationships relationships?; + ResourceLinks links; +}; + +public type BetaapplocalizationcreaterequestData record { + string 'type; + BetaapplocalizationcreaterequestDataAttributes attributes; + ApppreordercreaterequestDataRelationships relationships; +}; + +public type BundleIdCapabilityResponse record { + BundleIdCapability data; + DocumentLinks links; +}; + +public type BetaAppLocalization record { + string 'type; + string id; + BetaapplocalizationAttributes attributes?; + AppencryptiondeclarationRelationships relationships?; + ResourceLinks links; +}; + +public type AppStoreVersionsResponse record { + AppStoreVersion[] data; + AgeRatingDeclaration|AppStoreVersionLocalization|Build|AppStoreVersionPhasedRelease|RoutingAppCoverage|AppStoreReviewDetail|AppStoreVersionSubmission|IdfaDeclaration[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BundleIdCapabilitiesResponse record { + BundleIdCapability[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetatestercreaterequestDataRelationships record { + BetatestercreaterequestDataRelationshipsBetagroups betaGroups?; + BetagroupcreaterequestDataRelationshipsBuilds builds?; +}; + +public type AppstoreversionRelationshipsBuildData record { + string 'type; + string id; +}; + +public type BetaapplocalizationupdaterequestDataAttributes record { + string feedbackEmail?; + string marketingUrl?; + string privacyPolicyUrl?; + string tvOsPrivacyPolicy?; + string description?; +}; + +public type BetaappreviewsubmissionRelationships record { + AppstoreversionRelationshipsBuild build?; +}; + +public type AppPreviewSetAppPreviewsLinkagesRequest record { + ApppreviewsetRelationshipsApppreviewsData[] data; +}; + +public type AppstoreversionAttributes record { + Platform platform?; + string versionString?; + AppStoreVersionState appStoreState?; + string copyright?; + string releaseType?; + string earliestReleaseDate?; + boolean usesIdfa?; + boolean downloadable?; + string createdDate?; +}; + +public type BuildBetaDetailResponse record { + BuildBetaDetail data; + Build[] included?; + DocumentLinks links; +}; + +public type AppstoreversionphasedreleasecreaterequestDataAttributes record { + PhasedReleaseState phasedReleaseState?; +}; + +public type ProfilesResponse record { + Profile[] data; + BundleId|Device|Certificate[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppencryptiondeclarationRelationshipsAppData record { + string 'type; + string id; +}; + +public type CertificatecreaterequestDataAttributes record { + string csrContent; + CertificateType certificateType; +}; + +public type InAppPurchase record { + string 'type; + string id; + InapppurchaseAttributes attributes?; + InapppurchaseRelationships relationships?; + ResourceLinks links; +}; + +public type AgeratingdeclarationAttributes record { + string alcoholTobaccoOrDrugUseOrReferences?; + string contests?; + boolean gamblingAndContests?; + boolean gambling?; + string gamblingSimulated?; + KidsAgeBand kidsAgeBand?; + string medicalOrTreatmentInformation?; + string profanityOrCrudeHumor?; + string sexualContentGraphicAndNudity?; + string sexualContentOrNudity?; + boolean seventeenPlus?; + string horrorOrFearThemes?; + string matureOrSuggestiveThemes?; + boolean unrestrictedWebAccess?; + string violenceCartoonOrFantasy?; + string violenceRealisticProlongedGraphicOrSadistic?; + string violenceRealistic?; +}; + +public type AppStoreVersionSubmission record { + string 'type; + string id; + AppstoreversionsubmissionRelationships relationships?; + ResourceLinks links; +}; + +public type BetaLicenseAgreement record { + string 'type; + string id; + BetalicenseagreementAttributes attributes?; + AppencryptiondeclarationRelationships relationships?; + ResourceLinks links; +}; + +public type IdfadeclarationAttributes record { + boolean servesAds?; + boolean attributesAppInstallationToPreviousAd?; + boolean attributesActionWithPreviousAd?; + boolean honorsLimitedAdTracking?; +}; + +public type DocumentLinks record { + string self; +}; + +public type BundleidcapabilitycreaterequestDataRelationshipsBundleid record { + BundleidcapabilitycreaterequestDataRelationshipsBundleidData data; +}; + +public type EnduserlicenseagreementRelationships record { + AppencryptiondeclarationRelationshipsApp app?; + AppRelationshipsAvailableterritories territories?; +}; + +public type BuildupdaterequestData record { + string 'type; + string id; + BuildupdaterequestDataAttributes attributes?; + BuildupdaterequestDataRelationships relationships?; +}; + +public type GameCenterEnabledVersion record { + string 'type; + string id; + GamecenterenabledversionAttributes attributes?; + GamecenterenabledversionRelationships relationships?; + ResourceLinks links; +}; + +public type AppscreenshotupdaterequestDataAttributes record { + string sourceFileChecksum?; + boolean uploaded?; +}; + +public type AppAttributes record { + string name?; + string bundleId?; + string sku?; + string primaryLocale?; + boolean isOrEverWasMadeForKids?; + boolean availableInNewTerritories?; + string contentRightsDeclaration?; +}; + +public type BuildupdaterequestDataRelationshipsAppencryptiondeclaration record { + BuildRelationshipsAppencryptiondeclarationData data?; +}; + +public type AppRelationshipsBetagroups record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppRelationshipsBetagroupsData[] data?; +}; + +public type AppRelationshipsPricesData record { + string 'type; + string id; +}; + +public type BuildRelationshipsPrereleaseversion record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppRelationshipsPrereleaseversionsData data?; +}; + +public type AppStoreVersionLocalizationUpdateRequest record { + AppstoreversionlocalizationupdaterequestData data; +}; + +public type AppstoreversionRelationshipsAppstoreversionsubmissionData record { + string 'type; + string id; +}; + +public type BuildupdaterequestDataRelationships record { + BuildupdaterequestDataRelationshipsAppencryptiondeclaration appEncryptionDeclaration?; +}; + +public type DeviceCreateRequest record { + DevicecreaterequestData data; +}; + +public type ProfileRelationshipsCertificatesData record { + string 'type; + string id; +}; + +public type AppStoreVersionUpdateRequest record { + AppstoreversionupdaterequestData data; +}; + +public type BundleidRelationshipsProfilesData record { + string 'type; + string id; +}; + +public type AppstoreversionsubmissioncreaterequestData record { + string 'type; + AppstorereviewdetailcreaterequestDataRelationships relationships; +}; + +public type AppscreenshotRelationshipsAppscreenshotsetData record { + string 'type; + string id; +}; + +public type BuildRelationshipsBuildbetadetailData record { + string 'type; + string id; +}; + +public type ApppreviewsetRelationshipsAppstoreversionlocalization record { + AppcategoryRelationshipsSubcategoriesLinks links?; + ApppreviewsetRelationshipsAppstoreversionlocalizationData data?; +}; + +public type AppStoreVersionPhasedReleaseResponse record { + AppStoreVersionPhasedRelease data; + DocumentLinks links; +}; + +public type BetaInviteType string; + +public type UploadOperation record { + string method?; + string url?; + int length?; + int offset?; + UploadOperationHeader[] requestHeaders?; +}; + +public type AppRelationshipsAppinfos record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppinfolocalizationRelationshipsAppinfoData[] data?; +}; + +public type EnduserlicenseagreementcreaterequestDataAttributes record { + string agreementText; +}; + +public type ProfilecreaterequestDataAttributes record { + string name; + string profileType; +}; + +public type AppScreenshotCreateRequest record { + AppscreenshotcreaterequestData data; +}; + +public type UserUpdateRequest record { + UserupdaterequestData data; +}; + +public type TerritoryAttributes record { + string currency?; +}; + +public type AppinfoRelationships record { + AppencryptiondeclarationRelationshipsApp app?; + AppinfoRelationshipsAgeratingdeclaration ageRatingDeclaration?; + AppinfoRelationshipsAppinfolocalizations appInfoLocalizations?; + AppcategoryRelationshipsParent primaryCategory?; + AppcategoryRelationshipsParent primarySubcategoryOne?; + AppcategoryRelationshipsParent primarySubcategoryTwo?; + AppcategoryRelationshipsParent secondaryCategory?; + AppcategoryRelationshipsParent secondarySubcategoryOne?; + AppcategoryRelationshipsParent secondarySubcategoryTwo?; +}; + +public type ApppreviewRelationshipsApppreviewsetData record { + string 'type; + string id; +}; + +public type AppPreOrder record { + string 'type; + string id; + ApppreorderAttributes attributes?; + AppencryptiondeclarationRelationships relationships?; + ResourceLinks links; +}; + +public type AppRelationships record { + AppRelationshipsBetagroups betaGroups?; + AppRelationshipsAppstoreversions appStoreVersions?; + AppRelationshipsPrereleaseversions preReleaseVersions?; + AppRelationshipsBetaapplocalizations betaAppLocalizations?; + AppRelationshipsBuilds builds?; + AppRelationshipsBetalicenseagreement betaLicenseAgreement?; + AppRelationshipsBetaappreviewdetail betaAppReviewDetail?; + AppRelationshipsAppinfos appInfos?; + AppRelationshipsEnduserlicenseagreement endUserLicenseAgreement?; + AppRelationshipsPreorder preOrder?; + AppRelationshipsPrices prices?; + AppRelationshipsAvailableterritories availableTerritories?; + AppRelationshipsInapppurchases inAppPurchases?; + AppRelationshipsGamecenterenabledversions gameCenterEnabledVersions?; +}; + +public type AppsResponse record { + App[] data; + BetaGroup|AppStoreVersion|PrereleaseVersion|BetaAppLocalization|Build|BetaLicenseAgreement|BetaAppReviewDetail|AppInfo|EndUserLicenseAgreement|AppPreOrder|AppPrice|Territory|InAppPurchase|GameCenterEnabledVersion|PerfPowerMetric[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetagroupupdaterequestData record { + string 'type; + string id; + BetagroupupdaterequestDataAttributes attributes?; +}; + +public type BuildRelationshipsIconsData record { + string 'type; + string id; +}; + +public type AppInfosResponse record { + AppInfo[] data; + AppInfoLocalization|AppCategory|AppCategory|AppCategory|AppCategory|AppCategory|AppCategory[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetaAppReviewSubmissionResponse record { + BetaAppReviewSubmission data; + Build[] included?; + DocumentLinks links; +}; + +public type BetagroupRelationshipsBetatesters record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + BetagroupRelationshipsBetatestersData[] data?; +}; + +public type AppPricePointsResponse record { + AppPricePoint[] data; + Territory[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppScreenshotSetCreateRequest record { + AppscreenshotsetcreaterequestData data; +}; + +public type AppStoreVersionPhasedRelease record { + string 'type; + string id; + AppstoreversionphasedreleaseAttributes attributes?; + ResourceLinks links; +}; + +public type BetatestercreaterequestDataRelationshipsBetagroups record { + AppRelationshipsBetagroupsData[] data?; +}; + +public type BuildRelationshipsAppencryptiondeclarationData record { + string 'type; + string id; +}; + +public type BetaAppReviewSubmissionCreateRequest record { + BetaappreviewsubmissioncreaterequestData data; +}; + +public type AppinfolocalizationRelationshipsAppinfoData record { + string 'type; + string id; +}; + +public type AppcategoryRelationshipsParent record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppcategoryRelationshipsSubcategoriesData data?; +}; + +public type BetaTesterAppsLinkagesRequest record { + AppencryptiondeclarationRelationshipsAppData[] data; +}; + +public type BundleIdCapabilityUpdateRequest record { + BundleidcapabilityupdaterequestData data; +}; + +public type AppstoreversionphasedreleasecreaterequestData record { + string 'type; + AppstoreversionphasedreleasecreaterequestDataAttributes attributes?; + AppstorereviewdetailcreaterequestDataRelationships relationships; +}; + +public type BuildRelationships record { + BuildRelationshipsPrereleaseversion preReleaseVersion?; + BetagroupRelationshipsBetatesters individualTesters?; + BuildRelationshipsBetabuildlocalizations betaBuildLocalizations?; + BuildRelationshipsAppencryptiondeclaration appEncryptionDeclaration?; + BuildRelationshipsBetaappreviewsubmission betaAppReviewSubmission?; + AppencryptiondeclarationRelationshipsApp app?; + BuildRelationshipsBuildbetadetail buildBetaDetail?; + AppstorereviewdetailRelationshipsAppstoreversion appStoreVersion?; + BuildRelationshipsIcons icons?; +}; + +public type BundleidupdaterequestDataAttributes record { + string name?; +}; + +public type AgeRatingDeclarationResponse record { + AgeRatingDeclaration data; + DocumentLinks links; +}; + +public type AppStoreReviewAttachmentResponse record { + AppStoreReviewAttachment data; + DocumentLinks links; +}; + +public type AppstorereviewdetailRelationships record { + AppstorereviewdetailRelationshipsAppstoreversion appStoreVersion?; + AppstorereviewdetailRelationshipsAppstorereviewattachments appStoreReviewAttachments?; +}; + +public type AppPricePointResponse record { + AppPricePoint data; + Territory[] included?; + DocumentLinks links; +}; + +public type AppstorereviewattachmentupdaterequestData record { + string 'type; + string id; + AppscreenshotupdaterequestDataAttributes attributes?; +}; + +public type BuildRelationshipsBetaappreviewsubmission record { + AppcategoryRelationshipsSubcategoriesLinks links?; + BuildRelationshipsBetaappreviewsubmissionData data?; +}; + +public type AppMediaStateError record { + string code?; + string description?; +}; + +public type BuildAppEncryptionDeclarationLinkageResponse record { + BuildRelationshipsAppencryptiondeclarationData data; + DocumentLinks links; +}; + +public type BetaAppReviewSubmission record { + string 'type; + string id; + BetaappreviewsubmissionAttributes attributes?; + BetaappreviewsubmissionRelationships relationships?; + ResourceLinks links; +}; + +public type BuildBetaDetailsResponse record { + BuildBetaDetail[] data; + Build[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type PerfPowerMetric record { + string 'type; + string id; + PerfpowermetricAttributes attributes?; + ResourceLinks links; +}; + +public type AppRelationshipsBetagroupsData record { + string 'type; + string id; +}; + +public type Territory record { + string 'type; + string id; + TerritoryAttributes attributes?; + ResourceLinks links; +}; + +public type AppstorereviewattachmentRelationshipsAppstorereviewdetailData record { + string 'type; + string id; +}; + +public type AppstorereviewdetailcreaterequestDataRelationshipsAppstoreversion record { + AppstorereviewdetailRelationshipsAppstoreversionData data; +}; + +public type BetaappreviewsubmissionAttributes record { + BetaReviewState betaReviewState?; +}; + +public type BuildIndividualTestersLinkagesRequest record { + BetagroupRelationshipsBetatestersData[] data; +}; + +public type AppInfoLocalizationsResponse record { + AppInfoLocalization[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppRelationshipsBetaapplocalizationsData record { + string 'type; + string id; +}; + +public type DiagnosticLogsResponse record { + DiagnosticLog[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetagroupcreaterequestDataAttributes record { + string name; + boolean publicLinkEnabled?; + boolean publicLinkLimitEnabled?; + int publicLinkLimit?; + boolean feedbackEnabled?; +}; + +public type AppRelationshipsInapppurchases record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppRelationshipsInapppurchasesData[] data?; +}; + +public type AppEncryptionDeclarationsResponse record { + AppEncryptionDeclaration[] data; + App[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetaAppReviewSubmissionsResponse record { + BetaAppReviewSubmission[] data; + Build[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BuildBetaNotification record { + string 'type; + string id; + ResourceLinks links; +}; + +public type BuildBetaNotificationCreateRequest record { + BuildbetanotificationcreaterequestData data; +}; + +public type ApppriceRelationships record { + AppencryptiondeclarationRelationshipsApp app?; + ApppricepointRelationshipsPricetier priceTier?; +}; + +public type EnduserlicenseagreementcreaterequestData record { + string 'type; + EnduserlicenseagreementcreaterequestDataAttributes attributes; + EnduserlicenseagreementcreaterequestDataRelationships relationships; +}; + +public type AppPreOrderCreateRequest record { + ApppreordercreaterequestData data; +}; + +public type AppStoreReviewDetail record { + string 'type; + string id; + AppstorereviewdetailAttributes attributes?; + AppstorereviewdetailRelationships relationships?; + ResourceLinks links; +}; + +public type AppstoreversionlocalizationRelationshipsApppreviewsets record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + ApppreviewRelationshipsApppreviewsetData[] data?; +}; + +public type BuildBetaDetail record { + string 'type; + string id; + BuildbetadetailAttributes attributes?; + BetaappreviewsubmissionRelationships relationships?; + ResourceLinks links; +}; + +public type BetaLicenseAgreementResponse record { + BetaLicenseAgreement data; + App[] included?; + DocumentLinks links; +}; + +public type ApppricepointAttributes record { + string customerPrice?; + string proceeds?; +}; + +public type BetaTester record { + string 'type; + string id; + BetatesterAttributes attributes?; + BetatesterRelationships relationships?; + ResourceLinks links; +}; + +public type Certificate record { + string 'type; + string id; + CertificateAttributes attributes?; + ResourceLinks links; +}; + +public type AppinfoAttributes record { + AppStoreVersionState appStoreState?; + AppStoreAgeRating appStoreAgeRating?; + BrazilAgeRating brazilAgeRating?; + KidsAgeBand kidsAgeBand?; +}; + +public type ApppreviewupdaterequestData record { + string 'type; + string id; + ApppreviewupdaterequestDataAttributes attributes?; +}; + +public type BuildBetaNotificationResponse record { + BuildBetaNotification data; + DocumentLinks links; +}; + +public type ApppricetierRelationshipsPricepoints record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + ApppricetierRelationshipsPricepointsData[] data?; +}; + +public type BundleidRelationships record { + BundleidRelationshipsProfiles profiles?; + BundleidRelationshipsBundleidcapabilities bundleIdCapabilities?; + AppencryptiondeclarationRelationshipsApp app?; +}; + +public type AppInfoResponse record { + AppInfo data; + AppInfoLocalization|AppCategory|AppCategory|AppCategory|AppCategory|AppCategory|AppCategory[] included?; + DocumentLinks links; +}; + +public type UserAttributes record { + string username?; + string firstName?; + string lastName?; + UserRole[] roles?; + boolean allAppsVisible?; + boolean provisioningAllowed?; +}; + +public type BetaGroupsResponse record { + BetaGroup[] data; + App|Build|BetaTester[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetaGroupCreateRequest record { + BetagroupcreaterequestData data; +}; + +public type UserupdaterequestDataAttributes record { + UserRole[] roles?; + boolean allAppsVisible?; + boolean provisioningAllowed?; +}; + +public type BuildUpdateRequest record { + BuildupdaterequestData data; +}; + +public type ApppreviewsetRelationshipsAppstoreversionlocalizationData record { + string 'type; + string id; +}; + +public type AppstoreversionlocalizationcreaterequestDataAttributes record { + string description?; + string locale; + string keywords?; + string marketingUrl?; + string promotionalText?; + string supportUrl?; + string whatsNew?; +}; + +public type BundleidcapabilitycreaterequestData record { + string 'type; + BundleidcapabilitycreaterequestDataAttributes attributes; + BundleidcapabilitycreaterequestDataRelationships relationships; +}; + +public type AppStoreVersionSubmissionResponse record { + AppStoreVersionSubmission data; + DocumentLinks links; +}; + +public type AppResponse record { + App data; + BetaGroup|AppStoreVersion|PrereleaseVersion|BetaAppLocalization|Build|BetaLicenseAgreement|BetaAppReviewDetail|AppInfo|EndUserLicenseAgreement|AppPreOrder|AppPrice|Territory|InAppPurchase|GameCenterEnabledVersion|PerfPowerMetric[] included?; + DocumentLinks links; +}; + +public type DevicesResponse record { + Device[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppinfolocalizationRelationships record { + AppinfolocalizationRelationshipsAppinfo appInfo?; +}; + +public type BetagroupcreaterequestDataRelationshipsBetatesters record { + BetagroupRelationshipsBetatestersData[] data?; +}; + +public type AppInfoLocalizationUpdateRequest record { + AppinfolocalizationupdaterequestData data; +}; + +public type AppscreenshotsetRelationshipsAppscreenshots record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppscreenshotsetRelationshipsAppscreenshotsData[] data?; +}; + +public type ProfileRelationshipsCertificates record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + ProfileRelationshipsCertificatesData[] data?; +}; + +public type ApppreviewupdaterequestDataAttributes record { + string sourceFileChecksum?; + string previewFrameTimeCode?; + boolean uploaded?; +}; + +public type BetagroupcreaterequestDataRelationshipsBuilds record { + AppstoreversionRelationshipsBuildData[] data?; +}; + +public type AppstorereviewdetailupdaterequestData record { + string 'type; + string id; + AppstorereviewdetailAttributes attributes?; +}; + +public type RoutingappcoveragecreaterequestData record { + string 'type; + AppscreenshotcreaterequestDataAttributes attributes; + AppstorereviewdetailcreaterequestDataRelationships relationships; +}; + +public type BrazilAgeRating string; + +public type CertificateResponse record { + Certificate data; + DocumentLinks links; +}; + +public type BuildBetaDetailUpdateRequest record { + BuildbetadetailupdaterequestData data; +}; + +public type ProfilecreaterequestDataRelationshipsDevices record { + ProfileRelationshipsDevicesData[] data?; +}; + +public type UserResponse record { + User data; + App[] included?; + DocumentLinks links; +}; + +public type AgeRatingDeclaration record { + string 'type; + string id; + AgeratingdeclarationAttributes attributes?; + ResourceLinks links; +}; + +public type AppstoreversioncreaterequestData record { + string 'type; + AppstoreversioncreaterequestDataAttributes attributes; + AppstoreversioncreaterequestDataRelationships relationships; +}; + +public type ProfileCreateRequest record { + ProfilecreaterequestData data; +}; + +public type TerritoriesResponse record { + Territory[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type ApppreviewAttributes record { + int fileSize?; + string fileName?; + string sourceFileChecksum?; + string previewFrameTimeCode?; + string mimeType?; + string videoUrl?; + ImageAsset previewImage?; + UploadOperation[] uploadOperations?; + AppMediaAssetState assetDeliveryState?; +}; + +public type AppStoreVersion record { + string 'type; + string id; + AppstoreversionAttributes attributes?; + AppstoreversionRelationships relationships?; + ResourceLinks links; +}; + +public type BetaGroupBetaTestersLinkagesResponse record { + BetagroupRelationshipsBetatestersData[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type IdfadeclarationcreaterequestData record { + string 'type; + IdfadeclarationcreaterequestDataAttributes attributes; + AppstorereviewdetailcreaterequestDataRelationships relationships; +}; + +public type AppRelationshipsBetaappreviewdetail record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppRelationshipsBetaappreviewdetailData data?; +}; + +public type BuildAppEncryptionDeclarationLinkageRequest record { + BuildRelationshipsAppencryptiondeclarationData data; +}; + +public type EndUserLicenseAgreementResponse record { + EndUserLicenseAgreement data; + Territory[] included?; + DocumentLinks links; +}; + +public type AppRelationshipsGamecenterenabledversionsData record { + string 'type; + string id; +}; + +public type AppScreenshotSetsResponse record { + AppScreenshotSet[] data; + AppScreenshot[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppRelationshipsBuilds record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppstoreversionRelationshipsBuildData[] data?; +}; + +public type Platform string; + +public type DevicecreaterequestDataAttributes record { + string name; + BundleIdPlatform platform; + string udid; +}; + +public type AppinfoRelationshipsAppinfolocalizations record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppinfoRelationshipsAppinfolocalizationsData[] data?; +}; + +public type ApppricepointRelationshipsTerritoryData record { + string 'type; + string id; +}; + +public type ApppreviewRelationships record { + ApppreviewRelationshipsApppreviewset appPreviewSet?; +}; + +public type AppPreviewCreateRequest record { + ApppreviewcreaterequestData data; +}; + +public type AppScreenshotResponse record { + AppScreenshot data; + DocumentLinks links; +}; + +public type BetagroupcreaterequestDataRelationships record { + ApppreordercreaterequestDataRelationshipsApp app; + BetagroupcreaterequestDataRelationshipsBuilds builds?; + BetagroupcreaterequestDataRelationshipsBetatesters betaTesters?; +}; + +public type AppstoreversioncreaterequestDataRelationshipsBuild record { + AppstoreversionRelationshipsBuildData data?; +}; + +public type AppStoreReviewAttachmentsResponse record { + AppStoreReviewAttachment[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppstoreversionupdaterequestDataAttributes record { + string versionString?; + string copyright?; + string releaseType?; + string earliestReleaseDate?; + boolean usesIdfa?; + boolean downloadable?; +}; + +public type AppinfoupdaterequestDataRelationshipsPrimarycategory record { + AppcategoryRelationshipsSubcategoriesData data?; +}; + +public type CertificateCreateRequest record { + CertificatecreaterequestData data; +}; + +public type UserinvitationcreaterequestDataRelationships record { + UserinvitationcreaterequestDataRelationshipsVisibleapps visibleApps?; +}; + +public type BuildsResponse record { + Build[] data; + PrereleaseVersion|BetaTester|BetaBuildLocalization|AppEncryptionDeclaration|BetaAppReviewSubmission|App|BuildBetaDetail|AppStoreVersion|BuildIcon|PerfPowerMetric|DiagnosticSignature[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type ProfileRelationships record { + ProfileRelationshipsBundleid bundleId?; + ProfileRelationshipsDevices devices?; + ProfileRelationshipsCertificates certificates?; +}; + +public type AppStoreVersionCreateRequest record { + AppstoreversioncreaterequestData data; +}; + +public type InAppPurchaseResponse record { + InAppPurchase data; + DocumentLinks links; +}; + +public type EndUserLicenseAgreementCreateRequest record { + EnduserlicenseagreementcreaterequestData data; +}; + +public type ProfileRelationshipsDevices record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + ProfileRelationshipsDevicesData[] data?; +}; + +public type BetagroupupdaterequestDataAttributes record { + string name?; + boolean publicLinkEnabled?; + boolean publicLinkLimitEnabled?; + int publicLinkLimit?; + boolean feedbackEnabled?; +}; + +public type AppstoreversionlocalizationRelationships record { + AppstorereviewdetailRelationshipsAppstoreversion appStoreVersion?; + AppstoreversionlocalizationRelationshipsAppscreenshotsets appScreenshotSets?; + AppstoreversionlocalizationRelationshipsApppreviewsets appPreviewSets?; +}; + +public type PagedDocumentLinks record { + string self; + string first?; + string next?; +}; + +public type CapabilityOption record { + string 'key?; + string name?; + string description?; + boolean enabledByDefault?; + boolean enabled?; + boolean supportsWildcard?; +}; + +public type AppcategoryRelationshipsSubcategoriesLinks record { + string self?; + string related?; +}; + +public type AppscreenshotAttributes record { + int fileSize?; + string fileName?; + string sourceFileChecksum?; + ImageAsset imageAsset?; + string assetToken?; + string assetType?; + UploadOperation[] uploadOperations?; + AppMediaAssetState assetDeliveryState?; +}; + +public type GameCenterEnabledVersionsResponse record { + GameCenterEnabledVersion[] data; + GameCenterEnabledVersion[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppencryptiondeclarationRelationships record { + AppencryptiondeclarationRelationshipsApp app?; +}; + +public type BuildRelationshipsIcons record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + BuildRelationshipsIconsData[] data?; +}; + +public type AppStoreVersionLocalizationResponse record { + AppStoreVersionLocalization data; + AppScreenshotSet|AppPreviewSet[] included?; + DocumentLinks links; +}; + +public type RoutingAppCoverageCreateRequest record { + RoutingappcoveragecreaterequestData data; +}; + +public type AppRelationshipsBetalicenseagreement record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppRelationshipsBetalicenseagreementData data?; +}; + +public type AppPriceTierResponse record { + AppPriceTier data; + AppPricePoint[] included?; + DocumentLinks links; +}; + +public type UserupdaterequestData record { + string 'type; + string id; + UserupdaterequestDataAttributes attributes?; + UserinvitationcreaterequestDataRelationships relationships?; +}; + +public type AppMediaAssetState record { + AppMediaStateError[] errors?; + AppMediaStateError[] warnings?; + string state?; +}; + +public type BetaTesterInvitation record { + string 'type; + string id; + ResourceLinks links; +}; + +public type AppinfolocalizationcreaterequestDataRelationshipsAppinfo record { + AppinfolocalizationRelationshipsAppinfoData data; +}; + +public type DiagnosticSignaturesResponse record { + DiagnosticSignature[] data; + DiagnosticLog[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type PerfPowerMetricsResponse record { + PerfPowerMetric[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppscreenshotupdaterequestData record { + string 'type; + string id; + AppscreenshotupdaterequestDataAttributes attributes?; +}; + +public type AppPreviewSetAppPreviewsLinkagesResponse record { + ApppreviewsetRelationshipsApppreviewsData[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetatestercreaterequestDataAttributes record { + string firstName?; + string lastName?; + string email; +}; + +public type ApppreviewsetRelationships record { + ApppreviewsetRelationshipsAppstoreversionlocalization appStoreVersionLocalization?; + ApppreviewsetRelationshipsApppreviews appPreviews?; +}; + +public type BetagroupcreaterequestData record { + string 'type; + BetagroupcreaterequestDataAttributes attributes; + BetagroupcreaterequestDataRelationships relationships; +}; + +public type BetaTesterBetaGroupsLinkagesRequest record { + AppRelationshipsBetagroupsData[] data; +}; + +public type BundleIdCapabilityCreateRequest record { + BundleidcapabilitycreaterequestData data; +}; + +public type IdfaDeclaration record { + string 'type; + string id; + IdfadeclarationAttributes attributes?; + AppstoreversionsubmissionRelationships relationships?; + ResourceLinks links; +}; + +public type AppstoreversionlocalizationRelationshipsAppscreenshotsets record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppscreenshotRelationshipsAppscreenshotsetData[] data?; +}; + +public type IdfaDeclarationUpdateRequest record { + IdfadeclarationupdaterequestData data; +}; + +public type AppinfolocalizationcreaterequestDataAttributes record { + string locale; + string name?; + string subtitle?; + string privacyPolicyUrl?; + string privacyPolicyText?; +}; + +public type PreReleaseVersionsResponse record { + PrereleaseVersion[] data; + Build|App[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BundleidAttributes record { + string name?; + BundleIdPlatform platform?; + string identifier?; + string seedId?; +}; + +public type UserInvitationsResponse record { + UserInvitation[] data; + App[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetaAppReviewDetailUpdateRequest record { + BetaappreviewdetailupdaterequestData data; +}; + +public type BetaReviewState string; + +public type BetatesterinvitationcreaterequestData record { + string 'type; + BetatesterinvitationcreaterequestDataRelationships relationships; +}; + +public type AppEncryptionDeclarationState string; + +public type AppPrice record { + string 'type; + string id; + ApppriceRelationships relationships?; + ResourceLinks links; +}; + +public type BetagroupRelationships record { + AppencryptiondeclarationRelationshipsApp app?; + AppRelationshipsBuilds builds?; + BetagroupRelationshipsBetatesters betaTesters?; +}; + +public type UserinvitationcreaterequestDataRelationshipsVisibleapps record { + AppencryptiondeclarationRelationshipsAppData[] data?; +}; + +public type BetaTesterCreateRequest record { + BetatestercreaterequestData data; +}; + +public type AppRelationshipsGamecenterenabledversions record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppRelationshipsGamecenterenabledversionsData[] data?; +}; + +public type AppRelationshipsPreorder record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppRelationshipsPreorderData data?; +}; + +public type AppRelationshipsBetaapplocalizations record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + AppRelationshipsBetaapplocalizationsData[] data?; +}; + +public type UserinvitationcreaterequestData record { + string 'type; + UserinvitationcreaterequestDataAttributes attributes; + UserinvitationcreaterequestDataRelationships relationships?; +}; + +public type AppstoreversionRelationshipsAppstoreversionsubmission record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppstoreversionRelationshipsAppstoreversionsubmissionData data?; +}; + +public type AppinfoupdaterequestDataRelationships record { + AppinfoupdaterequestDataRelationshipsPrimarycategory primaryCategory?; + AppinfoupdaterequestDataRelationshipsPrimarycategory primarySubcategoryOne?; + AppinfoupdaterequestDataRelationshipsPrimarycategory primarySubcategoryTwo?; + AppinfoupdaterequestDataRelationshipsPrimarycategory secondaryCategory?; + AppinfoupdaterequestDataRelationshipsPrimarycategory secondarySubcategoryOne?; + AppinfoupdaterequestDataRelationshipsPrimarycategory secondarySubcategoryTwo?; +}; + +public type ApppreviewsetAttributes record { + PreviewType previewType?; +}; + +public type EnduserlicenseagreementupdaterequestData record { + string 'type; + string id; + BetalicenseagreementAttributes attributes?; + EnduserlicenseagreementupdaterequestDataRelationships relationships?; +}; + +public type CertificatesResponse record { + Certificate[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type IdfaDeclarationResponse record { + IdfaDeclaration data; + DocumentLinks links; +}; + +public type BuildbetadetailAttributes record { + boolean autoNotifyEnabled?; + InternalBetaState internalBuildState?; + ExternalBetaState externalBuildState?; +}; + +public type BetaTesterInvitationResponse record { + BetaTesterInvitation data; + DocumentLinks links; +}; + +public type BetatestercreaterequestData record { + string 'type; + BetatestercreaterequestDataAttributes attributes; + BetatestercreaterequestDataRelationships relationships?; +}; + +public type BetatesterinvitationcreaterequestDataRelationshipsBetatester record { + BetagroupRelationshipsBetatestersData data; +}; + +public type BuildRelationshipsBetaappreviewsubmissionData record { + string 'type; + string id; +}; + +public type AppStoreVersionResponse record { + AppStoreVersion data; + AgeRatingDeclaration|AppStoreVersionLocalization|Build|AppStoreVersionPhasedRelease|RoutingAppCoverage|AppStoreReviewDetail|AppStoreVersionSubmission|IdfaDeclaration[] included?; + DocumentLinks links; +}; + +public type Device record { + string 'type; + string id; + DeviceAttributes attributes?; + ResourceLinks links; +}; + +public type PerfpowermetricAttributes record { + string platform?; + string metricType?; + string deviceType?; +}; + +public type BetabuildlocalizationAttributes record { + string whatsNew?; + string locale?; +}; + +public type AppscreenshotsetRelationshipsAppscreenshotsData record { + string 'type; + string id; +}; + +public type AppstorereviewattachmentcreaterequestData record { + string 'type; + AppscreenshotcreaterequestDataAttributes attributes; + AppstorereviewattachmentcreaterequestDataRelationships relationships; +}; + +public type UserInvitationResponse record { + UserInvitation data; + App[] included?; + DocumentLinks links; +}; + +public type BetaappreviewsubmissioncreaterequestData record { + string 'type; + BetaappreviewsubmissioncreaterequestDataRelationships relationships; +}; + +public type ProfileAttributes record { + string name?; + BundleIdPlatform platform?; + string profileType?; + string profileState?; + string profileContent?; + string uuid?; + string createdDate?; + string expirationDate?; +}; + +public type AppPreviewSetResponse record { + AppPreviewSet data; + AppPreview[] included?; + DocumentLinks links; +}; + +public type RoutingAppCoverageUpdateRequest record { + RoutingappcoverageupdaterequestData data; +}; + +public type AppcategoryRelationships record { + AppcategoryRelationshipsSubcategories subcategories?; + AppcategoryRelationshipsParent parent?; +}; + +public type ApppricepointRelationshipsTerritory record { + AppcategoryRelationshipsSubcategoriesLinks links?; + ApppricepointRelationshipsTerritoryData data?; +}; + +public type DiagnosticLog record { + string 'type; + string id; + ResourceLinks links; +}; + +public type PagingInformation record { + PaginginformationPaging paging; +}; + +public type AppstoreversionRelationshipsRoutingappcoverageData record { + string 'type; + string id; +}; + +public type User record { + string 'type; + string id; + UserAttributes attributes?; + UserinvitationRelationships relationships?; + ResourceLinks links; +}; + +public type ApppreordercreaterequestDataAttributes record { + string appReleaseDate?; +}; + +public type AppstoreversionlocalizationAttributes record { + string description?; + string locale?; + string keywords?; + string marketingUrl?; + string promotionalText?; + string supportUrl?; + string whatsNew?; +}; + +public type RoutingappcoverageupdaterequestData record { + string 'type; + string id; + AppscreenshotupdaterequestDataAttributes attributes?; +}; + +public type AppstoreversionRelationshipsRoutingappcoverage record { + AppcategoryRelationshipsSubcategoriesLinks links?; + AppstoreversionRelationshipsRoutingappcoverageData data?; +}; + +public type AppStoreReviewAttachment record { + string 'type; + string id; + AppstorereviewattachmentAttributes attributes?; + AppstorereviewattachmentRelationships relationships?; + ResourceLinks links; +}; + +public type AppPreviewSetCreateRequest record { + ApppreviewsetcreaterequestData data; +}; + +public type BetaGroupResponse record { + BetaGroup data; + App|Build|BetaTester[] included?; + DocumentLinks links; +}; + +public type BundleidcapabilityupdaterequestData record { + string 'type; + string id; + BundleidcapabilityAttributes attributes?; +}; + +public type AppRelationshipsAvailableterritories record { + AppcategoryRelationshipsSubcategoriesLinks links?; + PagingInformation meta?; + ApppricepointRelationshipsTerritoryData[] data?; +}; + +public type BetaGroupBuildsLinkagesResponse record { + AppstoreversionRelationshipsBuildData[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type AppinfolocalizationcreaterequestDataRelationships record { + AppinfolocalizationcreaterequestDataRelationshipsAppinfo appInfo; +}; + +public type AppPreviewResponse record { + AppPreview data; + DocumentLinks links; +}; + +public type AppUpdateRequest record { + AppupdaterequestData data; +}; + +public type AppencryptiondeclarationAttributes record { + boolean usesEncryption?; + boolean exempt?; + boolean containsProprietaryCryptography?; + boolean containsThirdPartyCryptography?; + boolean availableOnFrenchStore?; + Platform platform?; + string uploadedDate?; + string documentUrl?; + string documentName?; + string documentType?; + AppEncryptionDeclarationState appEncryptionDeclarationState?; + string codeValue?; +}; + +public type AppstoreversionlocalizationcreaterequestData record { + string 'type; + AppstoreversionlocalizationcreaterequestDataAttributes attributes; + AppstorereviewdetailcreaterequestDataRelationships relationships; +}; + +public type ApppreviewsetcreaterequestData record { + string 'type; + ApppreviewsetcreaterequestDataAttributes attributes; + ApppreviewsetcreaterequestDataRelationships relationships; +}; + +public type AppstoreversionRelationshipsIdfadeclarationData record { + string 'type; + string id; +}; + +public type ApppricepointRelationships record { + ApppricepointRelationshipsPricetier priceTier?; + ApppricepointRelationshipsTerritory territory?; +}; + +public type EnduserlicenseagreementupdaterequestDataRelationships record { + AppupdaterequestDataRelationshipsAvailableterritories territories?; +}; + +public type AppScreenshotUpdateRequest record { + AppscreenshotupdaterequestData data; +}; + +public type BetaapplocalizationupdaterequestData record { + string 'type; + string id; + BetaapplocalizationupdaterequestDataAttributes attributes?; +}; + +public type BuildbetadetailupdaterequestData record { + string 'type; + string id; + BuildbetadetailupdaterequestDataAttributes attributes?; +}; + +public type CapabilityType string; + +public type BetabuildlocalizationupdaterequestDataAttributes record { + string whatsNew?; +}; + +public type BundleIdsResponse record { + BundleId[] data; + Profile|BundleIdCapability|App[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type BetaTesterBetaGroupsLinkagesResponse record { + AppRelationshipsBetagroupsData[] data; + PagedDocumentLinks links; + PagingInformation meta?; +}; + +public type CertificateAttributes record { + string name?; + CertificateType certificateType?; + string displayName?; + string serialNumber?; + BundleIdPlatform platform?; + string expirationDate?; + string certificateContent?; +}; + +public type ProfilecreaterequestDataRelationships record { + BundleidcapabilitycreaterequestDataRelationshipsBundleid bundleId; + ProfilecreaterequestDataRelationshipsDevices devices?; + ProfilecreaterequestDataRelationshipsCertificates certificates; +}; + +public type BundleIdUpdateRequest record { + BundleidupdaterequestData data; +}; + +public type ApppreordercreaterequestData record { + string 'type; + ApppreordercreaterequestDataAttributes attributes?; + ApppreordercreaterequestDataRelationships relationships; +}; + +public type BundleId record { + string 'type; + string id; + BundleidAttributes attributes?; + BundleidRelationships relationships?; + ResourceLinks links; +}; + +public type BetagroupAttributes record { + string name?; + string createdDate?; + boolean isInternalGroup?; + boolean publicLinkEnabled?; + string publicLinkId?; + boolean publicLinkLimitEnabled?; + int publicLinkLimit?; + string publicLink?; + boolean feedbackEnabled?; +}; + +public type AppcategoryRelationshipsSubcategoriesData record { + string 'type; + string id; +}; + +public type DiagnosticsignatureAttributes record { + string diagnosticType?; + string signature?; + decimal weight?; +}; + +public type RoutingAppCoverageResponse record { + RoutingAppCoverage data; + DocumentLinks links; +}; + +public type AppPreOrderResponse record { + AppPreOrder data; + DocumentLinks links; +}; + +public type IdfadeclarationupdaterequestData record { + string 'type; + string id; + IdfadeclarationAttributes attributes?; +}; + +public type AppstoreversionupdaterequestData record { + string 'type; + string id; + AppstoreversionupdaterequestDataAttributes attributes?; + AppstoreversionupdaterequestDataRelationships relationships?; +}; + +public type AppCategoriesResponse record { + AppCategory[] data; + AppCategory|AppCategory[] included?; + PagedDocumentLinks links; + PagingInformation meta?; +};