openapi: 3.0.1 info: title: App Store Connect AccessibilityDeclarations Apps API version: 4.3.1 x-platforms: app_store_connect_api: App Store Connect API description: The App Store Connect API is the standards-based REST API Apple provides to automate tasks across App Store Connect, Xcode, and Certificates, Identifiers & Profiles. It covers apps, builds, TestFlight, in-app purchases, subscriptions, Game Center, Xcode Cloud, provisioning, pricing and availability, and the full reporting surface (analytics, sales and trends, financial reports, power and performance). This spec is the official OpenAPI 3.0 document published by Apple at https://developer.apple.com/app-store-connect/api/ — mirrored here unmodified except for title-cased operation summaries. servers: - url: https://api.appstoreconnect.apple.com/ security: - itc-bearer-token: [] tags: - name: Apps paths: /v1/apps: get: tags: - Apps operationId: apps_getCollection 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[bundleId] in: query description: filter by attribute 'bundleId' 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.appStoreState] in: query description: filter by attribute 'appStoreVersions.appStoreState' schema: type: array items: type: string enum: - ACCEPTED - 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_REVIEW - READY_FOR_SALE - REJECTED - REMOVED_FROM_SALE - WAITING_FOR_EXPORT_COMPLIANCE - WAITING_FOR_REVIEW - REPLACED_WITH_NEW_VERSION - NOT_APPLICABLE style: form explode: false required: false deprecated: true - name: filter[appStoreVersions.platform] in: query description: filter by attribute 'appStoreVersions.platform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS style: form explode: false required: false - name: filter[appStoreVersions.appVersionState] in: query description: filter by attribute 'appStoreVersions.appVersionState' schema: type: array items: type: string enum: - ACCEPTED - DEVELOPER_REJECTED - IN_REVIEW - INVALID_BINARY - METADATA_REJECTED - PENDING_APPLE_RELEASE - PENDING_DEVELOPER_RELEASE - PREPARE_FOR_SUBMISSION - PROCESSING_FOR_DISTRIBUTION - READY_FOR_DISTRIBUTION - READY_FOR_REVIEW - REJECTED - REPLACED_WITH_NEW_VERSION - WAITING_FOR_EXPORT_COMPLIANCE - WAITING_FOR_REVIEW style: form explode: false required: false - name: filter[reviewSubmissions.state] in: query description: filter by attribute 'reviewSubmissions.state' schema: type: array items: type: string enum: - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - UNRESOLVED_ISSUES - CANCELING - COMPLETING - COMPLETE style: form explode: false required: false - name: filter[reviewSubmissions.platform] in: query description: filter by attribute 'reviewSubmissions.platform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS 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: boolean style: form explode: false required: false deprecated: true - name: sort in: query description: comma-separated list of sort expressions; resources will be sorted as specified schema: type: array items: type: string enum: - name - -name - bundleId - -bundleId - 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails 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: - appDescription - createdDate - usesEncryption - exempt - containsProprietaryCryptography - containsThirdPartyCryptography - availableOnFrenchStore - platform - uploadedDate - documentUrl - documentName - documentType - appEncryptionDeclarationState - codeValue - app - builds - appEncryptionDeclarationDocument 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 - masked - name style: form explode: false required: false - name: fields[ciProducts] in: query description: the fields to include for returned resources of type ciProducts schema: type: array items: type: string enum: - name - createdDate - productType - app - bundleId - workflows - primaryRepositories - additionalRepositories - buildRuns 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: - name - createdDate - isInternalGroup - hasAccessToAllBuilds - publicLinkEnabled - publicLinkId - publicLinkLimitEnabled - publicLinkLimit - publicLink - feedbackEnabled - iosBuildsAvailableForAppleSiliconMac - iosBuildsAvailableForAppleVision - app - builds - betaTesters - betaRecruitmentCriteria - betaRecruitmentCriterionCompatibleBuildCheck 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: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage 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: - version - platform - builds - app 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: - feedbackEmail - marketingUrl - privacyPolicyUrl - tvOsPrivacyPolicy - description - locale - app 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: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures 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[betaAppReviewDetails] in: query description: the fields to include for returned resources of type betaAppReviewDetails schema: type: array items: type: string enum: - contactFirstName - contactLastName - contactPhone - contactEmail - demoAccountName - demoAccountPassword - demoAccountRequired - notes - app 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: - appStoreState - state - appStoreAgeRating - australiaAgeRating - brazilAgeRating - brazilAgeRatingV2 - franceAgeRating - koreaAgeRating - kidsAgeBand - app - ageRatingDeclaration - appInfoLocalizations - primaryCategory - primarySubcategoryOne - primarySubcategoryTwo - secondaryCategory - secondarySubcategoryOne - secondarySubcategoryTwo - territoryAgeRatings style: form explode: false required: false - name: fields[appClips] in: query description: the fields to include for returned resources of type appClips schema: type: array items: type: string enum: - bundleId - app - appClipDefaultExperiences - appClipAdvancedExperiences 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: fields[inAppPurchases] in: query description: the fields to include for returned resources of type inAppPurchases schema: type: array items: type: string enum: - referenceName - productId - inAppPurchaseType - state - apps - name - reviewNote - familySharable - contentHosting - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false required: false - name: fields[subscriptionGroups] in: query description: the fields to include for returned resources of type subscriptionGroups schema: type: array items: type: string enum: - referenceName - subscriptions - subscriptionGroupLocalizations 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: - platform - versionString - iconAsset - compatibleVersions - app style: form explode: false required: false deprecated: true - name: fields[appCustomProductPages] in: query description: the fields to include for returned resources of type appCustomProductPages schema: type: array items: type: string enum: - name - url - visible - app - appCustomProductPageVersions style: form explode: false required: false - name: fields[promotedPurchases] in: query description: the fields to include for returned resources of type promotedPurchases schema: type: array items: type: string enum: - visibleForAllUsers - enabled - state - inAppPurchaseV2 - subscription style: form explode: false required: false - name: fields[appEvents] in: query description: the fields to include for returned resources of type appEvents schema: type: array items: type: string enum: - referenceName - badge - eventState - deepLink - purchaseRequirement - primaryLocale - priority - purpose - territorySchedules - archivedTerritorySchedules - localizations style: form explode: false required: false - name: fields[reviewSubmissions] in: query description: the fields to include for returned resources of type reviewSubmissions schema: type: array items: type: string enum: - platform - submittedDate - state - app - items - appStoreVersionForReview - submittedByActor - lastUpdatedByActor style: form explode: false required: false - name: fields[subscriptionGracePeriods] in: query description: the fields to include for returned resources of type subscriptionGracePeriods schema: type: array items: type: string enum: - optIn - sandboxOptIn - duration - renewalType style: form explode: false required: false - name: fields[gameCenterDetails] in: query description: the fields to include for returned resources of type gameCenterDetails schema: type: array items: type: string enum: - arcadeEnabled - challengeEnabled - app - gameCenterAppVersions - gameCenterGroup - gameCenterLeaderboards - gameCenterLeaderboardsV2 - gameCenterLeaderboardSets - gameCenterLeaderboardSetsV2 - gameCenterAchievements - gameCenterAchievementsV2 - gameCenterActivities - gameCenterChallenges - defaultLeaderboard - defaultLeaderboardV2 - defaultGroupLeaderboard - defaultGroupLeaderboardV2 - achievementReleases - activityReleases - challengeReleases - leaderboardReleases - leaderboardSetReleases - challengesMinimumPlatformVersions style: form explode: false required: false - name: fields[appStoreVersionExperiments] in: query description: the fields to include for returned resources of type appStoreVersionExperiments schema: type: array items: type: string enum: - name - platform - trafficProportion - state - reviewRequired - startDate - endDate - app - latestControlVersion - controlVersions - appStoreVersionExperimentTreatments style: form explode: false required: false - name: fields[androidToIosAppMappingDetails] in: query description: the fields to include for returned resources of type androidToIosAppMappingDetails schema: type: array items: type: string enum: - packageName - appSigningKeyPublicCertificateSha256Fingerprints 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: - appEncryptionDeclarations - appStoreIcon - ciProduct - betaGroups - appStoreVersions - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - endUserLicenseAgreement - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - gameCenterDetail - appStoreVersionExperimentsV2 - androidToIosAppMappingDetails style: form explode: false required: false - name: limit[androidToIosAppMappingDetails] in: query description: maximum number of related androidToIosAppMappingDetails returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[appClips] in: query description: maximum number of related appClips returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[appCustomProductPages] in: query description: maximum number of related appCustomProductPages returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[appEncryptionDeclarations] in: query description: maximum number of related appEncryptionDeclarations returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[appEvents] in: query description: maximum number of related appEvents returned (when they are included) schema: type: integer maximum: 50 style: form 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[appStoreVersionExperimentsV2] in: query description: maximum number of related appStoreVersionExperimentsV2 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[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 deprecated: true - 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 deprecated: true - name: limit[inAppPurchasesV2] in: query description: maximum number of related inAppPurchasesV2 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[promotedPurchases] in: query description: maximum number of related promotedPurchases returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[reviewSubmissions] in: query description: maximum number of related reviewSubmissions returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[subscriptionGroups] in: query description: maximum number of related subscriptionGroups returned (when they are included) schema: type: integer maximum: 50 style: form required: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of Apps content: application/json: schema: $ref: '#/components/schemas/AppsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Apps /v1/apps/{id}: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_getInstance parameters: - name: fields[apps] in: query description: the fields to include for returned resources of type apps schema: type: array items: type: string enum: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails 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: - appDescription - createdDate - usesEncryption - exempt - containsProprietaryCryptography - containsThirdPartyCryptography - availableOnFrenchStore - platform - uploadedDate - documentUrl - documentName - documentType - appEncryptionDeclarationState - codeValue - app - builds - appEncryptionDeclarationDocument 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 - masked - name style: form explode: false required: false - name: fields[ciProducts] in: query description: the fields to include for returned resources of type ciProducts schema: type: array items: type: string enum: - name - createdDate - productType - app - bundleId - workflows - primaryRepositories - additionalRepositories - buildRuns 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: - name - createdDate - isInternalGroup - hasAccessToAllBuilds - publicLinkEnabled - publicLinkId - publicLinkLimitEnabled - publicLinkLimit - publicLink - feedbackEnabled - iosBuildsAvailableForAppleSiliconMac - iosBuildsAvailableForAppleVision - app - builds - betaTesters - betaRecruitmentCriteria - betaRecruitmentCriterionCompatibleBuildCheck 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: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage 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: - version - platform - builds - app 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: - feedbackEmail - marketingUrl - privacyPolicyUrl - tvOsPrivacyPolicy - description - locale - app 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: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures 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[betaAppReviewDetails] in: query description: the fields to include for returned resources of type betaAppReviewDetails schema: type: array items: type: string enum: - contactFirstName - contactLastName - contactPhone - contactEmail - demoAccountName - demoAccountPassword - demoAccountRequired - notes - app 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: - appStoreState - state - appStoreAgeRating - australiaAgeRating - brazilAgeRating - brazilAgeRatingV2 - franceAgeRating - koreaAgeRating - kidsAgeBand - app - ageRatingDeclaration - appInfoLocalizations - primaryCategory - primarySubcategoryOne - primarySubcategoryTwo - secondaryCategory - secondarySubcategoryOne - secondarySubcategoryTwo - territoryAgeRatings style: form explode: false required: false - name: fields[appClips] in: query description: the fields to include for returned resources of type appClips schema: type: array items: type: string enum: - bundleId - app - appClipDefaultExperiences - appClipAdvancedExperiences 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: fields[inAppPurchases] in: query description: the fields to include for returned resources of type inAppPurchases schema: type: array items: type: string enum: - referenceName - productId - inAppPurchaseType - state - apps - name - reviewNote - familySharable - contentHosting - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false required: false - name: fields[subscriptionGroups] in: query description: the fields to include for returned resources of type subscriptionGroups schema: type: array items: type: string enum: - referenceName - subscriptions - subscriptionGroupLocalizations 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: - platform - versionString - iconAsset - compatibleVersions - app style: form explode: false required: false deprecated: true - name: fields[appCustomProductPages] in: query description: the fields to include for returned resources of type appCustomProductPages schema: type: array items: type: string enum: - name - url - visible - app - appCustomProductPageVersions style: form explode: false required: false - name: fields[promotedPurchases] in: query description: the fields to include for returned resources of type promotedPurchases schema: type: array items: type: string enum: - visibleForAllUsers - enabled - state - inAppPurchaseV2 - subscription style: form explode: false required: false - name: fields[appEvents] in: query description: the fields to include for returned resources of type appEvents schema: type: array items: type: string enum: - referenceName - badge - eventState - deepLink - purchaseRequirement - primaryLocale - priority - purpose - territorySchedules - archivedTerritorySchedules - localizations style: form explode: false required: false - name: fields[reviewSubmissions] in: query description: the fields to include for returned resources of type reviewSubmissions schema: type: array items: type: string enum: - platform - submittedDate - state - app - items - appStoreVersionForReview - submittedByActor - lastUpdatedByActor style: form explode: false required: false - name: fields[subscriptionGracePeriods] in: query description: the fields to include for returned resources of type subscriptionGracePeriods schema: type: array items: type: string enum: - optIn - sandboxOptIn - duration - renewalType style: form explode: false required: false - name: fields[gameCenterDetails] in: query description: the fields to include for returned resources of type gameCenterDetails schema: type: array items: type: string enum: - arcadeEnabled - challengeEnabled - app - gameCenterAppVersions - gameCenterGroup - gameCenterLeaderboards - gameCenterLeaderboardsV2 - gameCenterLeaderboardSets - gameCenterLeaderboardSetsV2 - gameCenterAchievements - gameCenterAchievementsV2 - gameCenterActivities - gameCenterChallenges - defaultLeaderboard - defaultLeaderboardV2 - defaultGroupLeaderboard - defaultGroupLeaderboardV2 - achievementReleases - activityReleases - challengeReleases - leaderboardReleases - leaderboardSetReleases - challengesMinimumPlatformVersions style: form explode: false required: false - name: fields[appStoreVersionExperiments] in: query description: the fields to include for returned resources of type appStoreVersionExperiments schema: type: array items: type: string enum: - name - platform - trafficProportion - state - reviewRequired - startDate - endDate - app - latestControlVersion - controlVersions - appStoreVersionExperimentTreatments style: form explode: false required: false - name: fields[androidToIosAppMappingDetails] in: query description: the fields to include for returned resources of type androidToIosAppMappingDetails schema: type: array items: type: string enum: - packageName - appSigningKeyPublicCertificateSha256Fingerprints 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: - appEncryptionDeclarations - appStoreIcon - ciProduct - betaGroups - appStoreVersions - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - endUserLicenseAgreement - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - gameCenterDetail - appStoreVersionExperimentsV2 - androidToIosAppMappingDetails style: form explode: false required: false - name: limit[androidToIosAppMappingDetails] in: query description: maximum number of related androidToIosAppMappingDetails returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[appClips] in: query description: maximum number of related appClips returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[appCustomProductPages] in: query description: maximum number of related appCustomProductPages returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[appEncryptionDeclarations] in: query description: maximum number of related appEncryptionDeclarations returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[appEvents] in: query description: maximum number of related appEvents returned (when they are included) schema: type: integer maximum: 50 style: form 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[appStoreVersionExperimentsV2] in: query description: maximum number of related appStoreVersionExperimentsV2 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[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 deprecated: true - 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 deprecated: true - name: limit[inAppPurchasesV2] in: query description: maximum number of related inAppPurchasesV2 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[promotedPurchases] in: query description: maximum number of related promotedPurchases returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[reviewSubmissions] in: query description: maximum number of related reviewSubmissions returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[subscriptionGroups] in: query description: maximum number of related subscriptionGroups returned (when they are included) schema: type: integer maximum: 50 style: form required: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single App content: application/json: schema: $ref: '#/components/schemas/AppResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Apps patch: tags: - Apps operationId: apps_updateInstance requestBody: description: App representation content: application/json: schema: $ref: '#/components/schemas/AppUpdateRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single App content: application/json: schema: $ref: '#/components/schemas/AppResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Update Apps /v1/apps/{id}/relationships/accessibilityDeclarations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_accessibilityDeclarations_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAccessibilityDeclarationsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Accessibility Declarations /v1/apps/{id}/accessibilityDeclarations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_accessibilityDeclarations_getToManyRelated parameters: - name: filter[deviceFamily] in: query description: filter by attribute 'deviceFamily' schema: type: array items: type: string enum: - IPHONE - IPAD - APPLE_TV - APPLE_WATCH - MAC - VISION style: form explode: false - name: filter[state] in: query description: filter by attribute 'state' schema: type: array items: type: string enum: - DRAFT - PUBLISHED - REPLACED style: form explode: false - name: fields[accessibilityDeclarations] in: query description: the fields to include for returned resources of type accessibilityDeclarations schema: type: array items: type: string enum: - deviceFamily - state - supportsAudioDescriptions - supportsCaptions - supportsDarkInterface - supportsDifferentiateWithoutColorAlone - supportsLargerText - supportsReducedMotion - supportsSufficientContrast - supportsVoiceControl - supportsVoiceover style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AccessibilityDeclarations content: application/json: schema: $ref: '#/components/schemas/AccessibilityDeclarationsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Accessibility Declarations /v1/apps/{id}/relationships/alternativeDistributionKey: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_alternativeDistributionKey_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppAlternativeDistributionKeyLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Alternative Distribution Key /v1/apps/{id}/alternativeDistributionKey: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_alternativeDistributionKey_getToOneRelated parameters: - name: fields[alternativeDistributionKeys] in: query description: the fields to include for returned resources of type alternativeDistributionKeys schema: type: array items: type: string enum: - publicKey style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single AlternativeDistributionKey content: application/json: schema: $ref: '#/components/schemas/AlternativeDistributionKeyResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Alternative Distribution Key /v1/apps/{id}/relationships/analyticsReportRequests: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_analyticsReportRequests_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAnalyticsReportRequestsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Analytics Report Requests /v1/apps/{id}/analyticsReportRequests: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_analyticsReportRequests_getToManyRelated parameters: - name: filter[accessType] in: query description: filter by attribute 'accessType' schema: type: array items: type: string enum: - ONE_TIME_SNAPSHOT - ONGOING style: form explode: false - name: fields[analyticsReportRequests] in: query description: the fields to include for returned resources of type analyticsReportRequests schema: type: array items: type: string enum: - accessType - stoppedDueToInactivity - reports style: form explode: false - name: fields[analyticsReports] in: query description: the fields to include for returned resources of type analyticsReports schema: type: array items: type: string enum: - name - category - instances 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: - reports style: form explode: false - name: limit[reports] in: query description: maximum number of related reports returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AnalyticsReportRequests content: application/json: schema: $ref: '#/components/schemas/AnalyticsReportRequestsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Analytics Report Requests /v1/apps/{id}/relationships/androidToIosAppMappingDetails: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_androidToIosAppMappingDetails_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAndroidToIosAppMappingDetailsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Android to Ios App Mapping Details /v1/apps/{id}/androidToIosAppMappingDetails: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_androidToIosAppMappingDetails_getToManyRelated parameters: - name: fields[androidToIosAppMappingDetails] in: query description: the fields to include for returned resources of type androidToIosAppMappingDetails schema: type: array items: type: string enum: - packageName - appSigningKeyPublicCertificateSha256Fingerprints style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AndroidToIosAppMappingDetails content: application/json: schema: $ref: '#/components/schemas/AndroidToIosAppMappingDetailsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Android to Ios App Mapping Details /v1/apps/{id}/relationships/appAvailabilityV2: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appAvailabilityV2_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppAppAvailabilityV2LinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / App Availability V2 /v1/apps/{id}/appAvailabilityV2: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appAvailabilityV2_getToOneRelated parameters: - name: fields[appAvailabilities] in: query description: the fields to include for returned resources of type appAvailabilities schema: type: array items: type: string enum: - availableInNewTerritories - territoryAvailabilities style: form explode: false - name: fields[territoryAvailabilities] in: query description: the fields to include for returned resources of type territoryAvailabilities schema: type: array items: type: string enum: - available - releaseDate - preOrderEnabled - preOrderPublishDate - contentStatuses - territory style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - territoryAvailabilities style: form explode: false - name: limit[territoryAvailabilities] in: query description: maximum number of related territoryAvailabilities returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single AppAvailability content: application/json: schema: $ref: '#/components/schemas/AppAvailabilityV2Response' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / App Availability V2 /v1/apps/{id}/relationships/appClips: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appClips_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAppClipsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Clips /v1/apps/{id}/appClips: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appClips_getToManyRelated parameters: - name: filter[bundleId] in: query description: filter by attribute 'bundleId' schema: type: array items: type: string style: form explode: false - name: fields[appClips] in: query description: the fields to include for returned resources of type appClips schema: type: array items: type: string enum: - bundleId - app - appClipDefaultExperiences - appClipAdvancedExperiences 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false - name: fields[appClipDefaultExperiences] in: query description: the fields to include for returned resources of type appClipDefaultExperiences schema: type: array items: type: string enum: - action - appClip - releaseWithAppStoreVersion - appClipDefaultExperienceLocalizations - appClipAppStoreReviewDetail 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 - appClipDefaultExperiences style: form explode: false - name: limit[appClipDefaultExperiences] in: query description: maximum number of related appClipDefaultExperiences returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppClips content: application/json: schema: $ref: '#/components/schemas/AppClipsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Clips /v1/apps/{id}/relationships/appCustomProductPages: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appCustomProductPages_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAppCustomProductPagesLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Custom Product Pages /v1/apps/{id}/appCustomProductPages: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appCustomProductPages_getToManyRelated parameters: - name: filter[visible] in: query description: filter by attribute 'visible' schema: type: array items: type: string style: form explode: false - name: fields[appCustomProductPages] in: query description: the fields to include for returned resources of type appCustomProductPages schema: type: array items: type: string enum: - name - url - visible - app - appCustomProductPageVersions 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false - name: fields[appCustomProductPageVersions] in: query description: the fields to include for returned resources of type appCustomProductPageVersions schema: type: array items: type: string enum: - version - state - deepLink - appCustomProductPage - appCustomProductPageLocalizations 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 - appCustomProductPageVersions style: form explode: false - name: limit[appCustomProductPageVersions] in: query description: maximum number of related appCustomProductPageVersions returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppCustomProductPages content: application/json: schema: $ref: '#/components/schemas/AppCustomProductPagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Custom Product Pages /v1/apps/{id}/relationships/appEncryptionDeclarations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appEncryptionDeclarations_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAppEncryptionDeclarationsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Encryption Declarations /v1/apps/{id}/appEncryptionDeclarations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appEncryptionDeclarations_getToManyRelated parameters: - name: filter[platform] in: query description: filter by attribute 'platform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS style: form explode: false deprecated: true - name: filter[builds] in: query description: filter by id(s) of related 'builds' schema: type: array items: type: string style: form explode: false - name: fields[appEncryptionDeclarations] in: query description: the fields to include for returned resources of type appEncryptionDeclarations schema: type: array items: type: string enum: - appDescription - createdDate - usesEncryption - exempt - containsProprietaryCryptography - containsThirdPartyCryptography - availableOnFrenchStore - platform - uploadedDate - documentUrl - documentName - documentType - appEncryptionDeclarationState - codeValue - app - builds - appEncryptionDeclarationDocument 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails 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: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures style: form explode: false - name: fields[appEncryptionDeclarationDocuments] in: query description: the fields to include for returned resources of type appEncryptionDeclarationDocuments schema: type: array items: type: string enum: - fileSize - fileName - assetToken - downloadUrl - sourceFileChecksum - uploadOperations - assetDeliveryState 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 - builds - appEncryptionDeclarationDocument style: form explode: false - name: limit[builds] in: query description: maximum number of related builds returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppEncryptionDeclarations content: application/json: schema: $ref: '#/components/schemas/AppEncryptionDeclarationsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Encryption Declarations /v1/apps/{id}/relationships/appEvents: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appEvents_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAppEventsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Events /v1/apps/{id}/appEvents: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appEvents_getToManyRelated parameters: - name: filter[eventState] in: query description: filter by attribute 'eventState' schema: type: array items: type: string enum: - DRAFT - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - REJECTED - ACCEPTED - APPROVED - PUBLISHED - PAST - ARCHIVED 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[appEvents] in: query description: the fields to include for returned resources of type appEvents schema: type: array items: type: string enum: - referenceName - badge - eventState - deepLink - purchaseRequirement - primaryLocale - priority - purpose - territorySchedules - archivedTerritorySchedules - localizations style: form explode: false - name: fields[appEventLocalizations] in: query description: the fields to include for returned resources of type appEventLocalizations schema: type: array items: type: string enum: - locale - name - shortDescription - longDescription - appEvent - appEventScreenshots - appEventVideoClips 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: - localizations style: form explode: false - name: limit[localizations] in: query description: maximum number of related localizations returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppEvents content: application/json: schema: $ref: '#/components/schemas/AppEventsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Events /v1/apps/{id}/relationships/appInfos: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appInfos_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAppInfosLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Infos /v1/apps/{id}/appInfos: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appInfos_getToManyRelated parameters: - name: fields[appInfos] in: query description: the fields to include for returned resources of type appInfos schema: type: array items: type: string enum: - appStoreState - state - appStoreAgeRating - australiaAgeRating - brazilAgeRating - brazilAgeRatingV2 - franceAgeRating - koreaAgeRating - kidsAgeBand - app - ageRatingDeclaration - appInfoLocalizations - primaryCategory - primarySubcategoryOne - primarySubcategoryTwo - secondaryCategory - secondarySubcategoryOne - secondarySubcategoryTwo - territoryAgeRatings 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails 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: - advertising - alcoholTobaccoOrDrugUseOrReferences - contests - gambling - gamblingSimulated - gunsOrOtherWeapons - healthOrWellnessTopics - kidsAgeBand - lootBox - medicalOrTreatmentInformation - messagingAndChat - parentalControls - profanityOrCrudeHumor - ageAssurance - sexualContentGraphicAndNudity - sexualContentOrNudity - horrorOrFearThemes - matureOrSuggestiveThemes - unrestrictedWebAccess - userGeneratedContent - violenceCartoonOrFantasy - violenceRealisticProlongedGraphicOrSadistic - violenceRealistic - ageRatingOverride - ageRatingOverrideV2 - koreaAgeRatingOverride - developerAgeRatingInfoUrl 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: - locale - name - subtitle - privacyPolicyUrl - privacyChoicesUrl - privacyPolicyText - appInfo 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: - platforms - subcategories - parent 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 - ageRatingDeclaration - appInfoLocalizations - primaryCategory - primarySubcategoryOne - primarySubcategoryTwo - secondaryCategory - secondarySubcategoryOne - secondarySubcategoryTwo style: form explode: false - name: limit[appInfoLocalizations] in: query description: maximum number of related appInfoLocalizations returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppInfos content: application/json: schema: $ref: '#/components/schemas/AppInfosResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Infos /v1/apps/{id}/relationships/appPricePoints: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appPricePoints_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAppPricePointsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Price Points /v1/apps/{id}/appPricePoints: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appPricePoints_getToManyRelated parameters: - name: filter[territory] in: query description: filter by id(s) of related 'territory' schema: type: array items: type: string style: form explode: 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 - proceeds - app - equalizations - territory 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: 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 - 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 - territory style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppPricePoints content: application/json: schema: $ref: '#/components/schemas/AppPricePointsV3Response' text/csv: schema: $ref: '#/components/schemas/csv' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Price Points /v1/apps/{id}/relationships/appPriceSchedule: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appPriceSchedule_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppAppPriceScheduleLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / App Price Schedule /v1/apps/{id}/appPriceSchedule: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appPriceSchedule_getToOneRelated parameters: - name: fields[appPriceSchedules] in: query description: the fields to include for returned resources of type appPriceSchedules schema: type: array items: type: string enum: - app - baseTerritory - manualPrices - automaticPrices 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: 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 - name: fields[appPrices] in: query description: the fields to include for returned resources of type appPrices schema: type: array items: type: string enum: - manual - startDate - endDate - appPricePoint - territory style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - app - baseTerritory - manualPrices - automaticPrices style: form explode: false - name: limit[manualPrices] in: query description: maximum number of related manualPrices returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[automaticPrices] in: query description: maximum number of related automaticPrices returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single AppPriceSchedule content: application/json: schema: $ref: '#/components/schemas/AppPriceScheduleResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / App Price Schedule /v1/apps/{id}/relationships/appStoreVersionExperimentsV2: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appStoreVersionExperimentsV2_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAppStoreVersionExperimentsV2LinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Store Version Experiments V2 /v1/apps/{id}/appStoreVersionExperimentsV2: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appStoreVersionExperimentsV2_getToManyRelated parameters: - name: filter[state] in: query description: filter by attribute 'state' schema: type: array items: type: string enum: - PREPARE_FOR_SUBMISSION - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - ACCEPTED - APPROVED - REJECTED - COMPLETED - STOPPED style: form explode: false - name: fields[appStoreVersionExperiments] in: query description: the fields to include for returned resources of type appStoreVersionExperiments schema: type: array items: type: string enum: - name - platform - trafficProportion - state - reviewRequired - startDate - endDate - app - latestControlVersion - controlVersions - appStoreVersionExperimentTreatments 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails 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: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: fields[appStoreVersionExperimentTreatments] in: query description: the fields to include for returned resources of type appStoreVersionExperimentTreatments schema: type: array items: type: string enum: - name - appIcon - appIconName - promotedDate - appStoreVersionExperiment - appStoreVersionExperimentV2 - appStoreVersionExperimentTreatmentLocalizations 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 - latestControlVersion - controlVersions - appStoreVersionExperimentTreatments style: form explode: false - name: limit[controlVersions] in: query description: maximum number of related controlVersions returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[appStoreVersionExperimentTreatments] in: query description: maximum number of related appStoreVersionExperimentTreatments returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppStoreVersionExperiments content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentsV2Response' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Store Version Experiments V2 /v1/apps/{id}/relationships/appStoreVersions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appStoreVersions_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAppStoreVersionsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Store Versions /v1/apps/{id}/appStoreVersions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appStoreVersions_getToManyRelated parameters: - name: filter[platform] in: query description: filter by attribute 'platform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_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[appStoreState] in: query description: filter by attribute 'appStoreState' schema: type: array items: type: string enum: - ACCEPTED - 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_REVIEW - READY_FOR_SALE - REJECTED - REMOVED_FROM_SALE - WAITING_FOR_EXPORT_COMPLIANCE - WAITING_FOR_REVIEW - REPLACED_WITH_NEW_VERSION - NOT_APPLICABLE style: form explode: false deprecated: true - name: filter[appVersionState] in: query description: filter by attribute 'appVersionState' schema: type: array items: type: string enum: - ACCEPTED - DEVELOPER_REJECTED - IN_REVIEW - INVALID_BINARY - METADATA_REJECTED - PENDING_APPLE_RELEASE - PENDING_DEVELOPER_RELEASE - PREPARE_FOR_SUBMISSION - PROCESSING_FOR_DISTRIBUTION - READY_FOR_DISTRIBUTION - READY_FOR_REVIEW - REJECTED - REPLACED_WITH_NEW_VERSION - WAITING_FOR_EXPORT_COMPLIANCE - WAITING_FOR_REVIEW 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[appStoreVersions] in: query description: the fields to include for returned resources of type appStoreVersions schema: type: array items: type: string enum: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false - name: fields[appStoreVersionLocalizations] in: query description: the fields to include for returned resources of type appStoreVersionLocalizations schema: type: array items: type: string enum: - description - locale - keywords - marketingUrl - promotionalText - supportUrl - whatsNew - appStoreVersion - appScreenshotSets - appPreviewSets - searchKeywords 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: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures 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: - phasedReleaseState - startDate - totalPauseDuration - currentDayNumber style: form explode: false - name: fields[gameCenterAppVersions] in: query description: the fields to include for returned resources of type gameCenterAppVersions schema: type: array items: type: string enum: - enabled - compatibilityVersions - appStoreVersion 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: - fileSize - fileName - sourceFileChecksum - uploadOperations - assetDeliveryState - appStoreVersion 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: - contactFirstName - contactLastName - contactPhone - contactEmail - demoAccountName - demoAccountPassword - demoAccountRequired - notes - appStoreVersion - appStoreReviewAttachments 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[appClipDefaultExperiences] in: query description: the fields to include for returned resources of type appClipDefaultExperiences schema: type: array items: type: string enum: - action - appClip - releaseWithAppStoreVersion - appClipDefaultExperienceLocalizations - appClipAppStoreReviewDetail style: form explode: false - name: fields[appStoreVersionExperiments] in: query description: the fields to include for returned resources of type appStoreVersionExperiments schema: type: array items: type: string enum: - name - trafficProportion - state - reviewRequired - startDate - endDate - appStoreVersion - appStoreVersionExperimentTreatments - platform - app - latestControlVersion - controlVersions style: form explode: false - name: fields[alternativeDistributionPackages] in: query description: the fields to include for returned resources of type alternativeDistributionPackages schema: type: array items: type: string enum: - sourceFileChecksum - versions 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 - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - alternativeDistributionPackage style: form explode: false - name: limit[appStoreVersionLocalizations] in: query description: maximum number of related appStoreVersionLocalizations returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[appStoreVersionExperiments] in: query description: maximum number of related appStoreVersionExperiments returned (when they are included) schema: type: integer maximum: 50 style: form deprecated: true - name: limit[appStoreVersionExperimentsV2] in: query description: maximum number of related appStoreVersionExperimentsV2 returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppStoreVersions content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Store Versions /v1/apps/{id}/relationships/appTags: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appTags_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppAppTagsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Tags /v1/apps/{id}/appTags: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_appTags_getToManyRelated parameters: - name: filter[visibleInAppStore] in: query description: filter by attribute 'visibleInAppStore' 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: - name - -name style: form explode: false - name: fields[appTags] in: query description: the fields to include for returned resources of type appTags schema: type: array items: type: string enum: - name - visibleInAppStore - territories style: form explode: 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 - 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: - territories style: form explode: false - name: limit[territories] in: query description: maximum number of related territories returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppTags content: application/json: schema: $ref: '#/components/schemas/AppTagsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / App Tags /v1/apps/{id}/relationships/backgroundAssets: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_backgroundAssets_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppBackgroundAssetsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Background Assets /v1/apps/{id}/backgroundAssets: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_backgroundAssets_getToManyRelated parameters: - name: filter[archived] in: query description: filter by attribute 'archived' schema: type: array items: type: string style: form explode: false - name: filter[assetPackIdentifier] in: query description: filter by attribute 'assetPackIdentifier' schema: type: array items: type: string style: form explode: false - name: filter[versions.platforms] in: query description: filter by attribute 'versions.platforms' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS 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: - assetPackIdentifier - -assetPackIdentifier - createdDate - -createdDate style: form explode: false - name: fields[backgroundAssets] in: query description: the fields to include for returned resources of type backgroundAssets schema: type: array items: type: string enum: - archived - assetPackIdentifier - createdDate - usedBytes - app - versions - appStoreVersion - internalBetaVersion - externalBetaVersion 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false - name: fields[backgroundAssetVersions] in: query description: the fields to include for returned resources of type backgroundAssetVersions schema: type: array items: type: string enum: - createdDate - platforms - state - stateDetails - version - backgroundAsset - internalBetaRelease - externalBetaRelease - appStoreRelease - assetFile - manifestFile - backgroundAssetUploadFiles 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 - appStoreVersion - internalBetaVersion - externalBetaVersion style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of BackgroundAssets content: application/json: schema: $ref: '#/components/schemas/BackgroundAssetsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Background Assets /v1/apps/{id}/relationships/betaAppLocalizations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaAppLocalizations_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppBetaAppLocalizationsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Beta App Localizations /v1/apps/{id}/betaAppLocalizations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaAppLocalizations_getToManyRelated parameters: - name: fields[betaAppLocalizations] in: query description: the fields to include for returned resources of type betaAppLocalizations schema: type: array items: type: string enum: - feedbackEmail - marketingUrl - privacyPolicyUrl - tvOsPrivacyPolicy - description - locale - app style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of BetaAppLocalizations with get content: application/json: schema: $ref: '#/components/schemas/BetaAppLocalizationsWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Beta App Localizations /v1/apps/{id}/relationships/betaAppReviewDetail: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaAppReviewDetail_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppBetaAppReviewDetailLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Beta App Review Detail /v1/apps/{id}/betaAppReviewDetail: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaAppReviewDetail_getToOneRelated parameters: - name: fields[betaAppReviewDetails] in: query description: the fields to include for returned resources of type betaAppReviewDetails schema: type: array items: type: string enum: - contactFirstName - contactLastName - contactPhone - contactEmail - demoAccountName - demoAccountPassword - demoAccountRequired - notes - app style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single BetaAppReviewDetail with get content: application/json: schema: $ref: '#/components/schemas/BetaAppReviewDetailWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Beta App Review Detail /v1/apps/{id}/relationships/betaFeedbackCrashSubmissions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaFeedbackCrashSubmissions_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppBetaFeedbackCrashSubmissionsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Beta Feedback Crash Submissions /v1/apps/{id}/betaFeedbackCrashSubmissions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaFeedbackCrashSubmissions_getToManyRelated parameters: - name: filter[deviceModel] in: query description: filter by attribute 'deviceModel' schema: type: array items: type: string style: form explode: false - name: filter[osVersion] in: query description: filter by attribute 'osVersion' schema: type: array items: type: string style: form explode: false - name: filter[appPlatform] in: query description: filter by attribute 'appPlatform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS style: form explode: false - name: filter[devicePlatform] in: query description: filter by attribute 'devicePlatform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS style: form explode: false - name: filter[build] in: query description: filter by id(s) of related 'build' schema: type: array items: type: string style: form explode: false - name: filter[build.preReleaseVersion] in: query description: filter by id(s) of related 'build.preReleaseVersion' schema: type: array items: type: string style: form explode: false - name: filter[tester] in: query description: filter by id(s) of related 'tester' schema: type: array items: type: string style: form explode: false - name: sort in: query description: comma-separated list of sort expressions; resources will be sorted as specified schema: type: array items: type: string enum: - createdDate - -createdDate style: form explode: false - name: fields[betaFeedbackCrashSubmissions] in: query description: the fields to include for returned resources of type betaFeedbackCrashSubmissions schema: type: array items: type: string enum: - createdDate - comment - email - deviceModel - osVersion - locale - timeZone - architecture - connectionType - pairedAppleWatch - appUptimeInMilliseconds - diskBytesAvailable - diskBytesTotal - batteryPercentage - screenWidthInPoints - screenHeightInPoints - appPlatform - devicePlatform - deviceFamily - buildBundleId - crashLog - build - tester 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: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures style: form explode: false - name: fields[betaTesters] in: query description: the fields to include for returned resources of type betaTesters schema: type: array items: type: string enum: - firstName - lastName - email - inviteType - state - appDevices - apps - betaGroups - builds 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: - build - tester style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of BetaFeedbackCrashSubmissions content: application/json: schema: $ref: '#/components/schemas/BetaFeedbackCrashSubmissionsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Beta Feedback Crash Submissions /v1/apps/{id}/relationships/betaFeedbackScreenshotSubmissions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaFeedbackScreenshotSubmissions_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppBetaFeedbackScreenshotSubmissionsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Beta Feedback Screenshot Submissions /v1/apps/{id}/betaFeedbackScreenshotSubmissions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaFeedbackScreenshotSubmissions_getToManyRelated parameters: - name: filter[deviceModel] in: query description: filter by attribute 'deviceModel' schema: type: array items: type: string style: form explode: false - name: filter[osVersion] in: query description: filter by attribute 'osVersion' schema: type: array items: type: string style: form explode: false - name: filter[appPlatform] in: query description: filter by attribute 'appPlatform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS style: form explode: false - name: filter[devicePlatform] in: query description: filter by attribute 'devicePlatform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS style: form explode: false - name: filter[build] in: query description: filter by id(s) of related 'build' schema: type: array items: type: string style: form explode: false - name: filter[build.preReleaseVersion] in: query description: filter by id(s) of related 'build.preReleaseVersion' schema: type: array items: type: string style: form explode: false - name: filter[tester] in: query description: filter by id(s) of related 'tester' schema: type: array items: type: string style: form explode: false - name: sort in: query description: comma-separated list of sort expressions; resources will be sorted as specified schema: type: array items: type: string enum: - createdDate - -createdDate style: form explode: false - name: fields[betaFeedbackScreenshotSubmissions] in: query description: the fields to include for returned resources of type betaFeedbackScreenshotSubmissions schema: type: array items: type: string enum: - createdDate - comment - email - deviceModel - osVersion - locale - timeZone - architecture - connectionType - pairedAppleWatch - appUptimeInMilliseconds - diskBytesAvailable - diskBytesTotal - batteryPercentage - screenWidthInPoints - screenHeightInPoints - appPlatform - devicePlatform - deviceFamily - buildBundleId - screenshots - build - tester 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: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures style: form explode: false - name: fields[betaTesters] in: query description: the fields to include for returned resources of type betaTesters schema: type: array items: type: string enum: - firstName - lastName - email - inviteType - state - appDevices - apps - betaGroups - builds 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: - build - tester style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of BetaFeedbackScreenshotSubmissions content: application/json: schema: $ref: '#/components/schemas/BetaFeedbackScreenshotSubmissionsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Beta Feedback Screenshot Submissions /v1/apps/{id}/relationships/betaGroups: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaGroups_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppBetaGroupsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Beta Groups /v1/apps/{id}/betaGroups: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaGroups_getToManyRelated parameters: - name: fields[betaGroups] in: query description: the fields to include for returned resources of type betaGroups schema: type: array items: type: string enum: - name - createdDate - isInternalGroup - hasAccessToAllBuilds - publicLinkEnabled - publicLinkId - publicLinkLimitEnabled - publicLinkLimit - publicLink - feedbackEnabled - iosBuildsAvailableForAppleSiliconMac - iosBuildsAvailableForAppleVision - app - builds - betaTesters - betaRecruitmentCriteria - betaRecruitmentCriterionCompatibleBuildCheck style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of BetaGroups with get content: application/json: schema: $ref: '#/components/schemas/BetaGroupsWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Beta Groups /v1/apps/{id}/relationships/betaLicenseAgreement: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaLicenseAgreement_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppBetaLicenseAgreementLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Beta License Agreement /v1/apps/{id}/betaLicenseAgreement: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaLicenseAgreement_getToOneRelated 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: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single BetaLicenseAgreement with get content: application/json: schema: $ref: '#/components/schemas/BetaLicenseAgreementWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Beta License Agreement /v1/apps/{id}/relationships/betaTesters: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true delete: tags: - Apps operationId: apps_betaTesters_deleteToManyRelationship requestBody: description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppBetaTestersLinkagesRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '202': description: Accepted for future completion '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Remove Related Apps / Beta Testers /v1/apps/{id}/relationships/buildUploads: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_buildUploads_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppBuildUploadsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Build Uploads /v1/apps/{id}/buildUploads: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_buildUploads_getToManyRelated parameters: - name: filter[cfBundleShortVersionString] in: query description: filter by attribute 'cfBundleShortVersionString' schema: type: array items: type: string style: form explode: false - name: filter[cfBundleVersion] in: query description: filter by attribute 'cfBundleVersion' schema: type: array items: type: string 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 - VISION_OS style: form explode: false - name: filter[state] in: query description: filter by state 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: - cfBundleVersion - -cfBundleVersion - uploadedDate - -uploadedDate style: form explode: false - name: fields[buildUploads] in: query description: the fields to include for returned resources of type buildUploads schema: type: array items: type: string enum: - cfBundleShortVersionString - cfBundleVersion - createdDate - state - platform - uploadedDate - build - assetFile - assetDescriptionFile - assetSpiFile - buildUploadFiles 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: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures style: form explode: false - name: fields[buildUploadFiles] in: query description: the fields to include for returned resources of type buildUploadFiles schema: type: array items: type: string enum: - assetDeliveryState - assetToken - assetType - fileName - fileSize - sourceFileChecksums - uploadOperations - uti 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: - build - assetFile - assetDescriptionFile - assetSpiFile style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of BuildUploads content: application/json: schema: $ref: '#/components/schemas/BuildUploadsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Build Uploads /v1/apps/{id}/relationships/builds: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_builds_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppBuildsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Builds /v1/apps/{id}/builds: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_builds_getToManyRelated parameters: - name: fields[builds] in: query description: the fields to include for returned resources of type builds schema: type: array items: type: string enum: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of Builds with get content: application/json: schema: $ref: '#/components/schemas/BuildsWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Builds /v1/apps/{id}/relationships/ciProduct: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_ciProduct_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppCiProductLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Ci Product /v1/apps/{id}/ciProduct: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_ciProduct_getToOneRelated parameters: - name: fields[ciProducts] in: query description: the fields to include for returned resources of type ciProducts schema: type: array items: type: string enum: - name - createdDate - productType - app - bundleId - workflows - primaryRepositories - additionalRepositories - buildRuns 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false - name: fields[bundleIds] in: query description: the fields to include for returned resources of type bundleIds schema: type: array items: type: string enum: - name - platform - identifier - seedId - profiles - bundleIdCapabilities - app style: form explode: false - name: fields[scmRepositories] in: query description: the fields to include for returned resources of type scmRepositories schema: type: array items: type: string enum: - lastAccessedDate - httpCloneUrl - sshCloneUrl - ownerName - repositoryName - scmProvider - defaultBranch - gitReferences - pullRequests style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - app - bundleId - primaryRepositories style: form explode: false - name: limit[primaryRepositories] in: query description: maximum number of related primaryRepositories returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single CiProduct content: application/json: schema: $ref: '#/components/schemas/CiProductResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Ci Product /v1/apps/{id}/customerReviewSummarizations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_customerReviewSummarizations_getToManyRelated parameters: - name: filter[platform] in: query description: filter by attribute 'platform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS style: form explode: false required: true - name: filter[territory] in: query description: filter by id(s) of related 'territory' schema: type: array items: type: string style: form explode: false - name: fields[customerReviewSummarizations] in: query description: the fields to include for returned resources of type customerReviewSummarizations schema: type: array items: type: string enum: - createdDate - locale - platform - text - territory style: form explode: 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 - 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: - territory style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of CustomerReviewSummarizations content: application/json: schema: $ref: '#/components/schemas/CustomerReviewSummarizationsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Customer Review Summarizations /v1/apps/{id}/relationships/customerReviews: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_customerReviews_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppCustomerReviewsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Customer Reviews /v1/apps/{id}/customerReviews: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_customerReviews_getToManyRelated parameters: - name: filter[territory] in: query description: filter by attribute 'territory' schema: type: array items: type: string enum: - ABW - AFG - AGO - AIA - ALB - AND - ANT - ARE - ARG - ARM - ASM - ATG - AUS - AUT - AZE - BDI - BEL - BEN - BES - BFA - BGD - BGR - BHR - BHS - BIH - BLR - BLZ - BMU - BOL - BRA - BRB - BRN - BTN - BWA - CAF - CAN - CHE - CHL - CHN - CIV - CMR - COD - COG - COK - COL - COM - CPV - CRI - CUB - CUW - CXR - CYM - CYP - CZE - DEU - DJI - DMA - DNK - DOM - DZA - ECU - EGY - ERI - ESP - EST - ETH - FIN - FJI - FLK - FRA - FRO - FSM - GAB - GBR - GEO - GGY - GHA - GIB - GIN - GLP - GMB - GNB - GNQ - GRC - GRD - GRL - GTM - GUF - GUM - GUY - HKG - HND - HRV - HTI - HUN - IDN - IMN - IND - IRL - IRQ - ISL - ISR - ITA - JAM - JEY - JOR - JPN - KAZ - KEN - KGZ - KHM - KIR - KNA - KOR - KWT - LAO - LBN - LBR - LBY - LCA - LIE - LKA - LSO - LTU - LUX - LVA - MAC - MAR - MCO - MDA - MDG - MDV - MEX - MHL - MKD - MLI - MLT - MMR - MNE - MNG - MNP - MOZ - MRT - MSR - MTQ - MUS - MWI - MYS - MYT - NAM - NCL - NER - NFK - NGA - NIC - NIU - NLD - NOR - NPL - NRU - NZL - OMN - PAK - PAN - PER - PHL - PLW - PNG - POL - PRI - PRT - PRY - PSE - PYF - QAT - REU - ROU - RUS - RWA - SAU - SEN - SGP - SHN - SLB - SLE - SLV - SMR - SOM - SPM - SRB - SSD - STP - SUR - SVK - SVN - SWE - SWZ - SXM - SYC - TCA - TCD - TGO - THA - TJK - TKM - TLS - TON - TTO - TUN - TUR - TUV - TWN - TZA - UGA - UKR - UMI - URY - USA - UZB - VAT - VCT - VEN - VGB - VIR - VNM - VUT - WLF - WSM - XKS - YEM - ZAF - ZMB - ZWE style: form explode: false - name: filter[rating] in: query description: filter by attribute 'rating' schema: type: array items: type: string style: form explode: false - name: filter[reviewTerritory] in: query description: filter by id(s) of related 'reviewTerritory' schema: type: array items: type: string style: form explode: false - name: exists[publishedResponse] in: query description: filter by publishedResponse schema: type: boolean 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: - rating - -rating - createdDate - -createdDate style: form explode: false - name: fields[customerReviews] in: query description: the fields to include for returned resources of type customerReviews schema: type: array items: type: string enum: - rating - title - body - reviewerNickname - createdDate - territory - response - reviewTerritory style: form explode: false - name: fields[customerReviewResponses] in: query description: the fields to include for returned resources of type customerReviewResponses schema: type: array items: type: string enum: - responseBody - lastModifiedDate - state - review style: form explode: 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 - 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: - response - reviewTerritory style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of CustomerReviews content: application/json: schema: $ref: '#/components/schemas/CustomerReviewsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Customer Reviews /v1/apps/{id}/relationships/endUserLicenseAgreement: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_endUserLicenseAgreement_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppEndUserLicenseAgreementLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / End User License Agreement /v1/apps/{id}/endUserLicenseAgreement: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_endUserLicenseAgreement_getToOneRelated 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: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single EndUserLicenseAgreement with get content: application/json: schema: $ref: '#/components/schemas/EndUserLicenseAgreementWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / End User License Agreement /v1/apps/{id}/relationships/gameCenterDetail: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_gameCenterDetail_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppGameCenterDetailLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Game Center Detail /v1/apps/{id}/gameCenterDetail: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_gameCenterDetail_getToOneRelated parameters: - name: fields[gameCenterDetails] in: query description: the fields to include for returned resources of type gameCenterDetails schema: type: array items: type: string enum: - arcadeEnabled - challengeEnabled - app - gameCenterAppVersions - gameCenterGroup - gameCenterLeaderboards - gameCenterLeaderboardsV2 - gameCenterLeaderboardSets - gameCenterLeaderboardSetsV2 - gameCenterAchievements - gameCenterAchievementsV2 - gameCenterActivities - gameCenterChallenges - defaultLeaderboard - defaultLeaderboardV2 - defaultGroupLeaderboard - defaultGroupLeaderboardV2 - achievementReleases - activityReleases - challengeReleases - leaderboardReleases - leaderboardSetReleases - challengesMinimumPlatformVersions 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false - name: fields[gameCenterAppVersions] in: query description: the fields to include for returned resources of type gameCenterAppVersions schema: type: array items: type: string enum: - enabled - compatibilityVersions - appStoreVersion style: form explode: false - name: fields[gameCenterGroups] in: query description: the fields to include for returned resources of type gameCenterGroups schema: type: array items: type: string enum: - referenceName - gameCenterDetails - gameCenterLeaderboards - gameCenterLeaderboardsV2 - gameCenterLeaderboardSets - gameCenterLeaderboardSetsV2 - gameCenterAchievements - gameCenterAchievementsV2 - gameCenterActivities - gameCenterChallenges style: form explode: false - name: fields[gameCenterLeaderboards] in: query description: the fields to include for returned resources of type gameCenterLeaderboards schema: type: array items: type: string enum: - defaultFormatter - referenceName - vendorIdentifier - submissionType - scoreSortType - scoreRangeStart - scoreRangeEnd - recurrenceStartDate - recurrenceDuration - recurrenceRule - archived - activityProperties - visibility - gameCenterDetail - gameCenterGroup - groupLeaderboard - gameCenterLeaderboardSets - localizations - releases - activity - challenge - versions style: form explode: false - name: fields[gameCenterLeaderboardSets] in: query description: the fields to include for returned resources of type gameCenterLeaderboardSets schema: type: array items: type: string enum: - referenceName - vendorIdentifier - gameCenterDetail - gameCenterGroup - groupLeaderboardSet - localizations - gameCenterLeaderboards - releases - versions style: form explode: false - name: fields[gameCenterAchievements] in: query description: the fields to include for returned resources of type gameCenterAchievements schema: type: array items: type: string enum: - referenceName - vendorIdentifier - points - showBeforeEarned - repeatable - archived - activityProperties - gameCenterDetail - gameCenterGroup - groupAchievement - localizations - releases - activity - versions style: form explode: false - name: fields[gameCenterActivities] in: query description: the fields to include for returned resources of type gameCenterActivities schema: type: array items: type: string enum: - referenceName - vendorIdentifier - playStyle - minimumPlayersCount - maximumPlayersCount - supportsPartyCode - archived - properties - gameCenterDetail - gameCenterGroup - achievements - achievementsV2 - leaderboards - leaderboardsV2 - versions style: form explode: false - name: fields[gameCenterChallenges] in: query description: the fields to include for returned resources of type gameCenterChallenges schema: type: array items: type: string enum: - referenceName - vendorIdentifier - archived - challengeType - repeatable - gameCenterDetail - gameCenterGroup - versions - leaderboard - leaderboardV2 style: form explode: false - name: fields[gameCenterAchievementReleases] in: query description: the fields to include for returned resources of type gameCenterAchievementReleases schema: type: array items: type: string enum: - live - gameCenterDetail - gameCenterAchievement style: form explode: false - name: fields[gameCenterActivityVersionReleases] in: query description: the fields to include for returned resources of type gameCenterActivityVersionReleases schema: type: array items: type: string enum: - version style: form explode: false - name: fields[gameCenterChallengeVersionReleases] in: query description: the fields to include for returned resources of type gameCenterChallengeVersionReleases schema: type: array items: type: string enum: - version style: form explode: false - name: fields[gameCenterLeaderboardReleases] in: query description: the fields to include for returned resources of type gameCenterLeaderboardReleases schema: type: array items: type: string enum: - live - gameCenterDetail - gameCenterLeaderboard style: form explode: false - name: fields[gameCenterLeaderboardSetReleases] in: query description: the fields to include for returned resources of type gameCenterLeaderboardSetReleases schema: type: array items: type: string enum: - live - gameCenterDetail - gameCenterLeaderboardSet 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: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - app - gameCenterAppVersions - gameCenterGroup - gameCenterLeaderboards - gameCenterLeaderboardsV2 - gameCenterLeaderboardSets - gameCenterLeaderboardSetsV2 - gameCenterAchievements - gameCenterAchievementsV2 - gameCenterActivities - gameCenterChallenges - defaultLeaderboard - defaultLeaderboardV2 - defaultGroupLeaderboard - defaultGroupLeaderboardV2 - achievementReleases - activityReleases - challengeReleases - leaderboardReleases - leaderboardSetReleases - challengesMinimumPlatformVersions style: form explode: false - name: limit[gameCenterAppVersions] in: query description: maximum number of related gameCenterAppVersions returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[gameCenterLeaderboards] in: query description: maximum number of related gameCenterLeaderboards returned (when they are included) schema: type: integer maximum: 50 style: form deprecated: true - name: limit[gameCenterLeaderboardsV2] in: query description: maximum number of related gameCenterLeaderboardsV2 returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[gameCenterLeaderboardSets] in: query description: maximum number of related gameCenterLeaderboardSets returned (when they are included) schema: type: integer maximum: 50 style: form deprecated: true - name: limit[gameCenterLeaderboardSetsV2] in: query description: maximum number of related gameCenterLeaderboardSetsV2 returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[gameCenterAchievements] in: query description: maximum number of related gameCenterAchievements returned (when they are included) schema: type: integer maximum: 50 style: form deprecated: true - name: limit[gameCenterAchievementsV2] in: query description: maximum number of related gameCenterAchievementsV2 returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[gameCenterActivities] in: query description: maximum number of related gameCenterActivities returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[gameCenterChallenges] in: query description: maximum number of related gameCenterChallenges returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[achievementReleases] in: query description: maximum number of related achievementReleases returned (when they are included) schema: type: integer maximum: 50 style: form deprecated: true - name: limit[activityReleases] in: query description: maximum number of related activityReleases returned (when they are included) schema: type: integer maximum: 50 style: form deprecated: true - name: limit[challengeReleases] in: query description: maximum number of related challengeReleases returned (when they are included) schema: type: integer maximum: 50 style: form deprecated: true - name: limit[leaderboardReleases] in: query description: maximum number of related leaderboardReleases returned (when they are included) schema: type: integer maximum: 50 style: form deprecated: true - name: limit[leaderboardSetReleases] in: query description: maximum number of related leaderboardSetReleases returned (when they are included) schema: type: integer maximum: 50 style: form deprecated: true - name: limit[challengesMinimumPlatformVersions] in: query description: maximum number of related challengesMinimumPlatformVersions returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single GameCenterDetail content: application/json: schema: $ref: '#/components/schemas/GameCenterDetailResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Game Center Detail /v1/apps/{id}/relationships/gameCenterEnabledVersions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_gameCenterEnabledVersions_getToManyRelationship deprecated: true parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppGameCenterEnabledVersionsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Game Center Enabled Versions /v1/apps/{id}/gameCenterEnabledVersions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_gameCenterEnabledVersions_getToManyRelated deprecated: true parameters: - name: filter[platform] in: query description: filter by attribute 'platform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_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: - platform - versionString - iconAsset - compatibleVersions - app 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails 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: - compatibleVersions - app style: form explode: false - name: limit[compatibleVersions] in: query description: maximum number of related compatibleVersions returned (when they are included) schema: type: integer maximum: 50 style: form deprecated: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of GameCenterEnabledVersions content: application/json: schema: $ref: '#/components/schemas/GameCenterEnabledVersionsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Game Center Enabled Versions /v1/apps/{id}/relationships/inAppPurchases: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_inAppPurchases_getToManyRelationship deprecated: true parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppInAppPurchasesLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / in App Purchases /v1/apps/{id}/inAppPurchases: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_inAppPurchases_getToManyRelated deprecated: true 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: - referenceName - -referenceName - productId - -productId - inAppPurchaseType - -inAppPurchaseType 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: - referenceName - productId - inAppPurchaseType - state - apps 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails 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 - name: limit[apps] in: query description: maximum number of related apps returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of InAppPurchases content: application/json: schema: $ref: '#/components/schemas/InAppPurchasesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / in App Purchases /v1/apps/{id}/relationships/inAppPurchasesV2: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_inAppPurchasesV2_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppInAppPurchasesV2LinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / in App Purchases V2 /v1/apps/{id}/inAppPurchasesV2: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_inAppPurchasesV2_getToManyRelated parameters: - name: filter[productId] in: query description: filter by attribute 'productId' schema: type: array items: type: string style: form explode: false - name: filter[name] in: query description: filter by attribute 'name' schema: type: array items: type: string style: form explode: false - name: filter[state] in: query description: filter by attribute 'state' schema: type: array items: type: string enum: - MISSING_METADATA - WAITING_FOR_UPLOAD - PROCESSING_CONTENT - READY_TO_SUBMIT - WAITING_FOR_REVIEW - IN_REVIEW - DEVELOPER_ACTION_NEEDED - PENDING_BINARY_APPROVAL - APPROVED - DEVELOPER_REMOVED_FROM_SALE - REMOVED_FROM_SALE - REJECTED style: form explode: false - name: filter[inAppPurchaseType] in: query description: filter by attribute 'inAppPurchaseType' schema: type: array items: type: string enum: - CONSUMABLE - NON_CONSUMABLE - NON_RENEWING_SUBSCRIPTION 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: - name - -name - inAppPurchaseType - -inAppPurchaseType 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: - name - productId - inAppPurchaseType - state - reviewNote - familySharable - contentHosting - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false - name: fields[inAppPurchaseLocalizations] in: query description: the fields to include for returned resources of type inAppPurchaseLocalizations schema: type: array items: type: string enum: - name - locale - description - state - inAppPurchaseV2 style: form explode: false - name: fields[inAppPurchaseContents] in: query description: the fields to include for returned resources of type inAppPurchaseContents schema: type: array items: type: string enum: - fileName - fileSize - url - lastModifiedDate - inAppPurchaseV2 style: form explode: false - name: fields[inAppPurchaseAppStoreReviewScreenshots] in: query description: the fields to include for returned resources of type inAppPurchaseAppStoreReviewScreenshots schema: type: array items: type: string enum: - fileSize - fileName - sourceFileChecksum - imageAsset - assetToken - assetType - uploadOperations - assetDeliveryState - inAppPurchaseV2 style: form explode: false - name: fields[promotedPurchases] in: query description: the fields to include for returned resources of type promotedPurchases schema: type: array items: type: string enum: - visibleForAllUsers - enabled - state - inAppPurchaseV2 - subscription style: form explode: false - name: fields[inAppPurchasePriceSchedules] in: query description: the fields to include for returned resources of type inAppPurchasePriceSchedules schema: type: array items: type: string enum: - baseTerritory - manualPrices - automaticPrices style: form explode: false - name: fields[inAppPurchaseAvailabilities] in: query description: the fields to include for returned resources of type inAppPurchaseAvailabilities schema: type: array items: type: string enum: - availableInNewTerritories - availableTerritories style: form explode: false - name: fields[inAppPurchaseImages] in: query description: the fields to include for returned resources of type inAppPurchaseImages schema: type: array items: type: string enum: - fileSize - fileName - sourceFileChecksum - assetToken - imageAsset - uploadOperations - state - inAppPurchase style: form explode: false - name: fields[inAppPurchaseOfferCodes] in: query description: the fields to include for returned resources of type inAppPurchaseOfferCodes schema: type: array items: type: string enum: - name - customerEligibilities - productionCodeCount - sandboxCodeCount - active - oneTimeUseCodes - customCodes - prices 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: - inAppPurchaseLocalizations - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false - name: limit[inAppPurchaseLocalizations] in: query description: maximum number of related inAppPurchaseLocalizations returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[images] in: query description: maximum number of related images returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[offerCodes] in: query description: maximum number of related offerCodes returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of InAppPurchases content: application/json: schema: $ref: '#/components/schemas/InAppPurchasesV2Response' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / in App Purchases V2 /v1/apps/{id}/relationships/marketplaceSearchDetail: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_marketplaceSearchDetail_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppMarketplaceSearchDetailLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Marketplace Search Detail /v1/apps/{id}/marketplaceSearchDetail: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_marketplaceSearchDetail_getToOneRelated parameters: - name: fields[marketplaceSearchDetails] in: query description: the fields to include for returned resources of type marketplaceSearchDetails schema: type: array items: type: string enum: - catalogUrl style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single MarketplaceSearchDetail content: application/json: schema: $ref: '#/components/schemas/MarketplaceSearchDetailResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Marketplace Search Detail /v1/apps/{id}/perfPowerMetrics: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_perfPowerMetrics_getToManyRelated parameters: - name: filter[platform] in: query description: filter by attribute 'platform' schema: type: array items: type: string enum: - IOS 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[deviceType] in: query description: filter by attribute 'deviceType' schema: type: array items: type: string style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of PerfPowerMetrics content: application/vnd.apple.xcode-metrics+json: schema: $ref: '#/components/schemas/xcodeMetrics' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Perf Power Metrics /v1/apps/{id}/relationships/preReleaseVersions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_preReleaseVersions_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppPreReleaseVersionsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Pre Release Versions /v1/apps/{id}/preReleaseVersions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_preReleaseVersions_getToManyRelated parameters: - name: fields[preReleaseVersions] in: query description: the fields to include for returned resources of type preReleaseVersions schema: type: array items: type: string enum: - version - platform - builds - app style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of PreReleaseVersions with get content: application/json: schema: $ref: '#/components/schemas/PreReleaseVersionsWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Pre Release Versions /v1/apps/{id}/relationships/promotedPurchases: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_promotedPurchases_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppPromotedPurchasesLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Promoted Purchases patch: tags: - Apps operationId: apps_promotedPurchases_replaceToManyRelationship requestBody: description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppPromotedPurchasesLinkagesRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Replace Related Apps / Promoted Purchases /v1/apps/{id}/promotedPurchases: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_promotedPurchases_getToManyRelated parameters: - name: fields[promotedPurchases] in: query description: the fields to include for returned resources of type promotedPurchases schema: type: array items: type: string enum: - visibleForAllUsers - enabled - state - inAppPurchaseV2 - subscription 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: - name - productId - inAppPurchaseType - state - reviewNote - familySharable - contentHosting - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false - name: fields[subscriptions] in: query description: the fields to include for returned resources of type subscriptions schema: type: array items: type: string enum: - name - productId - familySharable - state - subscriptionPeriod - reviewNote - groupLevel - subscriptionLocalizations - appStoreReviewScreenshot - group - introductoryOffers - promotionalOffers - offerCodes - prices - pricePoints - promotedPurchase - subscriptionAvailability - winBackOffers - images 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: - inAppPurchaseV2 - subscription style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of PromotedPurchases content: application/json: schema: $ref: '#/components/schemas/PromotedPurchasesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Promoted Purchases /v1/apps/{id}/relationships/reviewSubmissions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_reviewSubmissions_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppReviewSubmissionsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Review Submissions /v1/apps/{id}/reviewSubmissions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_reviewSubmissions_getToManyRelated parameters: - name: filter[platform] in: query description: filter by attribute 'platform' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS style: form explode: false - name: filter[state] in: query description: filter by attribute 'state' schema: type: array items: type: string enum: - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - UNRESOLVED_ISSUES - CANCELING - COMPLETING - COMPLETE style: form explode: false - name: fields[reviewSubmissions] in: query description: the fields to include for returned resources of type reviewSubmissions schema: type: array items: type: string enum: - platform - submittedDate - state - app - items - appStoreVersionForReview - submittedByActor - lastUpdatedByActor 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false - name: fields[reviewSubmissionItems] in: query description: the fields to include for returned resources of type reviewSubmissionItems schema: type: array items: type: string enum: - state - appStoreVersion - appCustomProductPageVersion - appStoreVersionExperiment - appStoreVersionExperimentV2 - appEvent - backgroundAssetVersion - gameCenterAchievementVersion - gameCenterActivityVersion - gameCenterChallengeVersion - gameCenterLeaderboardSetVersion - gameCenterLeaderboardVersion 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: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: fields[actors] in: query description: the fields to include for returned resources of type actors schema: type: array items: type: string enum: - actorType - userFirstName - userLastName - userEmail - apiKeyId 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 - items - appStoreVersionForReview - submittedByActor - lastUpdatedByActor style: form explode: false - name: limit[items] in: query description: maximum number of related items returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of ReviewSubmissions content: application/json: schema: $ref: '#/components/schemas/ReviewSubmissionsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Review Submissions /v1/apps/{id}/relationships/searchKeywords: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_searchKeywords_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppSearchKeywordsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Search Keywords /v1/apps/{id}/searchKeywords: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_searchKeywords_getToManyRelated parameters: - name: filter[platform] in: query description: filter by platform schema: type: array items: type: string style: form explode: false - name: filter[locale] in: query description: filter by locale schema: type: array items: type: string style: form explode: false - name: fields[appKeywords] in: query description: the fields to include for returned resources of type appKeywords schema: type: array items: type: string enum: [] style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppKeywords content: application/json: schema: $ref: '#/components/schemas/AppKeywordsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Search Keywords /v1/apps/{id}/relationships/subscriptionGracePeriod: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_subscriptionGracePeriod_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppSubscriptionGracePeriodLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Subscription Grace Period /v1/apps/{id}/subscriptionGracePeriod: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_subscriptionGracePeriod_getToOneRelated parameters: - name: fields[subscriptionGracePeriods] in: query description: the fields to include for returned resources of type subscriptionGracePeriods schema: type: array items: type: string enum: - optIn - sandboxOptIn - duration - renewalType style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single SubscriptionGracePeriod content: application/json: schema: $ref: '#/components/schemas/SubscriptionGracePeriodResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related Apps / Subscription Grace Period /v1/apps/{id}/relationships/subscriptionGroups: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_subscriptionGroups_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppSubscriptionGroupsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Subscription Groups /v1/apps/{id}/subscriptionGroups: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_subscriptionGroups_getToManyRelated parameters: - name: filter[referenceName] in: query description: filter by attribute 'referenceName' schema: type: array items: type: string style: form explode: false - name: filter[subscriptions.state] in: query description: filter by attribute 'subscriptions.state' schema: type: array items: type: string enum: - MISSING_METADATA - READY_TO_SUBMIT - WAITING_FOR_REVIEW - IN_REVIEW - DEVELOPER_ACTION_NEEDED - PENDING_BINARY_APPROVAL - APPROVED - DEVELOPER_REMOVED_FROM_SALE - REMOVED_FROM_SALE - REJECTED 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: - referenceName - -referenceName style: form explode: false - name: fields[subscriptionGroups] in: query description: the fields to include for returned resources of type subscriptionGroups schema: type: array items: type: string enum: - referenceName - subscriptions - subscriptionGroupLocalizations style: form explode: false - name: fields[subscriptions] in: query description: the fields to include for returned resources of type subscriptions schema: type: array items: type: string enum: - name - productId - familySharable - state - subscriptionPeriod - reviewNote - groupLevel - subscriptionLocalizations - appStoreReviewScreenshot - group - introductoryOffers - promotionalOffers - offerCodes - prices - pricePoints - promotedPurchase - subscriptionAvailability - winBackOffers - images style: form explode: false - name: fields[subscriptionGroupLocalizations] in: query description: the fields to include for returned resources of type subscriptionGroupLocalizations schema: type: array items: type: string enum: - name - customAppName - locale - state - subscriptionGroup 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: - subscriptions - subscriptionGroupLocalizations style: form explode: false - name: limit[subscriptions] in: query description: maximum number of related subscriptions returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[subscriptionGroupLocalizations] in: query description: maximum number of related subscriptionGroupLocalizations returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of SubscriptionGroups content: application/json: schema: $ref: '#/components/schemas/SubscriptionGroupsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Subscription Groups /v1/apps/{id}/relationships/webhooks: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_webhooks_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppWebhooksLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Webhooks /v1/apps/{id}/webhooks: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_webhooks_getToManyRelated parameters: - name: fields[webhooks] in: query description: the fields to include for returned resources of type webhooks schema: type: array items: type: string enum: - enabled - eventTypes - name - url - app - deliveries 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: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails 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 style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of Webhooks content: application/json: schema: $ref: '#/components/schemas/WebhooksResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Apps / Webhooks /v1/apps/{id}/metrics/betaTesterUsages: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Apps operationId: apps_betaTesterUsages_getMetrics parameters: - name: period in: query description: the duration of the reporting period schema: type: string enum: - P7D - P30D - P90D - P365D style: form explode: false examples: PnD: value: P7D PTnH: value: PT10H PTnM: value: PT10M PTn.nS: value: PT10.5S PnDTnHnMn.nS: value: P7DT10H10M10.5S - name: groupBy in: query description: the dimension by which to group the results schema: type: array items: type: string enum: - betaTesters style: form explode: false - name: filter[betaTesters] in: query description: filter by 'betaTesters' relationship dimension schema: type: string style: form explode: false required: false - name: limit in: query description: maximum number of groups to return per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Metrics data response content: application/json: schema: $ref: '#/components/schemas/AppsBetaTesterUsagesV1MetricResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Metrics Apps / Beta Tester Usages components: schemas: BrazilAgeRating: type: string enum: - L - TEN - TWELVE - FOURTEEN - SIXTEEN - EIGHTEEN InAppPurchaseAvailability: type: object title: InAppPurchaseAvailability properties: type: type: string enum: - inAppPurchaseAvailabilities id: type: string attributes: type: object properties: availableInNewTerritories: type: boolean relationships: type: object properties: availableTerritories: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: - id - type AppClip: type: object title: AppClip properties: type: type: string enum: - appClips id: type: string attributes: type: object properties: bundleId: type: string relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type appClipDefaultExperiences: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appClipDefaultExperiences id: type: string required: - id - type appClipAdvancedExperiences: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ErrorSourceParameter: type: object title: Parameter properties: parameter: type: string required: - parameter AppAnalyticsReportRequestsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - analyticsReportRequests id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppVersionState: type: string enum: - ACCEPTED - DEVELOPER_REJECTED - IN_REVIEW - INVALID_BINARY - METADATA_REJECTED - PENDING_APPLE_RELEASE - PENDING_DEVELOPER_RELEASE - PREPARE_FOR_SUBMISSION - PROCESSING_FOR_DISTRIBUTION - READY_FOR_DISTRIBUTION - READY_FOR_REVIEW - REJECTED - REPLACED_WITH_NEW_VERSION - WAITING_FOR_EXPORT_COMPLIANCE - WAITING_FOR_REVIEW AppClipAction: type: string enum: - OPEN - VIEW - PLAY AlternativeDistributionKey: type: object title: AlternativeDistributionKey properties: type: type: string enum: - alternativeDistributionKeys id: type: string attributes: type: object properties: publicKey: type: string links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppBuildsLinkagesResponse: 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 AppsBetaTesterUsagesV1MetricResponse: type: object properties: data: type: array items: type: object properties: dataPoints: type: array items: type: object properties: start: type: string format: date-time end: type: string format: date-time values: type: object properties: crashCount: type: integer sessionCount: type: integer feedbackCount: type: integer dimensions: type: object properties: betaTesters: type: object properties: links: type: object properties: groupBy: type: string format: uri-reference related: type: string format: uri-reference data: type: string links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' included: type: array items: $ref: '#/components/schemas/BetaTester' required: - data - links csv: type: string CustomerReviewSummarizationsResponse: type: object title: CustomerReviewSummarizationsResponse properties: data: type: array items: $ref: '#/components/schemas/CustomerReviewSummarization' included: type: array items: $ref: '#/components/schemas/Territory' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppClipsResponse: type: object title: AppClipsResponse properties: data: type: array items: $ref: '#/components/schemas/AppClip' included: type: array items: oneOf: - $ref: '#/components/schemas/AppClipDefaultExperience' - $ref: '#/components/schemas/App' discriminator: propertyName: type mapping: appClipDefaultExperiences: '#/components/schemas/AppClipDefaultExperience' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links DocumentLinks: type: object properties: self: type: string format: uri-reference required: - self BuildUpload: type: object title: BuildUpload properties: type: type: string enum: - buildUploads id: type: string attributes: type: object properties: cfBundleShortVersionString: type: string cfBundleVersion: type: string createdDate: type: string format: date-time state: type: object properties: errors: type: array items: $ref: '#/components/schemas/StateDetail' warnings: type: array items: $ref: '#/components/schemas/StateDetail' infos: type: array items: $ref: '#/components/schemas/StateDetail' state: $ref: '#/components/schemas/BuildUploadState' platform: $ref: '#/components/schemas/Platform' uploadedDate: type: string format: date-time relationships: type: object properties: build: type: object properties: data: type: object properties: type: type: string enum: - builds id: type: string required: - id - type assetFile: type: object properties: data: type: object properties: type: type: string enum: - buildUploadFiles id: type: string required: - id - type assetDescriptionFile: type: object properties: data: type: object properties: type: type: string enum: - buildUploadFiles id: type: string required: - id - type assetSpiFile: type: object properties: data: type: object properties: type: type: string enum: - buildUploadFiles id: type: string required: - id - type buildUploadFiles: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AndroidToIosAppMappingDetailsResponse: type: object title: AndroidToIosAppMappingDetailsResponse properties: data: type: array items: $ref: '#/components/schemas/AndroidToIosAppMappingDetail' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AlternativeDistributionPackage: type: object title: AlternativeDistributionPackage properties: type: type: string enum: - alternativeDistributionPackages id: type: string attributes: type: object properties: sourceFileChecksum: $ref: '#/components/schemas/Checksums' relationships: type: object properties: versions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - alternativeDistributionPackageVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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' masked: type: boolean name: type: string links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppTag: type: object title: AppTag properties: type: type: string enum: - appTags id: type: string attributes: type: object properties: name: type: string visibleInAppStore: type: boolean relationships: type: object properties: territories: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: - id - type AppEndUserLicenseAgreementLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - endUserLicenseAgreements id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links Actor: type: object title: Actor properties: type: type: string enum: - actors id: type: string attributes: type: object properties: actorType: type: string enum: - USER - API_KEY - XCODE_CLOUD - APPLE userFirstName: type: string userLastName: type: string userEmail: type: string apiKeyId: type: string links: $ref: '#/components/schemas/ResourceLinks' required: - id - type GameCenterAchievementRelease: type: object title: GameCenterAchievementRelease properties: type: type: string enum: - gameCenterAchievementReleases id: type: string attributes: type: object properties: live: type: boolean relationships: type: object properties: gameCenterDetail: type: object properties: data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type gameCenterAchievement: type: object properties: data: type: object properties: type: type: string enum: - gameCenterAchievements id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true PhasedReleaseState: type: string enum: - INACTIVE - ACTIVE - PAUSED - COMPLETE BetaFeedbackCrashSubmission: type: object title: BetaFeedbackCrashSubmission properties: type: type: string enum: - betaFeedbackCrashSubmissions id: type: string attributes: type: object properties: createdDate: type: string format: date-time comment: type: string email: type: string deviceModel: type: string osVersion: type: string locale: type: string timeZone: type: string architecture: type: string connectionType: $ref: '#/components/schemas/DeviceConnectionType' pairedAppleWatch: type: string appUptimeInMilliseconds: type: integer format: int64 maximum: 9007199254740991 minimum: 0 diskBytesAvailable: type: integer format: int64 maximum: 9007199254740991 minimum: 0 diskBytesTotal: type: integer format: int64 maximum: 9007199254740991 minimum: 0 batteryPercentage: type: integer screenWidthInPoints: type: integer screenHeightInPoints: type: integer appPlatform: $ref: '#/components/schemas/Platform' devicePlatform: $ref: '#/components/schemas/Platform' deviceFamily: $ref: '#/components/schemas/DeviceFamily' buildBundleId: type: string relationships: type: object properties: crashLog: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' build: type: object properties: data: type: object properties: type: type: string enum: - builds id: type: string required: - id - type tester: type: object properties: data: type: object properties: type: type: string enum: - betaTesters id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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: - id - type AppReviewSubmissionsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - reviewSubmissions id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links GameCenterDetailResponse: type: object title: GameCenterDetailResponse properties: data: $ref: '#/components/schemas/GameCenterDetail' included: type: array items: oneOf: - $ref: '#/components/schemas/AppStoreVersion' - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/GameCenterAchievementRelease' - $ref: '#/components/schemas/GameCenterAchievement' - $ref: '#/components/schemas/GameCenterActivity' - $ref: '#/components/schemas/GameCenterActivityVersionRelease' - $ref: '#/components/schemas/GameCenterAppVersion' - $ref: '#/components/schemas/GameCenterChallengeVersionRelease' - $ref: '#/components/schemas/GameCenterChallenge' - $ref: '#/components/schemas/GameCenterGroup' - $ref: '#/components/schemas/GameCenterLeaderboardRelease' - $ref: '#/components/schemas/GameCenterLeaderboardSetRelease' - $ref: '#/components/schemas/GameCenterLeaderboardSet' - $ref: '#/components/schemas/GameCenterLeaderboard' discriminator: propertyName: type mapping: gameCenterLeaderboardReleases: '#/components/schemas/GameCenterLeaderboardRelease' gameCenterActivities: '#/components/schemas/GameCenterActivity' gameCenterGroups: '#/components/schemas/GameCenterGroup' gameCenterAchievementReleases: '#/components/schemas/GameCenterAchievementRelease' gameCenterLeaderboardSetReleases: '#/components/schemas/GameCenterLeaderboardSetRelease' gameCenterAppVersions: '#/components/schemas/GameCenterAppVersion' gameCenterChallengeVersionReleases: '#/components/schemas/GameCenterChallengeVersionRelease' gameCenterLeaderboards: '#/components/schemas/GameCenterLeaderboard' gameCenterLeaderboardSets: '#/components/schemas/GameCenterLeaderboardSet' appStoreVersions: '#/components/schemas/AppStoreVersion' gameCenterAchievements: '#/components/schemas/GameCenterAchievement' gameCenterChallenges: '#/components/schemas/GameCenterChallenge' apps: '#/components/schemas/App' gameCenterActivityVersionReleases: '#/components/schemas/GameCenterActivityVersionRelease' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppTagsResponse: type: object title: AppTagsResponse properties: data: type: array items: $ref: '#/components/schemas/AppTag' included: type: array items: $ref: '#/components/schemas/Territory' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links MarketplaceSearchDetailResponse: type: object title: MarketplaceSearchDetailResponse properties: data: $ref: '#/components/schemas/MarketplaceSearchDetail' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppStoreVersionSubmission: type: object title: AppStoreVersionSubmission properties: type: type: string enum: - appStoreVersionSubmissions id: 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 links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true PromotedPurchase: type: object title: PromotedPurchase properties: type: type: string enum: - promotedPurchases id: type: string attributes: type: object properties: visibleForAllUsers: type: boolean enabled: type: boolean state: type: string enum: - APPROVED - IN_REVIEW - PREPARE_FOR_SUBMISSION - REJECTED relationships: type: object properties: inAppPurchaseV2: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type subscription: type: object properties: data: type: object properties: type: type: string enum: - subscriptions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type PromotedPurchasesResponse: type: object title: PromotedPurchasesResponse properties: data: type: array items: $ref: '#/components/schemas/PromotedPurchase' included: type: array items: oneOf: - $ref: '#/components/schemas/InAppPurchaseV2' - $ref: '#/components/schemas/Subscription' discriminator: propertyName: type mapping: subscriptions: '#/components/schemas/Subscription' inAppPurchases: '#/components/schemas/InAppPurchaseV2' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links 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: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BuildUploadState: type: string enum: - AWAITING_UPLOAD - PROCESSING - FAILED - COMPLETE AppSubscriptionGroupsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - subscriptionGroups id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links GameCenterAchievement: type: object title: GameCenterAchievement properties: type: type: string enum: - gameCenterAchievements id: type: string attributes: type: object properties: referenceName: type: string vendorIdentifier: type: string points: type: integer showBeforeEarned: type: boolean repeatable: type: boolean archived: type: boolean activityProperties: $ref: '#/components/schemas/StringToStringMap' relationships: type: object properties: gameCenterDetail: type: object properties: data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type gameCenterGroup: type: object properties: data: type: object properties: type: type: string enum: - gameCenterGroups id: type: string required: - id - type groupAchievement: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterAchievements id: type: string required: - id - type deprecated: true localizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAchievementLocalizations id: type: string required: - id - type releases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAchievementReleases id: type: string required: - id - type activity: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterActivities id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true AppBetaFeedbackScreenshotSubmissionsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - betaFeedbackScreenshotSubmissions id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppCustomProductPage: type: object title: AppCustomProductPage properties: type: type: string enum: - appCustomProductPages id: type: string attributes: type: object properties: name: type: string url: type: string format: uri visible: type: boolean relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type appCustomProductPageVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appCustomProductPageVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppWebhooksLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - webhooks id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppBetaAppReviewDetailLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - betaAppReviewDetails id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppAppTagsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appTags id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppPricePointV3: type: object title: AppPricePointV3 properties: type: type: string enum: - appPricePoints id: type: string attributes: type: object properties: customerPrice: type: string proceeds: type: string relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type equalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' territory: type: object properties: data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppAppClipsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appClips id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links BundleIdPlatform: type: string enum: - IOS - MAC_OS - UNIVERSAL StringToStringMap: type: object additionalProperties: type: string AppSearchKeywordsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appKeywords id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppStoreAgeRating: type: string enum: - L - ALL - ONE_PLUS - TWO_PLUS - THREE_PLUS - FOUR_PLUS - FIVE_PLUS - SIX_PLUS - SEVEN_PLUS - EIGHT_PLUS - NINE_PLUS - TEN_PLUS - ELEVEN_PLUS - TWELVE_PLUS - THIRTEEN_PLUS - FOURTEEN_PLUS - FIFTEEN_PLUS - SIXTEEN_PLUS - SEVENTEEN_PLUS - EIGHTEEN_PLUS - NINETEEN_PLUS - TWENTY_PLUS - TWENTY_ONE_PLUS - UNRATED AppClipDefaultExperience: type: object title: AppClipDefaultExperience properties: type: type: string enum: - appClipDefaultExperiences id: type: string attributes: type: object properties: action: $ref: '#/components/schemas/AppClipAction' relationships: type: object properties: appClip: type: object properties: data: type: object properties: type: type: string enum: - appClips id: type: string required: - id - type releaseWithAppStoreVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appClipDefaultExperienceLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appClipDefaultExperienceLocalizations id: type: string required: - id - type appClipAppStoreReviewDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appClipAppStoreReviewDetails id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type DeliveryFileUploadOperation: type: object properties: method: type: string url: type: string length: type: integer format: int64 maximum: 9007199254740991 minimum: 1 offset: type: integer format: int64 maximum: 9007199254740991 minimum: 0 requestHeaders: type: array items: $ref: '#/components/schemas/HttpHeader' expiration: type: string format: date-time partNumber: type: integer format: int64 maximum: 9007199254740991 minimum: 1 entityTag: type: string InAppPurchaseState: type: string enum: - MISSING_METADATA - WAITING_FOR_UPLOAD - PROCESSING_CONTENT - READY_TO_SUBMIT - WAITING_FOR_REVIEW - IN_REVIEW - DEVELOPER_ACTION_NEEDED - PENDING_BINARY_APPROVAL - APPROVED - DEVELOPER_REMOVED_FROM_SALE - REMOVED_FROM_SALE - REJECTED AppAppCustomProductPagesLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appCustomProductPages id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links CustomerReviewSummarization: type: object title: CustomerReviewSummarization properties: type: type: string enum: - customerReviewSummarizations id: type: string attributes: type: object properties: createdDate: type: string format: date-time locale: type: string platform: $ref: '#/components/schemas/Platform' text: type: string relationships: type: object properties: territory: type: object properties: data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppBetaGroupsLinkagesResponse: 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 GameCenterActivityVersionRelease: type: object title: GameCenterActivityVersionRelease properties: type: type: string enum: - gameCenterActivityVersionReleases id: type: string relationships: type: object properties: version: type: object properties: data: type: object properties: type: type: string enum: - gameCenterActivityVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true WebhooksResponse: type: object title: WebhooksResponse properties: data: type: array items: $ref: '#/components/schemas/Webhook' included: type: array items: $ref: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links BetaAppReviewDetailWithoutIncludesResponse: type: object title: BetaAppReviewDetailWithoutIncludesResponse properties: data: $ref: '#/components/schemas/BetaAppReviewDetail' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppInAppPurchasesLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links deprecated: true AppAppPriceScheduleLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - appPriceSchedules id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links ImageAsset: type: object properties: templateUrl: type: string width: type: integer height: type: integer PagedDocumentLinks: type: object properties: self: type: string format: uri-reference first: type: string format: uri-reference next: type: string format: uri-reference required: - self AppStoreVersionExperimentTreatment: type: object title: AppStoreVersionExperimentTreatment properties: type: type: string enum: - appStoreVersionExperimentTreatments id: type: string attributes: type: object properties: name: type: string appIcon: $ref: '#/components/schemas/ImageAsset' appIconName: type: string promotedDate: type: string format: date-time relationships: type: object properties: appStoreVersionExperiment: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type appStoreVersionExperimentV2: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type appStoreVersionExperimentTreatmentLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatmentLocalizations id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BetaLicenseAgreementWithoutIncludesResponse: type: object title: BetaLicenseAgreementWithoutIncludesResponse properties: data: $ref: '#/components/schemas/BetaLicenseAgreement' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links TerritoryCode: type: string enum: - ABW - AFG - AGO - AIA - ALB - AND - ANT - ARE - ARG - ARM - ASM - ATG - AUS - AUT - AZE - BDI - BEL - BEN - BES - BFA - BGD - BGR - BHR - BHS - BIH - BLR - BLZ - BMU - BOL - BRA - BRB - BRN - BTN - BWA - CAF - CAN - CHE - CHL - CHN - CIV - CMR - COD - COG - COK - COL - COM - CPV - CRI - CUB - CUW - CXR - CYM - CYP - CZE - DEU - DJI - DMA - DNK - DOM - DZA - ECU - EGY - ERI - ESP - EST - ETH - FIN - FJI - FLK - FRA - FRO - FSM - GAB - GBR - GEO - GGY - GHA - GIB - GIN - GLP - GMB - GNB - GNQ - GRC - GRD - GRL - GTM - GUF - GUM - GUY - HKG - HND - HRV - HTI - HUN - IDN - IMN - IND - IRL - IRQ - ISL - ISR - ITA - JAM - JEY - JOR - JPN - KAZ - KEN - KGZ - KHM - KIR - KNA - KOR - KWT - LAO - LBN - LBR - LBY - LCA - LIE - LKA - LSO - LTU - LUX - LVA - MAC - MAR - MCO - MDA - MDG - MDV - MEX - MHL - MKD - MLI - MLT - MMR - MNE - MNG - MNP - MOZ - MRT - MSR - MTQ - MUS - MWI - MYS - MYT - NAM - NCL - NER - NFK - NGA - NIC - NIU - NLD - NOR - NPL - NRU - NZL - OMN - PAK - PAN - PER - PHL - PLW - PNG - POL - PRI - PRT - PRY - PSE - PYF - QAT - REU - ROU - RUS - RWA - SAU - SEN - SGP - SHN - SLB - SLE - SLV - SMR - SOM - SPM - SRB - SSD - STP - SUR - SVK - SVN - SWE - SWZ - SXM - SYC - TCA - TCD - TGO - THA - TJK - TKM - TLS - TON - TTO - TUN - TUR - TUV - TWN - TZA - UGA - UKR - UMI - URY - USA - UZB - VAT - VCT - VEN - VGB - VIR - VNM - VUT - WLF - WSM - XKS - YEM - ZAF - ZMB - ZWE ReviewSubmissionsResponse: type: object title: ReviewSubmissionsResponse properties: data: type: array items: $ref: '#/components/schemas/ReviewSubmission' included: type: array items: oneOf: - $ref: '#/components/schemas/Actor' - $ref: '#/components/schemas/AppStoreVersion' - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/ReviewSubmissionItem' discriminator: propertyName: type mapping: actors: '#/components/schemas/Actor' reviewSubmissionItems: '#/components/schemas/ReviewSubmissionItem' appStoreVersions: '#/components/schemas/AppStoreVersion' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppCiProductLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - ciProducts id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links GameCenterChallengeVersionRelease: type: object title: GameCenterChallengeVersionRelease properties: type: type: string enum: - gameCenterChallengeVersionReleases id: type: string relationships: type: object properties: version: type: object properties: data: type: object properties: type: type: string enum: - gameCenterChallengeVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true InAppPurchasesV2Response: type: object title: InAppPurchasesV2Response properties: data: type: array items: $ref: '#/components/schemas/InAppPurchaseV2' included: type: array items: oneOf: - $ref: '#/components/schemas/InAppPurchaseAppStoreReviewScreenshot' - $ref: '#/components/schemas/InAppPurchaseAvailability' - $ref: '#/components/schemas/InAppPurchaseContent' - $ref: '#/components/schemas/InAppPurchaseImage' - $ref: '#/components/schemas/InAppPurchaseLocalization' - $ref: '#/components/schemas/InAppPurchaseOfferCode' - $ref: '#/components/schemas/InAppPurchasePricePoint' - $ref: '#/components/schemas/InAppPurchasePriceSchedule' - $ref: '#/components/schemas/PromotedPurchase' discriminator: propertyName: type mapping: inAppPurchaseAppStoreReviewScreenshots: '#/components/schemas/InAppPurchaseAppStoreReviewScreenshot' inAppPurchaseContents: '#/components/schemas/InAppPurchaseContent' inAppPurchaseOfferCodes: '#/components/schemas/InAppPurchaseOfferCode' inAppPurchasePriceSchedules: '#/components/schemas/InAppPurchasePriceSchedule' promotedPurchases: '#/components/schemas/PromotedPurchase' inAppPurchaseImages: '#/components/schemas/InAppPurchaseImage' inAppPurchaseAvailabilities: '#/components/schemas/InAppPurchaseAvailability' inAppPurchasePricePoints: '#/components/schemas/InAppPurchasePricePoint' inAppPurchaseLocalizations: '#/components/schemas/InAppPurchaseLocalization' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppAvailabilityV2: type: object title: AppAvailabilityV2 properties: type: type: string enum: - appAvailabilities id: type: string attributes: type: object properties: availableInNewTerritories: type: boolean relationships: type: object properties: territoryAvailabilities: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - territoryAvailabilities id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type GameCenterLeaderboardSetRelease: type: object title: GameCenterLeaderboardSetRelease properties: type: type: string enum: - gameCenterLeaderboardSetReleases id: type: string attributes: type: object properties: live: type: boolean relationships: type: object properties: gameCenterDetail: type: object properties: data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type gameCenterLeaderboardSet: type: object properties: data: type: object properties: type: type: string enum: - gameCenterLeaderboardSets id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true xcodeMetrics: type: object properties: version: type: string insights: type: object properties: trendingUp: type: array items: $ref: '#/components/schemas/MetricsInsight' regressions: type: array items: $ref: '#/components/schemas/MetricsInsight' productData: type: array items: type: object properties: platform: type: string metricCategories: type: array items: type: object properties: identifier: $ref: '#/components/schemas/MetricCategory' metrics: type: array items: type: object properties: identifier: type: string goalKeys: type: array items: type: object properties: goalKey: type: string lowerBound: type: integer upperBound: type: integer unit: type: object properties: identifier: type: string displayName: type: string datasets: type: array items: type: object properties: filterCriteria: type: object properties: percentile: type: string device: type: string deviceMarketingName: type: string points: type: array items: type: object properties: version: type: string value: type: number errorMargin: type: number percentageBreakdown: type: object properties: value: type: number subSystemLabel: type: string goal: type: string recommendedMetricGoal: type: object properties: value: type: number detail: type: string SubscriptionGroup: type: object title: SubscriptionGroup properties: type: type: string enum: - subscriptionGroups id: type: string attributes: type: object properties: referenceName: type: string relationships: type: object properties: subscriptions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptions id: type: string required: - id - type subscriptionGroupLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionGroupLocalizations id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BetaGroupsWithoutIncludesResponse: type: object title: BetaGroupsWithoutIncludesResponse properties: data: type: array items: $ref: '#/components/schemas/BetaGroup' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppEncryptionDeclarationState: type: string enum: - CREATED - IN_REVIEW - APPROVED - REJECTED - INVALID - EXPIRED DeviceConnectionType: type: string enum: - WIFI - MOBILE_DATA - WIRE - UNKNOWN - NONE AppGameCenterEnabledVersionsLinkagesResponse: 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 deprecated: true AppAlternativeDistributionKeyLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - alternativeDistributionKeys id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppAppPricePointsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appPricePoints id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links InAppPurchaseImage: type: object title: InAppPurchaseImage properties: type: type: string enum: - inAppPurchaseImages id: type: string attributes: type: object properties: fileSize: type: integer fileName: type: string sourceFileChecksum: type: string assetToken: type: string imageAsset: $ref: '#/components/schemas/ImageAsset' uploadOperations: type: array items: $ref: '#/components/schemas/UploadOperation' state: type: string enum: - AWAITING_UPLOAD - UPLOAD_COMPLETE - FAILED - PREPARE_FOR_SUBMISSION - WAITING_FOR_REVIEW - APPROVED - REJECTED relationships: type: object properties: inAppPurchase: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AndroidToIosAppMappingDetail: type: object title: AndroidToIosAppMappingDetail properties: type: type: string enum: - androidToIosAppMappingDetails id: type: string attributes: type: object properties: packageName: type: string appSigningKeyPublicCertificateSha256Fingerprints: type: array items: type: string links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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: - $ref: '#/components/schemas/ErrorSourcePointer' - $ref: '#/components/schemas/ErrorSourceParameter' links: $ref: '#/components/schemas/ErrorLinks' meta: type: object additionalProperties: {} required: - code - detail - status - title BetaFeedbackScreenshotSubmission: type: object title: BetaFeedbackScreenshotSubmission properties: type: type: string enum: - betaFeedbackScreenshotSubmissions id: type: string attributes: type: object properties: createdDate: type: string format: date-time comment: type: string email: type: string deviceModel: type: string osVersion: type: string locale: type: string timeZone: type: string architecture: type: string connectionType: $ref: '#/components/schemas/DeviceConnectionType' pairedAppleWatch: type: string appUptimeInMilliseconds: type: integer format: int64 maximum: 9007199254740991 minimum: 0 diskBytesAvailable: type: integer format: int64 maximum: 9007199254740991 minimum: 0 diskBytesTotal: type: integer format: int64 maximum: 9007199254740991 minimum: 0 batteryPercentage: type: integer screenWidthInPoints: type: integer screenHeightInPoints: type: integer appPlatform: $ref: '#/components/schemas/Platform' devicePlatform: $ref: '#/components/schemas/Platform' deviceFamily: $ref: '#/components/schemas/DeviceFamily' buildBundleId: type: string screenshots: type: array items: $ref: '#/components/schemas/BetaFeedbackScreenshotImage' relationships: type: object properties: build: type: object properties: data: type: object properties: type: type: string enum: - builds id: type: string required: - id - type tester: type: object properties: data: type: object properties: type: type: string enum: - betaTesters id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BackgroundAssetVersionState: type: string enum: - AWAITING_UPLOAD - PROCESSING - FAILED - COMPLETE DeviceFamily: type: string enum: - IPHONE - IPAD - APPLE_TV - APPLE_WATCH - MAC - VISION AppCustomerReviewsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - customerReviews id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links InAppPurchaseContent: type: object title: InAppPurchaseContent properties: type: type: string enum: - inAppPurchaseContents id: type: string attributes: type: object properties: fileName: type: string fileSize: type: integer url: type: string format: uri lastModifiedDate: type: string format: date-time relationships: type: object properties: inAppPurchaseV2: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type GameCenterActivity: type: object title: GameCenterActivity properties: type: type: string enum: - gameCenterActivities id: type: string attributes: type: object properties: referenceName: type: string vendorIdentifier: type: string playStyle: type: string enum: - ASYNCHRONOUS - SYNCHRONOUS minimumPlayersCount: type: integer maximumPlayersCount: type: integer supportsPartyCode: type: boolean archived: type: boolean properties: $ref: '#/components/schemas/StringToStringMap' relationships: type: object properties: gameCenterDetail: type: object properties: data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type gameCenterGroup: type: object properties: data: type: object properties: type: type: string enum: - gameCenterGroups id: type: string required: - id - type achievements: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAchievements id: type: string required: - id - type deprecated: true achievementsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAchievements id: type: string required: - id - type leaderboards: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type deprecated: true leaderboardsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type versions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterActivityVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type GameCenterEnabledVersionsResponse: type: object title: GameCenterEnabledVersionsResponse properties: data: type: array items: $ref: '#/components/schemas/GameCenterEnabledVersion' included: type: array items: oneOf: - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/GameCenterEnabledVersion' discriminator: propertyName: type mapping: gameCenterEnabledVersions: '#/components/schemas/GameCenterEnabledVersion' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links deprecated: true ChecksumAlgorithm: type: string enum: - MD5 - SHA_256 AppBetaAppLocalizationsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - betaAppLocalizations id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppAppStoreVersionsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links CustomerReview: type: object title: CustomerReview properties: type: type: string enum: - customerReviews id: type: string attributes: type: object properties: rating: type: integer maximum: 5 minimum: 1 title: type: string body: type: string reviewerNickname: type: string createdDate: type: string format: date-time territory: $ref: '#/components/schemas/TerritoryCode' relationships: type: object properties: response: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - customerReviewResponses id: type: string required: - id - type reviewTerritory: type: object properties: data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppPriceScheduleResponse: type: object title: AppPriceScheduleResponse properties: data: $ref: '#/components/schemas/AppPriceSchedule' included: type: array items: oneOf: - $ref: '#/components/schemas/AppPriceV2' - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/Territory' discriminator: propertyName: type mapping: territories: '#/components/schemas/Territory' appPrices: '#/components/schemas/AppPriceV2' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links ReviewSubmissionItem: type: object title: ReviewSubmissionItem properties: type: type: string enum: - reviewSubmissionItems id: type: string attributes: type: object properties: state: type: string enum: - READY_FOR_REVIEW - ACCEPTED - APPROVED - REJECTED - REMOVED relationships: type: object properties: appStoreVersion: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appCustomProductPageVersion: type: object properties: data: type: object properties: type: type: string enum: - appCustomProductPageVersions id: type: string required: - id - type appStoreVersionExperiment: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type appStoreVersionExperimentV2: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type appEvent: type: object properties: data: type: object properties: type: type: string enum: - appEvents id: type: string required: - id - type backgroundAssetVersion: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type gameCenterAchievementVersion: type: object properties: data: type: object properties: type: type: string enum: - gameCenterAchievementVersions id: type: string required: - id - type gameCenterActivityVersion: type: object properties: data: type: object properties: type: type: string enum: - gameCenterActivityVersions id: type: string required: - id - type gameCenterChallengeVersion: type: object properties: data: type: object properties: type: type: string enum: - gameCenterChallengeVersions id: type: string required: - id - type gameCenterLeaderboardSetVersion: type: object properties: data: type: object properties: type: type: string enum: - gameCenterLeaderboardSetVersions id: type: string required: - id - type gameCenterLeaderboardVersion: type: object properties: data: type: object properties: type: type: string enum: - gameCenterLeaderboardVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BackgroundAssetVersion: type: object title: BackgroundAssetVersion properties: type: type: string enum: - backgroundAssetVersions id: type: string attributes: type: object properties: createdDate: type: string format: date-time platforms: type: array items: $ref: '#/components/schemas/Platform' state: $ref: '#/components/schemas/BackgroundAssetVersionState' stateDetails: type: object properties: errors: type: array items: $ref: '#/components/schemas/StateDetail' warnings: type: array items: $ref: '#/components/schemas/StateDetail' infos: type: array items: $ref: '#/components/schemas/StateDetail' version: type: string relationships: type: object properties: backgroundAsset: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssets id: type: string required: - id - type internalBetaRelease: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersionInternalBetaReleases id: type: string required: - id - type externalBetaRelease: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersionExternalBetaReleases id: type: string required: - id - type appStoreRelease: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersionAppStoreReleases id: type: string required: - id - type assetFile: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetUploadFiles id: type: string required: - id - type manifestFile: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetUploadFiles id: type: string required: - id - type backgroundAssetUploadFiles: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ErrorSourcePointer: type: object title: JsonPointer properties: pointer: type: string required: - pointer AppCustomProductPagesResponse: type: object title: AppCustomProductPagesResponse properties: data: type: array items: $ref: '#/components/schemas/AppCustomProductPage' included: type: array items: oneOf: - $ref: '#/components/schemas/AppCustomProductPageLocalization' - $ref: '#/components/schemas/AppCustomProductPageVersion' - $ref: '#/components/schemas/App' discriminator: propertyName: type mapping: appCustomProductPageLocalizations: '#/components/schemas/AppCustomProductPageLocalization' appCustomProductPageVersions: '#/components/schemas/AppCustomProductPageVersion' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links 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: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppGameCenterDetailLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links BetaFeedbackCrashSubmissionsResponse: type: object title: BetaFeedbackCrashSubmissionsResponse properties: data: type: array items: $ref: '#/components/schemas/BetaFeedbackCrashSubmission' included: type: array items: oneOf: - $ref: '#/components/schemas/BetaTester' - $ref: '#/components/schemas/Build' discriminator: propertyName: type mapping: builds: '#/components/schemas/Build' betaTesters: '#/components/schemas/BetaTester' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links GameCenterLeaderboardSet: type: object title: GameCenterLeaderboardSet properties: type: type: string enum: - gameCenterLeaderboardSets id: type: string attributes: type: object properties: referenceName: type: string vendorIdentifier: type: string relationships: type: object properties: gameCenterDetail: type: object properties: data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type gameCenterGroup: type: object properties: data: type: object properties: type: type: string enum: - gameCenterGroups id: type: string required: - id - type groupLeaderboardSet: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterLeaderboardSets id: type: string required: - id - type deprecated: true localizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardSetLocalizations id: type: string required: - id - type gameCenterLeaderboards: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type releases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardSetReleases id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true PagingInformation: type: object properties: paging: type: object properties: total: type: integer limit: type: integer nextCursor: type: string required: - limit required: - paging AppBetaFeedbackCrashSubmissionsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - betaFeedbackCrashSubmissions id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppPriceV2: type: object title: AppPriceV2 properties: type: type: string enum: - appPrices id: type: string attributes: type: object properties: manual: type: boolean startDate: type: string format: date endDate: type: string format: date relationships: type: object properties: appPricePoint: type: object properties: data: type: object properties: type: type: string enum: - appPricePoints id: type: string required: - id - type territory: type: object properties: data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type GameCenterAppVersion: type: object title: GameCenterAppVersion properties: type: type: string enum: - gameCenterAppVersions id: type: string attributes: type: object properties: enabled: type: boolean relationships: type: object properties: compatibilityVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAppVersions id: type: string required: - id - type appStoreVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AccessibilityDeclaration: type: object title: AccessibilityDeclaration properties: type: type: string enum: - accessibilityDeclarations id: type: string attributes: type: object properties: deviceFamily: $ref: '#/components/schemas/DeviceFamily' state: type: string enum: - DRAFT - PUBLISHED - REPLACED supportsAudioDescriptions: type: boolean supportsCaptions: type: boolean supportsDarkInterface: type: boolean supportsDifferentiateWithoutColorAlone: type: boolean supportsLargerText: type: boolean supportsReducedMotion: type: boolean supportsSufficientContrast: type: boolean supportsVoiceControl: type: boolean supportsVoiceover: type: boolean links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseOfferCode: type: object title: InAppPurchaseOfferCode properties: type: type: string enum: - inAppPurchaseOfferCodes id: type: string attributes: type: object properties: name: type: string customerEligibilities: type: array items: type: string enum: - NON_SPENDER - ACTIVE_SPENDER - CHURNED_SPENDER productionCodeCount: type: integer sandboxCodeCount: type: integer active: type: boolean relationships: type: object properties: oneTimeUseCodes: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseOfferCodeOneTimeUseCodes id: type: string required: - id - type customCodes: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseOfferCodeCustomCodes id: type: string required: - id - type prices: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseOfferPrices id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AnalyticsReport: type: object title: AnalyticsReport properties: type: type: string enum: - analyticsReports id: type: string attributes: type: object properties: name: type: string category: type: string enum: - APP_USAGE - APP_STORE_ENGAGEMENT - COMMERCE - FRAMEWORK_USAGE - PERFORMANCE relationships: type: object properties: instances: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppEventLocalization: type: object title: AppEventLocalization properties: type: type: string enum: - appEventLocalizations id: type: string attributes: type: object properties: locale: type: string name: type: string shortDescription: type: string longDescription: type: string relationships: type: object properties: appEvent: type: object properties: data: type: object properties: type: type: string enum: - appEvents id: type: string required: - id - type appEventScreenshots: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEventScreenshots id: type: string required: - id - type appEventVideoClips: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEventVideoClips id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchasesResponse: type: object title: InAppPurchasesResponse properties: data: type: array items: $ref: '#/components/schemas/InAppPurchase' included: type: array items: $ref: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links deprecated: true GameCenterDetail: type: object title: GameCenterDetail properties: type: type: string enum: - gameCenterDetails id: type: string attributes: type: object properties: arcadeEnabled: type: boolean challengeEnabled: type: boolean deprecated: true relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type gameCenterAppVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAppVersions id: type: string required: - id - type gameCenterGroup: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterGroups id: type: string required: - id - type gameCenterLeaderboards: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type deprecated: true gameCenterLeaderboardsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type gameCenterLeaderboardSets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardSets id: type: string required: - id - type deprecated: true gameCenterLeaderboardSetsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardSets id: type: string required: - id - type gameCenterAchievements: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAchievements id: type: string required: - id - type deprecated: true gameCenterAchievementsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAchievements id: type: string required: - id - type gameCenterActivities: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterActivities id: type: string required: - id - type gameCenterChallenges: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterChallenges id: type: string required: - id - type defaultLeaderboard: type: object properties: data: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type deprecated: true defaultLeaderboardV2: type: object properties: data: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type defaultGroupLeaderboard: type: object properties: data: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type deprecated: true defaultGroupLeaderboardV2: type: object properties: data: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type achievementReleases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAchievementReleases id: type: string required: - id - type deprecated: true activityReleases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterActivityVersionReleases id: type: string required: - id - type deprecated: true challengeReleases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterChallengeVersionReleases id: type: string required: - id - type deprecated: true leaderboardReleases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardReleases id: type: string required: - id - type deprecated: true leaderboardSetReleases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardSetReleases id: type: string required: - id - type deprecated: true challengesMinimumPlatformVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseAppStoreReviewScreenshot: type: object title: InAppPurchaseAppStoreReviewScreenshot properties: type: type: string enum: - inAppPurchaseAppStoreReviewScreenshots 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: inAppPurchaseV2: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppEncryptionDeclarationDocument: type: object title: AppEncryptionDeclarationDocument properties: type: type: string enum: - appEncryptionDeclarationDocuments id: type: string attributes: type: object properties: fileSize: type: integer fileName: type: string assetToken: type: string downloadUrl: type: string format: uri sourceFileChecksum: type: string uploadOperations: type: array items: $ref: '#/components/schemas/UploadOperation' assetDeliveryState: $ref: '#/components/schemas/AppMediaAssetState' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type GameCenterLeaderboardFormatter: type: string enum: - INTEGER - DECIMAL_POINT_1_PLACE - DECIMAL_POINT_2_PLACE - DECIMAL_POINT_3_PLACE - ELAPSED_TIME_CENTISECOND - ELAPSED_TIME_MINUTE - ELAPSED_TIME_SECOND - MONEY_POUND_DECIMAL - MONEY_POUND - MONEY_DOLLAR_DECIMAL - MONEY_DOLLAR - MONEY_EURO_DECIMAL - MONEY_EURO - MONEY_FRANC_DECIMAL - MONEY_FRANC - MONEY_KRONER_DECIMAL - MONEY_KRONER - MONEY_YEN AppSubscriptionGracePeriodLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - subscriptionGracePeriods id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links Webhook: type: object title: Webhook properties: type: type: string enum: - webhooks id: type: string attributes: type: object properties: enabled: type: boolean eventTypes: type: array items: $ref: '#/components/schemas/WebhookEventType' name: type: string url: type: string format: uri relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type deliveries: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppAppAvailabilityV2LinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - appAvailabilities id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppMarketplaceSearchDetailLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - marketplaceSearchDetails id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppPricePointsV3Response: type: object title: AppPricePointsV3Response properties: data: type: array items: $ref: '#/components/schemas/AppPricePointV3' included: type: array items: oneOf: - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/Territory' discriminator: propertyName: type mapping: territories: '#/components/schemas/Territory' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AgeRatingDeclaration: type: object title: AgeRatingDeclaration properties: type: type: string enum: - ageRatingDeclarations id: type: string attributes: type: object properties: advertising: type: boolean alcoholTobaccoOrDrugUseOrReferences: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT contests: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT gambling: type: boolean gamblingSimulated: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT gunsOrOtherWeapons: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT healthOrWellnessTopics: type: boolean kidsAgeBand: $ref: '#/components/schemas/KidsAgeBand' lootBox: type: boolean medicalOrTreatmentInformation: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT messagingAndChat: type: boolean parentalControls: type: boolean profanityOrCrudeHumor: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT ageAssurance: type: boolean sexualContentGraphicAndNudity: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT sexualContentOrNudity: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT horrorOrFearThemes: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT matureOrSuggestiveThemes: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT unrestrictedWebAccess: type: boolean userGeneratedContent: type: boolean violenceCartoonOrFantasy: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT violenceRealisticProlongedGraphicOrSadistic: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT violenceRealistic: type: string enum: - NONE - INFREQUENT_OR_MILD - FREQUENT_OR_INTENSE - INFREQUENT - FREQUENT ageRatingOverride: type: string deprecated: true enum: - NONE - NINE_PLUS - THIRTEEN_PLUS - SIXTEEN_PLUS - SEVENTEEN_PLUS - UNRATED ageRatingOverrideV2: type: string enum: - NONE - NINE_PLUS - THIRTEEN_PLUS - SIXTEEN_PLUS - EIGHTEEN_PLUS - UNRATED koreaAgeRatingOverride: type: string enum: - NONE - FIFTEEN_PLUS - NINETEEN_PLUS developerAgeRatingInfoUrl: type: string format: uri links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppInfo: type: object title: AppInfo properties: type: type: string enum: - appInfos id: type: string attributes: type: object properties: appStoreState: deprecated: true $ref: '#/components/schemas/AppStoreVersionState' state: type: string enum: - ACCEPTED - DEVELOPER_REJECTED - IN_REVIEW - PENDING_RELEASE - PREPARE_FOR_SUBMISSION - READY_FOR_DISTRIBUTION - READY_FOR_REVIEW - REJECTED - REPLACED_WITH_NEW_INFO - WAITING_FOR_REVIEW appStoreAgeRating: deprecated: true $ref: '#/components/schemas/AppStoreAgeRating' australiaAgeRating: type: string deprecated: true enum: - FIFTEEN - EIGHTEEN brazilAgeRating: deprecated: true $ref: '#/components/schemas/BrazilAgeRating' brazilAgeRatingV2: type: string deprecated: true enum: - SELF_RATED_L - SELF_RATED_TEN - SELF_RATED_TWELVE - SELF_RATED_FOURTEEN - SELF_RATED_SIXTEEN - SELF_RATED_EIGHTEEN - OFFICIAL_L - OFFICIAL_TEN - OFFICIAL_TWELVE - OFFICIAL_FOURTEEN - OFFICIAL_SIXTEEN - OFFICIAL_EIGHTEEN franceAgeRating: type: string deprecated: true enum: - EIGHTEEN koreaAgeRating: type: string deprecated: true enum: - ALL - TWELVE - FIFTEEN - NINETEEN - NOT_APPLICABLE kidsAgeBand: deprecated: true $ref: '#/components/schemas/KidsAgeBand' relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type ageRatingDeclaration: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - ageRatingDeclarations id: type: string required: - id - type appInfoLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appCategories id: type: string required: - id - type primarySubcategoryOne: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appCategories id: type: string required: - id - type primarySubcategoryTwo: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appCategories id: type: string required: - id - type secondaryCategory: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appCategories id: type: string required: - id - type secondarySubcategoryOne: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appCategories id: type: string required: - id - type secondarySubcategoryTwo: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appCategories id: type: string required: - id - type territoryAgeRatings: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ErrorLinks: type: object properties: about: type: string format: uri-reference associated: oneOf: - type: string format: uri-reference - type: object properties: href: type: string format: uri-reference meta: type: object properties: source: type: string GameCenterChallenge: type: object title: GameCenterChallenge properties: type: type: string enum: - gameCenterChallenges id: type: string attributes: type: object properties: referenceName: type: string vendorIdentifier: type: string archived: type: boolean challengeType: type: string enum: - LEADERBOARD repeatable: type: boolean relationships: type: object properties: gameCenterDetail: type: object properties: data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type gameCenterGroup: type: object properties: data: type: object properties: type: type: string enum: - gameCenterGroups id: type: string required: - id - type versions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterChallengeVersions id: type: string required: - id - type leaderboard: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type deprecated: true leaderboardV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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 AppEventsResponse: type: object title: AppEventsResponse properties: data: type: array items: $ref: '#/components/schemas/AppEvent' included: type: array items: $ref: '#/components/schemas/AppEventLocalization' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links 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' state: $ref: '#/components/schemas/BetaTesterState' appDevices: type: array items: type: object properties: model: type: string platform: type: string enum: - IOS - MAC_OS - TV_OS - WATCH_OS - VISION_OS osVersion: type: string appBuildVersion: type: string relationships: type: object properties: apps: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' 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: - id - type AppAccessibilityDeclarationsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - accessibilityDeclarations id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links Platform: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS AppAppEncryptionDeclarationsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appEncryptionDeclarations id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links BuildUploadFile: type: object title: BuildUploadFile properties: type: type: string enum: - buildUploadFiles id: type: string attributes: type: object properties: assetDeliveryState: $ref: '#/components/schemas/AppMediaAssetState' assetToken: type: string assetType: type: string enum: - ASSET - ASSET_DESCRIPTION - ASSET_SPI fileName: type: string fileSize: type: integer format: int64 maximum: 9007199254740991 minimum: 1 sourceFileChecksums: $ref: '#/components/schemas/Checksums' uploadOperations: type: array items: $ref: '#/components/schemas/DeliveryFileUploadOperation' uti: type: string enum: - com.apple.binary-property-list - com.apple.ipa - com.apple.pkg - com.apple.xml-property-list - com.pkware.zip-archive links: $ref: '#/components/schemas/ResourceLinks' required: - id - type CiProduct: type: object title: CiProduct properties: type: type: string enum: - ciProducts id: type: string attributes: type: object properties: name: type: string createdDate: type: string format: date-time productType: type: string enum: - APP - FRAMEWORK relationships: type: object properties: app: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type bundleId: type: object properties: data: type: object properties: type: type: string enum: - bundleIds id: type: string required: - id - type workflows: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' primaryRepositories: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - scmRepositories id: type: string required: - id - type additionalRepositories: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' buildRuns: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type Checksums: type: object properties: file: type: object properties: hash: type: string algorithm: $ref: '#/components/schemas/ChecksumAlgorithm' composite: type: object properties: hash: type: string algorithm: type: string enum: - MD5 BetaFeedbackScreenshotSubmissionsResponse: type: object title: BetaFeedbackScreenshotSubmissionsResponse properties: data: type: array items: $ref: '#/components/schemas/BetaFeedbackScreenshotSubmission' included: type: array items: oneOf: - $ref: '#/components/schemas/BetaTester' - $ref: '#/components/schemas/Build' discriminator: propertyName: type mapping: builds: '#/components/schemas/Build' betaTesters: '#/components/schemas/BetaTester' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppBetaLicenseAgreementLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - betaLicenseAgreements id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links MetricCategory: type: string enum: - HANG - LAUNCH - MEMORY - DISK - BATTERY - TERMINATION - ANIMATION GameCenterGroup: type: object title: GameCenterGroup properties: type: type: string enum: - gameCenterGroups id: type: string attributes: type: object properties: referenceName: type: string relationships: type: object properties: gameCenterDetails: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type gameCenterLeaderboards: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type deprecated: true gameCenterLeaderboardsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type gameCenterLeaderboardSets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardSets id: type: string required: - id - type deprecated: true gameCenterLeaderboardSetsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardSets id: type: string required: - id - type gameCenterAchievements: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAchievements id: type: string required: - id - type deprecated: true gameCenterAchievementsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAchievements id: type: string required: - id - type gameCenterActivities: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterActivities id: type: string required: - id - type gameCenterChallenges: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterChallenges id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppCustomProductPageVersion: type: object title: AppCustomProductPageVersion properties: type: type: string enum: - appCustomProductPageVersions id: type: string attributes: type: object properties: version: type: string state: type: string enum: - PREPARE_FOR_SUBMISSION - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - ACCEPTED - APPROVED - REPLACED_WITH_NEW_VERSION - REJECTED deepLink: type: string format: uri relationships: type: object properties: appCustomProductPage: type: object properties: data: type: object properties: type: type: string enum: - appCustomProductPages id: type: string required: - id - type appCustomProductPageLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appCustomProductPageLocalizations id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreVersionExperiment: type: object title: AppStoreVersionExperiment properties: type: type: string enum: - appStoreVersionExperiments id: type: string attributes: type: object properties: name: type: string trafficProportion: type: integer state: type: string enum: - PREPARE_FOR_SUBMISSION - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - ACCEPTED - APPROVED - REJECTED - COMPLETED - STOPPED reviewRequired: type: boolean startDate: type: string format: date-time endDate: type: string format: date-time relationships: type: object properties: appStoreVersion: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appStoreVersionExperimentTreatments: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatments id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true InAppPurchasePriceSchedule: type: object title: InAppPurchasePriceSchedule properties: type: type: string enum: - inAppPurchasePriceSchedules id: type: string relationships: type: object properties: baseTerritory: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type manualPrices: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchasePrices id: type: string required: - id - type automaticPrices: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchasePrices id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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: 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: - id - type deprecated: true AnalyticsReportRequestsResponse: type: object title: AnalyticsReportRequestsResponse properties: data: type: array items: $ref: '#/components/schemas/AnalyticsReportRequest' included: type: array items: $ref: '#/components/schemas/AnalyticsReport' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links SubscriptionGracePeriodResponse: type: object title: SubscriptionGracePeriodResponse properties: data: $ref: '#/components/schemas/SubscriptionGracePeriod' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppAvailabilityV2Response: type: object title: AppAvailabilityV2Response properties: data: $ref: '#/components/schemas/AppAvailabilityV2' included: type: array items: $ref: '#/components/schemas/TerritoryAvailability' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AlternativeDistributionKeyResponse: type: object title: AlternativeDistributionKeyResponse properties: data: $ref: '#/components/schemas/AlternativeDistributionKey' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppPromotedPurchasesLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppBackgroundAssetsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - backgroundAssets id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links GameCenterLeaderboardRelease: type: object title: GameCenterLeaderboardRelease properties: type: type: string enum: - gameCenterLeaderboardReleases id: type: string attributes: type: object properties: live: type: boolean relationships: type: object properties: gameCenterDetail: type: object properties: data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type gameCenterLeaderboard: type: object properties: data: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true App: type: object title: App properties: type: type: string enum: - apps id: type: string attributes: type: object properties: accessibilityUrl: type: string format: uri name: type: string bundleId: type: string sku: type: string primaryLocale: type: string isOrEverWasMadeForKids: type: boolean subscriptionStatusUrl: type: string format: uri subscriptionStatusUrlVersion: $ref: '#/components/schemas/SubscriptionStatusUrlVersion' subscriptionStatusUrlForSandbox: type: string format: uri subscriptionStatusUrlVersionForSandbox: $ref: '#/components/schemas/SubscriptionStatusUrlVersion' contentRightsDeclaration: type: string enum: - DOES_NOT_USE_THIRD_PARTY_CONTENT - USES_THIRD_PARTY_CONTENT streamlinedPurchasingEnabled: type: boolean relationships: type: object properties: accessibilityDeclarations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appEncryptionDeclarations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEncryptionDeclarations id: type: string required: - id - type appStoreIcon: type: object properties: data: type: object properties: type: type: string enum: - buildIcons id: type: string required: - id - type ciProduct: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - ciProducts id: type: string required: - id - type betaTesters: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appTags: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' preReleaseVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaLicenseAgreements id: type: string required: - id - type betaAppReviewDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaAppReviewDetails id: type: string required: - id - type appInfos: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appInfos id: type: string required: - id - type appClips: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appClips id: type: string required: - id - type appPricePoints: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' endUserLicenseAgreement: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - endUserLicenseAgreements id: type: string required: - id - type appPriceSchedule: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appAvailabilityV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' inAppPurchases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type deprecated: true subscriptionGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionGroups id: type: string required: - id - type gameCenterEnabledVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterEnabledVersions id: type: string required: - id - type perfPowerMetrics: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appCustomProductPages: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appCustomProductPages id: type: string required: - id - type inAppPurchasesV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type promotedPurchases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type appEvents: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEvents id: type: string required: - id - type reviewSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - reviewSubmissions id: type: string required: - id - type subscriptionGracePeriod: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - subscriptionGracePeriods id: type: string required: - id - type customerReviews: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' customerReviewSummarizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' gameCenterDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type appStoreVersionExperimentsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type alternativeDistributionKey: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' analyticsReportRequests: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' marketplaceSearchDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' buildUploads: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' backgroundAssets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaFeedbackScreenshotSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaFeedbackCrashSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' searchKeywords: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' webhooks: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' androidToIosAppMappingDetails: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - androidToIosAppMappingDetails id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreVersionsResponse: type: object title: AppStoreVersionsResponse properties: data: type: array items: $ref: '#/components/schemas/AppStoreVersion' included: type: array items: oneOf: - $ref: '#/components/schemas/AlternativeDistributionPackage' - $ref: '#/components/schemas/AppClipDefaultExperience' - $ref: '#/components/schemas/AppStoreReviewDetail' - $ref: '#/components/schemas/AppStoreVersionExperiment' - $ref: '#/components/schemas/AppStoreVersionLocalization' - $ref: '#/components/schemas/AppStoreVersionPhasedRelease' - $ref: '#/components/schemas/AppStoreVersionSubmission' - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/Build' - $ref: '#/components/schemas/GameCenterAppVersion' - $ref: '#/components/schemas/RoutingAppCoverage' discriminator: propertyName: type mapping: alternativeDistributionPackages: '#/components/schemas/AlternativeDistributionPackage' appClipDefaultExperiences: '#/components/schemas/AppClipDefaultExperience' appStoreVersionLocalizations: '#/components/schemas/AppStoreVersionLocalization' routingAppCoverages: '#/components/schemas/RoutingAppCoverage' appStoreVersionPhasedReleases: '#/components/schemas/AppStoreVersionPhasedRelease' appStoreReviewDetails: '#/components/schemas/AppStoreReviewDetail' appStoreVersionExperiments: '#/components/schemas/AppStoreVersionExperiment' builds: '#/components/schemas/Build' appStoreVersionSubmissions: '#/components/schemas/AppStoreVersionSubmission' gameCenterAppVersions: '#/components/schemas/GameCenterAppVersion' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links 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: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appStoreReviewAttachments: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: - id - type RelationshipLinks: type: object properties: self: type: string format: uri-reference related: type: string format: uri-reference AppStoreVersionExperimentV2: type: object title: AppStoreVersionExperimentV2 properties: type: type: string enum: - appStoreVersionExperiments id: type: string attributes: type: object properties: name: type: string platform: $ref: '#/components/schemas/Platform' trafficProportion: type: integer state: type: string enum: - PREPARE_FOR_SUBMISSION - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - ACCEPTED - APPROVED - REJECTED - COMPLETED - STOPPED reviewRequired: type: boolean startDate: type: string format: date-time endDate: type: string format: date-time relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type latestControlVersion: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type controlVersions: type: object properties: meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appStoreVersionExperimentTreatments: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatments id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppEncryptionDeclarationsResponse: type: object title: AppEncryptionDeclarationsResponse properties: data: type: array items: $ref: '#/components/schemas/AppEncryptionDeclaration' included: type: array items: oneOf: - $ref: '#/components/schemas/AppEncryptionDeclarationDocument' - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/Build' discriminator: propertyName: type mapping: builds: '#/components/schemas/Build' appEncryptionDeclarationDocuments: '#/components/schemas/AppEncryptionDeclarationDocument' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppInAppPurchasesV2LinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppAppInfosLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appInfos id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links InAppPurchaseV2: type: object title: InAppPurchaseV2 properties: type: type: string enum: - inAppPurchases id: type: string attributes: type: object properties: name: type: string productId: type: string inAppPurchaseType: $ref: '#/components/schemas/InAppPurchaseType' state: $ref: '#/components/schemas/InAppPurchaseState' reviewNote: type: string familySharable: type: boolean contentHosting: type: boolean relationships: type: object properties: inAppPurchaseLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseLocalizations id: type: string required: - id - type pricePoints: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchasePricePoints id: type: string required: - id - type content: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - inAppPurchaseContents id: type: string required: - id - type appStoreReviewScreenshot: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - inAppPurchaseAppStoreReviewScreenshots id: type: string required: - id - type promotedPurchase: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type iapPriceSchedule: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - inAppPurchasePriceSchedules id: type: string required: - id - type inAppPurchaseAvailability: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - inAppPurchaseAvailabilities id: type: string required: - id - type images: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseImages id: type: string required: - id - type offerCodes: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseOfferCodes id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type GameCenterLeaderboard: type: object title: GameCenterLeaderboard properties: type: type: string enum: - gameCenterLeaderboards id: type: string attributes: type: object properties: defaultFormatter: $ref: '#/components/schemas/GameCenterLeaderboardFormatter' referenceName: type: string vendorIdentifier: type: string submissionType: type: string enum: - BEST_SCORE - MOST_RECENT_SCORE scoreSortType: type: string enum: - ASC - DESC scoreRangeStart: type: string format: number scoreRangeEnd: type: string format: number recurrenceStartDate: type: string format: date-time recurrenceDuration: type: string format: duration recurrenceRule: type: string archived: type: boolean activityProperties: $ref: '#/components/schemas/StringToStringMap' visibility: type: string enum: - SHOW_FOR_ALL - HIDE_FOR_ALL relationships: type: object properties: gameCenterDetail: type: object properties: data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type gameCenterGroup: type: object properties: data: type: object properties: type: type: string enum: - gameCenterGroups id: type: string required: - id - type groupLeaderboard: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterLeaderboards id: type: string required: - id - type deprecated: true gameCenterLeaderboardSets: type: object properties: meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardSets id: type: string required: - id - type localizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardLocalizations id: type: string required: - id - type releases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterLeaderboardReleases id: type: string required: - id - type activity: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterActivities id: type: string required: - id - type challenge: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterChallenges id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true 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: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppAndroidToIosAppMappingDetailsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - androidToIosAppMappingDetails id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links SubscriptionGroupLocalization: type: object title: SubscriptionGroupLocalization properties: type: type: string enum: - subscriptionGroupLocalizations id: type: string attributes: type: object properties: name: type: string customAppName: type: string locale: type: string state: type: string enum: - PREPARE_FOR_SUBMISSION - WAITING_FOR_REVIEW - APPROVED - REJECTED relationships: type: object properties: subscriptionGroup: type: object properties: data: type: object properties: type: type: string enum: - subscriptionGroups id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchasePricePoint: type: object title: InAppPurchasePricePoint properties: type: type: string enum: - inAppPurchasePricePoints id: type: string attributes: type: object properties: customerPrice: type: string proceeds: type: string relationships: type: object properties: territory: type: object properties: data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type equalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BuildAudienceType: type: string enum: - INTERNAL_ONLY - APP_STORE_ELIGIBLE WebhookEventType: type: string enum: - ALTERNATIVE_DISTRIBUTION_PACKAGE_AVAILABLE_UPDATED - ALTERNATIVE_DISTRIBUTION_PACKAGE_VERSION_CREATED - ALTERNATIVE_DISTRIBUTION_TERRITORY_AVAILABILITY_UPDATED - APP_STORE_VERSION_APP_VERSION_STATE_UPDATED - BACKGROUND_ASSET_VERSION_APP_STORE_RELEASE_STATE_UPDATED - BACKGROUND_ASSET_VERSION_EXTERNAL_BETA_RELEASE_STATE_UPDATED - BACKGROUND_ASSET_VERSION_INTERNAL_BETA_RELEASE_CREATED - BACKGROUND_ASSET_VERSION_STATE_UPDATED - BETA_FEEDBACK_CRASH_SUBMISSION_CREATED - BETA_FEEDBACK_SCREENSHOT_SUBMISSION_CREATED - BUILD_BETA_DETAIL_EXTERNAL_BUILD_STATE_UPDATED - BUILD_UPLOAD_STATE_UPDATED ReviewSubmission: type: object title: ReviewSubmission properties: type: type: string enum: - reviewSubmissions id: type: string attributes: type: object properties: platform: $ref: '#/components/schemas/Platform' submittedDate: type: string format: date-time state: type: string enum: - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - UNRESOLVED_ISSUES - CANCELING - COMPLETING - COMPLETE relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type items: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - reviewSubmissionItems id: type: string required: - id - type appStoreVersionForReview: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type submittedByActor: type: object properties: data: type: object properties: type: type: string enum: - actors id: type: string required: - id - type lastUpdatedByActor: type: object properties: data: type: object properties: type: type: string enum: - actors id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type SubscriptionGracePeriod: type: object title: SubscriptionGracePeriod properties: type: type: string enum: - subscriptionGracePeriods id: type: string attributes: type: object properties: optIn: type: boolean sandboxOptIn: type: boolean duration: $ref: '#/components/schemas/SubscriptionGracePeriodDuration' renewalType: type: string enum: - ALL_RENEWALS - PAID_TO_PAID_ONLY links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppCustomProductPageLocalization: type: object title: AppCustomProductPageLocalization properties: type: type: string enum: - appCustomProductPageLocalizations id: type: string attributes: type: object properties: locale: type: string promotionalText: type: string relationships: type: object properties: appCustomProductPageVersion: type: object properties: data: type: object properties: type: type: string enum: - appCustomProductPageVersions id: type: string required: - id - type appScreenshotSets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appPreviewSets id: type: string required: - id - type searchKeywords: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appKeywords id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppKeywordsResponse: type: object title: AppKeywordsResponse properties: data: type: array items: $ref: '#/components/schemas/AppKeyword' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links BackgroundAssetsResponse: type: object title: BackgroundAssetsResponse properties: data: type: array items: $ref: '#/components/schemas/BackgroundAsset' included: type: array items: oneOf: - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/BackgroundAssetVersion' discriminator: propertyName: type mapping: backgroundAssetVersions: '#/components/schemas/BackgroundAssetVersion' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links MetricsInsight: type: object properties: metricCategory: $ref: '#/components/schemas/MetricCategory' latestVersion: type: string metric: type: string summaryString: type: string referenceVersions: type: string maxLatestVersionValue: type: number subSystemLabel: type: string highImpact: type: boolean populations: type: array items: type: object properties: deltaPercentage: type: number percentile: type: string summaryString: type: string referenceAverageValue: type: number latestVersionValue: type: number device: type: string 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 hasAccessToAllBuilds: type: boolean publicLinkEnabled: type: boolean publicLinkId: type: string publicLinkLimitEnabled: type: boolean publicLinkLimit: type: integer publicLink: type: string feedbackEnabled: type: boolean iosBuildsAvailableForAppleSiliconMac: type: boolean iosBuildsAvailableForAppleVision: type: boolean relationships: type: object properties: app: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type builds: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaTesters id: type: string required: - id - type betaRecruitmentCriteria: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaRecruitmentCriteria id: type: string required: - id - type betaRecruitmentCriterionCompatibleBuildCheck: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appCategories id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppKeyword: type: object title: AppKeyword properties: type: type: string enum: - appKeywords id: type: string links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppBuildUploadsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - buildUploads id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppPromotedPurchasesLinkagesRequest: type: object properties: data: type: array items: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type required: - data HttpHeader: type: object properties: name: type: string value: type: string CiProductResponse: type: object title: CiProductResponse properties: data: $ref: '#/components/schemas/CiProduct' included: type: array items: oneOf: - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/BundleId' - $ref: '#/components/schemas/ScmRepository' discriminator: propertyName: type mapping: scmRepositories: '#/components/schemas/ScmRepository' bundleIds: '#/components/schemas/BundleId' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links ResourceLinks: type: object properties: self: type: string format: uri-reference AppPreReleaseVersionsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - preReleaseVersions id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links 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: $ref: '#/components/schemas/RelationshipLinks' 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: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true PreReleaseVersionsWithoutIncludesResponse: type: object title: PreReleaseVersionsWithoutIncludesResponse properties: data: type: array items: $ref: '#/components/schemas/PrereleaseVersion' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links StateDetail: type: object properties: code: type: string description: type: string AppPriceSchedule: type: object title: AppPriceSchedule properties: type: type: string enum: - appPriceSchedules id: type: string relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type baseTerritory: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type manualPrices: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appPrices id: type: string required: - id - type automaticPrices: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appPrices id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BuildsWithoutIncludesResponse: type: object title: BuildsWithoutIncludesResponse properties: data: type: array items: $ref: '#/components/schemas/Build' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppEvent: type: object title: AppEvent properties: type: type: string enum: - appEvents id: type: string attributes: type: object properties: referenceName: type: string badge: type: string enum: - LIVE_EVENT - PREMIERE - CHALLENGE - COMPETITION - NEW_SEASON - MAJOR_UPDATE - SPECIAL_EVENT eventState: type: string enum: - DRAFT - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - REJECTED - ACCEPTED - APPROVED - PUBLISHED - PAST - ARCHIVED deepLink: type: string format: uri purchaseRequirement: type: string primaryLocale: type: string priority: type: string enum: - HIGH - NORMAL purpose: type: string enum: - APPROPRIATE_FOR_ALL_USERS - ATTRACT_NEW_USERS - KEEP_ACTIVE_USERS_INFORMED - BRING_BACK_LAPSED_USERS territorySchedules: type: array items: type: object properties: territories: type: array items: type: string publishStart: type: string format: date-time eventStart: type: string format: date-time eventEnd: type: string format: date-time archivedTerritorySchedules: type: array items: type: object properties: territories: type: array items: type: string publishStart: type: string format: date-time eventStart: type: string format: date-time eventEnd: type: string format: date-time relationships: type: object properties: localizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEventLocalizations id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppBetaTestersLinkagesRequest: type: object properties: data: type: array items: type: object properties: type: type: string enum: - betaTesters id: type: string required: - id - type required: - data AppResponse: type: object title: AppResponse properties: data: $ref: '#/components/schemas/App' included: type: array items: oneOf: - $ref: '#/components/schemas/AndroidToIosAppMappingDetail' - $ref: '#/components/schemas/AppClip' - $ref: '#/components/schemas/AppCustomProductPage' - $ref: '#/components/schemas/AppEncryptionDeclaration' - $ref: '#/components/schemas/AppEvent' - $ref: '#/components/schemas/AppInfo' - $ref: '#/components/schemas/AppStoreVersionExperimentV2' - $ref: '#/components/schemas/AppStoreVersion' - $ref: '#/components/schemas/BetaAppLocalization' - $ref: '#/components/schemas/BetaAppReviewDetail' - $ref: '#/components/schemas/BetaGroup' - $ref: '#/components/schemas/BetaLicenseAgreement' - $ref: '#/components/schemas/BuildIcon' - $ref: '#/components/schemas/Build' - $ref: '#/components/schemas/CiProduct' - $ref: '#/components/schemas/EndUserLicenseAgreement' - $ref: '#/components/schemas/GameCenterDetail' - $ref: '#/components/schemas/GameCenterEnabledVersion' - $ref: '#/components/schemas/InAppPurchase' - $ref: '#/components/schemas/PrereleaseVersion' - $ref: '#/components/schemas/PromotedPurchase' - $ref: '#/components/schemas/ReviewSubmission' - $ref: '#/components/schemas/SubscriptionGracePeriod' - $ref: '#/components/schemas/SubscriptionGroup' discriminator: propertyName: type mapping: betaGroups: '#/components/schemas/BetaGroup' appEvents: '#/components/schemas/AppEvent' appEncryptionDeclarations: '#/components/schemas/AppEncryptionDeclaration' reviewSubmissions: '#/components/schemas/ReviewSubmission' subscriptionGracePeriods: '#/components/schemas/SubscriptionGracePeriod' appInfos: '#/components/schemas/AppInfo' preReleaseVersions: '#/components/schemas/PrereleaseVersion' appStoreVersionExperiments: '#/components/schemas/AppStoreVersionExperimentV2' appCustomProductPages: '#/components/schemas/AppCustomProductPage' inAppPurchases: '#/components/schemas/InAppPurchase' appClips: '#/components/schemas/AppClip' betaAppReviewDetails: '#/components/schemas/BetaAppReviewDetail' buildIcons: '#/components/schemas/BuildIcon' ciProducts: '#/components/schemas/CiProduct' gameCenterDetails: '#/components/schemas/GameCenterDetail' promotedPurchases: '#/components/schemas/PromotedPurchase' androidToIosAppMappingDetails: '#/components/schemas/AndroidToIosAppMappingDetail' gameCenterEnabledVersions: '#/components/schemas/GameCenterEnabledVersion' subscriptionGroups: '#/components/schemas/SubscriptionGroup' appStoreVersions: '#/components/schemas/AppStoreVersion' builds: '#/components/schemas/Build' betaAppLocalizations: '#/components/schemas/BetaAppLocalization' betaLicenseAgreements: '#/components/schemas/BetaLicenseAgreement' endUserLicenseAgreements: '#/components/schemas/EndUserLicenseAgreement' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links CustomerReviewResponseV1: type: object title: CustomerReviewResponseV1 properties: type: type: string enum: - customerReviewResponses id: type: string attributes: type: object properties: responseBody: type: string lastModifiedDate: type: string format: date-time state: type: string enum: - PUBLISHED - PENDING_PUBLISH relationships: type: object properties: review: type: object properties: data: type: object properties: type: type: string enum: - customerReviews id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type UploadOperation: type: object properties: method: type: string url: type: string length: type: integer offset: type: integer requestHeaders: type: array items: $ref: '#/components/schemas/HttpHeader' 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: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type KidsAgeBand: type: string enum: - FIVE_AND_UNDER - SIX_TO_EIGHT - NINE_TO_ELEVEN AppInfosResponse: type: object title: AppInfosResponse properties: data: type: array items: $ref: '#/components/schemas/AppInfo' included: type: array items: oneOf: - $ref: '#/components/schemas/AgeRatingDeclaration' - $ref: '#/components/schemas/AppCategory' - $ref: '#/components/schemas/AppInfoLocalization' - $ref: '#/components/schemas/App' discriminator: propertyName: type mapping: ageRatingDeclarations: '#/components/schemas/AgeRatingDeclaration' appCategories: '#/components/schemas/AppCategory' appInfoLocalizations: '#/components/schemas/AppInfoLocalization' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links BetaTesterState: type: string enum: - NOT_INVITED - INVITED - ACCEPTED - INSTALLED - REVOKED AppEncryptionDeclaration: type: object title: AppEncryptionDeclaration properties: type: type: string enum: - appEncryptionDeclarations id: type: string attributes: type: object properties: appDescription: type: string createdDate: type: string format: date-time usesEncryption: type: boolean deprecated: true exempt: type: boolean containsProprietaryCryptography: type: boolean containsThirdPartyCryptography: type: boolean availableOnFrenchStore: type: boolean platform: deprecated: true $ref: '#/components/schemas/Platform' uploadedDate: type: string format: date-time deprecated: true documentUrl: type: string deprecated: true documentName: type: string deprecated: true documentType: type: string deprecated: true appEncryptionDeclarationState: $ref: '#/components/schemas/AppEncryptionDeclarationState' codeValue: type: string relationships: type: object properties: app: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type deprecated: true builds: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - builds id: type: string required: - id - type deprecated: true appEncryptionDeclarationDocument: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appEncryptionDeclarationDocuments id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type SubscriptionGroupsResponse: type: object title: SubscriptionGroupsResponse properties: data: type: array items: $ref: '#/components/schemas/SubscriptionGroup' included: type: array items: oneOf: - $ref: '#/components/schemas/SubscriptionGroupLocalization' - $ref: '#/components/schemas/Subscription' discriminator: propertyName: type mapping: subscriptions: '#/components/schemas/Subscription' subscriptionGroupLocalizations: '#/components/schemas/SubscriptionGroupLocalization' 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 lsMinimumSystemVersion: type: string computedMinMacOsVersion: type: string computedMinVisionOsVersion: type: string iconAssetToken: $ref: '#/components/schemas/ImageAsset' processingState: type: string enum: - PROCESSING - FAILED - INVALID - VALID buildAudienceType: $ref: '#/components/schemas/BuildAudienceType' usesNonExemptEncryption: type: boolean relationships: type: object properties: preReleaseVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - preReleaseVersions id: type: string required: - id - type individualTesters: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaTesters id: type: string required: - id - type betaGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type betaBuildLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appEncryptionDeclarations id: type: string required: - id - type betaAppReviewSubmission: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaAppReviewSubmissions id: type: string required: - id - type app: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type buildBetaDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - buildBetaDetails id: type: string required: - id - type appStoreVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type icons: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - buildIcons id: type: string required: - id - type buildBundles: type: object properties: meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - buildBundles id: type: string required: - id - type buildUpload: type: object properties: data: type: object properties: type: type: string enum: - buildUploads id: type: string required: - id - type perfPowerMetrics: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' diagnosticSignatures: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreVersionExperimentsV2Response: type: object title: AppStoreVersionExperimentsV2Response properties: data: type: array items: $ref: '#/components/schemas/AppStoreVersionExperimentV2' included: type: array items: oneOf: - $ref: '#/components/schemas/AppStoreVersionExperimentTreatment' - $ref: '#/components/schemas/AppStoreVersion' - $ref: '#/components/schemas/App' discriminator: propertyName: type mapping: appStoreVersionExperimentTreatments: '#/components/schemas/AppStoreVersionExperimentTreatment' appStoreVersions: '#/components/schemas/AppStoreVersion' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links SubscriptionStatusUrlVersion: type: string enum: - V1 - V2 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: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type territories: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: - id - type ScmRepository: type: object title: ScmRepository properties: type: type: string enum: - scmRepositories id: type: string attributes: type: object properties: lastAccessedDate: type: string format: date-time httpCloneUrl: type: string format: uri sshCloneUrl: type: string format: uri ownerName: type: string repositoryName: type: string relationships: type: object properties: scmProvider: type: object properties: data: type: object properties: type: type: string enum: - scmProviders id: type: string required: - id - type defaultBranch: type: object properties: data: type: object properties: type: type: string enum: - scmGitReferences id: type: string required: - id - type gitReferences: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' pullRequests: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BackgroundAsset: type: object title: BackgroundAsset properties: type: type: string enum: - backgroundAssets id: type: string attributes: type: object properties: archived: type: boolean assetPackIdentifier: type: string createdDate: type: string format: date-time usedBytes: type: integer format: int64 maximum: 9007199254740991 minimum: 0 relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type versions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appStoreVersion: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type internalBetaVersion: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type externalBetaVersion: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appScreenshotSets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appPreviewSets id: type: string required: - id - type searchKeywords: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appKeywords id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BetaInviteType: type: string enum: - EMAIL - PUBLIC_LINK AppAppStoreVersionExperimentsV2LinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' 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 privacyChoicesUrl: type: string privacyPolicyText: type: string relationships: type: object properties: appInfo: type: object properties: data: type: object properties: type: type: string enum: - appInfos id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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: deprecated: true $ref: '#/components/schemas/AppStoreVersionState' appVersionState: $ref: '#/components/schemas/AppVersionState' copyright: type: string reviewType: type: string enum: - APP_STORE - NOTARIZATION releaseType: type: string enum: - MANUAL - AFTER_APPROVAL - SCHEDULED earliestReleaseDate: type: string format: date-time usesIdfa: type: boolean deprecated: true downloadable: type: boolean createdDate: type: string format: date-time relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type appStoreVersionLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' 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: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - builds id: type: string required: - id - type appStoreVersionPhasedRelease: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersionPhasedReleases id: type: string required: - id - type gameCenterAppVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterAppVersions id: type: string required: - id - type routingAppCoverage: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - routingAppCoverages id: type: string required: - id - type appStoreReviewDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreReviewDetails id: type: string required: - id - type appStoreVersionSubmission: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersionSubmissions id: type: string required: - id - type appClipDefaultExperience: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appClipDefaultExperiences id: type: string required: - id - type appStoreVersionExperiments: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type appStoreVersionExperimentsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type customerReviews: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' alternativeDistributionPackage: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - alternativeDistributionPackages id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AnalyticsReportRequest: type: object title: AnalyticsReportRequest properties: type: type: string enum: - analyticsReportRequests id: type: string attributes: type: object properties: accessType: type: string enum: - ONE_TIME_SNAPSHOT - ONGOING stoppedDueToInactivity: type: boolean relationships: type: object properties: reports: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - analyticsReports id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppUpdateRequest: type: object title: AppUpdateRequest properties: data: type: object properties: type: type: string enum: - apps id: type: string attributes: type: object properties: accessibilityUrl: type: string format: uri nullable: true bundleId: type: string nullable: true primaryLocale: type: string nullable: true subscriptionStatusUrl: type: string format: uri nullable: true subscriptionStatusUrlVersion: nullable: true $ref: '#/components/schemas/SubscriptionStatusUrlVersion' subscriptionStatusUrlForSandbox: type: string format: uri nullable: true subscriptionStatusUrlVersionForSandbox: nullable: true $ref: '#/components/schemas/SubscriptionStatusUrlVersion' contentRightsDeclaration: type: string nullable: true enum: - DOES_NOT_USE_THIRD_PARTY_CONTENT - USES_THIRD_PARTY_CONTENT streamlinedPurchasingEnabled: type: boolean nullable: true required: - id - type required: - data BetaAppLocalizationsWithoutIncludesResponse: type: object title: BetaAppLocalizationsWithoutIncludesResponse properties: data: type: array items: $ref: '#/components/schemas/BetaAppLocalization' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links TerritoryAvailability: type: object title: TerritoryAvailability properties: type: type: string enum: - territoryAvailabilities id: type: string attributes: type: object properties: available: type: boolean releaseDate: type: string format: date preOrderEnabled: type: boolean preOrderPublishDate: type: string format: date contentStatuses: type: array items: type: string enum: - AVAILABLE - AVAILABLE_FOR_PREORDER_ON_DATE - PROCESSING_TO_NOT_AVAILABLE - PROCESSING_TO_AVAILABLE - PROCESSING_TO_PRE_ORDER - AVAILABLE_FOR_SALE_UNRELEASED_APP - PREORDER_ON_UNRELEASED_APP - AVAILABLE_FOR_PREORDER - MISSING_RATING - CANNOT_SELL_RESTRICTED_RATING - BRAZIL_REQUIRED_TAX_ID - BRAZIL_GAMBLING_NOT_VERIFIED - MISSING_GRN - UNVERIFIED_GRN - ICP_NUMBER_INVALID - ICP_NUMBER_MISSING - TRADER_STATUS_NOT_PROVIDED - TRADER_STATUS_VERIFICATION_FAILED - TRADER_STATUS_VERIFICATION_STATUS_MISSING - CANNOT_SELL_SEVENTEEN_PLUS_APPS - CANNOT_SELL_SEXUALLY_EXPLICIT - CANNOT_SELL_NON_IOS_GAMES - CANNOT_SELL_SEVENTEEN_PLUS_GAMES - CANNOT_SELL_CASINO - CANNOT_SELL_CASINO_WITHOUT_GRAC - CANNOT_SELL_CASINO_WITHOUT_AGE_VERIFICATION - CANNOT_SELL_ADULT_ONLY - CANNOT_SELL_GAMBLING_CONTESTS - CANNOT_SELL_GAMBLING - CANNOT_SELL_CONTESTS - CANNOT_SELL_NINETEEN_PLUS_WITHOUT_GRAC - CANNOT_SELL - CANNOT_SELL_FREQUENT_INTENSE_GAMBLING - CANNOT_SELL_FREQUENT_INTENSE_ALCOHOL_TOBACCO_DRUGS - CANNOT_SELL_FREQUENT_INTENSE_VIOLENCE - CANNOT_SELL_FREQUENT_INTENSE_SEXUAL_CONTENT_NUDITY - CANNOT_SELL_INFREQUENT_MILD_ALCOHOL_TOBACCO_DRUGS - CANNOT_SELL_INFREQUENT_MILD_SEXUAL_CONTENT_NUDITY - CANNOT_SELL_FREQUENT_INTENSE - CANNOT_SELL_FREQUENT_INTENSE_WITHOUT_GRAC - CANNOT_SELL_FREQUENT_GAMBLING - CANNOT_SELL_FREQUENT_ALCOHOL_TOBACCO_DRUGS - CANNOT_SELL_FREQUENT_VIOLENCE - CANNOT_SELL_FREQUENT_SEXUAL_CONTENT_NUDITY - CANNOT_SELL_INFREQUENT_ALCOHOL_TOBACCO_DRUGS - CANNOT_SELL_INFREQUENT_SEXUAL_CONTENT_NUDITY - CANNOT_SELL_FREQUENT - CANNOT_SELL_FREQUENT_WITHOUT_GRAC relationships: type: object properties: territory: type: object properties: data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseLocalization: type: object title: InAppPurchaseLocalization properties: type: type: string enum: - inAppPurchaseLocalizations id: type: string attributes: type: object properties: name: type: string locale: type: string description: type: string state: type: string enum: - PREPARE_FOR_SUBMISSION - WAITING_FOR_REVIEW - APPROVED - REJECTED relationships: type: object properties: inAppPurchaseV2: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type SubscriptionGracePeriodDuration: type: string enum: - THREE_DAYS - SIXTEEN_DAYS - TWENTY_EIGHT_DAYS MarketplaceSearchDetail: type: object title: MarketplaceSearchDetail properties: type: type: string enum: - marketplaceSearchDetails id: type: string attributes: type: object properties: catalogUrl: type: string format: uri links: $ref: '#/components/schemas/ResourceLinks' required: - id - type CustomerReviewsResponse: type: object title: CustomerReviewsResponse properties: data: type: array items: $ref: '#/components/schemas/CustomerReview' included: type: array items: oneOf: - $ref: '#/components/schemas/CustomerReviewResponseV1' - $ref: '#/components/schemas/Territory' discriminator: propertyName: type mapping: territories: '#/components/schemas/Territory' customerReviewResponses: '#/components/schemas/CustomerReviewResponseV1' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppsResponse: type: object title: AppsResponse properties: data: type: array items: $ref: '#/components/schemas/App' included: type: array items: oneOf: - $ref: '#/components/schemas/AndroidToIosAppMappingDetail' - $ref: '#/components/schemas/AppClip' - $ref: '#/components/schemas/AppCustomProductPage' - $ref: '#/components/schemas/AppEncryptionDeclaration' - $ref: '#/components/schemas/AppEvent' - $ref: '#/components/schemas/AppInfo' - $ref: '#/components/schemas/AppStoreVersionExperimentV2' - $ref: '#/components/schemas/AppStoreVersion' - $ref: '#/components/schemas/BetaAppLocalization' - $ref: '#/components/schemas/BetaAppReviewDetail' - $ref: '#/components/schemas/BetaGroup' - $ref: '#/components/schemas/BetaLicenseAgreement' - $ref: '#/components/schemas/BuildIcon' - $ref: '#/components/schemas/Build' - $ref: '#/components/schemas/CiProduct' - $ref: '#/components/schemas/EndUserLicenseAgreement' - $ref: '#/components/schemas/GameCenterDetail' - $ref: '#/components/schemas/GameCenterEnabledVersion' - $ref: '#/components/schemas/InAppPurchase' - $ref: '#/components/schemas/PrereleaseVersion' - $ref: '#/components/schemas/PromotedPurchase' - $ref: '#/components/schemas/ReviewSubmission' - $ref: '#/components/schemas/SubscriptionGracePeriod' - $ref: '#/components/schemas/SubscriptionGroup' discriminator: propertyName: type mapping: betaGroups: '#/components/schemas/BetaGroup' appEvents: '#/components/schemas/AppEvent' appEncryptionDeclarations: '#/components/schemas/AppEncryptionDeclaration' reviewSubmissions: '#/components/schemas/ReviewSubmission' subscriptionGracePeriods: '#/components/schemas/SubscriptionGracePeriod' appInfos: '#/components/schemas/AppInfo' preReleaseVersions: '#/components/schemas/PrereleaseVersion' appStoreVersionExperiments: '#/components/schemas/AppStoreVersionExperimentV2' appCustomProductPages: '#/components/schemas/AppCustomProductPage' inAppPurchases: '#/components/schemas/InAppPurchase' appClips: '#/components/schemas/AppClip' betaAppReviewDetails: '#/components/schemas/BetaAppReviewDetail' buildIcons: '#/components/schemas/BuildIcon' ciProducts: '#/components/schemas/CiProduct' gameCenterDetails: '#/components/schemas/GameCenterDetail' promotedPurchases: '#/components/schemas/PromotedPurchase' androidToIosAppMappingDetails: '#/components/schemas/AndroidToIosAppMappingDetail' gameCenterEnabledVersions: '#/components/schemas/GameCenterEnabledVersion' subscriptionGroups: '#/components/schemas/SubscriptionGroup' appStoreVersions: '#/components/schemas/AppStoreVersion' builds: '#/components/schemas/Build' betaAppLocalizations: '#/components/schemas/BetaAppLocalization' betaLicenseAgreements: '#/components/schemas/BetaLicenseAgreement' endUserLicenseAgreements: '#/components/schemas/EndUserLicenseAgreement' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AccessibilityDeclarationsResponse: type: object title: AccessibilityDeclarationsResponse properties: data: type: array items: $ref: '#/components/schemas/AccessibilityDeclaration' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links IconAssetType: type: string enum: - APP_STORE - MESSAGES_APP_STORE - WATCH_APP_STORE - TV_OS_HOME_SCREEN - TV_OS_TOP_SHELF - ALTERNATE_EXPERIMENT Subscription: type: object title: Subscription properties: type: type: string enum: - subscriptions id: type: string attributes: type: object properties: name: type: string productId: type: string familySharable: type: boolean state: type: string enum: - MISSING_METADATA - READY_TO_SUBMIT - WAITING_FOR_REVIEW - IN_REVIEW - DEVELOPER_ACTION_NEEDED - PENDING_BINARY_APPROVAL - APPROVED - DEVELOPER_REMOVED_FROM_SALE - REMOVED_FROM_SALE - REJECTED subscriptionPeriod: type: string enum: - ONE_WEEK - ONE_MONTH - TWO_MONTHS - THREE_MONTHS - SIX_MONTHS - ONE_YEAR reviewNote: type: string groupLevel: type: integer relationships: type: object properties: subscriptionLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionLocalizations id: type: string required: - id - type appStoreReviewScreenshot: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - subscriptionAppStoreReviewScreenshots id: type: string required: - id - type group: type: object properties: data: type: object properties: type: type: string enum: - subscriptionGroups id: type: string required: - id - type introductoryOffers: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionIntroductoryOffers id: type: string required: - id - type promotionalOffers: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionPromotionalOffers id: type: string required: - id - type offerCodes: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionOfferCodes id: type: string required: - id - type prices: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionPrices id: type: string required: - id - type pricePoints: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' promotedPurchase: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type subscriptionAvailability: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - subscriptionAvailabilities id: type: string required: - id - type winBackOffers: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - winBackOffers id: type: string required: - id - type images: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionImages id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BetaFeedbackScreenshotImage: type: object properties: url: type: string width: type: integer height: type: integer expirationDate: type: string format: date-time AppMediaStateError: type: object properties: code: type: string description: type: string EndUserLicenseAgreementWithoutIncludesResponse: type: object title: EndUserLicenseAgreementWithoutIncludesResponse properties: data: $ref: '#/components/schemas/EndUserLicenseAgreement' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links InAppPurchaseType: type: string enum: - CONSUMABLE - NON_CONSUMABLE - NON_RENEWING_SUBSCRIPTION 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: - id - type BuildUploadsResponse: type: object title: BuildUploadsResponse properties: data: type: array items: $ref: '#/components/schemas/BuildUpload' included: type: array items: oneOf: - $ref: '#/components/schemas/BuildUploadFile' - $ref: '#/components/schemas/Build' discriminator: propertyName: type mapping: buildUploadFiles: '#/components/schemas/BuildUploadFile' builds: '#/components/schemas/Build' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppStoreVersionState: type: string enum: - ACCEPTED - 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_REVIEW - READY_FOR_SALE - REJECTED - REMOVED_FROM_SALE - WAITING_FOR_EXPORT_COMPLIANCE - WAITING_FOR_REVIEW - REPLACED_WITH_NEW_VERSION - NOT_APPLICABLE AppAppEventsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appEvents id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links securitySchemes: itc-bearer-token: type: http scheme: bearer bearerFormat: JWT