From d6fe321b82da03dd4c109fb344ac400c8d2bc783 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EF=A3=BF=20Aleksei=20Zelentsov?= <37956463+zelentsov-dev@users.noreply.github.com> Date: Wed, 28 Oct 2026 13:14:09 +0300 Subject: [PATCH 1/7] chore(ci): cache SwiftPM builds and skip macOS jobs on weekly drift schedule (#35) * chore(ci): cache SwiftPM builds and skip macOS jobs on weekly drift schedule * fix(ci): gate branch concurrency cancellation on push events --- .github/workflows/ci.yml | 41 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e609474..d0a6687 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -14,8 +14,8 @@ permissions: contents: read concurrency: - group: ${{ github.workflow }}-${{ (github.event_name == 'pull_request' || github.ref == 'refs/heads/develop') && github.ref || github.run_id }} - cancel-in-progress: ${{ github.event_name == 'pull_request' || github.ref == 'refs/heads/develop' }} + group: ${{ github.workflow }}-${{ (github.event_name == 'pull_request' || (github.event_name == 'push' && (github.ref == 'refs/heads/develop' || github.ref == 'refs/heads/main'))) && (github.event.pull_request.number || github.ref) || github.run_id }} + cancel-in-progress: ${{ github.event_name == 'pull_request' || (github.event_name == 'push' && (github.ref == 'refs/heads/develop' || github.ref == 'refs/heads/main')) }} jobs: promotion-lineage: @@ -132,6 +132,7 @@ jobs: tests: name: Tests + if: github.event_name != 'schedule' needs: promotion-lineage runs-on: macos-15 timeout-minutes: 20 @@ -145,6 +146,17 @@ jobs: - name: Select Xcode run: sudo xcode-select -s /Applications/Xcode_26.2.app + - name: Cache SwiftPM test build + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.2.3 + with: + path: | + ~/Library/Caches/org.swift.swiftpm + ~/.swiftpm + .build + key: swiftpm-tests-${{ runner.os }}-xcode26.2-${{ hashFiles('Package.swift', 'Package.resolved') }}-${{ hashFiles('Sources/**', 'Tests/**') }} + restore-keys: | + swiftpm-tests-${{ runner.os }}-xcode26.2-${{ hashFiles('Package.swift', 'Package.resolved') }}- + - name: Run tests shell: bash run: | @@ -189,6 +201,7 @@ jobs: release-contract: name: Release & Apple Contract + if: github.event_name != 'schedule' needs: promotion-lineage runs-on: macos-15 timeout-minutes: 20 @@ -202,6 +215,17 @@ jobs: - name: Select Xcode run: sudo xcode-select -s /Applications/Xcode_26.2.app + - name: Cache SwiftPM release build + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.2.3 + with: + path: | + ~/Library/Caches/org.swift.swiftpm + ~/.swiftpm + .build + key: swiftpm-release-${{ runner.os }}-xcode26.2-${{ hashFiles('Package.swift', 'Package.resolved') }}-${{ hashFiles('Sources/**') }} + restore-keys: | + swiftpm-release-${{ runner.os }}-xcode26.2-${{ hashFiles('Package.swift', 'Package.resolved') }}- + - name: Build release binary shell: bash run: | @@ -389,11 +413,22 @@ jobs: - name: Select Xcode run: sudo xcode-select -s /Applications/Xcode_26.2.app + - name: Cache Mint and SwiftPM packages + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.2.3 + with: + path: | + ~/Library/Caches/org.swift.swiftpm + ~/.swiftpm + ~/.mint + key: mint-swiftpm-${{ runner.os }}-xcode26.2-${{ hashFiles('Package.swift', 'Package.resolved') }}-${{ hashFiles('Sources/**') }} + restore-keys: | + mint-swiftpm-${{ runner.os }}-xcode26.2-${{ hashFiles('Package.swift', 'Package.resolved') }}- + - name: Install tagged release through Mint shell: bash run: | set -euo pipefail - brew install mint + command -v mint >/dev/null 2>&1 || brew install mint mint install "zelentsov-dev/asc-mcp@$GITHUB_REF_NAME" --force - name: Run installed MCP smoke From d0c4b05566a1dc0a38f355540ac0ccb5f6eb129f Mon Sep 17 00:00:00 2001 From: Aleksei Zelentsov Date: Sat, 7 Nov 2026 14:23:49 +0300 Subject: [PATCH 2/7] Add App Store Connect API 4.6 subscription retention messaging support --- .github/workflows/ci.yml | 4 +- AGENTS.md | 4 +- ASC-COVERAGE-MATRIX-2026-05-05.md | 1 + ASC-OPENAPI-COVERAGE-GENERATED.md | 16 +- CHANGELOG.md | 7 + README.md | 20 +- .../asc-mcp/Core/ASCCoverageInventory.swift | 7 +- Sources/asc-mcp/Core/Application.swift | 2 +- .../asc-mcp/Helpers/ToolMetadataPolicy.swift | 3 +- .../Models/Assets/AssetLibraryModels.swift | 17 + .../ReviewSubmissionModels.swift | 6 + .../RetentionMessagingModels.swift | 1163 + .../Resources/OperationManifest/manifest.json | 968 +- .../tools/accessibility.json | 388 +- .../OperationManifest/tools/analytics.json | 206 +- .../OperationManifest/tools/app_events.json | 26 +- .../OperationManifest/tools/app_info.json | 579 +- .../OperationManifest/tools/apps.json | 2392 +- .../OperationManifest/tools/assets.json | 10364 ++- .../OperationManifest/tools/auth.json | 56 +- .../OperationManifest/tools/beta_app.json | 78 +- .../tools/beta_feedback.json | 10 +- .../OperationManifest/tools/beta_groups.json | 241 +- .../OperationManifest/tools/beta_license.json | 4 +- .../OperationManifest/tools/beta_testers.json | 128 +- .../OperationManifest/tools/build_beta.json | 137 +- .../tools/build_processing.json | 40 +- .../tools/build_uploads.json | 1528 +- .../OperationManifest/tools/builds.json | 54 +- .../OperationManifest/tools/company.json | 26 +- .../OperationManifest/tools/custom_pages.json | 1788 +- .../tools/export_compliance.json | 886 +- .../OperationManifest/tools/iap.json | 1692 +- .../OperationManifest/tools/metrics.json | 4 +- .../OperationManifest/tools/ppo.json | 888 +- .../OperationManifest/tools/pre_release.json | 8 +- .../OperationManifest/tools/pricing.json | 137 +- .../OperationManifest/tools/promoted.json | 350 +- .../OperationManifest/tools/provisioning.json | 830 +- .../tools/review_attachments.json | 46 +- .../tools/review_submissions.json | 1428 +- .../OperationManifest/tools/reviews.json | 39 +- .../OperationManifest/tools/sandbox.json | 40 +- .../OperationManifest/tools/screenshots.json | 3040 +- .../tools/subscriptions.json | 5302 +- .../OperationManifest/tools/users.json | 627 +- .../OperationManifest/tools/versions.json | 708 +- .../OperationManifest/tools/webhooks.json | 598 +- .../OperationManifest/tools/xcode_cloud.json | 3813 +- .../asc-mcp/Tooling/ASCOpenAPICoverage.swift | 2 + .../AssetsWorker/AssetsWorker+Execution.swift | 4 +- .../AssetsWorker+Preparation.swift | 19 +- .../AssetsWorker/AssetsWorker+Reads.swift | 84 +- .../AssetsWorker/AssetsWorker+Recovery.swift | 2 +- .../AssetsWorker+ToolDefinitions.swift | 4 +- .../Workers/AssetsWorker/AssetsWorker.swift | 2 +- .../ReviewSubmissionsWorker+Handlers.swift | 16 +- ...iewSubmissionsWorker+ToolDefinitions.swift | 1 + .../ReviewSubmissionsWorker.swift | 1 + ...ubscriptionsWorker+RetentionHandlers.swift | 1884 + ...tionsWorker+RetentionToolDefinitions.swift | 703 + .../SubscriptionsWorker.swift | 48 +- .../Docs/ASCCoverageInventoryTests.swift | 5 +- .../Docs/READMEWorkerCountsTests.swift | 2 +- .../OpenAPI/api-4.6-operation-decisions.json | 244 + .../app-store-connect-4.5.1.provenance.json | 12 - ...as.json => app-store-connect-4.6.oas.json} | 74432 +++++++++------- .../app-store-connect-4.6.provenance.json | 11 + .../Tooling/API451ContractTests.swift | 45 +- .../Tooling/AssetsManifestContractTests.swift | 6 +- .../BuildUploadsManifestContractTests.swift | 16 +- .../TestFlightManifestContractTests.swift | 14 +- .../XcodeCloudManifestContractTests.swift | 16 +- .../Workers/AppSearchKeywordsV319Tests.swift | 2 +- .../Workers/AppsSearchContractTests.swift | 6 +- ...psVersionsOptionalInputContractTests.swift | 6 +- .../Workers/AssetsRegistrationTests.swift | 2 +- .../Workers/BetaAppWorkerContractTests.swift | 6 +- .../BuildUploadsRegistrationTests.swift | 2 +- .../CommerceCatalogOptionalInputTests.swift | 6 +- .../CommercePaginationHardeningTests.swift | 2 +- ...ustomProductPagesWorkerContractTests.swift | 2 +- .../MarketingOptionalInputContractTests.swift | 2 +- .../RetentionMessagingContractTests.swift | 586 + ...ReviewSubmissionsWorkerContractTests.swift | 13 +- ...scriptionPricingSummaryContractTests.swift | 2 +- ...ptionWriteOptionalInputContractTests.swift | 4 +- .../Workers/ToolMetadataPolicyTests.swift | 6 +- .../Workers/WorkerToolDefinitionsTests.swift | 29 +- 89 files changed, 79062 insertions(+), 39886 deletions(-) create mode 100644 Sources/asc-mcp/Models/Subscriptions/RetentionMessagingModels.swift create mode 100644 Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift create mode 100644 Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionToolDefinitions.swift create mode 100644 Tests/ASCMCPTests/Fixtures/OpenAPI/api-4.6-operation-decisions.json delete mode 100644 Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.5.1.provenance.json rename Tests/ASCMCPTests/Fixtures/OpenAPI/{app-store-connect-4.5.1.oas.json => app-store-connect-4.6.oas.json} (97%) create mode 100644 Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.6.provenance.json create mode 100644 Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d0a6687..6d97734 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -264,7 +264,7 @@ jobs: contract_directory="$RUNNER_TEMP/asc_openapi_contract" rm -rf "$contract_directory" mkdir -p "$contract_directory" - cp Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.5.1.oas.json \ + cp Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.6.oas.json \ "$contract_directory/openapi.oas.json" shasum -a 256 "$contract_directory/openapi.oas.json" \ > "$contract_directory/specification.sha256" @@ -364,7 +364,7 @@ jobs: run: | set -euo pipefail python3 .github/workflows/scripts/apple_spec_drift.py \ - --pinned Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.5.1.oas.json \ + --pinned Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.6.oas.json \ --latest-zip "$RUNNER_TEMP/asc_latest_openapi/spec.zip" \ --output-directory "$RUNNER_TEMP/asc_latest_openapi" diff --git a/AGENTS.md b/AGENTS.md index 526b925..96be341 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -49,7 +49,7 @@ Each company needs: `keyID`, `issuerID`, `privateKeyPath` (path to `.p8` file). **WorkerManager** (`Workers/MainWorker/WorkerManager.swift`) — central registry, routes tool calls by prefix. -**Workers** (40 Swift worker classes; 36 `--workers` filter keys; 514 tools): +**Workers** (40 Swift worker classes; 36 `--workers` filter keys; 537 tools): | Worker | Prefix | Tools | Domain | |--------|--------|-------|--------| @@ -76,7 +76,7 @@ Each company needs: `keyID`, `issuerID`, `privateKeyPath` (path to `.p8` file). | UsersWorker | `users_` | 10 | Team members, roles, invitations, visible apps | | AppEventsWorker | `app_events_` | 9 | In-app events CRUD, localizations | | AnalyticsWorker | `analytics_` | 11 | Sales/financial reports, app summary, analytics reports/instances/segments, snapshot status | -| SubscriptionsWorker | `subscriptions_` | 99 | Subscription and group versions, pricing, plan availability, offers, assets; includes offer-code, intro, promotional, and win-back sub-worker behavior | +| SubscriptionsWorker | `subscriptions_` | 122 | Subscription and group versions, pricing, plan availability, offers, retention messaging (messages, versions, localizations, retention offers, and subscription retention relationships), assets; includes offer-code, intro, promotional, and win-back sub-worker behavior | | SandboxTestersWorker | `sandbox_` | 3 | Sandbox testers (list, update, clear purchase history) | | BetaAppWorker | `beta_app_` | 10 | Beta app localizations, review submissions, review details | | PreReleaseVersionsWorker | `pre_release_` | 3 | Pre-release versions (list, get, builds) | diff --git a/ASC-COVERAGE-MATRIX-2026-05-05.md b/ASC-COVERAGE-MATRIX-2026-05-05.md index fed4f21..1ff2e0b 100644 --- a/ASC-COVERAGE-MATRIX-2026-05-05.md +++ b/ASC-COVERAGE-MATRIX-2026-05-05.md @@ -13,6 +13,7 @@ Update 2026-05-08: local webhook receiver helpers are available for signature ve Update 2026-07-20: Apple 4.4.1 versioned commerce metadata, plan-type-aware subscription availability, adjusted equalizations, and generic review submissions are covered. Update 2026-07-21: Build Upload parents, file reservations, resumable transfers, commit recovery, and processing reconciliation are covered by `build_uploads_*` tools. Update 2026-07-21: 11 TestFlight recruitment and usage-metric tools cover 12 additional Apple operations, including app-device context in tester projections. +Update 2026-11-07: Apple 4.6 subscription retention messaging (messages, versions, localizations, retention offers, subscription retention relationships, Asset Library `retentionMessageVersion` image placements, and Review Submission `retentionMessageVersion` items) is covered. This matrix tracks current `asc-mcp` coverage against the official App Store Connect API documentation. It is intentionally product-oriented: it names what users can do today, what is missing, and which additions should come first. diff --git a/ASC-OPENAPI-COVERAGE-GENERATED.md b/ASC-OPENAPI-COVERAGE-GENERATED.md index fe835b4..b7fbd22 100644 --- a/ASC-OPENAPI-COVERAGE-GENERATED.md +++ b/ASC-OPENAPI-COVERAGE-GENERATED.md @@ -1,21 +1,21 @@ # App Store Connect OpenAPI Coverage -Generated: 2026-10-15 +Generated: 2026-11-07 Sources: - Apple App Store Connect API overview: https://developer.apple.com/app-store-connect/api/ - Apple App Store Connect API documentation: https://developer.apple.com/documentation/appstoreconnectapi - Apple OpenAPI specification download: https://developer.apple.com/sample-code/app-store-connect/app-store-connect-openapi-specification.zip -Spec: App Store Connect API 4.5.1 (OpenAPI 3.0.1) -Apple paths: 1001 -Apple operations: 1303 -Classified paths: 1001 +Spec: App Store Connect API 4.6 (OpenAPI 3.0.1) +Apple paths: 1027 +Apple operations: 1337 +Classified paths: 1027 Unclassified paths: 0 ## Priority Gaps -- P0 App Store app metadata and release operations: Partial, 332 Apple paths, 414 operations. +- P0 App Store app metadata and release operations: Partial, 334 Apple paths, 416 operations. - P0 TestFlight builds, testers, groups, and beta app review: Partial, 115 Apple paths, 154 operations. - P1 Provisioning and identifiers: Partial, 32 Apple paths, 49 operations. - P1 Reporting, analytics, metrics, and diagnostics: Partial, 47 Apple paths, 56 operations. @@ -25,7 +25,7 @@ Unclassified paths: 0 | Domain | Status | Priority | Apple paths | Operations | Workers | Notes | |---|---|---:|---:|---:|---|---| -| App Store app metadata and release operations | Partial | P0 | 332 | 414 | `apps`, `accessibility`, `versions`, `app_info`, `pricing`, `app_events`, `assets`, `screenshots`, `custom_pages`, `ppo`, `promoted`, `review_attachments`, `review_submissions`, `reviews`, `export_compliance` | The common release workflow includes strict version filtering and paging, safe phased-release controls, generic review submissions, App Info-owned age-rating inspection, app search keywords, expanded Custom Product Page and PPO workflows, promoted ordering, and verified screenshot and preview ordering. Remaining app-surface operations stay explicitly phased. | +| App Store app metadata and release operations | Partial | P0 | 334 | 416 | `apps`, `accessibility`, `versions`, `app_info`, `pricing`, `app_events`, `assets`, `screenshots`, `custom_pages`, `ppo`, `promoted`, `review_attachments`, `review_submissions`, `reviews`, `export_compliance` | The common release workflow includes strict version filtering and paging, safe phased-release controls, generic review submissions, App Info-owned age-rating inspection, app search keywords, expanded Custom Product Page and PPO workflows, promoted ordering, and verified screenshot and preview ordering. Remaining app-surface operations stay explicitly phased. | | TestFlight builds, testers, groups, and beta app review | Partial | P0 | 115 | 154 | `builds`, `build_uploads`, `build_processing`, `export_compliance`, `build_beta`, `beta_groups`, `beta_feedback`, `beta_testers`, `beta_app`, `pre_release`, `beta_license`, `metrics` | Core TestFlight administration, resumable build uploads, and dedicated beta feedback retrieval are covered. Six recruitment tools and five usage-metric tools map twelve additional Apple operations; beta App Clip APIs remain the main gap. | | Essentials: auth, errors, paging, uploads, rate limits | Partial | P1 | 0 | 0 | `auth` | Core runtime behavior is covered; OpenAPI drift is now generated from Apple's official specification. | | Provisioning and identifiers | Partial | P1 | 32 | 49 | `provisioning` | Core signing automation exists; Wallet and Apple Pay identifiers are useful next additions. | @@ -34,7 +34,7 @@ Unclassified paths: 0 | Xcode Cloud workflows and builds | Partial | P1 | 56 | 59 | `xcode_cloud` | Covers read-heavy CI dashboards plus start/rebuild build runs; destructive workflow/product management remains intentionally deferred. | | Alternative distribution | Missing | P2 | 21 | 28 | none | Region- and entitlement-sensitive APIs should be opt-in and strongly documented. | | Game Center | Missing | P2 | 244 | 343 | none | Large domain; should be added only after OpenAPI-driven scaffolding is in place. | -| In-app purchases, subscriptions, and offers | Partial | P2 | 172 | 218 | `iap`, `subscriptions` | Apple 4.4.1 versioned metadata, generic review submission handoff, plan-type-aware subscription availability, and adjusted equalizations are covered. Legacy product-scoped tools remain explicit compatibility paths; an authoritative fully paginated subscription inventory is still pending. | +| In-app purchases, subscriptions, and offers | Partial | P2 | 196 | 250 | `iap`, `subscriptions` | Apple 4.4.1 versioned metadata, Apple 4.6 subscription retention messaging, generic review submission handoff, plan-type-aware subscription availability, and adjusted equalizations are covered. Legacy product-scoped tools remain explicit compatibility paths; an authoritative fully paginated subscription inventory is still pending. | | Users, access, and sandbox testers | Partial | P2 | 13 | 20 | `users`, `sandbox` | User management is serviceable; API key operations should remain carefully annotated as high-risk. | | Webhook notifications | Covered | P2 | 6 | 8 | `webhooks` | Covers app webhooks, individual webhook reads, create/update/delete, delivery listing, redelivery, ping testing, and local receiver diagnostics. | diff --git a/CHANGELOG.md b/CHANGELOG.md index f9cd865..3c08477 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Added + +- Add 23 subscription retention messaging tools in `SubscriptionsWorker` (`subscriptions_*`) covering App Store Connect API 4.6 retention messages (`list`, `get`, `create`, `delete`), versions (`list`, `get`, `create`), localizations (`list`, `get`, `create`, `update`, `delete`) with Apple header/body/emoji/price-mention preflight validation, retention offers (`list`, `get`, `create`, `update`, `delete`, `list_retention_offer_prices`), and subscription retention relationships (`list_retention_message_subscriptions`, `get_retention_message_for_subscription`, `set_retention_message`, `add_retention_message_offers`, `remove_retention_message_offers`). +- Extend `AssetsWorker` (`assets_*`) to support `retentionMessageVersion` (`feature = "RETENTION_MESSAGING"`) image placements via Apple's to-one `/v1/retentionMessageVersions/{id}/placement` endpoint, with app-scoped ownership verification and explicit rejection of video placements and multi-placement reordering. +- Extend `ReviewSubmissionsWorker` (`review_submissions_*`) to support `retention_message_version_id` (`retentionMessageVersion` / `retentionMessageVersions`) in review submission item assembly and reads. +- Pin the official Apple 4.6 OpenAPI specification (`1,027` paths, `1,337` operations) and update the operation manifest (`537` public tools, `528` mapped operations, `440` waived, `369` scope-rule out of scope, `4,562` classified optional inputs with `0` unclassified). + ## [4.2.0] - 2026-10-19 ### Added diff --git a/README.md b/README.md index ce8b968..8feb906 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ ## Overview -**asc-mcp** is a Swift-based MCP server that connects a local macOS MCP client to the [App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi). It exposes **514 tools** across 34 App Store tool domains + 2 core domains, enabling you to automate iOS and macOS release workflows through natural language. +**asc-mcp** is a Swift-based MCP server that connects a local macOS MCP client to the [App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi). It exposes **537 tools** across 34 App Store tool domains + 2 core domains, enabling you to automate iOS and macOS release workflows through natural language. Configuration examples are included for Codex, Claude Code, Claude Desktop, Gemini CLI, VS Code with GitHub Copilot, Continue, Cursor, and Devin Desktop (formerly Windsurf). Client configuration is documented; release CI verifies installation, MCP initialization, and tool discovery on macOS rather than launching every third-party client. @@ -482,7 +482,7 @@ You can also disable individual tools in the client. Server-side worker filterin ## Worker Filtering -The server exposes **514 tools** across 34 App Store tool domains + 2 core domains. Some MCP clients impose a tool limit; Cascade in Devin Desktop currently allows 100 active tools. Use the 36 `--workers` filter keys to enable only the workers you need: +The server exposes **537 tools** across 34 App Store tool domains + 2 core domains. Some MCP clients impose a tool limit; Cascade in Devin Desktop currently allows 100 active tools. Use the 36 `--workers` filter keys to enable only the workers you need: ```bash # Only load apps, builds, and version lifecycle tools @@ -533,7 +533,7 @@ swift run asc-mcp openapi-contract-check \ --strict ``` -The manifest is pinned to Apple API 4.5.1 by version, SHA-256, path count, and operation count. It maps 503 Apple operations, explicitly defers 431, and scopes out 369, accounting for all 1,303 operations. Required CI checks the committed snapshot reproducibly. A separate latest-Apple comparison produces a semantic drift report and blocks publication until changes are reviewed. Contract CI fails when a mapped operation moves or disappears, a public tool or worker drifts from the manifest, an input field loses its binding, response lineage becomes invalid, or a deferred decision expires. Unexposed optional Apple parameters are warnings so they remain visible in the generated backlog. +The manifest is pinned to Apple API 4.6 by version, SHA-256, path count, and operation count. It maps 528 Apple operations, explicitly defers 440, and scopes out 369, accounting for all 1,337 operations. Required CI checks the committed snapshot reproducibly. A separate latest-Apple comparison produces a semantic drift report and blocks publication until changes are reviewed. Contract CI fails when a mapped operation moves or disappears, a public tool or worker drifts from the manifest, an input field loses its binding, response lineage becomes invalid, or a deferred decision expires. Unexposed optional Apple parameters are warnings so they remain visible in the generated backlog. Manifest schema v2 also accounts for every optional Apple query and request-body input as publicly bound, internally controlled, intentionally omitted with a reviewed reason, or still unclassified. The checked-in `optionalInputCoveragePin` records the exact current totals and a SHA-256 digest of the sorted input identities and dispositions; `--strict` rejects a missing pin or any count- or identity-level drift. The pin makes phased remediation auditable and regression-safe, but it is not a claim that every optional Apple input is already public. The v4.1.3 pin is 2,905 total: 1,122 bound, 40 internally controlled, 1,743 intentionally omitted, and 0 unclassified. Its identity SHA-256 is `c975f4e4eebb62ec87864a73fbf72bb8841f644108e54e6ffb25168bcf2a2766`. @@ -564,7 +564,7 @@ The older `openapi-coverage` command remains available for the high-level domain | `beta_feedback` | `beta_feedback_` | 8 | TestFlight feedback screenshots, crash submissions, crash logs | | `beta_testers` | `beta_testers_` | 12 | Tester management | | `iap` | `iap_` | 59 | In-app purchases, versioned metadata, pricing, availability, offer codes, review assets | -| `subscriptions` | `subscriptions_` | 99 | Subscription and group versions, pricing, plan availability, offers, assets | +| `subscriptions` | `subscriptions_` | 122 | Subscription and group versions, pricing, plan availability, offers, retention messaging, assets | | `sandbox` | `sandbox_` | 3 | Sandbox testers | | `beta_app` | `beta_app_` | 10 | Beta app localizations and review | | `pre_release` | `pre_release_` | 3 | Pre-release versions | @@ -590,20 +590,20 @@ When an MCP client eagerly loads every tool definition, the approximate schema f | Configuration | Tools | ~Tokens | |---|---:|---:| -| All workers (default) | 514 | **~60,000** | +| All workers (default) | 537 | **~62,700** | | Release workflow: `apps,builds,export_compliance,versions,reviews` | ~72 | ~8,900 | -| Monetization: `apps,iap,subscriptions,pricing` | 184 | ~21,100 | +| Monetization: `apps,iap,subscriptions,pricing` | 207 | ~23,800 | | TestFlight: `apps,builds,beta_groups,beta_testers` | ~63 | ~7,100 | | Marketing: `apps,screenshots,custom_pages,ppo,promoted` | ~78 | ~8,800 | | `--workers apps` | 17 | ~2,100 | -**Heaviest workers:** Subscriptions (99 tools), InAppPurchases (59 tools), Xcode Cloud (42 tools), Screenshots (19 tools), Provisioning (17 tools). +**Heaviest workers:** Subscriptions (122 tools), InAppPurchases (59 tools), Xcode Cloud (42 tools), Screenshots (19 tools), Provisioning (17 tools). Exact cost depends on the MCP host's serialization, tokenizer, and tool-discovery strategy. Modern clients may defer schemas until they are needed. Use `--workers` when the client enforces a tool limit or when you want a smaller, more focused catalog. ## Available Tools -**514 tools** organized across 34 App Store tool domains + 2 core domains (use the 36 `--workers` filter keys — see [Worker Filtering](#worker-filtering)): +**537 tools** organized across 34 App Store tool domains + 2 core domains (use the 36 `--workers` filter keys — see [Worker Filtering](#worker-filtering)):
Company Management — 3 tools @@ -970,9 +970,9 @@ If Apple may have accepted a version or version-localization create but the resp
-Subscriptions — 99 tools +Subscriptions — 122 tools -Includes subscription and group metadata versions, version-owned localizations and images, plan-type-aware availability, territory-aware prices, price points and adjusted equalizations, promoted purchase reads, inventory/pricing helpers, intro offers, promotional offers, offer codes, one-time/custom codes, win-back offers, and review screenshots. All former public `offer_codes_*`, `intro_offers_*`, `promo_offers_*`, and `winback_*` functionality is exposed through `subscriptions_*`. +Includes subscription and group metadata versions, version-owned localizations and images, plan-type-aware availability, territory-aware prices, price points and adjusted equalizations, promoted purchase reads, inventory/pricing helpers, intro offers, promotional offers, offer codes, one-time/custom codes, win-back offers, subscription retention messaging (retention messages, versions, localizations, retention offers, and subscription retention relationships), and review screenshots. All former public `offer_codes_*`, `intro_offers_*`, `promo_offers_*`, and `winback_*` functionality is exposed through `subscriptions_*`. Apple 4.4.1 also deprecates the legacy product- or group-scoped localization, image, and submission tools. They remain callable for compatibility, return explicit replacement guidance on success, and never create or select a metadata version automatically. New integrations should use `subscriptions_create_version` or `subscriptions_create_group_version`, the corresponding version-localization/image tools, and the generic `review_submissions_*` workflow. diff --git a/Sources/asc-mcp/Core/ASCCoverageInventory.swift b/Sources/asc-mcp/Core/ASCCoverageInventory.swift index 997c144..5584af4 100644 --- a/Sources/asc-mcp/Core/ASCCoverageInventory.swift +++ b/Sources/asc-mcp/Core/ASCCoverageInventory.swift @@ -39,7 +39,7 @@ struct ASCCoverageArea: Sendable { enum ASCCoverageInventory { static let snapshotDate = "2026-10-15" - static let appleAPIVersionBaseline = "4.5.1" + static let appleAPIVersionBaseline = "4.6" static let areas: [ASCCoverageArea] = [ ASCCoverageArea( @@ -182,12 +182,13 @@ enum ASCCoverageInventory { "promotional offers", "pricing summaries and compatibility inventory helper", "review screenshot and image uploads", - "subscription organization market settings and multi-seat PATCH controls" + "subscription organization market settings and multi-seat PATCH controls", + "subscription retention messaging (messages, versions, localizations, retention offers, and subscription retention relationships)" ], missingCapabilities: [ "authoritative fully paginated subscription inventory" ], - notes: "Apple 4.4.1 versioned metadata, generic review submission handoff, plan-type-aware subscription availability, and adjusted equalizations are covered. Legacy product-scoped tools remain explicit compatibility paths; an authoritative fully paginated subscription inventory is still pending." + notes: "Apple 4.4.1 versioned metadata, Apple 4.6 subscription retention messaging, generic review submission handoff, plan-type-aware subscription availability, and adjusted equalizations are covered. Legacy product-scoped tools remain explicit compatibility paths; an authoritative fully paginated subscription inventory is still pending." ), ASCCoverageArea( name: "Provisioning and identifiers", diff --git a/Sources/asc-mcp/Core/Application.swift b/Sources/asc-mcp/Core/Application.swift index d638945..5e1191e 100644 --- a/Sources/asc-mcp/Core/Application.swift +++ b/Sources/asc-mcp/Core/Application.swift @@ -62,7 +62,7 @@ public func runApplication(options: AppRuntimeOptions = AppRuntimeOptions()) asy - users_* — team members and roles - app_events_* — in-app events - analytics_* — sales and financial reports - - subscriptions_* -- subscription and offer management (groups, products, prices, availability, intro/promotional/offer-code/win-back offers) + - subscriptions_* -- subscription and offer management (groups, products, prices, availability, intro/promotional/offer-code/win-back offers, retention messaging) - sandbox_* -- sandbox testers management (list, update, clear purchase history) - beta_app_* -- beta app localizations, review submissions, review details - pre_release_* -- pre-release versions (list, get, builds) diff --git a/Sources/asc-mcp/Helpers/ToolMetadataPolicy.swift b/Sources/asc-mcp/Helpers/ToolMetadataPolicy.swift index c91bad8..9b440d6 100644 --- a/Sources/asc-mcp/Helpers/ToolMetadataPolicy.swift +++ b/Sources/asc-mcp/Helpers/ToolMetadataPolicy.swift @@ -86,7 +86,8 @@ enum ToolMetadataPolicy { "build_uploads_reserve_file", "build_uploads_commit_file", "custom_pages_add_search_keywords", - "custom_pages_remove_search_keywords" + "custom_pages_remove_search_keywords", + "subscriptions_add_retention_message_offers" ] private static let assetToolReadEffects: [String: Bool] = [ diff --git a/Sources/asc-mcp/Models/Assets/AssetLibraryModels.swift b/Sources/asc-mcp/Models/Assets/AssetLibraryModels.swift index 93a3017..ce99d92 100644 --- a/Sources/asc-mcp/Models/Assets/AssetLibraryModels.swift +++ b/Sources/asc-mcp/Models/Assets/AssetLibraryModels.swift @@ -61,6 +61,11 @@ struct AssetLibraryDocument: Codable, Sendable { let data: AssetLibraryResource } +struct AssetOptionalLibraryDocument: Codable, Sendable { + let data: AssetLibraryResource? + let links: [String: JSONValue]? +} + struct AssetLibraryCollection: Codable, Sendable { let data: [AssetLibraryResource] let links: [String: JSONValue]? @@ -80,15 +85,27 @@ enum AssetLibraryTarget: String, Codable, Sendable, CaseIterable { case appCustomProductPageLocalization case appStoreVersionExperimentTreatmentLocalization case appEventLocalization + case retentionMessageVersion var resourceType: String { rawValue + "s" } + var isToOnePlacementEndpoint: Bool { self == .retentionMessageVersion } + var supportsOrdering: Bool { self != .appEventLocalization && self != .retentionMessageVersion } var feature: String { switch self { case .appStoreVersionLocalization: "APP_STORE_VERSIONS" case .appCustomProductPageLocalization: "CUSTOM_PRODUCT_PAGES" case .appStoreVersionExperimentTreatmentLocalization: "PRODUCT_PAGE_OPTIMIZATIONS" case .appEventLocalization: "IN_APP_EVENTS" + case .retentionMessageVersion: "RETENTION_MESSAGING" + } + } + + func placementsPath(id: String) throws -> String { + let encodedID = try ASCPathSegment.encode(id) + if isToOnePlacementEndpoint { + return "/v1/\(try ASCPathSegment.encode(resourceType))/\(encodedID)/placement" } + return "/v1/\(try ASCPathSegment.encode(resourceType))/\(encodedID)/placements" } } diff --git a/Sources/asc-mcp/Models/ReviewSubmissions/ReviewSubmissionModels.swift b/Sources/asc-mcp/Models/ReviewSubmissions/ReviewSubmissionModels.swift index 65ed6ec..72cc4f3 100644 --- a/Sources/asc-mcp/Models/ReviewSubmissions/ReviewSubmissionModels.swift +++ b/Sources/asc-mcp/Models/ReviewSubmissions/ReviewSubmissionModels.swift @@ -82,6 +82,7 @@ enum ASCReviewSubmissionItemRelation: String, CaseIterable, Sendable { case inAppPurchaseVersion case subscriptionVersion case subscriptionGroupVersion + case retentionMessageVersion var resourceType: String { switch self { @@ -101,6 +102,8 @@ enum ASCReviewSubmissionItemRelation: String, CaseIterable, Sendable { "subscriptionVersions" case .subscriptionGroupVersion: "subscriptionGroupVersions" + case .retentionMessageVersion: + "retentionMessageVersions" } } } @@ -212,6 +215,7 @@ struct ASCReviewSubmissionItemCreateRequest: Codable, Sendable { let inAppPurchaseVersion: ASCReviewSubmissionRequiredRelationship? let subscriptionVersion: ASCReviewSubmissionRequiredRelationship? let subscriptionGroupVersion: ASCReviewSubmissionRequiredRelationship? + let retentionMessageVersion: ASCReviewSubmissionRequiredRelationship? init( submissionID: String, @@ -238,6 +242,7 @@ struct ASCReviewSubmissionItemCreateRequest: Codable, Sendable { inAppPurchaseVersion = relation == .inAppPurchaseVersion ? resource : nil subscriptionVersion = relation == .subscriptionVersion ? resource : nil subscriptionGroupVersion = relation == .subscriptionGroupVersion ? resource : nil + retentionMessageVersion = relation == .retentionMessageVersion ? resource : nil } } } @@ -369,6 +374,7 @@ struct ASCReviewSubmissionItem: Codable, Sendable { let inAppPurchaseVersion: ASCRelationship? let subscriptionVersion: ASCRelationship? let subscriptionGroupVersion: ASCRelationship? + let retentionMessageVersion: ASCRelationship? } } diff --git a/Sources/asc-mcp/Models/Subscriptions/RetentionMessagingModels.swift b/Sources/asc-mcp/Models/Subscriptions/RetentionMessagingModels.swift new file mode 100644 index 0000000..841c6a9 --- /dev/null +++ b/Sources/asc-mcp/Models/Subscriptions/RetentionMessagingModels.swift @@ -0,0 +1,1163 @@ +import Foundation + +// MARK: - Shared Retention Helpers & Included Resources + +/// Integer range for retention offer subscriber eligibility duration in months +public struct RetentionIntegerRange: Codable, Sendable, Equatable { + public let minimum: Int? + public let maximum: Int? + + public init(minimum: Int? = nil, maximum: Int? = nil) { + self.minimum = minimum + self.maximum = maximum + } +} + +extension WinBackOfferAttributes { + /// Alias for integer range used across commerce offer models + public typealias IntegerRange = RetentionIntegerRange +} + +/// Included resource in retention messaging responses +public struct ASCRetentionMessageIncludedResource: Codable, Sendable { + public let type: String + public let id: String + public let attributes: [String: JSONValue]? + public let relationships: [String: JSONValue]? + + public init( + type: String, + id: String, + attributes: [String: JSONValue]? = nil, + relationships: [String: JSONValue]? = nil + ) { + self.type = type + self.id = id + self.attributes = attributes + self.relationships = relationships + } +} + +/// Included resource in win-back and retention offer price responses +public struct ASCWinBackOfferPriceIncludedResource: Codable, Sendable { + public let type: String + public let id: String + public let attributes: [String: JSONValue]? + public let relationships: [String: JSONValue]? + + public init( + type: String, + id: String, + attributes: [String: JSONValue]? = nil, + relationships: [String: JSONValue]? = nil + ) { + self.type = type + self.id = id + self.attributes = attributes + self.relationships = relationships + } +} + +/// Helper for decoding `ASCPagedDocumentLinks` even when test fixtures omit `links` or `links.self` +private struct LenientPagedDocumentLinks: Codable, Sendable { + let first: String? + let next: String? + let selfLink: String? + + private enum CodingKeys: String, CodingKey { + case first + case next + case selfLink = "self" + } + + var asPagedDocumentLinks: ASCPagedDocumentLinks { + ASCPagedDocumentLinks(first: first, next: next, self: selfLink ?? "") + } +} + +// MARK: - Retention Messages + +/// Response wrapper for multiple retention messages +public struct ASCRetentionMessagesResponse: Codable, Sendable { + public let data: [ASCRetentionMessage] + public let included: [ASCRetentionMessageIncludedResource]? + public let links: ASCPagedDocumentLinks + public let meta: ASCPagingInformation? + + public init( + data: [ASCRetentionMessage], + included: [ASCRetentionMessageIncludedResource]? = nil, + links: ASCPagedDocumentLinks, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = links + self.meta = meta + } + + public init( + data: [ASCRetentionMessage], + included: [ASCRetentionMessageIncludedResource]? = nil, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = meta + } + + private enum CodingKeys: String, CodingKey { + case data + case included + case links + case meta + } + + public init(from decoder: Decoder) throws { + let container = try decoder.container(keyedBy: CodingKeys.self) + self.data = try container.decode([ASCRetentionMessage].self, forKey: .data) + self.included = try container.decodeIfPresent([ASCRetentionMessageIncludedResource].self, forKey: .included) + let lenientLinks = try container.decodeIfPresent(LenientPagedDocumentLinks.self, forKey: .links) + self.links = lenientLinks?.asPagedDocumentLinks ?? ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = try container.decodeIfPresent(ASCPagingInformation.self, forKey: .meta) + } +} + +/// Response wrapper for a single retention message +public struct ASCRetentionMessageResponse: Codable, Sendable { + public let data: ASCRetentionMessage + public let included: [ASCRetentionMessageIncludedResource]? + public let links: ASCDocumentLinks? + + public init( + data: ASCRetentionMessage, + included: [ASCRetentionMessageIncludedResource]? = nil, + links: ASCDocumentLinks? = nil + ) { + self.data = data + self.included = included + self.links = links + } +} + +/// Response wrapper for an optional retention message (`GET /v1/subscriptions/{id}/retentionMessage` can return `{"data": null}`) +public struct ASCRetentionMessageOptionalResponse: Codable, Sendable { + public let data: ASCRetentionMessage? + public let included: [ASCRetentionMessageIncludedResource]? + public let links: ASCDocumentLinks? + + public init( + data: ASCRetentionMessage?, + included: [ASCRetentionMessageIncludedResource]? = nil, + links: ASCDocumentLinks? = nil + ) { + self.data = data + self.included = included + self.links = links + } +} + +/// Retention message resource +public struct ASCRetentionMessage: Codable, Sendable { + public let type: String + public let id: String + public let attributes: RetentionMessageAttributes? + public let relationships: RetentionMessageRelationships? + + public init( + type: String = "retentionMessages", + id: String, + attributes: RetentionMessageAttributes? = nil, + relationships: RetentionMessageRelationships? = nil + ) { + self.type = type + self.id = id + self.attributes = attributes + self.relationships = relationships + } +} + +/// Retention message attributes +public struct RetentionMessageAttributes: Codable, Sendable { + public let referenceName: String? + + public init(referenceName: String? = nil) { + self.referenceName = referenceName + } +} + +/// Retention message relationships +public struct RetentionMessageRelationships: Codable, Sendable { + public let app: ASCRelationship? + public let versions: ASCRelationshipMultiple? + public let retentionMessageVersions: ASCRelationshipMultiple? + public let subscriptions: ASCRelationshipMultiple? + + public init( + app: ASCRelationship? = nil, + versions: ASCRelationshipMultiple? = nil, + retentionMessageVersions: ASCRelationshipMultiple? = nil, + subscriptions: ASCRelationshipMultiple? = nil + ) { + self.app = app + self.versions = versions + self.retentionMessageVersions = retentionMessageVersions + self.subscriptions = subscriptions + } +} + +// MARK: - Retention Message Versions + +/// Response wrapper for multiple retention message versions +public struct ASCRetentionMessageVersionsResponse: Codable, Sendable { + public let data: [ASCRetentionMessageVersion] + public let included: [ASCRetentionMessageIncludedResource]? + public let links: ASCPagedDocumentLinks + public let meta: ASCPagingInformation? + + public init( + data: [ASCRetentionMessageVersion], + included: [ASCRetentionMessageIncludedResource]? = nil, + links: ASCPagedDocumentLinks, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = links + self.meta = meta + } + + public init( + data: [ASCRetentionMessageVersion], + included: [ASCRetentionMessageIncludedResource]? = nil, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = meta + } + + private enum CodingKeys: String, CodingKey { + case data + case included + case links + case meta + } + + public init(from decoder: Decoder) throws { + let container = try decoder.container(keyedBy: CodingKeys.self) + self.data = try container.decode([ASCRetentionMessageVersion].self, forKey: .data) + self.included = try container.decodeIfPresent([ASCRetentionMessageIncludedResource].self, forKey: .included) + let lenientLinks = try container.decodeIfPresent(LenientPagedDocumentLinks.self, forKey: .links) + self.links = lenientLinks?.asPagedDocumentLinks ?? ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = try container.decodeIfPresent(ASCPagingInformation.self, forKey: .meta) + } +} + +/// Response wrapper for a single retention message version +public struct ASCRetentionMessageVersionResponse: Codable, Sendable { + public let data: ASCRetentionMessageVersion + public let included: [ASCRetentionMessageIncludedResource]? + public let links: ASCDocumentLinks? + + public init( + data: ASCRetentionMessageVersion, + included: [ASCRetentionMessageIncludedResource]? = nil, + links: ASCDocumentLinks? = nil + ) { + self.data = data + self.included = included + self.links = links + } +} + +/// Retention message version resource +public struct ASCRetentionMessageVersion: Codable, Sendable { + public let type: String + public let id: String + public let attributes: RetentionMessageVersionAttributes? + public let relationships: RetentionMessageVersionRelationships? + + public init( + type: String = "retentionMessageVersions", + id: String, + attributes: RetentionMessageVersionAttributes? = nil, + relationships: RetentionMessageVersionRelationships? = nil + ) { + self.type = type + self.id = id + self.attributes = attributes + self.relationships = relationships + } +} + +/// Retention message version attributes +public struct RetentionMessageVersionAttributes: Codable, Sendable { + public let state: String? + public let version: Int? + + public init(state: String? = nil, version: Int? = nil) { + self.state = state + self.version = version + } +} + +/// Retention message version relationships +public struct RetentionMessageVersionRelationships: Codable, Sendable { + public let retentionMessage: ASCRelationship? + public let placement: ASCRelationship? + public let localizations: ASCRelationshipMultiple? + public let retentionMessageLocalizations: ASCRelationshipMultiple? + + public init( + retentionMessage: ASCRelationship? = nil, + placement: ASCRelationship? = nil, + localizations: ASCRelationshipMultiple? = nil, + retentionMessageLocalizations: ASCRelationshipMultiple? = nil + ) { + self.retentionMessage = retentionMessage + self.placement = placement + self.localizations = localizations + self.retentionMessageLocalizations = retentionMessageLocalizations + } +} + +// MARK: - Retention Message Localizations + +/// Response wrapper for multiple retention message localizations +public struct ASCRetentionMessageLocalizationsResponse: Codable, Sendable { + public let data: [ASCRetentionMessageLocalization] + public let included: [ASCRetentionMessageIncludedResource]? + public let links: ASCPagedDocumentLinks + public let meta: ASCPagingInformation? + + public init( + data: [ASCRetentionMessageLocalization], + included: [ASCRetentionMessageIncludedResource]? = nil, + links: ASCPagedDocumentLinks, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = links + self.meta = meta + } + + public init( + data: [ASCRetentionMessageLocalization], + included: [ASCRetentionMessageIncludedResource]? = nil, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = meta + } + + private enum CodingKeys: String, CodingKey { + case data + case included + case links + case meta + } + + public init(from decoder: Decoder) throws { + let container = try decoder.container(keyedBy: CodingKeys.self) + self.data = try container.decode([ASCRetentionMessageLocalization].self, forKey: .data) + self.included = try container.decodeIfPresent([ASCRetentionMessageIncludedResource].self, forKey: .included) + let lenientLinks = try container.decodeIfPresent(LenientPagedDocumentLinks.self, forKey: .links) + self.links = lenientLinks?.asPagedDocumentLinks ?? ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = try container.decodeIfPresent(ASCPagingInformation.self, forKey: .meta) + } +} + +/// Response wrapper for a single retention message localization +public struct ASCRetentionMessageLocalizationResponse: Codable, Sendable { + public let data: ASCRetentionMessageLocalization + public let included: [ASCRetentionMessageIncludedResource]? + public let links: ASCDocumentLinks? + + public init( + data: ASCRetentionMessageLocalization, + included: [ASCRetentionMessageIncludedResource]? = nil, + links: ASCDocumentLinks? = nil + ) { + self.data = data + self.included = included + self.links = links + } +} + +/// Retention message localization resource +public struct ASCRetentionMessageLocalization: Codable, Sendable { + public let type: String + public let id: String + public let attributes: RetentionMessageLocalizationAttributes? + public let relationships: RetentionMessageLocalizationRelationships? + + public init( + type: String = "retentionMessageLocalizations", + id: String, + attributes: RetentionMessageLocalizationAttributes? = nil, + relationships: RetentionMessageLocalizationRelationships? = nil + ) { + self.type = type + self.id = id + self.attributes = attributes + self.relationships = relationships + } +} + +/// Retention message localization attributes +public struct RetentionMessageLocalizationAttributes: Codable, Sendable { + public let locale: String? + public let header: String? + public let body: String? + + public init(locale: String? = nil, header: String? = nil, body: String? = nil) { + self.locale = locale + self.header = header + self.body = body + } +} + +/// Retention message localization relationships +public struct RetentionMessageLocalizationRelationships: Codable, Sendable { + public let retentionMessageVersion: ASCRelationship? + public let version: ASCRelationship? + + public init(retentionMessageVersion: ASCRelationship? = nil, version: ASCRelationship? = nil) { + self.retentionMessageVersion = retentionMessageVersion + self.version = version + } +} + +// MARK: - Retention Offers + +/// Response wrapper for multiple retention offers +public struct ASCRetentionOffersResponse: Codable, Sendable { + public let data: [ASCRetentionOffer] + public let included: [ASCRetentionMessageIncludedResource]? + public let links: ASCPagedDocumentLinks + public let meta: ASCPagingInformation? + + public init( + data: [ASCRetentionOffer], + included: [ASCRetentionMessageIncludedResource]? = nil, + links: ASCPagedDocumentLinks, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = links + self.meta = meta + } + + public init( + data: [ASCRetentionOffer], + included: [ASCRetentionMessageIncludedResource]? = nil, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = meta + } + + private enum CodingKeys: String, CodingKey { + case data + case included + case links + case meta + } + + public init(from decoder: Decoder) throws { + let container = try decoder.container(keyedBy: CodingKeys.self) + self.data = try container.decode([ASCRetentionOffer].self, forKey: .data) + self.included = try container.decodeIfPresent([ASCRetentionMessageIncludedResource].self, forKey: .included) + let lenientLinks = try container.decodeIfPresent(LenientPagedDocumentLinks.self, forKey: .links) + self.links = lenientLinks?.asPagedDocumentLinks ?? ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = try container.decodeIfPresent(ASCPagingInformation.self, forKey: .meta) + } +} + +/// Response wrapper for a single retention offer +public struct ASCRetentionOfferResponse: Codable, Sendable { + public let data: ASCRetentionOffer + public let included: [ASCRetentionMessageIncludedResource]? + public let links: ASCDocumentLinks? + + public init( + data: ASCRetentionOffer, + included: [ASCRetentionMessageIncludedResource]? = nil, + links: ASCDocumentLinks? = nil + ) { + self.data = data + self.included = included + self.links = links + } +} + +/// Retention offer resource +public struct ASCRetentionOffer: Codable, Sendable { + public let type: String + public let id: String + public let attributes: RetentionOfferAttributes? + public let relationships: RetentionOfferRelationships? + + public init( + type: String = "retentionOffers", + id: String, + attributes: RetentionOfferAttributes? = nil, + relationships: RetentionOfferRelationships? = nil + ) { + self.type = type + self.id = id + self.attributes = attributes + self.relationships = relationships + } +} + +/// Retention offer attributes +public struct RetentionOfferAttributes: Codable, Sendable { + public typealias IntegerRange = RetentionIntegerRange + + public let referenceName: String? + public let offerMode: String? + public let duration: String? + public let periods: Int? + public let eligibilitySubscriberDurationType: String? + public let eligibilitySubscriberDurationInMonths: IntegerRange? + public let waitBetweenOffersInMonths: Int? + + public init( + referenceName: String? = nil, + offerMode: String? = nil, + duration: String? = nil, + periods: Int? = nil, + eligibilitySubscriberDurationType: String? = nil, + eligibilitySubscriberDurationInMonths: IntegerRange? = nil, + waitBetweenOffersInMonths: Int? = nil + ) { + self.referenceName = referenceName + self.offerMode = offerMode + self.duration = duration + self.periods = periods + self.eligibilitySubscriberDurationType = eligibilitySubscriberDurationType + self.eligibilitySubscriberDurationInMonths = eligibilitySubscriberDurationInMonths + self.waitBetweenOffersInMonths = waitBetweenOffersInMonths + } +} + +/// Retention offer relationships +public struct RetentionOfferRelationships: Codable, Sendable { + public let subscription: ASCRelationship? + public let prices: ASCRelationshipMultiple? + + public init(subscription: ASCRelationship? = nil, prices: ASCRelationshipMultiple? = nil) { + self.subscription = subscription + self.prices = prices + } +} + +// MARK: - Retention Offer Prices + +/// Response wrapper for retention offer prices +public struct ASCRetentionOfferPricesResponse: Codable, Sendable { + public let data: [ASCRetentionOfferPrice] + public let included: [ASCWinBackOfferPriceIncludedResource]? + public let links: ASCPagedDocumentLinks + public let meta: ASCPagingInformation? + + public init( + data: [ASCRetentionOfferPrice], + included: [ASCWinBackOfferPriceIncludedResource]? = nil, + links: ASCPagedDocumentLinks, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = links + self.meta = meta + } + + public init( + data: [ASCRetentionOfferPrice], + included: [ASCWinBackOfferPriceIncludedResource]? = nil, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = meta + } + + private enum CodingKeys: String, CodingKey { + case data + case included + case links + case meta + } + + public init(from decoder: Decoder) throws { + let container = try decoder.container(keyedBy: CodingKeys.self) + self.data = try container.decode([ASCRetentionOfferPrice].self, forKey: .data) + self.included = try container.decodeIfPresent([ASCWinBackOfferPriceIncludedResource].self, forKey: .included) + let lenientLinks = try container.decodeIfPresent(LenientPagedDocumentLinks.self, forKey: .links) + self.links = lenientLinks?.asPagedDocumentLinks ?? ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = try container.decodeIfPresent(ASCPagingInformation.self, forKey: .meta) + } +} + +/// Retention offer price resource +public struct ASCRetentionOfferPrice: Codable, Sendable { + public let type: String + public let id: String + public let relationships: RetentionOfferPriceRelationships? + + public init( + type: String = "retentionOfferPrices", + id: String, + relationships: RetentionOfferPriceRelationships? = nil + ) { + self.type = type + self.id = id + self.relationships = relationships + } +} + +/// Retention offer price relationships +public struct RetentionOfferPriceRelationships: Codable, Sendable { + public let territory: ASCRelationship? + public let subscriptionPricePoint: ASCRelationship? + + public init(territory: ASCRelationship? = nil, subscriptionPricePoint: ASCRelationship? = nil) { + self.territory = territory + self.subscriptionPricePoint = subscriptionPricePoint + } +} + +// MARK: - Retention Message Subscriptions Response + +/// Subscription item returned by `GET /v1/retentionMessages/{id}/subscriptions` +public struct ASCRetentionMessageSubscription: Codable, Sendable { + public let type: String + public let id: String + public let attributes: SubscriptionAttributes? + public let relationships: [String: JSONValue]? + + public init( + type: String = "subscriptions", + id: String, + attributes: SubscriptionAttributes? = nil, + relationships: [String: JSONValue]? = nil + ) { + self.type = type + self.id = id + self.attributes = attributes + self.relationships = relationships + } +} + +/// Response wrapper for subscriptions associated with a retention message +public struct ASCRetentionMessageSubscriptionsResponse: Codable, Sendable { + public let data: [ASCRetentionMessageSubscription] + public let included: [ASCRetentionMessageIncludedResource]? + public let links: ASCPagedDocumentLinks + public let meta: ASCPagingInformation? + + public init( + data: [ASCRetentionMessageSubscription], + included: [ASCRetentionMessageIncludedResource]? = nil, + links: ASCPagedDocumentLinks, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = links + self.meta = meta + } + + public init( + data: [ASCRetentionMessageSubscription], + included: [ASCRetentionMessageIncludedResource]? = nil, + meta: ASCPagingInformation? = nil + ) { + self.data = data + self.included = included + self.links = ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = meta + } + + private enum CodingKeys: String, CodingKey { + case data + case included + case links + case meta + } + + public init(from decoder: Decoder) throws { + let container = try decoder.container(keyedBy: CodingKeys.self) + self.data = try container.decode([ASCRetentionMessageSubscription].self, forKey: .data) + self.included = try container.decodeIfPresent([ASCRetentionMessageIncludedResource].self, forKey: .included) + let lenientLinks = try container.decodeIfPresent(LenientPagedDocumentLinks.self, forKey: .links) + self.links = lenientLinks?.asPagedDocumentLinks ?? ASCPagedDocumentLinks(first: nil, next: nil, self: "") + self.meta = try container.decodeIfPresent(ASCPagingInformation.self, forKey: .meta) + } +} + +// MARK: - Request Models + +/// Request to create a retention message +public struct RetentionMessageCreateRequest: Codable, Sendable { + public let data: CreateData + + public init(data: CreateData) { + self.data = data + } + + public init(appId: String, referenceName: String) { + self.data = CreateData( + attributes: Attributes(referenceName: referenceName), + relationships: Relationships( + app: AppRelationship( + data: ASCResourceIdentifier(type: "apps", id: appId) + ) + ) + ) + } + + public struct CreateData: Codable, Sendable { + public let type: String + public let attributes: Attributes + public let relationships: Relationships + + public init( + type: String = "retentionMessages", + attributes: Attributes, + relationships: Relationships + ) { + self.type = type + self.attributes = attributes + self.relationships = relationships + } + } + + public struct Attributes: Codable, Sendable { + public let referenceName: String + + public init(referenceName: String) { + self.referenceName = referenceName + } + } + + public struct Relationships: Codable, Sendable { + public let app: AppRelationship + + public init(app: AppRelationship) { + self.app = app + } + } + + public struct AppRelationship: Codable, Sendable { + public let data: ASCResourceIdentifier + + public init(data: ASCResourceIdentifier) { + self.data = data + } + } +} + +/// Request to create a retention message version +public struct RetentionMessageVersionCreateRequest: Codable, Sendable { + public let data: CreateData + + public init(data: CreateData) { + self.data = data + } + + public init(retentionMessageId: String) { + self.data = CreateData( + relationships: Relationships( + retentionMessage: RetentionMessageRelationship( + data: ASCResourceIdentifier(type: "retentionMessages", id: retentionMessageId) + ) + ) + ) + } + + public struct CreateData: Codable, Sendable { + public let type: String + public let relationships: Relationships + + public init( + type: String = "retentionMessageVersions", + relationships: Relationships + ) { + self.type = type + self.relationships = relationships + } + } + + public struct Relationships: Codable, Sendable { + public let retentionMessage: RetentionMessageRelationship + + public init(retentionMessage: RetentionMessageRelationship) { + self.retentionMessage = retentionMessage + } + } + + public struct RetentionMessageRelationship: Codable, Sendable { + public let data: ASCResourceIdentifier + + public init(data: ASCResourceIdentifier) { + self.data = data + } + } +} + +/// Request to create a retention message localization +public struct RetentionMessageLocalizationCreateRequest: Codable, Sendable { + public let data: CreateData + + public init(data: CreateData) { + self.data = data + } + + public init(versionId: String, locale: String, header: String, body: String) { + self.data = CreateData( + attributes: Attributes(locale: locale, header: header, body: body), + relationships: Relationships( + retentionMessageVersion: VersionRelationship( + data: ASCResourceIdentifier(type: "retentionMessageVersions", id: versionId) + ) + ) + ) + } + + public struct CreateData: Codable, Sendable { + public let type: String + public let attributes: Attributes + public let relationships: Relationships + + public init( + type: String = "retentionMessageLocalizations", + attributes: Attributes, + relationships: Relationships + ) { + self.type = type + self.attributes = attributes + self.relationships = relationships + } + } + + public struct Attributes: Codable, Sendable { + public let locale: String + public let header: String + public let body: String + + public init(locale: String, header: String, body: String) { + self.locale = locale + self.header = header + self.body = body + } + } + + public struct Relationships: Codable, Sendable { + public let retentionMessageVersion: VersionRelationship + + public init(retentionMessageVersion: VersionRelationship) { + self.retentionMessageVersion = retentionMessageVersion + } + } + + public struct VersionRelationship: Codable, Sendable { + public let data: ASCResourceIdentifier + + public init(data: ASCResourceIdentifier) { + self.data = data + } + } +} + +/// Request to update a retention message localization +public struct RetentionMessageLocalizationUpdateRequest: Codable, Sendable { + public let data: UpdateData + + public init(data: UpdateData) { + self.data = data + } + + public init( + localizationId: String, + header: ASCNullable? = nil, + body: ASCNullable? = nil + ) { + self.data = UpdateData( + id: localizationId, + attributes: Attributes(header: header, body: body) + ) + } + + public struct UpdateData: Codable, Sendable { + public let type: String + public let id: String + public let attributes: Attributes + + public init( + type: String = "retentionMessageLocalizations", + id: String, + attributes: Attributes + ) { + self.type = type + self.id = id + self.attributes = attributes + } + } + + public struct Attributes: Codable, Sendable { + public let header: ASCNullable? + public let body: ASCNullable? + + public init( + header: ASCNullable? = nil, + body: ASCNullable? = nil + ) { + self.header = header + self.body = body + } + } +} + +/// Request to create a retention offer with inline prices +public struct RetentionOfferCreateRequest: Codable, Sendable { + public let data: CreateData + public let included: [RetentionOfferPriceInlineCreate]? + + public init(data: CreateData, included: [RetentionOfferPriceInlineCreate]? = nil) { + self.data = data + self.included = included + } + + public struct CreateData: Codable, Sendable { + public let type: String + public let attributes: Attributes + public let relationships: Relationships + + public init( + type: String = "retentionOffers", + attributes: Attributes, + relationships: Relationships + ) { + self.type = type + self.attributes = attributes + self.relationships = relationships + } + } + + public struct Attributes: Codable, Sendable { + public let referenceName: String + public let offerMode: String + public let duration: String + public let periods: Int + public let eligibilitySubscriberDurationType: String + public let eligibilitySubscriberDurationInMonths: RetentionIntegerRange? + public let waitBetweenOffersInMonths: Int + + public init( + referenceName: String, + offerMode: String, + duration: String, + periods: Int, + eligibilitySubscriberDurationType: String, + eligibilitySubscriberDurationInMonths: RetentionIntegerRange? = nil, + waitBetweenOffersInMonths: Int + ) { + self.referenceName = referenceName + self.offerMode = offerMode + self.duration = duration + self.periods = periods + self.eligibilitySubscriberDurationType = eligibilitySubscriberDurationType + self.eligibilitySubscriberDurationInMonths = eligibilitySubscriberDurationInMonths + self.waitBetweenOffersInMonths = waitBetweenOffersInMonths + } + } + + public struct Relationships: Codable, Sendable { + public let subscription: SubscriptionRelationship + public let prices: PricesRelationship + + public init(subscription: SubscriptionRelationship, prices: PricesRelationship) { + self.subscription = subscription + self.prices = prices + } + } + + public struct SubscriptionRelationship: Codable, Sendable { + public let data: ASCResourceIdentifier + + public init(data: ASCResourceIdentifier) { + self.data = data + } + } + + public struct PricesRelationship: Codable, Sendable { + public let data: [ASCResourceIdentifier] + + public init(data: [ASCResourceIdentifier]) { + self.data = data + } + } +} + +/// Inline price creation resource for `RetentionOfferCreateRequest.included` +/// Note: Apple's OpenAPI 4.6 schema omits `subscriptionPricePoint` from `RetentionOfferPriceInlineCreate`, +/// but the runtime API requires `relationships.subscriptionPricePoint.data` on each inline price item. +public struct RetentionOfferPriceInlineCreate: Codable, Sendable { + public let type: String + public let id: String? + public let relationships: Relationships + + public init( + type: String = "retentionOfferPrices", + id: String?, + relationships: Relationships + ) { + self.type = type + self.id = id + self.relationships = relationships + } + + public struct Relationships: Codable, Sendable { + public let subscriptionPricePoint: PricePointRelationship + public let territory: TerritoryRelationship? + + public init( + subscriptionPricePoint: PricePointRelationship, + territory: TerritoryRelationship? = nil + ) { + self.subscriptionPricePoint = subscriptionPricePoint + self.territory = territory + } + } + + public struct PricePointRelationship: Codable, Sendable { + public let data: ASCResourceIdentifier + + public init(data: ASCResourceIdentifier) { + self.data = data + } + } + + public struct TerritoryRelationship: Codable, Sendable { + public let data: ASCResourceIdentifier + + public init(data: ASCResourceIdentifier) { + self.data = data + } + } +} + +/// Request to update a retention offer with tri-state patch fields +public struct RetentionOfferUpdateRequest: Codable, Sendable { + public let data: UpdateData + + public init(data: UpdateData) { + self.data = data + } + + public init( + offerId: String, + eligibilitySubscriberDurationType: ASCNullable? = nil, + eligibilitySubscriberDurationInMonths: ASCNullable? = nil, + waitBetweenOffersInMonths: ASCNullable? = nil + ) { + self.data = UpdateData( + id: offerId, + attributes: Attributes( + eligibilitySubscriberDurationType: eligibilitySubscriberDurationType, + eligibilitySubscriberDurationInMonths: eligibilitySubscriberDurationInMonths, + waitBetweenOffersInMonths: waitBetweenOffersInMonths + ) + ) + } + + public struct UpdateData: Codable, Sendable { + public let type: String + public let id: String + public let attributes: Attributes + + public init( + type: String = "retentionOffers", + id: String, + attributes: Attributes + ) { + self.type = type + self.id = id + self.attributes = attributes + } + } + + public struct Attributes: Codable, Sendable { + public let eligibilitySubscriberDurationType: ASCNullable? + public let eligibilitySubscriberDurationInMonths: ASCNullable? + public let waitBetweenOffersInMonths: ASCNullable? + + public init( + eligibilitySubscriberDurationType: ASCNullable? = nil, + eligibilitySubscriberDurationInMonths: ASCNullable? = nil, + waitBetweenOffersInMonths: ASCNullable? = nil + ) { + self.eligibilitySubscriberDurationType = eligibilitySubscriberDurationType + self.eligibilitySubscriberDurationInMonths = eligibilitySubscriberDurationInMonths + self.waitBetweenOffersInMonths = waitBetweenOffersInMonths + } + } +} + +/// Request to set or clear a subscription's retention message (`PATCH /v1/subscriptions/{id}/relationships/retentionMessage`) +/// Encodes `{"data": {"type": "retentionMessages", "id": id}}` when setting, and `{"data": null}` when clearing. +public struct SubscriptionRetentionMessageLinkageRequest: Codable, Sendable { + public let data: ASCResourceIdentifier? + + public init(retentionMessageId: String?) { + if let retentionMessageId { + self.data = ASCResourceIdentifier(type: "retentionMessages", id: retentionMessageId) + } else { + self.data = nil + } + } + + public init(data: ASCResourceIdentifier?) { + self.data = data + } + + private enum CodingKeys: String, CodingKey { + case data + } + + public func encode(to encoder: Encoder) throws { + var container = encoder.container(keyedBy: CodingKeys.self) + if let data { + try container.encode(data, forKey: .data) + } else { + try container.encodeNil(forKey: .data) + } + } +} + +/// Request to add or remove retention message offers for a subscription +/// (`POST` or `DELETE /v1/subscriptions/{id}/relationships/retentionMessageOffers`) +public struct SubscriptionRetentionMessageOffersLinkagesRequest: Codable, Sendable { + public let data: [ASCResourceIdentifier] + + public init(offerIds: [String]) { + self.data = offerIds.map { ASCResourceIdentifier(type: "retentionOffers", id: $0) } + } + + public init(data: [ASCResourceIdentifier]) { + self.data = data + } +} diff --git a/Sources/asc-mcp/Resources/OperationManifest/manifest.json b/Sources/asc-mcp/Resources/OperationManifest/manifest.json index 4870e82..2bc6be7 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/manifest.json +++ b/Sources/asc-mcp/Resources/OperationManifest/manifest.json @@ -1,17 +1,17 @@ { "schemaVersion": 2, "specPin": { - "version": "4.5.1", - "sha256": "7518d3a94a8bd701ac25c1c601b95b8f53aad92091affb15a2a9d331713dac1a", - "pathCount": 1001, - "operationCount": 1303 + "version": "4.6", + "sha256": "74732362a91236dcb66eb1620f8be18c2b6060771269b483eab578473bb32763", + "pathCount": 1027, + "operationCount": 1337 }, "optionalInputCoveragePin": { - "bound": 1342, - "identitySHA256": "181f0398c6748772e8fc7e7ceac9b65b3a485c8ccfb3d0292bd2042f16e7d846", - "intentionallyOmitted": 2918, + "bound": 1377, + "identitySHA256": "1400d282aefe09f38931d0b51bd5edb7294657dbb0d8c54c3c9a0edc1c2a3ccd", + "intentionallyOmitted": 3145, "internalControl": 40, - "total": 4300, + "total": 4562, "unclassified": 0 }, "optionalParameterFamilyRules": [ @@ -20,7 +20,7 @@ "disposition": "intentionallyOmitted", "reason": "Public tools expose documented resource projections instead of arbitrary JSON:API sparse fieldsets; concrete missing response data is tracked at the tool output contract rather than passed through as fields[resource] strings.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ], "scopeRules": [ @@ -29,28 +29,28 @@ "disposition": "outOfScope", "reason": "Game Center is tracked as a separate product roadmap and is not part of the current public MCP scope.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "pathPrefix": "/v2/gameCenter", "disposition": "outOfScope", "reason": "Game Center is tracked as a separate product roadmap and is not part of the current public MCP scope.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "pathPrefix": "/v1/alternativeDistribution", "disposition": "outOfScope", "reason": "Alternative distribution is intentionally deferred to a separate product phase.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "pathPrefix": "/v1/marketplace", "disposition": "outOfScope", "reason": "Alternative marketplace management is intentionally deferred to a separate product phase.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ], "waivers": [ @@ -60,7 +60,7 @@ "disposition": "deferred", "reason": "The `actors` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.actors_getInstance", @@ -68,7 +68,7 @@ "disposition": "deferred", "reason": "The `actors` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.analyticsReportInstances_segments_getToManyRelationship", @@ -76,7 +76,7 @@ "disposition": "deferred", "reason": "The `analyticsReportInstances` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.analyticsReportRequests_deleteInstance", @@ -84,7 +84,7 @@ "disposition": "deferred", "reason": "The `analyticsReportRequests` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.analyticsReportRequests_getInstance", @@ -92,7 +92,7 @@ "disposition": "deferred", "reason": "The `analyticsReportRequests` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.analyticsReportRequests_reports_getToManyRelationship", @@ -100,7 +100,7 @@ "disposition": "deferred", "reason": "The `analyticsReportRequests` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.analyticsReportSegments_getInstance", @@ -108,7 +108,7 @@ "disposition": "deferred", "reason": "The `analyticsReportSegments` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.analyticsReports_instances_getToManyRelationship", @@ -116,7 +116,7 @@ "disposition": "deferred", "reason": "The `analyticsReports` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.androidToIosAppMappingDetails_createInstance", @@ -124,7 +124,7 @@ "disposition": "deferred", "reason": "The `androidToIosAppMappingDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.androidToIosAppMappingDetails_deleteInstance", @@ -132,7 +132,7 @@ "disposition": "deferred", "reason": "The `androidToIosAppMappingDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.androidToIosAppMappingDetails_getInstance", @@ -140,7 +140,7 @@ "disposition": "deferred", "reason": "The `androidToIosAppMappingDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.androidToIosAppMappingDetails_updateInstance", @@ -148,7 +148,7 @@ "disposition": "deferred", "reason": "The `androidToIosAppMappingDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCategories_getCollection", @@ -156,7 +156,7 @@ "disposition": "deferred", "reason": "The `appCategories` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCategories_getInstance", @@ -164,7 +164,7 @@ "disposition": "deferred", "reason": "The `appCategories` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCategories_parent_getToOneRelated", @@ -172,7 +172,7 @@ "disposition": "deferred", "reason": "The `appCategories` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCategories_parent_getToOneRelationship", @@ -180,7 +180,7 @@ "disposition": "deferred", "reason": "The `appCategories` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCategories_subcategories_getToManyRelationship", @@ -188,7 +188,7 @@ "disposition": "deferred", "reason": "The `appCategories` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCategories_subcategories_getToManyRelated", @@ -196,7 +196,7 @@ "disposition": "deferred", "reason": "The `appCategories` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipAdvancedExperienceImages_createInstance", @@ -204,7 +204,7 @@ "disposition": "deferred", "reason": "The `appClipAdvancedExperienceImages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipAdvancedExperienceImages_getInstance", @@ -212,7 +212,7 @@ "disposition": "deferred", "reason": "The `appClipAdvancedExperienceImages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipAdvancedExperienceImages_updateInstance", @@ -220,7 +220,7 @@ "disposition": "deferred", "reason": "The `appClipAdvancedExperienceImages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipAdvancedExperiences_createInstance", @@ -228,7 +228,7 @@ "disposition": "deferred", "reason": "The `appClipAdvancedExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipAdvancedExperiences_getInstance", @@ -236,7 +236,7 @@ "disposition": "deferred", "reason": "The `appClipAdvancedExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipAdvancedExperiences_updateInstance", @@ -244,7 +244,7 @@ "disposition": "deferred", "reason": "The `appClipAdvancedExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipAppStoreReviewDetails_createInstance", @@ -252,7 +252,7 @@ "disposition": "deferred", "reason": "The `appClipAppStoreReviewDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipAppStoreReviewDetails_getInstance", @@ -260,7 +260,7 @@ "disposition": "deferred", "reason": "The `appClipAppStoreReviewDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipAppStoreReviewDetails_updateInstance", @@ -268,7 +268,7 @@ "disposition": "deferred", "reason": "The `appClipAppStoreReviewDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperienceLocalizations_createInstance", @@ -276,7 +276,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperienceLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperienceLocalizations_deleteInstance", @@ -284,7 +284,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperienceLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperienceLocalizations_getInstance", @@ -292,7 +292,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperienceLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperienceLocalizations_updateInstance", @@ -300,7 +300,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperienceLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperienceLocalizations_appClipHeaderImage_getToOneRelated", @@ -308,7 +308,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperienceLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperienceLocalizations_appClipHeaderImage_getToOneRelationship", @@ -316,7 +316,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperienceLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_createInstance", @@ -324,7 +324,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_deleteInstance", @@ -332,7 +332,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_getInstance", @@ -340,7 +340,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_updateInstance", @@ -348,7 +348,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_appClipAppStoreReviewDetail_getToOneRelated", @@ -356,7 +356,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_appClipDefaultExperienceLocalizations_getToManyRelated", @@ -364,7 +364,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_appClipAppStoreReviewDetail_getToOneRelationship", @@ -372,7 +372,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_appClipDefaultExperienceLocalizations_getToManyRelationship", @@ -380,7 +380,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_releaseWithAppStoreVersion_getToOneRelationship", @@ -388,7 +388,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_releaseWithAppStoreVersion_updateToOneRelationship", @@ -396,7 +396,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipDefaultExperiences_releaseWithAppStoreVersion_getToOneRelated", @@ -404,7 +404,7 @@ "disposition": "deferred", "reason": "The `appClipDefaultExperiences` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipHeaderImages_createInstance", @@ -412,7 +412,7 @@ "disposition": "deferred", "reason": "The `appClipHeaderImages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipHeaderImages_deleteInstance", @@ -420,7 +420,7 @@ "disposition": "deferred", "reason": "The `appClipHeaderImages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipHeaderImages_getInstance", @@ -428,7 +428,7 @@ "disposition": "deferred", "reason": "The `appClipHeaderImages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClipHeaderImages_updateInstance", @@ -436,7 +436,7 @@ "disposition": "deferred", "reason": "The `appClipHeaderImages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClips_getInstance", @@ -444,7 +444,7 @@ "disposition": "deferred", "reason": "The `appClips` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClips_appClipAdvancedExperiences_getToManyRelated", @@ -452,7 +452,7 @@ "disposition": "deferred", "reason": "The `appClips` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClips_appClipDefaultExperiences_getToManyRelated", @@ -460,7 +460,7 @@ "disposition": "deferred", "reason": "The `appClips` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClips_appClipAdvancedExperiences_getToManyRelationship", @@ -468,7 +468,7 @@ "disposition": "deferred", "reason": "The `appClips` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appClips_appClipDefaultExperiences_getToManyRelationship", @@ -476,7 +476,7 @@ "disposition": "deferred", "reason": "The `appClips` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCustomProductPageLocalizations_appPreviewSets_getToManyRelationship", @@ -484,7 +484,7 @@ "disposition": "deferred", "reason": "screenshots_list_preview_sets returns the full related preview-set resources; this linkage-only relationship document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCustomProductPageLocalizations_appScreenshotSets_getToManyRelationship", @@ -492,7 +492,7 @@ "disposition": "deferred", "reason": "screenshots_list_sets returns the full related screenshot-set resources; this linkage-only relationship document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCustomProductPageLocalizations_searchKeywords_getToManyRelationship", @@ -500,7 +500,7 @@ "disposition": "deferred", "reason": "custom_pages_list_search_keywords returns full related keyword resources; this linkage-only relationship document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelationship", @@ -508,7 +508,7 @@ "disposition": "deferred", "reason": "custom_pages_list_localizations returns full related localization resources; this linkage-only relationship document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appCustomProductPages_appCustomProductPageVersions_getToManyRelationship", @@ -516,7 +516,7 @@ "disposition": "deferred", "reason": "custom_pages_list_versions returns full related version resources; this linkage-only relationship document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEncryptionDeclarations_getCollection", @@ -524,7 +524,7 @@ "disposition": "deferred", "reason": "The `appEncryptionDeclarations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEncryptionDeclarations_app_getToOneRelated", @@ -532,7 +532,7 @@ "disposition": "deferred", "reason": "The `appEncryptionDeclarations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEncryptionDeclarations_app_getToOneRelationship", @@ -540,7 +540,7 @@ "disposition": "deferred", "reason": "The `appEncryptionDeclarations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelationship", @@ -548,7 +548,7 @@ "disposition": "deferred", "reason": "The `appEncryptionDeclarations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEncryptionDeclarations_builds_createToManyRelationship", @@ -556,7 +556,7 @@ "disposition": "deferred", "reason": "Pinned Apple OpenAPI 4.5.1 marks this declaration-to-build relationship POST deprecated; equivalent relationship assignment is exposed through builds_updateInstance.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventLocalizations_appEventScreenshots_getToManyRelated", @@ -564,7 +564,7 @@ "disposition": "deferred", "reason": "The `appEventLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventLocalizations_appEventVideoClips_getToManyRelated", @@ -572,7 +572,7 @@ "disposition": "deferred", "reason": "The `appEventLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventLocalizations_appEventScreenshots_getToManyRelationship", @@ -580,7 +580,7 @@ "disposition": "deferred", "reason": "The `appEventLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventLocalizations_appEventVideoClips_getToManyRelationship", @@ -588,7 +588,7 @@ "disposition": "deferred", "reason": "The `appEventLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventScreenshots_createInstance", @@ -596,7 +596,7 @@ "disposition": "deferred", "reason": "The `appEventScreenshots` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventScreenshots_deleteInstance", @@ -604,7 +604,7 @@ "disposition": "deferred", "reason": "The `appEventScreenshots` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventScreenshots_getInstance", @@ -612,7 +612,7 @@ "disposition": "deferred", "reason": "The `appEventScreenshots` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventScreenshots_updateInstance", @@ -620,7 +620,7 @@ "disposition": "deferred", "reason": "The `appEventScreenshots` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventVideoClips_createInstance", @@ -628,7 +628,7 @@ "disposition": "deferred", "reason": "The `appEventVideoClips` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventVideoClips_deleteInstance", @@ -636,7 +636,7 @@ "disposition": "deferred", "reason": "The `appEventVideoClips` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventVideoClips_getInstance", @@ -644,7 +644,7 @@ "disposition": "deferred", "reason": "The `appEventVideoClips` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEventVideoClips_updateInstance", @@ -652,7 +652,7 @@ "disposition": "deferred", "reason": "The `appEventVideoClips` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appEvents_localizations_getToManyRelationship", @@ -660,7 +660,7 @@ "disposition": "deferred", "reason": "The `appEvents` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfoLocalizations_getInstance", @@ -668,7 +668,7 @@ "disposition": "deferred", "reason": "The `appInfoLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_primaryCategory_getToOneRelated", @@ -676,7 +676,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_primarySubcategoryOne_getToOneRelated", @@ -684,7 +684,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_primarySubcategoryTwo_getToOneRelated", @@ -692,7 +692,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_ageRatingDeclaration_getToOneRelationship", @@ -700,7 +700,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_appInfoLocalizations_getToManyRelationship", @@ -708,7 +708,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_primaryCategory_getToOneRelationship", @@ -716,7 +716,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_primarySubcategoryOne_getToOneRelationship", @@ -724,7 +724,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_primarySubcategoryTwo_getToOneRelationship", @@ -732,7 +732,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_secondaryCategory_getToOneRelationship", @@ -740,7 +740,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_secondarySubcategoryOne_getToOneRelationship", @@ -748,7 +748,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_secondarySubcategoryTwo_getToOneRelationship", @@ -756,7 +756,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_territoryAgeRatings_getToManyRelationship", @@ -764,7 +764,7 @@ "disposition": "deferred", "reason": "The related-resource collection is exposed and returns both calculated ratings and territory details; this linkage-only endpoint would add IDs without practical rating data.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_secondaryCategory_getToOneRelated", @@ -772,7 +772,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_secondarySubcategoryOne_getToOneRelated", @@ -780,7 +780,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appInfos_secondarySubcategoryTwo_getToOneRelated", @@ -788,7 +788,7 @@ "disposition": "deferred", "reason": "The `appInfos` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPreviewSets_appPreviews_getToManyRelationship", @@ -796,7 +796,7 @@ "disposition": "deferred", "reason": "screenshots_list_previews returns full preview resources; this linkage-only relationship document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPriceSchedules_getInstance", @@ -804,7 +804,7 @@ "disposition": "deferred", "reason": "The `appPriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPriceSchedules_automaticPrices_getToManyRelated", @@ -812,7 +812,7 @@ "disposition": "deferred", "reason": "The `appPriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPriceSchedules_baseTerritory_getToOneRelated", @@ -820,7 +820,7 @@ "disposition": "deferred", "reason": "The `appPriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPriceSchedules_manualPrices_getToManyRelated", @@ -828,7 +828,7 @@ "disposition": "deferred", "reason": "The `appPriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPriceSchedules_automaticPrices_getToManyRelationship", @@ -836,7 +836,7 @@ "disposition": "deferred", "reason": "The `appPriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPriceSchedules_baseTerritory_getToOneRelationship", @@ -844,7 +844,7 @@ "disposition": "deferred", "reason": "The `appPriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPriceSchedules_manualPrices_getToManyRelationship", @@ -852,7 +852,7 @@ "disposition": "deferred", "reason": "The `appPriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appScreenshotSets_appScreenshots_getToManyRelationship", @@ -860,7 +860,7 @@ "disposition": "deferred", "reason": "screenshots_list returns full screenshot resources; this linkage-only relationship document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreReviewDetails_getInstance", @@ -868,7 +868,7 @@ "disposition": "deferred", "reason": "The `appStoreReviewDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreReviewDetails_appStoreReviewAttachments_getToManyRelationship", @@ -876,7 +876,7 @@ "disposition": "deferred", "reason": "review_attachments_list exposes the related attachment resources; the linkage-only relationship endpoint is deferred because it would duplicate IDs without attachment attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelationship", @@ -884,7 +884,7 @@ "disposition": "deferred", "reason": "screenshots_list_preview_sets returns the full treatment-localization preview-set resources; this linkage-only document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelationship", @@ -892,7 +892,7 @@ "disposition": "deferred", "reason": "screenshots_list_sets returns the full treatment-localization screenshot-set resources; this linkage-only document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelationship", @@ -900,7 +900,7 @@ "disposition": "deferred", "reason": "ppo_list_treatment_localizations returns full localization resources; this linkage-only relationship document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionExperiments_createInstance", @@ -908,7 +908,7 @@ "disposition": "deferred", "reason": "The legacy V1 experiment mutation is intentionally deferred; PPO tools use Apple's nondeprecated V2 experiment surface and shared treatment resources.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionExperiments_deleteInstance", @@ -916,7 +916,7 @@ "disposition": "deferred", "reason": "The legacy V1 experiment mutation is intentionally deferred; PPO tools use Apple's nondeprecated V2 experiment surface and shared treatment resources.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionExperiments_getInstance", @@ -924,7 +924,7 @@ "disposition": "deferred", "reason": "The legacy V1 experiment read is intentionally deferred; PPO tools use Apple's nondeprecated V2 experiment surface and shared treatment resources.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionExperiments_updateInstance", @@ -932,7 +932,7 @@ "disposition": "deferred", "reason": "The legacy V1 experiment mutation is intentionally deferred; PPO tools use Apple's nondeprecated V2 experiment surface and shared treatment resources.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionExperiments_appStoreVersionExperimentTreatments_getToManyRelated", @@ -940,7 +940,7 @@ "disposition": "deferred", "reason": "This legacy V1 experiment relationship is intentionally deferred; ppo_list_treatments uses the nondeprecated V2 experiment relationship and returns full treatment resources.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionExperiments_appStoreVersionExperimentTreatments_getToManyRelationship", @@ -948,7 +948,7 @@ "disposition": "deferred", "reason": "This legacy V1 linkage-only relationship is intentionally deferred; ppo_list_treatments uses the nondeprecated V2 relationship and returns full treatment resources.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionLocalizations_appPreviewSets_getToManyRelationship", @@ -956,7 +956,7 @@ "disposition": "deferred", "reason": "screenshots_list_preview_sets returns full version-localization preview-set resources; this linkage-only document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionLocalizations_appScreenshotSets_getToManyRelationship", @@ -964,7 +964,7 @@ "disposition": "deferred", "reason": "screenshots_list_sets returns full version-localization screenshot-set resources; this linkage-only document is deferred because it duplicates IDs without attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionLocalizations_searchKeywords_deleteToManyRelationship", @@ -972,7 +972,7 @@ "disposition": "deferred", "reason": "Search-keyword targeting for standard App Store version localizations is not yet exposed; the current search-keyword tools are scoped to apps and Custom Product Page localizations.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionLocalizations_searchKeywords_getToManyRelationship", @@ -980,7 +980,7 @@ "disposition": "deferred", "reason": "Search-keyword targeting for standard App Store version localizations is not yet exposed; the current search-keyword tools are scoped to apps and Custom Product Page localizations.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionLocalizations_searchKeywords_createToManyRelationship", @@ -988,7 +988,7 @@ "disposition": "deferred", "reason": "Search-keyword targeting for standard App Store version localizations is not yet exposed; the current search-keyword tools are scoped to apps and Custom Product Page localizations.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionLocalizations_searchKeywords_getToManyRelated", @@ -996,7 +996,7 @@ "disposition": "deferred", "reason": "Search-keyword targeting for standard App Store version localizations is not yet exposed; the current search-keyword tools are scoped to apps and Custom Product Page localizations.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionPromotions_createInstance", @@ -1004,7 +1004,7 @@ "disposition": "deferred", "reason": "The `appStoreVersionPromotions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionSubmissions_deleteInstance", @@ -1012,7 +1012,7 @@ "disposition": "deferred", "reason": "The `appStoreVersionSubmissions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_alternativeDistributionPackage_getToOneRelated", @@ -1020,7 +1020,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appClipDefaultExperience_getToOneRelated", @@ -1028,7 +1028,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appStoreVersionExperiments_getToManyRelated", @@ -1036,7 +1036,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appStoreVersionSubmission_getToOneRelated", @@ -1044,7 +1044,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_gameCenterAppVersion_getToOneRelated", @@ -1052,7 +1052,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_alternativeDistributionPackage_getToOneRelationship", @@ -1060,7 +1060,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appClipDefaultExperience_getToOneRelationship", @@ -1068,7 +1068,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appClipDefaultExperience_updateToOneRelationship", @@ -1076,7 +1076,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appStoreReviewDetail_getToOneRelationship", @@ -1084,7 +1084,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appStoreVersionExperiments_getToManyRelationship", @@ -1092,7 +1092,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appStoreVersionExperimentsV2_getToManyRelationship", @@ -1100,7 +1100,7 @@ "disposition": "deferred", "reason": "ppo_list_version_experiments returns full V2 experiment resources; this linkage-only relationship document is deferred because it duplicates IDs without experiment attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appStoreVersionLocalizations_getToManyRelationship", @@ -1108,7 +1108,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appStoreVersionPhasedRelease_getToOneRelationship", @@ -1116,7 +1116,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_appStoreVersionSubmission_getToOneRelationship", @@ -1124,7 +1124,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_build_getToOneRelationship", @@ -1132,7 +1132,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_customerReviews_getToManyRelationship", @@ -1140,7 +1140,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_gameCenterAppVersion_getToOneRelationship", @@ -1148,7 +1148,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_routingAppCoverage_getToOneRelationship", @@ -1156,7 +1156,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersions_routingAppCoverage_getToOneRelated", @@ -1164,7 +1164,7 @@ "disposition": "deferred", "reason": "The `appStoreVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appTags_updateInstance", @@ -1172,7 +1172,7 @@ "disposition": "deferred", "reason": "The `appTags` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appTags_territories_getToManyRelationship", @@ -1180,7 +1180,7 @@ "disposition": "deferred", "reason": "The `appTags` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appTags_territories_getToManyRelated", @@ -1188,7 +1188,7 @@ "disposition": "deferred", "reason": "The `appTags` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_updateInstance", @@ -1196,7 +1196,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_alternativeDistributionKey_getToOneRelated", @@ -1204,7 +1204,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_androidToIosAppMappingDetails_getToManyRelated", @@ -1212,7 +1212,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appClips_getToManyRelated", @@ -1220,7 +1220,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appTags_getToManyRelated", @@ -1228,7 +1228,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_backgroundAssets_getToManyRelated", @@ -1236,7 +1236,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_betaGroups_getToManyRelated", @@ -1244,7 +1244,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_betaLicenseAgreement_getToOneRelated", @@ -1252,7 +1252,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_builds_getToManyRelated", @@ -1260,7 +1260,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_gameCenterDetail_getToOneRelated", @@ -1268,7 +1268,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_gameCenterEnabledVersions_getToManyRelated", @@ -1276,7 +1276,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_inAppPurchases_getToManyRelated", @@ -1284,7 +1284,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_marketplaceSearchDetail_getToOneRelated", @@ -1292,7 +1292,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_preReleaseVersions_getToManyRelated", @@ -1300,7 +1300,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_alternativeDistributionKey_getToOneRelationship", @@ -1308,7 +1308,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_analyticsReportRequests_getToManyRelationship", @@ -1316,7 +1316,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_androidToIosAppMappingDetails_getToManyRelationship", @@ -1324,7 +1324,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appAvailabilityV2_getToOneRelationship", @@ -1332,7 +1332,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appClips_getToManyRelationship", @@ -1340,7 +1340,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appCustomProductPages_getToManyRelationship", @@ -1348,7 +1348,7 @@ "disposition": "deferred", "reason": "custom_pages_list returns full app-owned custom product page resources; this linkage-only relationship document is deferred because it duplicates IDs without page attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appEncryptionDeclarations_getToManyRelationship", @@ -1356,7 +1356,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appEvents_getToManyRelationship", @@ -1364,7 +1364,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appInfos_getToManyRelationship", @@ -1372,7 +1372,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appPricePoints_getToManyRelationship", @@ -1380,7 +1380,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appPriceSchedule_getToOneRelationship", @@ -1388,7 +1388,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appStoreVersionExperimentsV2_getToManyRelationship", @@ -1396,7 +1396,7 @@ "disposition": "deferred", "reason": "ppo_list_experiments returns full app-owned V2 experiment resources; this linkage-only relationship document is deferred because it duplicates IDs without experiment attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appStoreVersions_getToManyRelationship", @@ -1404,7 +1404,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_appTags_getToManyRelationship", @@ -1412,7 +1412,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_backgroundAssets_getToManyRelationship", @@ -1420,7 +1420,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_betaAppLocalizations_getToManyRelationship", @@ -1428,7 +1428,7 @@ "disposition": "deferred", "reason": "The related BetaAppLocalization resource list is exposed; the raw app-to-localizations linkage collection is not exposed.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_betaAppReviewDetail_getToOneRelationship", @@ -1436,7 +1436,7 @@ "disposition": "deferred", "reason": "The related BetaAppReviewDetail resource is exposed; the raw app-to-review-detail linkage endpoint is not exposed.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_betaFeedbackCrashSubmissions_getToManyRelationship", @@ -1444,7 +1444,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_betaFeedbackScreenshotSubmissions_getToManyRelationship", @@ -1452,7 +1452,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_betaGroups_getToManyRelationship", @@ -1460,7 +1460,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_betaLicenseAgreement_getToOneRelationship", @@ -1468,7 +1468,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_betaTesters_deleteToManyRelationship", @@ -1476,7 +1476,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_buildUploads_getToManyRelationship", @@ -1484,7 +1484,7 @@ "disposition": "deferred", "reason": "build_uploads_list exposes the related BuildUpload resources; the linkage-only relationship endpoint is deferred because it would duplicate IDs without upload attributes or processing state.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_builds_getToManyRelationship", @@ -1492,7 +1492,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_ciProduct_getToOneRelationship", @@ -1500,7 +1500,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_app_product_get is a functional superset that returns the same product identity together with validated product attributes and relationship context.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_customerReviews_getToManyRelationship", @@ -1508,7 +1508,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_endUserLicenseAgreement_getToOneRelationship", @@ -1516,7 +1516,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_gameCenterDetail_getToOneRelationship", @@ -1524,7 +1524,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_gameCenterEnabledVersions_getToManyRelationship", @@ -1532,7 +1532,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_inAppPurchases_getToManyRelationship", @@ -1540,7 +1540,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_inAppPurchasesV2_getToManyRelationship", @@ -1548,7 +1548,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_marketplaceSearchDetail_getToOneRelationship", @@ -1556,7 +1556,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_preReleaseVersions_getToManyRelationship", @@ -1564,7 +1564,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_reviewSubmissions_getToManyRelationship", @@ -1572,7 +1572,7 @@ "disposition": "deferred", "reason": "`review_submissions_list` uses Apple's filtered collection endpoint to return submissions for one required app with state and platform filters; this app-scoped linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_searchKeywords_getToManyRelationship", @@ -1580,7 +1580,7 @@ "disposition": "deferred", "reason": "apps_list_search_keywords returns full related keyword resources; this linkage-only relationship document is deferred because it duplicates IDs without keyword attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_subscriptionGracePeriod_getToOneRelationship", @@ -1588,7 +1588,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_subscriptionGroups_getToManyRelationship", @@ -1596,7 +1596,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_webhooks_getToManyRelationship", @@ -1604,7 +1604,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_reviewSubmissions_getToManyRelated", @@ -1612,7 +1612,7 @@ "disposition": "deferred", "reason": "`review_submissions_list` exposes the equivalent app-owned submission collection through Apple's required filter[app] query and adds state, platform, include, and strict pagination controls; the alternate related-resource path is intentionally deferred.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.apps_subscriptionGracePeriod_getToOneRelated", @@ -1620,7 +1620,7 @@ "disposition": "deferred", "reason": "The `apps` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssetUploadFiles_createInstance", @@ -1628,7 +1628,7 @@ "disposition": "deferred", "reason": "The `backgroundAssetUploadFiles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssetUploadFiles_getInstance", @@ -1636,7 +1636,7 @@ "disposition": "deferred", "reason": "The `backgroundAssetUploadFiles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssetUploadFiles_updateInstance", @@ -1644,7 +1644,7 @@ "disposition": "deferred", "reason": "The `backgroundAssetUploadFiles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssetVersionAppStoreReleases_getInstance", @@ -1652,7 +1652,7 @@ "disposition": "deferred", "reason": "The `backgroundAssetVersionAppStoreReleases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssetVersionExternalBetaReleases_getInstance", @@ -1660,7 +1660,7 @@ "disposition": "deferred", "reason": "The `backgroundAssetVersionExternalBetaReleases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssetVersionInternalBetaReleases_getInstance", @@ -1668,7 +1668,7 @@ "disposition": "deferred", "reason": "The `backgroundAssetVersionInternalBetaReleases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssetVersions_createInstance", @@ -1676,7 +1676,7 @@ "disposition": "deferred", "reason": "The `backgroundAssetVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssetVersions_getInstance", @@ -1684,7 +1684,7 @@ "disposition": "deferred", "reason": "The `backgroundAssetVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssetVersions_backgroundAssetUploadFiles_getToManyRelated", @@ -1692,7 +1692,7 @@ "disposition": "deferred", "reason": "The `backgroundAssetVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssetVersions_backgroundAssetUploadFiles_getToManyRelationship", @@ -1700,7 +1700,7 @@ "disposition": "deferred", "reason": "The `backgroundAssetVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssets_createInstance", @@ -1708,7 +1708,7 @@ "disposition": "deferred", "reason": "The `backgroundAssets` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssets_getInstance", @@ -1716,7 +1716,7 @@ "disposition": "deferred", "reason": "The `backgroundAssets` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssets_updateInstance", @@ -1724,7 +1724,7 @@ "disposition": "deferred", "reason": "The `backgroundAssets` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssets_versions_getToManyRelationship", @@ -1732,7 +1732,7 @@ "disposition": "deferred", "reason": "The `backgroundAssets` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.backgroundAssets_versions_getToManyRelated", @@ -1740,7 +1740,7 @@ "disposition": "deferred", "reason": "The `backgroundAssets` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppClipInvocationLocalizations_createInstance", @@ -1748,7 +1748,7 @@ "disposition": "deferred", "reason": "The `betaAppClipInvocationLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppClipInvocationLocalizations_deleteInstance", @@ -1756,7 +1756,7 @@ "disposition": "deferred", "reason": "The `betaAppClipInvocationLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppClipInvocationLocalizations_updateInstance", @@ -1764,7 +1764,7 @@ "disposition": "deferred", "reason": "The `betaAppClipInvocationLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppClipInvocations_createInstance", @@ -1772,7 +1772,7 @@ "disposition": "deferred", "reason": "The `betaAppClipInvocations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppClipInvocations_deleteInstance", @@ -1780,7 +1780,7 @@ "disposition": "deferred", "reason": "The `betaAppClipInvocations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppClipInvocations_getInstance", @@ -1788,7 +1788,7 @@ "disposition": "deferred", "reason": "The `betaAppClipInvocations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppClipInvocations_updateInstance", @@ -1796,7 +1796,7 @@ "disposition": "deferred", "reason": "The `betaAppClipInvocations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppLocalizations_getCollection", @@ -1804,7 +1804,7 @@ "disposition": "deferred", "reason": "The app-scoped related-resource list is exposed; the direct BetaAppLocalization collection and its app filter are not exposed.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppLocalizations_app_getToOneRelated", @@ -1812,7 +1812,7 @@ "disposition": "deferred", "reason": "BetaAppLocalization resources are exposed, but the dedicated related App resource endpoint is not exposed.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppLocalizations_app_getToOneRelationship", @@ -1820,7 +1820,7 @@ "disposition": "deferred", "reason": "BetaAppLocalization resources are exposed, but the raw App relationship-linkage endpoint is not exposed.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppReviewDetails_getCollection", @@ -1828,7 +1828,7 @@ "disposition": "deferred", "reason": "The app-scoped related review detail is exposed; the direct BetaAppReviewDetail collection is not exposed.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppReviewDetails_getInstance", @@ -1836,7 +1836,7 @@ "disposition": "deferred", "reason": "The app-scoped related review detail is exposed; direct BetaAppReviewDetail lookup by detail ID is not exposed.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppReviewDetails_app_getToOneRelated", @@ -1844,7 +1844,7 @@ "disposition": "deferred", "reason": "BetaAppReviewDetail resources are exposed, but the dedicated related App resource endpoint is not exposed.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppReviewDetails_app_getToOneRelationship", @@ -1852,7 +1852,7 @@ "disposition": "deferred", "reason": "BetaAppReviewDetail resources are exposed, but the raw App relationship-linkage endpoint is not exposed.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaAppReviewSubmissions_build_getToOneRelated", @@ -1860,7 +1860,7 @@ "disposition": "deferred", "reason": "Submission tools expand Build resources with include=build; the dedicated related Build resource endpoint is not exposed.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaBuildLocalizations_deleteInstance", @@ -1868,7 +1868,7 @@ "disposition": "deferred", "reason": "The `betaBuildLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaBuildLocalizations_getInstance", @@ -1876,7 +1876,7 @@ "disposition": "deferred", "reason": "The `betaBuildLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaBuildLocalizations_build_getToOneRelated", @@ -1884,7 +1884,7 @@ "disposition": "deferred", "reason": "The `betaBuildLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaBuildLocalizations_build_getToOneRelationship", @@ -1892,7 +1892,7 @@ "disposition": "deferred", "reason": "The `betaBuildLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaFeedbackCrashSubmissions_crashLog_getToOneRelationship", @@ -1900,7 +1900,7 @@ "disposition": "deferred", "reason": "The `betaFeedbackCrashSubmissions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaGroups_app_getToOneRelated", @@ -1908,7 +1908,7 @@ "disposition": "deferred", "reason": "The related App resource lookup is deferred; current beta-group tools accept or filter by the App identifier without projecting the App resource.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaGroups_builds_getToManyRelated", @@ -1916,7 +1916,7 @@ "disposition": "deferred", "reason": "Reading the related Build resources for a beta group is deferred; current beta-group tools manage build membership but do not project Build resources.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaGroups_app_getToOneRelationship", @@ -1924,7 +1924,7 @@ "disposition": "deferred", "reason": "The linkage-only App relationship is deferred with the related App lookup; current beta-group tools accept or filter by the App identifier without a separate relationship read.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaGroups_betaRecruitmentCriteria_getToOneRelationship", @@ -1932,7 +1932,7 @@ "disposition": "deferred", "reason": "`beta_groups_get_recruitment_criteria` uses the related-resource endpoint to return the criterion identity and attributes after confirming the exact beta group; the linkage-only response is intentionally deferred because it is strictly less informative.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaGroups_betaRecruitmentCriterionCompatibleBuildCheck_getToOneRelationship", @@ -1940,7 +1940,7 @@ "disposition": "deferred", "reason": "`beta_groups_check_recruitment_compatibility` uses the related-resource endpoint to return the check identity and compatibility attribute after confirming the exact beta group; the linkage-only response is intentionally deferred because it is strictly less informative.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaGroups_betaTesters_getToManyRelationship", @@ -1948,7 +1948,7 @@ "disposition": "deferred", "reason": "`beta_groups_list_testers` returns the related BetaTester resources for the group; the linkage-only identifier response is intentionally deferred because it is strictly less informative.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaGroups_builds_getToManyRelationship", @@ -1956,7 +1956,7 @@ "disposition": "deferred", "reason": "The linkage-only Build relationship read is deferred with the richer related Build resource lookup; current tools manage build membership without a separate read projection.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaLicenseAgreements_app_getToOneRelated", @@ -1964,7 +1964,7 @@ "disposition": "deferred", "reason": "The `betaLicenseAgreements` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaLicenseAgreements_app_getToOneRelationship", @@ -1972,7 +1972,7 @@ "disposition": "deferred", "reason": "The `betaLicenseAgreements` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaTesters_betaGroups_getToManyRelated", @@ -1980,7 +1980,7 @@ "disposition": "deferred", "reason": "The `betaTesters` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaTesters_builds_getToManyRelated", @@ -1988,7 +1988,7 @@ "disposition": "deferred", "reason": "The `betaTesters` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaTesters_apps_getToManyRelationship", @@ -1996,7 +1996,7 @@ "disposition": "deferred", "reason": "The `betaTesters` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaTesters_betaGroups_getToManyRelationship", @@ -2004,7 +2004,7 @@ "disposition": "deferred", "reason": "The `betaTesters` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.betaTesters_builds_getToManyRelationship", @@ -2012,7 +2012,7 @@ "disposition": "deferred", "reason": "The `betaTesters` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBetaDetails_getCollection", @@ -2020,7 +2020,7 @@ "disposition": "deferred", "reason": "The `buildBetaDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBetaDetails_getInstance", @@ -2028,7 +2028,7 @@ "disposition": "deferred", "reason": "The public beta-detail tool resolves through a build ID and does not accept a BuildBetaDetail resource ID.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBetaDetails_build_getToOneRelated", @@ -2036,7 +2036,7 @@ "disposition": "deferred", "reason": "The `buildBetaDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBetaDetails_build_getToOneRelationship", @@ -2044,7 +2044,7 @@ "disposition": "deferred", "reason": "The `buildBetaDetails` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBundles_appClipDomainCacheStatus_getToOneRelated", @@ -2052,7 +2052,7 @@ "disposition": "deferred", "reason": "The `buildBundles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBundles_appClipDomainDebugStatus_getToOneRelated", @@ -2060,7 +2060,7 @@ "disposition": "deferred", "reason": "The `buildBundles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBundles_betaAppClipInvocations_getToManyRelated", @@ -2068,7 +2068,7 @@ "disposition": "deferred", "reason": "The `buildBundles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBundles_buildBundleFileSizes_getToManyRelated", @@ -2076,7 +2076,7 @@ "disposition": "deferred", "reason": "The `buildBundles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBundles_appClipDomainCacheStatus_getToOneRelationship", @@ -2084,7 +2084,7 @@ "disposition": "deferred", "reason": "The `buildBundles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBundles_appClipDomainDebugStatus_getToOneRelationship", @@ -2092,7 +2092,7 @@ "disposition": "deferred", "reason": "The `buildBundles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBundles_betaAppClipInvocations_getToManyRelationship", @@ -2100,7 +2100,7 @@ "disposition": "deferred", "reason": "The `buildBundles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildBundles_buildBundleFileSizes_getToManyRelationship", @@ -2108,7 +2108,7 @@ "disposition": "deferred", "reason": "The `buildBundles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.buildUploads_buildUploadFiles_getToManyRelationship", @@ -2116,7 +2116,7 @@ "disposition": "deferred", "reason": "build_uploads_list_files exposes the related BuildUploadFile resources; the linkage-only relationship endpoint is deferred because it would duplicate IDs without file attributes or delivery state.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_app_getToOneRelated", @@ -2124,7 +2124,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_appStoreVersion_getToOneRelated", @@ -2132,7 +2132,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_betaAppReviewSubmission_getToOneRelated", @@ -2140,7 +2140,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_icons_getToManyRelated", @@ -2148,7 +2148,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_preReleaseVersion_getToOneRelated", @@ -2156,7 +2156,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_app_getToOneRelationship", @@ -2164,7 +2164,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_appEncryptionDeclaration_getToOneRelationship", @@ -2172,7 +2172,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_appEncryptionDeclaration_updateToOneRelationship", @@ -2180,7 +2180,7 @@ "disposition": "deferred", "reason": "Pinned Apple OpenAPI 4.5.1 omits a deprecated flag, while current Apple DocC marks the direct relationship PATCH deprecated and directs clients to Modify a build; asc-mcp exposes that replacement through builds_updateInstance.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_appStoreVersion_getToOneRelationship", @@ -2188,7 +2188,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_betaAppReviewSubmission_getToOneRelationship", @@ -2196,7 +2196,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_betaBuildLocalizations_getToManyRelationship", @@ -2204,7 +2204,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_betaGroups_deleteToManyRelationship", @@ -2212,7 +2212,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_buildBetaDetail_getToOneRelationship", @@ -2220,7 +2220,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_diagnosticSignatures_getToManyRelationship", @@ -2228,7 +2228,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_icons_getToManyRelationship", @@ -2236,7 +2236,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_individualTesters_getToManyRelationship", @@ -2244,7 +2244,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.builds_preReleaseVersion_getToOneRelationship", @@ -2252,7 +2252,7 @@ "disposition": "deferred", "reason": "The `builds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.bundleIdCapabilities_updateInstance", @@ -2260,7 +2260,7 @@ "disposition": "deferred", "reason": "The `bundleIdCapabilities` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.bundleIds_updateInstance", @@ -2268,7 +2268,7 @@ "disposition": "deferred", "reason": "The `bundleIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.bundleIds_app_getToOneRelated", @@ -2276,7 +2276,7 @@ "disposition": "deferred", "reason": "The `bundleIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.bundleIds_profiles_getToManyRelated", @@ -2284,7 +2284,7 @@ "disposition": "deferred", "reason": "The `bundleIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.bundleIds_app_getToOneRelationship", @@ -2292,7 +2292,7 @@ "disposition": "deferred", "reason": "The `bundleIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.bundleIds_bundleIdCapabilities_getToManyRelationship", @@ -2300,7 +2300,7 @@ "disposition": "deferred", "reason": "The `bundleIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.bundleIds_profiles_getToManyRelationship", @@ -2308,7 +2308,7 @@ "disposition": "deferred", "reason": "The `bundleIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.certificates_createInstance", @@ -2316,7 +2316,7 @@ "disposition": "deferred", "reason": "The `certificates` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.certificates_updateInstance", @@ -2324,7 +2324,7 @@ "disposition": "deferred", "reason": "The `certificates` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.certificates_passTypeId_getToOneRelated", @@ -2332,7 +2332,7 @@ "disposition": "deferred", "reason": "The `certificates` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.certificates_passTypeId_getToOneRelationship", @@ -2340,7 +2340,7 @@ "disposition": "deferred", "reason": "The `certificates` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciBuildActions_artifacts_getToManyRelationship", @@ -2348,7 +2348,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_action_artifacts_list is a functional superset that returns artifact identities together with artifact attributes and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciBuildActions_buildRun_getToOneRelationship", @@ -2356,7 +2356,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_action_build_run_get is a functional superset that returns the build-run identity together with validated build-run attributes and requested related resources.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciBuildActions_issues_getToManyRelationship", @@ -2364,7 +2364,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_action_issues_list is a functional superset that returns issue identities together with issue attributes and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciBuildActions_testResults_getToManyRelationship", @@ -2372,7 +2372,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_action_test_results_list is a functional superset that returns test-result identities together with result attributes and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciBuildRuns_actions_getToManyRelationship", @@ -2380,7 +2380,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_build_run_actions_list is a functional superset that returns action identities together with action attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciBuildRuns_builds_getToManyRelationship", @@ -2388,7 +2388,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_build_run_builds_list is a functional superset that returns build identities together with build attributes and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciMacOsVersions_xcodeVersions_getToManyRelationship", @@ -2396,7 +2396,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_macos_version_xcode_versions_list is a functional superset that returns Xcode-version identities together with version attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciProducts_additionalRepositories_getToManyRelationship", @@ -2404,7 +2404,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_product_additional_repositories_list is a functional superset that returns repository identities together with repository attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciProducts_app_getToOneRelationship", @@ -2412,7 +2412,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_product_app_get is a functional superset that returns the app identity together with compact membership attributes and canonical resource context.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciProducts_buildRuns_getToManyRelationship", @@ -2420,7 +2420,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_product_build_runs_list is a functional superset that returns build-run identities together with build-run attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciProducts_primaryRepositories_getToManyRelationship", @@ -2428,7 +2428,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_product_primary_repositories_list is a functional superset that returns repository identities together with repository attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciProducts_workflows_getToManyRelationship", @@ -2436,7 +2436,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_product_workflows_list is a functional superset that returns workflow identities together with workflow attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciWorkflows_buildRuns_getToManyRelationship", @@ -2444,7 +2444,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_workflow_build_runs_list is a functional superset that returns build-run identities together with build-run attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciWorkflows_repository_getToOneRelationship", @@ -2452,7 +2452,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_workflow_repository_get is a functional superset that returns the repository identity together with repository attributes and validated included resources.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.ciXcodeVersions_macOsVersions_getToManyRelationship", @@ -2460,7 +2460,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_xcode_version_macos_versions_list is a functional superset that returns macOS-version identities together with version attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.customerReviewResponses_getInstance", @@ -2468,7 +2468,7 @@ "disposition": "deferred", "reason": "The `customerReviewResponses` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.customerReviews_response_getToOneRelationship", @@ -2476,7 +2476,7 @@ "disposition": "deferred", "reason": "The `customerReviews` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.devices_getInstance", @@ -2484,7 +2484,7 @@ "disposition": "deferred", "reason": "The `devices` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.endAppAvailabilityPreOrders_createInstance", @@ -2492,7 +2492,7 @@ "disposition": "deferred", "reason": "The `endAppAvailabilityPreOrders` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.endUserLicenseAgreements_deleteInstance", @@ -2500,7 +2500,7 @@ "disposition": "deferred", "reason": "The `endUserLicenseAgreements` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.endUserLicenseAgreements_getInstance", @@ -2508,7 +2508,7 @@ "disposition": "deferred", "reason": "The `endUserLicenseAgreements` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.endUserLicenseAgreements_territories_getToManyRelationship", @@ -2516,7 +2516,7 @@ "disposition": "deferred", "reason": "The `endUserLicenseAgreements` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.endUserLicenseAgreements_territories_getToManyRelated", @@ -2524,7 +2524,7 @@ "disposition": "deferred", "reason": "The `endUserLicenseAgreements` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchaseAvailabilities_availableTerritories_getToManyRelationship", @@ -2532,7 +2532,7 @@ "disposition": "deferred", "reason": "The `inAppPurchaseAvailabilities` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchaseContents_getInstance", @@ -2540,7 +2540,7 @@ "disposition": "deferred", "reason": "The `inAppPurchaseContents` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchaseLocalizations_getInstance", @@ -2548,7 +2548,7 @@ "disposition": "deferred", "reason": "The `inAppPurchaseLocalizations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchaseOfferCodes_customCodes_getToManyRelated", @@ -2556,7 +2556,7 @@ "disposition": "deferred", "reason": "The `inAppPurchaseOfferCodes` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchaseOfferCodes_customCodes_getToManyRelationship", @@ -2564,7 +2564,7 @@ "disposition": "deferred", "reason": "The `inAppPurchaseOfferCodes` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchaseOfferCodes_oneTimeUseCodes_getToManyRelationship", @@ -2572,7 +2572,7 @@ "disposition": "deferred", "reason": "The `inAppPurchaseOfferCodes` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchaseOfferCodes_prices_getToManyRelationship", @@ -2580,7 +2580,7 @@ "disposition": "deferred", "reason": "The `inAppPurchaseOfferCodes` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasePricePoints_equalizations_getToManyRelationship", @@ -2588,7 +2588,7 @@ "disposition": "deferred", "reason": "The `inAppPurchasePricePoints` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasePriceSchedules_getInstance", @@ -2596,7 +2596,7 @@ "disposition": "deferred", "reason": "The `inAppPurchasePriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasePriceSchedules_baseTerritory_getToOneRelated", @@ -2604,7 +2604,7 @@ "disposition": "deferred", "reason": "The `inAppPurchasePriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasePriceSchedules_automaticPrices_getToManyRelationship", @@ -2612,7 +2612,7 @@ "disposition": "deferred", "reason": "The `inAppPurchasePriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasePriceSchedules_baseTerritory_getToOneRelationship", @@ -2620,7 +2620,7 @@ "disposition": "deferred", "reason": "The `inAppPurchasePriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasePriceSchedules_manualPrices_getToManyRelationship", @@ -2628,7 +2628,7 @@ "disposition": "deferred", "reason": "The `inAppPurchasePriceSchedules` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchaseVersions_image_getToOneRelationship", @@ -2636,7 +2636,7 @@ "disposition": "deferred", "reason": "`iap_get_version_image` returns the singular related review image itself; the linkage-only relationship document would duplicate that workflow without additional public value.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchaseVersions_images_getToManyRelationship", @@ -2644,7 +2644,7 @@ "disposition": "deferred", "reason": "The plural IAP image relationship is semantically ambiguous beside Apple's documented singular review screenshot, so its linkage-only document remains deferred with the plural related-resource endpoint.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchaseVersions_localizations_getToManyRelationship", @@ -2652,7 +2652,7 @@ "disposition": "deferred", "reason": "`iap_list_version_localizations` returns the related localization resources and IDs; the linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchases_getInstance", @@ -2660,7 +2660,7 @@ "disposition": "deferred", "reason": "The `inAppPurchases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.merchantIds_getCollection", @@ -2668,7 +2668,7 @@ "disposition": "deferred", "reason": "The `merchantIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.merchantIds_createInstance", @@ -2676,7 +2676,7 @@ "disposition": "deferred", "reason": "The `merchantIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.merchantIds_deleteInstance", @@ -2684,7 +2684,7 @@ "disposition": "deferred", "reason": "The `merchantIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.merchantIds_getInstance", @@ -2692,7 +2692,7 @@ "disposition": "deferred", "reason": "The `merchantIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.merchantIds_updateInstance", @@ -2700,7 +2700,7 @@ "disposition": "deferred", "reason": "The `merchantIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.merchantIds_certificates_getToManyRelated", @@ -2708,7 +2708,7 @@ "disposition": "deferred", "reason": "The `merchantIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.merchantIds_certificates_getToManyRelationship", @@ -2716,7 +2716,7 @@ "disposition": "deferred", "reason": "The `merchantIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.nominations_getCollection", @@ -2724,7 +2724,7 @@ "disposition": "deferred", "reason": "The `nominations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.nominations_createInstance", @@ -2732,7 +2732,7 @@ "disposition": "deferred", "reason": "The `nominations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.nominations_deleteInstance", @@ -2740,7 +2740,7 @@ "disposition": "deferred", "reason": "The `nominations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.nominations_getInstance", @@ -2748,7 +2748,7 @@ "disposition": "deferred", "reason": "The `nominations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.nominations_updateInstance", @@ -2756,7 +2756,7 @@ "disposition": "deferred", "reason": "The `nominations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.passTypeIds_getCollection", @@ -2764,7 +2764,7 @@ "disposition": "deferred", "reason": "The `passTypeIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.passTypeIds_createInstance", @@ -2772,7 +2772,7 @@ "disposition": "deferred", "reason": "The `passTypeIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.passTypeIds_deleteInstance", @@ -2780,7 +2780,7 @@ "disposition": "deferred", "reason": "The `passTypeIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.passTypeIds_getInstance", @@ -2788,7 +2788,7 @@ "disposition": "deferred", "reason": "The `passTypeIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.passTypeIds_updateInstance", @@ -2796,7 +2796,7 @@ "disposition": "deferred", "reason": "The `passTypeIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.passTypeIds_certificates_getToManyRelated", @@ -2804,7 +2804,7 @@ "disposition": "deferred", "reason": "The `passTypeIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.passTypeIds_certificates_getToManyRelationship", @@ -2812,7 +2812,7 @@ "disposition": "deferred", "reason": "The `passTypeIds` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.preReleaseVersions_app_getToOneRelated", @@ -2820,7 +2820,7 @@ "disposition": "deferred", "reason": "The `preReleaseVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.preReleaseVersions_app_getToOneRelationship", @@ -2828,7 +2828,7 @@ "disposition": "deferred", "reason": "The `preReleaseVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.preReleaseVersions_builds_getToManyRelationship", @@ -2836,7 +2836,7 @@ "disposition": "deferred", "reason": "The `preReleaseVersions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.profiles_bundleId_getToOneRelated", @@ -2844,7 +2844,7 @@ "disposition": "deferred", "reason": "The `profiles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.profiles_certificates_getToManyRelated", @@ -2852,7 +2852,7 @@ "disposition": "deferred", "reason": "The `profiles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.profiles_devices_getToManyRelated", @@ -2860,7 +2860,7 @@ "disposition": "deferred", "reason": "The `profiles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.profiles_bundleId_getToOneRelationship", @@ -2868,7 +2868,7 @@ "disposition": "deferred", "reason": "The `profiles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.profiles_certificates_getToManyRelationship", @@ -2876,7 +2876,7 @@ "disposition": "deferred", "reason": "The `profiles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.profiles_devices_getToManyRelationship", @@ -2884,7 +2884,7 @@ "disposition": "deferred", "reason": "The `profiles` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.reviewSubmissions_items_getToManyRelationship", @@ -2892,7 +2892,7 @@ "disposition": "deferred", "reason": "`review_submissions_list_items` returns typed review item resources and IDs for recovery; the linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.routingAppCoverages_createInstance", @@ -2900,7 +2900,7 @@ "disposition": "deferred", "reason": "The `routingAppCoverages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.routingAppCoverages_deleteInstance", @@ -2908,7 +2908,7 @@ "disposition": "deferred", "reason": "The `routingAppCoverages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.routingAppCoverages_getInstance", @@ -2916,7 +2916,7 @@ "disposition": "deferred", "reason": "The `routingAppCoverages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.routingAppCoverages_updateInstance", @@ -2924,7 +2924,7 @@ "disposition": "deferred", "reason": "The `routingAppCoverages` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.scmProviders_repositories_getToManyRelationship", @@ -2932,7 +2932,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_scm_provider_repositories_list is a functional superset that returns repository identities together with repository attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.scmRepositories_gitReferences_getToManyRelationship", @@ -2940,7 +2940,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_scm_repository_git_references_list is a functional superset that returns Git-reference identities together with reference attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.scmRepositories_pullRequests_getToManyRelationship", @@ -2948,7 +2948,7 @@ "disposition": "deferred", "reason": "This ID-only linkage endpoint is intentionally deferred because xcode_cloud_scm_repository_pull_requests_list is a functional superset that returns pull-request identities together with pull-request attributes, included resources, and pagination.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionAvailabilities_getInstance", @@ -2956,7 +2956,7 @@ "disposition": "deferred", "reason": "The `subscriptionAvailabilities` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionAvailabilities_availableTerritories_getToManyRelationship", @@ -2964,7 +2964,7 @@ "disposition": "deferred", "reason": "The `subscriptionAvailabilities` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionGracePeriods_getInstance", @@ -2972,7 +2972,7 @@ "disposition": "deferred", "reason": "The `subscriptionGracePeriods` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionGracePeriods_updateInstance", @@ -2980,7 +2980,7 @@ "disposition": "deferred", "reason": "The `subscriptionGracePeriods` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionGroupVersions_localizations_getToManyRelationship", @@ -2988,7 +2988,7 @@ "disposition": "deferred", "reason": "`subscriptions_list_group_version_localizations` returns the related localization resources and IDs; the linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionGroups_subscriptionGroupLocalizations_getToManyRelationship", @@ -2996,7 +2996,7 @@ "disposition": "deferred", "reason": "The `subscriptionGroups` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionGroups_subscriptions_getToManyRelationship", @@ -3004,7 +3004,7 @@ "disposition": "deferred", "reason": "The `subscriptionGroups` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionGroups_versions_getToManyRelationship", @@ -3012,7 +3012,7 @@ "disposition": "deferred", "reason": "`subscriptions_list_group_versions` returns the related metadata versions and IDs; the linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionOfferCodeOneTimeUseCodes_updateInstance", @@ -3020,7 +3020,7 @@ "disposition": "deferred", "reason": "The `subscriptionOfferCodeOneTimeUseCodes` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionOfferCodes_customCodes_getToManyRelated", @@ -3028,7 +3028,7 @@ "disposition": "deferred", "reason": "The `subscriptionOfferCodes` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionOfferCodes_customCodes_getToManyRelationship", @@ -3036,7 +3036,7 @@ "disposition": "deferred", "reason": "The `subscriptionOfferCodes` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionOfferCodes_oneTimeUseCodes_getToManyRelationship", @@ -3044,7 +3044,7 @@ "disposition": "deferred", "reason": "The `subscriptionOfferCodes` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionOfferCodes_prices_getToManyRelationship", @@ -3052,7 +3052,7 @@ "disposition": "deferred", "reason": "The `subscriptionOfferCodes` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionPlanAvailabilities_availableTerritories_getToManyRelationship", @@ -3060,7 +3060,7 @@ "disposition": "deferred", "reason": "`subscriptions_list_plan_availability_territories` returns the related territory resources and IDs with pagination; the linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionPlanAvailabilities_availableTerritories_replaceToManyRelationship", @@ -3068,7 +3068,7 @@ "disposition": "deferred", "reason": "`subscriptions_update_plan_availability` already replaces the complete territory relationship through the resource PATCH and can update the nullable availability attribute atomically; a second relationship-only mutation is intentionally deferred.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionPricePoints_equalizations_getToManyRelationship", @@ -3076,7 +3076,7 @@ "disposition": "deferred", "reason": "The `subscriptionPricePoints` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionPromotionalOffers_prices_getToManyRelationship", @@ -3084,7 +3084,7 @@ "disposition": "deferred", "reason": "The `subscriptionPromotionalOffers` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionVersions_image_getToOneRelated", @@ -3092,7 +3092,7 @@ "disposition": "deferred", "reason": "Apple 4.4.1 documents plural version-owned subscription promotional images, which `subscriptions_list_version_images` exposes. The overlapping singular related-resource endpoint is deferred until Apple clarifies its distinct semantics.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionVersions_image_getToOneRelationship", @@ -3100,7 +3100,7 @@ "disposition": "deferred", "reason": "The singular subscription image relationship is semantically ambiguous beside Apple's documented plural promotional images, so its linkage-only document remains deferred with the singular related-resource endpoint.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionVersions_images_getToManyRelationship", @@ -3108,7 +3108,7 @@ "disposition": "deferred", "reason": "`subscriptions_list_version_images` returns the related promotional image resources and IDs; the linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptionVersions_localizations_getToManyRelationship", @@ -3116,7 +3116,7 @@ "disposition": "deferred", "reason": "`subscriptions_list_version_localizations` returns the related localization resources and IDs; the linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_appStoreReviewScreenshot_getToOneRelationship", @@ -3124,7 +3124,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_images_getToManyRelationship", @@ -3132,7 +3132,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_introductoryOffers_deleteToManyRelationship", @@ -3140,7 +3140,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_introductoryOffers_getToManyRelationship", @@ -3148,7 +3148,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_offerCodes_getToManyRelationship", @@ -3156,7 +3156,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_planAvailabilities_getToManyRelationship", @@ -3164,7 +3164,7 @@ "disposition": "deferred", "reason": "`subscriptions_list_plan_availabilities` returns the related plan availability resources and IDs; the linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_pricePoints_getToManyRelationship", @@ -3172,7 +3172,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_prices_deleteToManyRelationship", @@ -3180,7 +3180,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_prices_getToManyRelationship", @@ -3188,7 +3188,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_promotedPurchase_getToOneRelationship", @@ -3196,7 +3196,7 @@ "disposition": "deferred", "reason": "promoted_list and promoted_get expose the promoted-purchase resource and its linked subscription; this linkage-only inverse relationship is deferred because it carries only the promoted-purchase ID.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_promotionalOffers_getToManyRelationship", @@ -3204,7 +3204,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_subscriptionAvailability_getToOneRelationship", @@ -3212,7 +3212,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_subscriptionLocalizations_getToManyRelationship", @@ -3220,7 +3220,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_versions_getToManyRelationship", @@ -3228,7 +3228,7 @@ "disposition": "deferred", "reason": "`subscriptions_list_versions` returns the related metadata versions and IDs; the linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.subscriptions_winBackOffers_getToManyRelationship", @@ -3236,7 +3236,7 @@ "disposition": "deferred", "reason": "The `subscriptions` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.territoryAvailabilities_updateInstance", @@ -3244,7 +3244,7 @@ "disposition": "deferred", "reason": "The `territoryAvailabilities` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.userInvitations_getInstance", @@ -3252,7 +3252,7 @@ "disposition": "deferred", "reason": "The `userInvitations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.userInvitations_visibleApps_getToManyRelationship", @@ -3260,7 +3260,7 @@ "disposition": "deferred", "reason": "The `userInvitations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.userInvitations_visibleApps_getToManyRelated", @@ -3268,7 +3268,7 @@ "disposition": "deferred", "reason": "The `userInvitations` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.users_visibleApps_getToManyRelationship", @@ -3276,7 +3276,7 @@ "disposition": "deferred", "reason": "The `users` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.users_visibleApps_replaceToManyRelationship", @@ -3284,7 +3284,7 @@ "disposition": "deferred", "reason": "The `users` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.webhooks_deliveries_getToManyRelationship", @@ -3292,7 +3292,7 @@ "disposition": "deferred", "reason": "The `webhooks` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.winBackOffers_prices_getToManyRelationship", @@ -3300,7 +3300,7 @@ "disposition": "deferred", "reason": "The `winBackOffers` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appAvailabilitiesV2_territoryAvailabilities_getToManyRelationship", @@ -3308,7 +3308,7 @@ "disposition": "deferred", "reason": "The `appAvailabilities` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelationship", @@ -3316,7 +3316,7 @@ "disposition": "deferred", "reason": "ppo_list_treatments returns full treatment resources; this V2 linkage-only relationship document is deferred because it duplicates IDs without treatment attributes.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_content_getToOneRelated", @@ -3324,7 +3324,7 @@ "disposition": "deferred", "reason": "The `inAppPurchases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelationship", @@ -3332,7 +3332,7 @@ "disposition": "deferred", "reason": "The `inAppPurchases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_content_getToOneRelationship", @@ -3340,7 +3340,7 @@ "disposition": "deferred", "reason": "The `inAppPurchases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_iapPriceSchedule_getToOneRelationship", @@ -3348,7 +3348,7 @@ "disposition": "deferred", "reason": "The `inAppPurchases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_images_getToManyRelationship", @@ -3356,7 +3356,7 @@ "disposition": "deferred", "reason": "The `inAppPurchases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelationship", @@ -3364,7 +3364,7 @@ "disposition": "deferred", "reason": "The `inAppPurchases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_inAppPurchaseLocalizations_getToManyRelationship", @@ -3372,7 +3372,7 @@ "disposition": "deferred", "reason": "The `inAppPurchases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_offerCodes_getToManyRelationship", @@ -3380,7 +3380,7 @@ "disposition": "deferred", "reason": "The `inAppPurchases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_pricePoints_getToManyRelationship", @@ -3388,7 +3388,7 @@ "disposition": "deferred", "reason": "The `inAppPurchases` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_promotedPurchase_getToOneRelationship", @@ -3396,7 +3396,7 @@ "disposition": "deferred", "reason": "promoted_list and promoted_get expose the promoted-purchase resource and its linked in-app purchase; this linkage-only inverse relationship is deferred because it carries only the promoted-purchase ID.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.inAppPurchasesV2_versions_getToManyRelationship", @@ -3404,7 +3404,7 @@ "disposition": "deferred", "reason": "`iap_list_versions` returns the related metadata versions and IDs; the linkage-only relationship document is a lower-value duplicate.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPricePointsV3_getInstance", @@ -3412,7 +3412,7 @@ "disposition": "deferred", "reason": "The `appPricePoints` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPricePointsV3_equalizations_getToManyRelated", @@ -3420,7 +3420,7 @@ "disposition": "deferred", "reason": "The `appPricePoints` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "deferred.appPricePointsV3_equalizations_getToManyRelationship", @@ -3428,7 +3428,7 @@ "disposition": "deferred", "reason": "The `appPricePoints` resource-group capability is not yet exposed by asc-mcp.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "unsupported.appAssetLibraries_images_getToManyRelationship", @@ -3436,7 +3436,7 @@ "disposition": "unsupported", "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "unsupported.appAssetLibraries_videos_getToManyRelationship", @@ -3444,7 +3444,7 @@ "disposition": "unsupported", "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "unsupported.appAssetLibraryImages_placements_getToManyRelationship", @@ -3452,7 +3452,7 @@ "disposition": "unsupported", "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "unsupported.appAssetLibraryVideos_placements_getToManyRelationship", @@ -3460,7 +3460,7 @@ "disposition": "unsupported", "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "unsupported.appCustomProductPageLocalizations_placements_getToManyRelationship", @@ -3468,7 +3468,7 @@ "disposition": "unsupported", "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "unsupported.appEventLocalizations_placements_getToManyRelationship", @@ -3476,7 +3476,7 @@ "disposition": "unsupported", "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "unsupported.appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelationship", @@ -3484,7 +3484,7 @@ "disposition": "unsupported", "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "unsupported.appStoreVersionLocalizations_placements_getToManyRelationship", @@ -3492,7 +3492,7 @@ "disposition": "unsupported", "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "unsupported.apps_assetLibrary_getToOneRelationship", @@ -3500,7 +3500,79 @@ "disposition": "unsupported", "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" + }, + { + "id": "unsupported.apps_retentionMessages_getToManyRelationship", + "operationId": "apps_retentionMessages_getToManyRelationship", + "disposition": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", + "owner": "subscriptions", + "reviewAtSpec": "4.6" + }, + { + "id": "unsupported.retentionMessageVersions_localizations_getToManyRelationship", + "operationId": "retentionMessageVersions_localizations_getToManyRelationship", + "disposition": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", + "owner": "subscriptions", + "reviewAtSpec": "4.6" + }, + { + "id": "unsupported.retentionMessageVersions_placement_getToOneRelationship", + "operationId": "retentionMessageVersions_placement_getToOneRelationship", + "disposition": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", + "owner": "assets", + "reviewAtSpec": "4.6" + }, + { + "id": "unsupported.retentionMessages_subscriptions_getToManyRelationship", + "operationId": "retentionMessages_subscriptions_getToManyRelationship", + "disposition": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", + "owner": "subscriptions", + "reviewAtSpec": "4.6" + }, + { + "id": "unsupported.retentionMessages_versions_getToManyRelationship", + "operationId": "retentionMessages_versions_getToManyRelationship", + "disposition": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", + "owner": "subscriptions", + "reviewAtSpec": "4.6" + }, + { + "id": "unsupported.retentionOffers_prices_getToManyRelationship", + "operationId": "retentionOffers_prices_getToManyRelationship", + "disposition": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", + "owner": "subscriptions", + "reviewAtSpec": "4.6" + }, + { + "id": "unsupported.subscriptions_retentionMessage_getToOneRelationship", + "operationId": "subscriptions_retentionMessage_getToOneRelationship", + "disposition": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", + "owner": "subscriptions", + "reviewAtSpec": "4.6" + }, + { + "id": "unsupported.subscriptions_retentionMessageOffers_getToManyRelationship", + "operationId": "subscriptions_retentionMessageOffers_getToManyRelationship", + "disposition": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", + "owner": "subscriptions", + "reviewAtSpec": "4.6" + }, + { + "id": "unsupported.subscriptions_retentionOffers_getToManyRelationship", + "operationId": "subscriptions_retentionOffers_getToManyRelationship", + "disposition": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented.", + "owner": "subscriptions", + "reviewAtSpec": "4.6" } ], "semanticDeprecations": [ @@ -3543,7 +3615,7 @@ "reason": "Apple deprecated screenshot and preview set resources in API 4.5.1. Keep legacy tools compatible while offering Asset Library images, videos, and placements; no shutdown date has been published.", "sourceURL": "https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-4-5-1-release-notes", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "apple-4.5.1-event-media", @@ -3564,7 +3636,7 @@ "reason": "Apple deprecated event screenshots and video clips in favor of Asset Library images, videos, and placements.", "sourceURL": "https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-4-5-1-release-notes", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "apple-4.5-app-tag-territories", @@ -3575,7 +3647,7 @@ "reason": "Apple deprecated the territories relationship and territory endpoints for app tags.", "sourceURL": "https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-4-5-release-notes", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "id": "apple-4.5-app-tag-territory-parameters", @@ -3591,7 +3663,7 @@ "reason": "Release notes disallow territory-related selections, while the 4.5.1 OpenAPI still declares them. App tags remain deferred; resolve this documentation conflict before exposing territory selections.", "sourceURL": "https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-4-5-release-notes", "owner": "asc-mcp", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/accessibility.json b/Sources/asc-mcp/Resources/OperationManifest/tools/accessibility.json index 4cc5231..063fa1a 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/accessibility.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/accessibility.json @@ -28,26 +28,92 @@ } ], "fields": [ - { "toolField": "app_id", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/relationships/app/data/id" }, - { "toolField": "device_family", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/attributes/deviceFamily" }, - { "toolField": "supports_audio_descriptions", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/attributes/supportsAudioDescriptions" }, - { "toolField": "supports_captions", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/attributes/supportsCaptions" }, - { "toolField": "supports_dark_interface", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/attributes/supportsDarkInterface" }, - { "toolField": "supports_differentiate_without_color_alone", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/attributes/supportsDifferentiateWithoutColorAlone" }, - { "toolField": "supports_larger_text", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/attributes/supportsLargerText" }, - { "toolField": "supports_reduced_motion", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/attributes/supportsReducedMotion" }, - { "toolField": "supports_sufficient_contrast", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/attributes/supportsSufficientContrast" }, - { "toolField": "supports_voice_control", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/attributes/supportsVoiceControl" }, - { "toolField": "supports_voiceover", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data/attributes/supportsVoiceover" } + { + "toolField": "app_id", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/relationships/app/data/id" + }, + { + "toolField": "device_family", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/attributes/deviceFamily" + }, + { + "toolField": "supports_audio_descriptions", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/attributes/supportsAudioDescriptions" + }, + { + "toolField": "supports_captions", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/attributes/supportsCaptions" + }, + { + "toolField": "supports_dark_interface", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/attributes/supportsDarkInterface" + }, + { + "toolField": "supports_differentiate_without_color_alone", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/attributes/supportsDifferentiateWithoutColorAlone" + }, + { + "toolField": "supports_larger_text", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/attributes/supportsLargerText" + }, + { + "toolField": "supports_reduced_motion", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/attributes/supportsReducedMotion" + }, + { + "toolField": "supports_sufficient_contrast", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/attributes/supportsSufficientContrast" + }, + { + "toolField": "supports_voice_control", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/attributes/supportsVoiceControl" + }, + { + "toolField": "supports_voiceover", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data/attributes/supportsVoiceover" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "accessibilityDeclarations_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "accessibilityDeclarations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulCreate" }, - { "outputField": "accessibility_declaration", "operationId": "accessibilityDeclarations_createInstance", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "successfulCreate" + }, + { + "outputField": "accessibility_declaration", + "operationId": "accessibilityDeclarations_createInstance", + "jsonPointer": "/data" + } ] }, "note": "The request body covers every current AccessibilityDeclaration create attribute exposed by Apple; partial only because the MCP tool has no declared output schema." @@ -67,16 +133,31 @@ } ], "fields": [ - { "toolField": "declaration_id", "sourceKind": "parameter", "operationId": "accessibilityDeclarations_deleteInstance", "location": "path", "appleName": "id" } + { + "toolField": "declaration_id", + "sourceKind": "parameter", + "operationId": "accessibilityDeclarations_deleteInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "accessibilityDeclarations_deleteInstance", "statusCode": "204" } + { + "operationId": "accessibilityDeclarations_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "successful204" }, - { "outputField": "message", "localRole": "deleteConfirmation" } + { + "outputField": "success", + "localRole": "successful204" + }, + { + "outputField": "message", + "localRole": "deleteConfirmation" + } ] }, "note": "Apple returns 204 without content; deletion is permitted only while the declaration remains editable and the handler creates the confirmation locally." @@ -96,17 +177,40 @@ } ], "fields": [ - { "toolField": "declaration_id", "sourceKind": "parameter", "operationId": "accessibilityDeclarations_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "fields", "sourceKind": "parameter", "operationId": "accessibilityDeclarations_getInstance", "location": "query", "appleName": "fields[accessibilityDeclarations]" } + { + "toolField": "declaration_id", + "sourceKind": "parameter", + "operationId": "accessibilityDeclarations_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "fields", + "sourceKind": "parameter", + "operationId": "accessibilityDeclarations_getInstance", + "location": "query", + "appleName": "fields[accessibilityDeclarations]" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "accessibilityDeclarations_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "accessibilityDeclarations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "accessibility_declaration", "operationId": "accessibilityDeclarations_getInstance", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "accessibility_declaration", + "operationId": "accessibilityDeclarations_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Direct resource read with a local response projection; partial until a structured output schema is declared." @@ -126,24 +230,80 @@ } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_accessibilityDeclarations_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "device_family", "sourceKind": "parameter", "operationId": "apps_accessibilityDeclarations_getToManyRelated", "location": "query", "appleName": "filter[deviceFamily]" }, - { "toolField": "state", "sourceKind": "parameter", "operationId": "apps_accessibilityDeclarations_getToManyRelated", "location": "query", "appleName": "filter[state]" }, - { "toolField": "fields", "sourceKind": "parameter", "operationId": "apps_accessibilityDeclarations_getToManyRelated", "location": "query", "appleName": "fields[accessibilityDeclarations]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "apps_accessibilityDeclarations_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_accessibilityDeclarations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "device_family", + "sourceKind": "parameter", + "operationId": "apps_accessibilityDeclarations_getToManyRelated", + "location": "query", + "appleName": "filter[deviceFamily]" + }, + { + "toolField": "state", + "sourceKind": "parameter", + "operationId": "apps_accessibilityDeclarations_getToManyRelated", + "location": "query", + "appleName": "filter[state]" + }, + { + "toolField": "fields", + "sourceKind": "parameter", + "operationId": "apps_accessibilityDeclarations_getToManyRelated", + "location": "query", + "appleName": "fields[accessibilityDeclarations]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_accessibilityDeclarations_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "apps_accessibilityDeclarations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_accessibilityDeclarations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "accessibility_declarations", "operationId": "apps_accessibilityDeclarations_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "count", "localRole": "Count resources in the returned page." }, - { "outputField": "total", "operationId": "apps_accessibilityDeclarations_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "next_url", "operationId": "apps_accessibilityDeclarations_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "accessibility_declarations", + "operationId": "apps_accessibilityDeclarations_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "count", + "localRole": "Count resources in the returned page." + }, + { + "outputField": "total", + "operationId": "apps_accessibilityDeclarations_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "next_url", + "operationId": "apps_accessibilityDeclarations_getToManyRelated", + "jsonPointer": "/links/next" + } ] }, "note": "The current public schema and handler support scalar, comma-separated, or array deviceFamily and state filters, bounded pagination, sparse fields, and secure continuation URLs that preserve active filters and fieldsets; partial only because the tool has no outputSchema." @@ -163,22 +323,64 @@ } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_accessibilityDeclarations_getToManyRelationship", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "apps_accessibilityDeclarations_getToManyRelationship", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_accessibilityDeclarations_getToManyRelationship", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_accessibilityDeclarations_getToManyRelationship", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "apps_accessibilityDeclarations_getToManyRelationship", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_accessibilityDeclarations_getToManyRelationship", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "relationships", "operationId": "apps_accessibilityDeclarations_getToManyRelationship", "jsonPointer": "/data" }, - { "outputField": "declaration_ids", "operationId": "apps_accessibilityDeclarations_getToManyRelationship", "jsonPointer": "/data/*/id" }, - { "outputField": "count", "localRole": "Count relationship linkages in the returned page." }, - { "outputField": "total", "operationId": "apps_accessibilityDeclarations_getToManyRelationship", "jsonPointer": "/meta/paging/total" }, - { "outputField": "next_url", "operationId": "apps_accessibilityDeclarations_getToManyRelationship", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "relationships", + "operationId": "apps_accessibilityDeclarations_getToManyRelationship", + "jsonPointer": "/data" + }, + { + "outputField": "declaration_ids", + "operationId": "apps_accessibilityDeclarations_getToManyRelationship", + "jsonPointer": "/data/*/id" + }, + { + "outputField": "count", + "localRole": "Count relationship linkages in the returned page." + }, + { + "outputField": "total", + "operationId": "apps_accessibilityDeclarations_getToManyRelationship", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "next_url", + "operationId": "apps_accessibilityDeclarations_getToManyRelationship", + "jsonPointer": "/links/next" + } ] }, "note": "Direct relationship-linkage read with local projection and pagination continuation handling." @@ -213,26 +415,94 @@ } ], "fields": [ - { "toolField": "declaration_id", "sourceKind": "parameter", "operationId": "accessibilityDeclarations_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "publish", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data/attributes/publish", "localRole": "Preserve Boolean values and explicit JSON null distinctly from omission." }, - { "toolField": "supports_audio_descriptions", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data/attributes/supportsAudioDescriptions" }, - { "toolField": "supports_captions", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data/attributes/supportsCaptions" }, - { "toolField": "supports_dark_interface", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data/attributes/supportsDarkInterface" }, - { "toolField": "supports_differentiate_without_color_alone", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data/attributes/supportsDifferentiateWithoutColorAlone" }, - { "toolField": "supports_larger_text", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data/attributes/supportsLargerText" }, - { "toolField": "supports_reduced_motion", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data/attributes/supportsReducedMotion" }, - { "toolField": "supports_sufficient_contrast", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data/attributes/supportsSufficientContrast" }, - { "toolField": "supports_voice_control", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data/attributes/supportsVoiceControl" }, - { "toolField": "supports_voiceover", "sourceKind": "requestBody", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data/attributes/supportsVoiceover" } + { + "toolField": "declaration_id", + "sourceKind": "parameter", + "operationId": "accessibilityDeclarations_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "publish", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data/attributes/publish", + "localRole": "Preserve Boolean values and explicit JSON null distinctly from omission." + }, + { + "toolField": "supports_audio_descriptions", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data/attributes/supportsAudioDescriptions" + }, + { + "toolField": "supports_captions", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data/attributes/supportsCaptions" + }, + { + "toolField": "supports_dark_interface", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data/attributes/supportsDarkInterface" + }, + { + "toolField": "supports_differentiate_without_color_alone", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data/attributes/supportsDifferentiateWithoutColorAlone" + }, + { + "toolField": "supports_larger_text", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data/attributes/supportsLargerText" + }, + { + "toolField": "supports_reduced_motion", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data/attributes/supportsReducedMotion" + }, + { + "toolField": "supports_sufficient_contrast", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data/attributes/supportsSufficientContrast" + }, + { + "toolField": "supports_voice_control", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data/attributes/supportsVoiceControl" + }, + { + "toolField": "supports_voiceover", + "sourceKind": "requestBody", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data/attributes/supportsVoiceover" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "accessibilityDeclarations_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "accessibilityDeclarations_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulUpdate" }, - { "outputField": "accessibility_declaration", "operationId": "accessibilityDeclarations_updateInstance", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "successfulUpdate" + }, + { + "outputField": "accessibility_declaration", + "operationId": "accessibilityDeclarations_updateInstance", + "jsonPointer": "/data" + } ] }, "note": "The payload covers all current Apple update attributes and preserves an explicit JSON null for publish and every nullable supports attribute distinctly from omission; a null-only request is therefore a real update rather than a no-op. Apple permits support-flag edits only while the declaration is in DRAFT, with publish transitioning it out of that editable state." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/analytics.json b/Sources/asc-mcp/Resources/OperationManifest/tools/analytics.json index 863b9b8..a6d96dc 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/analytics.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/analytics.json @@ -16,10 +16,38 @@ "role": "primary", "condition": "Always: SALES + SUMMARY + DAILY.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "filter[reportType]", "fixedValue": ["SALES"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[reportSubType]", "fixedValue": ["SUMMARY"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[frequency]", "fixedValue": ["DAILY"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[version]", "fixedValue": ["1_0"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[reportType]", + "fixedValue": [ + "SALES" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[reportSubType]", + "fixedValue": [ + "SUMMARY" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[frequency]", + "fixedValue": [ + "DAILY" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[version]", + "fixedValue": [ + "1_0" + ] + } ] }, { @@ -30,10 +58,38 @@ "role": "supporting", "condition": "Always: SUBSCRIPTION + SUMMARY + DAILY.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "filter[reportType]", "fixedValue": ["SUBSCRIPTION"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[reportSubType]", "fixedValue": ["SUMMARY"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[frequency]", "fixedValue": ["DAILY"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[version]", "fixedValue": ["1_3"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[reportType]", + "fixedValue": [ + "SUBSCRIPTION" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[reportSubType]", + "fixedValue": [ + "SUMMARY" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[frequency]", + "fixedValue": [ + "DAILY" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[version]", + "fixedValue": [ + "1_3" + ] + } ] }, { @@ -44,10 +100,38 @@ "role": "supporting", "condition": "Always: SUBSCRIPTION_EVENT + SUMMARY + DAILY.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "filter[reportType]", "fixedValue": ["SUBSCRIPTION_EVENT"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[reportSubType]", "fixedValue": ["SUMMARY"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[frequency]", "fixedValue": ["DAILY"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[version]", "fixedValue": ["1_3"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[reportType]", + "fixedValue": [ + "SUBSCRIPTION_EVENT" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[reportSubType]", + "fixedValue": [ + "SUMMARY" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[frequency]", + "fixedValue": [ + "DAILY" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[version]", + "fixedValue": [ + "1_3" + ] + } ] }, { @@ -58,10 +142,38 @@ "role": "supporting", "condition": "Always: SUBSCRIBER + DETAILED + DAILY.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "filter[reportType]", "fixedValue": ["SUBSCRIBER"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[reportSubType]", "fixedValue": ["DETAILED"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[frequency]", "fixedValue": ["DAILY"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "filter[version]", "fixedValue": ["1_3"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[reportType]", + "fixedValue": [ + "SUBSCRIBER" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[reportSubType]", + "fixedValue": [ + "DETAILED" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[frequency]", + "fixedValue": [ + "DAILY" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "filter[version]", + "fixedValue": [ + "1_3" + ] + } ] } ], @@ -98,10 +210,10 @@ "location": "query", "appleName": "filter[reportDate]" }, - { - "toolField": "app_id", - "sourceKind": "local", - "localRole": "trimmedNonEmptyValidationThenPostDownloadAppIdentifierColumnFilter" + { + "toolField": "app_id", + "sourceKind": "local", + "localRole": "trimmedNonEmptyValidationThenPostDownloadAppIdentifierColumnFilter" }, { "toolField": "vendor_number", @@ -147,7 +259,12 @@ "operationId": "salesReports_getCollection", "statusCode": "200", "mediaType": "application/a-gzip", - "invocationIds": ["downloads", "subscriptions", "subscription-events", "revenue"] + "invocationIds": [ + "downloads", + "subscriptions", + "subscription-events", + "revenue" + ] } ], "fields": [ @@ -167,7 +284,12 @@ "outputField": "sections", "operationId": "salesReports_getCollection", "jsonPointer": "/", - "invocationIds": ["downloads", "subscriptions", "subscription-events", "revenue"], + "invocationIds": [ + "downloads", + "subscriptions", + "subscription-events", + "revenue" + ], "localRole": "fourGzipTSVParsesAndAggregations" }, { @@ -220,14 +342,14 @@ "appleName": "filter[granularity]", "disposition": "intentionallyOmitted", "reason": "The readiness heuristic only needs to know whether any report instance exists, regardless of granularity.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[processingDate]", "disposition": "intentionallyOmitted", "reason": "The readiness heuristic only needs to know whether any report instance exists, regardless of processing date.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ], "inputs": [ @@ -235,7 +357,9 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["analyticsReportRequests_reports_getToManyRelated:/data/*/id"], + "derivedFrom": [ + "analyticsReportRequests_reports_getToManyRelated:/data/*/id" + ], "localRole": "iterateFilteredReportIdentifiers" }, { @@ -338,8 +462,16 @@ "path": "/v1/analyticsReportRequests", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "analyticsReportRequests" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "analyticsReportRequests" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + } ] } ], @@ -477,9 +609,9 @@ "jsonPointer": "/", "localRole": "parsedTSVRowCount" }, - { - "outputField": "summary", - "localRole": "localDecimalFinancialTSVAggregationPreferringExtendedPartnerShare" + { + "outputField": "summary", + "localRole": "localDecimalFinancialTSVAggregationPreferringExtendedPartnerShare" }, { "outputField": "rows", @@ -1003,10 +1135,10 @@ "appleName": "filter[vendorNumber]", "localRole": "optionalCompanyConfigFallback" }, - { - "toolField": "app_id", - "sourceKind": "local", - "localRole": "trimmedNonEmptyValidationThenPostDownloadAppIdentifierColumnFilter" + { + "toolField": "app_id", + "sourceKind": "local", + "localRole": "trimmedNonEmptyValidationThenPostDownloadAppIdentifierColumnFilter" }, { "toolField": "report_type", @@ -1104,9 +1236,9 @@ "outputField": "filtered_rows", "localRole": "postDownloadAppFilterCount" }, - { - "outputField": "summary", - "localRole": "reportTypeSpecificDecimalTSVAggregationWithExactMonetaryStringsAndSubscriberSuppressionSemantics" + { + "outputField": "summary", + "localRole": "reportTypeSpecificDecimalTSVAggregationWithExactMonetaryStringsAndSubscriberSuppressionSemantics" }, { "outputField": "rows", diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/app_events.json b/Sources/asc-mcp/Resources/OperationManifest/tools/app_events.json index d42d362..c9bff23 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/app_events.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/app_events.json @@ -134,7 +134,13 @@ } ], "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/relationships/placements", "disposition": "intentionallyOmitted", "reason": "Localization creation and Asset Library placement are separate operations. This legacy create tool does not attach existing placement IDs; prepare and apply placement creation through AssetsWorker after creating the localization so ownership, specification, draft state, and preview checks remain mandatory.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/relationships/placements", + "disposition": "intentionallyOmitted", + "reason": "Localization creation and Asset Library placement are separate operations. This legacy create tool does not attach existing placement IDs; prepare and apply placement creation through AssetsWorker after creating the localization so ownership, specification, draft state, and preview checks remain mandatory.", + "reviewAtSpec": "4.6" + } ] } ], @@ -219,7 +225,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "appEvents_deleteInstance", "statusCode": "204" } + { + "operationId": "appEvents_deleteInstance", + "statusCode": "204" + } ], "fields": [ { @@ -260,7 +269,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "appEventLocalizations_deleteInstance", "statusCode": "204" } + { + "operationId": "appEventLocalizations_deleteInstance", + "statusCode": "204" + } ], "fields": [ { @@ -470,7 +482,13 @@ "path": "/v1/appEvents/{id}/localizations", "role": "primary", "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", + "reviewAtSpec": "4.6" + } ] } ], diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/app_info.json b/Sources/asc-mcp/Resources/OperationManifest/tools/app_info.json index a150241..36d4d67 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/app_info.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/app_info.json @@ -33,19 +33,48 @@ } ], "fields": [ - { "toolField": "app_id", "sourceKind": "requestBody", "operationId": "endUserLicenseAgreements_createInstance", "jsonPointer": "/data/relationships/app/data/id" }, - { "toolField": "agreement_text", "sourceKind": "requestBody", "operationId": "endUserLicenseAgreements_createInstance", "jsonPointer": "/data/attributes/agreementText" }, - { "toolField": "territory_ids", "sourceKind": "requestBody", "operationId": "endUserLicenseAgreements_createInstance", "jsonPointer": "/data/relationships/territories/data/*/id" } + { + "toolField": "app_id", + "sourceKind": "requestBody", + "operationId": "endUserLicenseAgreements_createInstance", + "jsonPointer": "/data/relationships/app/data/id" + }, + { + "toolField": "agreement_text", + "sourceKind": "requestBody", + "operationId": "endUserLicenseAgreements_createInstance", + "jsonPointer": "/data/attributes/agreementText" + }, + { + "toolField": "territory_ids", + "sourceKind": "requestBody", + "operationId": "endUserLicenseAgreements_createInstance", + "jsonPointer": "/data/relationships/territories/data/*/id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "endUserLicenseAgreements_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "endUserLicenseAgreements_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulCreate" }, - { "outputField": "eula", "operationId": "endUserLicenseAgreements_createInstance", "jsonPointer": "/data" }, - { "outputField": "message", "localRole": "createConfirmation" } + { + "outputField": "success", + "localRole": "successfulCreate" + }, + { + "outputField": "eula", + "operationId": "endUserLicenseAgreements_createInstance", + "jsonPointer": "/data" + }, + { + "outputField": "message", + "localRole": "createConfirmation" + } ] }, "note": "Direct create request covers Apple's required app and territories relationships, validates non-empty unique territory IDs, and projects returned relationship detail; partial only because the tool has no declared output schema." @@ -77,22 +106,68 @@ } ], "fields": [ - { "toolField": "info_id", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_createInstance", "jsonPointer": "/data/relationships/appInfo/data/id" }, - { "toolField": "locale", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_createInstance", "jsonPointer": "/data/attributes/locale" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_createInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "subtitle", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_createInstance", "jsonPointer": "/data/attributes/subtitle" }, - { "toolField": "privacy_policy_url", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_createInstance", "jsonPointer": "/data/attributes/privacyPolicyUrl" }, - { "toolField": "privacy_choices_url", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_createInstance", "jsonPointer": "/data/attributes/privacyChoicesUrl" }, - { "toolField": "privacy_policy_text", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_createInstance", "jsonPointer": "/data/attributes/privacyPolicyText" } + { + "toolField": "info_id", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_createInstance", + "jsonPointer": "/data/relationships/appInfo/data/id" + }, + { + "toolField": "locale", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_createInstance", + "jsonPointer": "/data/attributes/locale" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "subtitle", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_createInstance", + "jsonPointer": "/data/attributes/subtitle" + }, + { + "toolField": "privacy_policy_url", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_createInstance", + "jsonPointer": "/data/attributes/privacyPolicyUrl" + }, + { + "toolField": "privacy_choices_url", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_createInstance", + "jsonPointer": "/data/attributes/privacyChoicesUrl" + }, + { + "toolField": "privacy_policy_text", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_createInstance", + "jsonPointer": "/data/attributes/privacyPolicyText" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appInfoLocalizations_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "appInfoLocalizations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulCreate" }, - { "outputField": "localization", "operationId": "appInfoLocalizations_createInstance", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "successfulCreate" + }, + { + "outputField": "localization", + "operationId": "appInfoLocalizations_createInstance", + "jsonPointer": "/data" + } ] }, "note": "The MCP schema requires Apple's locale and name attributes and preserves explicit null for every nullable optional localization attribute; partial only because the response projection has no outputSchema." @@ -112,16 +187,31 @@ } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appInfoLocalizations_deleteInstance", "location": "path", "appleName": "id" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appInfoLocalizations_deleteInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "appInfoLocalizations_deleteInstance", "statusCode": "204" } + { + "operationId": "appInfoLocalizations_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "successful204" }, - { "outputField": "message", "localRole": "deleteConfirmation" } + { + "outputField": "success", + "localRole": "successful204" + }, + { + "outputField": "message", + "localRole": "deleteConfirmation" + } ] }, "note": "Apple returns 204 without content; the handler creates the confirmation locally." @@ -141,23 +231,72 @@ } ], "fields": [ - { "toolField": "info_id", "sourceKind": "parameter", "operationId": "appInfos_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "appInfos_getInstance", "location": "query", "appleName": "include" }, - { "toolField": "localizations_limit", "sourceKind": "parameter", "operationId": "appInfos_getInstance", "location": "query", "appleName": "limit[appInfoLocalizations]" } + { + "toolField": "info_id", + "sourceKind": "parameter", + "operationId": "appInfos_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "appInfos_getInstance", + "location": "query", + "appleName": "include" + }, + { + "toolField": "localizations_limit", + "sourceKind": "parameter", + "operationId": "appInfos_getInstance", + "location": "query", + "appleName": "limit[appInfoLocalizations]" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appInfos_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appInfos_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "app_info", "operationId": "appInfos_getInstance", "jsonPointer": "/data" }, - { "outputField": "included_apps", "operationId": "appInfos_getInstance", "jsonPointer": "/included" }, - { "outputField": "included_age_rating_declarations", "operationId": "appInfos_getInstance", "jsonPointer": "/included" }, - { "outputField": "included_categories", "operationId": "appInfos_getInstance", "jsonPointer": "/included" }, - { "outputField": "included_localizations", "operationId": "appInfos_getInstance", "jsonPointer": "/included" }, - { "outputField": "included_unknown", "operationId": "appInfos_getInstance", "jsonPointer": "/included" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "app_info", + "operationId": "appInfos_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "included_apps", + "operationId": "appInfos_getInstance", + "jsonPointer": "/included" + }, + { + "outputField": "included_age_rating_declarations", + "operationId": "appInfos_getInstance", + "jsonPointer": "/included" + }, + { + "outputField": "included_categories", + "operationId": "appInfos_getInstance", + "jsonPointer": "/included" + }, + { + "outputField": "included_localizations", + "operationId": "appInfos_getInstance", + "jsonPointer": "/included" + }, + { + "outputField": "included_unknown", + "operationId": "appInfos_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The current AppInfo projection preserves regional ratings, relationship identifiers, included apps, age-rating declarations, categories, localizations, and unknown future included resources; partial only because the tool has no outputSchema." @@ -177,16 +316,33 @@ } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_endUserLicenseAgreement_getToOneRelated", "location": "path", "appleName": "id" } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_endUserLicenseAgreement_getToOneRelated", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "apps_endUserLicenseAgreement_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_endUserLicenseAgreement_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "eula", "operationId": "apps_endUserLicenseAgreement_getToOneRelated", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "eula", + "operationId": "apps_endUserLicenseAgreement_getToOneRelated", + "jsonPointer": "/data" + } ] }, "note": "Direct related-resource read that projects agreement text plus app and territory relationship identifiers; partial only because the tool has no outputSchema." @@ -206,28 +362,98 @@ } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_appInfos_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "apps_appInfos_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "apps_appInfos_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "localizations_limit", "sourceKind": "parameter", "operationId": "apps_appInfos_getToManyRelated", "location": "query", "appleName": "limit[appInfoLocalizations]" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_appInfos_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "apps_appInfos_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_appInfos_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "localizations_limit", + "sourceKind": "parameter", + "operationId": "apps_appInfos_getToManyRelated", + "location": "query", + "appleName": "limit[appInfoLocalizations]" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "apps_appInfos_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_appInfos_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "app_infos", "operationId": "apps_appInfos_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "count", "localRole": "projectedResourceCount" }, - { "outputField": "next_url", "operationId": "apps_appInfos_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "apps_appInfos_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "included_apps", "operationId": "apps_appInfos_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "included_age_rating_declarations", "operationId": "apps_appInfos_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "included_categories", "operationId": "apps_appInfos_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "included_localizations", "operationId": "apps_appInfos_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "included_unknown", "operationId": "apps_appInfos_getToManyRelated", "jsonPointer": "/included" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "app_infos", + "operationId": "apps_appInfos_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "count", + "localRole": "projectedResourceCount" + }, + { + "outputField": "next_url", + "operationId": "apps_appInfos_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "apps_appInfos_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "included_apps", + "operationId": "apps_appInfos_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "included_age_rating_declarations", + "operationId": "apps_appInfos_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "included_categories", + "operationId": "apps_appInfos_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "included_localizations", + "operationId": "apps_appInfos_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "included_unknown", + "operationId": "apps_appInfos_getToManyRelated", + "jsonPointer": "/included" + } ] }, "note": "Current related collection with bounded pagination, include and nested localization controls, regional rating attributes, paging totals, relationship identifiers, and included-resource projections; partial only because the tool has no outputSchema." @@ -247,24 +473,78 @@ } ], "fields": [ - { "toolField": "info_id", "sourceKind": "parameter", "operationId": "appInfos_appInfoLocalizations_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "locale", "sourceKind": "parameter", "operationId": "appInfos_appInfoLocalizations_getToManyRelated", "location": "query", "appleName": "filter[locale]" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "appInfos_appInfoLocalizations_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appInfos_appInfoLocalizations_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "info_id", + "sourceKind": "parameter", + "operationId": "appInfos_appInfoLocalizations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "locale", + "sourceKind": "parameter", + "operationId": "appInfos_appInfoLocalizations_getToManyRelated", + "location": "query", + "appleName": "filter[locale]" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "appInfos_appInfoLocalizations_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appInfos_appInfoLocalizations_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appInfos_appInfoLocalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appInfos_appInfoLocalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "localizations", "operationId": "appInfos_appInfoLocalizations_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "count", "localRole": "projectedResourceCount" }, - { "outputField": "next_url", "operationId": "appInfos_appInfoLocalizations_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "appInfos_appInfoLocalizations_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "included_app_infos", "operationId": "appInfos_appInfoLocalizations_getToManyRelated", "jsonPointer": "/included" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "localizations", + "operationId": "appInfos_appInfoLocalizations_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "count", + "localRole": "projectedResourceCount" + }, + { + "outputField": "next_url", + "operationId": "appInfos_appInfoLocalizations_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "appInfos_appInfoLocalizations_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "included_app_infos", + "operationId": "appInfos_appInfoLocalizations_getToManyRelated", + "jsonPointer": "/included" + } ] }, "note": "Current related collection with locale filtering, include, bounded pagination, paging totals, parent relationship IDs, and included AppInfo projection; partial only because the tool has no outputSchema." @@ -329,22 +609,69 @@ } ], "fields": [ - { "toolField": "info_id", "sourceKind": "parameter", "operationId": "appInfos_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "primary_category_id", "sourceKind": "requestBody", "operationId": "appInfos_updateInstance", "jsonPointer": "/data/relationships/primaryCategory/data/id" }, - { "toolField": "secondary_category_id", "sourceKind": "requestBody", "operationId": "appInfos_updateInstance", "jsonPointer": "/data/relationships/secondaryCategory/data/id" }, - { "toolField": "primary_subcategory_one_id", "sourceKind": "requestBody", "operationId": "appInfos_updateInstance", "jsonPointer": "/data/relationships/primarySubcategoryOne/data/id" }, - { "toolField": "primary_subcategory_two_id", "sourceKind": "requestBody", "operationId": "appInfos_updateInstance", "jsonPointer": "/data/relationships/primarySubcategoryTwo/data/id" }, - { "toolField": "secondary_subcategory_one_id", "sourceKind": "requestBody", "operationId": "appInfos_updateInstance", "jsonPointer": "/data/relationships/secondarySubcategoryOne/data/id" }, - { "toolField": "secondary_subcategory_two_id", "sourceKind": "requestBody", "operationId": "appInfos_updateInstance", "jsonPointer": "/data/relationships/secondarySubcategoryTwo/data/id" } + { + "toolField": "info_id", + "sourceKind": "parameter", + "operationId": "appInfos_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "primary_category_id", + "sourceKind": "requestBody", + "operationId": "appInfos_updateInstance", + "jsonPointer": "/data/relationships/primaryCategory/data/id" + }, + { + "toolField": "secondary_category_id", + "sourceKind": "requestBody", + "operationId": "appInfos_updateInstance", + "jsonPointer": "/data/relationships/secondaryCategory/data/id" + }, + { + "toolField": "primary_subcategory_one_id", + "sourceKind": "requestBody", + "operationId": "appInfos_updateInstance", + "jsonPointer": "/data/relationships/primarySubcategoryOne/data/id" + }, + { + "toolField": "primary_subcategory_two_id", + "sourceKind": "requestBody", + "operationId": "appInfos_updateInstance", + "jsonPointer": "/data/relationships/primarySubcategoryTwo/data/id" + }, + { + "toolField": "secondary_subcategory_one_id", + "sourceKind": "requestBody", + "operationId": "appInfos_updateInstance", + "jsonPointer": "/data/relationships/secondarySubcategoryOne/data/id" + }, + { + "toolField": "secondary_subcategory_two_id", + "sourceKind": "requestBody", + "operationId": "appInfos_updateInstance", + "jsonPointer": "/data/relationships/secondarySubcategoryTwo/data/id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appInfos_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appInfos_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulUpdate" }, - { "outputField": "app_info", "operationId": "appInfos_updateInstance", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "successfulUpdate" + }, + { + "outputField": "app_info", + "operationId": "appInfos_updateInstance", + "jsonPointer": "/data" + } ] }, "note": "All six category relationships in Apple's current update request are exposed and validated, and no-op updates are rejected before network access; partial only because the tool has no outputSchema." @@ -384,19 +711,49 @@ } ], "fields": [ - { "toolField": "eula_id", "sourceKind": "parameter", "operationId": "endUserLicenseAgreements_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "agreement_text", "sourceKind": "requestBody", "operationId": "endUserLicenseAgreements_updateInstance", "jsonPointer": "/data/attributes/agreementText" }, - { "toolField": "territory_ids", "sourceKind": "requestBody", "operationId": "endUserLicenseAgreements_updateInstance", "jsonPointer": "/data/relationships/territories/data/*/id" } + { + "toolField": "eula_id", + "sourceKind": "parameter", + "operationId": "endUserLicenseAgreements_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "agreement_text", + "sourceKind": "requestBody", + "operationId": "endUserLicenseAgreements_updateInstance", + "jsonPointer": "/data/attributes/agreementText" + }, + { + "toolField": "territory_ids", + "sourceKind": "requestBody", + "operationId": "endUserLicenseAgreements_updateInstance", + "jsonPointer": "/data/relationships/territories/data/*/id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "endUserLicenseAgreements_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "endUserLicenseAgreements_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulUpdate" }, - { "outputField": "eula", "operationId": "endUserLicenseAgreements_updateInstance", "jsonPointer": "/data" }, - { "outputField": "message", "localRole": "updateConfirmation" } + { + "outputField": "success", + "localRole": "successfulUpdate" + }, + { + "outputField": "eula", + "operationId": "endUserLicenseAgreements_updateInstance", + "jsonPointer": "/data" + }, + { + "outputField": "message", + "localRole": "updateConfirmation" + } ] }, "note": "The PATCH preserves explicit null agreementText and replaces or clears Apple's territories relationship with strict ID validation; no-op updates fail before network access. Partial only because the tool has no outputSchema." @@ -431,21 +788,63 @@ } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appInfoLocalizations_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_updateInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "subtitle", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_updateInstance", "jsonPointer": "/data/attributes/subtitle" }, - { "toolField": "privacy_policy_url", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_updateInstance", "jsonPointer": "/data/attributes/privacyPolicyUrl" }, - { "toolField": "privacy_choices_url", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_updateInstance", "jsonPointer": "/data/attributes/privacyChoicesUrl" }, - { "toolField": "privacy_policy_text", "sourceKind": "requestBody", "operationId": "appInfoLocalizations_updateInstance", "jsonPointer": "/data/attributes/privacyPolicyText" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appInfoLocalizations_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_updateInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "subtitle", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_updateInstance", + "jsonPointer": "/data/attributes/subtitle" + }, + { + "toolField": "privacy_policy_url", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_updateInstance", + "jsonPointer": "/data/attributes/privacyPolicyUrl" + }, + { + "toolField": "privacy_choices_url", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_updateInstance", + "jsonPointer": "/data/attributes/privacyChoicesUrl" + }, + { + "toolField": "privacy_policy_text", + "sourceKind": "requestBody", + "operationId": "appInfoLocalizations_updateInstance", + "jsonPointer": "/data/attributes/privacyPolicyText" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appInfoLocalizations_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appInfoLocalizations_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulUpdate" }, - { "outputField": "localization", "operationId": "appInfoLocalizations_updateInstance", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "successfulUpdate" + }, + { + "outputField": "localization", + "operationId": "appInfoLocalizations_updateInstance", + "jsonPointer": "/data" + } ] }, "note": "Direct Apple localization PATCH with explicit-null preservation, no-op rejection, local metadata validation, and response projection; partial until a structured output schema is declared." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/apps.json b/Sources/asc-mcp/Resources/OperationManifest/tools/apps.json index a3ffbb5..efd4da3 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/apps.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/apps.json @@ -14,32 +14,97 @@ "path": "/v1/appStoreVersionLocalizations", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appStoreVersionLocalizations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appStoreVersion/data/type", "fixedValue": "appStoreVersions" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appStoreVersionLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appStoreVersion/data/type", + "fixedValue": "appStoreVersions" + } ], "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/relationships/placements", "disposition": "intentionallyOmitted", "reason": "Localization creation and Asset Library placement are separate operations. This legacy create tool does not attach existing placement IDs; prepare and apply placement creation through AssetsWorker after creating the localization so ownership, specification, draft state, and preview checks remain mandatory.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/relationships/placements", + "disposition": "intentionallyOmitted", + "reason": "Localization creation and Asset Library placement are separate operations. This legacy create tool does not attach existing placement IDs; prepare and apply placement creation through AssetsWorker after creating the localization so ownership, specification, draft state, and preview checks remain mandatory.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "version_id", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_createInstance", "jsonPointer": "/data/relationships/appStoreVersion/data/id" }, - { "toolField": "locale", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_createInstance", "jsonPointer": "/data/attributes/locale" }, - { "toolField": "description", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_createInstance", "jsonPointer": "/data/attributes/description" }, - { "toolField": "whats_new", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_createInstance", "jsonPointer": "/data/attributes/whatsNew" }, - { "toolField": "keywords", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_createInstance", "jsonPointer": "/data/attributes/keywords" }, - { "toolField": "promotional_text", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_createInstance", "jsonPointer": "/data/attributes/promotionalText" }, - { "toolField": "support_url", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_createInstance", "jsonPointer": "/data/attributes/supportUrl" }, - { "toolField": "marketing_url", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_createInstance", "jsonPointer": "/data/attributes/marketingUrl" } + { + "toolField": "version_id", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_createInstance", + "jsonPointer": "/data/relationships/appStoreVersion/data/id" + }, + { + "toolField": "locale", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_createInstance", + "jsonPointer": "/data/attributes/locale" + }, + { + "toolField": "description", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_createInstance", + "jsonPointer": "/data/attributes/description" + }, + { + "toolField": "whats_new", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_createInstance", + "jsonPointer": "/data/attributes/whatsNew" + }, + { + "toolField": "keywords", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_createInstance", + "jsonPointer": "/data/attributes/keywords" + }, + { + "toolField": "promotional_text", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_createInstance", + "jsonPointer": "/data/attributes/promotionalText" + }, + { + "toolField": "support_url", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_createInstance", + "jsonPointer": "/data/attributes/supportUrl" + }, + { + "toolField": "marketing_url", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_createInstance", + "jsonPointer": "/data/attributes/marketingUrl" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionLocalizations_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "appStoreVersionLocalizations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulCreate" }, - { "outputField": "localization", "operationId": "appStoreVersionLocalizations_createInstance", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "successfulCreate" + }, + { + "outputField": "localization", + "operationId": "appStoreVersionLocalizations_createInstance", + "jsonPointer": "/data" + } ] }, "note": "Direct Apple create operation with local metadata validation and a projected response; partial until this tool has a declared MCP output schema." @@ -59,16 +124,31 @@ } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_deleteInstance", "location": "path", "appleName": "id" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_deleteInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "appStoreVersionLocalizations_deleteInstance", "statusCode": "204" } + { + "operationId": "appStoreVersionLocalizations_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "successful204" }, - { "outputField": "message", "localRole": "deleteConfirmation" } + { + "outputField": "success", + "localRole": "successful204" + }, + { + "outputField": "message", + "localRole": "deleteConfirmation" + } ] }, "note": "Apple returns 204 without a response document; the handler creates the confirmation locally." @@ -86,40 +166,182 @@ "path": "/v1/apps/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[androidToIosAppMappingDetails]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appClips]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appCustomProductPages]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appEncryptionDeclarations]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appEvents]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appInfos]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersions]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaAppLocalizations]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[gameCenterEnabledVersions]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[inAppPurchases]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[inAppPurchasesV2]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[preReleaseVersions]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[promotedPurchases]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[reviewSubmissions]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[subscriptionGroups]", "disposition": "intentionallyOmitted", "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "limit[androidToIosAppMappingDetails]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appClips]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appCustomProductPages]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEncryptionDeclarations]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEvents]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appInfos]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersions]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaAppLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaGroups]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[builds]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[gameCenterEnabledVersions]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[inAppPurchases]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[inAppPurchasesV2]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[preReleaseVersions]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[promotedPurchases]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[reviewSubmissions]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptionGroups]", + "disposition": "intentionallyOmitted", + "reason": "The detail projection does not promise complete embedded to-many collections; use resource-specific tools for independently paginated data.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionMessages]", + "disposition": "intentionallyOmitted", + "reason": "Retention messages are read through the dedicated app-scoped subscriptions_list_retention_messages tool.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "apps_getInstance", "location": "query", "appleName": "include" } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "apps_getInstance", + "location": "query", + "appleName": "include" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "apps_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "app", "operationId": "apps_getInstance", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "apps_getInstance", "jsonPointer": "/included" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "app", + "operationId": "apps_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "apps_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The handler projects app attributes while preserving every returned relationship key, included resources, and JSON:API to-one versus to-many linkage." @@ -138,22 +360,48 @@ "role": "supporting", "condition": "version_id is supplied", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "App Store version experiments are not included by this metadata lookup.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "App Store version experiments are not included by this metadata lookup.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are fetched through their dedicated paginated related-resource operation.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "App Store version experiments are not included by this metadata lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "App Store version experiments are not included by this metadata lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are fetched through their dedicated paginated related-resource operation.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersions]", - "fixedValue": ["app", "platform", "versionString", "appVersionState", "appStoreState"] + "fixedValue": [ + "app", + "platform", + "versionString", + "appVersionState", + "appStoreState" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["app"] + "fixedValue": [ + "app" + ] } ] }, @@ -164,22 +412,82 @@ "role": "supporting", "condition": "version_id is omitted", "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[appStoreState]", "disposition": "intentionallyOmitted", "reason": "The tool traverses all version pages and applies legacy state fallback locally so selection semantics remain deterministic.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appVersionState]", "disposition": "intentionallyOmitted", "reason": "The tool traverses all version pages and selects current version state locally so state fallback remains deterministic.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "Explicit version selection uses version_id and the instance operation instead of filtering the auto-selection collection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[platform]", "disposition": "intentionallyOmitted", "reason": "Platform selection is applied locally after complete traversal to preserve the documented preference order.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[versionString]", "disposition": "intentionallyOmitted", "reason": "The metadata workflow selects by state and platform, not by version string.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Auto-selection consumes only the fixed sparse App Store version projection and does not expand relationships.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "App Store version experiments are not included during auto-selection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "App Store version experiments are not included during auto-selection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are fetched through their dedicated paginated related-resource operation.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "filter[appStoreState]", + "disposition": "intentionallyOmitted", + "reason": "The tool traverses all version pages and applies legacy state fallback locally so selection semantics remain deterministic.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appVersionState]", + "disposition": "intentionallyOmitted", + "reason": "The tool traverses all version pages and selects current version state locally so state fallback remains deterministic.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "Explicit version selection uses version_id and the instance operation instead of filtering the auto-selection collection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[platform]", + "disposition": "intentionallyOmitted", + "reason": "Platform selection is applied locally after complete traversal to preserve the documented preference order.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[versionString]", + "disposition": "intentionallyOmitted", + "reason": "The metadata workflow selects by state and platform, not by version string.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Auto-selection consumes only the fixed sparse App Store version projection and does not expand relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "App Store version experiments are not included during auto-selection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "App Store version experiments are not included during auto-selection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are fetched through their dedicated paginated related-resource operation.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersions]", - "fixedValue": ["platform", "versionString", "appVersionState", "appStoreState", "createdDate"] + "fixedValue": [ + "platform", + "versionString", + "appVersionState", + "appStoreState", + "createdDate" + ] }, { "sourceKind": "fixed", @@ -195,10 +503,34 @@ "path": "/v1/appStoreVersions/{id}/appStoreVersionLocalizations", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Preview sets are loaded through their dedicated paginated related-resource operation.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Screenshot sets are loaded through their dedicated paginated related-resource operation.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Search keyword relationships are outside the metadata aggregate response.", "reviewAtSpec": "4.5.1" }, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Preview sets are loaded through their dedicated paginated related-resource operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Screenshot sets are loaded through their dedicated paginated related-resource operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Search keyword relationships are outside the metadata aggregate response.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -215,13 +547,24 @@ "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersionLocalizations]", - "fixedValue": ["description", "locale", "keywords", "marketingUrl", "promotionalText", "supportUrl", "whatsNew", "appStoreVersion"] + "fixedValue": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["appStoreVersion"] + "fixedValue": [ + "appStoreVersion" + ] }, { "sourceKind": "fixed", @@ -238,23 +581,45 @@ "role": "conditional", "condition": "include_media is true and locale is supplied", "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[previewType]", "disposition": "intentionallyOmitted", "reason": "The media aggregate returns every preview set for the selected localization so callers can choose display types from one response.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "This workflow addresses an App Store version localization, not a custom product page localization.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "This workflow addresses an App Store version localization, not an experiment treatment localization.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "filter[previewType]", + "disposition": "intentionallyOmitted", + "reason": "The media aggregate returns every preview set for the selected localization so callers can choose display types from one response.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "This workflow addresses an App Store version localization, not a custom product page localization.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "This workflow addresses an App Store version localization, not an experiment treatment localization.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appStoreVersions_appStoreVersionLocalizations_getToManyRelated:/data/*/id"], + "derivedFrom": [ + "appStoreVersions_appStoreVersionLocalizations_getToManyRelated:/data/*/id" + ], "localRole": "useFirstLocaleFilteredLocalizationIdentifier" }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["appPreviews"] + "fixedValue": [ + "appPreviews" + ] }, { "sourceKind": "fixed", @@ -277,23 +642,45 @@ "role": "conditional", "condition": "include_media is true and locale is supplied", "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[screenshotDisplayType]", "disposition": "intentionallyOmitted", "reason": "The media aggregate returns every screenshot set for the selected localization so callers can choose display types from one response.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "This workflow addresses an App Store version localization, not a custom product page localization.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "This workflow addresses an App Store version localization, not an experiment treatment localization.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "filter[screenshotDisplayType]", + "disposition": "intentionallyOmitted", + "reason": "The media aggregate returns every screenshot set for the selected localization so callers can choose display types from one response.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "This workflow addresses an App Store version localization, not a custom product page localization.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "This workflow addresses an App Store version localization, not an experiment treatment localization.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appStoreVersions_appStoreVersionLocalizations_getToManyRelated:/data/*/id"], + "derivedFrom": [ + "appStoreVersions_appStoreVersionLocalizations_getToManyRelated:/data/*/id" + ], "localRole": "useFirstLocaleFilteredLocalizationIdentifier" }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["appScreenshots"] + "fixedValue": [ + "appScreenshots" + ] }, { "sourceKind": "fixed", @@ -311,30 +698,106 @@ } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_appStoreVersions_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "locale", "sourceKind": "parameter", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "location": "query", "appleName": "filter[locale]" }, - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "appStoreVersions_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "version_state", "sourceKind": "local", "localRole": "selectVersionByAppVersionStateWithDeprecatedAppStoreStateFallback" }, - { "toolField": "platform", "sourceKind": "local", "localRole": "selectOrValidateVersionPlatform" }, - { "toolField": "include_media", "sourceKind": "local", "localRole": "enableConditionalMediaReadsOnlyWhenLocaleIsExplicit" } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "locale", + "sourceKind": "parameter", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "location": "query", + "appleName": "filter[locale]" + }, + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "appStoreVersions_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "version_state", + "sourceKind": "local", + "localRole": "selectVersionByAppVersionStateWithDeprecatedAppStoreStateFallback" + }, + { + "toolField": "platform", + "sourceKind": "local", + "localRole": "selectOrValidateVersionPlatform" + }, + { + "toolField": "include_media", + "sourceKind": "local", + "localRole": "enableConditionalMediaReadsOnlyWhenLocaleIsExplicit" + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "apps_appStoreVersions_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appStoreVersions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulAggregate" }, - { "outputField": "version", "localRole": "resolvedVersionProjection" }, - { "outputField": "localization", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "jsonPointer": "/data/*", "localRole": "singleExactLocaleProjection" }, - { "outputField": "localizations", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "totalLocalizations", "localRole": "completedLocalizationCount" }, - { "outputField": "appPreviewSets", "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "screenshotSets", "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "successfulAggregate" + }, + { + "outputField": "version", + "localRole": "resolvedVersionProjection" + }, + { + "outputField": "localization", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "jsonPointer": "/data/*", + "localRole": "singleExactLocaleProjection" + }, + { + "outputField": "localizations", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "totalLocalizations", + "localRole": "completedLocalizationCount" + }, + { + "outputField": "appPreviewSets", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "screenshotSets", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "jsonPointer": "/data" + } ] }, "note": "Partial because the tool aggregates several Apple operations; version resolution and localization retrieval follow every Apple page, state selection prefers appVersionState with deprecated appStoreState fallback, ownership is validated, an exact-locale lookup must resolve to exactly one matching resource, and include_media requires an explicit locale." @@ -352,153 +815,511 @@ "path": "/v1/apps", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The collection tool returns an App projection without included resources; use apps_get_details or resource-specific tools for relationships.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[androidToIosAppMappingDetails]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appClips]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appCustomProductPages]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appEncryptionDeclarations]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appEvents]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appInfos]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaAppLocalizations]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[gameCenterEnabledVersions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[inAppPurchases]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[inAppPurchasesV2]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[preReleaseVersions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[promotedPurchases]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[reviewSubmissions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[subscriptionGroups]", "disposition": "intentionallyOmitted", "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", "reviewAtSpec": "4.5.1" } - ] - } - ], - "fields": [ - { "toolField": "limit", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "sort" }, - { "toolField": "bundle_id", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "filter[bundleId]" }, - { "toolField": "name", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "filter[name]" }, - { "toolField": "app_ids", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "filter[id]" }, - { "toolField": "skus", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "filter[sku]" }, - { "toolField": "app_store_version_ids", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "filter[appStoreVersions]" }, - { "toolField": "app_store_states", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "filter[appStoreVersions.appStoreState]" }, - { "toolField": "platforms", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "filter[appStoreVersions.platform]" }, - { "toolField": "app_version_states", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "filter[appStoreVersions.appVersionState]" }, - { "toolField": "review_submission_states", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "filter[reviewSubmissions.state]" }, - { "toolField": "review_submission_platforms", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "filter[reviewSubmissions.platform]" }, - { "toolField": "has_game_center_enabled_versions", "sourceKind": "parameter", "operationId": "apps_getCollection", "location": "query", "appleName": "exists[gameCenterEnabledVersions]" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } - ], - "response": { - "mode": "projection", - "sources": [ - { "operationId": "apps_getCollection", "statusCode": "200", "mediaType": "application/json" } - ], - "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "apps", "operationId": "apps_getCollection", "jsonPointer": "/data" }, - { "outputField": "count", "localRole": "currentPageResourceCount" }, - { "outputField": "totalCount", "operationId": "apps_getCollection", "jsonPointer": "/meta/paging/total", "localRole": "applePagingTotalOrTerminalPageCountOtherwiseNull" }, - { "outputField": "hasNextPage", "localRole": "nextLinkPresence" }, - { "outputField": "links", "operationId": "apps_getCollection", "jsonPointer": "/links" }, - { "outputField": "next_url", "operationId": "apps_getCollection", "jsonPointer": "/links/next" } - ] - }, - "note": "Partial because the public projection intentionally exposes only a subset of current App attributes and collection query controls. count is the current page size; totalCount uses Apple paging.total, falls back to count only on a terminal page, and is null when Apple omits total while another page exists." - }, - { - "tool": "apps_list_localizations", - "kind": "compound", - "status": "partial", - "effect": "read", - "implementationState": "asBuilt", - "operations": [ - { - "operationId": "appStoreVersions_getInstance", - "method": "get", - "path": "/v1/appStoreVersions/{id}", - "role": "supporting", - "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "App Store version experiments are not included in the ownership check.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "App Store version experiments are not included in the ownership check.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are fetched by the dedicated primary operation.", "reviewAtSpec": "4.5.1" } - ], - "inputs": [ { - "sourceKind": "fixed", "location": "query", - "appleName": "fields[appStoreVersions]", - "fixedValue": ["app"] + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The collection tool returns an App projection without included resources; use apps_get_details or resource-specific tools for relationships.", + "reviewAtSpec": "4.6" }, { - "sourceKind": "fixed", "location": "query", - "appleName": "include", - "fixedValue": ["app"] - } - ] - }, - { - "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", - "method": "get", - "path": "/v1/appStoreVersions/{id}/appStoreVersionLocalizations", - "role": "primary", - "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Preview sets are not included by the localization list.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Screenshot sets are not included by the localization list.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Search keywords are not included by the localization list.", "reviewAtSpec": "4.5.1" }, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", "reviewAtSpec": "4.5.1"} - ], - "inputs": [ + "appleName": "limit[androidToIosAppMappingDetails]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, { - "sourceKind": "fixed", "location": "query", - "appleName": "fields[appStoreVersionLocalizations]", - "fixedValue": ["locale", "description", "whatsNew", "keywords", "promotionalText", "supportUrl", "marketingUrl", "appStoreVersion"] + "appleName": "limit[appClips]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" }, { - "sourceKind": "fixed", "location": "query", - "appleName": "include", - "fixedValue": ["appStoreVersion"] - } - ] - } - ], - "fields": [ - { "toolField": "app_id", "sourceKind": "local", "localRole": "validateVersionOwnershipFromAppRelationship", "derivedFrom": ["appStoreVersions_getInstance:/data/relationships/app/data/id"] }, - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "appStoreVersions_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "locales", "sourceKind": "parameter", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "location": "query", "appleName": "filter[locale]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } - ], - "response": { - "mode": "projection", - "sources": [ - { "operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } - ], - "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "appId", "localRole": "validatedAppIdentifier" }, - { "outputField": "versionId", "localRole": "validatedVersionIdentifier" }, - { "outputField": "count", "localRole": "currentPageResourceCount" }, - { "outputField": "totalLocalizations", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "jsonPointer": "/meta/paging/total", "localRole": "applePagingTotalOrTerminalPageCountOtherwiseNull" }, - { "outputField": "localizations", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "jsonPointer": "/links/next" } - ] - }, - "note": "The handler validates app-to-version ownership, then returns only localizations whose appStoreVersion linkage matches version_id. count is the current page size; totalLocalizations uses Apple paging.total, falls back to count only on a terminal page, and is null when Apple omits total while another page exists." - }, - { - "tool": "apps_list_search_keywords", - "kind": "direct", - "status": "partial", - "effect": "read", - "implementationState": "asBuilt", - "operations": [ + "appleName": "limit[appCustomProductPages]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEncryptionDeclarations]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEvents]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appInfos]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaAppLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaGroups]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[builds]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[gameCenterEnabledVersions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[inAppPurchases]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[inAppPurchasesV2]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[preReleaseVersions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[promotedPurchases]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[reviewSubmissions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptionGroups]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included by the App collection projection, so this related-resource limit is inapplicable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionMessages]", + "disposition": "intentionallyOmitted", + "reason": "Retention messages are read through the dedicated app-scoped subscriptions_list_retention_messages tool.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "bundle_id", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "filter[bundleId]" + }, + { + "toolField": "name", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "filter[name]" + }, + { + "toolField": "app_ids", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "skus", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "filter[sku]" + }, + { + "toolField": "app_store_version_ids", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "filter[appStoreVersions]" + }, + { + "toolField": "app_store_states", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "filter[appStoreVersions.appStoreState]" + }, + { + "toolField": "platforms", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "filter[appStoreVersions.platform]" + }, + { + "toolField": "app_version_states", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "filter[appStoreVersions.appVersionState]" + }, + { + "toolField": "review_submission_states", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "filter[reviewSubmissions.state]" + }, + { + "toolField": "review_submission_platforms", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "filter[reviewSubmissions.platform]" + }, + { + "toolField": "has_game_center_enabled_versions", + "sourceKind": "parameter", + "operationId": "apps_getCollection", + "location": "query", + "appleName": "exists[gameCenterEnabledVersions]" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "apps_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "apps", + "operationId": "apps_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "count", + "localRole": "currentPageResourceCount" + }, + { + "outputField": "totalCount", + "operationId": "apps_getCollection", + "jsonPointer": "/meta/paging/total", + "localRole": "applePagingTotalOrTerminalPageCountOtherwiseNull" + }, + { + "outputField": "hasNextPage", + "localRole": "nextLinkPresence" + }, + { + "outputField": "links", + "operationId": "apps_getCollection", + "jsonPointer": "/links" + }, + { + "outputField": "next_url", + "operationId": "apps_getCollection", + "jsonPointer": "/links/next" + } + ] + }, + "note": "Partial because the public projection intentionally exposes only a subset of current App attributes and collection query controls. count is the current page size; totalCount uses Apple paging.total, falls back to count only on a terminal page, and is null when Apple omits total while another page exists." + }, + { + "tool": "apps_list_localizations", + "kind": "compound", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "appStoreVersions_getInstance", + "method": "get", + "path": "/v1/appStoreVersions/{id}", + "role": "supporting", + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "App Store version experiments are not included in the ownership check.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "App Store version experiments are not included in the ownership check.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are fetched by the dedicated primary operation.", + "reviewAtSpec": "4.6" + } + ], + "inputs": [ + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appStoreVersions]", + "fixedValue": [ + "app" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "include", + "fixedValue": [ + "app" + ] + } + ] + }, + { + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "method": "get", + "path": "/v1/appStoreVersions/{id}/appStoreVersionLocalizations", + "role": "primary", + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Preview sets are not included by the localization list.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Screenshot sets are not included by the localization list.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Search keywords are not included by the localization list.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", + "reviewAtSpec": "4.6" + } + ], + "inputs": [ + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appStoreVersionLocalizations]", + "fixedValue": [ + "locale", + "description", + "whatsNew", + "keywords", + "promotionalText", + "supportUrl", + "marketingUrl", + "appStoreVersion" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "include", + "fixedValue": [ + "appStoreVersion" + ] + } + ] + } + ], + "fields": [ + { + "toolField": "app_id", + "sourceKind": "local", + "localRole": "validateVersionOwnershipFromAppRelationship", + "derivedFrom": [ + "appStoreVersions_getInstance:/data/relationships/app/data/id" + ] + }, + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "appStoreVersions_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "locales", + "sourceKind": "parameter", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "location": "query", + "appleName": "filter[locale]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "appId", + "localRole": "validatedAppIdentifier" + }, + { + "outputField": "versionId", + "localRole": "validatedVersionIdentifier" + }, + { + "outputField": "count", + "localRole": "currentPageResourceCount" + }, + { + "outputField": "totalLocalizations", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "jsonPointer": "/meta/paging/total", + "localRole": "applePagingTotalOrTerminalPageCountOtherwiseNull" + }, + { + "outputField": "localizations", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "jsonPointer": "/links/next" + } + ] + }, + "note": "The handler validates app-to-version ownership, then returns only localizations whose appStoreVersion linkage matches version_id. count is the current page size; totalLocalizations uses Apple paging.total, falls back to count only on a terminal page, and is null when Apple omits total while another page exists." + }, + { + "tool": "apps_list_search_keywords", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ { "operationId": "apps_searchKeywords_getToManyRelated", "method": "get", @@ -507,28 +1328,94 @@ } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_searchKeywords_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "platforms", "sourceKind": "parameter", "operationId": "apps_searchKeywords_getToManyRelated", "location": "query", "appleName": "filter[platform]" }, - { "toolField": "locales", "sourceKind": "parameter", "operationId": "apps_searchKeywords_getToManyRelated", "location": "query", "appleName": "filter[locale]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "apps_searchKeywords_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact app keyword collection; app_id, filters, and effective limit must be repeated and the cursor is validated before network access." } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_searchKeywords_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "platforms", + "sourceKind": "parameter", + "operationId": "apps_searchKeywords_getToManyRelated", + "location": "query", + "appleName": "filter[platform]" + }, + { + "toolField": "locales", + "sourceKind": "parameter", + "operationId": "apps_searchKeywords_getToManyRelated", + "location": "query", + "appleName": "filter[locale]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_searchKeywords_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact app keyword collection; app_id, filters, and effective limit must be repeated and the cursor is validated before network access." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "apps_searchKeywords_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_searchKeywords_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "app_id", "localRole": "requestEcho" }, - { "outputField": "search_keywords", "operationId": "apps_searchKeywords_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "count", "localRole": "pageResourceCount" }, - { "outputField": "limit", "localRole": "effectiveLimitEcho" }, - { "outputField": "platforms", "localRole": "requestFilterEcho" }, - { "outputField": "locales", "localRole": "requestFilterEcho" }, - { "outputField": "links", "operationId": "apps_searchKeywords_getToManyRelated", "jsonPointer": "/links" }, - { "outputField": "paging", "operationId": "apps_searchKeywords_getToManyRelated", "jsonPointer": "/meta/paging" }, - { "outputField": "next_url", "operationId": "apps_searchKeywords_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "app_id", + "localRole": "requestEcho" + }, + { + "outputField": "search_keywords", + "operationId": "apps_searchKeywords_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "count", + "localRole": "pageResourceCount" + }, + { + "outputField": "limit", + "localRole": "effectiveLimitEcho" + }, + { + "outputField": "platforms", + "localRole": "requestFilterEcho" + }, + { + "outputField": "locales", + "localRole": "requestFilterEcho" + }, + { + "outputField": "links", + "operationId": "apps_searchKeywords_getToManyRelated", + "jsonPointer": "/links" + }, + { + "outputField": "paging", + "operationId": "apps_searchKeywords_getToManyRelated", + "jsonPointer": "/meta/paging" + }, + { + "outputField": "next_url", + "operationId": "apps_searchKeywords_getToManyRelated", + "jsonPointer": "/links/next" + } ] }, "note": "Lists canonical AppKeyword identifiers needed by Custom Product Page localization keyword relationships while preserving platform, locale, and pagination scope." @@ -541,166 +1428,706 @@ "implementationState": "asBuilt", "operations": [ { - "operationId": "apps_appStoreVersions_getToManyRelated", + "operationId": "apps_appStoreVersions_getToManyRelated", + "method": "get", + "path": "/v1/apps/{id}/appStoreVersions", + "role": "primary", + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The lightweight version list returns a fixed base projection and does not expand relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "App Store version experiments are not included by the lightweight list.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "App Store version experiments are not included by the lightweight list.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are not included by the lightweight list.", + "reviewAtSpec": "4.6" + } + ], + "inputs": [ + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appStoreVersions]", + "fixedValue": [ + "platform", + "versionString", + "appVersionState", + "appStoreState", + "createdDate" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } + ] + } + ], + "fields": [ + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "version_ids", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersions_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "version_strings", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersions_getToManyRelated", + "location": "query", + "appleName": "filter[versionString]" + }, + { + "toolField": "app_store_states", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersions_getToManyRelated", + "location": "query", + "appleName": "filter[appStoreState]" + }, + { + "toolField": "app_version_states", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersions_getToManyRelated", + "location": "query", + "appleName": "filter[appVersionState]" + }, + { + "toolField": "platforms", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersions_getToManyRelated", + "location": "query", + "appleName": "filter[platform]" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "apps_appStoreVersions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "versions", + "operationId": "apps_appStoreVersions_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "apps_appStoreVersions_getToManyRelated", + "jsonPointer": "/links/next" + } + ] + }, + "note": "Partial because the handler requests a fixed 200-item projection containing platform, current appVersionState, deprecated appStoreState, versionString, and createdDate; public ID, version-string, platform, and state filters are preserved across next_url pagination." + }, + { + "tool": "apps_search", + "kind": "compound", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "invocationId": "name-search", + "operationId": "apps_getCollection", + "method": "get", + "path": "/v1/apps", + "role": "primary", + "condition": "Exact-name branch; follows every page with fixed projection, maximum page size, and deterministic sort.", + "inputs": [ + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[apps]", + "fixedValue": [ + "name", + "bundleId", + "sku", + "primaryLocale" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "sort", + "fixedValue": [ + "name", + "bundleId", + "sku" + ] + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "filter[bundleId]", + "disposition": "intentionallyOmitted", + "reason": "The bundle ID filter is applied by the separate bundle-search invocation so this branch remains an independent union branch instead of an Apple AND filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[sku]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersions.appStoreState]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersions.platform]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersions.appVersionState]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[reviewSubmissions.state]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[reviewSubmissions.platform]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersions]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "exists[gameCenterEnabledVersions]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Search returns only the base App identity projection and does not expand relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[androidToIosAppMappingDetails]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appClips]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appCustomProductPages]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEncryptionDeclarations]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEvents]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appInfos]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaAppLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaGroups]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[builds]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[gameCenterEnabledVersions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[inAppPurchases]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[inAppPurchasesV2]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[preReleaseVersions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[promotedPurchases]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[reviewSubmissions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptionGroups]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionMessages]", + "disposition": "intentionallyOmitted", + "reason": "Retention messages are read through the dedicated app-scoped subscriptions_list_retention_messages tool.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "invocationId": "bundle-search", + "operationId": "apps_getCollection", "method": "get", - "path": "/v1/apps/{id}/appStoreVersions", - "role": "primary", - "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The lightweight version list returns a fixed base projection and does not expand relationships.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "App Store version experiments are not included by the lightweight list.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "App Store version experiments are not included by the lightweight list.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are not included by the lightweight list.", "reviewAtSpec": "4.5.1" } - ], + "path": "/v1/apps", + "role": "supporting", + "condition": "Exact-bundle-ID branch; follows every page with fixed projection, maximum page size, and deterministic sort.", "inputs": [ { "sourceKind": "fixed", "location": "query", - "appleName": "fields[appStoreVersions]", - "fixedValue": ["platform", "versionString", "appVersionState", "appStoreState", "createdDate"] + "appleName": "fields[apps]", + "fixedValue": [ + "name", + "bundleId", + "sku", + "primaryLocale" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "sort", + "fixedValue": [ + "name", + "bundleId", + "sku" + ] + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "filter[name]", + "disposition": "intentionallyOmitted", + "reason": "The name filter is applied by the separate name-search invocation so this branch remains an independent union branch instead of an Apple AND filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[sku]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersions.appStoreState]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersions.platform]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersions.appVersionState]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[reviewSubmissions.state]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[reviewSubmissions.platform]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersions]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "exists[gameCenterEnabledVersions]", + "disposition": "intentionallyOmitted", + "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Search returns only the base App identity projection and does not expand relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[androidToIosAppMappingDetails]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appClips]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appCustomProductPages]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEncryptionDeclarations]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEvents]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appInfos]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaAppLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaGroups]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[builds]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[gameCenterEnabledVersions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[inAppPurchases]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[inAppPurchasesV2]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[preReleaseVersions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[promotedPurchases]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[reviewSubmissions]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptionGroups]", + "disposition": "intentionallyOmitted", + "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionMessages]", + "disposition": "intentionallyOmitted", + "reason": "Retention messages are read through the dedicated app-scoped subscriptions_list_retention_messages tool.", + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_appStoreVersions_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "version_ids", "sourceKind": "parameter", "operationId": "apps_appStoreVersions_getToManyRelated", "location": "query", "appleName": "filter[id]" }, - { "toolField": "version_strings", "sourceKind": "parameter", "operationId": "apps_appStoreVersions_getToManyRelated", "location": "query", "appleName": "filter[versionString]" }, - { "toolField": "app_store_states", "sourceKind": "parameter", "operationId": "apps_appStoreVersions_getToManyRelated", "location": "query", "appleName": "filter[appStoreState]" }, - { "toolField": "app_version_states", "sourceKind": "parameter", "operationId": "apps_appStoreVersions_getToManyRelated", "location": "query", "appleName": "filter[appVersionState]" }, - { "toolField": "platforms", "sourceKind": "parameter", "operationId": "apps_appStoreVersions_getToManyRelated", "location": "query", "appleName": "filter[platform]" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } - ], - "response": { - "mode": "projection", - "sources": [ - { "operationId": "apps_appStoreVersions_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } - ], - "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "versions", "operationId": "apps_appStoreVersions_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "apps_appStoreVersions_getToManyRelated", "jsonPointer": "/links/next" } - ] - }, - "note": "Partial because the handler requests a fixed 200-item projection containing platform, current appVersionState, deprecated appStoreState, versionString, and createdDate; public ID, version-string, platform, and state filters are preserved across next_url pagination." - }, - { - "tool": "apps_search", - "kind": "compound", - "status": "partial", - "effect": "read", - "implementationState": "asBuilt", - "operations": [ { - "invocationId": "name-search", + "toolField": "query", + "sourceKind": "parameter", "operationId": "apps_getCollection", - "method": "get", - "path": "/v1/apps", - "role": "primary", - "condition": "Exact-name branch; follows every page with fixed projection, maximum page size, and deterministic sort.", - "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[apps]", "fixedValue": ["name", "bundleId", "sku", "primaryLocale"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 }, - { "sourceKind": "fixed", "location": "query", "appleName": "sort", "fixedValue": ["name", "bundleId", "sku"] } - ], - "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[bundleId]", "disposition": "intentionallyOmitted", "reason": "The bundle ID filter is applied by the separate bundle-search invocation so this branch remains an independent union branch instead of an Apple AND filter.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[sku]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersions.appStoreState]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersions.platform]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersions.appVersionState]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[reviewSubmissions.state]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[reviewSubmissions.platform]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersions]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "exists[gameCenterEnabledVersions]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Search returns only the base App identity projection and does not expand relationships.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[androidToIosAppMappingDetails]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appClips]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appCustomProductPages]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appEncryptionDeclarations]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appEvents]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appInfos]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaAppLocalizations]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[gameCenterEnabledVersions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[inAppPurchases]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[inAppPurchasesV2]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[preReleaseVersions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[promotedPurchases]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[reviewSubmissions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[subscriptionGroups]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" } - ] + "invocationId": "name-search", + "location": "query", + "appleName": "filter[name]" }, { - "invocationId": "bundle-search", + "toolField": "query", + "sourceKind": "parameter", "operationId": "apps_getCollection", - "method": "get", - "path": "/v1/apps", - "role": "supporting", - "condition": "Exact-bundle-ID branch; follows every page with fixed projection, maximum page size, and deterministic sort.", - "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[apps]", "fixedValue": ["name", "bundleId", "sku", "primaryLocale"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 }, - { "sourceKind": "fixed", "location": "query", "appleName": "sort", "fixedValue": ["name", "bundleId", "sku"] } - ], - "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[name]", "disposition": "intentionallyOmitted", "reason": "The name filter is applied by the separate name-search invocation so this branch remains an independent union branch instead of an Apple AND filter.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[sku]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersions.appStoreState]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersions.platform]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersions.appVersionState]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[reviewSubmissions.state]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[reviewSubmissions.platform]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersions]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "exists[gameCenterEnabledVersions]", "disposition": "intentionallyOmitted", "reason": "The public search contract is limited to an exact name-or-bundle-ID union; this additional filter would change its result semantics.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Search returns only the base App identity projection and does not expand relationships.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[androidToIosAppMappingDetails]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appClips]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appCustomProductPages]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appEncryptionDeclarations]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appEvents]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appInfos]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaAppLocalizations]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[gameCenterEnabledVersions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[inAppPurchases]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[inAppPurchasesV2]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[preReleaseVersions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[promotedPurchases]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[reviewSubmissions]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[subscriptionGroups]", "disposition": "intentionallyOmitted", "reason": "No relationships are included, so this related-resource page limit is inapplicable to the search projection.", "reviewAtSpec": "4.5.1" } - ] + "invocationId": "bundle-search", + "location": "query", + "appleName": "filter[bundleId]" } ], - "fields": [ - { "toolField": "query", "sourceKind": "parameter", "operationId": "apps_getCollection", "invocationId": "name-search", "location": "query", "appleName": "filter[name]" }, - { "toolField": "query", "sourceKind": "parameter", "operationId": "apps_getCollection", "invocationId": "bundle-search", "location": "query", "appleName": "filter[bundleId]" } - ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "apps_getCollection", "statusCode": "200", "mediaType": "application/json", "invocationIds": ["name-search", "bundle-search"] } + { + "operationId": "apps_getCollection", + "statusCode": "200", + "mediaType": "application/json", + "invocationIds": [ + "name-search", + "bundle-search" + ] + } ], "fields": [ - { "outputField": "success", "localRole": "successfulAggregate" }, - { "outputField": "query", "localRole": "echoInput" }, - { "outputField": "apps", "operationId": "apps_getCollection", "jsonPointer": "/data", "invocationIds": ["name-search", "bundle-search"] }, - { "outputField": "count", "localRole": "deduplicatedResultCount" }, - { "outputField": "pagesFetched", "localRole": "completedPaginationRequestCount" }, - { "outputField": "searchedIn", "localRole": "fixedSearchDimensions" } + { + "outputField": "success", + "localRole": "successfulAggregate" + }, + { + "outputField": "query", + "localRole": "echoInput" + }, + { + "outputField": "apps", + "operationId": "apps_getCollection", + "jsonPointer": "/data", + "invocationIds": [ + "name-search", + "bundle-search" + ] + }, + { + "outputField": "count", + "localRole": "deduplicatedResultCount" + }, + { + "outputField": "pagesFetched", + "localRole": "completedPaginationRequestCount" + }, + { + "outputField": "searchedIn", + "localRole": "fixedSearchDimensions" + } ] }, "note": "The exact-name and exact-bundle-ID union branches each follow all Apple pages with fixed limit=200, sparse App projection, and deterministic sort. Every continuation must preserve its branch filter and fixed controls, allow only Apple's cursor, and remain on the configured origin and collection path. Repeated or invalid next URLs fail without returning partial results. Resources are de-duplicated by App ID and sorted locally by name, bundle ID, SKU, then ID." @@ -722,14 +2149,22 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appStoreVersions_appStoreVersionLocalizations_getToManyRelated:/data/*/id"], + "derivedFrom": [ + "appStoreVersions_appStoreVersionLocalizations_getToManyRelated:/data/*/id" + ], "localRole": "useResolvedLocalizationIdentifierForPath" }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appStoreVersionLocalizations" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appStoreVersionLocalizations" + }, { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["appStoreVersions_appStoreVersionLocalizations_getToManyRelated:/data/*/id"], + "derivedFrom": [ + "appStoreVersions_appStoreVersionLocalizations_getToManyRelated:/data/*/id" + ], "localRole": "copyResolvedLocalizationIdentifierToRequestBody" } ] @@ -740,22 +2175,48 @@ "path": "/v1/appStoreVersions/{id}", "role": "supporting", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "App Store version experiments are not included in the write preflight.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "App Store version experiments are not included in the write preflight.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "The target localization is resolved through the dedicated filtered operation.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "App Store version experiments are not included in the write preflight.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "App Store version experiments are not included in the write preflight.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "The target localization is resolved through the dedicated filtered operation.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersions]", - "fixedValue": ["app", "platform", "versionString", "appVersionState", "appStoreState"] + "fixedValue": [ + "app", + "platform", + "versionString", + "appVersionState", + "appStoreState" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["app"] + "fixedValue": [ + "app" + ] } ] }, @@ -765,52 +2226,167 @@ "path": "/v1/appStoreVersions/{id}/appStoreVersionLocalizations", "role": "supporting", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit", "disposition": "internalControl", "reason": "The exact-locale write lookup fixes the page size to one before patching the resolved localization.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Preview sets are not included in the write lookup.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Screenshot sets are not included in the write lookup.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Search keywords are not included in the write lookup.", "reviewAtSpec": "4.5.1" }, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit", + "disposition": "internalControl", + "reason": "The exact-locale write lookup fixes the page size to one before patching the resolved localization.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Preview sets are not included in the write lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Screenshot sets are not included in the write lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Search keywords are not included in the write lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersionLocalizations]", - "fixedValue": ["locale", "appStoreVersion"] + "fixedValue": [ + "locale", + "appStoreVersion" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["appStoreVersion"] + "fixedValue": [ + "appStoreVersion" + ] } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "local", "localRole": "validateVersionOwnershipFromAppRelationship", "derivedFrom": ["appStoreVersions_getInstance:/data/relationships/app/data/id"] }, - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "appStoreVersions_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "locale", "sourceKind": "parameter", "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "location": "query", "appleName": "filter[locale]" }, - { "toolField": "description", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_updateInstance", "jsonPointer": "/data/attributes/description" }, - { "toolField": "whats_new", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_updateInstance", "jsonPointer": "/data/attributes/whatsNew" }, - { "toolField": "keywords", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_updateInstance", "jsonPointer": "/data/attributes/keywords" }, - { "toolField": "promotional_text", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_updateInstance", "jsonPointer": "/data/attributes/promotionalText" }, - { "toolField": "support_url", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_updateInstance", "jsonPointer": "/data/attributes/supportUrl" }, - { "toolField": "marketing_url", "sourceKind": "requestBody", "operationId": "appStoreVersionLocalizations_updateInstance", "jsonPointer": "/data/attributes/marketingUrl" } + { + "toolField": "app_id", + "sourceKind": "local", + "localRole": "validateVersionOwnershipFromAppRelationship", + "derivedFrom": [ + "appStoreVersions_getInstance:/data/relationships/app/data/id" + ] + }, + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "appStoreVersions_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "locale", + "sourceKind": "parameter", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "location": "query", + "appleName": "filter[locale]" + }, + { + "toolField": "description", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_updateInstance", + "jsonPointer": "/data/attributes/description" + }, + { + "toolField": "whats_new", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_updateInstance", + "jsonPointer": "/data/attributes/whatsNew" + }, + { + "toolField": "keywords", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_updateInstance", + "jsonPointer": "/data/attributes/keywords" + }, + { + "toolField": "promotional_text", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_updateInstance", + "jsonPointer": "/data/attributes/promotionalText" + }, + { + "toolField": "support_url", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_updateInstance", + "jsonPointer": "/data/attributes/supportUrl" + }, + { + "toolField": "marketing_url", + "sourceKind": "requestBody", + "operationId": "appStoreVersionLocalizations_updateInstance", + "jsonPointer": "/data/attributes/marketingUrl" + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "appStoreVersionLocalizations_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionLocalizations_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulUpdate" }, - { "outputField": "version", "operationId": "appStoreVersions_getInstance", "jsonPointer": "/data/attributes/versionString" }, - { "outputField": "localizationId", "localRole": "resolvedLocalizationIdentifier" }, - { "outputField": "updatedFields", "localRole": "providedAttributeNames" } + { + "outputField": "success", + "localRole": "successfulUpdate" + }, + { + "outputField": "version", + "operationId": "appStoreVersions_getInstance", + "jsonPointer": "/data/attributes/versionString" + }, + { + "outputField": "localizationId", + "localRole": "resolvedLocalizationIdentifier" + }, + { + "outputField": "updatedFields", + "localRole": "providedAttributeNames" + } ] }, "note": "The handler validates app-to-version ownership and requires the filter to resolve exactly one resource whose type, locale attribute, and version linkage all match before PATCH. It preserves omitted versus explicit-null localization attributes, then patches the resolved localization." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/assets.json b/Sources/asc-mcp/Resources/OperationManifest/tools/assets.json index 3abf9af..a1a574c 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/assets.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/assets.json @@ -8,7 +8,12 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "method": "get", "path": "/v1/apps/{id}/assetLibrary", "role": "primary"}, + { + "operationId": "apps_assetLibrary_getToOneRelated", + "method": "get", + "path": "/v1/apps/{id}/assetLibrary", + "role": "primary" + }, { "operationId": "appAssetLibraries_getInstance", "method": "get", @@ -16,23 +21,56 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "appAssetLibraries_getInstance:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "appAssetLibraries_getInstance:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ] } ], "fields": [ - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_assetLibrary_getToOneRelated", "location": "path", "appleName": "id"} + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_assetLibrary_getToOneRelated", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_getInstance", "statusCode": "200", "mediaType": "application/json"} + { + "operationId": "apps_assetLibrary_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation."}, - {"outputField": "app_id", "localRole": "Echo of the canonical app ID used for ownership checks."}, - {"outputField": "library", "operationId": "appAssetLibraries_getInstance", "jsonPointer": "/data"} + { + "outputField": "success", + "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation." + }, + { + "outputField": "app_id", + "localRole": "Echo of the canonical app ID used for ownership checks." + }, + { + "outputField": "library", + "operationId": "appAssetLibraries_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Resolves the app-owned library relationship and then validates the library instance. Output preserves unknown safe fields while removing signed links and upload credentials." @@ -44,26 +82,87 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - {"operationId": "appAssetLibraryRefData_getCollection", "method": "get", "path": "/v1/appAssetLibraryRefData", "role": "primary", "condition": "Without reference_id: read the collection using only supplied catalog filters."}, - {"operationId": "appAssetLibraryRefData_getInstance", "method": "get", "path": "/v1/appAssetLibraryRefData/{id}", "role": "conditional", "condition": "With reference_id only: read that exact reference-data resource; collection filters are rejected."} + { + "operationId": "appAssetLibraryRefData_getCollection", + "method": "get", + "path": "/v1/appAssetLibraryRefData", + "role": "primary", + "condition": "Without reference_id: read the collection using only supplied catalog filters." + }, + { + "operationId": "appAssetLibraryRefData_getInstance", + "method": "get", + "path": "/v1/appAssetLibraryRefData/{id}", + "role": "conditional", + "condition": "With reference_id only: read that exact reference-data resource; collection filters are rejected." + } ], "fields": [ - {"toolField": "reference_id", "sourceKind": "parameter", "operationId": "appAssetLibraryRefData_getInstance", "location": "path", "appleName": "id"}, - {"toolField": "features", "sourceKind": "parameter", "operationId": "appAssetLibraryRefData_getCollection", "location": "query", "appleName": "filter[features]"}, - {"toolField": "placement_types", "sourceKind": "parameter", "operationId": "appAssetLibraryRefData_getCollection", "location": "query", "appleName": "filter[placementTypes]"}, - {"toolField": "placement_groups", "sourceKind": "parameter", "operationId": "appAssetLibraryRefData_getCollection", "location": "query", "appleName": "filter[placementProfileGroups]"}, - {"toolField": "spec_ids", "sourceKind": "parameter", "operationId": "appAssetLibraryRefData_getCollection", "location": "query", "appleName": "filter[specs]"} + { + "toolField": "reference_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraryRefData_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "features", + "sourceKind": "parameter", + "operationId": "appAssetLibraryRefData_getCollection", + "location": "query", + "appleName": "filter[features]" + }, + { + "toolField": "placement_types", + "sourceKind": "parameter", + "operationId": "appAssetLibraryRefData_getCollection", + "location": "query", + "appleName": "filter[placementTypes]" + }, + { + "toolField": "placement_groups", + "sourceKind": "parameter", + "operationId": "appAssetLibraryRefData_getCollection", + "location": "query", + "appleName": "filter[placementProfileGroups]" + }, + { + "toolField": "spec_ids", + "sourceKind": "parameter", + "operationId": "appAssetLibraryRefData_getCollection", + "location": "query", + "appleName": "filter[specs]" + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "appAssetLibraryRefData_getCollection", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryRefData_getInstance", "statusCode": "200", "mediaType": "application/json"} + { + "operationId": "appAssetLibraryRefData_getCollection", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryRefData_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "Local validated read result."}, - {"outputField": "reference_data", "operationId": "appAssetLibraryRefData_getCollection", "jsonPointer": "/data"}, - {"outputField": "reference_data", "operationId": "appAssetLibraryRefData_getInstance", "jsonPointer": "/data"} + { + "outputField": "success", + "localRole": "Local validated read result." + }, + { + "outputField": "reference_data", + "operationId": "appAssetLibraryRefData_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "reference_data", + "operationId": "appAssetLibraryRefData_getInstance", + "jsonPointer": "/data" + } ] }, "note": "reference_id selects the instance endpoint and cannot be combined with filters. Otherwise reads the reference collection; a continuation is rejected because preparation requires a complete catalog. Unknown reference values remain readable." @@ -75,7 +174,13 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "method": "get", "path": "/v1/apps/{id}/assetLibrary", "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources."}, + { + "operationId": "apps_assetLibrary_getToOneRelated", + "method": "get", + "path": "/v1/apps/{id}/assetLibrary", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources." + }, { "operationId": "appAssetLibraries_getInstance", "method": "get", @@ -83,7 +188,17 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "appAssetLibraries_getInstance:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "appAssetLibraries_getInstance:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ] }, { @@ -93,17 +208,74 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "appAssetLibraries_images_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "appAssetLibraries_images_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[category]", "disposition": "intentionallyOmitted", "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specId]", "disposition": "intentionallyOmitted", "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[category]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[referenceName]", + "disposition": "intentionallyOmitted", + "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specId]", + "disposition": "intentionallyOmitted", + "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -112,28 +284,84 @@ "path": "/v1/appAssetLibraryImages/{id}", "role": "primary", "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_assetLibrary_getToOneRelated", "location": "path", "appleName": "id"}, - {"toolField": "asset_id", "sourceKind": "parameter", "operationId": "appAssetLibraryImages_getInstance", "location": "path", "appleName": "id"}, - {"toolField": "asset_id", "sourceKind": "parameter", "operationId": "appAssetLibraries_images_getToManyRelated", "location": "query", "appleName": "filter[id]"} + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_assetLibrary_getToOneRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "asset_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraryImages_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "asset_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_images_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_images_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_getInstance", "statusCode": "200", "mediaType": "application/json"} + { + "operationId": "apps_assetLibrary_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_images_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation."}, - {"outputField": "app_id", "localRole": "Echo of the canonical app ID used for ownership checks."}, - {"outputField": "asset", "operationId": "appAssetLibraryImages_getInstance", "jsonPointer": "/data"} + { + "outputField": "success", + "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation." + }, + { + "outputField": "app_id", + "localRole": "Echo of the canonical app ID used for ownership checks." + }, + { + "outputField": "asset", + "operationId": "appAssetLibraryImages_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Proves exact membership in the requested app library before reading the asset. Processing, review and video poster state are returned as safe projections; uploadOperations, signed URLs and binary contents are not returned." @@ -145,7 +373,13 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "method": "get", "path": "/v1/apps/{id}/assetLibrary", "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources."}, + { + "operationId": "apps_assetLibrary_getToOneRelated", + "method": "get", + "path": "/v1/apps/{id}/assetLibrary", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources." + }, { "operationId": "appAssetLibraries_getInstance", "method": "get", @@ -153,7 +387,17 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "appAssetLibraries_getInstance:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "appAssetLibraries_getInstance:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ] }, { @@ -163,17 +407,74 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[category]", "disposition": "intentionallyOmitted", "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specId]", "disposition": "intentionallyOmitted", "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[category]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[referenceName]", + "disposition": "intentionallyOmitted", + "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specId]", + "disposition": "intentionallyOmitted", + "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -182,28 +483,84 @@ "path": "/v1/appAssetLibraryVideos/{id}", "role": "primary", "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_assetLibrary_getToOneRelated", "location": "path", "appleName": "id"}, - {"toolField": "asset_id", "sourceKind": "parameter", "operationId": "appAssetLibraryVideos_getInstance", "location": "path", "appleName": "id"}, - {"toolField": "asset_id", "sourceKind": "parameter", "operationId": "appAssetLibraries_videos_getToManyRelated", "location": "query", "appleName": "filter[id]"} + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_assetLibrary_getToOneRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "asset_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraryVideos_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "asset_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_videos_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_getInstance", "statusCode": "200", "mediaType": "application/json"} + { + "operationId": "apps_assetLibrary_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_videos_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation."}, - {"outputField": "app_id", "localRole": "Echo of the canonical app ID used for ownership checks."}, - {"outputField": "asset", "operationId": "appAssetLibraryVideos_getInstance", "jsonPointer": "/data"} + { + "outputField": "success", + "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation." + }, + { + "outputField": "app_id", + "localRole": "Echo of the canonical app ID used for ownership checks." + }, + { + "outputField": "asset", + "operationId": "appAssetLibraryVideos_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Proves exact membership in the requested app library before reading the asset. Processing, review and video poster state are returned as safe projections; uploadOperations, signed URLs and binary contents are not returned." @@ -221,7 +578,20 @@ "path": "/v1/appAssetLibraryPlacements/{id}", "role": "primary", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"} + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + } ] }, { @@ -231,14 +601,55 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appStoreVersionLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersion"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appStoreVersionLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersion" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -248,14 +659,55 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appCustomProductPageLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appCustomProductPageVersion"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appCustomProductPageLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appCustomProductPageVersion" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -265,13 +717,48 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appStoreVersionExperimentTreatmentLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersionExperimentTreatment"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appStoreVersionExperimentTreatmentLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersionExperimentTreatment" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -281,13 +768,48 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appEventLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appEvent"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appEventLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appEvent" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appEventScreenshots]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appEventVideoClips]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appEventScreenshots]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEventVideoClips]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -297,13 +819,48 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appStoreVersions_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appStoreVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -313,11 +870,34 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appCustomProductPageVersions_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appCustomProductPage"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appCustomProductPageVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appCustomProductPage" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appCustomProductPageLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appCustomProductPageLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -327,11 +907,34 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appCustomProductPages_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appCustomProductPages_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appCustomProductPageVersions]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appCustomProductPageVersions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -341,11 +944,34 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appStoreVersionExperimentTreatments_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersionExperimentV2"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appStoreVersionExperimentTreatments_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersionExperimentV2" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -355,12 +981,41 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appStoreVersionExperimentsV2_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appStoreVersionExperimentsV2_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperimentTreatments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[controlVersions]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[controlVersions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -370,11 +1025,33 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appEvents_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appEvents_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -384,13 +1061,46 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "placement_id", "appEvents_getInstance:/data/id"], "localRole": "Single event ID from the localization parent, verified in this app before accepting ownership.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "appEvents_getInstance:/data/id" + ], + "localRole": "Single event ID from the localization parent, verified in this app before accepting ownership.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[eventState]", "disposition": "intentionallyOmitted", "reason": "Event ownership is independent of event state; the matched event is validated after the app-scoped lookup.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[eventState]", + "disposition": "intentionallyOmitted", + "reason": "Event ownership is independent of event state; the matched event is validated after the app-scoped lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -400,48 +1110,283 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "filter[platform]", + "disposition": "intentionallyOmitted", + "reason": "The complete app inventory is required; platform is checked from the selected parent or submission.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[versionString]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and approved-version checks inspect all versions rather than selecting a marketing version.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreState]", + "disposition": "intentionallyOmitted", + "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or legacy-state resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appVersionState]", + "disposition": "intentionallyOmitted", + "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or future-state resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "operationId": "retentionMessageVersions_getInstance", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "placement_id", + "retentionMessageVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact retention message version ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "retentionMessage" + ], + "location": "query", + "appleName": "include" + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "operationId": "apps_retentionMessages_getToManyRelated", + "method": "get", + "path": "/v1/apps/{id}/retentionMessages", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[platform]", "disposition": "intentionallyOmitted", "reason": "The complete app inventory is required; platform is checked from the selected parent or submission.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[versionString]", "disposition": "intentionallyOmitted", "reason": "Ownership and approved-version checks inspect all versions rather than selecting a marketing version.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreState]", "disposition": "intentionallyOmitted", "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or legacy-state resources.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appVersionState]", "disposition": "intentionallyOmitted", "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or future-state resources.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[versions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - {"toolField": "placement_id", "sourceKind": "parameter", "operationId": "appAssetLibraryPlacements_getInstance", "location": "path", "appleName": "id"}, - {"toolField": "app_id", "sourceKind": "local", "localRole": "Canonical expected app ID compared against the complete localization ownership chain and used for app-scoped event/version lookup."}, - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_appEvents_getToManyRelated", "location": "path", "appleName": "id"}, - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_appStoreVersions_getToManyRelated", "location": "path", "appleName": "id"} + { + "toolField": "placement_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraryPlacements_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_id", + "sourceKind": "local", + "localRole": "Canonical expected app ID compared against the complete localization ownership chain and used for app-scoped event/version lookup." + }, + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_appEvents_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_retentionMessages_getToManyRelated", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "appAssetLibraryPlacements_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEventLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageVersions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPages_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatments_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentsV2_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEvents_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "apps_appEvents_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "apps_appStoreVersions_getToManyRelated", "statusCode": "200", "mediaType": "application/json"} + { + "operationId": "appAssetLibraryPlacements_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEventLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatments_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentsV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEvents_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appEvents_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appStoreVersions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "retentionMessageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_retentionMessages_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation."}, - {"outputField": "app_id", "localRole": "Echo of the canonical app ID used for ownership checks."}, - {"outputField": "placement", "operationId": "appAssetLibraryPlacements_getInstance", "jsonPointer": "/data"} + { + "outputField": "success", + "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation." + }, + { + "outputField": "app_id", + "localRole": "Echo of the canonical app ID used for ownership checks." + }, + { + "outputField": "placement", + "operationId": "appAssetLibraryPlacements_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Requires exactly one supported localization relationship and verifies its app ownership. Main page, CPP, PPO treatment and event parents are read through their typed ownership chains; no parent mutation is performed." @@ -453,7 +1398,13 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "method": "get", "path": "/v1/apps/{id}/assetLibrary", "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources."}, + { + "operationId": "apps_assetLibrary_getToOneRelated", + "method": "get", + "path": "/v1/apps/{id}/assetLibrary", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources." + }, { "operationId": "appAssetLibraries_getInstance", "method": "get", @@ -461,7 +1412,16 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "appAssetLibraries_getInstance:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "appAssetLibraries_getInstance:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ] }, { @@ -470,39 +1430,145 @@ "path": "/v1/appAssetLibraries/{id}/images", "role": "primary", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "appAssetLibraries_images_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "appAssetLibraries_images_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_assetLibrary_getToOneRelated", "location": "path", "appleName": "id"}, - {"toolField": "limit", "sourceKind": "parameter", "operationId": "appAssetLibraries_images_getToManyRelated", "location": "query", "appleName": "limit"}, - {"toolField": "next_url", "sourceKind": "local", "localRole": "Apple-returned continuation only; HTTPS host, path, nonempty cursor and complete immutable query scope must match this exact app library collection."}, - {"toolField": "categories", "sourceKind": "parameter", "operationId": "appAssetLibraries_images_getToManyRelated", "location": "query", "appleName": "filter[category]"}, - {"toolField": "states", "sourceKind": "parameter", "operationId": "appAssetLibraries_images_getToManyRelated", "location": "query", "appleName": "filter[state]"}, - {"toolField": "reference_names", "sourceKind": "parameter", "operationId": "appAssetLibraries_images_getToManyRelated", "location": "query", "appleName": "filter[referenceName]"}, - {"toolField": "spec_ids", "sourceKind": "parameter", "operationId": "appAssetLibraries_images_getToManyRelated", "location": "query", "appleName": "filter[specId]"}, - {"toolField": "asset_ids", "sourceKind": "parameter", "operationId": "appAssetLibraries_images_getToManyRelated", "location": "query", "appleName": "filter[id]"} + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_assetLibrary_getToOneRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_images_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Apple-returned continuation only; HTTPS host, path, nonempty cursor and complete immutable query scope must match this exact app library collection." + }, + { + "toolField": "categories", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_images_getToManyRelated", + "location": "query", + "appleName": "filter[category]" + }, + { + "toolField": "states", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_images_getToManyRelated", + "location": "query", + "appleName": "filter[state]" + }, + { + "toolField": "reference_names", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_images_getToManyRelated", + "location": "query", + "appleName": "filter[referenceName]" + }, + { + "toolField": "spec_ids", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_images_getToManyRelated", + "location": "query", + "appleName": "filter[specId]" + }, + { + "toolField": "asset_ids", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_images_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_images_getToManyRelated", "statusCode": "200", "mediaType": "application/json"} + { + "operationId": "apps_assetLibrary_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_images_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation."}, - {"outputField": "app_id", "localRole": "Echo of the canonical app ID used for ownership checks."}, - {"outputField": "resources", "operationId": "appAssetLibraries_images_getToManyRelated", "jsonPointer": "/data"}, - {"outputField": "next_url", "operationId": "appAssetLibraries_images_getToManyRelated", "jsonPointer": "/links/next"}, - {"outputField": "meta", "operationId": "appAssetLibraries_images_getToManyRelated", "jsonPointer": "/meta"}, - {"outputField": "count", "localRole": "Number of unique resources on this validated page."} + { + "outputField": "success", + "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation." + }, + { + "outputField": "app_id", + "localRole": "Echo of the canonical app ID used for ownership checks." + }, + { + "outputField": "resources", + "operationId": "appAssetLibraries_images_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appAssetLibraries_images_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "meta", + "operationId": "appAssetLibraries_images_getToManyRelated", + "jsonPointer": "/meta" + }, + { + "outputField": "count", + "localRole": "Number of unique resources on this validated page." + } ] }, "note": "App ownership is resolved before every page. Optional filters are serialized as validated unique string lists; limit defaults to 50. Continuations cannot change the original app/library, filters or page size." @@ -514,7 +1580,13 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "method": "get", "path": "/v1/apps/{id}/assetLibrary", "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources."}, + { + "operationId": "apps_assetLibrary_getToOneRelated", + "method": "get", + "path": "/v1/apps/{id}/assetLibrary", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources." + }, { "operationId": "appAssetLibraries_getInstance", "method": "get", @@ -522,7 +1594,16 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "appAssetLibraries_getInstance:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "appAssetLibraries_getInstance:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ] }, { @@ -531,39 +1612,145 @@ "path": "/v1/appAssetLibraries/{id}/videos", "role": "primary", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_assetLibrary_getToOneRelated", "location": "path", "appleName": "id"}, - {"toolField": "limit", "sourceKind": "parameter", "operationId": "appAssetLibraries_videos_getToManyRelated", "location": "query", "appleName": "limit"}, - {"toolField": "next_url", "sourceKind": "local", "localRole": "Apple-returned continuation only; HTTPS host, path, nonempty cursor and complete immutable query scope must match this exact app library collection."}, - {"toolField": "categories", "sourceKind": "parameter", "operationId": "appAssetLibraries_videos_getToManyRelated", "location": "query", "appleName": "filter[category]"}, - {"toolField": "states", "sourceKind": "parameter", "operationId": "appAssetLibraries_videos_getToManyRelated", "location": "query", "appleName": "filter[state]"}, - {"toolField": "reference_names", "sourceKind": "parameter", "operationId": "appAssetLibraries_videos_getToManyRelated", "location": "query", "appleName": "filter[referenceName]"}, - {"toolField": "spec_ids", "sourceKind": "parameter", "operationId": "appAssetLibraries_videos_getToManyRelated", "location": "query", "appleName": "filter[specId]"}, - {"toolField": "asset_ids", "sourceKind": "parameter", "operationId": "appAssetLibraries_videos_getToManyRelated", "location": "query", "appleName": "filter[id]"} + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_assetLibrary_getToOneRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Apple-returned continuation only; HTTPS host, path, nonempty cursor and complete immutable query scope must match this exact app library collection." + }, + { + "toolField": "categories", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "location": "query", + "appleName": "filter[category]" + }, + { + "toolField": "states", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "location": "query", + "appleName": "filter[state]" + }, + { + "toolField": "reference_names", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "location": "query", + "appleName": "filter[referenceName]" + }, + { + "toolField": "spec_ids", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "location": "query", + "appleName": "filter[specId]" + }, + { + "toolField": "asset_ids", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_videos_getToManyRelated", "statusCode": "200", "mediaType": "application/json"} + { + "operationId": "apps_assetLibrary_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_videos_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation."}, - {"outputField": "app_id", "localRole": "Echo of the canonical app ID used for ownership checks."}, - {"outputField": "resources", "operationId": "appAssetLibraries_videos_getToManyRelated", "jsonPointer": "/data"}, - {"outputField": "next_url", "operationId": "appAssetLibraries_videos_getToManyRelated", "jsonPointer": "/links/next"}, - {"outputField": "meta", "operationId": "appAssetLibraries_videos_getToManyRelated", "jsonPointer": "/meta"}, - {"outputField": "count", "localRole": "Number of unique resources on this validated page."} + { + "outputField": "success", + "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation." + }, + { + "outputField": "app_id", + "localRole": "Echo of the canonical app ID used for ownership checks." + }, + { + "outputField": "resources", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "meta", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "jsonPointer": "/meta" + }, + { + "outputField": "count", + "localRole": "Number of unique resources on this validated page." + } ] }, "note": "App ownership is resolved before every page. Optional filters are serialized as validated unique string lists; limit defaults to 50. Continuations cannot change the original app/library, filters or page size." @@ -575,7 +1762,13 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "method": "get", "path": "/v1/apps/{id}/assetLibrary", "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources."}, + { + "operationId": "apps_assetLibrary_getToOneRelated", + "method": "get", + "path": "/v1/apps/{id}/assetLibrary", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources." + }, { "operationId": "appAssetLibraries_getInstance", "method": "get", @@ -583,7 +1776,18 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "target_id", "appAssetLibraries_getInstance:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "target_id", + "appAssetLibraries_getInstance:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ] }, { @@ -593,17 +1797,75 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "target_id", "appAssetLibraries_images_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "target_id", + "appAssetLibraries_images_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[category]", "disposition": "intentionallyOmitted", "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specId]", "disposition": "intentionallyOmitted", "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[category]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[referenceName]", + "disposition": "intentionallyOmitted", + "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specId]", + "disposition": "intentionallyOmitted", + "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -613,17 +1875,75 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "target_id", "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "target_id", + "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[category]", "disposition": "intentionallyOmitted", "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specId]", "disposition": "intentionallyOmitted", "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[category]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[referenceName]", + "disposition": "intentionallyOmitted", + "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specId]", + "disposition": "intentionallyOmitted", + "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -633,8 +1953,20 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -644,8 +1976,20 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -654,17 +1998,79 @@ "path": "/v1/appAssetLibraryImages/{id}/placements", "role": "primary", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"} + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ], "condition": "Only for the matching validated asset_kind or target_type selector. Exactly one asset or localization selector is permitted; public pagination preserves the complete query." }, @@ -674,17 +2080,79 @@ "path": "/v1/appAssetLibraryVideos/{id}/placements", "role": "conditional", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"} + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ], "condition": "Only for the matching validated asset_kind or target_type selector. Exactly one asset or localization selector is permitted; public pagination preserves the complete query." }, @@ -694,17 +2162,79 @@ "path": "/v1/appStoreVersionLocalizations/{id}/placements", "role": "conditional", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"} + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ], "condition": "Only for the matching validated asset_kind or target_type selector. Exactly one asset or localization selector is permitted; public pagination preserves the complete query." }, @@ -714,17 +2244,79 @@ "path": "/v1/appCustomProductPageLocalizations/{id}/placements", "role": "conditional", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"} + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ], "condition": "Only for the matching validated asset_kind or target_type selector. Exactly one asset or localization selector is permitted; public pagination preserves the complete query." }, @@ -734,17 +2326,79 @@ "path": "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/placements", "role": "conditional", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"} + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ], "condition": "Only for the matching validated asset_kind or target_type selector. Exactly one asset or localization selector is permitted; public pagination preserves the complete query." }, @@ -754,17 +2408,79 @@ "path": "/v1/appEventLocalizations/{id}/placements", "role": "conditional", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"} + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ], "condition": "Only for the matching validated asset_kind or target_type selector. Exactly one asset or localization selector is permitted; public pagination preserves the complete query." }, @@ -775,13 +2491,44 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["appStoreVersion"], "location": "query", "appleName": "include"} + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersion" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -791,13 +2538,44 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["appCustomProductPageVersion"], "location": "query", "appleName": "include"} + { + "sourceKind": "fixed", + "fixedValue": [ + "appCustomProductPageVersion" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -807,12 +2585,37 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["appStoreVersionExperimentTreatment"], "location": "query", "appleName": "include"} + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersionExperimentTreatment" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -822,12 +2625,37 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": ["appEvent"], "location": "query", "appleName": "include"} + { + "sourceKind": "fixed", + "fixedValue": [ + "appEvent" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appEventScreenshots]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appEventVideoClips]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appEventScreenshots]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEventVideoClips]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -837,13 +2665,49 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "target_id", "appStoreVersions_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "target_id", + "appStoreVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -853,11 +2717,35 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "target_id", "appCustomProductPageVersions_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appCustomProductPage"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "target_id", + "appCustomProductPageVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appCustomProductPage" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appCustomProductPageLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appCustomProductPageLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -867,11 +2755,35 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "target_id", "appCustomProductPages_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "target_id", + "appCustomProductPages_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appCustomProductPageVersions]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appCustomProductPageVersions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -881,11 +2793,35 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "target_id", "appStoreVersionExperimentTreatments_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersionExperimentV2"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "target_id", + "appStoreVersionExperimentTreatments_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersionExperimentV2" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -895,12 +2831,42 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "target_id", "appStoreVersionExperimentsV2_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "target_id", + "appStoreVersionExperimentsV2_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperimentTreatments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[controlVersions]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[controlVersions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -910,11 +2876,34 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "target_id", "appEvents_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "target_id", + "appEvents_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -924,13 +2913,47 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "target_id", "appEvents_getInstance:/data/id"], "localRole": "Single event ID from the localization parent, verified in this app before accepting ownership.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "target_id", + "appEvents_getInstance:/data/id" + ], + "localRole": "Single event ID from the localization parent, verified in this app before accepting ownership.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[eventState]", "disposition": "intentionallyOmitted", "reason": "Event ownership is independent of event state; the matched event is validated after the app-scoped lookup.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[eventState]", + "disposition": "intentionallyOmitted", + "reason": "Event ownership is independent of event state; the matched event is validated after the app-scoped lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -940,111 +2963,697 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "filter[platform]", + "disposition": "intentionallyOmitted", + "reason": "The complete app inventory is required; platform is checked from the selected parent or submission.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[versionString]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and approved-version checks inspect all versions rather than selecting a marketing version.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreState]", + "disposition": "intentionallyOmitted", + "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or legacy-state resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appVersionState]", + "disposition": "intentionallyOmitted", + "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or future-state resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}/placement", + "role": "conditional", + "inputs": [ + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + } + ], + "condition": "Only for the matching validated asset_kind or target_type selector. Exactly one asset or localization selector is permitted; public pagination preserves the complete query." + }, + { + "operationId": "retentionMessageVersions_getInstance", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "fixed", + "fixedValue": [ + "retentionMessage" + ], + "location": "query", + "appleName": "include" + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "operationId": "apps_retentionMessages_getToManyRelated", + "method": "get", + "path": "/v1/apps/{id}/retentionMessages", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[platform]", "disposition": "intentionallyOmitted", "reason": "The complete app inventory is required; platform is checked from the selected parent or submission.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[versionString]", "disposition": "intentionallyOmitted", "reason": "Ownership and approved-version checks inspect all versions rather than selecting a marketing version.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreState]", "disposition": "intentionallyOmitted", "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or legacy-state resources.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appVersionState]", "disposition": "intentionallyOmitted", "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or future-state resources.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[versions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_assetLibrary_getToOneRelated", "location": "path", "appleName": "id"}, - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_appEvents_getToManyRelated", "location": "path", "appleName": "id"}, - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_appStoreVersions_getToManyRelated", "location": "path", "appleName": "id"}, - {"toolField": "asset_kind", "sourceKind": "local", "localRole": "Selects exactly the image or video endpoint; must be supplied with asset_id and excludes a localization selector."}, - {"toolField": "target_type", "sourceKind": "local", "localRole": "Selects one of the four supported localization types; must be supplied with target_id and excludes an asset selector."}, - {"toolField": "next_url", "sourceKind": "local", "localRole": "Apple-returned continuation bound to the exact selected resource, complete filters, fixed includes/order and page size; cannot supply an arbitrary network destination."}, - {"toolField": "asset_id", "sourceKind": "parameter", "operationId": "appAssetLibraryImages_getInstance", "location": "path", "appleName": "id"}, - {"toolField": "asset_id", "sourceKind": "parameter", "operationId": "appAssetLibraryVideos_getInstance", "location": "path", "appleName": "id"}, - {"toolField": "asset_id", "sourceKind": "parameter", "operationId": "appAssetLibraryImages_placements_getToManyRelated", "location": "path", "appleName": "id"}, - {"toolField": "asset_id", "sourceKind": "parameter", "operationId": "appAssetLibraryVideos_placements_getToManyRelated", "location": "path", "appleName": "id"}, - {"toolField": "asset_id", "sourceKind": "parameter", "operationId": "appAssetLibraries_images_getToManyRelated", "location": "query", "appleName": "filter[id]"}, - {"toolField": "asset_id", "sourceKind": "parameter", "operationId": "appAssetLibraries_videos_getToManyRelated", "location": "query", "appleName": "filter[id]"}, - {"toolField": "target_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_getInstance", "location": "path", "appleName": "id"}, - {"toolField": "target_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_getInstance", "location": "path", "appleName": "id"}, - {"toolField": "target_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", "location": "path", "appleName": "id"}, - {"toolField": "target_id", "sourceKind": "parameter", "operationId": "appEventLocalizations_getInstance", "location": "path", "appleName": "id"}, - {"toolField": "target_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "location": "path", "appleName": "id"}, - {"toolField": "target_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "location": "path", "appleName": "id"}, - {"toolField": "target_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "location": "path", "appleName": "id"}, - {"toolField": "target_id", "sourceKind": "parameter", "operationId": "appEventLocalizations_placements_getToManyRelated", "location": "path", "appleName": "id"}, - {"toolField": "limit", "sourceKind": "parameter", "operationId": "appAssetLibraryImages_placements_getToManyRelated", "location": "query", "appleName": "limit"}, - {"toolField": "placement_types", "sourceKind": "parameter", "operationId": "appAssetLibraryImages_placements_getToManyRelated", "location": "query", "appleName": "filter[placementType]"}, - {"toolField": "placement_groups", "sourceKind": "parameter", "operationId": "appAssetLibraryImages_placements_getToManyRelated", "location": "query", "appleName": "filter[placementGroup]"}, - {"toolField": "limit", "sourceKind": "parameter", "operationId": "appAssetLibraryVideos_placements_getToManyRelated", "location": "query", "appleName": "limit"}, - {"toolField": "placement_types", "sourceKind": "parameter", "operationId": "appAssetLibraryVideos_placements_getToManyRelated", "location": "query", "appleName": "filter[placementType]"}, - {"toolField": "placement_groups", "sourceKind": "parameter", "operationId": "appAssetLibraryVideos_placements_getToManyRelated", "location": "query", "appleName": "filter[placementGroup]"}, - {"toolField": "limit", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "location": "query", "appleName": "limit"}, - {"toolField": "placement_types", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "location": "query", "appleName": "filter[placementType]"}, - {"toolField": "placement_groups", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "location": "query", "appleName": "filter[placementGroup]"}, - {"toolField": "limit", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "location": "query", "appleName": "limit"}, - {"toolField": "placement_types", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "location": "query", "appleName": "filter[placementType]"}, - {"toolField": "placement_groups", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "location": "query", "appleName": "filter[placementGroup]"}, - {"toolField": "limit", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "location": "query", "appleName": "limit"}, - {"toolField": "placement_types", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "location": "query", "appleName": "filter[placementType]"}, - {"toolField": "placement_groups", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "location": "query", "appleName": "filter[placementGroup]"}, - {"toolField": "limit", "sourceKind": "parameter", "operationId": "appEventLocalizations_placements_getToManyRelated", "location": "query", "appleName": "limit"}, - {"toolField": "placement_types", "sourceKind": "parameter", "operationId": "appEventLocalizations_placements_getToManyRelated", "location": "query", "appleName": "filter[placementType]"}, - {"toolField": "placement_groups", "sourceKind": "parameter", "operationId": "appEventLocalizations_placements_getToManyRelated", "location": "query", "appleName": "filter[placementGroup]"} + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_assetLibrary_getToOneRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_appEvents_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "asset_kind", + "sourceKind": "local", + "localRole": "Selects exactly the image or video endpoint; must be supplied with asset_id and excludes a localization selector." + }, + { + "toolField": "target_type", + "sourceKind": "local", + "localRole": "Selects one of the four supported localization types; must be supplied with target_id and excludes an asset selector." + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Apple-returned continuation bound to the exact selected resource, complete filters, fixed includes/order and page size; cannot supply an arbitrary network destination." + }, + { + "toolField": "asset_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraryImages_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "asset_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraryVideos_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "asset_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "asset_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "asset_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_images_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "asset_id", + "sourceKind": "parameter", + "operationId": "appAssetLibraries_videos_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "target_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "target_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "target_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "target_id", + "sourceKind": "parameter", + "operationId": "appEventLocalizations_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "target_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "target_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "target_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "target_id", + "sourceKind": "parameter", + "operationId": "appEventLocalizations_placements_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "placement_types", + "sourceKind": "parameter", + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementType]" + }, + { + "toolField": "placement_groups", + "sourceKind": "parameter", + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementGroup]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "placement_types", + "sourceKind": "parameter", + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementType]" + }, + { + "toolField": "placement_groups", + "sourceKind": "parameter", + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementGroup]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "placement_types", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementType]" + }, + { + "toolField": "placement_groups", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementGroup]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "placement_types", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementType]" + }, + { + "toolField": "placement_groups", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementGroup]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "placement_types", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementType]" + }, + { + "toolField": "placement_groups", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementGroup]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appEventLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "placement_types", + "sourceKind": "parameter", + "operationId": "appEventLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementType]" + }, + { + "toolField": "placement_groups", + "sourceKind": "parameter", + "operationId": "appEventLocalizations_placements_getToManyRelated", + "location": "query", + "appleName": "filter[placementGroup]" + }, + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_retentionMessages_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "target_id", + "sourceKind": "parameter", + "operationId": "retentionMessageVersions_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "target_id", + "sourceKind": "parameter", + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_images_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_videos_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEventLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEventLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageVersions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPages_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatments_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentsV2_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEvents_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "apps_appEvents_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "apps_appStoreVersions_getToManyRelated", "statusCode": "200", "mediaType": "application/json"} + { + "operationId": "apps_assetLibrary_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_images_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_videos_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEventLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEventLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatments_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentsV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEvents_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appEvents_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appStoreVersions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "retentionMessageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_retentionMessages_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation."}, - {"outputField": "app_id", "localRole": "Echo of the canonical app ID used for ownership checks."}, - {"outputField": "count", "localRole": "Count of unique placements on the validated page."}, - {"outputField": "resources", "operationId": "appAssetLibraryImages_placements_getToManyRelated", "jsonPointer": "/data"}, - {"outputField": "next_url", "operationId": "appAssetLibraryImages_placements_getToManyRelated", "jsonPointer": "/links/next"}, - {"outputField": "meta", "operationId": "appAssetLibraryImages_placements_getToManyRelated", "jsonPointer": "/meta"}, - {"outputField": "resources", "operationId": "appAssetLibraryVideos_placements_getToManyRelated", "jsonPointer": "/data"}, - {"outputField": "next_url", "operationId": "appAssetLibraryVideos_placements_getToManyRelated", "jsonPointer": "/links/next"}, - {"outputField": "meta", "operationId": "appAssetLibraryVideos_placements_getToManyRelated", "jsonPointer": "/meta"}, - {"outputField": "resources", "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "jsonPointer": "/data"}, - {"outputField": "next_url", "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "jsonPointer": "/links/next"}, - {"outputField": "meta", "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "jsonPointer": "/meta"}, - {"outputField": "resources", "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "jsonPointer": "/data"}, - {"outputField": "next_url", "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "jsonPointer": "/links/next"}, - {"outputField": "meta", "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "jsonPointer": "/meta"}, - {"outputField": "resources", "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "jsonPointer": "/data"}, - {"outputField": "next_url", "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "jsonPointer": "/links/next"}, - {"outputField": "meta", "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "jsonPointer": "/meta"}, - {"outputField": "resources", "operationId": "appEventLocalizations_placements_getToManyRelated", "jsonPointer": "/data"}, - {"outputField": "next_url", "operationId": "appEventLocalizations_placements_getToManyRelated", "jsonPointer": "/links/next"}, - {"outputField": "meta", "operationId": "appEventLocalizations_placements_getToManyRelated", "jsonPointer": "/meta"} + { + "outputField": "success", + "localRole": "Local success or safe-error envelope after resource type, identity and ownership validation." + }, + { + "outputField": "app_id", + "localRole": "Echo of the canonical app ID used for ownership checks." + }, + { + "outputField": "count", + "localRole": "Count of unique placements on the validated page." + }, + { + "outputField": "resources", + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "meta", + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "jsonPointer": "/meta" + }, + { + "outputField": "resources", + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "meta", + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "jsonPointer": "/meta" + }, + { + "outputField": "resources", + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "meta", + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "jsonPointer": "/meta" + }, + { + "outputField": "resources", + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "meta", + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "jsonPointer": "/meta" + }, + { + "outputField": "resources", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "meta", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "jsonPointer": "/meta" + }, + { + "outputField": "resources", + "operationId": "appEventLocalizations_placements_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appEventLocalizations_placements_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "meta", + "operationId": "appEventLocalizations_placements_getToManyRelated", + "jsonPointer": "/meta" + }, + { + "outputField": "resources", + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "jsonPointer": "/data" + } ] }, "note": "Exactly one asset or localization selector is required. Asset membership or the complete localization parent chain is verified before pagination. All six relationship identities are requested and ordering reads placementGroupPosition, including for event collections; Event ordering mutations are unsupported." @@ -1056,7 +3665,13 @@ "effect": "local", "implementationState": "asBuilt", "operations": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "method": "get", "path": "/v1/apps/{id}/assetLibrary", "role": "primary", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources."}, + { + "operationId": "apps_assetLibrary_getToOneRelated", + "method": "get", + "path": "/v1/apps/{id}/assetLibrary", + "role": "primary", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources." + }, { "operationId": "appAssetLibraries_getInstance", "method": "get", @@ -1064,7 +3679,20 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appAssetLibraries_getInstance:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appAssetLibraries_getInstance:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ] }, { @@ -1074,10 +3702,34 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementTypes]", "disposition": "intentionallyOmitted", "reason": "Write preparation refreshes the complete live catalog so that feature, group and specification relationships can be validated together.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementProfileGroups]", "disposition": "intentionallyOmitted", "reason": "Write preparation requires the full placement profile groups and their feature/specification relationships.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[features]", "disposition": "intentionallyOmitted", "reason": "Write preparation requires the full catalog to reject missing or unsupported feature relationships.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specs]", "disposition": "intentionallyOmitted", "reason": "Write preparation validates actual media against every specification allowed by the selected feature/group/category.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementTypes]", + "disposition": "intentionallyOmitted", + "reason": "Write preparation refreshes the complete live catalog so that feature, group and specification relationships can be validated together.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementProfileGroups]", + "disposition": "intentionallyOmitted", + "reason": "Write preparation requires the full placement profile groups and their feature/specification relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[features]", + "disposition": "intentionallyOmitted", + "reason": "Write preparation requires the full catalog to reject missing or unsupported feature relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specs]", + "disposition": "intentionallyOmitted", + "reason": "Write preparation validates actual media against every specification allowed by the selected feature/group/category.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1087,18 +3739,90 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appAssetLibraries_images_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id"], "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appAssetLibraries_images_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id" + ], + "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[category]", "disposition": "intentionallyOmitted", "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specId]", "disposition": "intentionallyOmitted", "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[category]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[referenceName]", + "disposition": "intentionallyOmitted", + "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specId]", + "disposition": "intentionallyOmitted", + "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1108,18 +3832,90 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id"], "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id" + ], + "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[category]", "disposition": "intentionallyOmitted", "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specId]", "disposition": "intentionallyOmitted", "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[category]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[referenceName]", + "disposition": "intentionallyOmitted", + "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specId]", + "disposition": "intentionallyOmitted", + "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1129,11 +3925,36 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appAssetLibraryImages_getInstance:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appAssetLibraryImages_getInstance:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1143,11 +3964,36 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appAssetLibraryVideos_getInstance:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appAssetLibraryVideos_getInstance:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1157,21 +4003,112 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appAssetLibraryImages_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appAssetLibraryImages_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1181,21 +4118,112 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appAssetLibraryVideos_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appAssetLibraryVideos_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1205,8 +4233,34 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appAssetLibraryPlacements_getInstance:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appAssetLibraryPlacements_getInstance:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + } ] }, { @@ -1216,21 +4270,113 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appStoreVersionLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appStoreVersionLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1240,21 +4386,113 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appCustomProductPageLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appCustomProductPageLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1264,21 +4502,113 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1288,21 +4618,113 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appEventLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appEventLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1312,14 +4734,58 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appStoreVersionLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersion"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appStoreVersionLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersion" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1329,14 +4795,58 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appCustomProductPageLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appCustomProductPageVersion"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appCustomProductPageLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appCustomProductPageVersion" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1346,13 +4856,51 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appStoreVersionExperimentTreatmentLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersionExperimentTreatment"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appStoreVersionExperimentTreatmentLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersionExperimentTreatment" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1362,13 +4910,51 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appEventLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appEvent"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appEventLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appEvent" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appEventScreenshots]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appEventVideoClips]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appEventScreenshots]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEventVideoClips]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1378,13 +4964,51 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appStoreVersions_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appStoreVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1394,11 +5018,37 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appCustomProductPageVersions_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appCustomProductPage"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appCustomProductPageVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appCustomProductPage" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appCustomProductPageLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appCustomProductPageLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1408,11 +5058,37 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appCustomProductPages_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appCustomProductPages_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appCustomProductPageVersions]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appCustomProductPageVersions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1422,11 +5098,37 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appStoreVersionExperimentTreatments_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersionExperimentV2"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appStoreVersionExperimentTreatments_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersionExperimentV2" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1436,12 +5138,44 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appStoreVersionExperimentsV2_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appStoreVersionExperimentsV2_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperimentTreatments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[controlVersions]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[controlVersions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1451,11 +5185,36 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appEvents_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appEvents_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1465,14 +5224,63 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "apps_appEvents_getToManyRelated:validated-ownership-chain"], "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "appEvents_getInstance:/data/id"], "localRole": "Single event ID from the localization parent, verified in this app before accepting ownership.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "apps_appEvents_getToManyRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "appEvents_getInstance:/data/id" + ], + "localRole": "Single event ID from the localization parent, verified in this app before accepting ownership.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[eventState]", "disposition": "intentionallyOmitted", "reason": "Event ownership is independent of event state; the matched event is validated after the app-scoped lookup.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[eventState]", + "disposition": "intentionallyOmitted", + "reason": "Event ownership is independent of event state; the matched event is validated after the app-scoped lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1482,19 +5290,98 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "apps_appStoreVersions_getToManyRelated:validated-ownership-chain"], "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "reviewSubmissions_getInstance:/data/attributes/platform"], "localRole": "For review preflight use the verified submission platform; for localization platform fallback omit the filter and inspect all app versions.", "location": "query", "appleName": "filter[platform]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "apps_appStoreVersions_getToManyRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "reviewSubmissions_getInstance:/data/attributes/platform" + ], + "localRole": "For review preflight use the verified submission platform; for localization platform fallback omit the filter and inspect all app versions.", + "location": "query", + "appleName": "filter[platform]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[versionString]", "disposition": "intentionallyOmitted", "reason": "Ownership and approved-version checks inspect all versions rather than selecting a marketing version.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreState]", "disposition": "intentionallyOmitted", "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or legacy-state resources.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appVersionState]", "disposition": "intentionallyOmitted", "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or future-state resources.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[versionString]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and approved-version checks inspect all versions rather than selecting a marketing version.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreState]", + "disposition": "intentionallyOmitted", + "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or legacy-state resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appVersionState]", + "disposition": "intentionallyOmitted", + "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or future-state resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1504,11 +5391,37 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "reviewSubmissions_getInstance:validated-ownership-chain"], "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "reviewSubmissions_getInstance:validated-ownership-chain" + ], + "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[items]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[items]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1518,14 +5431,55 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id"], "localRole": "Exactly one verified app ID; enumerate active submissions locally without a state filter.", "location": "query", "appleName": "filter[app]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id" + ], + "localRole": "Exactly one verified app ID; enumerate active submissions locally without a state filter.", + "location": "query", + "appleName": "filter[app]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[platform]", "disposition": "intentionallyOmitted", "reason": "The complete app inventory is required; platform is checked from the selected parent or submission.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[items]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[platform]", + "disposition": "intentionallyOmitted", + "reason": "The complete app inventory is required; platform is checked from the selected parent or submission.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[items]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1535,72 +5489,448 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["app_id", "asset_id", "placement_id", "submission_id", "target_id", "reviewSubmissions_items_getToManyRelated:validated-ownership-chain"], "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appAssetLibraryImage", "appAssetLibraryVideo"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "reviewSubmissions_items_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appAssetLibraryImage", + "appAssetLibraryVideo" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } + ] + }, + { + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}/placement", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "retentionMessageVersions_placement_getToOneRelated:validated-ownership-chain" + ], + "localRole": "Exact retention message version ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + } + ] + }, + { + "operationId": "retentionMessageVersions_getInstance", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "retentionMessageVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact retention message version ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "retentionMessage" + ], + "location": "query", + "appleName": "include" + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "operationId": "apps_retentionMessages_getToManyRelated", + "method": "get", + "path": "/v1/apps/{id}/retentionMessages", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "derived", + "derivedFrom": [ + "app_id", + "asset_id", + "placement_id", + "submission_id", + "target_id", + "apps_retentionMessages_getToManyRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[versions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - {"toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_assetLibrary_getToOneRelated", "location": "path", "appleName": "id"}, - {"toolField": "action", "sourceKind": "local", "localRole": "Allowlisted typed action selects validated preparation branches; arbitrary HTTP methods, URLs, headers and resource types are rejected."}, - {"toolField": "asset_kind", "sourceKind": "local", "localRole": "Typed image/video selector stored in the preview after ownership validation; upload actions derive kind from action."}, - {"toolField": "asset_id", "sourceKind": "local", "localRole": "Canonical app-owned asset identity stored in the immutable prepared change, or recovered from a confirmed resumable journal reservation."}, - {"toolField": "file_path", "sourceKind": "local", "localRole": "Absolute regular-file source path used only to create a protected immutable snapshot with exact file name, size, SHA-256 and inspected media facts; never sent to Apple or retained in the journal."}, - {"toolField": "resume_operation_id", "sourceKind": "local", "localRole": "Account/app-bound predecessor operation ID. Only a confirmed reservation awaiting upload with identical snapshot metadata/hash can resume; no new POST reservation is allowed."}, - {"toolField": "category", "sourceKind": "local", "localRole": "Validated immutable asset category used to select live media requirements and stored for later reservation; no Apple write occurs during preparation."}, - {"toolField": "reference_name", "sourceKind": "local", "localRole": "Optional reference metadata stored for execution; missing upload name gets a unique local identifier, explicit null clears update_reference_name, omission does not mutate an existing name."}, - {"toolField": "preview_frame_time_code", "sourceKind": "local", "localRole": "Validated video timestamp stored for reservation or a separate poster update; inspected duration/FPS bound the value."}, - {"toolField": "target_type", "sourceKind": "local", "localRole": "Exactly one allowlisted localization type, checked through its app ownership chain and editability; the resulting type is stored in the preview."}, - {"toolField": "target_id", "sourceKind": "local", "localRole": "Canonical target localization ID checked through its parent chain, or derived from the existing placement for replacement/deletion."}, - {"toolField": "placement_type", "sourceKind": "local", "localRole": "Live-catalog placement type checked against feature, category, group and spec before storing the prepared change."}, - {"toolField": "placement_group", "sourceKind": "local", "localRole": "Live-catalog group checked against platform, capacity and exact complete membership before storing the prepared change."}, - {"toolField": "placement_id", "sourceKind": "local", "localRole": "Canonical existing placement for replace/delete; its sole target and exact current membership are derived from Apple before snapshotting state."}, - {"toolField": "ordered_placement_ids", "sourceKind": "local", "localRole": "Complete unique group membership in requested order. Event ordering is rejected; replacement records current order for later substitution."}, - {"toolField": "submission_id", "sourceKind": "local", "localRole": "Canonical editable submission ID whose app, platform, approved version and active item participation are verified before storing the prepared action."} + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_assetLibrary_getToOneRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "action", + "sourceKind": "local", + "localRole": "Allowlisted typed action selects validated preparation branches; arbitrary HTTP methods, URLs, headers and resource types are rejected." + }, + { + "toolField": "asset_kind", + "sourceKind": "local", + "localRole": "Typed image/video selector stored in the preview after ownership validation; upload actions derive kind from action." + }, + { + "toolField": "asset_id", + "sourceKind": "local", + "localRole": "Canonical app-owned asset identity stored in the immutable prepared change, or recovered from a confirmed resumable journal reservation." + }, + { + "toolField": "file_path", + "sourceKind": "local", + "localRole": "Absolute regular-file source path used only to create a protected immutable snapshot with exact file name, size, SHA-256 and inspected media facts; never sent to Apple or retained in the journal." + }, + { + "toolField": "resume_operation_id", + "sourceKind": "local", + "localRole": "Account/app-bound predecessor operation ID. Only a confirmed reservation awaiting upload with identical snapshot metadata/hash can resume; no new POST reservation is allowed." + }, + { + "toolField": "category", + "sourceKind": "local", + "localRole": "Validated immutable asset category used to select live media requirements and stored for later reservation; no Apple write occurs during preparation." + }, + { + "toolField": "reference_name", + "sourceKind": "local", + "localRole": "Optional reference metadata stored for execution; missing upload name gets a unique local identifier, explicit null clears update_reference_name, omission does not mutate an existing name." + }, + { + "toolField": "preview_frame_time_code", + "sourceKind": "local", + "localRole": "Validated video timestamp stored for reservation or a separate poster update; inspected duration/FPS bound the value." + }, + { + "toolField": "target_type", + "sourceKind": "local", + "localRole": "Exactly one allowlisted localization type, checked through its app ownership chain and editability; the resulting type is stored in the preview." + }, + { + "toolField": "target_id", + "sourceKind": "local", + "localRole": "Canonical target localization ID checked through its parent chain, or derived from the existing placement for replacement/deletion." + }, + { + "toolField": "placement_type", + "sourceKind": "local", + "localRole": "Live-catalog placement type checked against feature, category, group and spec before storing the prepared change." + }, + { + "toolField": "placement_group", + "sourceKind": "local", + "localRole": "Live-catalog group checked against platform, capacity and exact complete membership before storing the prepared change." + }, + { + "toolField": "placement_id", + "sourceKind": "local", + "localRole": "Canonical existing placement for replace/delete; its sole target and exact current membership are derived from Apple before snapshotting state." + }, + { + "toolField": "ordered_placement_ids", + "sourceKind": "local", + "localRole": "Complete unique group membership in requested order. Event ordering is rejected; replacement records current order for later substitution." + }, + { + "toolField": "submission_id", + "sourceKind": "local", + "localRole": "Canonical editable submission ID whose app, platform, approved version and active item participation are verified before storing the prepared action." + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryRefData_getCollection", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_images_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_videos_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryPlacements_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEventLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEventLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageVersions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPages_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatments_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentsV2_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEvents_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "apps_appEvents_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "apps_appStoreVersions_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "reviewSubmissions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "reviewSubmissions_getCollection", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "reviewSubmissions_items_getToManyRelated", "statusCode": "200", "mediaType": "application/json"} + { + "operationId": "apps_assetLibrary_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryRefData_getCollection", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_images_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_videos_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryPlacements_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEventLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEventLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatments_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentsV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEvents_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appEvents_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appStoreVersions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissions_getCollection", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissions_items_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "retentionMessageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_retentionMessages_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "True only after safe preparation without Apple writes."}, - {"outputField": "preview_id", "localRole": "Opaque single-use identifier bound to account, process session, action, snapshot and remote baseline for ten minutes."}, - {"outputField": "operation_id", "localRole": "Private journal operation identifier available before any remote mutation."}, - {"outputField": "expires_at", "localRole": "Preview expiry timestamp."}, - {"outputField": "changes", "localRole": "Exact prepared typed action, fingerprinted remote baseline, snapshot identity and non-atomic replacement/recovery warnings; no file contents, source path or signed URLs."}, - {"outputField": "writes_performed", "localRole": "Always false; only local snapshot/journal state and Apple GET requests are performed."}, - {"outputField": "apply_tool", "localRole": "assets_apply_change"}, - {"outputField": "approval_note", "localRole": "MCP client remains responsible for human approval of execution."} + { + "outputField": "success", + "localRole": "True only after safe preparation without Apple writes." + }, + { + "outputField": "preview_id", + "localRole": "Opaque single-use identifier bound to account, process session, action, snapshot and remote baseline for ten minutes." + }, + { + "outputField": "operation_id", + "localRole": "Private journal operation identifier available before any remote mutation." + }, + { + "outputField": "expires_at", + "localRole": "Preview expiry timestamp." + }, + { + "outputField": "changes", + "localRole": "Exact prepared typed action, fingerprinted remote baseline, snapshot identity and non-atomic replacement/recovery warnings; no file contents, source path or signed URLs." + }, + { + "outputField": "writes_performed", + "localRole": "Always false; only local snapshot/journal state and Apple GET requests are performed." + }, + { + "outputField": "apply_tool", + "localRole": "assets_apply_change" + }, + { + "outputField": "approval_note", + "localRole": "MCP client remains responsible for human approval of execution." + } ] }, "note": "Prepares only allowlisted actions. All media, ownership, catalog, parent editability, affected placement and review checks happen before a ten-minute single-use preview is issued. Snapshot capacity, size and transfer bounds are enforced locally. Upload and placement remain separate actions. Resume binds a confirmed existing reservation to identical file metadata and SHA-256; uncertain creation candidates cannot be resumed or automatically deleted." @@ -1619,7 +5949,16 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "apps_assetLibrary_getToOneRelated:validated-ownership-chain"], "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "apps_assetLibrary_getToOneRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + } ] }, { @@ -1629,7 +5968,16 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appAssetLibraries_getInstance:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appAssetLibraries_getInstance:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ] }, { @@ -1639,10 +5987,34 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementTypes]", "disposition": "intentionallyOmitted", "reason": "Write preparation refreshes the complete live catalog so that feature, group and specification relationships can be validated together.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementProfileGroups]", "disposition": "intentionallyOmitted", "reason": "Write preparation requires the full placement profile groups and their feature/specification relationships.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[features]", "disposition": "intentionallyOmitted", "reason": "Write preparation requires the full catalog to reject missing or unsupported feature relationships.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specs]", "disposition": "intentionallyOmitted", "reason": "Write preparation validates actual media against every specification allowed by the selected feature/group/category.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementTypes]", + "disposition": "intentionallyOmitted", + "reason": "Write preparation refreshes the complete live catalog so that feature, group and specification relationships can be validated together.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementProfileGroups]", + "disposition": "intentionallyOmitted", + "reason": "Write preparation requires the full placement profile groups and their feature/specification relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[features]", + "disposition": "intentionallyOmitted", + "reason": "Write preparation requires the full catalog to reject missing or unsupported feature relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specs]", + "disposition": "intentionallyOmitted", + "reason": "Write preparation validates actual media against every specification allowed by the selected feature/group/category.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1652,18 +6024,82 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appAssetLibraries_images_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appAssetLibraries_images_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[category]", "disposition": "intentionallyOmitted", "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specId]", "disposition": "intentionallyOmitted", "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[category]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[referenceName]", + "disposition": "intentionallyOmitted", + "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specId]", + "disposition": "intentionallyOmitted", + "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1673,18 +6109,82 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[category]", "disposition": "intentionallyOmitted", "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specId]", "disposition": "intentionallyOmitted", "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[category]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[referenceName]", + "disposition": "intentionallyOmitted", + "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specId]", + "disposition": "intentionallyOmitted", + "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1694,11 +6194,32 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appAssetLibraryImages_getInstance:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appAssetLibraryImages_getInstance:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1708,11 +6229,32 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appAssetLibraryVideos_getInstance:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appAssetLibraryVideos_getInstance:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1722,21 +6264,108 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appAssetLibraryImages_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appAssetLibraryImages_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1746,21 +6375,108 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appAssetLibraryVideos_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appAssetLibraryVideos_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1770,8 +6486,25 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appAssetLibraryPlacements_getInstance:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Use all six supported asset/localization relationships for ownership and placement verification; omit include for contentless-deletion absence checks.", "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appAssetLibraryPlacements_getInstance:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Use all six supported asset/localization relationships for ownership and placement verification; omit include for contentless-deletion absence checks.", + "location": "query", + "appleName": "include" + } ] }, { @@ -1781,21 +6514,109 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appStoreVersionLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appStoreVersionLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1805,21 +6626,109 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appCustomProductPageLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appCustomProductPageLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1829,21 +6738,109 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1853,21 +6850,109 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appEventLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appEventLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1877,14 +6962,54 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appStoreVersionLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersion"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appStoreVersionLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersion" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1894,14 +7019,54 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appCustomProductPageLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appCustomProductPageVersion"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appCustomProductPageLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appCustomProductPageVersion" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1911,13 +7076,47 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appStoreVersionExperimentTreatmentLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersionExperimentTreatment"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appStoreVersionExperimentTreatmentLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersionExperimentTreatment" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1927,13 +7126,47 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appEventLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appEvent"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appEventLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appEvent" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appEventScreenshots]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appEventVideoClips]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appEventScreenshots]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEventVideoClips]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1943,13 +7176,47 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appStoreVersions_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appStoreVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1959,11 +7226,33 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appCustomProductPageVersions_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appCustomProductPage"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appCustomProductPageVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appCustomProductPage" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appCustomProductPageLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appCustomProductPageLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1973,11 +7262,33 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appCustomProductPages_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appCustomProductPages_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appCustomProductPageVersions]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appCustomProductPageVersions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1987,11 +7298,33 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appStoreVersionExperimentTreatments_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersionExperimentV2"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appStoreVersionExperimentTreatments_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersionExperimentV2" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2001,12 +7334,40 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appStoreVersionExperimentsV2_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appStoreVersionExperimentsV2_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperimentTreatments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[controlVersions]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[controlVersions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2016,11 +7377,32 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appEvents_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appEvents_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2030,14 +7412,55 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "apps_appEvents_getToManyRelated:validated-ownership-chain"], "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appEvents_getInstance:/data/id"], "localRole": "Single event ID from the localization parent, verified in this app before accepting ownership.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "apps_appEvents_getToManyRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appEvents_getInstance:/data/id" + ], + "localRole": "Single event ID from the localization parent, verified in this app before accepting ownership.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[eventState]", "disposition": "intentionallyOmitted", "reason": "Event ownership is independent of event state; the matched event is validated after the app-scoped lookup.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[eventState]", + "disposition": "intentionallyOmitted", + "reason": "Event ownership is independent of event state; the matched event is validated after the app-scoped lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2047,19 +7470,90 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "apps_appStoreVersions_getToManyRelated:validated-ownership-chain"], "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "reviewSubmissions_getInstance:/data/attributes/platform"], "localRole": "For review preflight use the verified submission platform; for localization platform fallback omit the filter and inspect all app versions.", "location": "query", "appleName": "filter[platform]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "apps_appStoreVersions_getToManyRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "reviewSubmissions_getInstance:/data/attributes/platform" + ], + "localRole": "For review preflight use the verified submission platform; for localization platform fallback omit the filter and inspect all app versions.", + "location": "query", + "appleName": "filter[platform]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[versionString]", "disposition": "intentionallyOmitted", "reason": "Ownership and approved-version checks inspect all versions rather than selecting a marketing version.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreState]", "disposition": "intentionallyOmitted", "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or legacy-state resources.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appVersionState]", "disposition": "intentionallyOmitted", "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or future-state resources.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[versionString]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and approved-version checks inspect all versions rather than selecting a marketing version.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreState]", + "disposition": "intentionallyOmitted", + "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or legacy-state resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appVersionState]", + "disposition": "intentionallyOmitted", + "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or future-state resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2069,11 +7563,33 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "reviewSubmissions_getInstance:validated-ownership-chain"], "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "reviewSubmissions_getInstance:validated-ownership-chain" + ], + "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[items]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[items]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2083,14 +7599,51 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Exactly one verified app ID; enumerate active submissions locally without a state filter.", "location": "query", "appleName": "filter[app]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Exactly one verified app ID; enumerate active submissions locally without a state filter.", + "location": "query", + "appleName": "filter[app]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[platform]", "disposition": "intentionallyOmitted", "reason": "The complete app inventory is required; platform is checked from the selected parent or submission.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[items]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[platform]", + "disposition": "intentionallyOmitted", + "reason": "The complete app inventory is required; platform is checked from the selected parent or submission.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[items]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2100,9 +7653,31 @@ "role": "supporting", "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "reviewSubmissions_items_getToManyRelated:validated-ownership-chain"], "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appAssetLibraryImage", "appAssetLibraryVideo"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "reviewSubmissions_items_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appAssetLibraryImage", + "appAssetLibraryVideo" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ] }, { @@ -2112,16 +7687,70 @@ "role": "primary", "condition": "Fresh image upload only, after preview consumption and baseline revalidation. Never called when resuming a known reservation; lost reservation responses are reconciled without replaying creation.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryImages", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "immutable file snapshot"], "localRole": "Immutable snapshot file name.", "jsonPointer": "/data/attributes/fileName"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "immutable file snapshot"], "localRole": "Immutable snapshot byte count; bounded to 2 GiB.", "jsonPointer": "/data/attributes/fileSize"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "immutable file snapshot"], "localRole": "Validated prepared immutable category.", "jsonPointer": "/data/attributes/category"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "immutable file snapshot"], "localRole": "Prepared explicit reference name or generated unique marker; never a new apply argument.", "jsonPointer": "/data/attributes/referenceName"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraries", "jsonPointer": "/data/relationships/assetLibrary/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "apps_assetLibrary_getToOneRelated:/data/id"], "localRole": "Exact library ID captured and rechecked for this app before reservation.", "jsonPointer": "/data/relationships/assetLibrary/data/id"} + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryImages", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "immutable file snapshot" + ], + "localRole": "Immutable snapshot file name.", + "jsonPointer": "/data/attributes/fileName" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "immutable file snapshot" + ], + "localRole": "Immutable snapshot byte count; bounded to 2 GiB.", + "jsonPointer": "/data/attributes/fileSize" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "immutable file snapshot" + ], + "localRole": "Validated prepared immutable category.", + "jsonPointer": "/data/attributes/category" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "immutable file snapshot" + ], + "localRole": "Prepared explicit reference name or generated unique marker; never a new apply argument.", + "jsonPointer": "/data/attributes/referenceName" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraries", + "jsonPointer": "/data/relationships/assetLibrary/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "apps_assetLibrary_getToOneRelated:/data/id" + ], + "localRole": "Exact library ID captured and rechecked for this app before reservation.", + "jsonPointer": "/data/relationships/assetLibrary/data/id" + } ], "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/relationships/placements", "disposition": "intentionallyOmitted", "reason": "Uploads never attach placements in the reservation. Reuse or placement requires a separate prepared action after processing succeeds.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/relationships/placements", + "disposition": "intentionallyOmitted", + "reason": "Uploads never attach placements in the reservation. Reuse or placement requires a separate prepared action after processing succeeds.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2131,17 +7760,78 @@ "role": "conditional", "condition": "Fresh video upload only, after preview consumption and baseline revalidation. Never called when resuming a known reservation; lost reservation responses are reconciled without replaying creation.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryVideos", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "immutable file snapshot"], "localRole": "Immutable snapshot file name.", "jsonPointer": "/data/attributes/fileName"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "immutable file snapshot"], "localRole": "Immutable snapshot byte count; bounded to 2 GiB.", "jsonPointer": "/data/attributes/fileSize"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "immutable file snapshot"], "localRole": "Validated prepared immutable category.", "jsonPointer": "/data/attributes/category"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "immutable file snapshot"], "localRole": "Prepared explicit reference name or generated unique marker; never a new apply argument.", "jsonPointer": "/data/attributes/referenceName"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Prepared validated optional video poster timestamp; omitted when not provided.", "jsonPointer": "/data/attributes/previewFrameTimeCode"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraries", "jsonPointer": "/data/relationships/assetLibrary/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "apps_assetLibrary_getToOneRelated:/data/id"], "localRole": "Exact library ID captured and rechecked for this app before reservation.", "jsonPointer": "/data/relationships/assetLibrary/data/id"} + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryVideos", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "immutable file snapshot" + ], + "localRole": "Immutable snapshot file name.", + "jsonPointer": "/data/attributes/fileName" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "immutable file snapshot" + ], + "localRole": "Immutable snapshot byte count; bounded to 2 GiB.", + "jsonPointer": "/data/attributes/fileSize" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "immutable file snapshot" + ], + "localRole": "Validated prepared immutable category.", + "jsonPointer": "/data/attributes/category" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "immutable file snapshot" + ], + "localRole": "Prepared explicit reference name or generated unique marker; never a new apply argument.", + "jsonPointer": "/data/attributes/referenceName" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Prepared validated optional video poster timestamp; omitted when not provided.", + "jsonPointer": "/data/attributes/previewFrameTimeCode" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraries", + "jsonPointer": "/data/relationships/assetLibrary/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "apps_assetLibrary_getToOneRelated:/data/id" + ], + "localRole": "Exact library ID captured and rechecked for this app before reservation.", + "jsonPointer": "/data/relationships/assetLibrary/data/id" + } ], "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/relationships/placements", "disposition": "intentionallyOmitted", "reason": "Uploads never attach placements in the reservation. Reuse or placement requires a separate prepared action after processing succeeds.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/relationships/placements", + "disposition": "intentionallyOmitted", + "reason": "Uploads never attach placements in the reservation. Reuse or placement requires a separate prepared action after processing succeeds.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2151,15 +7841,52 @@ "role": "conditional", "condition": "Only commit_upload for the selected media kind after consuming preview_id and revalidating state. This PATCH emits only uploaded; every other optional attribute is absent. Ambiguous responses require GET reconciliation without replay.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryImages", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", "jsonPointer": "/data/id"}, - {"sourceKind": "fixed", "fixedValue": true, "jsonPointer": "/data/attributes/uploaded"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryImages", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", + "jsonPointer": "/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": true, + "jsonPointer": "/data/attributes/uploaded" + } ], "invocationId": "appAssetLibraryImages_commit_upload", "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/attributes/archived", "disposition": "intentionallyOmitted", "reason": "This commit_upload PATCH must not change archived; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/referenceName", "disposition": "intentionallyOmitted", "reason": "This commit_upload PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/attributes/archived", + "disposition": "intentionallyOmitted", + "reason": "This commit_upload PATCH must not change archived; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/referenceName", + "disposition": "intentionallyOmitted", + "reason": "This commit_upload PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2169,15 +7896,52 @@ "role": "conditional", "condition": "Only archive_asset for the selected media kind after consuming preview_id and revalidating state. This PATCH emits only archived; every other optional attribute is absent. Ambiguous responses require GET reconciliation without replay.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryImages", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", "jsonPointer": "/data/id"}, - {"sourceKind": "fixed", "fixedValue": true, "jsonPointer": "/data/attributes/archived"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryImages", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", + "jsonPointer": "/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": true, + "jsonPointer": "/data/attributes/archived" + } ], "invocationId": "appAssetLibraryImages_archive_asset", "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/attributes/uploaded", "disposition": "intentionallyOmitted", "reason": "This archive_asset PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/referenceName", "disposition": "intentionallyOmitted", "reason": "This archive_asset PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/attributes/uploaded", + "disposition": "intentionallyOmitted", + "reason": "This archive_asset PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/referenceName", + "disposition": "intentionallyOmitted", + "reason": "This archive_asset PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2187,15 +7951,52 @@ "role": "conditional", "condition": "Only unarchive_asset for the selected media kind after consuming preview_id and revalidating state. This PATCH emits only archived; every other optional attribute is absent. Ambiguous responses require GET reconciliation without replay.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryImages", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", "jsonPointer": "/data/id"}, - {"sourceKind": "fixed", "fixedValue": false, "jsonPointer": "/data/attributes/archived"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryImages", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", + "jsonPointer": "/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": false, + "jsonPointer": "/data/attributes/archived" + } ], "invocationId": "appAssetLibraryImages_unarchive_asset", "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/attributes/uploaded", "disposition": "intentionallyOmitted", "reason": "This unarchive_asset PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/referenceName", "disposition": "intentionallyOmitted", "reason": "This unarchive_asset PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/attributes/uploaded", + "disposition": "intentionallyOmitted", + "reason": "This unarchive_asset PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/referenceName", + "disposition": "intentionallyOmitted", + "reason": "This unarchive_asset PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2205,15 +8006,55 @@ "role": "conditional", "condition": "Only update_reference_name for the selected media kind after consuming preview_id and revalidating state. This PATCH emits only referenceName; every other optional attribute is absent. Ambiguous responses require GET reconciliation without replay.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryImages", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", "jsonPointer": "/data/id"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Prepared reference name (including explicit null) or validated video poster timestamp for this typed action only.", "jsonPointer": "/data/attributes/referenceName"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryImages", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", + "jsonPointer": "/data/id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Prepared reference name (including explicit null) or validated video poster timestamp for this typed action only.", + "jsonPointer": "/data/attributes/referenceName" + } ], "invocationId": "appAssetLibraryImages_update_reference_name", "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/attributes/uploaded", "disposition": "intentionallyOmitted", "reason": "This update_reference_name PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/archived", "disposition": "intentionallyOmitted", "reason": "This update_reference_name PATCH must not change archived; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/attributes/uploaded", + "disposition": "intentionallyOmitted", + "reason": "This update_reference_name PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/archived", + "disposition": "intentionallyOmitted", + "reason": "This update_reference_name PATCH must not change archived; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2223,16 +8064,59 @@ "role": "conditional", "condition": "Only commit_upload for the selected media kind after consuming preview_id and revalidating state. This PATCH emits only uploaded; every other optional attribute is absent. Ambiguous responses require GET reconciliation without replay.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryVideos", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", "jsonPointer": "/data/id"}, - {"sourceKind": "fixed", "fixedValue": true, "jsonPointer": "/data/attributes/uploaded"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryVideos", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", + "jsonPointer": "/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": true, + "jsonPointer": "/data/attributes/uploaded" + } ], "invocationId": "appAssetLibraryVideos_commit_upload", "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/attributes/archived", "disposition": "intentionallyOmitted", "reason": "This commit_upload PATCH must not change archived; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/referenceName", "disposition": "intentionallyOmitted", "reason": "This commit_upload PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/previewFrameTimeCode", "disposition": "intentionallyOmitted", "reason": "This commit_upload PATCH must not change previewFrameTimeCode; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/attributes/archived", + "disposition": "intentionallyOmitted", + "reason": "This commit_upload PATCH must not change archived; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/referenceName", + "disposition": "intentionallyOmitted", + "reason": "This commit_upload PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/previewFrameTimeCode", + "disposition": "intentionallyOmitted", + "reason": "This commit_upload PATCH must not change previewFrameTimeCode; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2242,16 +8126,59 @@ "role": "conditional", "condition": "Only archive_asset for the selected media kind after consuming preview_id and revalidating state. This PATCH emits only archived; every other optional attribute is absent. Ambiguous responses require GET reconciliation without replay.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryVideos", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", "jsonPointer": "/data/id"}, - {"sourceKind": "fixed", "fixedValue": true, "jsonPointer": "/data/attributes/archived"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryVideos", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", + "jsonPointer": "/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": true, + "jsonPointer": "/data/attributes/archived" + } ], "invocationId": "appAssetLibraryVideos_archive_asset", "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/attributes/uploaded", "disposition": "intentionallyOmitted", "reason": "This archive_asset PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/referenceName", "disposition": "intentionallyOmitted", "reason": "This archive_asset PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/previewFrameTimeCode", "disposition": "intentionallyOmitted", "reason": "This archive_asset PATCH must not change previewFrameTimeCode; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/attributes/uploaded", + "disposition": "intentionallyOmitted", + "reason": "This archive_asset PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/referenceName", + "disposition": "intentionallyOmitted", + "reason": "This archive_asset PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/previewFrameTimeCode", + "disposition": "intentionallyOmitted", + "reason": "This archive_asset PATCH must not change previewFrameTimeCode; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2261,16 +8188,59 @@ "role": "conditional", "condition": "Only unarchive_asset for the selected media kind after consuming preview_id and revalidating state. This PATCH emits only archived; every other optional attribute is absent. Ambiguous responses require GET reconciliation without replay.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryVideos", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", "jsonPointer": "/data/id"}, - {"sourceKind": "fixed", "fixedValue": false, "jsonPointer": "/data/attributes/archived"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryVideos", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", + "jsonPointer": "/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": false, + "jsonPointer": "/data/attributes/archived" + } ], "invocationId": "appAssetLibraryVideos_unarchive_asset", "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/attributes/uploaded", "disposition": "intentionallyOmitted", "reason": "This unarchive_asset PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/referenceName", "disposition": "intentionallyOmitted", "reason": "This unarchive_asset PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/previewFrameTimeCode", "disposition": "intentionallyOmitted", "reason": "This unarchive_asset PATCH must not change previewFrameTimeCode; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/attributes/uploaded", + "disposition": "intentionallyOmitted", + "reason": "This unarchive_asset PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/referenceName", + "disposition": "intentionallyOmitted", + "reason": "This unarchive_asset PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/previewFrameTimeCode", + "disposition": "intentionallyOmitted", + "reason": "This unarchive_asset PATCH must not change previewFrameTimeCode; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2280,16 +8250,62 @@ "role": "conditional", "condition": "Only update_reference_name for the selected media kind after consuming preview_id and revalidating state. This PATCH emits only referenceName; every other optional attribute is absent. Ambiguous responses require GET reconciliation without replay.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryVideos", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", "jsonPointer": "/data/id"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Prepared reference name (including explicit null) or validated video poster timestamp for this typed action only.", "jsonPointer": "/data/attributes/referenceName"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryVideos", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", + "jsonPointer": "/data/id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Prepared reference name (including explicit null) or validated video poster timestamp for this typed action only.", + "jsonPointer": "/data/attributes/referenceName" + } ], "invocationId": "appAssetLibraryVideos_update_reference_name", "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/attributes/uploaded", "disposition": "intentionallyOmitted", "reason": "This update_reference_name PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/archived", "disposition": "intentionallyOmitted", "reason": "This update_reference_name PATCH must not change archived; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/previewFrameTimeCode", "disposition": "intentionallyOmitted", "reason": "This update_reference_name PATCH must not change previewFrameTimeCode; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/attributes/uploaded", + "disposition": "intentionallyOmitted", + "reason": "This update_reference_name PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/archived", + "disposition": "intentionallyOmitted", + "reason": "This update_reference_name PATCH must not change archived; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/previewFrameTimeCode", + "disposition": "intentionallyOmitted", + "reason": "This update_reference_name PATCH must not change previewFrameTimeCode; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2299,16 +8315,62 @@ "role": "conditional", "condition": "Only update_video_poster for the selected media kind after consuming preview_id and revalidating state. This PATCH emits only previewFrameTimeCode; every other optional attribute is absent. Ambiguous responses require GET reconciliation without replay.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryVideos", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "confirmed reservation resource ID"], "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", "jsonPointer": "/data/id"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Prepared reference name (including explicit null) or validated video poster timestamp for this typed action only.", "jsonPointer": "/data/attributes/previewFrameTimeCode"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Only the canonical resource ID stored in the consumed preview or exact successful reservation response.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryVideos", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "confirmed reservation resource ID" + ], + "localRole": "Matches the exact path ID from the prepared asset or confirmed reservation.", + "jsonPointer": "/data/id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Prepared reference name (including explicit null) or validated video poster timestamp for this typed action only.", + "jsonPointer": "/data/attributes/previewFrameTimeCode" + } ], "invocationId": "appAssetLibraryVideos_update_video_poster", "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/attributes/uploaded", "disposition": "intentionallyOmitted", "reason": "This update_video_poster PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/archived", "disposition": "intentionallyOmitted", "reason": "This update_video_poster PATCH must not change archived; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/attributes/referenceName", "disposition": "intentionallyOmitted", "reason": "This update_video_poster PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/attributes/uploaded", + "disposition": "intentionallyOmitted", + "reason": "This update_video_poster PATCH must not change uploaded; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/archived", + "disposition": "intentionallyOmitted", + "reason": "This update_video_poster PATCH must not change archived; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/referenceName", + "disposition": "intentionallyOmitted", + "reason": "This update_video_poster PATCH must not change referenceName; the separate typed action supplies its own preview and attribute.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2318,7 +8380,15 @@ "role": "conditional", "condition": "Only the explicitly previewed deletion, or known old placement removal during replacement. Asset deletion requires zero uses and a supported draft/failure state; there is no cascading deletion. Verify absence without replaying DELETE.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Exact asset or existing placement ID captured in the consumed preview. There is no automatic deletion of a reservation or diagnostic candidate.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Exact asset or existing placement ID captured in the consumed preview. There is no automatic deletion of a reservation or diagnostic candidate.", + "location": "path", + "appleName": "id" + } ] }, { @@ -2328,7 +8398,15 @@ "role": "conditional", "condition": "Only the explicitly previewed deletion, or known old placement removal during replacement. Asset deletion requires zero uses and a supported draft/failure state; there is no cascading deletion. Verify absence without replaying DELETE.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Exact asset or existing placement ID captured in the consumed preview. There is no automatic deletion of a reservation or diagnostic candidate.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Exact asset or existing placement ID captured in the consumed preview. There is no automatic deletion of a reservation or diagnostic candidate.", + "location": "path", + "appleName": "id" + } ] }, { @@ -2338,21 +8416,118 @@ "role": "conditional", "condition": "Create or replace placement only. Replacement may delete the known old placement first, so preview warns about the intermediate empty slot; failures preserve completed steps and never delete an unknown resource.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryPlacements", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Validated placement placementType from the consumed preview and fresh catalog/parent checks.", "jsonPointer": "/data/attributes/placementType"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Validated placement placementGroup from the consumed preview and fresh catalog/parent checks.", "jsonPointer": "/data/attributes/placementGroup"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryImages", "jsonPointer": "/data/relationships/image/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", "jsonPointer": "/data/relationships/image/data/id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryVideos", "jsonPointer": "/data/relationships/video/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", "jsonPointer": "/data/relationships/video/data/id"}, - {"sourceKind": "fixed", "fixedValue": "appStoreVersionLocalizations", "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id"}, - {"sourceKind": "fixed", "fixedValue": "appCustomProductPageLocalizations", "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/id"}, - {"sourceKind": "fixed", "fixedValue": "appStoreVersionExperimentTreatmentLocalizations", "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/id"}, - {"sourceKind": "fixed", "fixedValue": "appEventLocalizations", "jsonPointer": "/data/relationships/appEventLocalization/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", "jsonPointer": "/data/relationships/appEventLocalization/data/id"} + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryPlacements", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Validated placement placementType from the consumed preview and fresh catalog/parent checks.", + "jsonPointer": "/data/attributes/placementType" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Validated placement placementGroup from the consumed preview and fresh catalog/parent checks.", + "jsonPointer": "/data/attributes/placementGroup" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryImages", + "jsonPointer": "/data/relationships/image/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", + "jsonPointer": "/data/relationships/image/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryVideos", + "jsonPointer": "/data/relationships/video/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", + "jsonPointer": "/data/relationships/video/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appStoreVersionLocalizations", + "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", + "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appCustomProductPageLocalizations", + "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", + "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appStoreVersionExperimentTreatmentLocalizations", + "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", + "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appEventLocalizations", + "jsonPointer": "/data/relationships/appEventLocalization/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization; omit every unselected alternative.", + "jsonPointer": "/data/relationships/appEventLocalization/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": "retentionMessageVersions", + "jsonPointer": "/data/relationships/retentionMessageVersion/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Emit only for the selected relationship: exactly one processed app-owned asset and exactly one validated editable localization or retention message version; omit every unselected alternative.", + "jsonPointer": "/data/relationships/retentionMessageVersion/data/id" + } ] }, { @@ -2362,7 +8537,15 @@ "role": "conditional", "condition": "Only the explicitly previewed deletion, or known old placement removal during replacement. Asset deletion requires zero uses and a supported draft/failure state; there is no cascading deletion. Verify absence without replaying DELETE.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Exact asset or existing placement ID captured in the consumed preview. There is no automatic deletion of a reservation or diagnostic candidate.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Exact asset or existing placement ID captured in the consumed preview. There is no automatic deletion of a reservation or diagnostic candidate.", + "location": "path", + "appleName": "id" + } ] }, { @@ -2372,19 +8555,83 @@ "role": "conditional", "condition": "Explicit reorder or replacement order restoration on main-page, CPP or PPO only, after exact membership check and followed by full ordered readback. Event ordering is never emitted.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryPlacementOrderingRequests", "jsonPointer": "/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Exact group captured in preview and checked with complete membership before ordering.", "jsonPointer": "/data/attributes/placementGroup"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id", "appAssetLibraryPlacements_createInstance:/data/id"], "localRole": "Complete requested group order with canonical type appAssetLibraryPlacements for every item. Replacement substitutes the exact confirmed new placement ID into the captured order.", "jsonPointer": "/data/relationships/orderedPlacements/data"}, - {"sourceKind": "fixed", "fixedValue": "appStoreVersionLocalizations", "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Only the single selected main-page, CPP or PPO localization. Omit unselected alternatives; Event ordering is rejected.", "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id"}, - {"sourceKind": "fixed", "fixedValue": "appCustomProductPageLocalizations", "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Only the single selected main-page, CPP or PPO localization. Omit unselected alternatives; Event ordering is rejected.", "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/id"}, - {"sourceKind": "fixed", "fixedValue": "appStoreVersionExperimentTreatmentLocalizations", "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Only the single selected main-page, CPP or PPO localization. Omit unselected alternatives; Event ordering is rejected.", "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/id"} + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryPlacementOrderingRequests", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Exact group captured in preview and checked with complete membership before ordering.", + "jsonPointer": "/data/attributes/placementGroup" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "appAssetLibraryPlacements_createInstance:/data/id" + ], + "localRole": "Complete requested group order with canonical type appAssetLibraryPlacements for every item. Replacement substitutes the exact confirmed new placement ID into the captured order.", + "jsonPointer": "/data/relationships/orderedPlacements/data" + }, + { + "sourceKind": "fixed", + "fixedValue": "appStoreVersionLocalizations", + "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Only the single selected main-page, CPP or PPO localization. Omit unselected alternatives; Event ordering is rejected.", + "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appCustomProductPageLocalizations", + "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Only the single selected main-page, CPP or PPO localization. Omit unselected alternatives; Event ordering is rejected.", + "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appStoreVersionExperimentTreatmentLocalizations", + "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Only the single selected main-page, CPP or PPO localization. Omit unselected alternatives; Event ordering is rejected.", + "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[orderedPlacements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[orderedPlacements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2394,91 +8641,578 @@ "role": "conditional", "condition": "add_review_item only: app/platform/approved-version and active submission participation are rechecked. Read back the exact item; uncertain outcomes reconcile identity without a second POST. Attaching does not submit, approve or publish.", "inputs": [ - {"sourceKind": "fixed", "fixedValue": "reviewSubmissionItems", "jsonPointer": "/data/type"}, - {"sourceKind": "fixed", "fixedValue": "reviewSubmissions", "jsonPointer": "/data/relationships/reviewSubmission/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Prepared submission identity or exactly one matching image/video relationship; omit the unselected media alternative.", "jsonPointer": "/data/relationships/reviewSubmission/data/id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryImages", "jsonPointer": "/data/relationships/appAssetLibraryImage/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Prepared submission identity or exactly one matching image/video relationship; omit the unselected media alternative.", "jsonPointer": "/data/relationships/appAssetLibraryImage/data/id"}, - {"sourceKind": "fixed", "fixedValue": "appAssetLibraryVideos", "jsonPointer": "/data/relationships/appAssetLibraryVideo/data/type"}, - {"sourceKind": "derived", "derivedFrom": ["preview_id"], "localRole": "Prepared submission identity or exactly one matching image/video relationship; omit the unselected media alternative.", "jsonPointer": "/data/relationships/appAssetLibraryVideo/data/id"} - ], - "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/relationships/appStoreVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/appCustomProductPageVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/appStoreVersionExperiment", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/appStoreVersionExperimentV2", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/appEvent", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/backgroundAssetVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/gameCenterAchievementVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/gameCenterActivityVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/gameCenterChallengeVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/gameCenterLeaderboardSetVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/gameCenterLeaderboardVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/inAppPurchaseVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/subscriptionVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/subscriptionGroupVersion", "disposition": "intentionallyOmitted", "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", "reviewAtSpec": "4.5.1"} + { + "sourceKind": "fixed", + "fixedValue": "reviewSubmissionItems", + "jsonPointer": "/data/type" + }, + { + "sourceKind": "fixed", + "fixedValue": "reviewSubmissions", + "jsonPointer": "/data/relationships/reviewSubmission/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Prepared submission identity or exactly one matching image/video relationship; omit the unselected media alternative.", + "jsonPointer": "/data/relationships/reviewSubmission/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryImages", + "jsonPointer": "/data/relationships/appAssetLibraryImage/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Prepared submission identity or exactly one matching image/video relationship; omit the unselected media alternative.", + "jsonPointer": "/data/relationships/appAssetLibraryImage/data/id" + }, + { + "sourceKind": "fixed", + "fixedValue": "appAssetLibraryVideos", + "jsonPointer": "/data/relationships/appAssetLibraryVideo/data/type" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id" + ], + "localRole": "Prepared submission identity or exactly one matching image/video relationship; omit the unselected media alternative.", + "jsonPointer": "/data/relationships/appAssetLibraryVideo/data/id" + } + ], + "optionalParameterClassifications": [ + { + "location": "body", + "appleName": "/data/relationships/appStoreVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/appCustomProductPageVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/appStoreVersionExperiment", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/appStoreVersionExperimentV2", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/appEvent", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/backgroundAssetVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterAchievementVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterActivityVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterChallengeVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterLeaderboardSetVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterLeaderboardVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/inAppPurchaseVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/subscriptionVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/subscriptionGroupVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/retentionMessageVersion", + "disposition": "intentionallyOmitted", + "reason": "Asset preview execution only attaches one library image or video. Existing review_submissions_add_item retains its separate legacy-resource contract.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}/placement", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "retentionMessageVersions_placement_getToOneRelated:validated-ownership-chain" + ], + "localRole": "Exact retention message version ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + } + ] + }, + { + "operationId": "retentionMessageVersions_getInstance", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "retentionMessageVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact retention message version ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "retentionMessage" + ], + "location": "query", + "appleName": "include" + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "operationId": "apps_retentionMessages_getToManyRelated", + "method": "get", + "path": "/v1/apps/{id}/retentionMessages", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "derived", + "derivedFrom": [ + "preview_id", + "apps_retentionMessages_getToManyRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[versions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - {"toolField": "preview_id", "sourceKind": "local", "localRole": "Opaque single-use receipt only. Consume once in the same account and process session before revalidating the stored baseline. Action, IDs, file snapshot, attributes and relationships cannot be supplied or overridden at execution."} + { + "toolField": "preview_id", + "sourceKind": "local", + "localRole": "Opaque single-use receipt only. Consume once in the same account and process session before revalidating the stored baseline. Action, IDs, file snapshot, attributes and relationships cannot be supplied or overridden at execution." + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryRefData_getCollection", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_images_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_videos_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryPlacements_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEventLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEventLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageVersions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPages_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatments_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentsV2_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEvents_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "apps_appEvents_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "apps_appStoreVersions_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "reviewSubmissions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "reviewSubmissions_getCollection", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "reviewSubmissions_items_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_createInstance", "statusCode": "201", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_createInstance", "statusCode": "201", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_updateInstance", "statusCode": "200", "invocationIds": ["appAssetLibraryImages_commit_upload"], "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_updateInstance", "statusCode": "200", "invocationIds": ["appAssetLibraryImages_archive_asset"], "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_updateInstance", "statusCode": "200", "invocationIds": ["appAssetLibraryImages_unarchive_asset"], "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_updateInstance", "statusCode": "200", "invocationIds": ["appAssetLibraryImages_update_reference_name"], "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_updateInstance", "statusCode": "200", "invocationIds": ["appAssetLibraryVideos_commit_upload"], "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_updateInstance", "statusCode": "200", "invocationIds": ["appAssetLibraryVideos_archive_asset"], "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_updateInstance", "statusCode": "200", "invocationIds": ["appAssetLibraryVideos_unarchive_asset"], "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_updateInstance", "statusCode": "200", "invocationIds": ["appAssetLibraryVideos_update_reference_name"], "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_updateInstance", "statusCode": "200", "invocationIds": ["appAssetLibraryVideos_update_video_poster"], "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_deleteInstance", "statusCode": "204"}, - {"operationId": "appAssetLibraryVideos_deleteInstance", "statusCode": "204"}, - {"operationId": "appAssetLibraryPlacements_createInstance", "statusCode": "201", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryPlacements_deleteInstance", "statusCode": "204"}, - {"operationId": "appAssetLibraryPlacementOrderingRequests_createInstance", "statusCode": "201", "mediaType": "application/json"}, - {"operationId": "reviewSubmissionItems_createInstance", "statusCode": "201", "mediaType": "application/json"} + { + "operationId": "apps_assetLibrary_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryRefData_getCollection", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_images_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_videos_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryPlacements_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEventLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEventLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatments_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentsV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEvents_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appEvents_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appStoreVersions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissions_getCollection", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissions_items_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_updateInstance", + "statusCode": "200", + "invocationIds": [ + "appAssetLibraryImages_commit_upload" + ], + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_updateInstance", + "statusCode": "200", + "invocationIds": [ + "appAssetLibraryImages_archive_asset" + ], + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_updateInstance", + "statusCode": "200", + "invocationIds": [ + "appAssetLibraryImages_unarchive_asset" + ], + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_updateInstance", + "statusCode": "200", + "invocationIds": [ + "appAssetLibraryImages_update_reference_name" + ], + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_updateInstance", + "statusCode": "200", + "invocationIds": [ + "appAssetLibraryVideos_commit_upload" + ], + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_updateInstance", + "statusCode": "200", + "invocationIds": [ + "appAssetLibraryVideos_archive_asset" + ], + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_updateInstance", + "statusCode": "200", + "invocationIds": [ + "appAssetLibraryVideos_unarchive_asset" + ], + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_updateInstance", + "statusCode": "200", + "invocationIds": [ + "appAssetLibraryVideos_update_reference_name" + ], + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_updateInstance", + "statusCode": "200", + "invocationIds": [ + "appAssetLibraryVideos_update_video_poster" + ], + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_deleteInstance", + "statusCode": "204" + }, + { + "operationId": "appAssetLibraryVideos_deleteInstance", + "statusCode": "204" + }, + { + "operationId": "appAssetLibraryPlacements_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryPlacements_deleteInstance", + "statusCode": "204" + }, + { + "operationId": "appAssetLibraryPlacementOrderingRequests_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissionItems_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "retentionMessageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_retentionMessages_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "True for confirmed success or explicitly processing_pending; false with isError for failed or unresolved operations."}, - {"outputField": "operation", "localRole": "Sanitized account-scoped journal: prepared change/fingerprint, operation status, confirmed resource IDs, completed and pending steps, timestamps and recovery guidance. No JWT, private keys, signed URLs, source paths or file contents."}, - {"outputField": "retry_safe", "localRole": "Always false: callers must inspect the known operation before preparing any further action."}, - {"outputField": "inspect_tool", "localRole": "assets_get_operation"}, - {"outputField": "error", "localRole": "Safe diagnostic present for failed or unresolved operation status."} + { + "outputField": "success", + "localRole": "True for confirmed success or explicitly processing_pending; false with isError for failed or unresolved operations." + }, + { + "outputField": "operation", + "localRole": "Sanitized account-scoped journal: prepared change/fingerprint, operation status, confirmed resource IDs, completed and pending steps, timestamps and recovery guidance. No JWT, private keys, signed URLs, source paths or file contents." + }, + { + "outputField": "retry_safe", + "localRole": "Always false: callers must inspect the known operation before preparing any further action." + }, + { + "outputField": "inspect_tool", + "localRole": "assets_get_operation" + }, + { + "outputField": "error", + "localRole": "Safe diagnostic present for failed or unresolved operation status." + } ] }, "note": "The sole asset write dispatcher accepts preview_id only. Before first write it consumes once and compares fresh material state with the preview baseline. Validated reservation URLs drive bounded transfers without ASC JWT or redirects; no caller URL/header/HTTP verb is accepted. The same one-time mechanism serves the new review_submissions_add_item form. Byte transfer, commit, processing, poster readiness, placement and review approval remain distinct. Unknown outcomes are journaled and reconciled with GETs; creation and ambiguous commit are not replayed. Successful known-reservation resume never issues a second reservation. Non-atomic replacements expose partial steps and require a separate prepared recovery action." @@ -2497,7 +9231,16 @@ "role": "primary", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "apps_assetLibrary_getToOneRelated:validated-ownership-chain"], "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "apps_assetLibrary_getToOneRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + } ] }, { @@ -2507,7 +9250,16 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appAssetLibraries_getInstance:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appAssetLibraries_getInstance:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + } ] }, { @@ -2517,18 +9269,82 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appAssetLibraries_images_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["operation_id"], "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appAssetLibraries_images_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id" + ], + "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[category]", "disposition": "intentionallyOmitted", "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specId]", "disposition": "intentionallyOmitted", "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[category]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[referenceName]", + "disposition": "intentionallyOmitted", + "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specId]", + "disposition": "intentionallyOmitted", + "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2538,18 +9354,82 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain"], "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["operation_id"], "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appAssetLibraries_videos_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Library ID returned by apps_assetLibrary_getToOneRelated for the requested app and re-read with exact resource identity validation.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id" + ], + "localRole": "Use the single canonical asset ID for ownership checks; omit this filter for complete upload/recovery inventory.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[category]", "disposition": "intentionallyOmitted", "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[specId]", "disposition": "intentionallyOmitted", "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[category]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and recovery inspect all asset categories; category is validated against the selected resource rather than used to hide membership.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[referenceName]", + "disposition": "intentionallyOmitted", + "reason": "Recovery compares exact file and reference metadata after reading the complete library; this filter could hide ambiguous candidates.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[specId]", + "disposition": "intentionallyOmitted", + "reason": "Processing and placement checks inspect the returned specId; prefiltering could hide an incompatible or pending asset.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "Asset ownership and recovery compare complete membership sets; list tools preserve Apple default order rather than expose an additional ordering contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2559,11 +9439,32 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appAssetLibraryImages_getInstance:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appAssetLibraryImages_getInstance:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2573,11 +9474,32 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appAssetLibraryVideos_getInstance:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appAssetLibraryVideos_getInstance:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2587,8 +9509,25 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appAssetLibraryPlacements_getInstance:validated-ownership-chain"], "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["operation_id"], "localRole": "Use all six supported asset/localization relationships for ownership and placement verification; omit include for contentless-deletion absence checks.", "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appAssetLibraryPlacements_getInstance:validated-ownership-chain" + ], + "localRole": "Exact resource ID from the selected asset/placement, confirmed reservation, consumed preview or account-scoped operation journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id" + ], + "localRole": "Use all six supported asset/localization relationships for ownership and placement verification; omit include for contentless-deletion absence checks.", + "location": "query", + "appleName": "include" + } ] }, { @@ -2598,21 +9537,109 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appStoreVersionLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appStoreVersionLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2622,21 +9649,109 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appCustomProductPageLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appCustomProductPageLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2646,21 +9761,109 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appEventLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appEventLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2670,21 +9873,109 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appEventLocalizations_placements_getToManyRelated:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["image", "video", "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": ["placementGroupPosition"], "location": "query", "appleName": "sort"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appEventLocalizations_placements_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "placementGroupPosition" + ], + "location": "query", + "appleName": "sort" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[placementType]", "disposition": "intentionallyOmitted", "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[placementGroup]", "disposition": "intentionallyOmitted", "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[image]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[video]", "disposition": "intentionallyOmitted", "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[placementType]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks inventory all placement types before enforcing the prepared placement constraints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[placementGroup]", + "disposition": "intentionallyOmitted", + "reason": "Safety checks read every placement group before calculating membership, exact ordering, capacity and affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "Inventory and recovery must retain resources in every Apple state, including failed and intermediate states.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[image]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[video]", + "disposition": "intentionallyOmitted", + "reason": "The selected endpoint fixes the asset or localization scope; complete membership is checked without a second asset filter.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "The parent endpoint or verified placement relationship supplies the localization scope; filtering would hide other affected uses.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2694,14 +9985,54 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appStoreVersionLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersion"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appStoreVersionLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersion" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2711,14 +10042,54 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appCustomProductPageLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appCustomProductPageVersion"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appCustomProductPageLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appCustomProductPageVersion" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2728,13 +10099,47 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appStoreVersionExperimentTreatmentLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersionExperimentTreatment"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appStoreVersionExperimentTreatmentLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersionExperimentTreatment" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2744,13 +10149,47 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appEventLocalizations_getInstance:validated-ownership-chain"], "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appEvent"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appEventLocalizations_getInstance:validated-ownership-chain" + ], + "localRole": "Exact localization ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appEvent" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appEventScreenshots]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appEventVideoClips]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appEventScreenshots]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEventVideoClips]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2760,13 +10199,47 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appStoreVersions_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appStoreVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2776,11 +10249,33 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appCustomProductPageVersions_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appCustomProductPage"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appCustomProductPageVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appCustomProductPage" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appCustomProductPageLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appCustomProductPageLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2790,11 +10285,33 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appCustomProductPages_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appCustomProductPages_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appCustomProductPageVersions]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appCustomProductPageVersions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2804,11 +10321,33 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appStoreVersionExperimentTreatments_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appStoreVersionExperimentV2"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appStoreVersionExperimentTreatments_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appStoreVersionExperimentV2" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2818,12 +10357,40 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appStoreVersionExperimentsV2_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appStoreVersionExperimentsV2_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[appStoreVersionExperimentTreatments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[controlVersions]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[controlVersions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2833,11 +10400,32 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appEvents_getInstance:validated-ownership-chain"], "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", "location": "path", "appleName": "id"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appEvents_getInstance:validated-ownership-chain" + ], + "localRole": "Exact parent ID from the validated localization ownership chain; CPP follows version to page and PPO follows treatment to v2 experiment.", + "location": "path", + "appleName": "id" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2847,14 +10435,55 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "apps_appEvents_getToManyRelated:validated-ownership-chain"], "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", "location": "path", "appleName": "id"}, - {"sourceKind": "derived", "derivedFrom": ["operation_id", "appEvents_getInstance:/data/id"], "localRole": "Single event ID from the localization parent, verified in this app before accepting ownership.", "location": "query", "appleName": "filter[id]"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "apps_appEvents_getToManyRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "appEvents_getInstance:/data/id" + ], + "localRole": "Single event ID from the localization parent, verified in this app before accepting ownership.", + "location": "query", + "appleName": "filter[id]" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[eventState]", "disposition": "intentionallyOmitted", "reason": "Event ownership is independent of event state; the matched event is validated after the app-scoped lookup.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[eventState]", + "disposition": "intentionallyOmitted", + "reason": "Event ownership is independent of event state; the matched event is validated after the app-scoped lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2864,19 +10493,87 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "apps_appStoreVersions_getToManyRelated:validated-ownership-chain"], "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "apps_appStoreVersions_getToManyRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "filter[platform]", "disposition": "intentionallyOmitted", "reason": "The complete app inventory is required; platform is checked from the selected parent or submission.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[versionString]", "disposition": "intentionallyOmitted", "reason": "Ownership and approved-version checks inspect all versions rather than selecting a marketing version.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appStoreState]", "disposition": "intentionallyOmitted", "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or legacy-state resources.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[appVersionState]", "disposition": "intentionallyOmitted", "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or future-state resources.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"}, - {"location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "filter[platform]", + "disposition": "intentionallyOmitted", + "reason": "The complete app inventory is required; platform is checked from the selected parent or submission.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[versionString]", + "disposition": "intentionallyOmitted", + "reason": "Ownership and approved-version checks inspect all versions rather than selecting a marketing version.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreState]", + "disposition": "intentionallyOmitted", + "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or legacy-state resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appVersionState]", + "disposition": "intentionallyOmitted", + "reason": "Approved-version and parent checks inspect states locally without hiding intermediate or future-state resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[id]", + "disposition": "intentionallyOmitted", + "reason": "This scoped collection is inventoried in full so that membership and concurrent changes remain observable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2886,11 +10583,33 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "reviewSubmissions_getInstance:validated-ownership-chain"], "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["app"], "location": "query", "appleName": "include"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "reviewSubmissions_getInstance:validated-ownership-chain" + ], + "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "app" + ], + "location": "query", + "appleName": "include" + } ], "optionalParameterClassifications": [ - {"location": "query", "appleName": "limit[items]", "disposition": "intentionallyOmitted", "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "limit[items]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] }, { @@ -2900,50 +10619,323 @@ "role": "supporting", "condition": "Only when the selected recorded recovery action traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", "inputs": [ - {"sourceKind": "derived", "derivedFrom": ["operation_id", "reviewSubmissions_items_getToManyRelated:validated-ownership-chain"], "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", "location": "path", "appleName": "id"}, - {"sourceKind": "fixed", "fixedValue": ["appAssetLibraryImage", "appAssetLibraryVideo"], "location": "query", "appleName": "include"}, - {"sourceKind": "fixed", "fixedValue": 200, "location": "query", "appleName": "limit"} + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "reviewSubmissions_items_getToManyRelated:validated-ownership-chain" + ], + "localRole": "Selected submission ID or active app-scoped submission ID; preview and reconciliation preserve the recorded submission identity.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "appAssetLibraryImage", + "appAssetLibraryVideo" + ], + "location": "query", + "appleName": "include" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } + ] + }, + { + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}/placement", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "retentionMessageVersions_placement_getToOneRelated:validated-ownership-chain" + ], + "localRole": "Exact retention message version ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ], + "location": "query", + "appleName": "include" + } + ] + }, + { + "operationId": "retentionMessageVersions_getInstance", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "retentionMessageVersions_getInstance:validated-ownership-chain" + ], + "localRole": "Exact retention message version ID from the typed target selector, validated placement relationship, consumed preview or stored journal.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": [ + "retentionMessage" + ], + "location": "query", + "appleName": "include" + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "operationId": "apps_retentionMessages_getToManyRelated", + "method": "get", + "path": "/v1/apps/{id}/retentionMessages", + "role": "supporting", + "condition": "Only when the selected typed action or resource selector traverses this resource. Ownership, inventory and state checks are GET-only; collection reads preserve exact query scope for at most 100 pages and 20,000 resources.", + "inputs": [ + { + "sourceKind": "derived", + "derivedFrom": [ + "operation_id", + "apps_retentionMessages_getToManyRelated:validated-ownership-chain" + ], + "localRole": "App ID from the validated request, consumed preview or account-scoped journal; never inferred from an arbitrary URL.", + "location": "path", + "appleName": "id" + }, + { + "sourceKind": "fixed", + "fixedValue": 200, + "location": "query", + "appleName": "limit" + } + ], + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Related collections are fetched separately with strict pagination when required. No expanded resources are requested on this operation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[versions]", + "disposition": "intentionallyOmitted", + "reason": "Expanded relationship pagination is not used. Required related collections are read through their own bounded, app-scoped endpoints.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - {"toolField": "operation_id", "sourceKind": "local", "localRole": "Opaque account-scoped local journal identifier. Active operations return their current journal; unresolved inactive operations may perform only GET reconciliation. Previous-process previews remain invalid; persisted resource IDs and fingerprints are diagnostic evidence, never authority for a new write."} + { + "toolField": "operation_id", + "sourceKind": "local", + "localRole": "Opaque account-scoped local journal identifier. Active operations return their current journal; unresolved inactive operations may perform only GET reconciliation. Previous-process previews remain invalid; persisted resource IDs and fingerprints are diagnostic evidence, never authority for a new write." + } ], "response": { "mode": "aggregate", "sources": [ - {"operationId": "apps_assetLibrary_getToOneRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_images_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraries_videos_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryImages_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryVideos_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appAssetLibraryPlacements_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEventLocalizations_placements_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEventLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPageVersions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appCustomProductPages_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentTreatments_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appStoreVersionExperimentsV2_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "appEvents_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "apps_appEvents_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "apps_appStoreVersions_getToManyRelated", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "reviewSubmissions_getInstance", "statusCode": "200", "mediaType": "application/json"}, - {"operationId": "reviewSubmissions_items_getToManyRelated", "statusCode": "200", "mediaType": "application/json"} + { + "operationId": "apps_assetLibrary_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_images_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraries_videos_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryImages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryVideos_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appAssetLibraryPlacements_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEventLocalizations_placements_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEventLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatments_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentsV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEvents_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appEvents_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appStoreVersions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissions_items_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "retentionMessageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_retentionMessages_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - {"outputField": "success", "localRole": "True for confirmed success or explicitly processing_pending; false with isError for failed or unresolved operations."}, - {"outputField": "operation", "localRole": "Sanitized account-scoped journal: prepared change/fingerprint, operation status, confirmed resource IDs, completed and pending steps, timestamps and recovery guidance. No JWT, private keys, signed URLs, source paths or file contents."}, - {"outputField": "retry_safe", "localRole": "Always false: callers must inspect the known operation before preparing any further action."}, - {"outputField": "inspect_tool", "localRole": "assets_get_operation"}, - {"outputField": "error", "localRole": "Safe diagnostic present for failed or unresolved operation status."} + { + "outputField": "success", + "localRole": "True for confirmed success or explicitly processing_pending; false with isError for failed or unresolved operations." + }, + { + "outputField": "operation", + "localRole": "Sanitized account-scoped journal: prepared change/fingerprint, operation status, confirmed resource IDs, completed and pending steps, timestamps and recovery guidance. No JWT, private keys, signed URLs, source paths or file contents." + }, + { + "outputField": "retry_safe", + "localRole": "Always false: callers must inspect the known operation before preparing any further action." + }, + { + "outputField": "inspect_tool", + "localRole": "assets_get_operation" + }, + { + "outputField": "error", + "localRole": "Safe diagnostic present for failed or unresolved operation status." + } ] }, "note": "Reads private local operation state and conditionally reconciles known Apple identities using GET only. Lost create responses can identify a diagnostic candidate but never attribute ownership or trigger replay, transfer or deletion. Known uploads require confirmed transfer/commit before processing can become success; otherwise prepare an explicit identical-file resume. Exact placement membership/order and review item identity are read back. Successful deletions require a GET 404; other errors remain unresolved. No write is emitted by reconciliation." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/auth.json b/Sources/asc-mcp/Resources/OperationManifest/tools/auth.json index 955589d..65e3d6c 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/auth.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/auth.json @@ -13,8 +13,14 @@ "mode": "local", "sources": [], "fields": [ - { "outputField": "success", "localRole": "JWTService.getToken completion" }, - { "outputField": "message", "localRole": "token generation confirmation; token value is intentionally not returned" } + { + "outputField": "success", + "localRole": "JWTService.getToken completion" + }, + { + "outputField": "message", + "localRole": "token generation confirmation; token value is intentionally not returned" + } ] }, "note": "Local team-key JWT workflow, not an App Store Connect REST operation. It creates or reuses a cached ES256 token with a 20-minute lifetime and does not expose the token; individual API-key scope and long-lived individual-key tokens are not supported." @@ -31,8 +37,14 @@ "mode": "local", "sources": [], "fields": [ - { "outputField": "success", "localRole": "JWTService.refreshToken completion" }, - { "outputField": "message", "localRole": "cache invalidation and token regeneration confirmation" } + { + "outputField": "success", + "localRole": "JWTService.refreshToken completion" + }, + { + "outputField": "message", + "localRole": "cache invalidation and token regeneration confirmation" + } ] }, "note": "Local cache invalidation and team-key JWT regeneration; no Apple REST operation is called and the refreshed token is not returned." @@ -49,7 +61,10 @@ "mode": "local", "sources": [], "fields": [ - { "outputField": "cacheInfo", "localRole": "JWTService.getCacheInfo snapshot" } + { + "outputField": "cacheInfo", + "localRole": "JWTService.getCacheInfo snapshot" + } ] }, "note": "Local in-memory cache inspection only. Validity means the cached token's decoded exp claim is beyond the configured refresh leeway; it is not server-side Apple validation." @@ -62,17 +77,36 @@ "implementationState": "asBuilt", "operations": [], "fields": [ - { "toolField": "token", "sourceKind": "local", "localRole": "JWT compact serialization validated against the configured team key and company claims" } + { + "toolField": "token", + "sourceKind": "local", + "localRole": "JWT compact serialization validated against the configured team key and company claims" + } ], "response": { "mode": "local", "sources": [], "fields": [ - { "outputField": "success", "localRole": "local validation completed" }, - { "outputField": "isValid", "localRole": "combined format, ES256 signature, header, company claim, issued-at, standard lifetime, and expiration result" }, - { "outputField": "validationScope", "localRole": "configured_team_key identifies the local trust boundary" }, - { "outputField": "appleAcceptanceChecked", "localRole": "always false because no Apple request is made" }, - { "outputField": "failureReason", "localRole": "stable local reason code, present only when validation fails" } + { + "outputField": "success", + "localRole": "local validation completed" + }, + { + "outputField": "isValid", + "localRole": "combined format, ES256 signature, header, company claim, issued-at, standard lifetime, and expiration result" + }, + { + "outputField": "validationScope", + "localRole": "configured_team_key identifies the local trust boundary" + }, + { + "outputField": "appleAcceptanceChecked", + "localRole": "always false because no Apple request is made" + }, + { + "outputField": "failureReason", + "localRole": "stable local reason code, present only when validation fails" + } ] }, "note": "Performs local cryptographic validation for the configured non-scoped team-key contract using the private key's public key. It checks alg=ES256, typ=JWT, kid, iss, aud=appstoreconnect-v1, iat ordering, exp-iat at most 1200 seconds, and exp beyond the refresh leeway. It intentionally rejects long-lived scoped JWTs, does not call Apple, does not evaluate endpoint role permissions, does not support individual-key JWTs, and does not prove server acceptance." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/beta_app.json b/Sources/asc-mcp/Resources/OperationManifest/tools/beta_app.json index 22055c9..cfb19a4 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/beta_app.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/beta_app.json @@ -125,7 +125,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaAppLocalizations_deleteInstance", "statusCode": "204" } + { + "operationId": "betaAppLocalizations_deleteInstance", + "statusCode": "204" + } ], "fields": [ { @@ -157,7 +160,14 @@ "sourceKind": "fixed", "location": "query", "appleName": "fields[betaAppLocalizations]", - "fixedValue": ["feedbackEmail", "marketingUrl", "privacyPolicyUrl", "tvOsPrivacyPolicy", "description", "locale"] + "fixedValue": [ + "feedbackEmail", + "marketingUrl", + "privacyPolicyUrl", + "tvOsPrivacyPolicy", + "description", + "locale" + ] } ], "optionalParameterClassifications": [ @@ -166,7 +176,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The focused localization tool projects the base resource; callers can use apps tools for expanded App details.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -225,7 +235,16 @@ "sourceKind": "fixed", "location": "query", "appleName": "fields[betaAppReviewDetails]", - "fixedValue": ["contactFirstName", "contactLastName", "contactPhone", "contactEmail", "demoAccountName", "demoAccountPassword", "demoAccountRequired", "notes"] + "fixedValue": [ + "contactFirstName", + "contactLastName", + "contactPhone", + "contactEmail", + "demoAccountName", + "demoAccountPassword", + "demoAccountRequired", + "notes" + ] } ] } @@ -290,19 +309,29 @@ "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["build"] + "fixedValue": [ + "build" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[betaAppReviewSubmissions]", - "fixedValue": ["betaReviewState", "submittedDate", "build"] + "fixedValue": [ + "betaReviewState", + "submittedDate", + "build" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[builds]", - "fixedValue": ["version", "uploadedDate", "processingState"] + "fixedValue": [ + "version", + "uploadedDate", + "processingState" + ] } ] }, @@ -311,13 +340,15 @@ "method": "get", "path": "/v1/betaAppReviewSubmissions/{id}/relationships/build", "role": "conditional", - "condition": "The primary response omits Build relationship data and contains no included Build.", + "condition": "The primary response omits Build relationship data and contains no included Build.", "inputs": [ { "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["betaAppReviewSubmissions_getInstance:/data/id"], + "derivedFrom": [ + "betaAppReviewSubmissions_getInstance:/data/id" + ], "localRole": "Use the decoded submission identifier." } ] @@ -448,7 +479,14 @@ "sourceKind": "fixed", "location": "query", "appleName": "fields[betaAppLocalizations]", - "fixedValue": ["feedbackEmail", "marketingUrl", "privacyPolicyUrl", "tvOsPrivacyPolicy", "description", "locale"] + "fixedValue": [ + "feedbackEmail", + "marketingUrl", + "privacyPolicyUrl", + "tvOsPrivacyPolicy", + "description", + "locale" + ] } ] } @@ -533,19 +571,29 @@ "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["build"] + "fixedValue": [ + "build" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[betaAppReviewSubmissions]", - "fixedValue": ["betaReviewState", "submittedDate", "build"] + "fixedValue": [ + "betaReviewState", + "submittedDate", + "build" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[builds]", - "fixedValue": ["version", "uploadedDate", "processingState"] + "fixedValue": [ + "version", + "uploadedDate", + "processingState" + ] } ] }, @@ -560,7 +608,9 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["betaAppReviewSubmissions_getCollection:/data/*/id"], + "derivedFrom": [ + "betaAppReviewSubmissions_getCollection:/data/*/id" + ], "localRole": "Use each unresolved decoded submission identifier." } ] diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/beta_feedback.json b/Sources/asc-mcp/Resources/OperationManifest/tools/beta_feedback.json index e4c3c16..2bbef7a 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/beta_feedback.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/beta_feedback.json @@ -27,7 +27,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaFeedbackCrashSubmissions_deleteInstance", "statusCode": "204" } + { + "operationId": "betaFeedbackCrashSubmissions_deleteInstance", + "statusCode": "204" + } ], "fields": [ { @@ -68,7 +71,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaFeedbackScreenshotSubmissions_deleteInstance", "statusCode": "204" } + { + "operationId": "betaFeedbackScreenshotSubmissions_deleteInstance", + "statusCode": "204" + } ], "fields": [ { diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/beta_groups.json b/Sources/asc-mcp/Resources/OperationManifest/tools/beta_groups.json index 9e43d87..5a5f502 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/beta_groups.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/beta_groups.json @@ -33,7 +33,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaGroups_builds_createToManyRelationship", "statusCode": "204" } + { + "operationId": "betaGroups_builds_createToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -80,7 +83,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaGroups_betaTesters_createToManyRelationship", "statusCode": "204" } + { + "operationId": "betaGroups_betaTesters_createToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -238,7 +244,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaGroups_deleteInstance", "statusCode": "204" } + { + "operationId": "betaGroups_deleteInstance", + "statusCode": "204" + } ], "fields": [ { @@ -271,21 +280,21 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The group collection returns stable group and relationship-ID projections; related resources have dedicated tools.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaTesters]", "disposition": "intentionallyOmitted", "reason": "Beta testers are not included in the group collection response.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Builds are not included in the group collection response.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -441,11 +450,11 @@ } ], "fields": [ - { - "outputField": "beta_testers", - "operationId": "betaGroups_betaTesters_getToManyRelated", - "jsonPointer": "/data", - "localRole": "Stable tester projections including Apple's appDevices attributes." + { + "outputField": "beta_testers", + "operationId": "betaGroups_betaTesters_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Stable tester projections including Apple's appDevices attributes." }, { "outputField": "next_url", @@ -493,7 +502,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaGroups_builds_deleteToManyRelationship", "statusCode": "204" } + { + "operationId": "betaGroups_builds_deleteToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -540,7 +552,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaGroups_betaTesters_deleteToManyRelationship", "statusCode": "204" } + { + "operationId": "betaGroups_betaTesters_deleteToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -683,21 +698,21 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The supporting request only confirms the parent identity and does not project relationships.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaTesters]", "disposition": "intentionallyOmitted", "reason": "No beta testers are included by the supporting parent lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "No builds are included by the supporting parent lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -801,21 +816,21 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The supporting request only confirms the parent identity.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaTesters]", "disposition": "intentionallyOmitted", "reason": "No beta testers are included by the supporting parent lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "No builds are included by the supporting parent lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -940,20 +955,20 @@ "outputField": "groupId", "localRole": "requestEcho" }, - { - "outputField": "statusCode", - "localRole": "Exact verified 201 status." + { + "outputField": "statusCode", + "localRole": "Exact verified 201 status." + }, + { + "outputField": "recruitmentCriteria", + "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", + "jsonPointer": "/data", + "localRole": "Fresh group-scoped postflight projection." + }, + { + "outputField": "criterionId", + "localRole": "Validated response identity retained on an accepted create whose postflight could not be verified." }, - { - "outputField": "recruitmentCriteria", - "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", - "jsonPointer": "/data", - "localRole": "Fresh group-scoped postflight projection." - }, - { - "outputField": "criterionId", - "localRole": "Validated response identity retained on an accepted create whose postflight could not be verified." - }, { "outputField": "responseCriterionId", "operationId": "betaRecruitmentCriteria_createInstance", @@ -992,14 +1007,14 @@ "outputField": "inspectionRequired", "localRole": "True when a caller inspection is required before retrying." }, - { - "outputField": "outcomeUnknown", - "localRole": "True only for an ambiguous request outcome." - }, - { - "outputField": "inspectionError", - "localRole": "Redacted diagnostic-read failure when exact group inspection could not complete." - } + { + "outputField": "outcomeUnknown", + "localRole": "True only for an ambiguous request outcome." + }, + { + "outputField": "inspectionError", + "localRole": "Redacted diagnostic-read failure when exact group inspection could not complete." + } ] }, "note": "Requires confirmed parent and preflight absence, exact HTTP 201, and a fresh group-scoped ID/filter match. Ambiguous candidates remain unattributed and fail closed." @@ -1033,21 +1048,21 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The supporting request only confirms the parent identity.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaTesters]", "disposition": "intentionallyOmitted", "reason": "No beta testers are included by the supporting parent lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "No builds are included by the supporting parent lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -1168,36 +1183,36 @@ "outputField": "groupId", "localRole": "requestEcho" }, - { - "outputField": "statusCode", - "localRole": "Exact verified 200 status." + { + "outputField": "statusCode", + "localRole": "Exact verified 200 status." + }, + { + "outputField": "recruitmentCriteria", + "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", + "jsonPointer": "/data", + "localRole": "Fresh group-scoped postflight projection preserving omitted/null/value state." + }, + { + "outputField": "criterionId", + "localRole": "Validated request criterion identity on mutation failures." + }, + { + "outputField": "observedCandidate", + "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", + "jsonPointer": "/data", + "localRole": "Diagnostic only; never proves this PATCH committed." + }, + { + "outputField": "candidateId", + "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", + "jsonPointer": "/data/id", + "localRole": "Diagnostic candidate identity." + }, + { + "outputField": "candidateAttributionConfirmed", + "localRole": "Always false for a diagnostic candidate after an unverified PATCH." }, - { - "outputField": "recruitmentCriteria", - "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", - "jsonPointer": "/data", - "localRole": "Fresh group-scoped postflight projection preserving omitted/null/value state." - }, - { - "outputField": "criterionId", - "localRole": "Validated request criterion identity on mutation failures." - }, - { - "outputField": "observedCandidate", - "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", - "jsonPointer": "/data", - "localRole": "Diagnostic only; never proves this PATCH committed." - }, - { - "outputField": "candidateId", - "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", - "jsonPointer": "/data/id", - "localRole": "Diagnostic candidate identity." - }, - { - "outputField": "candidateAttributionConfirmed", - "localRole": "Always false for a diagnostic candidate after an unverified PATCH." - }, { "outputField": "write_outcome", "localRole": "Stable mutation outcome discriminator on failure." @@ -1218,14 +1233,14 @@ "outputField": "inspectionRequired", "localRole": "True when a caller inspection is required before retrying." }, - { - "outputField": "outcomeUnknown", - "localRole": "True only for an ambiguous request outcome." - }, - { - "outputField": "inspectionError", - "localRole": "Redacted diagnostic-read failure when exact group inspection could not complete." - } + { + "outputField": "outcomeUnknown", + "localRole": "True only for an ambiguous request outcome." + }, + { + "outputField": "inspectionError", + "localRole": "Redacted diagnostic-read failure when exact group inspection could not complete." + } ] }, "note": "Verifies parent ownership before PATCH, distinguishes omitted/null/value, requires exact HTTP 200 and a fresh group-scoped postflight, and never treats diagnostic state as commit proof." @@ -1259,21 +1274,21 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The supporting request only confirms the parent identity.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaTesters]", "disposition": "intentionallyOmitted", "reason": "No beta testers are included by the supporting parent lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "No builds are included by the supporting parent lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -1381,30 +1396,30 @@ "outputField": "criterionId", "localRole": "requestEcho" }, - { - "outputField": "statusCode", - "localRole": "Exact verified 204 status." + { + "outputField": "statusCode", + "localRole": "Exact verified 204 status." }, { "outputField": "message", "localRole": "Local exact-204 confirmation." }, - { - "outputField": "observedCandidate", - "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", - "jsonPointer": "/data", - "localRole": "Diagnostic only; absence or replacement never proves this DELETE committed." - }, - { - "outputField": "candidateId", - "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", - "jsonPointer": "/data/id", - "localRole": "Diagnostic candidate identity." - }, - { - "outputField": "candidateAttributionConfirmed", - "localRole": "Always false for a diagnostic candidate after an unverified DELETE." - }, + { + "outputField": "observedCandidate", + "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", + "jsonPointer": "/data", + "localRole": "Diagnostic only; absence or replacement never proves this DELETE committed." + }, + { + "outputField": "candidateId", + "operationId": "betaGroups_betaRecruitmentCriteria_getToOneRelated", + "jsonPointer": "/data/id", + "localRole": "Diagnostic candidate identity." + }, + { + "outputField": "candidateAttributionConfirmed", + "localRole": "Always false for a diagnostic candidate after an unverified DELETE." + }, { "outputField": "write_outcome", "localRole": "Stable mutation outcome discriminator on failure." @@ -1425,14 +1440,14 @@ "outputField": "inspectionRequired", "localRole": "True when a caller inspection is required before retrying." }, - { - "outputField": "outcomeUnknown", - "localRole": "True only for an ambiguous request outcome." - }, - { - "outputField": "inspectionError", - "localRole": "Redacted diagnostic-read failure when exact group inspection could not complete." - } + { + "outputField": "outcomeUnknown", + "localRole": "True only for an ambiguous request outcome." + }, + { + "outputField": "inspectionError", + "localRole": "Redacted diagnostic-read failure when exact group inspection could not complete." + } ] }, "note": "Requires exact confirm_criterion_id and parent ownership. Only HTTP 204 confirms deletion; follow-up state is diagnostic and cannot convert rejected or ambiguous DELETE outcomes into success." @@ -1548,21 +1563,21 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The supporting request only confirms the parent identity.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaTesters]", "disposition": "intentionallyOmitted", "reason": "No beta testers are included by the supporting parent lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "No builds are included by the supporting parent lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/beta_license.json b/Sources/asc-mcp/Resources/OperationManifest/tools/beta_license.json index 27a0189..b992dde 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/beta_license.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/beta_license.json @@ -19,7 +19,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The base resource app linkage is projected as appId; expanding the full App resource is outside this focused agreement tool.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -74,7 +74,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Each agreement already projects its app linkage; expanding full App resources would duplicate the apps worker.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/beta_testers.json b/Sources/asc-mcp/Resources/OperationManifest/tools/beta_testers.json index ca29319..97db0f9 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/beta_testers.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/beta_testers.json @@ -33,7 +33,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaTesters_builds_createToManyRelationship", "statusCode": "204" } + { + "operationId": "betaTesters_builds_createToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -80,7 +83,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaTesters_betaGroups_createToManyRelationship", "statusCode": "204" } + { + "operationId": "betaTesters_betaGroups_createToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -168,11 +174,11 @@ } ], "fields": [ - { - "outputField": "beta_tester", - "operationId": "betaTesters_createInstance", - "jsonPointer": "/data", - "localRole": "Stable tester projection including Apple's appDevices attributes." + { + "outputField": "beta_tester", + "operationId": "betaTesters_createInstance", + "jsonPointer": "/data", + "localRole": "Stable tester projection including Apple's appDevices attributes." } ] }, @@ -204,8 +210,14 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaTesters_deleteInstance", "statusCode": "202" }, - { "operationId": "betaTesters_deleteInstance", "statusCode": "204" } + { + "operationId": "betaTesters_deleteInstance", + "statusCode": "202" + }, + { + "operationId": "betaTesters_deleteInstance", + "statusCode": "204" + } ], "fields": [ { @@ -254,21 +266,21 @@ "appleName": "limit[apps]", "disposition": "intentionallyOmitted", "reason": "The detail tool returns Apple's bounded included-app preview; full app access remains paginated through beta_testers_list_apps.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "The detail tool intentionally returns a bounded included beta-group preview.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "The detail tool intentionally returns a bounded included-build preview; relationship mutation has dedicated tools.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -342,28 +354,28 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The collection returns tester and relationship-ID projections; included details are available through beta_testers_get.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[apps]", "disposition": "intentionallyOmitted", "reason": "Apps are not included by the tester collection projection.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta groups are not included by the tester collection projection.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Builds are not included by the tester collection projection.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -455,11 +467,11 @@ } ], "fields": [ - { - "outputField": "beta_testers", - "operationId": "betaTesters_getCollection", - "jsonPointer": "/data", - "localRole": "Stable tester projections including Apple's appDevices attributes." + { + "outputField": "beta_testers", + "operationId": "betaTesters_getCollection", + "jsonPointer": "/data", + "localRole": "Stable tester projections including Apple's appDevices attributes." }, { "outputField": "next_url", @@ -581,8 +593,14 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaTesters_apps_deleteToManyRelationship", "statusCode": "202" }, - { "operationId": "betaTesters_apps_deleteToManyRelationship", "statusCode": "204" } + { + "operationId": "betaTesters_apps_deleteToManyRelationship", + "statusCode": "202" + }, + { + "operationId": "betaTesters_apps_deleteToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -645,7 +663,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaTesters_builds_deleteToManyRelationship", "statusCode": "204" } + { + "operationId": "betaTesters_builds_deleteToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -692,7 +713,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "betaTesters_betaGroups_deleteToManyRelationship", "statusCode": "204" } + { + "operationId": "betaTesters_betaGroups_deleteToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -725,77 +749,77 @@ "appleName": "filter[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Advanced group filtering belongs to beta_testers_list; search is intentionally exact-email plus optional app scope.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[builds]", "disposition": "intentionallyOmitted", "reason": "Advanced build filtering belongs to beta_testers_list; search is intentionally exact-email plus optional app scope.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[firstName]", "disposition": "intentionallyOmitted", "reason": "Name filtering belongs to beta_testers_list; Apple email search is exact.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "A caller with a tester ID should use beta_testers_get.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[inviteType]", "disposition": "intentionallyOmitted", "reason": "Invitation-type filtering belongs to beta_testers_list.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[lastName]", "disposition": "intentionallyOmitted", "reason": "Name filtering belongs to beta_testers_list; Apple email search is exact.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Search returns compact tester matches; beta_testers_get provides included details.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[apps]", "disposition": "intentionallyOmitted", "reason": "Apps are not included in search results.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta groups are not included in search results.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Builds are not included in search results.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Exact-email search preserves Apple's natural match order and exposes pagination for ambiguous matches.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -838,11 +862,11 @@ } ], "fields": [ - { - "outputField": "beta_testers", - "operationId": "betaTesters_getCollection", - "jsonPointer": "/data", - "localRole": "Stable tester projections including Apple's appDevices attributes." + { + "outputField": "beta_testers", + "operationId": "betaTesters_getCollection", + "jsonPointer": "/data", + "localRole": "Stable tester projections including Apple's appDevices attributes." }, { "outputField": "next_url", @@ -876,17 +900,17 @@ "jsonPointer": "/data/type", "fixedValue": "betaTesterInvitations" }, - { - "sourceKind": "fixed", - "jsonPointer": "/data/relationships/app/data/type", - "fixedValue": "apps" - }, - { - "sourceKind": "fixed", - "jsonPointer": "/data/relationships/betaTester/data/type", - "fixedValue": "betaTesters" - } - ] + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/betaTester/data/type", + "fixedValue": "betaTesters" + } + ] } ], "fields": [ diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/build_beta.json b/Sources/asc-mcp/Resources/OperationManifest/tools/build_beta.json index 7fd5007..09e80b6 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/build_beta.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/build_beta.json @@ -14,7 +14,11 @@ "path": "/v1/builds/{id}/relationships/individualTesters", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/*/type", "fixedValue": "betaTesters" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "betaTesters" + } ] } ], @@ -36,7 +40,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "builds_individualTesters_createToManyRelationship", "statusCode": "204" } + { + "operationId": "builds_individualTesters_createToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -64,7 +71,11 @@ "path": "/v1/builds/{id}/relationships/betaGroups", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/*/type", "fixedValue": "betaGroups" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "betaGroups" + } ] } ], @@ -86,7 +97,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "builds_betaGroups_createToManyRelationship", "statusCode": "204" } + { + "operationId": "builds_betaGroups_createToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -119,7 +133,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The selected build ID is already known and the tool returns the related beta-detail resource without re-including the Build.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -136,7 +150,11 @@ "response": { "mode": "aggregate", "sources": [ - { "operationId": "builds_buildBetaDetail_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "builds_buildBetaDetail_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { @@ -178,28 +196,28 @@ "appleName": "filter[app]", "disposition": "intentionallyOmitted", "reason": "The required build filter already scopes this tool to groups attached to the selected build.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The tool returns a stable group projection and relationship IDs; related resources use dedicated tools.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaTesters]", "disposition": "intentionallyOmitted", "reason": "Beta testers are not included by this group projection.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Builds are represented by relationship IDs rather than included resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -348,11 +366,11 @@ } ], "fields": [ - { - "outputField": "betaTesters", - "operationId": "builds_individualTesters_getToManyRelated", - "jsonPointer": "/data", - "localRole": "Stable individual-tester projections including Apple's appDevices attributes." + { + "outputField": "betaTesters", + "operationId": "builds_individualTesters_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Stable individual-tester projections including Apple's appDevices attributes." }, { "outputField": "next_url", @@ -477,11 +495,11 @@ } ], "fields": [ - { - "outputField": "individualTesters", - "operationId": "builds_individualTesters_getToManyRelated", - "jsonPointer": "/data", - "localRole": "Stable individual-tester projections including Apple's appDevices attributes." + { + "outputField": "individualTesters", + "operationId": "builds_individualTesters_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Stable individual-tester projections including Apple's appDevices attributes." }, { "outputField": "next_url", @@ -510,7 +528,11 @@ "path": "/v1/builds/{id}/relationships/individualTesters", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/*/type", "fixedValue": "betaTesters" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "betaTesters" + } ] } ], @@ -532,7 +554,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "builds_individualTesters_deleteToManyRelationship", "statusCode": "204" } + { + "operationId": "builds_individualTesters_deleteToManyRelationship", + "statusCode": "204" + } ], "fields": [ { @@ -560,8 +585,16 @@ "path": "/v1/buildBetaNotifications", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "buildBetaNotifications" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/build/data/type", "fixedValue": "builds" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "buildBetaNotifications" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/build/data/type", + "fixedValue": "builds" + } ] } ], @@ -621,7 +654,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The supporting lookup needs only the localization resource ID and does not expand its Build relationship.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -632,8 +665,16 @@ "role": "primary", "condition": "No existing localization has the requested locale.", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "betaBuildLocalizations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/build/data/type", "fixedValue": "builds" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "betaBuildLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/build/data/type", + "fixedValue": "builds" + } ] }, { @@ -647,14 +688,22 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["betaBuildLocalizations_getCollection:/data/*/id"], + "derivedFrom": [ + "betaBuildLocalizations_getCollection:/data/*/id" + ], "localRole": "useFirstLocaleMatchedLocalizationIdentifierForPath" }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "betaBuildLocalizations" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "betaBuildLocalizations" + }, { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["betaBuildLocalizations_getCollection:/data/*/id"], + "derivedFrom": [ + "betaBuildLocalizations_getCollection:/data/*/id" + ], "localRole": "copyLocaleMatchedLocalizationIdentifierToRequestBody" } ] @@ -727,9 +776,21 @@ "response": { "mode": "aggregate", "sources": [ - { "operationId": "betaBuildLocalizations_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "betaBuildLocalizations_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "betaBuildLocalizations_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "betaBuildLocalizations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "betaBuildLocalizations_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "betaBuildLocalizations_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { @@ -767,11 +828,17 @@ "path": "/v1/buildBetaDetails/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "buildBetaDetails" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "buildBetaDetails" + }, { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["beta_detail_id"], + "derivedFrom": [ + "beta_detail_id" + ], "localRole": "copyPathIdentifierToRequestBody" } ] diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/build_processing.json b/Sources/asc-mcp/Resources/OperationManifest/tools/build_processing.json index b15745b..f4063cd 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/build_processing.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/build_processing.json @@ -19,42 +19,42 @@ "appleName": "include", "disposition": "internalControl", "reason": "Readiness always includes buildBetaDetail because TestFlight states are required for the documented result.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaBuildLocalizations]", "disposition": "intentionallyOmitted", "reason": "Beta build localizations are not included in readiness checks.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta groups are not included in readiness checks.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[buildBundles]", "disposition": "intentionallyOmitted", "reason": "Build bundles are not included in readiness checks.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[icons]", "disposition": "intentionallyOmitted", "reason": "Build icons are not included in readiness checks.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[individualTesters]", "disposition": "intentionallyOmitted", "reason": "Individual testers are not included in readiness checks.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -140,42 +140,42 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Processing state is a reduced Build projection and does not include related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaBuildLocalizations]", "disposition": "intentionallyOmitted", "reason": "Beta build localizations are not included in processing state.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta groups are not included in processing state.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[buildBundles]", "disposition": "intentionallyOmitted", "reason": "Build bundles are not included in processing state.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[icons]", "disposition": "intentionallyOmitted", "reason": "Build icons are not included in processing state.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[individualTesters]", "disposition": "intentionallyOmitted", "reason": "Individual testers are not included in processing state.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -235,42 +235,42 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Processing status is a reduced Build projection and does not include related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaBuildLocalizations]", "disposition": "intentionallyOmitted", "reason": "Beta build localizations are not included in processing status.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta groups are not included in processing status.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[buildBundles]", "disposition": "intentionallyOmitted", "reason": "Build bundles are not included in processing status.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[icons]", "disposition": "intentionallyOmitted", "reason": "Build icons are not included in processing status.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[individualTesters]", "disposition": "intentionallyOmitted", "reason": "Individual testers are not included in processing status.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -345,14 +345,14 @@ "appleName": "/data/attributes/expired", "disposition": "intentionallyOmitted", "reason": "This narrowly scoped encryption-compliance tool must not also expire a TestFlight build; expiration requires a separately named destructive action.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "body", "appleName": "/data/relationships/appEncryptionDeclaration", "disposition": "intentionallyOmitted", "reason": "Linking an App Encryption Declaration is a distinct relationship workflow and is not inferred by the boolean encryption-compliance update.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/build_uploads.json b/Sources/asc-mcp/Resources/OperationManifest/tools/build_uploads.json index 79d1f02..324a23e 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/build_uploads.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/build_uploads.json @@ -16,31 +16,128 @@ } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "short_version_strings", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "filter[cfBundleShortVersionString]" }, - { "toolField": "build_versions", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "filter[cfBundleVersion]" }, - { "toolField": "platforms", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "filter[platform]" }, - { "toolField": "states", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "filter[state]" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "sort" }, - { "toolField": "fields_build_uploads", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "fields[buildUploads]" }, - { "toolField": "fields_builds", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "fields[builds]" }, - { "toolField": "fields_build_upload_files", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "fields[buildUploadFiles]" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "include_sensitive_details", "sourceKind": "local", "localRole": "False by default. When true, assetToken and uploadOperations are exposed only inside returned BuildUploadFile resource paths; errors always redact transfer credentials." }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact app collection: scheme, host, path, immutable query scope, and a non-empty cursor are validated before the GET." } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "short_version_strings", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "filter[cfBundleShortVersionString]" + }, + { + "toolField": "build_versions", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "filter[cfBundleVersion]" + }, + { + "toolField": "platforms", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "filter[platform]" + }, + { + "toolField": "states", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "filter[state]" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "fields_build_uploads", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "fields[buildUploads]" + }, + { + "toolField": "fields_builds", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "fields[builds]" + }, + { + "toolField": "fields_build_upload_files", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "fields[buildUploadFiles]" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "include_sensitive_details", + "sourceKind": "local", + "localRole": "False by default. When true, assetToken and uploadOperations are exposed only inside returned BuildUploadFile resource paths; errors always redact transfer credentials." + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact app collection: scheme, host, path, immutable query scope, and a non-empty cursor are validated before the GET." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "apps_buildUploads_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_buildUploads_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildUploads", "operationId": "apps_buildUploads_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "apps_buildUploads_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "apps_buildUploads_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "apps_buildUploads_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "count", "localRole": "Count of BuildUpload resources returned on the current page." } + { + "outputField": "buildUploads", + "operationId": "apps_buildUploads_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "apps_buildUploads_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "apps_buildUploads_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "apps_buildUploads_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "count", + "localRole": "Count of BuildUpload resources returned on the current page." + } ] }, "note": "Maps every Apple 4.4.1 collection filter, sort, sparse fieldset, include, and limit through a strict GET 200 contract. Sensitive BuildUploadFile transfer credentials are redacted by default and explicit disclosure is limited to successful BuildUploadFile output paths; pagination preserves the complete original query scope." @@ -60,21 +157,67 @@ } ], "fields": [ - { "toolField": "build_upload_id", "sourceKind": "parameter", "operationId": "buildUploads_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "fields_build_uploads", "sourceKind": "parameter", "operationId": "buildUploads_getInstance", "location": "query", "appleName": "fields[buildUploads]" }, - { "toolField": "fields_builds", "sourceKind": "parameter", "operationId": "buildUploads_getInstance", "location": "query", "appleName": "fields[builds]" }, - { "toolField": "fields_build_upload_files", "sourceKind": "parameter", "operationId": "buildUploads_getInstance", "location": "query", "appleName": "fields[buildUploadFiles]" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "buildUploads_getInstance", "location": "query", "appleName": "include" }, - { "toolField": "include_sensitive_details", "sourceKind": "local", "localRole": "False by default. When true, assetToken and uploadOperations are exposed only inside returned BuildUploadFile resource paths; errors always redact transfer credentials." } + { + "toolField": "build_upload_id", + "sourceKind": "parameter", + "operationId": "buildUploads_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "fields_build_uploads", + "sourceKind": "parameter", + "operationId": "buildUploads_getInstance", + "location": "query", + "appleName": "fields[buildUploads]" + }, + { + "toolField": "fields_builds", + "sourceKind": "parameter", + "operationId": "buildUploads_getInstance", + "location": "query", + "appleName": "fields[builds]" + }, + { + "toolField": "fields_build_upload_files", + "sourceKind": "parameter", + "operationId": "buildUploads_getInstance", + "location": "query", + "appleName": "fields[buildUploadFiles]" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "buildUploads_getInstance", + "location": "query", + "appleName": "include" + }, + { + "toolField": "include_sensitive_details", + "sourceKind": "local", + "localRole": "False by default. When true, assetToken and uploadOperations are exposed only inside returned BuildUploadFile resource paths; errors always redact transfer credentials." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "buildUploads_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "buildUploads_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildUpload", "operationId": "buildUploads_getInstance", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "buildUploads_getInstance", "jsonPointer": "/included" } + { + "outputField": "buildUpload", + "operationId": "buildUploads_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "buildUploads_getInstance", + "jsonPointer": "/included" + } ] }, "note": "Uses the strict Apple GET 200 response and exposes all Apple 4.4.1 sparse fieldsets and includes while keeping presigned transfer credentials opt-in, path-scoped to BuildUploadFile output, and redacted from errors." @@ -93,8 +236,30 @@ "role": "supporting", "condition": "Take exact preflight and postflight sets around parent creation for unknown-outcome recovery; follow strict pagination for at most 20 pages and reject repeated continuations.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[buildUploads]", "fixedValue": ["cfBundleShortVersionString", "cfBundleVersion", "createdDate", "state", "platform", "uploadedDate", "build", "assetFile", "assetDescriptionFile", "assetSpiFile", "buildUploadFiles"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[buildUploads]", + "fixedValue": [ + "cfBundleShortVersionString", + "cfBundleVersion", + "createdDate", + "state", + "platform", + "uploadedDate", + "build", + "assetFile", + "assetDescriptionFile", + "assetSpiFile", + "buildUploadFiles" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ { @@ -102,21 +267,21 @@ "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Recovery must compare the complete exact version/build/platform fingerprint regardless of current upload state.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Recovery computes a set difference across every bounded page, so Apple result ordering cannot affect identity.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Parent recovery needs only BuildUpload identity and fingerprint attributes; related resources cannot prove create ownership.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -126,39 +291,132 @@ "path": "/v1/buildUploads", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "buildUploads" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "buildUploads" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "app_id", "sourceKind": "requestBody", "operationId": "buildUploads_createInstance", "jsonPointer": "/data/relationships/app/data/id" }, - { "toolField": "short_version", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "filter[cfBundleShortVersionString]" }, - { "toolField": "short_version", "sourceKind": "requestBody", "operationId": "buildUploads_createInstance", "jsonPointer": "/data/attributes/cfBundleShortVersionString" }, - { "toolField": "build_version", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "filter[cfBundleVersion]" }, - { "toolField": "build_version", "sourceKind": "requestBody", "operationId": "buildUploads_createInstance", "jsonPointer": "/data/attributes/cfBundleVersion" }, - { "toolField": "platform", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "filter[platform]" }, - { "toolField": "platform", "sourceKind": "requestBody", "operationId": "buildUploads_createInstance", "jsonPointer": "/data/attributes/platform" } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_id", + "sourceKind": "requestBody", + "operationId": "buildUploads_createInstance", + "jsonPointer": "/data/relationships/app/data/id" + }, + { + "toolField": "short_version", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "filter[cfBundleShortVersionString]" + }, + { + "toolField": "short_version", + "sourceKind": "requestBody", + "operationId": "buildUploads_createInstance", + "jsonPointer": "/data/attributes/cfBundleShortVersionString" + }, + { + "toolField": "build_version", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "filter[cfBundleVersion]" + }, + { + "toolField": "build_version", + "sourceKind": "requestBody", + "operationId": "buildUploads_createInstance", + "jsonPointer": "/data/attributes/cfBundleVersion" + }, + { + "toolField": "platform", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "filter[platform]" + }, + { + "toolField": "platform", + "sourceKind": "requestBody", + "operationId": "buildUploads_createInstance", + "jsonPointer": "/data/attributes/platform" + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "apps_buildUploads_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploads_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "apps_buildUploads_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploads_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildUpload", "localRole": "For success, the fresh app-scoped collection projection whose ID matches the contract-valid POST 201 response and was absent before the request; for ambiguous recovery, the one unique unattributed candidate returned only inside an error result." }, - { "outputField": "candidateId", "localRole": "Unique bounded-recovery candidate ID returned only for candidate_inspection_required." }, - { "outputField": "candidateAttributionConfirmed", "localRole": "False for every recovered candidate because concurrent creation prevents attribution to this invocation." }, - { "outputField": "workflowState", "localRole": "candidate_inspection_required for one unique postflight candidate whose invocation ownership is not proven." }, - { "outputField": "createdByInvocation", "localRole": "True only after an exact 201 identity is absent from preflight and confirmed by a fresh requested-app collection read; false for recovered candidates." }, - { "outputField": "reconciledAfterCreate", "localRole": "True only for one uniquely observed exact postflight candidate; that outcome is success false and stops before any further mutation." }, - { "outputField": "automaticDeletionAllowed", "localRole": "False for a uniquely recovered candidate because attribution to this invocation is not confirmed." }, - { "outputField": "operationCommitState", "localRole": "committed only after exact 201 plus fresh app-membership proof; preserves unknown for transport ambiguity and committed_unverified for an invalid accepted response or its recovered candidate." }, - { "outputField": "inspectionRequired", "localRole": "True for recovered or unresolved outcomes before another POST or continuation." }, - { "outputField": "inspection", "localRole": "Executable build_uploads_get or bounded build_uploads_list guidance using canonical candidate IDs and the exact requested fingerprint; inspection does not prove invocation ownership." }, - { "outputField": "retrySafe", "localRole": "False for recovered, committed_unverified, and unknown outcomes; the returned inspection guidance must be followed before another POST." } + { + "outputField": "buildUpload", + "localRole": "For success, the fresh app-scoped collection projection whose ID matches the contract-valid POST 201 response and was absent before the request; for ambiguous recovery, the one unique unattributed candidate returned only inside an error result." + }, + { + "outputField": "candidateId", + "localRole": "Unique bounded-recovery candidate ID returned only for candidate_inspection_required." + }, + { + "outputField": "candidateAttributionConfirmed", + "localRole": "False for every recovered candidate because concurrent creation prevents attribution to this invocation." + }, + { + "outputField": "workflowState", + "localRole": "candidate_inspection_required for one unique postflight candidate whose invocation ownership is not proven." + }, + { + "outputField": "createdByInvocation", + "localRole": "True only after an exact 201 identity is absent from preflight and confirmed by a fresh requested-app collection read; false for recovered candidates." + }, + { + "outputField": "reconciledAfterCreate", + "localRole": "True only for one uniquely observed exact postflight candidate; that outcome is success false and stops before any further mutation." + }, + { + "outputField": "automaticDeletionAllowed", + "localRole": "False for a uniquely recovered candidate because attribution to this invocation is not confirmed." + }, + { + "outputField": "operationCommitState", + "localRole": "committed only after exact 201 plus fresh app-membership proof; preserves unknown for transport ambiguity and committed_unverified for an invalid accepted response or its recovered candidate." + }, + { + "outputField": "inspectionRequired", + "localRole": "True for recovered or unresolved outcomes before another POST or continuation." + }, + { + "outputField": "inspection", + "localRole": "Executable build_uploads_get or bounded build_uploads_list guidance using canonical candidate IDs and the exact requested fingerprint; inspection does not prove invocation ownership." + }, + { + "outputField": "retrySafe", + "localRole": "False for recovered, committed_unverified, and unknown outcomes; the returned inspection guidance must be followed before another POST." + } ] }, "note": "Invocation ownership and success require Apple's exact POST 201 with canonical type, ID, required self link, exact app/version/build/platform fingerprint, absence from preflight, and fresh membership in the requested app collection; the fresh scoped projection is returned. Ambiguous outcomes scan at most 20 strict pages; when one new exact candidate is found the call stops and returns success false, isError true, candidate_inspection_required, the original unknown or committed_unverified state, and executable inspection, while zero or multiple candidates remain unresolved. Recovered or otherwise ambiguous parents are never owned, automatically deleted, or safe to retry." @@ -178,21 +436,52 @@ } ], "fields": [ - { "toolField": "build_upload_id", "sourceKind": "parameter", "operationId": "buildUploads_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_build_upload_id", "sourceKind": "local", "localRole": "Required exact-match confirmation for build_upload_id; mismatch is rejected before any network request." } + { + "toolField": "build_upload_id", + "sourceKind": "parameter", + "operationId": "buildUploads_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_build_upload_id", + "sourceKind": "local", + "localRole": "Required exact-match confirmation for build_upload_id; mismatch is rejected before any network request." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "buildUploads_deleteInstance", "statusCode": "204" } + { + "operationId": "buildUploads_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "Local confirmation after Apple's contentless 204 response." }, - { "outputField": "buildUploadId", "localRole": "Echoes the explicitly requested parent identifier." }, - { "outputField": "operationCommitState", "localRole": "committed only for exact 204; committed_unverified or unknown is returned for an ambiguous accepted or transport outcome." }, - { "outputField": "inspectionRequired", "localRole": "True for every committed_unverified or unknown DELETE result." }, - { "outputField": "inspection", "localRole": "Executable build_uploads_get guidance carrying the exact known build_upload_id after an ambiguous DELETE." }, - { "outputField": "retrySafe", "localRole": "False for every committed_unverified or unknown DELETE result." } + { + "outputField": "success", + "localRole": "Local confirmation after Apple's contentless 204 response." + }, + { + "outputField": "buildUploadId", + "localRole": "Echoes the explicitly requested parent identifier." + }, + { + "outputField": "operationCommitState", + "localRole": "committed only for exact 204; committed_unverified or unknown is returned for an ambiguous accepted or transport outcome." + }, + { + "outputField": "inspectionRequired", + "localRole": "True for every committed_unverified or unknown DELETE result." + }, + { + "outputField": "inspection", + "localRole": "Executable build_uploads_get guidance carrying the exact known build_upload_id after an ambiguous DELETE." + }, + { + "outputField": "retrySafe", + "localRole": "False for every committed_unverified or unknown DELETE result." + } ] }, "note": "This is the only public Build Upload deletion surface. The confirmation ID must exactly match before the request, and only Apple's exact DELETE 204 confirms success; ambiguous or unexpected accepted outcomes preserve the exact parent ID and executable build_uploads_get inspection and are non-retryable until inspected. Apple defines no DELETE for BuildUploadFile children." @@ -212,22 +501,67 @@ } ], "fields": [ - { "toolField": "build_upload_id", "sourceKind": "parameter", "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "fields_build_upload_files", "sourceKind": "parameter", "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "location": "query", "appleName": "fields[buildUploadFiles]" }, - { "toolField": "include_sensitive_details", "sourceKind": "local", "localRole": "False by default. When true, assetToken and uploadOperations are exposed only inside returned BuildUploadFile resource paths; errors always redact transfer credentials." }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact parent collection: scheme, host, path, immutable query scope, and a non-empty cursor are validated before the GET." } + { + "toolField": "build_upload_id", + "sourceKind": "parameter", + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "fields_build_upload_files", + "sourceKind": "parameter", + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "location": "query", + "appleName": "fields[buildUploadFiles]" + }, + { + "toolField": "include_sensitive_details", + "sourceKind": "local", + "localRole": "False by default. When true, assetToken and uploadOperations are exposed only inside returned BuildUploadFile resource paths; errors always redact transfer credentials." + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact parent collection: scheme, host, path, immutable query scope, and a non-empty cursor are validated before the GET." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildUploadFiles", "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "count", "localRole": "Count of BuildUploadFile resources on the current page." } + { + "outputField": "buildUploadFiles", + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "count", + "localRole": "Count of BuildUploadFile resources on the current page." + } ] }, "note": "Maps every Apple 4.4.1 query input through a strict GET 200 contract and preserves strict pagination scope. Signed upload operations are redacted by default and explicit disclosure is limited to successful BuildUploadFile output paths." @@ -247,17 +581,41 @@ } ], "fields": [ - { "toolField": "file_id", "sourceKind": "parameter", "operationId": "buildUploadFiles_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "fields_build_upload_files", "sourceKind": "parameter", "operationId": "buildUploadFiles_getInstance", "location": "query", "appleName": "fields[buildUploadFiles]" }, - { "toolField": "include_sensitive_details", "sourceKind": "local", "localRole": "False by default. When true, assetToken and uploadOperations are exposed only inside the returned BuildUploadFile resource path; errors always redact transfer credentials." } + { + "toolField": "file_id", + "sourceKind": "parameter", + "operationId": "buildUploadFiles_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "fields_build_upload_files", + "sourceKind": "parameter", + "operationId": "buildUploadFiles_getInstance", + "location": "query", + "appleName": "fields[buildUploadFiles]" + }, + { + "toolField": "include_sensitive_details", + "sourceKind": "local", + "localRole": "False by default. When true, assetToken and uploadOperations are exposed only inside the returned BuildUploadFile resource path; errors always redact transfer credentials." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "buildUploadFiles_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "buildUploadFiles_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildUploadFile", "operationId": "buildUploadFiles_getInstance", "jsonPointer": "/data" } + { + "outputField": "buildUploadFile", + "operationId": "buildUploadFiles_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Returns the strict Apple GET 200 file and delivery-state projection. Transfer credentials remain opt-in, path-scoped to successful BuildUploadFile output, and redacted from diagnostic errors." @@ -276,8 +634,27 @@ "role": "supporting", "condition": "Take exact preflight and postflight file sets around reservation for unknown-outcome recovery; follow strict pagination for at most 20 pages and reject repeated continuations.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[buildUploadFiles]", "fixedValue": ["assetDeliveryState", "assetToken", "assetType", "fileName", "fileSize", "sourceFileChecksums", "uploadOperations", "uti"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[buildUploadFiles]", + "fixedValue": [ + "assetDeliveryState", + "assetToken", + "assetType", + "fileName", + "fileSize", + "sourceFileChecksums", + "uploadOperations", + "uti" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ] }, { @@ -286,38 +663,122 @@ "path": "/v1/buildUploadFiles", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "buildUploadFiles" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/buildUpload/data/type", "fixedValue": "buildUploads" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "buildUploadFiles" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/buildUpload/data/type", + "fixedValue": "buildUploads" + } ] } ], "fields": [ - { "toolField": "build_upload_id", "sourceKind": "parameter", "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "build_upload_id", "sourceKind": "requestBody", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/relationships/buildUpload/data/id" }, - { "toolField": "asset_type", "sourceKind": "requestBody", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/assetType" }, - { "toolField": "file_name", "sourceKind": "requestBody", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/fileName" }, - { "toolField": "file_size", "sourceKind": "requestBody", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/fileSize" }, - { "toolField": "uti", "sourceKind": "requestBody", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/uti" }, - { "toolField": "include_sensitive_details", "sourceKind": "local", "localRole": "False by default. When true, assetToken and uploadOperations are exposed only inside an exact confirmed successful BuildUploadFile resource path; recovered and all other error outputs remain redacted." } + { + "toolField": "build_upload_id", + "sourceKind": "parameter", + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "build_upload_id", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/relationships/buildUpload/data/id" + }, + { + "toolField": "asset_type", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/assetType" + }, + { + "toolField": "file_name", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/fileName" + }, + { + "toolField": "file_size", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/fileSize" + }, + { + "toolField": "uti", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/uti" + }, + { + "toolField": "include_sensitive_details", + "sourceKind": "local", + "localRole": "False by default. When true, assetToken and uploadOperations are exposed only inside an exact confirmed successful BuildUploadFile resource path; recovered and all other error outputs remain redacted." + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploadFiles_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploadFiles_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildUploadFile", "localRole": "For success, the fresh parent-scoped collection projection whose ID matches the contract-valid POST 201 response and was absent before the request; for ambiguous recovery, one unique unattributed candidate with transfer credentials redacted inside an error result." }, - { "outputField": "candidateId", "localRole": "Unique bounded-recovery candidate ID returned only for candidate_inspection_required." }, - { "outputField": "candidateAttributionConfirmed", "localRole": "False for every recovered candidate because concurrent reservation prevents attribution to this invocation." }, - { "outputField": "workflowState", "localRole": "candidate_inspection_required for one unique postflight candidate whose invocation ownership is not proven." }, - { "outputField": "createdByInvocation", "localRole": "True only after an exact 201 identity is absent from preflight and confirmed by a fresh requested-parent collection read." }, - { "outputField": "reconciledAfterCreate", "localRole": "True only for one uniquely observed exact postflight candidate; that outcome is success false and stops before transfer or commit." }, - { "outputField": "automaticDeletionAllowed", "localRole": "False for a uniquely recovered candidate because attribution to this invocation is not confirmed and no child delete exists." }, - { "outputField": "operationCommitState", "localRole": "committed only after exact 201 plus fresh parent-membership proof; preserves unknown for transport ambiguity and committed_unverified for an invalid accepted response or its recovered candidate." }, - { "outputField": "inspectionRequired", "localRole": "True for recovered or unresolved outcomes before another POST, transfer, or commit." }, - { "outputField": "inspection", "localRole": "Executable build_uploads_get_file or bounded build_uploads_list_files guidance using canonical IDs; inspection does not prove invocation ownership." }, - { "outputField": "retrySafe", "localRole": "False for recovered, committed_unverified, and unknown outcomes; the returned inspection guidance must be followed before another POST." } + { + "outputField": "buildUploadFile", + "localRole": "For success, the fresh parent-scoped collection projection whose ID matches the contract-valid POST 201 response and was absent before the request; for ambiguous recovery, one unique unattributed candidate with transfer credentials redacted inside an error result." + }, + { + "outputField": "candidateId", + "localRole": "Unique bounded-recovery candidate ID returned only for candidate_inspection_required." + }, + { + "outputField": "candidateAttributionConfirmed", + "localRole": "False for every recovered candidate because concurrent reservation prevents attribution to this invocation." + }, + { + "outputField": "workflowState", + "localRole": "candidate_inspection_required for one unique postflight candidate whose invocation ownership is not proven." + }, + { + "outputField": "createdByInvocation", + "localRole": "True only after an exact 201 identity is absent from preflight and confirmed by a fresh requested-parent collection read." + }, + { + "outputField": "reconciledAfterCreate", + "localRole": "True only for one uniquely observed exact postflight candidate; that outcome is success false and stops before transfer or commit." + }, + { + "outputField": "automaticDeletionAllowed", + "localRole": "False for a uniquely recovered candidate because attribution to this invocation is not confirmed and no child delete exists." + }, + { + "outputField": "operationCommitState", + "localRole": "committed only after exact 201 plus fresh parent-membership proof; preserves unknown for transport ambiguity and committed_unverified for an invalid accepted response or its recovered candidate." + }, + { + "outputField": "inspectionRequired", + "localRole": "True for recovered or unresolved outcomes before another POST, transfer, or commit." + }, + { + "outputField": "inspection", + "localRole": "Executable build_uploads_get_file or bounded build_uploads_list_files guidance using canonical IDs; inspection does not prove invocation ownership." + }, + { + "outputField": "retrySafe", + "localRole": "False for recovered, committed_unverified, and unknown outcomes; the returned inspection guidance must be followed before another POST." + } ] }, "note": "Invocation ownership and success require Apple's exact POST 201 with canonical type, ID, required self link, file fingerprint, absence from preflight, and fresh membership in the requested parent collection; the fresh scoped projection supplies any transfer operations. Ambiguous outcomes scan at most 20 strict pages; when one new exact candidate is found the call stops and returns success false, isError true, candidate_inspection_required, the original unknown or committed_unverified state, and executable inspection, while zero or multiple candidates remain unresolved. Recovered reservations are never owned, automatically deleted, exposed with transfer credentials, or safe to retry, and neither this tool nor Apple exposes child-file DELETE." @@ -335,7 +796,11 @@ "path": "/v1/buildUploadFiles/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "buildUploadFiles" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "buildUploadFiles" + } ] }, { @@ -345,32 +810,107 @@ "role": "conditional", "condition": "Diagnose an ambiguous or contract-invalid PATCH without claiming confirmation; the follow-up GET cannot prove that every requested writable attribute was applied.", "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["file_id"], "localRole": "Inspect only the exact file identifier supplied to PATCH." }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[buildUploadFiles]", "fixedValue": ["assetDeliveryState", "assetToken", "assetType", "fileName", "fileSize", "sourceFileChecksums", "uploadOperations", "uti"] } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "file_id" + ], + "localRole": "Inspect only the exact file identifier supplied to PATCH." + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[buildUploadFiles]", + "fixedValue": [ + "assetDeliveryState", + "assetToken", + "assetType", + "fileName", + "fileSize", + "sourceFileChecksums", + "uploadOperations", + "uti" + ] + } ] } ], "fields": [ - { "toolField": "file_id", "sourceKind": "parameter", "operationId": "buildUploadFiles_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "file_id", "sourceKind": "requestBody", "operationId": "buildUploadFiles_updateInstance", "jsonPointer": "/data/id" }, - { "toolField": "source_file_checksums", "sourceKind": "requestBody", "operationId": "buildUploadFiles_updateInstance", "jsonPointer": "/data/attributes/sourceFileChecksums" }, - { "toolField": "uploaded", "sourceKind": "requestBody", "operationId": "buildUploadFiles_updateInstance", "jsonPointer": "/data/attributes/uploaded" } + { + "toolField": "file_id", + "sourceKind": "parameter", + "operationId": "buildUploadFiles_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "file_id", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_updateInstance", + "jsonPointer": "/data/id" + }, + { + "toolField": "source_file_checksums", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_updateInstance", + "jsonPointer": "/data/attributes/sourceFileChecksums" + }, + { + "toolField": "uploaded", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_updateInstance", + "jsonPointer": "/data/attributes/uploaded" + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "buildUploadFiles_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploadFiles_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "buildUploadFiles_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploadFiles_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildUploadFile", "localRole": "Exact canonical BuildUploadFile from PATCH 200, or its redacted follow-up GET projection when an ambiguous PATCH requires diagnostic inspection." }, - { "outputField": "commitConfirmed", "localRole": "True only when PATCH returns the exact expected BuildUploadFile resource." }, - { "outputField": "reconciledAfterCommit", "localRole": "False for a directly confirmed PATCH; an ambiguous PATCH returns operationCommitState unknown instead of a false confirmation." }, - { "outputField": "operationCommitState", "localRole": "committed only for an exact PATCH 200 with canonical identity; committed_unverified for another accepted status or invalid success response; unknown when commitment cannot be determined." }, - { "outputField": "fileId", "localRole": "Always preserves the exact canonical PATCH input ID for ambiguous inspection, even when the diagnostic GET fails." }, - { "outputField": "inspectionRequired", "localRole": "True for every ambiguous PATCH outcome." }, - { "outputField": "inspection", "localRole": "Executable build_uploads_get_file guidance carrying the exact known file_id regardless of diagnostic GET success." }, - { "outputField": "retrySafe", "localRole": "False for every ambiguous or accepted-but-unverified PATCH result." } + { + "outputField": "buildUploadFile", + "localRole": "Exact canonical BuildUploadFile from PATCH 200, or its redacted follow-up GET projection when an ambiguous PATCH requires diagnostic inspection." + }, + { + "outputField": "commitConfirmed", + "localRole": "True only when PATCH returns the exact expected BuildUploadFile resource." + }, + { + "outputField": "reconciledAfterCommit", + "localRole": "False for a directly confirmed PATCH; an ambiguous PATCH returns operationCommitState unknown instead of a false confirmation." + }, + { + "outputField": "operationCommitState", + "localRole": "committed only for an exact PATCH 200 with canonical identity; committed_unverified for another accepted status or invalid success response; unknown when commitment cannot be determined." + }, + { + "outputField": "fileId", + "localRole": "Always preserves the exact canonical PATCH input ID for ambiguous inspection, even when the diagnostic GET fails." + }, + { + "outputField": "inspectionRequired", + "localRole": "True for every ambiguous PATCH outcome." + }, + { + "outputField": "inspection", + "localRole": "Executable build_uploads_get_file guidance carrying the exact known file_id regardless of diagnostic GET success." + }, + { + "outputField": "retrySafe", + "localRole": "False for every ambiguous or accepted-but-unverified PATCH result." + } ] }, "note": "Preserves omission versus explicit null for both optional Apple attributes and requires at least one attribute locally. Only Apple's exact PATCH 200 with canonical type, ID, and required self link confirms the commit. A GET after an ambiguous PATCH is diagnostic only because it cannot prove every writable attribute; the exact file ID and executable inspection remain present even if that GET fails, while the result stays non-retryable and never triggers deletion." @@ -389,7 +929,24 @@ "role": "supporting", "condition": "Confirm the supplied existing parent with an exact GET 200 before any reservation or transfer.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[buildUploads]", "fixedValue": ["cfBundleShortVersionString", "cfBundleVersion", "createdDate", "state", "platform", "uploadedDate", "build", "assetFile", "assetDescriptionFile", "assetSpiFile", "buildUploadFiles"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[buildUploads]", + "fixedValue": [ + "cfBundleShortVersionString", + "cfBundleVersion", + "createdDate", + "state", + "platform", + "uploadedDate", + "build", + "assetFile", + "assetDescriptionFile", + "assetSpiFile", + "buildUploadFiles" + ] + } ], "optionalParameterClassifications": [ { @@ -397,7 +954,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Parent identity and processing state are sufficient for upload-file ownership and polling; related resources do not affect the transfer contract.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -408,8 +965,27 @@ "role": "conditional", "condition": "Verify supplied file_id membership, or take exact preflight and postflight sets around a new reservation; recovery follows strict pagination for at most 20 pages and rejects repeated continuations.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[buildUploadFiles]", "fixedValue": ["assetDeliveryState", "assetToken", "assetType", "fileName", "fileSize", "sourceFileChecksums", "uploadOperations", "uti"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[buildUploadFiles]", + "fixedValue": [ + "assetDeliveryState", + "assetToken", + "assetType", + "fileName", + "fileSize", + "sourceFileChecksums", + "uploadOperations", + "uti" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ] }, { @@ -419,8 +995,16 @@ "role": "conditional", "condition": "Reserve a new file only when file_id is omitted. An exact POST 201 may continue; a uniquely recovered reservation is returned with continuation guidance and the workflow stops before transfer.", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "buildUploadFiles" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/buildUpload/data/type", "fixedValue": "buildUploads" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "buildUploadFiles" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/buildUpload/data/type", + "fixedValue": "buildUploads" + } ] }, { @@ -430,8 +1014,31 @@ "role": "conditional", "condition": "Load a resumed reservation, diagnose an ambiguous PATCH without claiming confirmation, and poll file delivery state only after a confirmed commit.", "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["file_id", "buildUploadFiles_createInstance:/data/id"], "localRole": "Use only a supplied and membership-verified resume ID or the exact canonical reservation ID confirmed by POST 201; recovered candidates require a later explicit resume call." }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[buildUploadFiles]", "fixedValue": ["assetDeliveryState", "assetToken", "assetType", "fileName", "fileSize", "sourceFileChecksums", "uploadOperations", "uti"] } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "file_id", + "buildUploadFiles_createInstance:/data/id" + ], + "localRole": "Use only a supplied and membership-verified resume ID or the exact canonical reservation ID confirmed by POST 201; recovered candidates require a later explicit resume call." + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[buildUploadFiles]", + "fixedValue": [ + "assetDeliveryState", + "assetToken", + "assetType", + "fileName", + "fileSize", + "sourceFileChecksums", + "uploadOperations", + "uti" + ] + } ] }, { @@ -441,51 +1048,208 @@ "role": "primary", "condition": "Commit the immutable bytes only after every presigned transfer operation succeeds.", "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["file_id", "buildUploadFiles_createInstance:/data/id"], "localRole": "Commit only the verified resumed file or the exact canonical reservation confirmed by POST 201; never a candidate recovered from an ambiguous POST in the same call." }, - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["file_id", "buildUploadFiles_createInstance:/data/id"], "localRole": "Copy the verified reservation identifier into the JSON:API update body." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "buildUploadFiles" }, - { "sourceKind": "derived", "jsonPointer": "/data/attributes/sourceFileChecksums", "derivedFrom": ["file_path"], "localRole": "Derive the MD5 checksum from the same immutable snapshot bytes transferred through every signed operation." }, - { "sourceKind": "fixed", "jsonPointer": "/data/attributes/uploaded", "fixedValue": true } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "file_id", + "buildUploadFiles_createInstance:/data/id" + ], + "localRole": "Commit only the verified resumed file or the exact canonical reservation confirmed by POST 201; never a candidate recovered from an ambiguous POST in the same call." + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "file_id", + "buildUploadFiles_createInstance:/data/id" + ], + "localRole": "Copy the verified reservation identifier into the JSON:API update body." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "buildUploadFiles" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/attributes/sourceFileChecksums", + "derivedFrom": [ + "file_path" + ], + "localRole": "Derive the MD5 checksum from the same immutable snapshot bytes transferred through every signed operation." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/uploaded", + "fixedValue": true + } ] } ], "fields": [ - { "toolField": "build_upload_id", "sourceKind": "parameter", "operationId": "buildUploads_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "build_upload_id", "sourceKind": "parameter", "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "build_upload_id", "sourceKind": "requestBody", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/relationships/buildUpload/data/id" }, - { "toolField": "file_id", "sourceKind": "local", "localRole": "Optional resume identity that cannot be supplied without expected_md5; when present it must be a canonical string before snapshot creation or any network request, then membership in build_upload_id and immutable snapshot name and size are verified before transfer." }, - { "toolField": "file_path", "sourceKind": "local", "localRole": "When a fresh reservation is required, reject a noncanonical path basename before snapshot creation or any Apple request. Create a fresh mode-0600 immutable snapshot before any Apple API request or presigned transfer, use it for every byte range, checksum, file name, and file size, and verify the MD5 again after all transfers before PATCH." }, - { "toolField": "expected_md5", "sourceKind": "local", "localRole": "Snapshot proof required whenever file_id is supplied and optional for a recovered-parent continuation; compare it with the MD5 of the fresh mode-0600 immutable snapshot before any Apple API request or presigned transfer, and stop without network activity on mismatch." }, - { "toolField": "file_path", "sourceKind": "derived", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/fileName", "derivedFrom": ["file_path"], "localRole": "Derive fileName from the immutable snapshot." }, - { "toolField": "file_path", "sourceKind": "derived", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/fileSize", "derivedFrom": ["file_path"], "localRole": "Derive fileSize from the immutable snapshot." }, - { "toolField": "asset_type", "sourceKind": "requestBody", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/assetType", "localRole": "When present, reject null, non-string, empty, or unsupported values before snapshot creation or any network request; required when file_id is omitted." }, - { "toolField": "uti", "sourceKind": "requestBody", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/uti", "localRole": "When present, reject null, non-string, empty, or unsupported values before snapshot creation or any network request; required when file_id is omitted." }, - { "toolField": "max_transfer_attempts", "sourceKind": "local", "localRole": "Bounds retries independently only when Apple explicitly specifies PUT. POST, PATCH, an omitted method, and every unknown method get one attempt. Redirects are rejected and App Store Connect JWT headers are never sent to signed transfer URLs." } + { + "toolField": "build_upload_id", + "sourceKind": "parameter", + "operationId": "buildUploads_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "build_upload_id", + "sourceKind": "parameter", + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "build_upload_id", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/relationships/buildUpload/data/id" + }, + { + "toolField": "file_id", + "sourceKind": "local", + "localRole": "Optional resume identity that cannot be supplied without expected_md5; when present it must be a canonical string before snapshot creation or any network request, then membership in build_upload_id and immutable snapshot name and size are verified before transfer." + }, + { + "toolField": "file_path", + "sourceKind": "local", + "localRole": "When a fresh reservation is required, reject a noncanonical path basename before snapshot creation or any Apple request. Create a fresh mode-0600 immutable snapshot before any Apple API request or presigned transfer, use it for every byte range, checksum, file name, and file size, and verify the MD5 again after all transfers before PATCH." + }, + { + "toolField": "expected_md5", + "sourceKind": "local", + "localRole": "Snapshot proof required whenever file_id is supplied and optional for a recovered-parent continuation; compare it with the MD5 of the fresh mode-0600 immutable snapshot before any Apple API request or presigned transfer, and stop without network activity on mismatch." + }, + { + "toolField": "file_path", + "sourceKind": "derived", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/fileName", + "derivedFrom": [ + "file_path" + ], + "localRole": "Derive fileName from the immutable snapshot." + }, + { + "toolField": "file_path", + "sourceKind": "derived", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/fileSize", + "derivedFrom": [ + "file_path" + ], + "localRole": "Derive fileSize from the immutable snapshot." + }, + { + "toolField": "asset_type", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/assetType", + "localRole": "When present, reject null, non-string, empty, or unsupported values before snapshot creation or any network request; required when file_id is omitted." + }, + { + "toolField": "uti", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/uti", + "localRole": "When present, reject null, non-string, empty, or unsupported values before snapshot creation or any network request; required when file_id is omitted." + }, + { + "toolField": "max_transfer_attempts", + "sourceKind": "local", + "localRole": "Bounds retries independently only when Apple explicitly specifies PUT. POST, PATCH, an omitted method, and every unknown method get one attempt. Redirects are rejected and App Store Connect JWT headers are never sent to signed transfer URLs." + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "buildUploads_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploadFiles_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "buildUploadFiles_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploadFiles_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "buildUploads_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploadFiles_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "buildUploadFiles_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploadFiles_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildUpload", "localRole": "Verified existing parent projection and its latest processing state." }, - { "outputField": "buildUploadFile", "localRole": "Reserved or resumed file projection with transfer credentials redacted." }, - { "outputField": "transferReceipts", "localRole": "Per-part operationIndex, method, offset, length, attempts, statusCode, expiration, partNumber, entityTag, and responseEntityTag; URL and request or response headers are never emitted." }, - { "outputField": "processingComplete", "localRole": "True only after Apple reports COMPLETE for the parent; a committed but still-processing upload is returned as pending." }, - { "outputField": "workflowState", "localRole": "continuation_required for one uniquely recovered reservation; reservation_unresolved for zero or multiple candidates; checksum_inspection_required when an initial UPLOAD_COMPLETE or COMPLETE file lacks matching Apple MD5 evidence." }, - { "outputField": "checksumEvidence", "localRole": "For checksum_inspection_required, returns the deliveryState, fresh immutable snapshotChecksum, nullable Apple file checksum algorithm and value, and verified false; transfer and PATCH are not attempted and both resources are retained for inspection." }, - { "outputField": "candidateAttributionConfirmed", "localRole": "False when a reservation is uniquely recovered after an ambiguous POST; that result is not treated as invocation-owned." }, - { "outputField": "operationCommitState", "localRole": "Preserves unknown for transport ambiguity and committed_unverified for an invalid accepted response when reservation recovery returns a continuation." }, - { "outputField": "continuationRequired", "localRole": "True for a uniquely recovered reservation; transfer and commit stop until an explicit build_uploads_upload_file call resumes with the returned buildUploadId and fileId." }, - { "outputField": "buildUploadId", "localRole": "Exact verified parent identifier needed for explicit continuation." }, - { "outputField": "fileId", "localRole": "Unique recovered reservation identifier needed for explicit continuation; absent when recovery remains unresolved." }, - { "outputField": "parentDeleted", "localRole": "False for continuation_required and checksum_inspection_required because the existing parent is retained." }, - { "outputField": "continuation", "localRole": "Exact build_uploads_upload_file tool name and arguments for an explicit resume call, carrying expected_md5 from the fresh immutable snapshot together with the recovered file ID." }, - { "outputField": "retrySafe", "localRole": "False for recovered, committed_unverified, checksum_inspection_required, unknown, and post-commit pending outcomes." } + { + "outputField": "buildUpload", + "localRole": "Verified existing parent projection and its latest processing state." + }, + { + "outputField": "buildUploadFile", + "localRole": "Reserved or resumed file projection with transfer credentials redacted." + }, + { + "outputField": "transferReceipts", + "localRole": "Per-part operationIndex, method, offset, length, attempts, statusCode, expiration, partNumber, entityTag, and responseEntityTag; URL and request or response headers are never emitted." + }, + { + "outputField": "processingComplete", + "localRole": "True only after Apple reports COMPLETE for the parent; a committed but still-processing upload is returned as pending." + }, + { + "outputField": "workflowState", + "localRole": "continuation_required for one uniquely recovered reservation; reservation_unresolved for zero or multiple candidates; checksum_inspection_required when an initial UPLOAD_COMPLETE or COMPLETE file lacks matching Apple MD5 evidence." + }, + { + "outputField": "checksumEvidence", + "localRole": "For checksum_inspection_required, returns the deliveryState, fresh immutable snapshotChecksum, nullable Apple file checksum algorithm and value, and verified false; transfer and PATCH are not attempted and both resources are retained for inspection." + }, + { + "outputField": "candidateAttributionConfirmed", + "localRole": "False when a reservation is uniquely recovered after an ambiguous POST; that result is not treated as invocation-owned." + }, + { + "outputField": "operationCommitState", + "localRole": "Preserves unknown for transport ambiguity and committed_unverified for an invalid accepted response when reservation recovery returns a continuation." + }, + { + "outputField": "continuationRequired", + "localRole": "True for a uniquely recovered reservation; transfer and commit stop until an explicit build_uploads_upload_file call resumes with the returned buildUploadId and fileId." + }, + { + "outputField": "buildUploadId", + "localRole": "Exact verified parent identifier needed for explicit continuation." + }, + { + "outputField": "fileId", + "localRole": "Unique recovered reservation identifier needed for explicit continuation; absent when recovery remains unresolved." + }, + { + "outputField": "parentDeleted", + "localRole": "False for continuation_required and checksum_inspection_required because the existing parent is retained." + }, + { + "outputField": "continuation", + "localRole": "Exact build_uploads_upload_file tool name and arguments for an explicit resume call, carrying expected_md5 from the fresh immutable snapshot together with the recovered file ID." + }, + { + "outputField": "retrySafe", + "localRole": "False for recovered, committed_unverified, checksum_inspection_required, unknown, and post-commit pending outcomes." + } ] }, "note": "Uses a fresh mode-0600 immutable snapshot and checks expected_md5 before any Apple API request or presigned transfer; expected_md5 is required with file_id resume and may prove a recovered-parent continuation. It verifies the snapshot MD5 again after all raw presigned transfers and exposes no transfer credentials. An initial UPLOAD_COMPLETE or COMPLETE file without matching Apple MD5 evidence returns checksum_inspection_required with checksumEvidence and committed_unverified; no transfer or PATCH occurs, both resources are retained, and retrySafe is false. Only explicit PUT operations may retry; other methods run once, redirects are rejected, and no ASC authorization is attached. A uniquely recovered reservation stops with exact continuation IDs and expected_md5 instead of transferring. Existing parents are never automatically deleted, ambiguous PATCH inspection cannot prove commit, and no child DELETE operation exists." @@ -504,8 +1268,30 @@ "role": "supporting", "condition": "Take exact preflight and postflight sets around parent creation for unknown-outcome recovery; follow strict pagination for at most 20 pages and reject repeated continuations.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[buildUploads]", "fixedValue": ["cfBundleShortVersionString", "cfBundleVersion", "createdDate", "state", "platform", "uploadedDate", "build", "assetFile", "assetDescriptionFile", "assetSpiFile", "buildUploadFiles"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[buildUploads]", + "fixedValue": [ + "cfBundleShortVersionString", + "cfBundleVersion", + "createdDate", + "state", + "platform", + "uploadedDate", + "build", + "assetFile", + "assetDescriptionFile", + "assetSpiFile", + "buildUploadFiles" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ { @@ -513,21 +1299,21 @@ "appleName": "filter[state]", "disposition": "intentionallyOmitted", "reason": "Recovery must compare the complete exact version/build/platform fingerprint regardless of current upload state.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "Recovery computes a set difference across every bounded page, so Apple result ordering cannot affect identity.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Parent recovery needs only BuildUpload identity and fingerprint attributes; related resources cannot prove create ownership.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -538,8 +1324,16 @@ "role": "primary", "condition": "Create the BuildUpload parent after the immutable local snapshot succeeds. An exact POST 201 may continue; a uniquely recovered parent is returned with continuation guidance and the workflow stops before file reservation.", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "buildUploads" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "buildUploads" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + } ] }, { @@ -549,9 +1343,36 @@ "role": "supporting", "condition": "Take exact preflight and postflight file sets around reservation for unknown-outcome recovery; follow strict pagination for at most 20 pages and reject repeated continuations.", "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["buildUploads_createInstance:/data/id"], "localRole": "Use only the exact canonical parent confirmed by POST 201; a recovered parent stops the workflow and requires explicit continuation." }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[buildUploadFiles]", "fixedValue": ["assetDeliveryState", "assetToken", "assetType", "fileName", "fileSize", "sourceFileChecksums", "uploadOperations", "uti"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "buildUploads_createInstance:/data/id" + ], + "localRole": "Use only the exact canonical parent confirmed by POST 201; a recovered parent stops the workflow and requires explicit continuation." + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[buildUploadFiles]", + "fixedValue": [ + "assetDeliveryState", + "assetToken", + "assetType", + "fileName", + "fileSize", + "sourceFileChecksums", + "uploadOperations", + "uti" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ] }, { @@ -561,9 +1382,24 @@ "role": "supporting", "condition": "Reserve the immutable snapshot under the exact confirmed parent. An exact POST 201 may continue; a uniquely recovered reservation is returned with continuation guidance and the workflow stops before transfer.", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "buildUploadFiles" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/buildUpload/data/type", "fixedValue": "buildUploads" }, - { "sourceKind": "derived", "jsonPointer": "/data/relationships/buildUpload/data/id", "derivedFrom": ["buildUploads_createInstance:/data/id"], "localRole": "Reserve the file only beneath the exact canonical parent confirmed by POST 201; never beneath a recovered parent in the same call." } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "buildUploadFiles" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/buildUpload/data/type", + "fixedValue": "buildUploads" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/relationships/buildUpload/data/id", + "derivedFrom": [ + "buildUploads_createInstance:/data/id" + ], + "localRole": "Reserve the file only beneath the exact canonical parent confirmed by POST 201; never beneath a recovered parent in the same call." + } ] }, { @@ -573,11 +1409,41 @@ "role": "supporting", "condition": "Commit only after every signed transfer part succeeds.", "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["buildUploadFiles_createInstance:/data/id"], "localRole": "Commit only the exact canonical reservation confirmed by POST 201; never a candidate recovered from an ambiguous POST in the same call." }, - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["buildUploadFiles_createInstance:/data/id"], "localRole": "Copy the exact reservation identifier into the JSON:API update body." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "buildUploadFiles" }, - { "sourceKind": "derived", "jsonPointer": "/data/attributes/sourceFileChecksums", "derivedFrom": ["file_path"], "localRole": "Derive MD5 from the same immutable snapshot bytes transferred through all signed operations." }, - { "sourceKind": "fixed", "jsonPointer": "/data/attributes/uploaded", "fixedValue": true } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "buildUploadFiles_createInstance:/data/id" + ], + "localRole": "Commit only the exact canonical reservation confirmed by POST 201; never a candidate recovered from an ambiguous POST in the same call." + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "buildUploadFiles_createInstance:/data/id" + ], + "localRole": "Copy the exact reservation identifier into the JSON:API update body." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "buildUploadFiles" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/attributes/sourceFileChecksums", + "derivedFrom": [ + "file_path" + ], + "localRole": "Derive MD5 from the same immutable snapshot bytes transferred through all signed operations." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/uploaded", + "fixedValue": true + } ] }, { @@ -587,8 +1453,30 @@ "role": "conditional", "condition": "Diagnose ambiguous PATCH without claiming confirmation and poll the exact file only after a confirmed commit.", "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["buildUploadFiles_createInstance:/data/id"], "localRole": "Read only the exact reserved file." }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[buildUploadFiles]", "fixedValue": ["assetDeliveryState", "assetToken", "assetType", "fileName", "fileSize", "sourceFileChecksums", "uploadOperations", "uti"] } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "buildUploadFiles_createInstance:/data/id" + ], + "localRole": "Read only the exact reserved file." + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[buildUploadFiles]", + "fixedValue": [ + "assetDeliveryState", + "assetToken", + "assetType", + "fileName", + "fileSize", + "sourceFileChecksums", + "uploadOperations", + "uti" + ] + } ] }, { @@ -598,8 +1486,33 @@ "role": "conditional", "condition": "Poll the exact parent after commit until COMPLETE, FAILED, cancellation, or the bounded local polling limit.", "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["buildUploads_createInstance:/data/id"], "localRole": "Read only the exact canonical parent confirmed by POST 201; recovered parents require explicit continuation." }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[buildUploads]", "fixedValue": ["cfBundleShortVersionString", "cfBundleVersion", "createdDate", "state", "platform", "uploadedDate", "build", "assetFile", "assetDescriptionFile", "assetSpiFile", "buildUploadFiles"] } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "buildUploads_createInstance:/data/id" + ], + "localRole": "Read only the exact canonical parent confirmed by POST 201; recovered parents require explicit continuation." + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[buildUploads]", + "fixedValue": [ + "cfBundleShortVersionString", + "cfBundleVersion", + "createdDate", + "state", + "platform", + "uploadedDate", + "build", + "assetFile", + "assetDescriptionFile", + "assetSpiFile", + "buildUploadFiles" + ] + } ], "optionalParameterClassifications": [ { @@ -607,7 +1520,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Post-commit polling needs parent processing state and build linkage already present in the base BuildUpload projection; expanded resources do not change terminal classification.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -618,54 +1531,219 @@ "role": "conditional", "condition": "Before any file PATCH is attempted, best-effort delete only a parent whose exact 201 response confirmed creation by this invocation; recovered or existing parents are retained.", "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["buildUploads_createInstance:/data/id"], "localRole": "Delete only a parent identity confirmed by this invocation, never a BuildUploadFile child." } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "buildUploads_createInstance:/data/id" + ], + "localRole": "Delete only a parent identity confirmed by this invocation, never a BuildUploadFile child." + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "app_id", "sourceKind": "requestBody", "operationId": "buildUploads_createInstance", "jsonPointer": "/data/relationships/app/data/id" }, - { "toolField": "short_version", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "filter[cfBundleShortVersionString]" }, - { "toolField": "short_version", "sourceKind": "requestBody", "operationId": "buildUploads_createInstance", "jsonPointer": "/data/attributes/cfBundleShortVersionString" }, - { "toolField": "build_version", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "filter[cfBundleVersion]" }, - { "toolField": "build_version", "sourceKind": "requestBody", "operationId": "buildUploads_createInstance", "jsonPointer": "/data/attributes/cfBundleVersion" }, - { "toolField": "platform", "sourceKind": "parameter", "operationId": "apps_buildUploads_getToManyRelated", "location": "query", "appleName": "filter[platform]" }, - { "toolField": "platform", "sourceKind": "requestBody", "operationId": "buildUploads_createInstance", "jsonPointer": "/data/attributes/platform" }, - { "toolField": "file_path", "sourceKind": "local", "localRole": "Reject a noncanonical path basename before snapshot creation or parent mutation. Create a mode-0600 immutable snapshot before parent creation, use it for every reservation field, transfer range, and checksum, then verify the MD5 again after all transfers before PATCH." }, - { "toolField": "file_path", "sourceKind": "derived", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/fileName", "derivedFrom": ["file_path"], "localRole": "Derive fileName from the immutable snapshot." }, - { "toolField": "file_path", "sourceKind": "derived", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/fileSize", "derivedFrom": ["file_path"], "localRole": "Derive fileSize from the immutable snapshot." }, - { "toolField": "asset_type", "sourceKind": "requestBody", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/assetType", "localRole": "Defaults to ASSET only when omitted; reject a present null, non-string, empty, or unsupported value before snapshot creation or any network request." }, - { "toolField": "uti", "sourceKind": "requestBody", "operationId": "buildUploadFiles_createInstance", "jsonPointer": "/data/attributes/uti", "localRole": "Reject a present null, non-string, empty, or unsupported value before snapshot creation or any network request." }, - { "toolField": "max_transfer_attempts", "sourceKind": "local", "localRole": "Bounds retries independently only when Apple explicitly specifies PUT. POST, PATCH, an omitted method, and every unknown method get one attempt. Redirects are rejected and signed transfer requests never receive the App Store Connect JWT." } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_id", + "sourceKind": "requestBody", + "operationId": "buildUploads_createInstance", + "jsonPointer": "/data/relationships/app/data/id" + }, + { + "toolField": "short_version", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "filter[cfBundleShortVersionString]" + }, + { + "toolField": "short_version", + "sourceKind": "requestBody", + "operationId": "buildUploads_createInstance", + "jsonPointer": "/data/attributes/cfBundleShortVersionString" + }, + { + "toolField": "build_version", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "filter[cfBundleVersion]" + }, + { + "toolField": "build_version", + "sourceKind": "requestBody", + "operationId": "buildUploads_createInstance", + "jsonPointer": "/data/attributes/cfBundleVersion" + }, + { + "toolField": "platform", + "sourceKind": "parameter", + "operationId": "apps_buildUploads_getToManyRelated", + "location": "query", + "appleName": "filter[platform]" + }, + { + "toolField": "platform", + "sourceKind": "requestBody", + "operationId": "buildUploads_createInstance", + "jsonPointer": "/data/attributes/platform" + }, + { + "toolField": "file_path", + "sourceKind": "local", + "localRole": "Reject a noncanonical path basename before snapshot creation or parent mutation. Create a mode-0600 immutable snapshot before parent creation, use it for every reservation field, transfer range, and checksum, then verify the MD5 again after all transfers before PATCH." + }, + { + "toolField": "file_path", + "sourceKind": "derived", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/fileName", + "derivedFrom": [ + "file_path" + ], + "localRole": "Derive fileName from the immutable snapshot." + }, + { + "toolField": "file_path", + "sourceKind": "derived", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/fileSize", + "derivedFrom": [ + "file_path" + ], + "localRole": "Derive fileSize from the immutable snapshot." + }, + { + "toolField": "asset_type", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/assetType", + "localRole": "Defaults to ASSET only when omitted; reject a present null, non-string, empty, or unsupported value before snapshot creation or any network request." + }, + { + "toolField": "uti", + "sourceKind": "requestBody", + "operationId": "buildUploadFiles_createInstance", + "jsonPointer": "/data/attributes/uti", + "localRole": "Reject a present null, non-string, empty, or unsupported value before snapshot creation or any network request." + }, + { + "toolField": "max_transfer_attempts", + "sourceKind": "local", + "localRole": "Bounds retries independently only when Apple explicitly specifies PUT. POST, PATCH, an omitted method, and every unknown method get one attempt. Redirects are rejected and signed transfer requests never receive the App Store Connect JWT." + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "apps_buildUploads_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploads_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "buildUploads_buildUploadFiles_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploadFiles_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "buildUploadFiles_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploadFiles_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploads_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "buildUploads_deleteInstance", "statusCode": "204" } + { + "operationId": "apps_buildUploads_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploads_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "buildUploads_buildUploadFiles_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploadFiles_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "buildUploadFiles_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploadFiles_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploads_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "buildUploads_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "buildUpload", "localRole": "Exact parent projection with current processing state and optional final Build relationship." }, - { "outputField": "buildUploadFile", "localRole": "Exact reserved file projection with credentials redacted." }, - { "outputField": "transferReceipts", "localRole": "Per-part operationIndex, method, offset, length, attempts, statusCode, expiration, partNumber, entityTag, and responseEntityTag; URL and request or response headers are never emitted." }, - { "outputField": "cleanup", "localRole": "Parent-only cleanup outcome, resource identity, and explicit inspection/deletion guidance." }, - { "outputField": "processingComplete", "localRole": "True only for parent COMPLETE; committed processing remains a successful pending result that is unsafe to retry blindly." }, - { "outputField": "workflowState", "localRole": "continuation_required for one uniquely recovered parent or file reservation; parent_unresolved for zero or multiple parent candidates; reservation_unresolved for zero or multiple file candidates; checksum_inspection_required when an initial UPLOAD_COMPLETE or COMPLETE file lacks matching Apple MD5 evidence." }, - { "outputField": "checksumEvidence", "localRole": "For checksum_inspection_required, returns the deliveryState, fresh immutable snapshotChecksum, nullable Apple file checksum algorithm and value, and verified false; transfer and PATCH are not attempted and both resources are retained for inspection." }, - { "outputField": "candidateAttributionConfirmed", "localRole": "False when a parent or file reservation is uniquely recovered after an ambiguous POST; that candidate is not treated as invocation-owned." }, - { "outputField": "operationCommitState", "localRole": "Preserves unknown for transport ambiguity and committed_unverified for an invalid accepted response when parent or reservation recovery returns a continuation." }, - { "outputField": "continuationRequired", "localRole": "True for a uniquely recovered parent or reservation; mutation stops and exact continuation.tool and arguments identify the explicit next call." }, - { "outputField": "buildUploadId", "localRole": "Unique recovered parent ID or exact confirmed parent ID needed for explicit continuation." }, - { "outputField": "fileId", "localRole": "Unique recovered file reservation ID when recovery stopped after file POST; absent for recovered-parent or unresolved outcomes." }, - { "outputField": "parentDeleted", "localRole": "False for continuation_required and checksum_inspection_required because no recovered, existing, or checksum-unverified parent is deleted." }, - { "outputField": "continuation", "localRole": "Exact build_uploads_upload_file tool name and arguments for an explicit resume call; recovered-parent and recovered-file continuations carry expected_md5 from the fresh immutable snapshot, with fileId included when a reservation was recovered." }, - { "outputField": "retrySafe", "localRole": "False for recovered, committed_unverified, checksum_inspection_required, unknown, and post-commit pending outcomes." + { + "outputField": "buildUpload", + "localRole": "Exact parent projection with current processing state and optional final Build relationship." + }, + { + "outputField": "buildUploadFile", + "localRole": "Exact reserved file projection with credentials redacted." + }, + { + "outputField": "transferReceipts", + "localRole": "Per-part operationIndex, method, offset, length, attempts, statusCode, expiration, partNumber, entityTag, and responseEntityTag; URL and request or response headers are never emitted." + }, + { + "outputField": "cleanup", + "localRole": "Parent-only cleanup outcome, resource identity, and explicit inspection/deletion guidance." + }, + { + "outputField": "processingComplete", + "localRole": "True only for parent COMPLETE; committed processing remains a successful pending result that is unsafe to retry blindly." + }, + { + "outputField": "workflowState", + "localRole": "continuation_required for one uniquely recovered parent or file reservation; parent_unresolved for zero or multiple parent candidates; reservation_unresolved for zero or multiple file candidates; checksum_inspection_required when an initial UPLOAD_COMPLETE or COMPLETE file lacks matching Apple MD5 evidence." + }, + { + "outputField": "checksumEvidence", + "localRole": "For checksum_inspection_required, returns the deliveryState, fresh immutable snapshotChecksum, nullable Apple file checksum algorithm and value, and verified false; transfer and PATCH are not attempted and both resources are retained for inspection." + }, + { + "outputField": "candidateAttributionConfirmed", + "localRole": "False when a parent or file reservation is uniquely recovered after an ambiguous POST; that candidate is not treated as invocation-owned." + }, + { + "outputField": "operationCommitState", + "localRole": "Preserves unknown for transport ambiguity and committed_unverified for an invalid accepted response when parent or reservation recovery returns a continuation." + }, + { + "outputField": "continuationRequired", + "localRole": "True for a uniquely recovered parent or reservation; mutation stops and exact continuation.tool and arguments identify the explicit next call." + }, + { + "outputField": "buildUploadId", + "localRole": "Unique recovered parent ID or exact confirmed parent ID needed for explicit continuation." + }, + { + "outputField": "fileId", + "localRole": "Unique recovered file reservation ID when recovery stopped after file POST; absent for recovered-parent or unresolved outcomes." + }, + { + "outputField": "parentDeleted", + "localRole": "False for continuation_required and checksum_inspection_required because no recovered, existing, or checksum-unverified parent is deleted." + }, + { + "outputField": "continuation", + "localRole": "Exact build_uploads_upload_file tool name and arguments for an explicit resume call; recovered-parent and recovered-file continuations carry expected_md5 from the fresh immutable snapshot, with fileId included when a reservation was recovered." + }, + { + "outputField": "retrySafe", + "localRole": "False for recovered, committed_unverified, checksum_inspection_required, unknown, and post-commit pending outcomes." } ] }, diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/builds.json b/Sources/asc-mcp/Resources/OperationManifest/tools/builds.json index 9930cc7..682f882 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/builds.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/builds.json @@ -19,112 +19,112 @@ "appleName": "include", "disposition": "internalControl", "reason": "The finder fixes include to app, buildBetaDetail, preReleaseVersion, and buildUpload so a stable match and upload-state projection can be produced.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit", "disposition": "internalControl", "reason": "The singular finder fixes limit to one after applying deterministic filters and sort.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "exists[usesNonExemptEncryption]", "disposition": "intentionallyOmitted", "reason": "Encryption-presence filtering belongs to builds_list; this tool is intentionally scoped to exact build-number lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[appStoreVersion]", "disposition": "intentionallyOmitted", "reason": "App Store version filtering belongs to builds_list; the finder supports platform and pre-release disambiguation.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[betaAppReviewSubmission.betaReviewState]", "disposition": "intentionallyOmitted", "reason": "Beta review-state filtering belongs to builds_list, not exact build-number lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta-group filtering belongs to builds_list, not exact build-number lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[buildAudienceType]", "disposition": "intentionallyOmitted", "reason": "Audience filtering belongs to builds_list, not exact build-number lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[expired]", "disposition": "intentionallyOmitted", "reason": "Expiration filtering belongs to builds_list, not exact build-number lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[id]", "disposition": "intentionallyOmitted", "reason": "A caller with a build ID should use builds_get; this finder is keyed by app and build number.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[processingState]", "disposition": "intentionallyOmitted", "reason": "Processing-state filtering belongs to builds_list, not exact build-number lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[usesNonExemptEncryption]", "disposition": "intentionallyOmitted", "reason": "Encryption-value filtering belongs to builds_list, not exact build-number lookup.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaBuildLocalizations]", "disposition": "intentionallyOmitted", "reason": "Beta build localizations are not included by the finder.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta groups are not included by the finder.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[buildBundles]", "disposition": "intentionallyOmitted", "reason": "Build bundles are not included by the finder.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[icons]", "disposition": "intentionallyOmitted", "reason": "Build icons are not included by the finder.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[individualTesters]", "disposition": "intentionallyOmitted", "reason": "Individual testers are not included by the finder.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -220,35 +220,35 @@ "appleName": "limit[betaBuildLocalizations]", "disposition": "intentionallyOmitted", "reason": "Beta build localizations are available through builds_list_beta_localizations and are not included by this detail tool.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta groups are available through builds_get_beta_groups and are not included by this detail tool.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[buildBundles]", "disposition": "intentionallyOmitted", "reason": "The detail tool intentionally returns Apple's bounded build-bundle include preview rather than exposing nested JSON:API pagination controls.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[icons]", "disposition": "intentionallyOmitted", "reason": "Build icons are not included by this detail tool.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[individualTesters]", "disposition": "intentionallyOmitted", "reason": "Individual testers are available through dedicated paginated tools and are not included here.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -318,42 +318,42 @@ "appleName": "include", "disposition": "internalControl", "reason": "The list fixes include to app, buildBetaDetail, preReleaseVersion, and buildUpload, which are projected in its included output.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaBuildLocalizations]", "disposition": "intentionallyOmitted", "reason": "Beta build localizations are not included by this list projection.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta groups are not included by this list projection.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[buildBundles]", "disposition": "intentionallyOmitted", "reason": "Build bundles are not included by this list projection.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[icons]", "disposition": "intentionallyOmitted", "reason": "Build icons are not included by this list projection.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[individualTesters]", "disposition": "intentionallyOmitted", "reason": "Individual testers are available through dedicated TestFlight tools and are not included here.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/company.json b/Sources/asc-mcp/Resources/OperationManifest/tools/company.json index 631c820..7026601 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/company.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/company.json @@ -13,7 +13,10 @@ "mode": "local", "sources": [], "fields": [ - { "outputField": "currentCompany", "localRole": "CompaniesManager active configuration with credential identifiers masked" } + { + "outputField": "currentCompany", + "localRole": "CompaniesManager active configuration with credential identifiers masked" + } ] }, "note": "Local configuration lookup; no App Store Connect REST operation is called. The response intentionally projects masked key and issuer identifiers rather than credentials." @@ -30,8 +33,14 @@ "mode": "local", "sources": [], "fields": [ - { "outputField": "companies", "localRole": "CompaniesManager configured companies with masked key IDs" }, - { "outputField": "currentCompanyId", "localRole": "CompaniesManager active company identifier" } + { + "outputField": "companies", + "localRole": "CompaniesManager configured companies with masked key IDs" + }, + { + "outputField": "currentCompanyId", + "localRole": "CompaniesManager active company identifier" + } ] }, "note": "Local server configuration inventory; it is not the App Store Connect Users API and does not discover provider organizations from Apple." @@ -44,13 +53,20 @@ "implementationState": "asBuilt", "operations": [], "fields": [ - { "toolField": "company", "sourceKind": "local", "localRole": "exact configured company ID, exact case-insensitive name, or unique case-insensitive partial name match; empty and ambiguous queries are rejected" } + { + "toolField": "company", + "sourceKind": "local", + "localRole": "exact configured company ID, exact case-insensitive name, or unique case-insensitive partial name match; empty and ambiguous queries are rejected" + } ], "response": { "mode": "local", "sources": [], "fields": [ - { "outputField": "company", "localRole": "new active company with masked credential identifiers" } + { + "outputField": "company", + "localRole": "new active company with masked credential identifiers" + } ] }, "note": "Local credential-context switch followed by atomic dependent worker replacement; no Apple REST operation is called. Partial-name selection succeeds only for a unique configured match, preventing accidental account selection." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/custom_pages.json b/Sources/asc-mcp/Resources/OperationManifest/tools/custom_pages.json index fbe2822..8dd8b5c 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/custom_pages.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/custom_pages.json @@ -14,47 +14,161 @@ "path": "/v1/appCustomProductPages", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appCustomProductPages" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appStoreVersionTemplate/data/type", "fixedValue": "appStoreVersions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/customProductPageTemplate/data/type", "fixedValue": "appCustomProductPages" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appCustomProductPages" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appStoreVersionTemplate/data/type", + "fixedValue": "appStoreVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/customProductPageTemplate/data/type", + "fixedValue": "appCustomProductPages" + } ], "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/relationships/appCustomProductPageVersions", "disposition": "internalControl", "reason": "The create workflow always generates local JSON:API IDs for the first page version and localization, then binds this relationship to that internally constructed inline version graph required by the public locale input.", "reviewAtSpec": "4.5.1" } + { + "location": "body", + "appleName": "/data/relationships/appCustomProductPageVersions", + "disposition": "internalControl", + "reason": "The create workflow always generates local JSON:API IDs for the first page version and localization, then binds this relationship to that internally constructed inline version graph required by the public locale input.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "requestBody", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/data/relationships/app/data/id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "locale", "sourceKind": "requestBody", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/included/*/attributes/locale" }, - { "toolField": "promotional_text", "sourceKind": "requestBody", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/included/*/attributes/promotionalText" }, - { "toolField": "template_version_id", "sourceKind": "requestBody", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/data/relationships/appStoreVersionTemplate/data/id" }, - { "toolField": "template_page_id", "sourceKind": "requestBody", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/data/relationships/customProductPageTemplate/data/id" } + { + "toolField": "app_id", + "sourceKind": "requestBody", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/data/relationships/app/data/id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "locale", + "sourceKind": "requestBody", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/included/*/attributes/locale" + }, + { + "toolField": "promotional_text", + "sourceKind": "requestBody", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/included/*/attributes/promotionalText" + }, + { + "toolField": "template_version_id", + "sourceKind": "requestBody", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/data/relationships/appStoreVersionTemplate/data/id" + }, + { + "toolField": "template_page_id", + "sourceKind": "requestBody", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/data/relationships/customProductPageTemplate/data/id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPages_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "appCustomProductPages_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Exact HTTP 201, canonical resource identity, required document self-link, requested name, and returned lineage when present were verified." }, - { "outputField": "operation", "localRole": "create_page" }, - { "outputField": "operationCommitted", "localRole": "True only after exact accepted-response verification." }, - { "outputField": "operationCommitState", "localRole": "committed only after exact verification; failures distinguish rejected, unknown, and committed_unverified." }, - { "outputField": "changed", "localRole": "True because Apple's exact 201 response proves creation of a new resource." }, - { "outputField": "retrySafe", "localRole": "False after a committed non-idempotent create." }, - { "outputField": "statusCode", "localRole": "Exact accepted HTTP status." }, - { "outputField": "custom_product_page.id", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/data/id" }, - { "outputField": "custom_product_page.type", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/data/type" }, - { "outputField": "custom_product_page.name", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/data/attributes/name" }, - { "outputField": "custom_product_page.nameState", "localRole": "Distinguish value, explicit null, and omitted name." }, - { "outputField": "custom_product_page.url", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/data/attributes/url" }, - { "outputField": "custom_product_page.urlState", "localRole": "Distinguish value, explicit null, and omitted URL." }, - { "outputField": "custom_product_page.visible", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/data/attributes/visible" }, - { "outputField": "custom_product_page.visibleState", "localRole": "Distinguish value, explicit null, and omitted visibility." }, - { "outputField": "custom_product_page.appId", "operationId": "appCustomProductPages_createInstance", "jsonPointer": "/data/relationships/app/data/id", "localRole": "Returned only when Apple supplied and the handler validated this parent relationship." }, - { "outputField": "custom_product_page.state", "localRole": "Legacy compatibility placeholder set to null because Apple exposes state on page versions, not pages." } + { + "outputField": "success", + "localRole": "Exact HTTP 201, canonical resource identity, required document self-link, requested name, and returned lineage when present were verified." + }, + { + "outputField": "operation", + "localRole": "create_page" + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact accepted-response verification." + }, + { + "outputField": "operationCommitState", + "localRole": "committed only after exact verification; failures distinguish rejected, unknown, and committed_unverified." + }, + { + "outputField": "changed", + "localRole": "True because Apple's exact 201 response proves creation of a new resource." + }, + { + "outputField": "retrySafe", + "localRole": "False after a committed non-idempotent create." + }, + { + "outputField": "statusCode", + "localRole": "Exact accepted HTTP status." + }, + { + "outputField": "custom_product_page.id", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "custom_product_page.type", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "custom_product_page.name", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "outputField": "custom_product_page.nameState", + "localRole": "Distinguish value, explicit null, and omitted name." + }, + { + "outputField": "custom_product_page.url", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/data/attributes/url" + }, + { + "outputField": "custom_product_page.urlState", + "localRole": "Distinguish value, explicit null, and omitted URL." + }, + { + "outputField": "custom_product_page.visible", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/data/attributes/visible" + }, + { + "outputField": "custom_product_page.visibleState", + "localRole": "Distinguish value, explicit null, and omitted visibility." + }, + { + "outputField": "custom_product_page.appId", + "operationId": "appCustomProductPages_createInstance", + "jsonPointer": "/data/relationships/app/data/id", + "localRole": "Returned only when Apple supplied and the handler validated this parent relationship." + }, + { + "outputField": "custom_product_page.state", + "localRole": "Legacy compatibility placeholder set to null because Apple exposes state on page versions, not pages." + } ] }, "note": "Apple supports inline creation of the first version and localization in this POST. Its App Store version and custom-product-page template relationships are independent, so callers may supply either one or both." @@ -72,38 +186,116 @@ "path": "/v1/appCustomProductPageLocalizations", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appCustomProductPageLocalizations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/type", "fixedValue": "appCustomProductPageVersions" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appCustomProductPageLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/type", + "fixedValue": "appCustomProductPageVersions" + } ], "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/relationships/placements", "disposition": "intentionallyOmitted", "reason": "Localization creation and Asset Library placement are separate operations. This legacy create tool does not attach existing placement IDs; prepare and apply placement creation through AssetsWorker after creating the localization so ownership, specification, draft state, and preview checks remain mandatory.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/relationships/placements", + "disposition": "intentionallyOmitted", + "reason": "Localization creation and Asset Library placement are separate operations. This legacy create tool does not attach existing placement IDs; prepare and apply placement creation through AssetsWorker after creating the localization so ownership, specification, draft state, and preview checks remain mandatory.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "version_id", "sourceKind": "requestBody", "operationId": "appCustomProductPageLocalizations_createInstance", "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/id" }, - { "toolField": "locale", "sourceKind": "requestBody", "operationId": "appCustomProductPageLocalizations_createInstance", "jsonPointer": "/data/attributes/locale" }, - { "toolField": "promotional_text", "sourceKind": "requestBody", "operationId": "appCustomProductPageLocalizations_createInstance", "jsonPointer": "/data/attributes/promotionalText" } + { + "toolField": "version_id", + "sourceKind": "requestBody", + "operationId": "appCustomProductPageLocalizations_createInstance", + "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/id" + }, + { + "toolField": "locale", + "sourceKind": "requestBody", + "operationId": "appCustomProductPageLocalizations_createInstance", + "jsonPointer": "/data/attributes/locale" + }, + { + "toolField": "promotional_text", + "sourceKind": "requestBody", + "operationId": "appCustomProductPageLocalizations_createInstance", + "jsonPointer": "/data/attributes/promotionalText" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPageLocalizations_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "appCustomProductPageLocalizations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Exact HTTP 201, canonical resource identity, required document self-link, requested attributes, and returned parent lineage when present were verified." }, - { "outputField": "operation", "localRole": "create_localization" }, - { "outputField": "operationCommitted", "localRole": "True only after exact accepted-response verification." }, - { "outputField": "operationCommitState", "localRole": "Structured non-idempotent write outcome." }, - { "outputField": "changed", "localRole": "True because Apple's exact 201 response proves creation." }, - { "outputField": "retrySafe", "localRole": "False after committed creation." }, - { "outputField": "statusCode", "localRole": "Exact accepted HTTP status." }, - { "outputField": "localization.id", "operationId": "appCustomProductPageLocalizations_createInstance", "jsonPointer": "/data/id" }, - { "outputField": "localization.type", "operationId": "appCustomProductPageLocalizations_createInstance", "jsonPointer": "/data/type" }, - { "outputField": "localization.locale", "operationId": "appCustomProductPageLocalizations_createInstance", "jsonPointer": "/data/attributes/locale" }, - { "outputField": "localization.promotionalText", "operationId": "appCustomProductPageLocalizations_createInstance", "jsonPointer": "/data/attributes/promotionalText" }, - { "outputField": "localization.promotionalTextState", "localRole": "Distinguish value, explicit null, and omitted promotional text." }, - { "outputField": "localization.versionId", "operationId": "appCustomProductPageLocalizations_createInstance", "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/id", "localRole": "Returned only when Apple supplied and the handler validated this parent relationship." } + { + "outputField": "success", + "localRole": "Exact HTTP 201, canonical resource identity, required document self-link, requested attributes, and returned parent lineage when present were verified." + }, + { + "outputField": "operation", + "localRole": "create_localization" + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact accepted-response verification." + }, + { + "outputField": "operationCommitState", + "localRole": "Structured non-idempotent write outcome." + }, + { + "outputField": "changed", + "localRole": "True because Apple's exact 201 response proves creation." + }, + { + "outputField": "retrySafe", + "localRole": "False after committed creation." + }, + { + "outputField": "statusCode", + "localRole": "Exact accepted HTTP status." + }, + { + "outputField": "localization.id", + "operationId": "appCustomProductPageLocalizations_createInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "localization.type", + "operationId": "appCustomProductPageLocalizations_createInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "localization.locale", + "operationId": "appCustomProductPageLocalizations_createInstance", + "jsonPointer": "/data/attributes/locale" + }, + { + "outputField": "localization.promotionalText", + "operationId": "appCustomProductPageLocalizations_createInstance", + "jsonPointer": "/data/attributes/promotionalText" + }, + { + "outputField": "localization.promotionalTextState", + "localRole": "Distinguish value, explicit null, and omitted promotional text." + }, + { + "outputField": "localization.versionId", + "operationId": "appCustomProductPageLocalizations_createInstance", + "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/id", + "localRole": "Returned only when Apple supplied and the handler validated this parent relationship." + } ] } }, @@ -120,38 +312,115 @@ "path": "/v1/appCustomProductPageVersions", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appCustomProductPageVersions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appCustomProductPage/data/type", "fixedValue": "appCustomProductPages" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appCustomProductPageVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appCustomProductPage/data/type", + "fixedValue": "appCustomProductPages" + } ], "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/relationships/appCustomProductPageLocalizations", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1's standalone AppCustomProductPageVersionCreateRequest has no top-level included member for inline localization resources; this tool creates the version first and callers create its owned localizations through appCustomProductPageLocalizations_createInstance instead of attempting to reparent existing localization IDs.", "reviewAtSpec": "4.5.1" } + { + "location": "body", + "appleName": "/data/relationships/appCustomProductPageLocalizations", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1's standalone AppCustomProductPageVersionCreateRequest has no top-level included member for inline localization resources; this tool creates the version first and callers create its owned localizations through appCustomProductPageLocalizations_createInstance instead of attempting to reparent existing localization IDs.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "page_id", "sourceKind": "requestBody", "operationId": "appCustomProductPageVersions_createInstance", "jsonPointer": "/data/relationships/appCustomProductPage/data/id" }, - { "toolField": "deep_link", "sourceKind": "requestBody", "operationId": "appCustomProductPageVersions_createInstance", "jsonPointer": "/data/attributes/deepLink" } + { + "toolField": "page_id", + "sourceKind": "requestBody", + "operationId": "appCustomProductPageVersions_createInstance", + "jsonPointer": "/data/relationships/appCustomProductPage/data/id" + }, + { + "toolField": "deep_link", + "sourceKind": "requestBody", + "operationId": "appCustomProductPageVersions_createInstance", + "jsonPointer": "/data/attributes/deepLink" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPageVersions_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "appCustomProductPageVersions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Exact HTTP 201, canonical resource identity, required document self-link, requested deep-link state, and returned parent lineage when present were verified." }, - { "outputField": "operation", "localRole": "create_version" }, - { "outputField": "operationCommitted", "localRole": "True only after exact accepted-response verification." }, - { "outputField": "operationCommitState", "localRole": "Structured non-idempotent write outcome." }, - { "outputField": "changed", "localRole": "True because Apple's exact 201 response proves creation." }, - { "outputField": "retrySafe", "localRole": "False after committed creation." }, - { "outputField": "statusCode", "localRole": "Exact accepted HTTP status." }, - { "outputField": "version.id", "operationId": "appCustomProductPageVersions_createInstance", "jsonPointer": "/data/id" }, - { "outputField": "version.type", "operationId": "appCustomProductPageVersions_createInstance", "jsonPointer": "/data/type" }, - { "outputField": "version.version", "operationId": "appCustomProductPageVersions_createInstance", "jsonPointer": "/data/attributes/version" }, - { "outputField": "version.state", "operationId": "appCustomProductPageVersions_createInstance", "jsonPointer": "/data/attributes/state" }, - { "outputField": "version.deepLink", "operationId": "appCustomProductPageVersions_createInstance", "jsonPointer": "/data/attributes/deepLink" }, - { "outputField": "version.deepLinkState", "localRole": "Distinguish value, explicit null, and omitted deep link." }, - { "outputField": "version.pageId", "operationId": "appCustomProductPageVersions_createInstance", "jsonPointer": "/data/relationships/appCustomProductPage/data/id", "localRole": "Returned only when Apple supplied and the handler validated this parent relationship." } + { + "outputField": "success", + "localRole": "Exact HTTP 201, canonical resource identity, required document self-link, requested deep-link state, and returned parent lineage when present were verified." + }, + { + "outputField": "operation", + "localRole": "create_version" + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact accepted-response verification." + }, + { + "outputField": "operationCommitState", + "localRole": "Structured non-idempotent write outcome." + }, + { + "outputField": "changed", + "localRole": "True because Apple's exact 201 response proves creation." + }, + { + "outputField": "retrySafe", + "localRole": "False after committed creation." + }, + { + "outputField": "statusCode", + "localRole": "Exact accepted HTTP status." + }, + { + "outputField": "version.id", + "operationId": "appCustomProductPageVersions_createInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "version.type", + "operationId": "appCustomProductPageVersions_createInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "version.version", + "operationId": "appCustomProductPageVersions_createInstance", + "jsonPointer": "/data/attributes/version" + }, + { + "outputField": "version.state", + "operationId": "appCustomProductPageVersions_createInstance", + "jsonPointer": "/data/attributes/state" + }, + { + "outputField": "version.deepLink", + "operationId": "appCustomProductPageVersions_createInstance", + "jsonPointer": "/data/attributes/deepLink" + }, + { + "outputField": "version.deepLinkState", + "localRole": "Distinguish value, explicit null, and omitted deep link." + }, + { + "outputField": "version.pageId", + "operationId": "appCustomProductPageVersions_createInstance", + "jsonPointer": "/data/relationships/appCustomProductPage/data/id", + "localRole": "Returned only when Apple supplied and the handler validated this parent relationship." + } ] }, "note": "The tool exposes Apple's nullable deepLink attribute. Localizations are created after the version through the dedicated localization create operation because this standalone request has no inline included resource array." @@ -163,25 +432,72 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "appCustomProductPages_deleteInstance", "method": "delete", "path": "/v1/appCustomProductPages/{id}", "role": "primary" } + { + "operationId": "appCustomProductPages_deleteInstance", + "method": "delete", + "path": "/v1/appCustomProductPages/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "page_id", "sourceKind": "parameter", "operationId": "appCustomProductPages_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_page_id", "sourceKind": "local", "localRole": "Require an exact canonical match with page_id before any Apple request is sent." } + { + "toolField": "page_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPages_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_page_id", + "sourceKind": "local", + "localRole": "Require an exact canonical match with page_id before any Apple request is sent." + } ], "response": { "mode": "local", - "sources": [{ "operationId": "appCustomProductPages_deleteInstance", "statusCode": "204" }], + "sources": [ + { + "operationId": "appCustomProductPages_deleteInstance", + "statusCode": "204" + } + ], "fields": [ - { "outputField": "success", "localRole": "True only for Apple's exact HTTP 204 response." }, - { "outputField": "operation", "localRole": "delete_page" }, - { "outputField": "operationCommitted", "localRole": "True only for exact HTTP 204." }, - { "outputField": "operationCommitState", "localRole": "Structured destructive-operation outcome." }, - { "outputField": "changed", "localRole": "True because exact HTTP 204 follows an existing-resource delete contract." }, - { "outputField": "retrySafe", "localRole": "False after committed deletion." }, - { "outputField": "pageId", "localRole": "Canonical target page ID." }, - { "outputField": "statusCode", "localRole": "Exact accepted HTTP status." }, - { "outputField": "message", "localRole": "Local deletion confirmation." } + { + "outputField": "success", + "localRole": "True only for Apple's exact HTTP 204 response." + }, + { + "outputField": "operation", + "localRole": "delete_page" + }, + { + "outputField": "operationCommitted", + "localRole": "True only for exact HTTP 204." + }, + { + "outputField": "operationCommitState", + "localRole": "Structured destructive-operation outcome." + }, + { + "outputField": "changed", + "localRole": "True because exact HTTP 204 follows an existing-resource delete contract." + }, + { + "outputField": "retrySafe", + "localRole": "False after committed deletion." + }, + { + "outputField": "pageId", + "localRole": "Canonical target page ID." + }, + { + "outputField": "statusCode", + "localRole": "Exact accepted HTTP status." + }, + { + "outputField": "message", + "localRole": "Local deletion confirmation." + } ] }, "note": "Apple returns 204; the MCP deletion confirmation is local." @@ -199,31 +515,93 @@ "path": "/v1/appCustomProductPages/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The get tool projects only the primary appCustomProductPages resource and does not decode Apple's top-level included relationship resources, so exposing include would silently discard the requested expansion.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appCustomProductPageVersions]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only when appCustomProductPageVersions is requested through include; the get tool intentionally returns the base page without relationship expansion.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The get tool projects only the primary appCustomProductPages resource and does not decode Apple's top-level included relationship resources, so exposing include would silently discard the requested expansion.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appCustomProductPageVersions]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only when appCustomProductPageVersions is requested through include; the get tool intentionally returns the base page without relationship expansion.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "page_id", "sourceKind": "parameter", "operationId": "appCustomProductPages_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "page_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPages_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPages_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appCustomProductPages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Exact HTTP 200, canonical identity, required document self-link, and returned relationships were validated." }, - { "outputField": "custom_product_page.id", "operationId": "appCustomProductPages_getInstance", "jsonPointer": "/data/id" }, - { "outputField": "custom_product_page.type", "operationId": "appCustomProductPages_getInstance", "jsonPointer": "/data/type" }, - { "outputField": "custom_product_page.name", "operationId": "appCustomProductPages_getInstance", "jsonPointer": "/data/attributes/name" }, - { "outputField": "custom_product_page.nameState", "localRole": "Distinguish value, explicit null, and omitted name." }, - { "outputField": "custom_product_page.url", "operationId": "appCustomProductPages_getInstance", "jsonPointer": "/data/attributes/url" }, - { "outputField": "custom_product_page.urlState", "localRole": "Distinguish value, explicit null, and omitted URL." }, - { "outputField": "custom_product_page.visible", "operationId": "appCustomProductPages_getInstance", "jsonPointer": "/data/attributes/visible" }, - { "outputField": "custom_product_page.visibleState", "localRole": "Distinguish value, explicit null, and omitted visibility." }, - { "outputField": "custom_product_page.appId", "operationId": "appCustomProductPages_getInstance", "jsonPointer": "/data/relationships/app/data/id", "localRole": "Returned only after parent relationship validation." }, - { "outputField": "custom_product_page.state", "localRole": "Legacy compatibility placeholder set to null." } + { + "outputField": "success", + "localRole": "Exact HTTP 200, canonical identity, required document self-link, and returned relationships were validated." + }, + { + "outputField": "custom_product_page.id", + "operationId": "appCustomProductPages_getInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "custom_product_page.type", + "operationId": "appCustomProductPages_getInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "custom_product_page.name", + "operationId": "appCustomProductPages_getInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "outputField": "custom_product_page.nameState", + "localRole": "Distinguish value, explicit null, and omitted name." + }, + { + "outputField": "custom_product_page.url", + "operationId": "appCustomProductPages_getInstance", + "jsonPointer": "/data/attributes/url" + }, + { + "outputField": "custom_product_page.urlState", + "localRole": "Distinguish value, explicit null, and omitted URL." + }, + { + "outputField": "custom_product_page.visible", + "operationId": "appCustomProductPages_getInstance", + "jsonPointer": "/data/attributes/visible" + }, + { + "outputField": "custom_product_page.visibleState", + "localRole": "Distinguish value, explicit null, and omitted visibility." + }, + { + "outputField": "custom_product_page.appId", + "operationId": "appCustomProductPages_getInstance", + "jsonPointer": "/data/relationships/app/data/id", + "localRole": "Returned only after parent relationship validation." + }, + { + "outputField": "custom_product_page.state", + "localRole": "Legacy compatibility placeholder set to null." + } ] } }, @@ -240,38 +618,129 @@ "path": "/v1/apps/{id}/appCustomProductPages", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The list tool returns only its primary appCustomProductPages array and does not decode Apple's top-level included resources, so relationship expansion is deliberately unavailable.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appCustomProductPageVersions]", "disposition": "intentionallyOmitted", "reason": "Apple uses this nested limit only for included appCustomProductPageVersions; the list tool does not request or project that relationship.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The list tool returns only its primary appCustomProductPages array and does not decode Apple's top-level included resources, so relationship expansion is deliberately unavailable.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appCustomProductPageVersions]", + "disposition": "intentionallyOmitted", + "reason": "Apple uses this nested limit only for included appCustomProductPageVersions; the list tool does not request or project that relationship.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_appCustomProductPages_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "visible", "sourceKind": "parameter", "operationId": "apps_appCustomProductPages_getToManyRelated", "location": "query", "appleName": "filter[visible]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "apps_appCustomProductPages_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_appCustomProductPages_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "visible", + "sourceKind": "parameter", + "operationId": "apps_appCustomProductPages_getToManyRelated", + "location": "query", + "appleName": "filter[visible]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_appCustomProductPages_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "apps_appCustomProductPages_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_appCustomProductPages_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Validated collection response." }, - { "outputField": "appId", "localRole": "Canonical app scope established by the requested relationship path." }, - { "outputField": "custom_product_pages.*.id", "operationId": "apps_appCustomProductPages_getToManyRelated", "jsonPointer": "/data/*/id" }, - { "outputField": "custom_product_pages.*.type", "operationId": "apps_appCustomProductPages_getToManyRelated", "jsonPointer": "/data/*/type" }, - { "outputField": "custom_product_pages.*.name", "operationId": "apps_appCustomProductPages_getToManyRelated", "jsonPointer": "/data/*/attributes/name" }, - { "outputField": "custom_product_pages.*.nameState", "localRole": "Distinguish value, explicit null, and omitted name per resource." }, - { "outputField": "custom_product_pages.*.url", "operationId": "apps_appCustomProductPages_getToManyRelated", "jsonPointer": "/data/*/attributes/url" }, - { "outputField": "custom_product_pages.*.urlState", "localRole": "Distinguish value, explicit null, and omitted URL per resource." }, - { "outputField": "custom_product_pages.*.visible", "operationId": "apps_appCustomProductPages_getToManyRelated", "jsonPointer": "/data/*/attributes/visible" }, - { "outputField": "custom_product_pages.*.visibleState", "localRole": "Distinguish value, explicit null, and omitted visibility per resource." }, - { "outputField": "custom_product_pages.*.appId", "operationId": "apps_appCustomProductPages_getToManyRelated", "jsonPointer": "/data/*/relationships/app/data/id", "localRole": "Returned only when Apple supplied and the handler validated the parent relationship." }, - { "outputField": "custom_product_pages.*.state", "localRole": "Legacy compatibility placeholder set to null." }, - { "outputField": "count", "localRole": "Number of validated page resources in this page." }, - { "outputField": "limit", "localRole": "Effective validated page limit." }, - { "outputField": "next_url", "operationId": "apps_appCustomProductPages_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "Validated collection response." + }, + { + "outputField": "appId", + "localRole": "Canonical app scope established by the requested relationship path." + }, + { + "outputField": "custom_product_pages.*.id", + "operationId": "apps_appCustomProductPages_getToManyRelated", + "jsonPointer": "/data/*/id" + }, + { + "outputField": "custom_product_pages.*.type", + "operationId": "apps_appCustomProductPages_getToManyRelated", + "jsonPointer": "/data/*/type" + }, + { + "outputField": "custom_product_pages.*.name", + "operationId": "apps_appCustomProductPages_getToManyRelated", + "jsonPointer": "/data/*/attributes/name" + }, + { + "outputField": "custom_product_pages.*.nameState", + "localRole": "Distinguish value, explicit null, and omitted name per resource." + }, + { + "outputField": "custom_product_pages.*.url", + "operationId": "apps_appCustomProductPages_getToManyRelated", + "jsonPointer": "/data/*/attributes/url" + }, + { + "outputField": "custom_product_pages.*.urlState", + "localRole": "Distinguish value, explicit null, and omitted URL per resource." + }, + { + "outputField": "custom_product_pages.*.visible", + "operationId": "apps_appCustomProductPages_getToManyRelated", + "jsonPointer": "/data/*/attributes/visible" + }, + { + "outputField": "custom_product_pages.*.visibleState", + "localRole": "Distinguish value, explicit null, and omitted visibility per resource." + }, + { + "outputField": "custom_product_pages.*.appId", + "operationId": "apps_appCustomProductPages_getToManyRelated", + "jsonPointer": "/data/*/relationships/app/data/id", + "localRole": "Returned only when Apple supplied and the handler validated the parent relationship." + }, + { + "outputField": "custom_product_pages.*.state", + "localRole": "Legacy compatibility placeholder set to null." + }, + { + "outputField": "count", + "localRole": "Number of validated page resources in this page." + }, + { + "outputField": "limit", + "localRole": "Effective validated page limit." + }, + { + "outputField": "next_url", + "operationId": "apps_appCustomProductPages_getToManyRelated", + "jsonPointer": "/links/next" + } ] } }, @@ -288,37 +757,133 @@ "path": "/v1/appCustomProductPageVersions/{id}/appCustomProductPageLocalizations", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The localization list projects only primary appCustomProductPageLocalizations resources and does not decode Apple's included screenshot, preview, keyword, placement, or parent-version resources.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only when appPreviewSets is included; this tool neither requests nor projects preview-set relationship resources.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only when appScreenshotSets is included; this tool neither requests nor projects screenshot-set relationship resources.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only when searchKeywords is included; this tool neither requests nor projects keyword relationship resources.", "reviewAtSpec": "4.5.1" }, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The localization list projects only primary appCustomProductPageLocalizations resources and does not decode Apple's included screenshot, preview, keyword, placement, or parent-version resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only when appPreviewSets is included; this tool neither requests nor projects preview-set relationship resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only when appScreenshotSets is included; this tool neither requests nor projects screenshot-set relationship resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only when searchKeywords is included; this tool neither requests nor projects keyword relationship resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "locale", "sourceKind": "parameter", "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "location": "query", "appleName": "filter[locale]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "locale", + "sourceKind": "parameter", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "location": "query", + "appleName": "filter[locale]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Validated collection response." }, - { "outputField": "versionId", "localRole": "Canonical version scope established by the requested relationship path." }, - { "outputField": "localizations.*.id", "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "jsonPointer": "/data/*/id" }, - { "outputField": "localizations.*.type", "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "jsonPointer": "/data/*/type" }, - { "outputField": "localizations.*.locale", "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "jsonPointer": "/data/*/attributes/locale" }, - { "outputField": "localizations.*.promotionalText", "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "jsonPointer": "/data/*/attributes/promotionalText" }, - { "outputField": "localizations.*.promotionalTextState", "localRole": "Distinguish value, explicit null, and omitted promotional text per resource." }, - { "outputField": "localizations.*.versionId", "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "jsonPointer": "/data/*/relationships/appCustomProductPageVersion/data/id", "localRole": "Returned only when Apple supplied and the handler validated the parent relationship." }, - { "outputField": "count", "localRole": "Number of validated localization resources in this page." }, - { "outputField": "limit", "localRole": "Effective validated page limit." }, - { "outputField": "next_url", "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "Validated collection response." + }, + { + "outputField": "versionId", + "localRole": "Canonical version scope established by the requested relationship path." + }, + { + "outputField": "localizations.*.id", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "jsonPointer": "/data/*/id" + }, + { + "outputField": "localizations.*.type", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "jsonPointer": "/data/*/type" + }, + { + "outputField": "localizations.*.locale", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "jsonPointer": "/data/*/attributes/locale" + }, + { + "outputField": "localizations.*.promotionalText", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "jsonPointer": "/data/*/attributes/promotionalText" + }, + { + "outputField": "localizations.*.promotionalTextState", + "localRole": "Distinguish value, explicit null, and omitted promotional text per resource." + }, + { + "outputField": "localizations.*.versionId", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "jsonPointer": "/data/*/relationships/appCustomProductPageVersion/data/id", + "localRole": "Returned only when Apple supplied and the handler validated the parent relationship." + }, + { + "outputField": "count", + "localRole": "Number of validated localization resources in this page." + }, + { + "outputField": "limit", + "localRole": "Effective validated page limit." + }, + { + "outputField": "next_url", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "jsonPointer": "/links/next" + } ] } }, @@ -335,35 +900,117 @@ "path": "/v1/appCustomProductPages/{id}/appCustomProductPageVersions", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The version list projects only primary appCustomProductPageVersions resources and does not decode Apple's included page or localization resources.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appCustomProductPageLocalizations]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only when appCustomProductPageLocalizations is included; this tool leaves relationship expansion to custom_pages_list_localizations.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The version list projects only primary appCustomProductPageVersions resources and does not decode Apple's included page or localization resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appCustomProductPageLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only when appCustomProductPageLocalizations is included; this tool leaves relationship expansion to custom_pages_list_localizations.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "page_id", "sourceKind": "parameter", "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "state", "sourceKind": "parameter", "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "location": "query", "appleName": "filter[state]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "page_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "state", + "sourceKind": "parameter", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "location": "query", + "appleName": "filter[state]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Validated collection response." }, - { "outputField": "pageId", "localRole": "Canonical page scope established by the requested relationship path." }, - { "outputField": "versions.*.id", "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "jsonPointer": "/data/*/id" }, - { "outputField": "versions.*.type", "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "jsonPointer": "/data/*/type" }, - { "outputField": "versions.*.version", "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "jsonPointer": "/data/*/attributes/version" }, - { "outputField": "versions.*.state", "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "jsonPointer": "/data/*/attributes/state" }, - { "outputField": "versions.*.deepLink", "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "jsonPointer": "/data/*/attributes/deepLink" }, - { "outputField": "versions.*.deepLinkState", "localRole": "Distinguish value, explicit null, and omitted deep link per resource." }, - { "outputField": "versions.*.pageId", "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "jsonPointer": "/data/*/relationships/appCustomProductPage/data/id", "localRole": "Returned only when Apple supplied and the handler validated the parent relationship." }, - { "outputField": "count", "localRole": "Number of validated version resources in this page." }, - { "outputField": "limit", "localRole": "Effective validated page limit." }, - { "outputField": "next_url", "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "Validated collection response." + }, + { + "outputField": "pageId", + "localRole": "Canonical page scope established by the requested relationship path." + }, + { + "outputField": "versions.*.id", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "jsonPointer": "/data/*/id" + }, + { + "outputField": "versions.*.type", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "jsonPointer": "/data/*/type" + }, + { + "outputField": "versions.*.version", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "jsonPointer": "/data/*/attributes/version" + }, + { + "outputField": "versions.*.state", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "jsonPointer": "/data/*/attributes/state" + }, + { + "outputField": "versions.*.deepLink", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "jsonPointer": "/data/*/attributes/deepLink" + }, + { + "outputField": "versions.*.deepLinkState", + "localRole": "Distinguish value, explicit null, and omitted deep link per resource." + }, + { + "outputField": "versions.*.pageId", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "jsonPointer": "/data/*/relationships/appCustomProductPage/data/id", + "localRole": "Returned only when Apple supplied and the handler validated the parent relationship." + }, + { + "outputField": "count", + "localRole": "Number of validated version resources in this page." + }, + { + "outputField": "limit", + "localRole": "Effective validated page limit." + }, + { + "outputField": "next_url", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "jsonPointer": "/links/next" + } ] } }, @@ -380,44 +1027,128 @@ "path": "/v1/appCustomProductPages/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appCustomProductPages" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appCustomProductPages" + }, { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["page_id"], + "derivedFrom": [ + "page_id" + ], "localRole": "copyPathIdentifierToRequestBody" } ] } ], "fields": [ - { "toolField": "page_id", "sourceKind": "parameter", "operationId": "appCustomProductPages_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "appCustomProductPages_updateInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "visible", "sourceKind": "requestBody", "operationId": "appCustomProductPages_updateInstance", "jsonPointer": "/data/attributes/visible" } + { + "toolField": "page_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPages_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "appCustomProductPages_updateInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "visible", + "sourceKind": "requestBody", + "operationId": "appCustomProductPages_updateInstance", + "jsonPointer": "/data/attributes/visible" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPages_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appCustomProductPages_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Exact HTTP 200, canonical identity, required document self-link, and requested nullable attribute states were verified." }, - { "outputField": "operation", "localRole": "update_page" }, - { "outputField": "operationCommitted", "localRole": "True only after exact accepted-response verification." }, - { "outputField": "operationCommitState", "localRole": "Structured non-idempotent write outcome." }, - { "outputField": "changed", "localRole": "Null because response equality does not prove the prior value differed." }, - { "outputField": "retrySafe", "localRole": "False after an accepted PATCH." }, - { "outputField": "statusCode", "localRole": "Exact accepted HTTP status." }, - { "outputField": "custom_product_page.id", "operationId": "appCustomProductPages_updateInstance", "jsonPointer": "/data/id" }, - { "outputField": "custom_product_page.type", "operationId": "appCustomProductPages_updateInstance", "jsonPointer": "/data/type" }, - { "outputField": "custom_product_page.name", "operationId": "appCustomProductPages_updateInstance", "jsonPointer": "/data/attributes/name" }, - { "outputField": "custom_product_page.nameState", "localRole": "Distinguish value, explicit null, and omitted name." }, - { "outputField": "custom_product_page.url", "operationId": "appCustomProductPages_updateInstance", "jsonPointer": "/data/attributes/url" }, - { "outputField": "custom_product_page.urlState", "localRole": "Distinguish value, explicit null, and omitted URL." }, - { "outputField": "custom_product_page.visible", "operationId": "appCustomProductPages_updateInstance", "jsonPointer": "/data/attributes/visible" }, - { "outputField": "custom_product_page.visibleState", "localRole": "Distinguish value, explicit null, and omitted visibility." }, - { "outputField": "custom_product_page.appId", "operationId": "appCustomProductPages_updateInstance", "jsonPointer": "/data/relationships/app/data/id", "localRole": "Returned only after parent relationship validation." }, - { "outputField": "custom_product_page.state", "localRole": "Legacy compatibility placeholder set to null." } + { + "outputField": "success", + "localRole": "Exact HTTP 200, canonical identity, required document self-link, and requested nullable attribute states were verified." + }, + { + "outputField": "operation", + "localRole": "update_page" + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact accepted-response verification." + }, + { + "outputField": "operationCommitState", + "localRole": "Structured non-idempotent write outcome." + }, + { + "outputField": "changed", + "localRole": "Null because response equality does not prove the prior value differed." + }, + { + "outputField": "retrySafe", + "localRole": "False after an accepted PATCH." + }, + { + "outputField": "statusCode", + "localRole": "Exact accepted HTTP status." + }, + { + "outputField": "custom_product_page.id", + "operationId": "appCustomProductPages_updateInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "custom_product_page.type", + "operationId": "appCustomProductPages_updateInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "custom_product_page.name", + "operationId": "appCustomProductPages_updateInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "outputField": "custom_product_page.nameState", + "localRole": "Distinguish value, explicit null, and omitted name." + }, + { + "outputField": "custom_product_page.url", + "operationId": "appCustomProductPages_updateInstance", + "jsonPointer": "/data/attributes/url" + }, + { + "outputField": "custom_product_page.urlState", + "localRole": "Distinguish value, explicit null, and omitted URL." + }, + { + "outputField": "custom_product_page.visible", + "operationId": "appCustomProductPages_updateInstance", + "jsonPointer": "/data/attributes/visible" + }, + { + "outputField": "custom_product_page.visibleState", + "localRole": "Distinguish value, explicit null, and omitted visibility." + }, + { + "outputField": "custom_product_page.appId", + "operationId": "appCustomProductPages_updateInstance", + "jsonPointer": "/data/relationships/app/data/id", + "localRole": "Returned only after parent relationship validation." + }, + { + "outputField": "custom_product_page.state", + "localRole": "Legacy compatibility placeholder set to null." + } ] }, "note": "The closed input schema and runtime both require at least one mutable field, name or visible, in addition to page_id." @@ -435,39 +1166,105 @@ "path": "/v1/appCustomProductPageLocalizations/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appCustomProductPageLocalizations" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appCustomProductPageLocalizations" + }, { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["localization_id"], + "derivedFrom": [ + "localization_id" + ], "localRole": "copyPathIdentifierToRequestBody" } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "promotional_text", "sourceKind": "requestBody", "operationId": "appCustomProductPageLocalizations_updateInstance", "jsonPointer": "/data/attributes/promotionalText" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "promotional_text", + "sourceKind": "requestBody", + "operationId": "appCustomProductPageLocalizations_updateInstance", + "jsonPointer": "/data/attributes/promotionalText" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPageLocalizations_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appCustomProductPageLocalizations_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Exact HTTP 200, canonical identity, required document self-link, and requested promotional-text state were verified." }, - { "outputField": "operation", "localRole": "update_localization" }, - { "outputField": "operationCommitted", "localRole": "True only after exact accepted-response verification." }, - { "outputField": "operationCommitState", "localRole": "Structured non-idempotent write outcome." }, - { "outputField": "changed", "localRole": "Null because response equality does not prove the prior value differed." }, - { "outputField": "retrySafe", "localRole": "False after an accepted PATCH." }, - { "outputField": "statusCode", "localRole": "Exact accepted HTTP status." }, - { "outputField": "localization.id", "operationId": "appCustomProductPageLocalizations_updateInstance", "jsonPointer": "/data/id" }, - { "outputField": "localization.type", "operationId": "appCustomProductPageLocalizations_updateInstance", "jsonPointer": "/data/type" }, - { "outputField": "localization.locale", "operationId": "appCustomProductPageLocalizations_updateInstance", "jsonPointer": "/data/attributes/locale" }, - { "outputField": "localization.promotionalText", "operationId": "appCustomProductPageLocalizations_updateInstance", "jsonPointer": "/data/attributes/promotionalText" }, - { "outputField": "localization.promotionalTextState", "localRole": "Distinguish value, explicit null, and omitted promotional text." }, - { "outputField": "localization.versionId", "operationId": "appCustomProductPageLocalizations_updateInstance", "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/id", "localRole": "Returned only after parent relationship validation." } + { + "outputField": "success", + "localRole": "Exact HTTP 200, canonical identity, required document self-link, and requested promotional-text state were verified." + }, + { + "outputField": "operation", + "localRole": "update_localization" + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact accepted-response verification." + }, + { + "outputField": "operationCommitState", + "localRole": "Structured non-idempotent write outcome." + }, + { + "outputField": "changed", + "localRole": "Null because response equality does not prove the prior value differed." + }, + { + "outputField": "retrySafe", + "localRole": "False after an accepted PATCH." + }, + { + "outputField": "statusCode", + "localRole": "Exact accepted HTTP status." + }, + { + "outputField": "localization.id", + "operationId": "appCustomProductPageLocalizations_updateInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "localization.type", + "operationId": "appCustomProductPageLocalizations_updateInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "localization.locale", + "operationId": "appCustomProductPageLocalizations_updateInstance", + "jsonPointer": "/data/attributes/locale" + }, + { + "outputField": "localization.promotionalText", + "operationId": "appCustomProductPageLocalizations_updateInstance", + "jsonPointer": "/data/attributes/promotionalText" + }, + { + "outputField": "localization.promotionalTextState", + "localRole": "Distinguish value, explicit null, and omitted promotional text." + }, + { + "outputField": "localization.versionId", + "operationId": "appCustomProductPageLocalizations_updateInstance", + "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/id", + "localRole": "Returned only after parent relationship validation." + } ] } }, @@ -484,28 +1281,81 @@ "path": "/v1/appCustomProductPageVersions/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The tool projects the primary page-version resource only; relationship expansion would be silently discarded and is available through the dedicated page and localization tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appCustomProductPageLocalizations]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only when appCustomProductPageLocalizations is included; the tool does not request that expansion.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The tool projects the primary page-version resource only; relationship expansion would be silently discarded and is available through the dedicated page and localization tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appCustomProductPageLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only when appCustomProductPageLocalizations is included; the tool does not request that expansion.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "appCustomProductPageVersions_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageVersions_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPageVersions_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appCustomProductPageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "version.id", "operationId": "appCustomProductPageVersions_getInstance", "jsonPointer": "/data/id" }, - { "outputField": "version.type", "operationId": "appCustomProductPageVersions_getInstance", "jsonPointer": "/data/type" }, - { "outputField": "version.version", "operationId": "appCustomProductPageVersions_getInstance", "jsonPointer": "/data/attributes/version" }, - { "outputField": "version.state", "operationId": "appCustomProductPageVersions_getInstance", "jsonPointer": "/data/attributes/state" }, - { "outputField": "version.deepLink", "operationId": "appCustomProductPageVersions_getInstance", "jsonPointer": "/data/attributes/deepLink" }, - { "outputField": "version.deepLinkState", "localRole": "Distinguish a returned deepLink value, explicit null, and omitted attribute." }, - { "outputField": "version.pageId", "operationId": "appCustomProductPageVersions_getInstance", "jsonPointer": "/data/relationships/appCustomProductPage/data/id", "localRole": "Returned only after parent relationship validation." } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "version.id", + "operationId": "appCustomProductPageVersions_getInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "version.type", + "operationId": "appCustomProductPageVersions_getInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "version.version", + "operationId": "appCustomProductPageVersions_getInstance", + "jsonPointer": "/data/attributes/version" + }, + { + "outputField": "version.state", + "operationId": "appCustomProductPageVersions_getInstance", + "jsonPointer": "/data/attributes/state" + }, + { + "outputField": "version.deepLink", + "operationId": "appCustomProductPageVersions_getInstance", + "jsonPointer": "/data/attributes/deepLink" + }, + { + "outputField": "version.deepLinkState", + "localRole": "Distinguish a returned deepLink value, explicit null, and omitted attribute." + }, + { + "outputField": "version.pageId", + "operationId": "appCustomProductPageVersions_getInstance", + "jsonPointer": "/data/relationships/appCustomProductPage/data/id", + "localRole": "Returned only after parent relationship validation." + } ] } }, @@ -522,35 +1372,110 @@ "path": "/v1/appCustomProductPageVersions/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appCustomProductPageVersions" }, - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["version_id"], "localRole": "copyPathIdentifierToRequestBody" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appCustomProductPageVersions" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "version_id" + ], + "localRole": "copyPathIdentifierToRequestBody" + } ] } ], "fields": [ - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "appCustomProductPageVersions_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "deep_link", "sourceKind": "requestBody", "operationId": "appCustomProductPageVersions_updateInstance", "jsonPointer": "/data/attributes/deepLink" } + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageVersions_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "deep_link", + "sourceKind": "requestBody", + "operationId": "appCustomProductPageVersions_updateInstance", + "jsonPointer": "/data/attributes/deepLink" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPageVersions_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appCustomProductPageVersions_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Exact HTTP 200, canonical identity, required document self-link, and requested nullable deep-link state were verified." }, - { "outputField": "operation", "localRole": "update_version" }, - { "outputField": "operationCommitted", "localRole": "True only after exact accepted-response verification." }, - { "outputField": "operationCommitState", "localRole": "Structured non-idempotent write outcome." }, - { "outputField": "changed", "localRole": "Null because response equality does not prove the prior value differed." }, - { "outputField": "retrySafe", "localRole": "False after an accepted PATCH." }, - { "outputField": "statusCode", "localRole": "Exact accepted HTTP status." }, - { "outputField": "version.id", "operationId": "appCustomProductPageVersions_updateInstance", "jsonPointer": "/data/id" }, - { "outputField": "version.type", "operationId": "appCustomProductPageVersions_updateInstance", "jsonPointer": "/data/type" }, - { "outputField": "version.version", "operationId": "appCustomProductPageVersions_updateInstance", "jsonPointer": "/data/attributes/version" }, - { "outputField": "version.state", "operationId": "appCustomProductPageVersions_updateInstance", "jsonPointer": "/data/attributes/state" }, - { "outputField": "version.deepLink", "operationId": "appCustomProductPageVersions_updateInstance", "jsonPointer": "/data/attributes/deepLink" }, - { "outputField": "version.deepLinkState", "localRole": "Distinguish a returned deepLink value, explicit null, and omitted attribute." }, - { "outputField": "version.pageId", "operationId": "appCustomProductPageVersions_updateInstance", "jsonPointer": "/data/relationships/appCustomProductPage/data/id", "localRole": "Returned only after parent relationship validation." } + { + "outputField": "success", + "localRole": "Exact HTTP 200, canonical identity, required document self-link, and requested nullable deep-link state were verified." + }, + { + "outputField": "operation", + "localRole": "update_version" + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact accepted-response verification." + }, + { + "outputField": "operationCommitState", + "localRole": "Structured non-idempotent write outcome." + }, + { + "outputField": "changed", + "localRole": "Null because response equality does not prove the prior value differed." + }, + { + "outputField": "retrySafe", + "localRole": "False after an accepted PATCH." + }, + { + "outputField": "statusCode", + "localRole": "Exact accepted HTTP status." + }, + { + "outputField": "version.id", + "operationId": "appCustomProductPageVersions_updateInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "version.type", + "operationId": "appCustomProductPageVersions_updateInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "version.version", + "operationId": "appCustomProductPageVersions_updateInstance", + "jsonPointer": "/data/attributes/version" + }, + { + "outputField": "version.state", + "operationId": "appCustomProductPageVersions_updateInstance", + "jsonPointer": "/data/attributes/state" + }, + { + "outputField": "version.deepLink", + "operationId": "appCustomProductPageVersions_updateInstance", + "jsonPointer": "/data/attributes/deepLink" + }, + { + "outputField": "version.deepLinkState", + "localRole": "Distinguish a returned deepLink value, explicit null, and omitted attribute." + }, + { + "outputField": "version.pageId", + "operationId": "appCustomProductPageVersions_updateInstance", + "jsonPointer": "/data/relationships/appCustomProductPage/data/id", + "localRole": "Returned only after parent relationship validation." + } ] } }, @@ -567,30 +1492,97 @@ "path": "/v1/appCustomProductPageLocalizations/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The tool projects the primary localization only and does not decode included parent, screenshot, preview, keyword, or placement resources.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only to an appPreviewSets expansion that this tool does not request.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only to an appScreenshotSets expansion that this tool does not request.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[searchKeywords]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only to an included searchKeywords expansion; custom_pages_list_search_keywords exposes the related collection directly.", "reviewAtSpec": "4.5.1" }, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The tool projects the primary localization only and does not decode included parent, screenshot, preview, keyword, or placement resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only to an appPreviewSets expansion that this tool does not request.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only to an appScreenshotSets expansion that this tool does not request.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[searchKeywords]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only to an included searchKeywords expansion; custom_pages_list_search_keywords exposes the related collection directly.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPageLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appCustomProductPageLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "localization.id", "operationId": "appCustomProductPageLocalizations_getInstance", "jsonPointer": "/data/id" }, - { "outputField": "localization.type", "operationId": "appCustomProductPageLocalizations_getInstance", "jsonPointer": "/data/type" }, - { "outputField": "localization.locale", "operationId": "appCustomProductPageLocalizations_getInstance", "jsonPointer": "/data/attributes/locale" }, - { "outputField": "localization.promotionalText", "operationId": "appCustomProductPageLocalizations_getInstance", "jsonPointer": "/data/attributes/promotionalText" }, - { "outputField": "localization.promotionalTextState", "localRole": "Distinguish a returned promotionalText value, explicit null, and omitted attribute." }, - { "outputField": "localization.versionId", "operationId": "appCustomProductPageLocalizations_getInstance", "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/id", "localRole": "Returned only after parent relationship validation." } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "localization.id", + "operationId": "appCustomProductPageLocalizations_getInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "localization.type", + "operationId": "appCustomProductPageLocalizations_getInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "localization.locale", + "operationId": "appCustomProductPageLocalizations_getInstance", + "jsonPointer": "/data/attributes/locale" + }, + { + "outputField": "localization.promotionalText", + "operationId": "appCustomProductPageLocalizations_getInstance", + "jsonPointer": "/data/attributes/promotionalText" + }, + { + "outputField": "localization.promotionalTextState", + "localRole": "Distinguish a returned promotionalText value, explicit null, and omitted attribute." + }, + { + "outputField": "localization.versionId", + "operationId": "appCustomProductPageLocalizations_getInstance", + "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/id", + "localRole": "Returned only after parent relationship validation." + } ] } }, @@ -601,27 +1593,72 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "appCustomProductPageLocalizations_deleteInstance", "method": "delete", "path": "/v1/appCustomProductPageLocalizations/{id}", "role": "primary" } + { + "operationId": "appCustomProductPageLocalizations_deleteInstance", + "method": "delete", + "path": "/v1/appCustomProductPageLocalizations/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_localization_id", "sourceKind": "local", "localRole": "Require an exact canonical match with localization_id before any Apple request is sent." } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_localization_id", + "sourceKind": "local", + "localRole": "Require an exact canonical match with localization_id before any Apple request is sent." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "appCustomProductPageLocalizations_deleteInstance", "statusCode": "204" } + { + "operationId": "appCustomProductPageLocalizations_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "True only for Apple's exact HTTP 204 response." }, - { "outputField": "operation", "localRole": "delete_localization" }, - { "outputField": "operationCommitted", "localRole": "True only for exact HTTP 204." }, - { "outputField": "operationCommitState", "localRole": "Structured destructive-operation outcome." }, - { "outputField": "changed", "localRole": "True because exact HTTP 204 follows an existing-resource delete contract." }, - { "outputField": "retrySafe", "localRole": "False after committed deletion." }, - { "outputField": "localizationId", "localRole": "Echo the canonical deleted localization ID." }, - { "outputField": "statusCode", "localRole": "Exact accepted HTTP status." }, - { "outputField": "message", "localRole": "Local deletion confirmation." } + { + "outputField": "success", + "localRole": "True only for Apple's exact HTTP 204 response." + }, + { + "outputField": "operation", + "localRole": "delete_localization" + }, + { + "outputField": "operationCommitted", + "localRole": "True only for exact HTTP 204." + }, + { + "outputField": "operationCommitState", + "localRole": "Structured destructive-operation outcome." + }, + { + "outputField": "changed", + "localRole": "True because exact HTTP 204 follows an existing-resource delete contract." + }, + { + "outputField": "retrySafe", + "localRole": "False after committed deletion." + }, + { + "outputField": "localizationId", + "localRole": "Echo the canonical deleted localization ID." + }, + { + "outputField": "statusCode", + "localRole": "Exact accepted HTTP status." + }, + { + "outputField": "message", + "localRole": "Local deletion confirmation." + } ] } }, @@ -640,25 +1677,81 @@ } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "platform", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", "location": "query", "appleName": "filter[platform]" }, - { "toolField": "locale", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", "location": "query", "appleName": "filter[locale]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "platform", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", + "location": "query", + "appleName": "filter[platform]" + }, + { + "toolField": "locale", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", + "location": "query", + "appleName": "filter[locale]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "localizationId", "localRole": "Echo the canonical parent localization ID." }, - { "outputField": "search_keywords.*.id", "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", "jsonPointer": "/data/*/id" }, - { "outputField": "search_keywords.*.type", "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", "jsonPointer": "/data/*/type" }, - { "outputField": "next_url", "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "count", "localRole": "Number of validated keyword resources in this page." }, - { "outputField": "limit", "localRole": "Echo the effective validated page limit." } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "localizationId", + "localRole": "Echo the canonical parent localization ID." + }, + { + "outputField": "search_keywords.*.id", + "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", + "jsonPointer": "/data/*/id" + }, + { + "outputField": "search_keywords.*.type", + "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", + "jsonPointer": "/data/*/type" + }, + { + "outputField": "next_url", + "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "count", + "localRole": "Number of validated keyword resources in this page." + }, + { + "outputField": "limit", + "localRole": "Echo the effective validated page limit." + } ] } }, @@ -675,29 +1768,74 @@ "path": "/v1/appCustomProductPageLocalizations/{id}/relationships/searchKeywords", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/*/type", "fixedValue": "appKeywords" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "appKeywords" + } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_searchKeywords_createToManyRelationship", "location": "path", "appleName": "id" }, - { "toolField": "keyword_ids", "sourceKind": "requestBody", "operationId": "appCustomProductPageLocalizations_searchKeywords_createToManyRelationship", "jsonPointer": "/data/*/id" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_searchKeywords_createToManyRelationship", + "location": "path", + "appleName": "id" + }, + { + "toolField": "keyword_ids", + "sourceKind": "requestBody", + "operationId": "appCustomProductPageLocalizations_searchKeywords_createToManyRelationship", + "jsonPointer": "/data/*/id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "appCustomProductPageLocalizations_searchKeywords_createToManyRelationship", "statusCode": "204" } + { + "operationId": "appCustomProductPageLocalizations_searchKeywords_createToManyRelationship", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "True only for Apple's exact HTTP 204 response." }, - { "outputField": "operation", "localRole": "add_search_keywords" }, - { "outputField": "operationCommitted", "localRole": "True only for exact HTTP 204." }, - { "outputField": "operationCommitState", "localRole": "Structured relationship-write outcome." }, - { "outputField": "changed", "localRole": "Null because exact HTTP 204 does not prove whether every requested relationship was previously absent." }, - { "outputField": "retrySafe", "localRole": "False after an accepted relationship write." }, - { "outputField": "localizationId", "localRole": "Echo the canonical parent localization ID." }, - { "outputField": "keywordIds", "localRole": "Echo the exact canonical relationship IDs sent to Apple." }, - { "outputField": "statusCode", "localRole": "Exact accepted HTTP status." } + { + "outputField": "success", + "localRole": "True only for Apple's exact HTTP 204 response." + }, + { + "outputField": "operation", + "localRole": "add_search_keywords" + }, + { + "outputField": "operationCommitted", + "localRole": "True only for exact HTTP 204." + }, + { + "outputField": "operationCommitState", + "localRole": "Structured relationship-write outcome." + }, + { + "outputField": "changed", + "localRole": "Null because exact HTTP 204 does not prove whether every requested relationship was previously absent." + }, + { + "outputField": "retrySafe", + "localRole": "False after an accepted relationship write." + }, + { + "outputField": "localizationId", + "localRole": "Echo the canonical parent localization ID." + }, + { + "outputField": "keywordIds", + "localRole": "Echo the exact canonical relationship IDs sent to Apple." + }, + { + "outputField": "statusCode", + "localRole": "Exact accepted HTTP status." + } ] } }, @@ -714,31 +1852,83 @@ "path": "/v1/appCustomProductPageLocalizations/{id}/relationships/searchKeywords", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/*/type", "fixedValue": "appKeywords" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "appKeywords" + } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_searchKeywords_deleteToManyRelationship", "location": "path", "appleName": "id" }, - { "toolField": "keyword_ids", "sourceKind": "requestBody", "operationId": "appCustomProductPageLocalizations_searchKeywords_deleteToManyRelationship", "jsonPointer": "/data/*/id" }, - { "toolField": "confirm_localization_id", "sourceKind": "local", "localRole": "Require an exact canonical match with localization_id before any Apple request is sent." } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_searchKeywords_deleteToManyRelationship", + "location": "path", + "appleName": "id" + }, + { + "toolField": "keyword_ids", + "sourceKind": "requestBody", + "operationId": "appCustomProductPageLocalizations_searchKeywords_deleteToManyRelationship", + "jsonPointer": "/data/*/id" + }, + { + "toolField": "confirm_localization_id", + "sourceKind": "local", + "localRole": "Require an exact canonical match with localization_id before any Apple request is sent." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "appCustomProductPageLocalizations_searchKeywords_deleteToManyRelationship", "statusCode": "204" } + { + "operationId": "appCustomProductPageLocalizations_searchKeywords_deleteToManyRelationship", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "True only for Apple's exact HTTP 204 response." }, - { "outputField": "operation", "localRole": "remove_search_keywords" }, - { "outputField": "operationCommitted", "localRole": "True only for exact HTTP 204." }, - { "outputField": "operationCommitState", "localRole": "Structured destructive relationship-write outcome." }, - { "outputField": "changed", "localRole": "Null because exact HTTP 204 does not prove whether every requested relationship was previously present." }, - { "outputField": "retrySafe", "localRole": "False after an accepted destructive relationship write." }, - { "outputField": "confirmationMatched", "localRole": "True only after confirm_localization_id exactly matches localization_id before the request." }, - { "outputField": "localizationId", "localRole": "Echo the canonical parent localization ID." }, - { "outputField": "keywordIds", "localRole": "Echo the exact canonical relationship IDs sent to Apple." }, - { "outputField": "statusCode", "localRole": "Exact accepted HTTP status." } + { + "outputField": "success", + "localRole": "True only for Apple's exact HTTP 204 response." + }, + { + "outputField": "operation", + "localRole": "remove_search_keywords" + }, + { + "outputField": "operationCommitted", + "localRole": "True only for exact HTTP 204." + }, + { + "outputField": "operationCommitState", + "localRole": "Structured destructive relationship-write outcome." + }, + { + "outputField": "changed", + "localRole": "Null because exact HTTP 204 does not prove whether every requested relationship was previously present." + }, + { + "outputField": "retrySafe", + "localRole": "False after an accepted destructive relationship write." + }, + { + "outputField": "confirmationMatched", + "localRole": "True only after confirm_localization_id exactly matches localization_id before the request." + }, + { + "outputField": "localizationId", + "localRole": "Echo the canonical parent localization ID." + }, + { + "outputField": "keywordIds", + "localRole": "Echo the exact canonical relationship IDs sent to Apple." + }, + { + "outputField": "statusCode", + "localRole": "Exact accepted HTTP status." + } ] } } diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/export_compliance.json b/Sources/asc-mcp/Resources/OperationManifest/tools/export_compliance.json index 5a59de7..9c72183 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/export_compliance.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/export_compliance.json @@ -20,14 +20,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Attachment preflight only needs declaration approval metadata.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Attachment preflight does not expand the deprecated builds relationship.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ], "inputs": [ @@ -82,14 +82,14 @@ "appleName": "/data/attributes/expired", "disposition": "intentionallyOmitted", "reason": "Attachment does not mutate build expiration state.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "body", "appleName": "/data/attributes/usesNonExemptEncryption", "disposition": "intentionallyOmitted", "reason": "Attachment does not change the build encryption answer; builds_update_encryption owns that mutation.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ], "inputs": [ @@ -176,10 +176,26 @@ "response": { "mode": "aggregate", "sources": [ - { "operationId": "appEncryptionDeclarations_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "builds_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "builds_appEncryptionDeclaration_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appEncryptionDeclarations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "builds_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "builds_appEncryptionDeclaration_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { @@ -208,19 +224,61 @@ "path": "/v1/builds/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The export gate reads only Build attributes and the app relationship identifier.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaBuildLocalizations]", "disposition": "intentionallyOmitted", "reason": "Beta localizations are outside export compliance.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta groups are outside export compliance.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[buildBundles]", "disposition": "intentionallyOmitted", "reason": "Build bundles are outside this gate.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[icons]", "disposition": "intentionallyOmitted", "reason": "Build icons are outside this gate.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[individualTesters]", "disposition": "intentionallyOmitted", "reason": "Individual testers are outside export compliance.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The export gate reads only Build attributes and the app relationship identifier.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaBuildLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Beta localizations are outside export compliance.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaGroups]", + "disposition": "intentionallyOmitted", + "reason": "Beta groups are outside export compliance.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[buildBundles]", + "disposition": "intentionallyOmitted", + "reason": "Build bundles are outside this gate.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[icons]", + "disposition": "intentionallyOmitted", + "reason": "Build icons are outside this gate.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[individualTesters]", + "disposition": "intentionallyOmitted", + "reason": "Individual testers are outside export compliance.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[builds]", - "fixedValue": ["version", "processingState", "expired", "usesNonExemptEncryption", "app"] + "fixedValue": [ + "version", + "processingState", + "expired", + "usesNonExemptEncryption", + "app" + ] } ] }, @@ -260,35 +318,82 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["builds_appEncryptionDeclaration_getToOneRelated:/data/id"], + "derivedFrom": [ + "builds_appEncryptionDeclaration_getToOneRelated:/data/id" + ], "localRole": "Use the declaration ID returned by the build relationship lookup." }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[appEncryptionDeclarationDocuments]", - "fixedValue": ["fileSize", "fileName", "downloadUrl", "sourceFileChecksum", "assetDeliveryState"] + "fixedValue": [ + "fileSize", + "fileName", + "downloadUrl", + "sourceFileChecksum", + "assetDeliveryState" + ] } ] } ], "fields": [ - { "toolField": "build_id", "sourceKind": "parameter", "operationId": "builds_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "build_id", "sourceKind": "parameter", "operationId": "builds_appEncryptionDeclaration_getToOneRelated", "location": "path", "appleName": "id" } + { + "toolField": "build_id", + "sourceKind": "parameter", + "operationId": "builds_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "build_id", + "sourceKind": "parameter", + "operationId": "builds_appEncryptionDeclaration_getToOneRelated", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "builds_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "builds_appEncryptionDeclaration_getToOneRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "builds_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "builds_appEncryptionDeclaration_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "status", "localRole": "Derive READY, PENDING, or BLOCKED without treating unknown nullable state as success." }, - { "outputField": "exportComplianceReady", "localRole": "True only when the EXPORT_COMPLIANCE_ONLY gate passes; this is not a global release-ready claim." }, - { "outputField": "checks", "localRole": "Actionable build, declaration, and document gate checks." }, - { "outputField": "actions", "localRole": "State-specific next steps; unknown build encryption includes the required true-or-false selection placeholder, retained uploads include path and checksum-receipt placeholders, and unsupported declaration states route to App Store Connect or Apple Support." }, - { "outputField": "appStoreSubmissionStatus", "localRole": "Always NOT_DETERMINED because non-export release requirements are outside this tool." } + { + "outputField": "status", + "localRole": "Derive READY, PENDING, or BLOCKED without treating unknown nullable state as success." + }, + { + "outputField": "exportComplianceReady", + "localRole": "True only when the EXPORT_COMPLIANCE_ONLY gate passes; this is not a global release-ready claim." + }, + { + "outputField": "checks", + "localRole": "Actionable build, declaration, and document gate checks." + }, + { + "outputField": "actions", + "localRole": "State-specific next steps; unknown build encryption includes the required true-or-false selection placeholder, retained uploads include path and checksum-receipt placeholders, and unsupported declaration states route to App Store Connect or Apple Support." + }, + { + "outputField": "appStoreSubmissionStatus", + "localRole": "Always NOT_DETERMINED because non-export release requirements are outside this tool." + } ] }, "note": "A false encryption answer needs no declaration. A true answer requires an attached APPROVED non-exempt declaration and COMPLETE document. Build processingState and expired are informational because this tool is scoped only to export compliance. AWAITING_UPLOAD points to checksum-bound resume, UPLOAD_COMPLETE points to inspection, document creation is suggested only for CREATED or REJECTED declarations, and missing, nullable, future, failed, or inconsistent states fail closed." @@ -306,27 +411,82 @@ "path": "/v1/appEncryptionDeclarations", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appEncryptionDeclarations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appEncryptionDeclarations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarations_createInstance", "jsonPointer": "/data/relationships/app/data/id" }, - { "toolField": "app_description", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarations_createInstance", "jsonPointer": "/data/attributes/appDescription" }, - { "toolField": "contains_proprietary_cryptography", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarations_createInstance", "jsonPointer": "/data/attributes/containsProprietaryCryptography" }, - { "toolField": "contains_third_party_cryptography", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarations_createInstance", "jsonPointer": "/data/attributes/containsThirdPartyCryptography" }, - { "toolField": "available_on_french_store", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarations_createInstance", "jsonPointer": "/data/attributes/availableOnFrenchStore" } + { + "toolField": "app_id", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarations_createInstance", + "jsonPointer": "/data/relationships/app/data/id" + }, + { + "toolField": "app_description", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarations_createInstance", + "jsonPointer": "/data/attributes/appDescription" + }, + { + "toolField": "contains_proprietary_cryptography", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarations_createInstance", + "jsonPointer": "/data/attributes/containsProprietaryCryptography" + }, + { + "toolField": "contains_third_party_cryptography", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarations_createInstance", + "jsonPointer": "/data/attributes/containsThirdPartyCryptography" + }, + { + "toolField": "available_on_french_store", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarations_createInstance", + "jsonPointer": "/data/attributes/availableOnFrenchStore" + } ], "response": { "mode": "projection", - "sources": [{ "operationId": "appEncryptionDeclarations_createInstance", "statusCode": "201", "mediaType": "application/json" }], + "sources": [ + { + "operationId": "appEncryptionDeclarations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } + ], "fields": [ - { "outputField": "declaration", "operationId": "appEncryptionDeclarations_createInstance", "jsonPointer": "/data" }, - { "outputField": "creationState", "localRole": "confirmed for a validated 201 resource, committed_unverified for a malformed or identity-invalid successful response, commit_unknown for network, 408, or 5xx uncertainty, and rejected for a deterministic rejection." }, - { "outputField": "commitConfirmed", "localRole": "True for a validated resource or a successful response whose resource could not be verified; false when transport or status does not prove acceptance." }, - { "outputField": "retrySafe", "localRole": "False after confirmed, committed-unverified, or commit-unknown outcomes; true only after a deterministic rejection." }, - { "outputField": "inspection", "localRole": "For committed-unverified or commit-unknown outcomes, call export_compliance_list_declarations with the original app_id before any retry." } + { + "outputField": "declaration", + "operationId": "appEncryptionDeclarations_createInstance", + "jsonPointer": "/data" + }, + { + "outputField": "creationState", + "localRole": "confirmed for a validated 201 resource, committed_unverified for a malformed or identity-invalid successful response, commit_unknown for network, 408, or 5xx uncertainty, and rejected for a deterministic rejection." + }, + { + "outputField": "commitConfirmed", + "localRole": "True for a validated resource or a successful response whose resource could not be verified; false when transport or status does not prove acceptance." + }, + { + "outputField": "retrySafe", + "localRole": "False after confirmed, committed-unverified, or commit-unknown outcomes; true only after a deterministic rejection." + }, + { + "outputField": "inspection", + "localRole": "For committed-unverified or commit-unknown outcomes, call export_compliance_list_declarations with the original app_id before any retry." + } ] }, "note": "Sends exactly the four required questionnaire attributes and required app linkage from OpenAPI 4.4.1; obsolete platform, usesEncryption, and compliance-code inputs are not exposed. A confirmed response requires the mandatory configured-origin canonical resource self-link. The non-idempotent POST distinguishes committed-but-unverified success, unknown commit state, and deterministic rejection so an ambiguous response never invites a blind duplicate create." @@ -345,8 +505,20 @@ "role": "supporting", "condition": "Preflight a mutable declaration state before creating a reservation.", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Reservation preflight only needs declaration state.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Reservation preflight does not expand deprecated builds.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Reservation preflight only needs declaration state.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[builds]", + "disposition": "intentionallyOmitted", + "reason": "Reservation preflight does not expand deprecated builds.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -378,7 +550,13 @@ "sourceKind": "fixed", "location": "query", "appleName": "fields[appEncryptionDeclarationDocuments]", - "fixedValue": ["fileSize", "fileName", "downloadUrl", "sourceFileChecksum", "assetDeliveryState"] + "fixedValue": [ + "fileSize", + "fileName", + "downloadUrl", + "sourceFileChecksum", + "assetDeliveryState" + ] } ] }, @@ -389,8 +567,16 @@ "role": "primary", "condition": "After preflight and immutable snapshot creation, reserve one document upload.", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appEncryptionDeclarationDocuments" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appEncryptionDeclaration/data/type", "fixedValue": "appEncryptionDeclarations" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appEncryptionDeclarationDocuments" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appEncryptionDeclaration/data/type", + "fixedValue": "appEncryptionDeclarations" + } ] }, { @@ -404,23 +590,38 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appEncryptionDeclarationDocuments_createInstance:/data/id"], + "derivedFrom": [ + "appEncryptionDeclarationDocuments_createInstance:/data/id" + ], "localRole": "Commit only the exact document returned by this reservation operation." }, { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["appEncryptionDeclarationDocuments_createInstance:/data/id"], + "derivedFrom": [ + "appEncryptionDeclarationDocuments_createInstance:/data/id" + ], "localRole": "Copy the reservation response ID into the commit resource identifier." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appEncryptionDeclarationDocuments" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appEncryptionDeclarationDocuments" + }, { "sourceKind": "derived", "jsonPointer": "/data/attributes/sourceFileChecksum", - "derivedFrom": ["file_path", "appEncryptionDeclarationDocuments_createInstance:/data/attributes/uploadOperations"], + "derivedFrom": [ + "file_path", + "appEncryptionDeclarationDocuments_createInstance:/data/attributes/uploadOperations" + ], "localRole": "Commit the lowercase MD5 returned after transferring the immutable snapshot through this reservation's signed upload operations." }, - { "sourceKind": "fixed", "jsonPointer": "/data/attributes/uploaded", "fixedValue": true } + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/uploaded", + "fixedValue": true + } ] }, { @@ -434,35 +635,111 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appEncryptionDeclarationDocuments_createInstance:/data/id"], + "derivedFrom": [ + "appEncryptionDeclarationDocuments_createInstance:/data/id" + ], "localRole": "Inspect only the exact document returned by this reservation operation." } ] } ], "fields": [ - { "toolField": "declaration_id", "sourceKind": "parameter", "operationId": "appEncryptionDeclarations_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "declaration_id", "sourceKind": "parameter", "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", "location": "path", "appleName": "id" }, - { "toolField": "declaration_id", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarationDocuments_createInstance", "jsonPointer": "/data/relationships/appEncryptionDeclaration/data/id" }, - { "toolField": "file_path", "sourceKind": "local", "localRole": "Create an immutable local snapshot; never return signed upload URLs or headers." }, - { "toolField": "file_path", "sourceKind": "derived", "operationId": "appEncryptionDeclarationDocuments_createInstance", "jsonPointer": "/data/attributes/fileSize", "derivedFrom": ["file_path"], "localRole": "Derive byte size from the snapshot." }, - { "toolField": "file_path", "sourceKind": "derived", "operationId": "appEncryptionDeclarationDocuments_createInstance", "jsonPointer": "/data/attributes/fileName", "derivedFrom": ["file_path"], "localRole": "Derive file name from the snapshot." } + { + "toolField": "declaration_id", + "sourceKind": "parameter", + "operationId": "appEncryptionDeclarations_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "declaration_id", + "sourceKind": "parameter", + "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "declaration_id", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarationDocuments_createInstance", + "jsonPointer": "/data/relationships/appEncryptionDeclaration/data/id" + }, + { + "toolField": "file_path", + "sourceKind": "local", + "localRole": "Create an immutable local snapshot; never return signed upload URLs or headers." + }, + { + "toolField": "file_path", + "sourceKind": "derived", + "operationId": "appEncryptionDeclarationDocuments_createInstance", + "jsonPointer": "/data/attributes/fileSize", + "derivedFrom": [ + "file_path" + ], + "localRole": "Derive byte size from the snapshot." + }, + { + "toolField": "file_path", + "sourceKind": "derived", + "operationId": "appEncryptionDeclarationDocuments_createInstance", + "jsonPointer": "/data/attributes/fileName", + "derivedFrom": [ + "file_path" + ], + "localRole": "Derive file name from the snapshot." + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "appEncryptionDeclarations_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appEncryptionDeclarationDocuments_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "appEncryptionDeclarationDocuments_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appEncryptionDeclarationDocuments_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appEncryptionDeclarations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEncryptionDeclarationDocuments_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appEncryptionDeclarationDocuments_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEncryptionDeclarationDocuments_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "document", "localRole": "Latest safe resource projection after commit, reconciliation, or bounded delivery polling." }, - { "outputField": "sourceFileChecksumReceipt", "localRole": "When reservation creation is ambiguous, or a known precommit reservation has no conflicting Apple checksum binding, return the lowercase MD5 of the immutable snapshot so later inspection and resume can require the exact same bytes." }, - { "outputField": "checksumBindingConflict", "localRole": "True when checksum evidence cannot be reconciled safely: without an Apple binding the caller receipt and snapshot must agree, while with a binding Apple and the snapshot must agree. Omit the resume receipt and require inspection instead of suggesting another transfer." }, - { "outputField": "retrySafe", "localRole": "True only before reservation or after a deterministic reservation rejection; false for retained, ambiguous, committed, pending, or failed outcomes." }, - { "outputField": "inspection", "localRole": "When reservation identity or commit state is unresolved, inspect the declaration or retained document before any retry." } + { + "outputField": "document", + "localRole": "Latest safe resource projection after commit, reconciliation, or bounded delivery polling." + }, + { + "outputField": "sourceFileChecksumReceipt", + "localRole": "When reservation creation is ambiguous, or a known precommit reservation has no conflicting Apple checksum binding, return the lowercase MD5 of the immutable snapshot so later inspection and resume can require the exact same bytes." + }, + { + "outputField": "checksumBindingConflict", + "localRole": "True when checksum evidence cannot be reconciled safely: without an Apple binding the caller receipt and snapshot must agree, while with a binding Apple and the snapshot must agree. Omit the resume receipt and require inspection instead of suggesting another transfer." + }, + { + "outputField": "retrySafe", + "localRole": "True only before reservation or after a deterministic reservation rejection; false for retained, ambiguous, committed, pending, or failed outcomes." + }, + { + "outputField": "inspection", + "localRole": "When reservation identity or commit state is unresolved, inspect the declaration or retained document before any retry." + } ] }, "note": "Preflights declaration state and confirmed absence, then reserves, transfers, commits, and polls using one immutable snapshot. Transfer is allowed only from exact AWAITING_UPLOAD. Deterministic reservation rejection is retryable after input correction; transport, 408, 5xx, malformed-success, invalid-identity, retained precommit, and ambiguous commit outcomes remain unsafe until inspection. Every post-snapshot unresolved reservation returns the immutable snapshot checksum receipt so a document later found by inspection can be resumed only with the original bytes. The tool never exposes assetToken, downloadUrl, upload URL, or request headers." @@ -481,19 +758,61 @@ "role": "supporting", "condition": "Confirm that the parent build exists before interpreting a relationship 404 as absence.", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Parent existence confirmation needs only the Build resource.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaBuildLocalizations]", "disposition": "intentionallyOmitted", "reason": "Beta localizations are outside parent confirmation.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "Beta groups are outside parent confirmation.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[buildBundles]", "disposition": "intentionallyOmitted", "reason": "Build bundles are outside parent confirmation.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[icons]", "disposition": "intentionallyOmitted", "reason": "Icons are outside parent confirmation.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[individualTesters]", "disposition": "intentionallyOmitted", "reason": "Individual testers are outside parent confirmation.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Parent existence confirmation needs only the Build resource.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaBuildLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Beta localizations are outside parent confirmation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaGroups]", + "disposition": "intentionallyOmitted", + "reason": "Beta groups are outside parent confirmation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[buildBundles]", + "disposition": "intentionallyOmitted", + "reason": "Build bundles are outside parent confirmation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[icons]", + "disposition": "intentionallyOmitted", + "reason": "Icons are outside parent confirmation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[individualTesters]", + "disposition": "intentionallyOmitted", + "reason": "Individual testers are outside parent confirmation.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[builds]", - "fixedValue": ["version", "processingState", "expired", "usesNonExemptEncryption", "app"] + "fixedValue": [ + "version", + "processingState", + "expired", + "usesNonExemptEncryption", + "app" + ] } ] }, @@ -523,18 +842,45 @@ } ], "fields": [ - { "toolField": "build_id", "sourceKind": "parameter", "operationId": "builds_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "build_id", "sourceKind": "parameter", "operationId": "builds_appEncryptionDeclaration_getToOneRelated", "location": "path", "appleName": "id" } + { + "toolField": "build_id", + "sourceKind": "parameter", + "operationId": "builds_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "build_id", + "sourceKind": "parameter", + "operationId": "builds_appEncryptionDeclaration_getToOneRelated", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "builds_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "builds_appEncryptionDeclaration_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "builds_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "builds_appEncryptionDeclaration_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "declarationAttached", "localRole": "False on Apple 404 and true only for a valid declaration resource." }, - { "outputField": "declaration", "operationId": "builds_appEncryptionDeclaration_getToOneRelated", "jsonPointer": "/data" } + { + "outputField": "declarationAttached", + "localRole": "False on Apple 404 and true only for a valid declaration resource." + }, + { + "outputField": "declaration", + "operationId": "builds_appEncryptionDeclaration_getToOneRelated", + "jsonPointer": "/data" + } ] }, "note": "Confirms the parent build first. Only a subsequent relationship 404 means no declaration is attached; an invalid or inaccessible build remains an error." @@ -552,8 +898,20 @@ "path": "/v1/appEncryptionDeclarations/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The safe declaration projection does not expand related app, builds, or document resources.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "The deprecated builds relationship is not expanded.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The safe declaration projection does not expand related app, builds, or document resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[builds]", + "disposition": "intentionallyOmitted", + "reason": "The deprecated builds relationship is not expanded.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -575,11 +933,31 @@ ] } ], - "fields": [{ "toolField": "declaration_id", "sourceKind": "parameter", "operationId": "appEncryptionDeclarations_getInstance", "location": "path", "appleName": "id" }], + "fields": [ + { + "toolField": "declaration_id", + "sourceKind": "parameter", + "operationId": "appEncryptionDeclarations_getInstance", + "location": "path", + "appleName": "id" + } + ], "response": { "mode": "projection", - "sources": [{ "operationId": "appEncryptionDeclarations_getInstance", "statusCode": "200", "mediaType": "application/json" }], - "fields": [{ "outputField": "declaration", "operationId": "appEncryptionDeclarations_getInstance", "jsonPointer": "/data" }] + "sources": [ + { + "operationId": "appEncryptionDeclarations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "declaration", + "operationId": "appEncryptionDeclarations_getInstance", + "jsonPointer": "/data" + } + ] }, "note": "Omits deprecated platform, usesEncryption, uploadedDate, documentUrl, documentName, and documentType attributes. The required document self-link must resolve to the returned canonical declaration on the configured origin." }, @@ -600,16 +978,41 @@ "sourceKind": "fixed", "location": "query", "appleName": "fields[appEncryptionDeclarationDocuments]", - "fixedValue": ["fileSize", "fileName", "downloadUrl", "sourceFileChecksum", "assetDeliveryState"] + "fixedValue": [ + "fileSize", + "fileName", + "downloadUrl", + "sourceFileChecksum", + "assetDeliveryState" + ] } ] } ], - "fields": [{ "toolField": "document_id", "sourceKind": "parameter", "operationId": "appEncryptionDeclarationDocuments_getInstance", "location": "path", "appleName": "id" }], + "fields": [ + { + "toolField": "document_id", + "sourceKind": "parameter", + "operationId": "appEncryptionDeclarationDocuments_getInstance", + "location": "path", + "appleName": "id" + } + ], "response": { "mode": "projection", - "sources": [{ "operationId": "appEncryptionDeclarationDocuments_getInstance", "statusCode": "200", "mediaType": "application/json" }], - "fields": [{ "outputField": "document", "localRole": "Redact downloadUrl and expose download availability only when Apple actually returns a URL; omit asset-token and upload-operation availability claims because those fields were not requested." }] + "sources": [ + { + "operationId": "appEncryptionDeclarationDocuments_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "document", + "localRole": "Redact downloadUrl and expose download availability only when Apple actually returns a URL; omit asset-token and upload-operation availability claims because those fields were not requested." + } + ] }, "note": "The public result contains no signed URL, asset token, upload operation URL, or request header, and it does not emit false or zero availability claims for unrequested fields. The required document self-link must resolve to the returned canonical document on the configured origin." }, @@ -627,8 +1030,20 @@ "role": "supporting", "condition": "Confirm that the parent declaration exists before interpreting a relationship 404 as absence.", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Parent confirmation needs only declaration state.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Parent confirmation does not expand deprecated builds.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Parent confirmation needs only declaration state.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[builds]", + "disposition": "intentionallyOmitted", + "reason": "Parent confirmation does not expand deprecated builds.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -659,24 +1074,57 @@ "sourceKind": "fixed", "location": "query", "appleName": "fields[appEncryptionDeclarationDocuments]", - "fixedValue": ["fileSize", "fileName", "downloadUrl", "sourceFileChecksum", "assetDeliveryState"] + "fixedValue": [ + "fileSize", + "fileName", + "downloadUrl", + "sourceFileChecksum", + "assetDeliveryState" + ] } ] } ], "fields": [ - { "toolField": "declaration_id", "sourceKind": "parameter", "operationId": "appEncryptionDeclarations_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "declaration_id", "sourceKind": "parameter", "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", "location": "path", "appleName": "id" } + { + "toolField": "declaration_id", + "sourceKind": "parameter", + "operationId": "appEncryptionDeclarations_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "declaration_id", + "sourceKind": "parameter", + "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "appEncryptionDeclarations_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appEncryptionDeclarations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "documentPresent", "localRole": "False on 404 and true only for a valid related document." }, - { "outputField": "deliveryStatus", "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", "jsonPointer": "/data/attributes/assetDeliveryState/state" } + { + "outputField": "documentPresent", + "localRole": "False on 404 and true only for a valid related document." + }, + { + "outputField": "deliveryStatus", + "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", + "jsonPointer": "/data/attributes/assetDeliveryState/state" + } ] }, "note": "Confirms the parent declaration first. Only a subsequent relationship 404 is MISSING; an invalid or inaccessible declaration remains an error. Pending, COMPLETE, and FAILED states are classified without leaking document transfer secrets." @@ -694,10 +1142,34 @@ "path": "/v1/apps/{id}/appEncryptionDeclarations", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[platform]", "disposition": "intentionallyOmitted", "reason": "The platform filter is deprecated and is not exposed.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[builds]", "disposition": "intentionallyOmitted", "reason": "The app-scoped list does not infer a build filter; build linkage has a dedicated tool.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The list returns a bounded declaration projection without related expansion.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "The deprecated builds relationship is not expanded.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "filter[platform]", + "disposition": "intentionallyOmitted", + "reason": "The platform filter is deprecated and is not exposed.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[builds]", + "disposition": "intentionallyOmitted", + "reason": "The app-scoped list does not infer a build filter; build linkage has a dedicated tool.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The list returns a bounded declaration projection without related expansion.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[builds]", + "disposition": "intentionallyOmitted", + "reason": "The deprecated builds relationship is not expanded.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -720,17 +1192,51 @@ } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_appEncryptionDeclarations_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "apps_appEncryptionDeclarations_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Require the exact encoded app path, fixed projection, strict query allowlist, one valid limit, and nonempty cursor; preserve the validated continuation limit when the caller omits limit." } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_appEncryptionDeclarations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_appEncryptionDeclarations_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Require the exact encoded app path, fixed projection, strict query allowlist, one valid limit, and nonempty cursor; preserve the validated continuation limit when the caller omits limit." + } ], "response": { "mode": "projection", - "sources": [{ "operationId": "apps_appEncryptionDeclarations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }], + "sources": [ + { + "operationId": "apps_appEncryptionDeclarations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], "fields": [ - { "outputField": "declarations", "operationId": "apps_appEncryptionDeclarations_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "total", "operationId": "apps_appEncryptionDeclarations_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "next_url", "operationId": "apps_appEncryptionDeclarations_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "declarations", + "operationId": "apps_appEncryptionDeclarations_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "total", + "operationId": "apps_appEncryptionDeclarations_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "next_url", + "operationId": "apps_appEncryptionDeclarations_getToManyRelated", + "jsonPointer": "/links/next" + } ] }, "note": "Strict pagination rejects cross-app paths, changed projection, a caller-supplied limit that differs from the continuation, invalid or duplicate limit or cursor parameters, and unknown query names. A continuation call can use only app_id plus the unmodified next_url even when the first page used a nondefault limit. Apple responses require collection links, stay on the configured app path, preserve strict next-link query and cursor lineage, stay within the effective requested limit and paging metadata, and reject invalid or duplicate declaration identities." @@ -748,25 +1254,71 @@ "path": "/v1/appEncryptionDeclarationDocuments/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appEncryptionDeclarationDocuments" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appEncryptionDeclarationDocuments" + } ] } ], "fields": [ - { "toolField": "document_id", "sourceKind": "parameter", "operationId": "appEncryptionDeclarationDocuments_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "document_id", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarationDocuments_updateInstance", "jsonPointer": "/data/id" }, - { "toolField": "source_file_checksum", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarationDocuments_updateInstance", "jsonPointer": "/data/attributes/sourceFileChecksum" }, - { "toolField": "uploaded", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarationDocuments_updateInstance", "jsonPointer": "/data/attributes/uploaded" } + { + "toolField": "document_id", + "sourceKind": "parameter", + "operationId": "appEncryptionDeclarationDocuments_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "document_id", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarationDocuments_updateInstance", + "jsonPointer": "/data/id" + }, + { + "toolField": "source_file_checksum", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarationDocuments_updateInstance", + "jsonPointer": "/data/attributes/sourceFileChecksum" + }, + { + "toolField": "uploaded", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarationDocuments_updateInstance", + "jsonPointer": "/data/attributes/uploaded" + } ], "response": { "mode": "projection", - "sources": [{ "operationId": "appEncryptionDeclarationDocuments_updateInstance", "statusCode": "200", "mediaType": "application/json" }], + "sources": [ + { + "operationId": "appEncryptionDeclarationDocuments_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], "fields": [ - { "outputField": "document", "localRole": "Safe document projection after the nullable patch." }, - { "outputField": "updateState", "localRole": "confirmed for a validated update response, committed_unverified for a malformed or identity-invalid successful response, commit_unknown for network, 408, or 5xx uncertainty, and rejected for a deterministic rejection." }, - { "outputField": "commitConfirmed", "localRole": "True for a validated update or a successful response whose resource could not be verified." }, - { "outputField": "retrySafe", "localRole": "False after confirmed, committed-unverified, or commit-unknown outcomes; true only after a deterministic rejection." }, - { "outputField": "inspection", "localRole": "For committed-unverified or commit-unknown outcomes, call export_compliance_get_document with the same document_id before any retry." } + { + "outputField": "document", + "localRole": "Safe document projection after the nullable patch." + }, + { + "outputField": "updateState", + "localRole": "confirmed for a validated update response, committed_unverified for a malformed or identity-invalid successful response, commit_unknown for network, 408, or 5xx uncertainty, and rejected for a deterministic rejection." + }, + { + "outputField": "commitConfirmed", + "localRole": "True for a validated update or a successful response whose resource could not be verified." + }, + { + "outputField": "retrySafe", + "localRole": "False after confirmed, committed-unverified, or commit-unknown outcomes; true only after a deterministic rejection." + }, + { + "outputField": "inspection", + "localRole": "For committed-unverified or commit-unknown outcomes, call export_compliance_get_document with the same document_id before any retry." + } ] }, "note": "Requires at least one update field and preserves missing versus explicit JSON null for both optional Apple attributes without promising server-side reversal semantics. A confirmed response requires the mandatory configured-origin canonical resource self-link. The PATCH distinguishes committed-but-unverified success, unknown commit state, and deterministic rejection." @@ -789,7 +1341,13 @@ "sourceKind": "fixed", "location": "query", "appleName": "fields[appEncryptionDeclarationDocuments]", - "fixedValue": ["fileSize", "fileName", "sourceFileChecksum", "uploadOperations", "assetDeliveryState"] + "fixedValue": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "uploadOperations", + "assetDeliveryState" + ] } ] }, @@ -800,30 +1358,88 @@ "role": "supporting", "condition": "Only after an exact AWAITING_UPLOAD reservation, an exact checksum-receipt match, and successful transfer of the same immutable snapshot, commit its checksum with uploaded=true.", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appEncryptionDeclarationDocuments" }, - { "sourceKind": "fixed", "jsonPointer": "/data/attributes/uploaded", "fixedValue": true } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appEncryptionDeclarationDocuments" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/uploaded", + "fixedValue": true + } ] } ], "fields": [ - { "toolField": "document_id", "sourceKind": "parameter", "operationId": "appEncryptionDeclarationDocuments_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "document_id", "sourceKind": "parameter", "operationId": "appEncryptionDeclarationDocuments_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "document_id", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarationDocuments_updateInstance", "jsonPointer": "/data/id" }, - { "toolField": "file_path", "sourceKind": "local", "localRole": "Create one immutable snapshot and verify file name, byte size, and bytes against the reservation and checksum receipt before any signed transfer." }, - { "toolField": "source_file_checksum", "sourceKind": "requestBody", "operationId": "appEncryptionDeclarationDocuments_updateInstance", "jsonPointer": "/data/attributes/sourceFileChecksum", "localRole": "Require the exact lowercase MD5 receipt returned for the retained reservation and prove that it equals both the immutable snapshot checksum and any sourceFileChecksum already stored by Apple before transferring bytes." } + { + "toolField": "document_id", + "sourceKind": "parameter", + "operationId": "appEncryptionDeclarationDocuments_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "document_id", + "sourceKind": "parameter", + "operationId": "appEncryptionDeclarationDocuments_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "document_id", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarationDocuments_updateInstance", + "jsonPointer": "/data/id" + }, + { + "toolField": "file_path", + "sourceKind": "local", + "localRole": "Create one immutable snapshot and verify file name, byte size, and bytes against the reservation and checksum receipt before any signed transfer." + }, + { + "toolField": "source_file_checksum", + "sourceKind": "requestBody", + "operationId": "appEncryptionDeclarationDocuments_updateInstance", + "jsonPointer": "/data/attributes/sourceFileChecksum", + "localRole": "Require the exact lowercase MD5 receipt returned for the retained reservation and prove that it equals both the immutable snapshot checksum and any sourceFileChecksum already stored by Apple before transferring bytes." + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "appEncryptionDeclarationDocuments_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appEncryptionDeclarationDocuments_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appEncryptionDeclarationDocuments_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appEncryptionDeclarationDocuments_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "document", "localRole": "Latest safe resource projection after commit or reconciliation." }, - { "outputField": "sourceFileChecksumReceipt", "localRole": "Return the authoritative lowercase MD5 receipt again only when it matches both the immutable snapshot and any checksum already stored by Apple." }, - { "outputField": "checksumBindingConflict", "localRole": "True when checksum evidence cannot be reconciled safely: without an Apple binding the caller receipt and snapshot must agree, while with a binding Apple and the snapshot must agree. Omit automatic resume guidance and require inspection." }, - { "outputField": "retrySafe", "localRole": "False for every post-reservation unresolved, pending, or failed outcome." }, - { "outputField": "cleanup", "localRole": "Explicit unavailable status because OpenAPI 4.4.1 exposes no document DELETE operation." } + { + "outputField": "document", + "localRole": "Latest safe resource projection after commit or reconciliation." + }, + { + "outputField": "sourceFileChecksumReceipt", + "localRole": "Return the authoritative lowercase MD5 receipt again only when it matches both the immutable snapshot and any checksum already stored by Apple." + }, + { + "outputField": "checksumBindingConflict", + "localRole": "True when checksum evidence cannot be reconciled safely: without an Apple binding the caller receipt and snapshot must agree, while with a binding Apple and the snapshot must agree. Omit automatic resume guidance and require inspection." + }, + { + "outputField": "retrySafe", + "localRole": "False for every post-reservation unresolved, pending, or failed outcome." + }, + { + "outputField": "cleanup", + "localRole": "Explicit unavailable status because OpenAPI 4.4.1 exposes no document DELETE operation." + } ] }, "note": "Safely resumes an existing AWAITING_UPLOAD reservation only when the exact snapshot bytes match the required lowercase MD5 receipt. COMPLETE succeeds without transfer, UPLOAD_COMPLETE only polls or inspects, FAILED is terminal, nullable and future states fail closed without transfer, ambiguous PATCH is reconciled, and every precommit failure retains the known reservation because no document DELETE exists. Signed URLs and headers are never exposed." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/iap.json b/Sources/asc-mcp/Resources/OperationManifest/tools/iap.json index 36386ab..e3efda1 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/iap.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/iap.json @@ -69,7 +69,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "inAppPurchasesV2_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -131,7 +135,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodeCustomCodes_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodeCustomCodes_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -193,7 +201,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseLocalizations_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseLocalizations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -277,7 +289,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodes_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodes_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -330,7 +346,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodeCustomCodes_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodeCustomCodes_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -383,7 +403,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodes_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodes_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -436,7 +460,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodeOneTimeUseCodes_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodeOneTimeUseCodes_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -469,7 +497,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_deleteInstance", "statusCode": "204" } + { + "operationId": "inAppPurchasesV2_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -502,7 +533,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseImages_deleteInstance", "statusCode": "204" } + { + "operationId": "inAppPurchaseImages_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -535,7 +569,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseLocalizations_deleteInstance", "statusCode": "204" } + { + "operationId": "inAppPurchaseLocalizations_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -568,7 +605,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseAppStoreReviewScreenshots_deleteInstance", "statusCode": "204" } + { + "operationId": "inAppPurchaseAppStoreReviewScreenshots_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -630,7 +670,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodeOneTimeUseCodes_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodeOneTimeUseCodes_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -655,42 +699,42 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[images]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[inAppPurchaseLocalizations]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[offerCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[pricePoints]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[versions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -707,7 +751,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchasesV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -800,8 +848,16 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "inAppPurchaseAvailabilities_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseAvailabilities_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { @@ -859,7 +915,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -876,7 +932,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodeCustomCodes_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodeCustomCodes_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -901,7 +961,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -918,7 +978,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseImages_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseImages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -943,28 +1007,28 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[customCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[oneTimeUseCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[prices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -981,7 +1045,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodes_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodes_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1006,7 +1074,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1023,7 +1091,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodeOneTimeUseCodes_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodeOneTimeUseCodes_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1110,21 +1182,21 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[automaticPrices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[manualPrices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1141,7 +1213,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_iapPriceSchedule_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchasesV2_iapPriceSchedule_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1166,7 +1242,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1183,7 +1259,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_promotedPurchase_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchasesV2_promotedPurchase_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1208,7 +1288,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1225,7 +1305,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1250,21 +1334,21 @@ "appleName": "limit[subscriptionGroupLocalizations]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[versions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1292,7 +1376,11 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "subscriptionGroups_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionGroups_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { @@ -1340,35 +1428,35 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[images]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[inAppPurchaseLocalizations]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[offerCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[versions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1432,7 +1520,11 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "apps_inAppPurchasesV2_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_inAppPurchasesV2_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { @@ -1490,35 +1582,35 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[images]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[inAppPurchaseLocalizations]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[offerCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[versions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1582,7 +1674,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "apps_inAppPurchasesV2_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_inAppPurchasesV2_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1627,7 +1723,11 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "inAppPurchaseAvailabilities_availableTerritories_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseAvailabilities_availableTerritories_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { @@ -1675,7 +1775,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1704,7 +1804,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_images_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchasesV2_images_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1729,7 +1833,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1758,7 +1862,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_inAppPurchaseLocalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchasesV2_inAppPurchaseLocalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1783,7 +1891,7 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control and requires the same value on every continuation; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1819,7 +1927,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodes_prices_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodes_prices_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1844,35 +1956,35 @@ "appleName": "filter[territory]", "disposition": "intentionallyOmitted", "reason": "Offer-code discovery stays product-scoped; territory selection is available on the dedicated offer-price listing.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control and requires the same value on every continuation; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[customCodes]", "disposition": "internalControl", "reason": "The handler fixes this query control and requires the same value on every continuation; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[oneTimeUseCodes]", "disposition": "internalControl", "reason": "The handler fixes this query control and requires the same value on every continuation; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[prices]", "disposition": "internalControl", "reason": "The handler fixes this query control and requires the same value on every continuation; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1901,7 +2013,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_offerCodes_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchasesV2_offerCodes_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1926,7 +2042,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1955,7 +2071,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodes_oneTimeUseCodes_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodes_oneTimeUseCodes_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1980,7 +2100,7 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control and requires the same value on every continuation; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2023,8 +2143,16 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasePricePoints_equalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchasePricePoints_equalizations_getToManyRelated", "statusCode": "200", "mediaType": "text/csv" } + { + "operationId": "inAppPurchasePricePoints_equalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchasePricePoints_equalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "text/csv" + } ], "fields": [] }, @@ -2049,7 +2177,7 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control and requires the same value on every continuation; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2096,8 +2224,16 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_pricePoints_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchasesV2_pricePoints_getToManyRelated", "statusCode": "200", "mediaType": "text/csv" } + { + "operationId": "inAppPurchasesV2_pricePoints_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchasesV2_pricePoints_getToManyRelated", + "statusCode": "200", + "mediaType": "text/csv" + } ], "fields": [] }, @@ -2122,28 +2258,28 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptionGroupLocalizations]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[versions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2193,7 +2329,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "apps_subscriptionGroups_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_subscriptionGroups_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2218,14 +2358,14 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2254,8 +2394,16 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_pricePoints_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchasesV2_pricePoints_getToManyRelated", "statusCode": "200", "mediaType": "text/csv" } + { + "operationId": "inAppPurchasesV2_pricePoints_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchasesV2_pricePoints_getToManyRelated", + "statusCode": "200", + "mediaType": "text/csv" + } ], "fields": [] }, @@ -2280,21 +2428,21 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[automaticPrices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[manualPrices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -2321,14 +2469,14 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -2355,14 +2503,14 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2401,9 +2549,21 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasePriceSchedules_automaticPrices_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchasePriceSchedules_manualPrices_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchasesV2_iapPriceSchedule_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchasePriceSchedules_automaticPrices_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchasePriceSchedules_manualPrices_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchasesV2_iapPriceSchedule_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2459,7 +2619,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseAvailabilities_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseAvailabilities_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2542,7 +2706,11 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "inAppPurchasePriceSchedules_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "inAppPurchasePriceSchedules_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ { @@ -2601,7 +2769,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseSubmissions_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseSubmissions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2667,7 +2839,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchasesV2_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchasesV2_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2721,7 +2897,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodeCustomCodes_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodeCustomCodes_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2781,7 +2961,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseLocalizations_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseLocalizations_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2835,7 +3019,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodes_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodes_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2889,7 +3077,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseOfferCodeOneTimeUseCodes_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseOfferCodeOneTimeUseCodes_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2988,7 +3180,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -3032,10 +3224,25 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseImages_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "inAppPurchaseImages_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchaseImages_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchaseImages_deleteInstance", "statusCode": "204" } + { + "operationId": "inAppPurchaseImages_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchaseImages_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchaseImages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchaseImages_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -3134,7 +3341,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -3178,10 +3385,25 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseAppStoreReviewScreenshots_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "inAppPurchaseAppStoreReviewScreenshots_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchaseAppStoreReviewScreenshots_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchaseAppStoreReviewScreenshots_deleteInstance", "statusCode": "204" } + { + "operationId": "inAppPurchaseAppStoreReviewScreenshots_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchaseAppStoreReviewScreenshots_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchaseAppStoreReviewScreenshots_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchaseAppStoreReviewScreenshots_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -3201,40 +3423,133 @@ "role": "primary", "condition": null, "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "inAppPurchaseVersions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/inAppPurchase/data/type", "fixedValue": "inAppPurchases" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "inAppPurchaseVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/inAppPurchase/data/type", + "fixedValue": "inAppPurchases" + } ] } ], "fields": [ - { "toolField": "iap_id", "sourceKind": "requestBody", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/inAppPurchase/data/id" } + { + "toolField": "iap_id", + "sourceKind": "requestBody", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/inAppPurchase/data/id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "inAppPurchaseVersions_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseVersions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after the created version and its ownership pass validation." }, - { "outputField": "version", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data", "localRole": "Project stable version fields and relationship-page metadata when Apple supplies each relationship." }, - { "outputField": "version.image_ids", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/images/data/*/id", "localRole": "Omit when the images relationship or relationship.data is absent; preserve an explicit empty data array as []." }, - { "outputField": "version.images_page.ids", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/images/data/*/id", "localRole": "Present only when the images relationship includes relationship.data." }, - { "outputField": "version.images_page.count", "localRole": "Present only when relationship.data is returned; count its image identifiers, including zero for an explicit empty page." }, - { "outputField": "version.images_page.data_returned", "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." }, - { "outputField": "version.images_page.total", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/images/meta/paging/total" }, - { "outputField": "version.images_page.limit", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/images/meta/paging/limit" }, - { "outputField": "version.images_page.next_cursor", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/images/meta/paging/nextCursor" }, - { "outputField": "version.images_page.truncated", "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned image count." }, - { "outputField": "version.images_page.completeness_known", "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." }, - { "outputField": "version.localization_ids", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/localizations/data/*/id", "localRole": "Omit when the localizations relationship or relationship.data is absent; preserve an explicit empty data array as []." }, - { "outputField": "version.localizations_page.ids", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/localizations/data/*/id", "localRole": "Present only when the localizations relationship includes relationship.data." }, - { "outputField": "version.localizations_page.count", "localRole": "Present only when relationship.data is returned; count its localization identifiers, including zero for an explicit empty page." }, - { "outputField": "version.localizations_page.data_returned", "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." }, - { "outputField": "version.localizations_page.total", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/localizations/meta/paging/total" }, - { "outputField": "version.localizations_page.limit", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/localizations/meta/paging/limit" }, - { "outputField": "version.localizations_page.next_cursor", "operationId": "inAppPurchaseVersions_createInstance", "jsonPointer": "/data/relationships/localizations/meta/paging/nextCursor" }, - { "outputField": "version.localizations_page.truncated", "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned localization count." }, - { "outputField": "version.localizations_page.completeness_known", "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." } + { + "outputField": "success", + "localRole": "Set true after the created version and its ownership pass validation." + }, + { + "outputField": "version", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data", + "localRole": "Project stable version fields and relationship-page metadata when Apple supplies each relationship." + }, + { + "outputField": "version.image_ids", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/images/data/*/id", + "localRole": "Omit when the images relationship or relationship.data is absent; preserve an explicit empty data array as []." + }, + { + "outputField": "version.images_page.ids", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/images/data/*/id", + "localRole": "Present only when the images relationship includes relationship.data." + }, + { + "outputField": "version.images_page.count", + "localRole": "Present only when relationship.data is returned; count its image identifiers, including zero for an explicit empty page." + }, + { + "outputField": "version.images_page.data_returned", + "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." + }, + { + "outputField": "version.images_page.total", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/images/meta/paging/total" + }, + { + "outputField": "version.images_page.limit", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/images/meta/paging/limit" + }, + { + "outputField": "version.images_page.next_cursor", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/images/meta/paging/nextCursor" + }, + { + "outputField": "version.images_page.truncated", + "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned image count." + }, + { + "outputField": "version.images_page.completeness_known", + "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." + }, + { + "outputField": "version.localization_ids", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/data/*/id", + "localRole": "Omit when the localizations relationship or relationship.data is absent; preserve an explicit empty data array as []." + }, + { + "outputField": "version.localizations_page.ids", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/data/*/id", + "localRole": "Present only when the localizations relationship includes relationship.data." + }, + { + "outputField": "version.localizations_page.count", + "localRole": "Present only when relationship.data is returned; count its localization identifiers, including zero for an explicit empty page." + }, + { + "outputField": "version.localizations_page.data_returned", + "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." + }, + { + "outputField": "version.localizations_page.total", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/total" + }, + { + "outputField": "version.localizations_page.limit", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/limit" + }, + { + "outputField": "version.localizations_page.next_cursor", + "operationId": "inAppPurchaseVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/nextCursor" + }, + { + "outputField": "version.localizations_page.truncated", + "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned localization count." + }, + { + "outputField": "version.localizations_page.completeness_known", + "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." + } ] }, "note": "Creates one explicit Apple 4.4.1 in-app purchase version; it never auto-creates a version while invoking a legacy product-scoped tool. An ambiguous POST or response decode returns write_outcome=not_confirmed, retrySafe=false, the IAP ID, and list/get recovery guidance instead of encouraging a duplicate create." @@ -3253,50 +3568,154 @@ "role": "primary", "condition": null, "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The tool avoids arbitrary relationship expansion.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[images]", "disposition": "intentionallyOmitted", "reason": "Images are not included inline.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are not included inline.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The tool avoids arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[images]", + "disposition": "intentionallyOmitted", + "reason": "Images are not included inline.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are not included inline.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "inAppPurchaseVersions_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "inAppPurchaseVersions_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "inAppPurchaseVersions_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after the version identity and document links pass validation." }, - { "outputField": "version", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data", "localRole": "Project stable version fields and relationship-page metadata when Apple supplies each relationship." }, - { "outputField": "version.image_ids", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data/relationships/images/data/*/id", "localRole": "Omit when the images relationship or relationship.data is absent; preserve an explicit empty data array as []." }, - { "outputField": "version.images_page.ids", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data/relationships/images/data/*/id", "localRole": "Present only when the images relationship includes relationship.data." }, - { "outputField": "version.images_page.count", "localRole": "Present only when relationship.data is returned; count its image identifiers, including zero for an explicit empty page." }, - { "outputField": "version.images_page.data_returned", "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." }, - { "outputField": "version.images_page.total", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data/relationships/images/meta/paging/total" }, - { "outputField": "version.images_page.limit", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data/relationships/images/meta/paging/limit" }, - { "outputField": "version.images_page.next_cursor", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data/relationships/images/meta/paging/nextCursor" }, - { "outputField": "version.images_page.truncated", "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned image count." }, - { "outputField": "version.images_page.completeness_known", "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." }, - { "outputField": "version.localization_ids", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data/relationships/localizations/data/*/id", "localRole": "Omit when the localizations relationship or relationship.data is absent; preserve an explicit empty data array as []." }, - { "outputField": "version.localizations_page.ids", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data/relationships/localizations/data/*/id", "localRole": "Present only when the localizations relationship includes relationship.data." }, - { "outputField": "version.localizations_page.count", "localRole": "Present only when relationship.data is returned; count its localization identifiers, including zero for an explicit empty page." }, - { "outputField": "version.localizations_page.data_returned", "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." }, - { "outputField": "version.localizations_page.total", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data/relationships/localizations/meta/paging/total" }, - { "outputField": "version.localizations_page.limit", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data/relationships/localizations/meta/paging/limit" }, - { "outputField": "version.localizations_page.next_cursor", "operationId": "inAppPurchaseVersions_getInstance", "jsonPointer": "/data/relationships/localizations/meta/paging/nextCursor" }, - { "outputField": "version.localizations_page.truncated", "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned localization count." }, - { "outputField": "version.localizations_page.completeness_known", "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." } - ] - }, - "note": "Returns the integer version, review state, and relationship identifiers when Apple supplies them." - }, - { - "tool": "iap_list_versions", - "kind": "direct", - "status": "partial", - "effect": "read", + { + "outputField": "success", + "localRole": "Set true after the version identity and document links pass validation." + }, + { + "outputField": "version", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data", + "localRole": "Project stable version fields and relationship-page metadata when Apple supplies each relationship." + }, + { + "outputField": "version.image_ids", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data/relationships/images/data/*/id", + "localRole": "Omit when the images relationship or relationship.data is absent; preserve an explicit empty data array as []." + }, + { + "outputField": "version.images_page.ids", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data/relationships/images/data/*/id", + "localRole": "Present only when the images relationship includes relationship.data." + }, + { + "outputField": "version.images_page.count", + "localRole": "Present only when relationship.data is returned; count its image identifiers, including zero for an explicit empty page." + }, + { + "outputField": "version.images_page.data_returned", + "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." + }, + { + "outputField": "version.images_page.total", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data/relationships/images/meta/paging/total" + }, + { + "outputField": "version.images_page.limit", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data/relationships/images/meta/paging/limit" + }, + { + "outputField": "version.images_page.next_cursor", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data/relationships/images/meta/paging/nextCursor" + }, + { + "outputField": "version.images_page.truncated", + "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned image count." + }, + { + "outputField": "version.images_page.completeness_known", + "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." + }, + { + "outputField": "version.localization_ids", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/data/*/id", + "localRole": "Omit when the localizations relationship or relationship.data is absent; preserve an explicit empty data array as []." + }, + { + "outputField": "version.localizations_page.ids", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/data/*/id", + "localRole": "Present only when the localizations relationship includes relationship.data." + }, + { + "outputField": "version.localizations_page.count", + "localRole": "Present only when relationship.data is returned; count its localization identifiers, including zero for an explicit empty page." + }, + { + "outputField": "version.localizations_page.data_returned", + "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." + }, + { + "outputField": "version.localizations_page.total", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/total" + }, + { + "outputField": "version.localizations_page.limit", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/limit" + }, + { + "outputField": "version.localizations_page.next_cursor", + "operationId": "inAppPurchaseVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/nextCursor" + }, + { + "outputField": "version.localizations_page.truncated", + "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned localization count." + }, + { + "outputField": "version.localizations_page.completeness_known", + "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." + } + ] + }, + "note": "Returns the integer version, review state, and relationship identifiers when Apple supplies them." + }, + { + "tool": "iap_list_versions", + "kind": "direct", + "status": "partial", + "effect": "read", "implementationState": "asBuilt", "operations": [ { @@ -3306,47 +3725,181 @@ "role": "primary", "condition": null, "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The list avoids arbitrary relationship expansion.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[images]", "disposition": "intentionallyOmitted", "reason": "Images are not included inline.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[localizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are not included inline.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The list avoids arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[images]", + "disposition": "intentionallyOmitted", + "reason": "Images are not included inline.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are not included inline.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "iap_id", "sourceKind": "parameter", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "filter_state", "sourceKind": "parameter", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "location": "query", "appleName": "filter[state]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Validated same-origin Apple continuation restricted to the concrete IAP versions path, full originating query, and one non-empty cursor." } + { + "toolField": "iap_id", + "sourceKind": "parameter", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "filter_state", + "sourceKind": "parameter", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "location": "query", + "appleName": "filter[state]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Validated same-origin Apple continuation restricted to the concrete IAP versions path, full originating query, and one non-empty cursor." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "inAppPurchasesV2_versions_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after the page passes ownership, paging, and document-link validation." }, - { "outputField": "versions", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data", "localRole": "Project stable version fields and relationship-page metadata when Apple supplies each relationship." }, - { "outputField": "versions.*.image_ids", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data/*/relationships/images/data/*/id", "localRole": "Omit when the images relationship or relationship.data is absent; preserve an explicit empty data array as []." }, - { "outputField": "versions.*.images_page.ids", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data/*/relationships/images/data/*/id", "localRole": "Present only when the images relationship includes relationship.data." }, - { "outputField": "versions.*.images_page.count", "localRole": "Present only when relationship.data is returned; count its image identifiers, including zero for an explicit empty page." }, - { "outputField": "versions.*.images_page.data_returned", "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." }, - { "outputField": "versions.*.images_page.total", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data/*/relationships/images/meta/paging/total" }, - { "outputField": "versions.*.images_page.limit", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data/*/relationships/images/meta/paging/limit" }, - { "outputField": "versions.*.images_page.next_cursor", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data/*/relationships/images/meta/paging/nextCursor" }, - { "outputField": "versions.*.images_page.truncated", "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned image count." }, - { "outputField": "versions.*.images_page.completeness_known", "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." }, - { "outputField": "versions.*.localization_ids", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data/*/relationships/localizations/data/*/id", "localRole": "Omit when the localizations relationship or relationship.data is absent; preserve an explicit empty data array as []." }, - { "outputField": "versions.*.localizations_page.ids", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data/*/relationships/localizations/data/*/id", "localRole": "Present only when the localizations relationship includes relationship.data." }, - { "outputField": "versions.*.localizations_page.count", "localRole": "Present only when relationship.data is returned; count its localization identifiers, including zero for an explicit empty page." }, - { "outputField": "versions.*.localizations_page.data_returned", "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." }, - { "outputField": "versions.*.localizations_page.total", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data/*/relationships/localizations/meta/paging/total" }, - { "outputField": "versions.*.localizations_page.limit", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data/*/relationships/localizations/meta/paging/limit" }, - { "outputField": "versions.*.localizations_page.next_cursor", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data/*/relationships/localizations/meta/paging/nextCursor" }, - { "outputField": "versions.*.localizations_page.truncated", "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned localization count." }, - { "outputField": "versions.*.localizations_page.completeness_known", "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." }, - { "outputField": "count", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/data", "localRole": "Current validated Apple page resource count." }, - { "outputField": "total", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "next_url", "operationId": "inAppPurchasesV2_versions_getToManyRelated", "jsonPointer": "/links/next", "localRole": "Apple continuation URL when another page exists; otherwise omitted." } + { + "outputField": "success", + "localRole": "Set true after the page passes ownership, paging, and document-link validation." + }, + { + "outputField": "versions", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Project stable version fields and relationship-page metadata when Apple supplies each relationship." + }, + { + "outputField": "versions.*.image_ids", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/images/data/*/id", + "localRole": "Omit when the images relationship or relationship.data is absent; preserve an explicit empty data array as []." + }, + { + "outputField": "versions.*.images_page.ids", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/images/data/*/id", + "localRole": "Present only when the images relationship includes relationship.data." + }, + { + "outputField": "versions.*.images_page.count", + "localRole": "Present only when relationship.data is returned; count its image identifiers, including zero for an explicit empty page." + }, + { + "outputField": "versions.*.images_page.data_returned", + "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." + }, + { + "outputField": "versions.*.images_page.total", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/images/meta/paging/total" + }, + { + "outputField": "versions.*.images_page.limit", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/images/meta/paging/limit" + }, + { + "outputField": "versions.*.images_page.next_cursor", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/images/meta/paging/nextCursor" + }, + { + "outputField": "versions.*.images_page.truncated", + "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned image count." + }, + { + "outputField": "versions.*.images_page.completeness_known", + "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." + }, + { + "outputField": "versions.*.localization_ids", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/data/*/id", + "localRole": "Omit when the localizations relationship or relationship.data is absent; preserve an explicit empty data array as []." + }, + { + "outputField": "versions.*.localizations_page.ids", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/data/*/id", + "localRole": "Present only when the localizations relationship includes relationship.data." + }, + { + "outputField": "versions.*.localizations_page.count", + "localRole": "Present only when relationship.data is returned; count its localization identifiers, including zero for an explicit empty page." + }, + { + "outputField": "versions.*.localizations_page.data_returned", + "localRole": "False when the relationship exists but Apple omits relationship.data; true when data is present." + }, + { + "outputField": "versions.*.localizations_page.total", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/meta/paging/total" + }, + { + "outputField": "versions.*.localizations_page.limit", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/meta/paging/limit" + }, + { + "outputField": "versions.*.localizations_page.next_cursor", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/meta/paging/nextCursor" + }, + { + "outputField": "versions.*.localizations_page.truncated", + "localRole": "Null when relationship.data is omitted; otherwise true for a next cursor or a total greater than the returned localization count." + }, + { + "outputField": "versions.*.localizations_page.completeness_known", + "localRole": "False when relationship.data is omitted; otherwise true only when Apple supplies a total or next cursor." + }, + { + "outputField": "count", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Current validated Apple page resource count." + }, + { + "outputField": "total", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "next_url", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "jsonPointer": "/links/next", + "localRole": "Apple continuation URL when another page exists; otherwise omitted." + } ] }, "note": "State filters reject commas and duplicates; limit is 1 through 200; output includes page count, Apple paging total, and strict next_url." @@ -3365,19 +3918,45 @@ "role": "primary", "condition": null, "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The list avoids redundant parent expansion.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The list avoids redundant parent expansion.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "inAppPurchaseVersions_localizations_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "inAppPurchaseVersions_localizations_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Validated same-origin Apple continuation restricted to the concrete version-localizations path, full originating query, and one non-empty cursor." } + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "inAppPurchaseVersions_localizations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "inAppPurchaseVersions_localizations_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Validated same-origin Apple continuation restricted to the concrete version-localizations path, full originating query, and one non-empty cursor." + } ], "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseVersions_localizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseVersions_localizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3397,21 +3976,53 @@ "role": "primary", "condition": null, "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "inAppPurchaseLocalizations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/version/data/type", "fixedValue": "inAppPurchaseVersions" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "inAppPurchaseLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/version/data/type", + "fixedValue": "inAppPurchaseVersions" + } ] } ], "fields": [ - { "toolField": "version_id", "sourceKind": "requestBody", "operationId": "inAppPurchaseLocalizationsV2_createInstance", "jsonPointer": "/data/relationships/version/data/id" }, - { "toolField": "locale", "sourceKind": "requestBody", "operationId": "inAppPurchaseLocalizationsV2_createInstance", "jsonPointer": "/data/attributes/locale" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "inAppPurchaseLocalizationsV2_createInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "description", "sourceKind": "requestBody", "operationId": "inAppPurchaseLocalizationsV2_createInstance", "jsonPointer": "/data/attributes/description" } + { + "toolField": "version_id", + "sourceKind": "requestBody", + "operationId": "inAppPurchaseLocalizationsV2_createInstance", + "jsonPointer": "/data/relationships/version/data/id" + }, + { + "toolField": "locale", + "sourceKind": "requestBody", + "operationId": "inAppPurchaseLocalizationsV2_createInstance", + "jsonPointer": "/data/attributes/locale" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "inAppPurchaseLocalizationsV2_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "description", + "sourceKind": "requestBody", + "operationId": "inAppPurchaseLocalizationsV2_createInstance", + "jsonPointer": "/data/attributes/description" + } ], "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseLocalizationsV2_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseLocalizationsV2_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3431,17 +4042,33 @@ "role": "primary", "condition": null, "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The tool avoids redundant parent expansion.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The tool avoids redundant parent expansion.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "inAppPurchaseLocalizationsV2_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "inAppPurchaseLocalizationsV2_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseLocalizationsV2_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseLocalizationsV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3461,20 +4088,51 @@ "role": "primary", "condition": null, "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "inAppPurchaseLocalizations" }, - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["localization_id"], "localRole": "Reuse localization_id as the JSON:API resource ID." } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "inAppPurchaseLocalizations" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "localization_id" + ], + "localRole": "Reuse localization_id as the JSON:API resource ID." + } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "inAppPurchaseLocalizationsV2_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "inAppPurchaseLocalizationsV2_updateInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "description", "sourceKind": "requestBody", "operationId": "inAppPurchaseLocalizationsV2_updateInstance", "jsonPointer": "/data/attributes/description" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "inAppPurchaseLocalizationsV2_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "inAppPurchaseLocalizationsV2_updateInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "description", + "sourceKind": "requestBody", + "operationId": "inAppPurchaseLocalizationsV2_updateInstance", + "jsonPointer": "/data/attributes/description" + } ], "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseLocalizationsV2_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseLocalizationsV2_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3487,24 +4145,61 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "inAppPurchaseLocalizationsV2_deleteInstance", "method": "delete", "path": "/v2/inAppPurchaseLocalizations/{id}", "role": "primary", "condition": null } + { + "operationId": "inAppPurchaseLocalizationsV2_deleteInstance", + "method": "delete", + "path": "/v2/inAppPurchaseLocalizations/{id}", + "role": "primary", + "condition": null + } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "inAppPurchaseLocalizationsV2_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_localization_id", "sourceKind": "local", "localRole": "Require an exact canonical match with localization_id before any Apple request is sent." } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "inAppPurchaseLocalizationsV2_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_localization_id", + "sourceKind": "local", + "localRole": "Require an exact canonical match with localization_id before any Apple request is sent." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "inAppPurchaseLocalizationsV2_deleteInstance", "statusCode": "204" } + { + "operationId": "inAppPurchaseLocalizationsV2_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after Apple confirms deletion with 204." }, - { "outputField": "localization_id", "localRole": "Echo the exact deleted localization ID." }, - { "outputField": "deleted", "localRole": "Set true after confirmed deletion." }, - { "outputField": "deletionState", "localRole": "Set to confirmed after Apple's 204 response." }, - { "outputField": "outcomeUnknown", "localRole": "Set false for a confirmed deletion." }, - { "outputField": "retrySafe", "localRole": "Set false because the destructive operation is already confirmed." } + { + "outputField": "success", + "localRole": "Set true after Apple confirms deletion with 204." + }, + { + "outputField": "localization_id", + "localRole": "Echo the exact deleted localization ID." + }, + { + "outputField": "deleted", + "localRole": "Set true after confirmed deletion." + }, + { + "outputField": "deletionState", + "localRole": "Set to confirmed after Apple's 204 response." + }, + { + "outputField": "outcomeUnknown", + "localRole": "Set false for a confirmed deletion." + }, + { + "outputField": "retrySafe", + "localRole": "Set false because the destructive operation is already confirmed." + } ] }, "note": "Deletes only the explicitly identified v2 version-localization resource." @@ -3525,12 +4220,22 @@ } ], "fields": [ - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "inAppPurchaseVersions_image_getToOneRelated", "location": "path", "appleName": "id" } + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "inAppPurchaseVersions_image_getToOneRelated", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseVersions_image_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseVersions_image_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3552,33 +4257,121 @@ } ], "fields": [ - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Transport-only continuation validated against the same Apple origin, exact version-owned images path, effective limit, and one non-empty cursor." } + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Transport-only continuation validated against the same Apple origin, exact version-owned images path, effective limit, and one non-empty cursor." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "inAppPurchaseVersions_images_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after the page passes resource identity, paging, and document-link validation." }, - { "outputField": "images", "localRole": "Project each Apple image without assetToken or uploadOperations." }, - { "outputField": "images.*.id", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/id" }, - { "outputField": "images.*.type", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/type" }, - { "outputField": "images.*.file_name", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/attributes/fileName" }, - { "outputField": "images.*.file_size", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/attributes/fileSize" }, - { "outputField": "images.*.delivery_state", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/attributes/assetDeliveryState/state" }, - { "outputField": "images.*.image_asset.template_url", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/attributes/imageAsset/templateUrl" }, - { "outputField": "images.*.image_asset.width", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/attributes/imageAsset/width" }, - { "outputField": "images.*.image_asset.height", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/attributes/imageAsset/height" }, - { "outputField": "images.*.errors.*.code", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/attributes/assetDeliveryState/errors/*/code" }, - { "outputField": "images.*.errors.*.description", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/attributes/assetDeliveryState/errors/*/description" }, - { "outputField": "images.*.warnings.*.code", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/attributes/assetDeliveryState/warnings/*/code" }, - { "outputField": "images.*.warnings.*.description", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data/*/attributes/assetDeliveryState/warnings/*/description" }, - { "outputField": "count", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/data", "localRole": "Current validated Apple page resource count." }, - { "outputField": "total", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "next_url", "operationId": "inAppPurchaseVersions_images_getToManyRelated", "jsonPointer": "/links/next", "localRole": "Apple continuation URL when another page exists; otherwise omitted." } + { + "outputField": "success", + "localRole": "Set true after the page passes resource identity, paging, and document-link validation." + }, + { + "outputField": "images", + "localRole": "Project each Apple image without assetToken or uploadOperations." + }, + { + "outputField": "images.*.id", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/id" + }, + { + "outputField": "images.*.type", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/type" + }, + { + "outputField": "images.*.file_name", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/attributes/fileName" + }, + { + "outputField": "images.*.file_size", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/attributes/fileSize" + }, + { + "outputField": "images.*.delivery_state", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/attributes/assetDeliveryState/state" + }, + { + "outputField": "images.*.image_asset.template_url", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/attributes/imageAsset/templateUrl" + }, + { + "outputField": "images.*.image_asset.width", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/attributes/imageAsset/width" + }, + { + "outputField": "images.*.image_asset.height", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/attributes/imageAsset/height" + }, + { + "outputField": "images.*.errors.*.code", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/attributes/assetDeliveryState/errors/*/code" + }, + { + "outputField": "images.*.errors.*.description", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/attributes/assetDeliveryState/errors/*/description" + }, + { + "outputField": "images.*.warnings.*.code", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/attributes/assetDeliveryState/warnings/*/code" + }, + { + "outputField": "images.*.warnings.*.description", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data/*/attributes/assetDeliveryState/warnings/*/description" + }, + { + "outputField": "count", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Current validated Apple page resource count." + }, + { + "outputField": "total", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "next_url", + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "jsonPointer": "/links/next", + "localRole": "Apple continuation URL when another page exists; otherwise omitted." + } ] }, "note": "Lists one validated page of plural version-owned IAP review images with a 1 through 200 limit, scope-locked continuation, and a safe projection that excludes upload credentials." @@ -3597,8 +4390,16 @@ "role": "primary", "condition": null, "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "inAppPurchaseImages" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/version/data/type", "fixedValue": "inAppPurchaseVersions" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "inAppPurchaseImages" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/version/data/type", + "fixedValue": "inAppPurchaseVersions" + } ] }, { @@ -3608,10 +4409,33 @@ "role": "supporting", "condition": null, "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["inAppPurchaseImagesV2_createInstance:/data/id"], "localRole": "Use Apple's reserved image ID as the commit path ID." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "inAppPurchaseImages" }, - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["inAppPurchaseImagesV2_createInstance:/data/id"], "localRole": "Use Apple's reserved image ID as the commit resource ID." }, - { "sourceKind": "fixed", "jsonPointer": "/data/attributes/uploaded", "fixedValue": true } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "inAppPurchaseImagesV2_createInstance:/data/id" + ], + "localRole": "Use Apple's reserved image ID as the commit path ID." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "inAppPurchaseImages" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "inAppPurchaseImagesV2_createInstance:/data/id" + ], + "localRole": "Use Apple's reserved image ID as the commit resource ID." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/uploaded", + "fixedValue": true + } ] }, { @@ -3621,7 +4445,15 @@ "role": "conditional", "condition": "After PATCH returns a nonterminal assetDeliveryState, or when PATCH is ambiguous, reconcile and poll the exact reserved image.", "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["inAppPurchaseImagesV2_createInstance:/data/id"], "localRole": "Inspect the exact image created by the reservation." } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "inAppPurchaseImagesV2_createInstance:/data/id" + ], + "localRole": "Inspect the exact image created by the reservation." + } ] }, { @@ -3631,65 +4463,228 @@ "role": "conditional", "condition": "Before commit, best-effort delete a confirmed reservation after cancellation, missing upload operations, transfer failure, or commit-body failure; treat 404 as already absent.", "inputs": [ - { "sourceKind": "derived", "location": "path", "appleName": "id", "derivedFrom": ["inAppPurchaseImagesV2_createInstance:/data/id"], "localRole": "Rollback only the confirmed reservation for this upload attempt." } + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "inAppPurchaseImagesV2_createInstance:/data/id" + ], + "localRole": "Rollback only the confirmed reservation for this upload attempt." + } ] } ], "fields": [ - { "toolField": "version_id", "sourceKind": "requestBody", "operationId": "inAppPurchaseImagesV2_createInstance", "jsonPointer": "/data/relationships/version/data/id" }, - { "toolField": "file_path", "sourceKind": "derived", "operationId": "inAppPurchaseImagesV2_createInstance", "jsonPointer": "/data/attributes", "derivedFrom": ["file_path"], "localRole": "Create an immutable snapshot, derive fileName and fileSize, transfer its bytes through Apple's signed operations, and discard it after reconciliation." } + { + "toolField": "version_id", + "sourceKind": "requestBody", + "operationId": "inAppPurchaseImagesV2_createInstance", + "jsonPointer": "/data/relationships/version/data/id" + }, + { + "toolField": "file_path", + "sourceKind": "derived", + "operationId": "inAppPurchaseImagesV2_createInstance", + "jsonPointer": "/data/attributes", + "derivedFrom": [ + "file_path" + ], + "localRole": "Create an immutable snapshot, derive fileName and fileSize, transfer its bytes through Apple's signed operations, and discard it after reconciliation." + } ], "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseImagesV2_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "inAppPurchaseImagesV2_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchaseImagesV2_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "inAppPurchaseImagesV2_deleteInstance", "statusCode": "204" } + { + "operationId": "inAppPurchaseImagesV2_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchaseImagesV2_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchaseImagesV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "inAppPurchaseImagesV2_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "False on structured recovery failures; true on completed or accepted upload results." }, - { "outputField": "error", "localRole": "Stable failure summary when reservation or commit verification cannot complete." }, - { "outputField": "statusCode", "localRole": "Apple status code when a 2xx reservation response was committed but could not be verified." }, - { "outputField": "reservationState", "localRole": "Unknown or committed_unverified reservation state for ambiguous reserve outcomes." }, - { "outputField": "reservationIdKnown", "localRole": "False when Apple did not return a safely attributable reservation ID." }, - { "outputField": "operationCommitState", "localRole": "Unknown when Apple may have committed an operation that cannot be reconciled." }, - { "outputField": "operationCommitted", "localRole": "True when a 2xx response proves commit despite response verification failure." }, - { "outputField": "outcomeUnknown", "localRole": "True when Apple may have committed the operation and safe retry cannot be established." }, - { "outputField": "inspectionRequired", "localRole": "True when deterministic collection or exact-resource inspection is required." }, - { "outputField": "retrySafe", "localRole": "False for all unresolved, committed-unverified, retained, or confirmed destructive outcomes." }, - { "outputField": "sourceFileChecksumReceipt", "localRole": "IAP upload snapshot checksum receipt retained for support and ambiguous reservation recovery." }, - { "outputField": "reservationFingerprint", "localRole": "Stable reservation fingerprint emitted when the reserve outcome cannot be identified safely." }, - { "outputField": "reservationFingerprint.file_name", "localRole": "Snapshot file name used to match inspection candidates." }, - { "outputField": "reservationFingerprint.file_size", "localRole": "Snapshot byte count used to match inspection candidates." }, - { "outputField": "reservationFingerprint.checksum", "localRole": "Snapshot checksum used as the authoritative reservation fingerprint." }, - { "outputField": "inspection", "localRole": "Full-pagination reservation inspection guidance for ambiguous create outcomes." }, - { "outputField": "inspection.tool", "localRole": "Use iap_list_version_images for collection recovery." }, - { "outputField": "inspection.arguments", "localRole": "Scope the collection inspection to the parent version and a bounded page size." }, - { "outputField": "inspection.arguments.version_id", "localRole": "Inspect only the exact parent version." }, - { "outputField": "inspection.arguments.limit", "localRole": "Use the maximum bounded page size of 200." }, - { "outputField": "inspection.continue_with_next_url", "localRole": "Continue through every strict next_url page before deciding whether the reservation exists." }, - { "outputField": "inspection.next_url_argument", "localRole": "Names next_url as the transport-only continuation input." }, - { "outputField": "inspection.candidate_match.fingerprint_key", "localRole": "Match candidates against reservationFingerprint." }, - { "outputField": "inspection.candidate_match.candidate_fields", "localRole": "Compare candidate file_name and file_size fields." }, - { "outputField": "inspection.candidate_match.require_unique_match_before_retry", "localRole": "Retry only after inspection establishes a unique candidate outcome." }, - { "outputField": "cleanup", "localRole": "Describe rollback state or retained-resource inspect/delete guidance." }, - { "outputField": "cleanup.status", "localRole": "Rollback or retention state for the reserved resource." }, - { "outputField": "cleanup.resourceId", "localRole": "Confirmed reserved resource ID when Apple returned one." }, - { "outputField": "cleanup.reason", "localRole": "Reason cleanup failed, was unavailable, or was intentionally not attempted." }, - { "outputField": "cleanup.tool", "localRole": "Explicit destructive cleanup tool when deletion remains available." }, - { "outputField": "cleanup.arguments", "localRole": "Exact destructive cleanup arguments, including the confirmation ID." }, - { "outputField": "cleanup.arguments.image_id", "localRole": "Use the exact retained reservation ID as the destructive cleanup target." }, - { "outputField": "cleanup.arguments.confirm_image_id", "localRole": "Repeat the exact retained reservation ID as the required delete confirmation." }, - { "outputField": "cleanup.operationCommitState", "localRole": "Expose unknown or committed commit reconciliation state." }, - { "outputField": "cleanup.outcomeUnknown", "localRole": "True only when Apple may have committed the operation but reconciliation cannot prove it." }, - { "outputField": "cleanup.retrySafe", "localRole": "False whenever retry could duplicate or destroy an unresolved upload." }, - { "outputField": "cleanup.inspectTool", "localRole": "Read tool for retained-resource inspection." }, - { "outputField": "cleanup.inspectArguments", "localRole": "Exact arguments for retained-resource inspection." }, - { "outputField": "cleanup.inspectArguments.image_id", "localRole": "Inspect only the exact confirmed reservation ID." }, - { "outputField": "cleanup.statusCode", "localRole": "Apple status code for a committed but unverified operation." }, - { "outputField": "cleanup.operationCommitted", "localRole": "True when a 2xx response proves the operation was committed even though projection verification failed." }, - { "outputField": "cleanup.inspectionRequired", "localRole": "True when the retained resource needs deterministic inspection." } + { + "outputField": "success", + "localRole": "False on structured recovery failures; true on completed or accepted upload results." + }, + { + "outputField": "error", + "localRole": "Stable failure summary when reservation or commit verification cannot complete." + }, + { + "outputField": "statusCode", + "localRole": "Apple status code when a 2xx reservation response was committed but could not be verified." + }, + { + "outputField": "reservationState", + "localRole": "Unknown or committed_unverified reservation state for ambiguous reserve outcomes." + }, + { + "outputField": "reservationIdKnown", + "localRole": "False when Apple did not return a safely attributable reservation ID." + }, + { + "outputField": "operationCommitState", + "localRole": "Unknown when Apple may have committed an operation that cannot be reconciled." + }, + { + "outputField": "operationCommitted", + "localRole": "True when a 2xx response proves commit despite response verification failure." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when Apple may have committed the operation and safe retry cannot be established." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when deterministic collection or exact-resource inspection is required." + }, + { + "outputField": "retrySafe", + "localRole": "False for all unresolved, committed-unverified, retained, or confirmed destructive outcomes." + }, + { + "outputField": "sourceFileChecksumReceipt", + "localRole": "IAP upload snapshot checksum receipt retained for support and ambiguous reservation recovery." + }, + { + "outputField": "reservationFingerprint", + "localRole": "Stable reservation fingerprint emitted when the reserve outcome cannot be identified safely." + }, + { + "outputField": "reservationFingerprint.file_name", + "localRole": "Snapshot file name used to match inspection candidates." + }, + { + "outputField": "reservationFingerprint.file_size", + "localRole": "Snapshot byte count used to match inspection candidates." + }, + { + "outputField": "reservationFingerprint.checksum", + "localRole": "Snapshot checksum used as the authoritative reservation fingerprint." + }, + { + "outputField": "inspection", + "localRole": "Full-pagination reservation inspection guidance for ambiguous create outcomes." + }, + { + "outputField": "inspection.tool", + "localRole": "Use iap_list_version_images for collection recovery." + }, + { + "outputField": "inspection.arguments", + "localRole": "Scope the collection inspection to the parent version and a bounded page size." + }, + { + "outputField": "inspection.arguments.version_id", + "localRole": "Inspect only the exact parent version." + }, + { + "outputField": "inspection.arguments.limit", + "localRole": "Use the maximum bounded page size of 200." + }, + { + "outputField": "inspection.continue_with_next_url", + "localRole": "Continue through every strict next_url page before deciding whether the reservation exists." + }, + { + "outputField": "inspection.next_url_argument", + "localRole": "Names next_url as the transport-only continuation input." + }, + { + "outputField": "inspection.candidate_match.fingerprint_key", + "localRole": "Match candidates against reservationFingerprint." + }, + { + "outputField": "inspection.candidate_match.candidate_fields", + "localRole": "Compare candidate file_name and file_size fields." + }, + { + "outputField": "inspection.candidate_match.require_unique_match_before_retry", + "localRole": "Retry only after inspection establishes a unique candidate outcome." + }, + { + "outputField": "cleanup", + "localRole": "Describe rollback state or retained-resource inspect/delete guidance." + }, + { + "outputField": "cleanup.status", + "localRole": "Rollback or retention state for the reserved resource." + }, + { + "outputField": "cleanup.resourceId", + "localRole": "Confirmed reserved resource ID when Apple returned one." + }, + { + "outputField": "cleanup.reason", + "localRole": "Reason cleanup failed, was unavailable, or was intentionally not attempted." + }, + { + "outputField": "cleanup.tool", + "localRole": "Explicit destructive cleanup tool when deletion remains available." + }, + { + "outputField": "cleanup.arguments", + "localRole": "Exact destructive cleanup arguments, including the confirmation ID." + }, + { + "outputField": "cleanup.arguments.image_id", + "localRole": "Use the exact retained reservation ID as the destructive cleanup target." + }, + { + "outputField": "cleanup.arguments.confirm_image_id", + "localRole": "Repeat the exact retained reservation ID as the required delete confirmation." + }, + { + "outputField": "cleanup.operationCommitState", + "localRole": "Expose unknown or committed commit reconciliation state." + }, + { + "outputField": "cleanup.outcomeUnknown", + "localRole": "True only when Apple may have committed the operation but reconciliation cannot prove it." + }, + { + "outputField": "cleanup.retrySafe", + "localRole": "False whenever retry could duplicate or destroy an unresolved upload." + }, + { + "outputField": "cleanup.inspectTool", + "localRole": "Read tool for retained-resource inspection." + }, + { + "outputField": "cleanup.inspectArguments", + "localRole": "Exact arguments for retained-resource inspection." + }, + { + "outputField": "cleanup.inspectArguments.image_id", + "localRole": "Inspect only the exact confirmed reservation ID." + }, + { + "outputField": "cleanup.statusCode", + "localRole": "Apple status code for a committed but unverified operation." + }, + { + "outputField": "cleanup.operationCommitted", + "localRole": "True when a 2xx response proves the operation was committed even though projection verification failed." + }, + { + "outputField": "cleanup.inspectionRequired", + "localRole": "True when the retained resource needs deterministic inspection." + } ] }, "note": "The tool is the safe create-and-PATCH workflow for Apple 4.4.1 version images. It never exposes a stranded raw reservation API. Binary transfer is external to OpenAPI. COMPLETE is terminal success, FAILED terminal failure, and other assetDeliveryState values remain pending. Pre-commit failures roll back; ambiguous or accepted commits retain the resource and provide exact inspect/delete guidance." @@ -3710,12 +4705,22 @@ } ], "fields": [ - { "toolField": "image_id", "sourceKind": "parameter", "operationId": "inAppPurchaseImagesV2_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "image_id", + "sourceKind": "parameter", + "operationId": "inAppPurchaseImagesV2_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "opaque", "sources": [ - { "operationId": "inAppPurchaseImagesV2_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "inAppPurchaseImagesV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3728,24 +4733,61 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "inAppPurchaseImagesV2_deleteInstance", "method": "delete", "path": "/v2/inAppPurchaseImages/{id}", "role": "primary", "condition": null } + { + "operationId": "inAppPurchaseImagesV2_deleteInstance", + "method": "delete", + "path": "/v2/inAppPurchaseImages/{id}", + "role": "primary", + "condition": null + } ], "fields": [ - { "toolField": "image_id", "sourceKind": "parameter", "operationId": "inAppPurchaseImagesV2_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_image_id", "sourceKind": "local", "localRole": "Require an exact canonical match with image_id before any Apple request is sent." } + { + "toolField": "image_id", + "sourceKind": "parameter", + "operationId": "inAppPurchaseImagesV2_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_image_id", + "sourceKind": "local", + "localRole": "Require an exact canonical match with image_id before any Apple request is sent." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "inAppPurchaseImagesV2_deleteInstance", "statusCode": "204" } + { + "operationId": "inAppPurchaseImagesV2_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after Apple confirms deletion with 204." }, - { "outputField": "image_id", "localRole": "Echo the exact deleted image ID." }, - { "outputField": "deleted", "localRole": "Set true after confirmed deletion." }, - { "outputField": "deletionState", "localRole": "Set to confirmed after Apple's 204 response." }, - { "outputField": "outcomeUnknown", "localRole": "Set false for a confirmed deletion." }, - { "outputField": "retrySafe", "localRole": "Set false because the destructive operation is already confirmed." } + { + "outputField": "success", + "localRole": "Set true after Apple confirms deletion with 204." + }, + { + "outputField": "image_id", + "localRole": "Echo the exact deleted image ID." + }, + { + "outputField": "deleted", + "localRole": "Set true after confirmed deletion." + }, + { + "outputField": "deletionState", + "localRole": "Set to confirmed after Apple's 204 response." + }, + { + "outputField": "outcomeUnknown", + "localRole": "Set false for a confirmed deletion." + }, + { + "outputField": "retrySafe", + "localRole": "Set false because the destructive operation is already confirmed." + } ] }, "note": "Deletes only the explicitly identified Apple 4.4.1 v2 version image." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/metrics.json b/Sources/asc-mcp/Resources/OperationManifest/tools/metrics.json index 9b56ced..578ae15 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/metrics.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/metrics.json @@ -115,7 +115,7 @@ "appleName": "filter[platform]", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 advertises IOS as the only legal platform filter value. This legacy performance tool preserves its unfiltered request contract; it does not claim support for additional platform filter values.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -285,7 +285,7 @@ "appleName": "filter[platform]", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 advertises IOS as the only legal platform filter value. This legacy performance tool preserves its unfiltered request contract; it does not claim support for additional platform filter values.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/ppo.json b/Sources/asc-mcp/Resources/OperationManifest/tools/ppo.json index 673dbf4..8b96fa9 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/ppo.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/ppo.json @@ -14,26 +14,69 @@ "path": "/v2/appStoreVersionExperiments", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appStoreVersionExperiments" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appStoreVersionExperiments" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentsV2_createInstance", "jsonPointer": "/data/relationships/app/data/id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentsV2_createInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "traffic_proportion", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentsV2_createInstance", "jsonPointer": "/data/attributes/trafficProportion" }, - { "toolField": "platform", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentsV2_createInstance", "jsonPointer": "/data/attributes/platform", "localRole": "Default to IOS only when the tool field is omitted." } + { + "toolField": "app_id", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentsV2_createInstance", + "jsonPointer": "/data/relationships/app/data/id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentsV2_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "traffic_proportion", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentsV2_createInstance", + "jsonPointer": "/data/attributes/trafficProportion" + }, + { + "toolField": "platform", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentsV2_createInstance", + "jsonPointer": "/data/attributes/platform", + "localRole": "Default to IOS only when the tool field is omitted." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionExperimentsV2_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "appStoreVersionExperimentsV2_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "exact201AndCanonicalResource" }, - { "outputField": "experiment", "operationId": "appStoreVersionExperimentsV2_createInstance", "jsonPointer": "/data" }, - { "outputField": "operationCommitState", "localRole": "structuredNonIdempotentWriteState" } + { + "outputField": "success", + "localRole": "exact201AndCanonicalResource" + }, + { + "outputField": "experiment", + "operationId": "appStoreVersionExperimentsV2_createInstance", + "jsonPointer": "/data" + }, + { + "outputField": "operationCommitState", + "localRole": "structuredNonIdempotentWriteState" + } ] }, "note": "Current V2 create only. Exact HTTP 201, canonical response identity, requested attributes, and links.self are validated; ambiguous POST outcomes are never replayed and return list/get recovery instructions." @@ -51,8 +94,16 @@ "path": "/v1/appStoreVersionExperimentTreatments", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appStoreVersionExperimentTreatments" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appStoreVersionExperimentV2/data/type", "fixedValue": "appStoreVersionExperiments" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appStoreVersionExperimentTreatments" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appStoreVersionExperimentV2/data/type", + "fixedValue": "appStoreVersionExperiments" + } ], "optionalParameterClassifications": [ { @@ -60,25 +111,55 @@ "appleName": "/data/relationships/appStoreVersionExperiment", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 retains this deprecated V1 parent alternative. PPO tools accept only current V2 experiment IDs and always bind appStoreVersionExperimentV2, so exposing both parents would make lineage ambiguous.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "experiment_id", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentTreatments_createInstance", "jsonPointer": "/data/relationships/appStoreVersionExperimentV2/data/id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentTreatments_createInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "app_icon_name", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentTreatments_createInstance", "jsonPointer": "/data/attributes/appIconName", "localRole": "Preserve omission, explicit null, and concrete string." } + { + "toolField": "experiment_id", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentTreatments_createInstance", + "jsonPointer": "/data/relationships/appStoreVersionExperimentV2/data/id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentTreatments_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "app_icon_name", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentTreatments_createInstance", + "jsonPointer": "/data/attributes/appIconName", + "localRole": "Preserve omission, explicit null, and concrete string." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionExperimentTreatments_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "appStoreVersionExperimentTreatments_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "exact201AndCanonicalResource" }, - { "outputField": "treatment", "operationId": "appStoreVersionExperimentTreatments_createInstance", "jsonPointer": "/data" }, - { "outputField": "operationCommitState", "localRole": "structuredNonIdempotentWriteState" } + { + "outputField": "success", + "localRole": "exact201AndCanonicalResource" + }, + { + "outputField": "treatment", + "operationId": "appStoreVersionExperimentTreatments_createInstance", + "jsonPointer": "/data" + }, + { + "outputField": "operationCommitState", + "localRole": "structuredNonIdempotentWriteState" + } ] }, "note": "Creates only under appStoreVersionExperimentV2 and never sends the deprecated V1 relationship. Exact status, identity, attributes, and links.self are validated." @@ -96,27 +177,65 @@ "path": "/v1/appStoreVersionExperimentTreatmentLocalizations", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appStoreVersionExperimentTreatmentLocalizations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatment/data/type", "fixedValue": "appStoreVersionExperimentTreatments" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appStoreVersionExperimentTreatmentLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatment/data/type", + "fixedValue": "appStoreVersionExperimentTreatments" + } ], "optionalParameterClassifications": [ - {"location": "body", "appleName": "/data/relationships/placements", "disposition": "intentionallyOmitted", "reason": "Localization creation and Asset Library placement are separate operations. This legacy create tool does not attach existing placement IDs; prepare and apply placement creation through AssetsWorker after creating the localization so ownership, specification, draft state, and preview checks remain mandatory.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/relationships/placements", + "disposition": "intentionallyOmitted", + "reason": "Localization creation and Asset Library placement are separate operations. This legacy create tool does not attach existing placement IDs; prepare and apply placement creation through AssetsWorker after creating the localization so ownership, specification, draft state, and preview checks remain mandatory.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "treatment_id", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentTreatmentLocalizations_createInstance", "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatment/data/id" }, - { "toolField": "locale", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentTreatmentLocalizations_createInstance", "jsonPointer": "/data/attributes/locale" } + { + "toolField": "treatment_id", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_createInstance", + "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatment/data/id" + }, + { + "toolField": "locale", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_createInstance", + "jsonPointer": "/data/attributes/locale" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionExperimentTreatmentLocalizations_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "exact201AndCanonicalResource" }, - { "outputField": "localization", "operationId": "appStoreVersionExperimentTreatmentLocalizations_createInstance", "jsonPointer": "/data" }, - { "outputField": "operationCommitState", "localRole": "structuredNonIdempotentWriteState" } + { + "outputField": "success", + "localRole": "exact201AndCanonicalResource" + }, + { + "outputField": "localization", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_createInstance", + "jsonPointer": "/data" + }, + { + "outputField": "operationCommitState", + "localRole": "structuredNonIdempotentWriteState" + } ] }, "note": "Exact HTTP 201, canonical response identity, locale, parent relationship when returned, and links.self are validated; ambiguous POST outcomes return scoped recovery." @@ -136,18 +255,40 @@ } ], "fields": [ - { "toolField": "experiment_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentsV2_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_experiment_id", "sourceKind": "local", "localRole": "Exact irreversible-delete confirmation matching experiment_id." } + { + "toolField": "experiment_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentsV2_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_experiment_id", + "sourceKind": "local", + "localRole": "Exact irreversible-delete confirmation matching experiment_id." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "appStoreVersionExperimentsV2_deleteInstance", "statusCode": "204" } + { + "operationId": "appStoreVersionExperimentsV2_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "exact204" }, - { "outputField": "operationCommitState", "localRole": "structuredDeleteOutcome" }, - { "outputField": "message", "localRole": "deleteConfirmation" } + { + "outputField": "success", + "localRole": "exact204" + }, + { + "outputField": "operationCommitState", + "localRole": "structuredDeleteOutcome" + }, + { + "outputField": "message", + "localRole": "deleteConfirmation" + } ] }, "note": "Requires exact ID confirmation. Only HTTP 204 is reported as committed; unknown and unexpected-success outcomes require exact get inspection before retry." @@ -167,18 +308,40 @@ } ], "fields": [ - { "toolField": "treatment_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatments_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_treatment_id", "sourceKind": "local", "localRole": "Exact irreversible-delete confirmation matching treatment_id." } + { + "toolField": "treatment_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatments_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_treatment_id", + "sourceKind": "local", + "localRole": "Exact irreversible-delete confirmation matching treatment_id." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "appStoreVersionExperimentTreatments_deleteInstance", "statusCode": "204" } + { + "operationId": "appStoreVersionExperimentTreatments_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "exact204" }, - { "outputField": "operationCommitState", "localRole": "structuredDeleteOutcome" }, - { "outputField": "message", "localRole": "deleteConfirmation" } + { + "outputField": "success", + "localRole": "exact204" + }, + { + "outputField": "operationCommitState", + "localRole": "structuredDeleteOutcome" + }, + { + "outputField": "message", + "localRole": "deleteConfirmation" + } ] }, "note": "Current shared treatment delete endpoint with exact confirmation and fail-closed outcome reporting. No deprecated V1 experiment endpoint is used." @@ -198,18 +361,40 @@ } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_localization_id", "sourceKind": "local", "localRole": "Exact irreversible-delete confirmation matching localization_id." } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_localization_id", + "sourceKind": "local", + "localRole": "Exact irreversible-delete confirmation matching localization_id." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "appStoreVersionExperimentTreatmentLocalizations_deleteInstance", "statusCode": "204" } + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "exact204" }, - { "outputField": "operationCommitState", "localRole": "structuredDeleteOutcome" }, - { "outputField": "message", "localRole": "deleteConfirmation" } + { + "outputField": "success", + "localRole": "exact204" + }, + { + "outputField": "operationCommitState", + "localRole": "structuredDeleteOutcome" + }, + { + "outputField": "message", + "localRole": "deleteConfirmation" + } ] }, "note": "Requires exact localization-ID confirmation and accepts only Apple's exact 204 contract as committed." @@ -227,23 +412,58 @@ "path": "/v2/appStoreVersionExperiments/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 can expand app, control-version, and treatment resources; the detail tool returns the canonical experiment and dedicated tools own child collections.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentTreatments]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only to an omitted treatment include; ppo_list_treatments provides strict continuation.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[controlVersions]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only to an omitted controlVersions include.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 can expand app, control-version, and treatment resources; the detail tool returns the canonical experiment and dedicated tools own child collections.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatments]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only to an omitted treatment include; ppo_list_treatments provides strict continuation.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[controlVersions]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only to an omitted controlVersions include.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "experiment_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentsV2_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "experiment_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentsV2_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionExperimentsV2_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionExperimentsV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "exact200AndCanonicalIdentity" }, - { "outputField": "experiment", "operationId": "appStoreVersionExperimentsV2_getInstance", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "exact200AndCanonicalIdentity" + }, + { + "outputField": "experiment", + "operationId": "appStoreVersionExperimentsV2_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Current V2 detail endpoint only; validates exact identity and required document self-link." @@ -261,22 +481,51 @@ "path": "/v1/appStoreVersionExperimentTreatments/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 allows legacy-parent and child expansion; the direct treatment projection avoids the deprecated parent and uses ppo_list_treatment_localizations for child resources.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only to the omitted localization include; the child collection has strict pagination.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 allows legacy-parent and child expansion; the direct treatment projection avoids the deprecated parent and uses ppo_list_treatment_localizations for child resources.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only to the omitted localization include; the child collection has strict pagination.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "treatment_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatments_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "treatment_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatments_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionExperimentTreatments_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionExperimentTreatments_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "exact200AndCanonicalIdentity" }, - { "outputField": "treatment", "operationId": "appStoreVersionExperimentTreatments_getInstance", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "exact200AndCanonicalIdentity" + }, + { + "outputField": "treatment", + "operationId": "appStoreVersionExperimentTreatments_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Shared nondeprecated treatment detail endpoint; a response containing only the deprecated V1 parent relationship is rejected." @@ -294,24 +543,65 @@ "path": "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 allows media expansion; this tool returns the localization identity and locale while legacy screenshots and previews remain in ScreenshotsWorker and Asset Library placements use AssetsWorker.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested preview limit only to the omitted appPreviewSets include.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested screenshot limit only to the omitted appScreenshotSets include.", "reviewAtSpec": "4.5.1" }, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 allows media expansion; this tool returns the localization identity and locale while legacy screenshots and previews remain in ScreenshotsWorker and Asset Library placements use AssetsWorker.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested preview limit only to the omitted appPreviewSets include.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested screenshot limit only to the omitted appScreenshotSets include.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "exact200AndCanonicalIdentity" }, - { "outputField": "localization", "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "exact200AndCanonicalIdentity" + }, + { + "outputField": "localization", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Direct localization read with exact identity and required links.self validation." @@ -329,27 +619,83 @@ "path": "/v1/apps/{id}/appStoreVersionExperimentsV2", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 can expand app, control-version, and treatment resources; this app collection returns experiment resources only and dedicated tools own children.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentTreatments]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only to an omitted treatment include.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[controlVersions]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested limit only to an omitted controlVersions include.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 can expand app, control-version, and treatment resources; this app collection returns experiment resources only and dedicated tools own children.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatments]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only to an omitted treatment include.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[controlVersions]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested limit only to an omitted controlVersions include.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "states", "sourceKind": "parameter", "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", "location": "query", "appleName": "filter[state]", "localRole": "Validate scalar-or-array enum and serialize Apple's explode=false CSV filter." }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict continuation bound to path, effective limit, state filter, origin, and non-empty cursor." } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "states", + "sourceKind": "parameter", + "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", + "location": "query", + "appleName": "filter[state]", + "localRole": "Validate scalar-or-array enum and serialize Apple's explode=false CSV filter." + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict continuation bound to path, effective limit, state filter, origin, and non-empty cursor." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "validatedCollection" }, - { "outputField": "experiments", "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "validatedCollection" + }, + { + "outputField": "experiments", + "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", + "jsonPointer": "/links/next" + } ] }, "note": "App-scoped current V2 list with strict arguments, canonical unique identities, required self-link, paging metadata checks, and exact continuation lineage." @@ -367,28 +713,90 @@ "path": "/v1/appStoreVersionExperimentTreatments/{id}/appStoreVersionExperimentTreatmentLocalizations", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 can expand the treatment and media resources; this localization collection stays narrow; ScreenshotsWorker owns legacy media and AssetsWorker owns Asset Library placement operations.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appPreviewSets]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested preview limit only to an omitted appPreviewSets include.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshotSets]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested screenshot limit only to an omitted appScreenshotSets include.", "reviewAtSpec": "4.5.1" }, - {"location": "query", "appleName": "limit[placements]", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", "reviewAtSpec": "4.5.1"} + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 can expand the treatment and media resources; this localization collection stays narrow; ScreenshotsWorker owns legacy media and AssetsWorker owns Asset Library placement operations.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appPreviewSets]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested preview limit only to an omitted appPreviewSets include.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshotSets]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested screenshot limit only to an omitted appScreenshotSets include.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[placements]", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 applies this optional limit only to included placements. This existing localization workflow does not request or project placement resources; use assets_list_placements for independently paginated Asset Library placements.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "treatment_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "locale", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", "location": "query", "appleName": "filter[locale]", "localRole": "Validate scalar-or-array values and serialize Apple's explode=false CSV filter." }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict continuation bound to path, effective limit, locale filter, origin, and non-empty cursor." } + { + "toolField": "treatment_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "locale", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", + "location": "query", + "appleName": "filter[locale]", + "localRole": "Validate scalar-or-array values and serialize Apple's explode=false CSV filter." + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict continuation bound to path, effective limit, locale filter, origin, and non-empty cursor." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "validatedCollection" }, - { "outputField": "localizations", "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "validatedCollection" + }, + { + "outputField": "localizations", + "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", + "jsonPointer": "/links/next" + } ] }, "note": "Treatment-scoped localization list with strict locale filtering, unique identities, parent lineage when returned, paging validation, and exact continuation scope." @@ -406,25 +814,68 @@ "path": "/v2/appStoreVersionExperiments/{id}/appStoreVersionExperimentTreatments", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 can expand parent and localization resources; the V2 relationship endpoint establishes lineage and the child collection is separate.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested localization limit only to an omitted include.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 can expand parent and localization resources; the V2 relationship endpoint establishes lineage and the child collection is separate.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatmentLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested localization limit only to an omitted include.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "experiment_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict continuation bound to the V2 parent path, effective limit, origin, and non-empty cursor." } + { + "toolField": "experiment_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict continuation bound to the V2 parent path, effective limit, origin, and non-empty cursor." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "validatedCollection" }, - { "outputField": "treatments", "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "validatedCollection" + }, + { + "outputField": "treatments", + "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", + "jsonPointer": "/links/next" + } ] }, "note": "Uses only the V2 experiment relationship endpoint, validates unique canonical treatment identities and returned parent lineage, and preserves strict pagination scope." @@ -442,27 +893,83 @@ "path": "/v1/appStoreVersions/{id}/appStoreVersionExperimentsV2", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 allows related-resource expansion; the version-scoped endpoint establishes lineage directly while app, control-version, and treatment resources remain separate contracts.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentTreatments]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested treatment limit only to the omitted include; ppo_list_treatments is strictly paginated.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[controlVersions]", "disposition": "intentionallyOmitted", "reason": "Apple applies this nested control-version limit only to the omitted include.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 allows related-resource expansion; the version-scoped endpoint establishes lineage directly while app, control-version, and treatment resources remain separate contracts.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentTreatments]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested treatment limit only to the omitted include; ppo_list_treatments is strictly paginated.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[controlVersions]", + "disposition": "intentionallyOmitted", + "reason": "Apple applies this nested control-version limit only to the omitted include.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "version_id", "sourceKind": "parameter", "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "states", "sourceKind": "parameter", "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", "location": "query", "appleName": "filter[state]", "localRole": "Validate scalar-or-array enum and serialize Apple's explode=false CSV filter." }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict continuation bound to the exact version path, effective limit, state filter, origin, and non-empty cursor." } + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "states", + "sourceKind": "parameter", + "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", + "location": "query", + "appleName": "filter[state]", + "localRole": "Validate scalar-or-array enum and serialize Apple's explode=false CSV filter." + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict continuation bound to the exact version path, effective limit, state filter, origin, and non-empty cursor." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "validatedCollection" }, - { "outputField": "experiments", "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "validatedCollection" + }, + { + "outputField": "experiments", + "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", + "jsonPointer": "/links/next" + } ] }, "note": "Adds the practical nondeprecated Apple 4.4.1 version-scoped V2 collection with the same strict filtering and pagination contract as the app-scoped list." @@ -480,29 +987,91 @@ "path": "/v2/appStoreVersionExperiments/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appStoreVersionExperiments" }, - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["experiment_id"], "localRole": "Copy the canonical path identifier to the body." } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appStoreVersionExperiments" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "experiment_id" + ], + "localRole": "Copy the canonical path identifier to the body." + } ] } ], "fields": [ - { "toolField": "experiment_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentsV2_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentsV2_updateInstance", "jsonPointer": "/data/attributes/name", "localRole": "Preserve omission, explicit null, and concrete string." }, - { "toolField": "traffic_proportion", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentsV2_updateInstance", "jsonPointer": "/data/attributes/trafficProportion", "localRole": "Preserve omission, explicit null, and concrete integer." }, - { "toolField": "state", "sourceKind": "derived", "operationId": "appStoreVersionExperimentsV2_updateInstance", "jsonPointer": "/data/attributes/started", "localRole": "Map START to true, STOP to false, explicit null to null, and omission to no key.", "derivedFrom": ["state"] }, - { "toolField": "confirm_experiment_id", "sourceKind": "local", "localRole": "Exact experiment_id confirmation required whenever state is present." } + { + "toolField": "experiment_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentsV2_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentsV2_updateInstance", + "jsonPointer": "/data/attributes/name", + "localRole": "Preserve omission, explicit null, and concrete string." + }, + { + "toolField": "traffic_proportion", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentsV2_updateInstance", + "jsonPointer": "/data/attributes/trafficProportion", + "localRole": "Preserve omission, explicit null, and concrete integer." + }, + { + "toolField": "state", + "sourceKind": "derived", + "operationId": "appStoreVersionExperimentsV2_updateInstance", + "jsonPointer": "/data/attributes/started", + "localRole": "Map START to true, STOP to false, explicit null to null, and omission to no key.", + "derivedFrom": [ + "state" + ] + }, + { + "toolField": "confirm_experiment_id", + "sourceKind": "local", + "localRole": "Exact experiment_id confirmation required whenever state is present." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionExperimentsV2_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionExperimentsV2_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "exact200AndCanonicalResource" }, - { "outputField": "experiment", "operationId": "appStoreVersionExperimentsV2_updateInstance", "jsonPointer": "/data" }, - { "outputField": "operationCommitState", "localRole": "structuredNonIdempotentWriteState" }, - { "outputField": "changed", "localRole": "Null because a PATCH response proves the accepted target state but not that the pre-request state differed." }, - { "outputField": "changeVerified", "localRole": "False without a pre-mutation read." } + { + "outputField": "success", + "localRole": "exact200AndCanonicalResource" + }, + { + "outputField": "experiment", + "operationId": "appStoreVersionExperimentsV2_updateInstance", + "jsonPointer": "/data" + }, + { + "outputField": "operationCommitState", + "localRole": "structuredNonIdempotentWriteState" + }, + { + "outputField": "changed", + "localRole": "Null because a PATCH response proves the accepted target state but not that the pre-request state differed." + }, + { + "outputField": "changeVerified", + "localRole": "False without a pre-mutation read." + } ] }, "note": "Rejects empty updates and unknown keys, preserves nullable request states with presence checks, requires exact lifecycle confirmation, and never replays an ambiguous PATCH. STOP is verified only when Apple returns STOPPED; START and started=null remain committed_unverified because Apple 4.4.1 exposes no response attribute that can attribute those lifecycle outcomes to this request." @@ -520,27 +1089,76 @@ "path": "/v1/appStoreVersionExperimentTreatments/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appStoreVersionExperimentTreatments" }, - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["treatment_id"], "localRole": "Copy the canonical path identifier to the body." } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appStoreVersionExperimentTreatments" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "treatment_id" + ], + "localRole": "Copy the canonical path identifier to the body." + } ] } ], "fields": [ - { "toolField": "treatment_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatments_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentTreatments_updateInstance", "jsonPointer": "/data/attributes/name", "localRole": "Preserve omission, explicit null, and concrete string." }, - { "toolField": "app_icon_name", "sourceKind": "requestBody", "operationId": "appStoreVersionExperimentTreatments_updateInstance", "jsonPointer": "/data/attributes/appIconName", "localRole": "Preserve omission, explicit null, and concrete string." } + { + "toolField": "treatment_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatments_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentTreatments_updateInstance", + "jsonPointer": "/data/attributes/name", + "localRole": "Preserve omission, explicit null, and concrete string." + }, + { + "toolField": "app_icon_name", + "sourceKind": "requestBody", + "operationId": "appStoreVersionExperimentTreatments_updateInstance", + "jsonPointer": "/data/attributes/appIconName", + "localRole": "Preserve omission, explicit null, and concrete string." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionExperimentTreatments_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionExperimentTreatments_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "exact200AndCanonicalResource" }, - { "outputField": "treatment", "operationId": "appStoreVersionExperimentTreatments_updateInstance", "jsonPointer": "/data" }, - { "outputField": "operationCommitState", "localRole": "structuredNonIdempotentWriteState" }, - { "outputField": "changed", "localRole": "Null because a PATCH response proves the accepted target state but not that the pre-request state differed." }, - { "outputField": "changeVerified", "localRole": "False without a pre-mutation read." } + { + "outputField": "success", + "localRole": "exact200AndCanonicalResource" + }, + { + "outputField": "treatment", + "operationId": "appStoreVersionExperimentTreatments_updateInstance", + "jsonPointer": "/data" + }, + { + "outputField": "operationCommitState", + "localRole": "structuredNonIdempotentWriteState" + }, + { + "outputField": "changed", + "localRole": "Null because a PATCH response proves the accepted target state but not that the pre-request state differed." + }, + { + "outputField": "changeVerified", + "localRole": "False without a pre-mutation read." + } ] }, "note": "Adds the nondeprecated treatment PATCH, rejects empty updates, preserves null versus omission with presence checks, validates exact HTTP 200 and canonical identity, reports change as unverified without a pre-read, and returns fail-closed recovery for ambiguous writes." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/pre_release.json b/Sources/asc-mcp/Resources/OperationManifest/tools/pre_release.json index 0452191..ac9bdb3 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/pre_release.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/pre_release.json @@ -19,14 +19,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The detail tool preserves relationship IDs and uses dedicated tools for full related builds.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Builds are not included by this detail projection.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -77,14 +77,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The collection preserves relationship IDs and uses pre_release_list_builds for full related Build resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Builds are not included by the pre-release collection projection.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/pricing.json b/Sources/asc-mcp/Resources/OperationManifest/tools/pricing.json index 3a00f7d..7e9e0b3 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/pricing.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/pricing.json @@ -14,23 +14,47 @@ "path": "/v2/appAvailabilities", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appAvailabilities" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/territoryAvailabilities/data/*/type", "fixedValue": "territoryAvailabilities" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appAvailabilities" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/territoryAvailabilities/data/*/type", + "fixedValue": "territoryAvailabilities" + }, { "sourceKind": "derived", "jsonPointer": "/data/relationships/territoryAvailabilities/data/*/id", - "derivedFrom": ["local:inlineTerritoryAvailabilityId"], + "derivedFrom": [ + "local:inlineTerritoryAvailabilityId" + ], "localRole": "appendGeneratedInlineTerritoryAvailabilityIdentifiers" }, - { "sourceKind": "fixed", "jsonPointer": "/included/*/type", "fixedValue": "territoryAvailabilities" }, + { + "sourceKind": "fixed", + "jsonPointer": "/included/*/type", + "fixedValue": "territoryAvailabilities" + }, { "sourceKind": "derived", "jsonPointer": "/included/*/id", - "derivedFrom": ["local:inlineTerritoryAvailabilityId"], + "derivedFrom": [ + "local:inlineTerritoryAvailabilityId" + ], "localRole": "reuseGeneratedInlineTerritoryAvailabilityIdentifier" }, - { "sourceKind": "fixed", "jsonPointer": "/included/*/relationships/territory/data/type", "fixedValue": "territories" } + { + "sourceKind": "fixed", + "jsonPointer": "/included/*/relationships/territory/data/type", + "fixedValue": "territories" + } ] } ], @@ -406,7 +430,11 @@ "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["manualPrices", "automaticPrices", "baseTerritory"] + "fixedValue": [ + "manualPrices", + "automaticPrices", + "baseTerritory" + ] } ] } @@ -582,7 +610,9 @@ "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["territory"] + "fixedValue": [ + "territory" + ] } ] } @@ -618,8 +648,16 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "apps_appPricePoints_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "apps_appPricePoints_getToManyRelated", "statusCode": "200", "mediaType": "text/csv" } + { + "operationId": "apps_appPricePoints_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appPricePoints_getToManyRelated", + "statusCode": "200", + "mediaType": "text/csv" + } ], "fields": [ { @@ -721,7 +759,9 @@ "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["territory"] + "fixedValue": [ + "territory" + ] } ] } @@ -809,14 +849,14 @@ "appleName": "include", "disposition": "internalControl", "reason": "The resolver needs only the authoritative availability ID; the primary operation fetches the complete paginated territory collection with included territories.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[territoryAvailabilities]", "disposition": "internalControl", "reason": "The resolver does not include territoryAvailabilities because the primary related-collection operation provides independent pagination up to 200 resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -831,14 +871,18 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["apps_appAvailabilityV2_getToOneRelated:/data/id"], + "derivedFrom": [ + "apps_appAvailabilityV2_getToOneRelated:/data/id" + ], "localRole": "useResolvedAppAvailabilityIdentifier" }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["territory"] + "fixedValue": [ + "territory" + ] } ] } @@ -867,8 +911,16 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "appAvailabilitiesV2_territoryAvailabilities_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "apps_appAvailabilityV2_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appAvailabilitiesV2_territoryAvailabilities_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appAvailabilityV2_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { @@ -917,28 +969,59 @@ "path": "/v1/appPriceSchedules", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appPriceSchedules" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/baseTerritory/data/type", "fixedValue": "territories" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/manualPrices/data/*/type", "fixedValue": "appPrices" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appPriceSchedules" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/baseTerritory/data/type", + "fixedValue": "territories" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/manualPrices/data/*/type", + "fixedValue": "appPrices" + }, { "sourceKind": "derived", "jsonPointer": "/data/relationships/manualPrices/data/*/id", - "derivedFrom": ["local:inlinePriceIds"], + "derivedFrom": [ + "local:inlinePriceIds" + ], "localRole": "reuseGeneratedInlinePriceIdentifiers" }, - { "sourceKind": "fixed", "jsonPointer": "/included/*/type", "fixedValue": "appPrices" }, + { + "sourceKind": "fixed", + "jsonPointer": "/included/*/type", + "fixedValue": "appPrices" + }, { "sourceKind": "derived", "jsonPointer": "/included/*/id", - "derivedFrom": ["local:inlinePriceIds"], + "derivedFrom": [ + "local:inlinePriceIds" + ], "localRole": "reuseGeneratedInlinePriceIdentifiers" }, - { "sourceKind": "fixed", "jsonPointer": "/included/*/relationships/appPricePoint/data/type", "fixedValue": "appPricePoints" }, + { + "sourceKind": "fixed", + "jsonPointer": "/included/*/relationships/appPricePoint/data/type", + "fixedValue": "appPricePoints" + }, { "sourceKind": "derived", "jsonPointer": "/included/*/relationships/appPricePoint/data/id", - "derivedFrom": ["price_point_id", "manual_prices/*/price_point_id"], + "derivedFrom": [ + "price_point_id", + "manual_prices/*/price_point_id" + ], "localRole": "embedSelectedAppPricePointIdentifiers" } ] diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/promoted.json b/Sources/asc-mcp/Resources/OperationManifest/tools/promoted.json index e9663ae..d2f6b42 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/promoted.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/promoted.json @@ -15,10 +15,26 @@ "role": "primary", "condition": null, "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "promotedPurchases" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/inAppPurchaseV2/data/type", "fixedValue": "inAppPurchases" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/subscription/data/type", "fixedValue": "subscriptions" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "promotedPurchases" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/inAppPurchaseV2/data/type", + "fixedValue": "inAppPurchases" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/subscription/data/type", + "fixedValue": "subscriptions" + } ] } ], @@ -57,22 +73,73 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "promotedPurchases_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "promotedPurchases_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulCreate" }, - { "outputField": "operation", "localRole": "create discriminator" }, - { "outputField": "operationCommitted", "localRole": "True only after Apple's exact 201 response has a canonical promoted-purchase identity." }, - { "outputField": "operationCommitState", "localRole": "committed for a validated 201, committed_unverified for an invalid accepted response, unknown for an ambiguous request, or rejected for a definitive rejection." }, - { "outputField": "retrySafe", "localRole": "False for all mutation outcomes; ambiguous outcomes require inspection before another create." }, - { "outputField": "statusCode", "localRole": "Exact verified 201 status." }, - { "outputField": "promoted_purchase.id", "operationId": "promotedPurchases_createInstance", "jsonPointer": "/data/id" }, - { "outputField": "promoted_purchase.visibleForAllUsers", "operationId": "promotedPurchases_createInstance", "jsonPointer": "/data/attributes/visibleForAllUsers" }, - { "outputField": "promoted_purchase.enabled", "operationId": "promotedPurchases_createInstance", "jsonPointer": "/data/attributes/enabled" }, - { "outputField": "promoted_purchase.state", "operationId": "promotedPurchases_createInstance", "jsonPointer": "/data/attributes/state" }, - { "outputField": "promoted_purchase.inAppPurchaseId", "operationId": "promotedPurchases_createInstance", "jsonPointer": "/data/relationships/inAppPurchaseV2/data/id", "localRole": "Exact canonical response linkage required when iap_id was requested." }, - { "outputField": "promoted_purchase.subscriptionId", "operationId": "promotedPurchases_createInstance", "jsonPointer": "/data/relationships/subscription/data/id", "localRole": "Exact canonical response linkage required when subscription_id was requested." }, - { "outputField": "details.recovery", "localRole": "Executable app-scoped promoted_list and promoted_get candidate inspection with explicit request-to-output field mappings for unknown or committed-unverified create outcomes." } + { + "outputField": "success", + "localRole": "successfulCreate" + }, + { + "outputField": "operation", + "localRole": "create discriminator" + }, + { + "outputField": "operationCommitted", + "localRole": "True only after Apple's exact 201 response has a canonical promoted-purchase identity." + }, + { + "outputField": "operationCommitState", + "localRole": "committed for a validated 201, committed_unverified for an invalid accepted response, unknown for an ambiguous request, or rejected for a definitive rejection." + }, + { + "outputField": "retrySafe", + "localRole": "False for all mutation outcomes; ambiguous outcomes require inspection before another create." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 201 status." + }, + { + "outputField": "promoted_purchase.id", + "operationId": "promotedPurchases_createInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "promoted_purchase.visibleForAllUsers", + "operationId": "promotedPurchases_createInstance", + "jsonPointer": "/data/attributes/visibleForAllUsers" + }, + { + "outputField": "promoted_purchase.enabled", + "operationId": "promotedPurchases_createInstance", + "jsonPointer": "/data/attributes/enabled" + }, + { + "outputField": "promoted_purchase.state", + "operationId": "promotedPurchases_createInstance", + "jsonPointer": "/data/attributes/state" + }, + { + "outputField": "promoted_purchase.inAppPurchaseId", + "operationId": "promotedPurchases_createInstance", + "jsonPointer": "/data/relationships/inAppPurchaseV2/data/id", + "localRole": "Exact canonical response linkage required when iap_id was requested." + }, + { + "outputField": "promoted_purchase.subscriptionId", + "operationId": "promotedPurchases_createInstance", + "jsonPointer": "/data/relationships/subscription/data/id", + "localRole": "Exact canonical response linkage required when subscription_id was requested." + }, + { + "outputField": "details.recovery", + "localRole": "Executable app-scoped promoted_list and promoted_get candidate inspection with explicit request-to-output field mappings for unknown or committed-unverified create outcomes." + } ] }, "note": "Create binds canonical app and exactly one canonical product identity plus required visibility. enabled is optional; omission stays omitted and explicit null is preserved in the request. Success requires exact HTTP 201, canonical promotedPurchases type and ID, a configured-origin or root-relative canonical required document links.self, the exact requested primary product linkage, non-null response Booleans when present, and exact included-resource lineage; unknown and malformed accepted outcomes fail closed with structured app-scoped candidate-inspection recovery." @@ -109,15 +176,36 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "promotedPurchases_deleteInstance", "statusCode": "204" } + { + "operationId": "promotedPurchases_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "True only for exact HTTP 204." }, - { "outputField": "deleted", "localRole": "True only for exact HTTP 204." }, - { "outputField": "deletionState", "localRole": "confirmed for 204, committed_unverified for another accepted status, commit_unknown for an ambiguous outcome, or rejected for a definitive rejection." }, - { "outputField": "operationCommitState", "localRole": "Stable delete commit-state discriminator." }, - { "outputField": "retrySafe", "localRole": "Always false; ambiguous outcomes require exact-target inspection before another delete attempt." }, - { "outputField": "recovery", "localRole": "Executable promoted_get exact-target inspection for ambiguous delete outcomes." } + { + "outputField": "success", + "localRole": "True only for exact HTTP 204." + }, + { + "outputField": "deleted", + "localRole": "True only for exact HTTP 204." + }, + { + "outputField": "deletionState", + "localRole": "confirmed for 204, committed_unverified for another accepted status, commit_unknown for an ambiguous outcome, or rejected for a definitive rejection." + }, + { + "outputField": "operationCommitState", + "localRole": "Stable delete commit-state discriminator." + }, + { + "outputField": "retrySafe", + "localRole": "Always false; ambiguous outcomes require exact-target inspection before another delete attempt." + }, + { + "outputField": "recovery", + "localRole": "Executable promoted_get exact-target inspection for ambiguous delete outcomes." + } ] }, "note": "Irreversible deletion requires two matching canonical IDs before network access. Success requires exact HTTP 204; unknown and unexpectedly accepted outcomes fail closed with promoted_get inspection guidance and are never replayed automatically." @@ -163,7 +251,7 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler always sends Apple 4.5.1 include=inAppPurchaseV2,subscription so the detail result can project the linked product without requiring caller-controlled expansion.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -180,14 +268,37 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "promotedPurchases_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "promotedPurchases_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "promoted_purchase", "operationId": "promotedPurchases_getInstance", "jsonPointer": "/data" }, - { "outputField": "promoted_purchase.inAppPurchaseId", "operationId": "promotedPurchases_getInstance", "jsonPointer": "/data/relationships/inAppPurchaseV2/data/id" }, - { "outputField": "promoted_purchase.subscriptionId", "operationId": "promotedPurchases_getInstance", "jsonPointer": "/data/relationships/subscription/data/id" }, - { "outputField": "promoted_purchase.linkedProduct", "operationId": "promotedPurchases_getInstance", "jsonPointer": "/included/*" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "promoted_purchase", + "operationId": "promotedPurchases_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "promoted_purchase.inAppPurchaseId", + "operationId": "promotedPurchases_getInstance", + "jsonPointer": "/data/relationships/inAppPurchaseV2/data/id" + }, + { + "outputField": "promoted_purchase.subscriptionId", + "operationId": "promotedPurchases_getInstance", + "jsonPointer": "/data/relationships/subscription/data/id" + }, + { + "outputField": "promoted_purchase.linkedProduct", + "operationId": "promotedPurchases_getInstance", + "jsonPointer": "/included/*" + } ] }, "note": "The response requires a configured-origin or root-relative canonical document links.self matching the exact resource and fixed include query, projects only primary product relationship IDs, rejects present-null response Booleans, and accepts an included linked product only when its type and ID exactly match that primary linkage." @@ -255,7 +366,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 can include inAppPurchaseV2 and subscription resources, but this collection contract returns base promoted-purchase attributes and relationship IDs; promoted_get provides expanded linked-product details.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -284,14 +395,37 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "apps_promotedPurchases_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_promotedPurchases_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "promoted_purchases", "operationId": "apps_promotedPurchases_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "promoted_purchases.inAppPurchaseId", "operationId": "apps_promotedPurchases_getToManyRelated", "jsonPointer": "/data/*/relationships/inAppPurchaseV2/data/id" }, - { "outputField": "promoted_purchases.subscriptionId", "operationId": "apps_promotedPurchases_getToManyRelated", "jsonPointer": "/data/*/relationships/subscription/data/id" }, - { "outputField": "next_url", "operationId": "apps_promotedPurchases_getToManyRelated", "jsonPointer": "/links/next" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "promoted_purchases", + "operationId": "apps_promotedPurchases_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "promoted_purchases.inAppPurchaseId", + "operationId": "apps_promotedPurchases_getToManyRelated", + "jsonPointer": "/data/*/relationships/inAppPurchaseV2/data/id" + }, + { + "outputField": "promoted_purchases.subscriptionId", + "operationId": "apps_promotedPurchases_getToManyRelated", + "jsonPointer": "/data/*/relationships/subscription/data/id" + }, + { + "outputField": "next_url", + "operationId": "apps_promotedPurchases_getToManyRelated", + "jsonPointer": "/links/next" + } ] }, "note": "The list requires a canonical app ID, enforces limit 1...200 with an effective default of 25, rejects whitespace-bearing continuation references, and binds required links.self plus optional links.next to the configured origin or a root-relative exact collection scope. Every next cursor must be non-empty and advance beyond the current cursor; data cannot exceed the effective limit. When meta is present, paging.limit must equal the effective limit, total cannot fall below the page count, and nextCursor must exactly agree with links.next. The response rejects present-null Booleans and projects only Apple primary product relationship IDs; any included resource must exactly match a primary relationship in the same document." @@ -369,19 +503,62 @@ } ], "fields": [ - { "outputField": "success", "localRole": "True for a fully verified no-op or after exact 204 plus exact fully paginated postflight order." }, - { "outputField": "operation", "localRole": "reorder discriminator" }, - { "outputField": "operationCommitted", "localRole": "False for a verified no-op and true only after exact 204 plus exact postflight order; accepted but unverified outcomes remain errors." }, - { "outputField": "operationCommitState", "localRole": "not_attempted for a verified no-op, committed after exact mutation verification, committed_unverified after an invalid accepted response or failed postflight, unknown after request ambiguity, or rejected after definitive rejection." }, - { "outputField": "mutationAttempted", "localRole": "False for a verified no-op and true after a PATCH receives an exact 204 and passes postflight verification." }, - { "outputField": "changed", "localRole": "False for a verified no-op; otherwise whether the verified postflight order differs from the fully paginated preflight order." }, - { "outputField": "retrySafe", "localRole": "True for a verified no-op and false for every attempted reorder; inspect current order before another PATCH after ambiguity." }, - { "outputField": "statusCode", "localRole": "Exact verified 204 status after mutation; omitted for a verified no-op." }, - { "outputField": "appId", "localRole": "Validated canonical request echo." }, - { "outputField": "order", "operationId": "apps_promotedPurchases_getToManyRelationship", "jsonPointer": "/data/*/id", "localRole": "Exact fully paginated postflight order." }, - { "outputField": "details.preflightOrder", "operationId": "apps_promotedPurchases_getToManyRelationship", "jsonPointer": "/data/*/id", "localRole": "Exact fully paginated order observed before an attempted reorder, retained only for recovery." }, - { "outputField": "details.requestedOrder", "localRole": "Validated ordered request echo retained for recovery." }, - { "outputField": "details.recovery", "localRole": "Executable promoted_list inspection guidance after an unknown or committed-unverified outcome." } + { + "outputField": "success", + "localRole": "True for a fully verified no-op or after exact 204 plus exact fully paginated postflight order." + }, + { + "outputField": "operation", + "localRole": "reorder discriminator" + }, + { + "outputField": "operationCommitted", + "localRole": "False for a verified no-op and true only after exact 204 plus exact postflight order; accepted but unverified outcomes remain errors." + }, + { + "outputField": "operationCommitState", + "localRole": "not_attempted for a verified no-op, committed after exact mutation verification, committed_unverified after an invalid accepted response or failed postflight, unknown after request ambiguity, or rejected after definitive rejection." + }, + { + "outputField": "mutationAttempted", + "localRole": "False for a verified no-op and true after a PATCH receives an exact 204 and passes postflight verification." + }, + { + "outputField": "changed", + "localRole": "False for a verified no-op; otherwise whether the verified postflight order differs from the fully paginated preflight order." + }, + { + "outputField": "retrySafe", + "localRole": "True for a verified no-op and false for every attempted reorder; inspect current order before another PATCH after ambiguity." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 204 status after mutation; omitted for a verified no-op." + }, + { + "outputField": "appId", + "localRole": "Validated canonical request echo." + }, + { + "outputField": "order", + "operationId": "apps_promotedPurchases_getToManyRelationship", + "jsonPointer": "/data/*/id", + "localRole": "Exact fully paginated postflight order." + }, + { + "outputField": "details.preflightOrder", + "operationId": "apps_promotedPurchases_getToManyRelationship", + "jsonPointer": "/data/*/id", + "localRole": "Exact fully paginated order observed before an attempted reorder, retained only for recovery." + }, + { + "outputField": "details.requestedOrder", + "localRole": "Validated ordered request echo retained for recovery." + }, + { + "outputField": "details.recovery", + "localRole": "Executable promoted_list inspection guidance after an unknown or committed-unverified outcome." + } ] }, "note": "The MCP field is a non-empty JSON string array of canonical unique IDs with no artificial item-count maximum; Apple's relationship request schema defines no maxItems. Every relationship page remains capped at 200 resources; links.self and links.next must stay in the exact configured-origin or root-relative scope, and each next cursor must be non-empty and advancing. Optional paging metadata must report limit 200, a total no smaller than the page count, and a nextCursor exactly consistent with links.next. The handler exhausts pagination with stable-total and terminal cumulative-count validation and requires exact set-and-count equality with current membership. An identical requested order returns a verified no-op without PATCH. A changed order sends ordered JSON:API linkage objects, accepts only HTTP 204, and returns mutation success only after a second exhaustive relationship read exactly matches the requested order." @@ -403,10 +580,16 @@ { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["promoted_purchase_id"], + "derivedFrom": [ + "promoted_purchase_id" + ], "localRole": "copyPathIdentifierIntoResourceBody" }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "promotedPurchases" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "promotedPurchases" + } ] } ], @@ -434,19 +617,56 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "promotedPurchases_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "promotedPurchases_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulUpdate" }, - { "outputField": "operation", "localRole": "update discriminator" }, - { "outputField": "operationCommitted", "localRole": "True only after exact 200 plus canonical promoted purchase identity." }, - { "outputField": "operationCommitState", "localRole": "committed for a validated 200, committed_unverified for an invalid accepted response, unknown for request ambiguity, or rejected for a definitive rejection." }, - { "outputField": "retrySafe", "localRole": "False for every attempted update; inspect the exact target before retrying an ambiguous outcome." }, - { "outputField": "statusCode", "localRole": "Exact verified 200 status." }, - { "outputField": "promoted_purchase", "operationId": "promotedPurchases_updateInstance", "jsonPointer": "/data" }, - { "outputField": "promoted_purchase.inAppPurchaseId", "operationId": "promotedPurchases_updateInstance", "jsonPointer": "/data/relationships/inAppPurchaseV2/data/id" }, - { "outputField": "promoted_purchase.subscriptionId", "operationId": "promotedPurchases_updateInstance", "jsonPointer": "/data/relationships/subscription/data/id" }, - { "outputField": "details.recovery", "localRole": "Executable promoted_get exact-target inspection after an unknown or committed-unverified update." } + { + "outputField": "success", + "localRole": "successfulUpdate" + }, + { + "outputField": "operation", + "localRole": "update discriminator" + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact 200 plus canonical promoted purchase identity." + }, + { + "outputField": "operationCommitState", + "localRole": "committed for a validated 200, committed_unverified for an invalid accepted response, unknown for request ambiguity, or rejected for a definitive rejection." + }, + { + "outputField": "retrySafe", + "localRole": "False for every attempted update; inspect the exact target before retrying an ambiguous outcome." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 200 status." + }, + { + "outputField": "promoted_purchase", + "operationId": "promotedPurchases_updateInstance", + "jsonPointer": "/data" + }, + { + "outputField": "promoted_purchase.inAppPurchaseId", + "operationId": "promotedPurchases_updateInstance", + "jsonPointer": "/data/relationships/inAppPurchaseV2/data/id" + }, + { + "outputField": "promoted_purchase.subscriptionId", + "operationId": "promotedPurchases_updateInstance", + "jsonPointer": "/data/relationships/subscription/data/id" + }, + { + "outputField": "details.recovery", + "localRole": "Executable promoted_get exact-target inspection after an unknown or committed-unverified update." + } ] }, "note": "Update request fields preserve Apple value, explicit-null, and omission semantics; unknown keys, non-canonical IDs, and empty or malformed PATCH requests fail pre-network. Success requires exact HTTP 200, exact canonical response identity, a configured-origin or root-relative canonical document links.self, non-null response Booleans when present, and exact included-resource lineage. Unknown and malformed accepted outcomes fail closed with promoted_get recovery guidance." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/provisioning.json b/Sources/asc-mcp/Resources/OperationManifest/tools/provisioning.json index 9ad259b..486c08b 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/provisioning.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/provisioning.json @@ -14,23 +14,56 @@ "path": "/v1/bundleIds", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "bundleIds" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "bundleIds" + } ] } ], "fields": [ - { "toolField": "name", "sourceKind": "requestBody", "operationId": "bundleIds_createInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "identifier", "sourceKind": "requestBody", "operationId": "bundleIds_createInstance", "jsonPointer": "/data/attributes/identifier" }, - { "toolField": "platform", "sourceKind": "requestBody", "operationId": "bundleIds_createInstance", "jsonPointer": "/data/attributes/platform" }, - { "toolField": "seed_id", "sourceKind": "requestBody", "operationId": "bundleIds_createInstance", "jsonPointer": "/data/attributes/seedId", "localRole": "preserves omission, explicit null, and string values" } + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "bundleIds_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "identifier", + "sourceKind": "requestBody", + "operationId": "bundleIds_createInstance", + "jsonPointer": "/data/attributes/identifier" + }, + { + "toolField": "platform", + "sourceKind": "requestBody", + "operationId": "bundleIds_createInstance", + "jsonPointer": "/data/attributes/platform" + }, + { + "toolField": "seed_id", + "sourceKind": "requestBody", + "operationId": "bundleIds_createInstance", + "jsonPointer": "/data/attributes/seedId", + "localRole": "preserves omission, explicit null, and string values" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "bundleIds_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "bundleIds_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "bundle_id", "operationId": "bundleIds_createInstance", "jsonPointer": "/data" } + { + "outputField": "bundle_id", + "operationId": "bundleIds_createInstance", + "jsonPointer": "/data" + } ] }, "note": "Exact Apple 4.4.1 create attributes, including optional seedId, with a selected bundle-ID response projection and no MCP output schema." @@ -48,27 +81,78 @@ "path": "/v1/profiles", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "profiles" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/bundleId/data/type", "fixedValue": "bundleIds" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/certificates/data/*/type", "fixedValue": "certificates" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/devices/data/*/type", "fixedValue": "devices" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "profiles" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/bundleId/data/type", + "fixedValue": "bundleIds" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/certificates/data/*/type", + "fixedValue": "certificates" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/devices/data/*/type", + "fixedValue": "devices" + } ] } ], "fields": [ - { "toolField": "name", "sourceKind": "requestBody", "operationId": "profiles_createInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "profile_type", "sourceKind": "requestBody", "operationId": "profiles_createInstance", "jsonPointer": "/data/attributes/profileType" }, - { "toolField": "bundle_id_resource_id", "sourceKind": "requestBody", "operationId": "profiles_createInstance", "jsonPointer": "/data/relationships/bundleId/data/id" }, - { "toolField": "certificate_ids", "sourceKind": "requestBody", "operationId": "profiles_createInstance", "jsonPointer": "/data/relationships/certificates/data/*/id", "localRole": "validated non-empty unique string IDs" }, - { "toolField": "device_ids", "sourceKind": "requestBody", "operationId": "profiles_createInstance", "jsonPointer": "/data/relationships/devices/data/*/id", "localRole": "optional relationship with validated non-empty unique string IDs" } + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "profiles_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "profile_type", + "sourceKind": "requestBody", + "operationId": "profiles_createInstance", + "jsonPointer": "/data/attributes/profileType" + }, + { + "toolField": "bundle_id_resource_id", + "sourceKind": "requestBody", + "operationId": "profiles_createInstance", + "jsonPointer": "/data/relationships/bundleId/data/id" + }, + { + "toolField": "certificate_ids", + "sourceKind": "requestBody", + "operationId": "profiles_createInstance", + "jsonPointer": "/data/relationships/certificates/data/*/id", + "localRole": "validated non-empty unique string IDs" + }, + { + "toolField": "device_ids", + "sourceKind": "requestBody", + "operationId": "profiles_createInstance", + "jsonPointer": "/data/relationships/devices/data/*/id", + "localRole": "optional relationship with validated non-empty unique string IDs" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "profiles_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "profiles_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "profile", "operationId": "profiles_createInstance", "jsonPointer": "/data" } + { + "outputField": "profile", + "operationId": "profiles_createInstance", + "jsonPointer": "/data" + } ] }, "note": "Apple 4.4.1 profile relationships are preserved after complete local ID-array validation, and the create response includes installable profileContent plus current profile timestamps." @@ -80,18 +164,35 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "bundleIds_deleteInstance", "method": "delete", "path": "/v1/bundleIds/{id}", "role": "primary" } + { + "operationId": "bundleIds_deleteInstance", + "method": "delete", + "path": "/v1/bundleIds/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "bundle_id_resource_id", "sourceKind": "parameter", "operationId": "bundleIds_deleteInstance", "location": "path", "appleName": "id" } + { + "toolField": "bundle_id_resource_id", + "sourceKind": "parameter", + "operationId": "bundleIds_deleteInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "bundleIds_deleteInstance", "statusCode": "204" } + { + "operationId": "bundleIds_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "message", "localRole": "confirmation synthesized after Apple's content-free 204 response" } + { + "outputField": "message", + "localRole": "confirmation synthesized after Apple's content-free 204 response" + } ] }, "note": "Apple returns 204 with no response document; the MCP result is a local deletion confirmation." @@ -103,18 +204,35 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "profiles_deleteInstance", "method": "delete", "path": "/v1/profiles/{id}", "role": "primary" } + { + "operationId": "profiles_deleteInstance", + "method": "delete", + "path": "/v1/profiles/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "profile_id", "sourceKind": "parameter", "operationId": "profiles_deleteInstance", "location": "path", "appleName": "id" } + { + "toolField": "profile_id", + "sourceKind": "parameter", + "operationId": "profiles_deleteInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "profiles_deleteInstance", "statusCode": "204" } + { + "operationId": "profiles_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "message", "localRole": "confirmation synthesized after Apple's content-free 204 response" } + { + "outputField": "message", + "localRole": "confirmation synthesized after Apple's content-free 204 response" + } ] }, "note": "Apple returns 204 with no response document; the MCP result is a local deletion confirmation." @@ -126,18 +244,35 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "bundleIdCapabilities_deleteInstance", "method": "delete", "path": "/v1/bundleIdCapabilities/{id}", "role": "primary" } + { + "operationId": "bundleIdCapabilities_deleteInstance", + "method": "delete", + "path": "/v1/bundleIdCapabilities/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "capability_id", "sourceKind": "parameter", "operationId": "bundleIdCapabilities_deleteInstance", "location": "path", "appleName": "id" } + { + "toolField": "capability_id", + "sourceKind": "parameter", + "operationId": "bundleIdCapabilities_deleteInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "bundleIdCapabilities_deleteInstance", "statusCode": "204" } + { + "operationId": "bundleIdCapabilities_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "message", "localRole": "confirmation synthesized after Apple's content-free 204 response" } + { + "outputField": "message", + "localRole": "confirmation synthesized after Apple's content-free 204 response" + } ] }, "note": "Apple returns 204 with no response document; the MCP result is a local capability-disable confirmation." @@ -155,23 +290,55 @@ "path": "/v1/bundleIdCapabilities", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "bundleIdCapabilities" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/bundleId/data/type", "fixedValue": "bundleIds" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "bundleIdCapabilities" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/bundleId/data/type", + "fixedValue": "bundleIds" + } ] } ], "fields": [ - { "toolField": "bundle_id_resource_id", "sourceKind": "requestBody", "operationId": "bundleIdCapabilities_createInstance", "jsonPointer": "/data/relationships/bundleId/data/id" }, - { "toolField": "capability_type", "sourceKind": "requestBody", "operationId": "bundleIdCapabilities_createInstance", "jsonPointer": "/data/attributes/capabilityType" }, - { "toolField": "settings", "sourceKind": "requestBody", "operationId": "bundleIdCapabilities_createInstance", "jsonPointer": "/data/attributes/settings", "localRole": "native array input preserving omission, explicit null, and array values; nested fields reject unknown keys and enforce Apple 4.4.1 enums and scalar types" } + { + "toolField": "bundle_id_resource_id", + "sourceKind": "requestBody", + "operationId": "bundleIdCapabilities_createInstance", + "jsonPointer": "/data/relationships/bundleId/data/id" + }, + { + "toolField": "capability_type", + "sourceKind": "requestBody", + "operationId": "bundleIdCapabilities_createInstance", + "jsonPointer": "/data/attributes/capabilityType" + }, + { + "toolField": "settings", + "sourceKind": "requestBody", + "operationId": "bundleIdCapabilities_createInstance", + "jsonPointer": "/data/attributes/settings", + "localRole": "native array input preserving omission, explicit null, and array values; nested fields reject unknown keys and enforce Apple 4.4.1 enums and scalar types" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "bundleIdCapabilities_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "bundleIdCapabilities_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "capability", "operationId": "bundleIdCapabilities_createInstance", "jsonPointer": "/data" } + { + "outputField": "capability", + "operationId": "bundleIdCapabilities_createInstance", + "jsonPointer": "/data" + } ] }, "note": "Exact Apple create operation. Settings use Apple's nullable array contract, while the response preserves empty arrays and enabledByDefault, visible, enabled, and supportsWildcard flags." @@ -194,35 +361,49 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "This detail tool returns a stable bundle-ID projection and does not project related profiles, capabilities, or app resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[bundleIdCapabilities]", "disposition": "intentionallyOmitted", "reason": "The related capability collection is not included by this tool, so its nested include limit has no effect on the documented output.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[profiles]", "disposition": "intentionallyOmitted", "reason": "The related profile collection is not included by this tool, so its nested include limit has no effect on the documented output.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "bundle_id_resource_id", "sourceKind": "parameter", "operationId": "bundleIds_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "bundle_id_resource_id", + "sourceKind": "parameter", + "operationId": "bundleIds_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "bundleIds_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "bundleIds_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "bundle_id", "operationId": "bundleIds_getInstance", "jsonPointer": "/data" } + { + "outputField": "bundle_id", + "operationId": "bundleIds_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Apple sparse fields and includes are not exposed; the handler returns selected bundle-ID attributes only." @@ -245,21 +426,35 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The certificate detail output is deliberately limited to certificate attributes and does not project the optional passTypeId relationship.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "certificate_id", "sourceKind": "parameter", "operationId": "certificates_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "certificate_id", + "sourceKind": "parameter", + "operationId": "certificates_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "certificates_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "certificates_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "certificate", "operationId": "certificates_getInstance", "jsonPointer": "/data" } + { + "outputField": "certificate", + "operationId": "certificates_getInstance", + "jsonPointer": "/data" + } ] }, "note": "The detail projection returns Apple's certificateContent and activated state. Sparse fields follow the global projection policy; passTypeId include is intentionally omitted." @@ -282,35 +477,49 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The profile detail output returns profile attributes and does not project bundleId, devices, or certificates relationship resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[certificates]", "disposition": "intentionallyOmitted", "reason": "Certificates are not included by this tool, so the nested relationship limit has no effect on its documented output.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[devices]", "disposition": "intentionallyOmitted", "reason": "Devices are not included by this tool, so the nested relationship limit has no effect on its documented output.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "profile_id", "sourceKind": "parameter", "operationId": "profiles_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "profile_id", + "sourceKind": "parameter", + "operationId": "profiles_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "profiles_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "profiles_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "profile", "operationId": "profiles_getInstance", "jsonPointer": "/data" } + { + "outputField": "profile", + "operationId": "profiles_getInstance", + "jsonPointer": "/data" + } ] }, "note": "The detail projection returns installable profileContent with createdDate and expirationDate. Sparse fields follow the global projection policy; relationships are intentionally omitted." @@ -333,44 +542,106 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The collection tool returns a stable bundle-ID projection and does not project related profiles, capabilities, or app resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[bundleIdCapabilities]", "disposition": "intentionallyOmitted", "reason": "The related capability collection is not included, so its nested limit has no effect on the documented output.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[profiles]", "disposition": "intentionallyOmitted", "reason": "The related profile collection is not included, so its nested limit has no effect on the documented output.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "limit", "sourceKind": "parameter", "operationId": "bundleIds_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "filter_platform", "sourceKind": "parameter", "operationId": "bundleIds_getCollection", "location": "query", "appleName": "filter[platform]" }, - { "toolField": "filter_identifier", "sourceKind": "parameter", "operationId": "bundleIds_getCollection", "location": "query", "appleName": "filter[identifier]" }, - { "toolField": "filter_name", "sourceKind": "parameter", "operationId": "bundleIds_getCollection", "location": "query", "appleName": "filter[name]" }, - { "toolField": "filter_seed_id", "sourceKind": "parameter", "operationId": "bundleIds_getCollection", "location": "query", "appleName": "filter[seedId]" }, - { "toolField": "filter_id", "sourceKind": "parameter", "operationId": "bundleIds_getCollection", "location": "query", "appleName": "filter[id]" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "bundleIds_getCollection", "location": "query", "appleName": "sort" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "bundleIds_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "filter_platform", + "sourceKind": "parameter", + "operationId": "bundleIds_getCollection", + "location": "query", + "appleName": "filter[platform]" + }, + { + "toolField": "filter_identifier", + "sourceKind": "parameter", + "operationId": "bundleIds_getCollection", + "location": "query", + "appleName": "filter[identifier]" + }, + { + "toolField": "filter_name", + "sourceKind": "parameter", + "operationId": "bundleIds_getCollection", + "location": "query", + "appleName": "filter[name]" + }, + { + "toolField": "filter_seed_id", + "sourceKind": "parameter", + "operationId": "bundleIds_getCollection", + "location": "query", + "appleName": "filter[seedId]" + }, + { + "toolField": "filter_id", + "sourceKind": "parameter", + "operationId": "bundleIds_getCollection", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "bundleIds_getCollection", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "bundleIds_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "bundleIds_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "bundle_ids", "operationId": "bundleIds_getCollection", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "bundleIds_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "bundleIds_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "bundle_ids", + "operationId": "bundleIds_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "bundleIds_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "bundleIds_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "All Apple 4.4.1 collection filters, sort, limit, and continuation are exposed. Sparse fields follow the global projection policy; includes and their nested limits are intentionally omitted." @@ -382,22 +653,59 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", "method": "get", "path": "/v1/bundleIds/{id}/bundleIdCapabilities", "role": "primary" } + { + "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", + "method": "get", + "path": "/v1/bundleIds/{id}/bundleIdCapabilities", + "role": "primary" + } ], "fields": [ - { "toolField": "bundle_id_resource_id", "sourceKind": "parameter", "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "bundle_id_resource_id", + "sourceKind": "parameter", + "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "capabilities", "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "capabilities", + "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "bundleIds_bundleIdCapabilities_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Apple 4.4.1 limit and continuation are honored. Capability settings preserve enabledByDefault, visible, enabled, and supportsWildcard; sparse fields follow the global projection policy." @@ -420,29 +728,85 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Certificate lists use a bounded attribute projection and do not project optional passTypeId relationship resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "limit", "sourceKind": "parameter", "operationId": "certificates_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "filter_type", "sourceKind": "parameter", "operationId": "certificates_getCollection", "location": "query", "appleName": "filter[certificateType]" }, - { "toolField": "filter_display_name", "sourceKind": "parameter", "operationId": "certificates_getCollection", "location": "query", "appleName": "filter[displayName]" }, - { "toolField": "filter_serial_number", "sourceKind": "parameter", "operationId": "certificates_getCollection", "location": "query", "appleName": "filter[serialNumber]" }, - { "toolField": "filter_id", "sourceKind": "parameter", "operationId": "certificates_getCollection", "location": "query", "appleName": "filter[id]" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "certificates_getCollection", "location": "query", "appleName": "sort" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "certificates_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "filter_type", + "sourceKind": "parameter", + "operationId": "certificates_getCollection", + "location": "query", + "appleName": "filter[certificateType]" + }, + { + "toolField": "filter_display_name", + "sourceKind": "parameter", + "operationId": "certificates_getCollection", + "location": "query", + "appleName": "filter[displayName]" + }, + { + "toolField": "filter_serial_number", + "sourceKind": "parameter", + "operationId": "certificates_getCollection", + "location": "query", + "appleName": "filter[serialNumber]" + }, + { + "toolField": "filter_id", + "sourceKind": "parameter", + "operationId": "certificates_getCollection", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "certificates_getCollection", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "certificates_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "certificates_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "certificates", "operationId": "certificates_getCollection", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "certificates_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "certificates_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "certificates", + "operationId": "certificates_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "certificates_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "certificates_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "All Apple 4.4.1 certificate filters, sort, limit, and continuation are exposed. Lists intentionally omit certificateContent and passTypeId resources; detail lookup returns certificateContent." @@ -454,27 +818,94 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "devices_getCollection", "method": "get", "path": "/v1/devices", "role": "primary" } + { + "operationId": "devices_getCollection", + "method": "get", + "path": "/v1/devices", + "role": "primary" + } ], "fields": [ - { "toolField": "limit", "sourceKind": "parameter", "operationId": "devices_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "filter_platform", "sourceKind": "parameter", "operationId": "devices_getCollection", "location": "query", "appleName": "filter[platform]" }, - { "toolField": "filter_status", "sourceKind": "parameter", "operationId": "devices_getCollection", "location": "query", "appleName": "filter[status]" }, - { "toolField": "filter_name", "sourceKind": "parameter", "operationId": "devices_getCollection", "location": "query", "appleName": "filter[name]" }, - { "toolField": "filter_udid", "sourceKind": "parameter", "operationId": "devices_getCollection", "location": "query", "appleName": "filter[udid]" }, - { "toolField": "filter_id", "sourceKind": "parameter", "operationId": "devices_getCollection", "location": "query", "appleName": "filter[id]" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "devices_getCollection", "location": "query", "appleName": "sort" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "devices_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "filter_platform", + "sourceKind": "parameter", + "operationId": "devices_getCollection", + "location": "query", + "appleName": "filter[platform]" + }, + { + "toolField": "filter_status", + "sourceKind": "parameter", + "operationId": "devices_getCollection", + "location": "query", + "appleName": "filter[status]" + }, + { + "toolField": "filter_name", + "sourceKind": "parameter", + "operationId": "devices_getCollection", + "location": "query", + "appleName": "filter[name]" + }, + { + "toolField": "filter_udid", + "sourceKind": "parameter", + "operationId": "devices_getCollection", + "location": "query", + "appleName": "filter[udid]" + }, + { + "toolField": "filter_id", + "sourceKind": "parameter", + "operationId": "devices_getCollection", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "devices_getCollection", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "devices_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "devices_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "devices", "operationId": "devices_getCollection", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "devices_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "devices_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "devices", + "operationId": "devices_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "devices_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "devices_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "All Apple 4.4.1 device filters, sort, limit, and continuation are exposed, including UNIVERSAL platform support. Sparse fields follow the global projection policy." @@ -497,43 +928,99 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Profile lists use a bounded attribute projection and do not project bundleId, devices, or certificates relationship resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[certificates]", "disposition": "intentionallyOmitted", "reason": "Certificates are not included by this tool, so the nested relationship limit has no effect on its documented output.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[devices]", "disposition": "intentionallyOmitted", "reason": "Devices are not included by this tool, so the nested relationship limit has no effect on its documented output.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "limit", "sourceKind": "parameter", "operationId": "profiles_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "filter_profile_type", "sourceKind": "parameter", "operationId": "profiles_getCollection", "location": "query", "appleName": "filter[profileType]" }, - { "toolField": "filter_profile_state", "sourceKind": "parameter", "operationId": "profiles_getCollection", "location": "query", "appleName": "filter[profileState]" }, - { "toolField": "filter_name", "sourceKind": "parameter", "operationId": "profiles_getCollection", "location": "query", "appleName": "filter[name]" }, - { "toolField": "filter_id", "sourceKind": "parameter", "operationId": "profiles_getCollection", "location": "query", "appleName": "filter[id]" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "profiles_getCollection", "location": "query", "appleName": "sort" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "profiles_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "filter_profile_type", + "sourceKind": "parameter", + "operationId": "profiles_getCollection", + "location": "query", + "appleName": "filter[profileType]" + }, + { + "toolField": "filter_profile_state", + "sourceKind": "parameter", + "operationId": "profiles_getCollection", + "location": "query", + "appleName": "filter[profileState]" + }, + { + "toolField": "filter_name", + "sourceKind": "parameter", + "operationId": "profiles_getCollection", + "location": "query", + "appleName": "filter[name]" + }, + { + "toolField": "filter_id", + "sourceKind": "parameter", + "operationId": "profiles_getCollection", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "profiles_getCollection", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "profiles_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "profiles_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "profiles", "operationId": "profiles_getCollection", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "profiles_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "profiles_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "profiles", + "operationId": "profiles_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "profiles_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "profiles_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "All Apple 4.4.1 profile filters, sort, limit, and continuation are exposed. Lists intentionally omit profileContent and relationship resources; detail/create responses return profileContent." @@ -551,22 +1038,49 @@ "path": "/v1/devices", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "devices" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "devices" + } ] } ], "fields": [ - { "toolField": "name", "sourceKind": "requestBody", "operationId": "devices_createInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "udid", "sourceKind": "requestBody", "operationId": "devices_createInstance", "jsonPointer": "/data/attributes/udid" }, - { "toolField": "platform", "sourceKind": "requestBody", "operationId": "devices_createInstance", "jsonPointer": "/data/attributes/platform" } + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "devices_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "udid", + "sourceKind": "requestBody", + "operationId": "devices_createInstance", + "jsonPointer": "/data/attributes/udid" + }, + { + "toolField": "platform", + "sourceKind": "requestBody", + "operationId": "devices_createInstance", + "jsonPointer": "/data/attributes/platform" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "devices_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "devices_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "device", "operationId": "devices_createInstance", "jsonPointer": "/data" } + { + "outputField": "device", + "operationId": "devices_createInstance", + "jsonPointer": "/data" + } ] }, "note": "Exact Apple 4.4.1 create operation, including IOS, MAC_OS, and UNIVERSAL platform support." @@ -578,18 +1092,35 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "certificates_deleteInstance", "method": "delete", "path": "/v1/certificates/{id}", "role": "primary" } + { + "operationId": "certificates_deleteInstance", + "method": "delete", + "path": "/v1/certificates/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "certificate_id", "sourceKind": "parameter", "operationId": "certificates_deleteInstance", "location": "path", "appleName": "id" } + { + "toolField": "certificate_id", + "sourceKind": "parameter", + "operationId": "certificates_deleteInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "certificates_deleteInstance", "statusCode": "204" } + { + "operationId": "certificates_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "message", "localRole": "confirmation synthesized after Apple's content-free 204 response" } + { + "outputField": "message", + "localRole": "confirmation synthesized after Apple's content-free 204 response" + } ] }, "note": "Apple models revocation as certificate deletion and returns 204 with no response document; the MCP result is a local confirmation." @@ -607,23 +1138,58 @@ "path": "/v1/devices/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "devices" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "devices" + } ] } ], "fields": [ - { "toolField": "device_id", "sourceKind": "parameter", "operationId": "devices_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "device_id", "sourceKind": "requestBody", "operationId": "devices_updateInstance", "jsonPointer": "/data/id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "devices_updateInstance", "jsonPointer": "/data/attributes/name", "localRole": "preserves omission, explicit null, and string values" }, - { "toolField": "status", "sourceKind": "requestBody", "operationId": "devices_updateInstance", "jsonPointer": "/data/attributes/status", "localRole": "preserves omission, explicit null, and validated ENABLED or DISABLED values" } + { + "toolField": "device_id", + "sourceKind": "parameter", + "operationId": "devices_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "device_id", + "sourceKind": "requestBody", + "operationId": "devices_updateInstance", + "jsonPointer": "/data/id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "devices_updateInstance", + "jsonPointer": "/data/attributes/name", + "localRole": "preserves omission, explicit null, and string values" + }, + { + "toolField": "status", + "sourceKind": "requestBody", + "operationId": "devices_updateInstance", + "jsonPointer": "/data/attributes/status", + "localRole": "preserves omission, explicit null, and validated ENABLED or DISABLED values" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "devices_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "devices_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "device", "operationId": "devices_updateInstance", "jsonPointer": "/data" } + { + "outputField": "device", + "operationId": "devices_updateInstance", + "jsonPointer": "/data" + } ] }, "note": "Exact Apple 4.4.1 path/body mapping. The handler requires at least one mutable attribute and rejects an empty PATCH before network access." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/review_attachments.json b/Sources/asc-mcp/Resources/OperationManifest/tools/review_attachments.json index 76f4852..096da73 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/review_attachments.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/review_attachments.json @@ -32,7 +32,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "appStoreReviewAttachments_deleteInstance", "statusCode": "204" } + { + "operationId": "appStoreReviewAttachments_deleteInstance", + "statusCode": "204" + } ], "fields": [ { @@ -76,13 +79,17 @@ "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["appStoreReviewDetail"] + "fixedValue": [ + "appStoreReviewDetail" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreReviewDetails]", - "fixedValue": ["appStoreVersion"] + "fixedValue": [ + "appStoreVersion" + ] } ] } @@ -153,13 +160,17 @@ "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["appStoreReviewDetail"] + "fixedValue": [ + "appStoreReviewDetail" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreReviewDetails]", - "fixedValue": ["appStoreVersion"] + "fixedValue": [ + "appStoreVersion" + ] } ] } @@ -301,7 +312,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Upload reconciliation needs attachment delivery state and relationship identity only; expanding reviewer contact or demo-account data is unrelated to delivery verification.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ], "inputs": [ @@ -381,10 +392,25 @@ "response": { "mode": "aggregate", "sources": [ - { "operationId": "appStoreReviewAttachments_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "appStoreReviewAttachments_deleteInstance", "statusCode": "204" }, - { "operationId": "appStoreReviewAttachments_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreReviewAttachments_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreReviewAttachments_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appStoreReviewAttachments_deleteInstance", + "statusCode": "204" + }, + { + "operationId": "appStoreReviewAttachments_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreReviewAttachments_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/review_submissions.json b/Sources/asc-mcp/Resources/OperationManifest/tools/review_submissions.json index 86b0e24..9ede0e5 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/review_submissions.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/review_submissions.json @@ -14,53 +14,224 @@ "path": "/v1/reviewSubmissionItems", "role": "primary", "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/relationships/appStoreVersionExperiment", "disposition": "intentionallyOmitted", "reason": "The legacy PPO relationship is intentionally rejected; this worker accepts only appStoreVersionExperimentV2.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/gameCenterAchievementVersion", "disposition": "intentionallyOmitted", "reason": "Game Center review items remain in the separately scoped Game Center product.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/gameCenterActivityVersion", "disposition": "intentionallyOmitted", "reason": "Game Center review items remain in the separately scoped Game Center product.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/gameCenterChallengeVersion", "disposition": "intentionallyOmitted", "reason": "Game Center review items remain in the separately scoped Game Center product.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/gameCenterLeaderboardSetVersion", "disposition": "intentionallyOmitted", "reason": "Game Center review items remain in the separately scoped Game Center product.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/gameCenterLeaderboardVersion", "disposition": "intentionallyOmitted", "reason": "Game Center review items remain in the separately scoped Game Center product.", "reviewAtSpec": "4.5.1" } + { + "location": "body", + "appleName": "/data/relationships/appStoreVersionExperiment", + "disposition": "intentionallyOmitted", + "reason": "The legacy PPO relationship is intentionally rejected; this worker accepts only appStoreVersionExperimentV2.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterAchievementVersion", + "disposition": "intentionallyOmitted", + "reason": "Game Center review items remain in the separately scoped Game Center product.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterActivityVersion", + "disposition": "intentionallyOmitted", + "reason": "Game Center review items remain in the separately scoped Game Center product.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterChallengeVersion", + "disposition": "intentionallyOmitted", + "reason": "Game Center review items remain in the separately scoped Game Center product.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterLeaderboardSetVersion", + "disposition": "intentionallyOmitted", + "reason": "Game Center review items remain in the separately scoped Game Center product.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterLeaderboardVersion", + "disposition": "intentionallyOmitted", + "reason": "Game Center review items remain in the separately scoped Game Center product.", + "reviewAtSpec": "4.6" + } ], "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "reviewSubmissionItems" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/reviewSubmission/data/type", "fixedValue": "reviewSubmissions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appStoreVersion/data/type", "fixedValue": "appStoreVersions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/type", "fixedValue": "appCustomProductPageVersions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appStoreVersionExperimentV2/data/type", "fixedValue": "appStoreVersionExperiments" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appEvent/data/type", "fixedValue": "appEvents" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appAssetLibraryImage/data/type", "fixedValue": "appAssetLibraryImages" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appAssetLibraryVideo/data/type", "fixedValue": "appAssetLibraryVideos" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/backgroundAssetVersion/data/type", "fixedValue": "backgroundAssetVersions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/inAppPurchaseVersion/data/type", "fixedValue": "inAppPurchaseVersions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/subscriptionVersion/data/type", "fixedValue": "subscriptionVersions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/subscriptionGroupVersion/data/type", "fixedValue": "subscriptionGroupVersions" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "reviewSubmissionItems" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/reviewSubmission/data/type", + "fixedValue": "reviewSubmissions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appStoreVersion/data/type", + "fixedValue": "appStoreVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/type", + "fixedValue": "appCustomProductPageVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appStoreVersionExperimentV2/data/type", + "fixedValue": "appStoreVersionExperiments" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appEvent/data/type", + "fixedValue": "appEvents" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appAssetLibraryImage/data/type", + "fixedValue": "appAssetLibraryImages" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appAssetLibraryVideo/data/type", + "fixedValue": "appAssetLibraryVideos" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/backgroundAssetVersion/data/type", + "fixedValue": "backgroundAssetVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/inAppPurchaseVersion/data/type", + "fixedValue": "inAppPurchaseVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/subscriptionVersion/data/type", + "fixedValue": "subscriptionVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/subscriptionGroupVersion/data/type", + "fixedValue": "subscriptionGroupVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/retentionMessageVersion/data/type", + "fixedValue": "retentionMessageVersions" + } ] } ], "fields": [ - { "toolField": "submission_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/reviewSubmission/data/id" }, - { "toolField": "app_store_version_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/appStoreVersion/data/id" }, - { "toolField": "app_custom_product_page_version_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/id" }, - { "toolField": "app_store_version_experiment_v2_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/appStoreVersionExperimentV2/data/id" }, - { "toolField": "app_event_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/appEvent/data/id" }, - { "toolField": "app_asset_library_image_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/appAssetLibraryImage/data/id" }, - { "toolField": "app_asset_library_video_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/appAssetLibraryVideo/data/id" }, - { "toolField": "preview_id", "sourceKind": "local", "localRole": "Required only for Asset Library image/video additions; validates and consumes the shared AssetsWorker one-time preview for the exact submission and asset before any write." }, - { "toolField": "background_asset_version_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/backgroundAssetVersion/data/id" }, - { "toolField": "in_app_purchase_version_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/inAppPurchaseVersion/data/id" }, - { "toolField": "subscription_version_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/subscriptionVersion/data/id" }, - { "toolField": "subscription_group_version_id", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data/relationships/subscriptionGroupVersion/data/id" } + { + "toolField": "submission_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/reviewSubmission/data/id" + }, + { + "toolField": "app_store_version_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/appStoreVersion/data/id" + }, + { + "toolField": "app_custom_product_page_version_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/appCustomProductPageVersion/data/id" + }, + { + "toolField": "app_store_version_experiment_v2_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/appStoreVersionExperimentV2/data/id" + }, + { + "toolField": "app_event_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/appEvent/data/id" + }, + { + "toolField": "app_asset_library_image_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/appAssetLibraryImage/data/id" + }, + { + "toolField": "app_asset_library_video_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/appAssetLibraryVideo/data/id" + }, + { + "toolField": "preview_id", + "sourceKind": "local", + "localRole": "Required only for Asset Library image/video additions; validates and consumes the shared AssetsWorker one-time preview for the exact submission and asset before any write." + }, + { + "toolField": "background_asset_version_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/backgroundAssetVersion/data/id" + }, + { + "toolField": "in_app_purchase_version_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/inAppPurchaseVersion/data/id" + }, + { + "toolField": "subscription_version_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/subscriptionVersion/data/id" + }, + { + "toolField": "subscription_group_version_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/subscriptionGroupVersion/data/id" + }, + { + "toolField": "retention_message_version_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data/relationships/retentionMessageVersion/data/id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "reviewSubmissionItems_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "reviewSubmissionItems_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulCreate" }, - { "outputField": "submission_id", "localRole": "Echo the owning review submission ID for recovery." }, - { "outputField": "item", "operationId": "reviewSubmissionItems_createInstance", "jsonPointer": "/data" }, - { "outputField": "recovery", "localRole": "Expose deterministic inspect, update, and remove tool references." } + { + "outputField": "success", + "localRole": "successfulCreate" + }, + { + "outputField": "submission_id", + "localRole": "Echo the owning review submission ID for recovery." + }, + { + "outputField": "item", + "operationId": "reviewSubmissionItems_createInstance", + "jsonPointer": "/data" + }, + { + "outputField": "recovery", + "localRole": "Expose deterministic inspect, update, and remove tool references." + } ] }, "note": "Existing calls accept exactly one of eight typed resource-version IDs unchanged. Asset Library image/video additions instead require the exact asset ID, submission ID, and one-time preview_id; execution is delegated to the shared AssetsWorker coordinator. Legacy PPO and Game Center relationships remain rejected before network access. Legacy creates retain exact resource identity and committed-unverified recovery validation." @@ -78,40 +249,128 @@ "path": "/v1/reviewSubmissions/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/attributes/platform", "disposition": "intentionallyOmitted", "reason": "Cancellation preserves the platform selected when the submission was created.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/attributes/submitted", "disposition": "intentionallyOmitted", "reason": "Cancellation never combines canceled=true with the distinct submit transition.", "reviewAtSpec": "4.5.1" } + { + "location": "body", + "appleName": "/data/attributes/platform", + "disposition": "intentionallyOmitted", + "reason": "Cancellation preserves the platform selected when the submission was created.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/submitted", + "disposition": "intentionallyOmitted", + "reason": "Cancellation never combines canceled=true with the distinct submit transition.", + "reviewAtSpec": "4.6" + } ], "inputs": [ - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["submission_id"], "localRole": "Copy the path ID into the JSON:API resource identifier." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "reviewSubmissions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/attributes/canceled", "fixedValue": true } + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "submission_id" + ], + "localRole": "Copy the path ID into the JSON:API resource identifier." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "reviewSubmissions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/canceled", + "fixedValue": true + } ] } ], "fields": [ - { "toolField": "submission_id", "sourceKind": "parameter", "operationId": "reviewSubmissions_updateInstance", "location": "path", "appleName": "id" } + { + "toolField": "submission_id", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_updateInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "reviewSubmissions_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "reviewSubmissions_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulUpdate" }, - { "outputField": "submission", "operationId": "reviewSubmissions_updateInstance", "jsonPointer": "/data" }, - { "outputField": "submission.item_ids", "operationId": "reviewSubmissions_updateInstance", "jsonPointer": "/data/relationships/items/data/*/id", "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." }, - { "outputField": "submission.item_included_count", "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded item identifiers, including zero for an explicit empty page." }, - { "outputField": "submission.item_total", "operationId": "reviewSubmissions_updateInstance", "jsonPointer": "/data/relationships/items/meta/paging/total" }, - { "outputField": "submission.item_limit", "operationId": "reviewSubmissions_updateInstance", "jsonPointer": "/data/relationships/items/meta/paging/limit" }, - { "outputField": "submission.item_next_cursor", "operationId": "reviewSubmissions_updateInstance", "jsonPointer": "/data/relationships/items/meta/paging/nextCursor" }, - { "outputField": "submission.items_truncated", "localRole": "True for a nested next cursor, or when the relationship total exceeds a known embedded item count; otherwise null when truncation cannot be inferred." }, - { "outputField": "submission.items_complete", "localRole": "Inverse of items_truncated when truncation is known; otherwise null." }, - { "outputField": "submission.items_completeness_known", "localRole": "True exactly when items_truncated can be determined." }, - { "outputField": "submission.items_inspection", "localRole": "Emit only when items_truncated is true, with full-pagination review_submissions_list_items guidance." }, - { "outputField": "submission.items_inspection.tool", "localRole": "Use review_submissions_list_items for nested item inspection." }, - { "outputField": "submission.items_inspection.arguments.submission_id", "localRole": "Inspect the exact parent submission." }, - { "outputField": "submission.items_inspection.arguments.limit", "localRole": "Use the maximum bounded page size of 200." }, - { "outputField": "submission.items_inspection.continue_with_next_url", "localRole": "Continue through every strict next_url page." } + { + "outputField": "success", + "localRole": "successfulUpdate" + }, + { + "outputField": "submission", + "operationId": "reviewSubmissions_updateInstance", + "jsonPointer": "/data" + }, + { + "outputField": "submission.item_ids", + "operationId": "reviewSubmissions_updateInstance", + "jsonPointer": "/data/relationships/items/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "submission.item_included_count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded item identifiers, including zero for an explicit empty page." + }, + { + "outputField": "submission.item_total", + "operationId": "reviewSubmissions_updateInstance", + "jsonPointer": "/data/relationships/items/meta/paging/total" + }, + { + "outputField": "submission.item_limit", + "operationId": "reviewSubmissions_updateInstance", + "jsonPointer": "/data/relationships/items/meta/paging/limit" + }, + { + "outputField": "submission.item_next_cursor", + "operationId": "reviewSubmissions_updateInstance", + "jsonPointer": "/data/relationships/items/meta/paging/nextCursor" + }, + { + "outputField": "submission.items_truncated", + "localRole": "True for a nested next cursor, or when the relationship total exceeds a known embedded item count; otherwise null when truncation cannot be inferred." + }, + { + "outputField": "submission.items_complete", + "localRole": "Inverse of items_truncated when truncation is known; otherwise null." + }, + { + "outputField": "submission.items_completeness_known", + "localRole": "True exactly when items_truncated can be determined." + }, + { + "outputField": "submission.items_inspection", + "localRole": "Emit only when items_truncated is true, with full-pagination review_submissions_list_items guidance." + }, + { + "outputField": "submission.items_inspection.tool", + "localRole": "Use review_submissions_list_items for nested item inspection." + }, + { + "outputField": "submission.items_inspection.arguments.submission_id", + "localRole": "Inspect the exact parent submission." + }, + { + "outputField": "submission.items_inspection.arguments.limit", + "localRole": "Use the maximum bounded page size of 200." + }, + { + "outputField": "submission.items_inspection.continue_with_next_url", + "localRole": "Continue through every strict next_url page." + } ] }, "note": "Dedicated cancellation transition with a normalized submission projection; failed writes retain the submission ID and deterministic inspection steps." @@ -129,36 +388,109 @@ "path": "/v1/reviewSubmissions", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "reviewSubmissions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "reviewSubmissions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "requestBody", "operationId": "reviewSubmissions_createInstance", "jsonPointer": "/data/relationships/app/data/id" }, - { "toolField": "platform", "sourceKind": "requestBody", "operationId": "reviewSubmissions_createInstance", "jsonPointer": "/data/attributes/platform" } + { + "toolField": "app_id", + "sourceKind": "requestBody", + "operationId": "reviewSubmissions_createInstance", + "jsonPointer": "/data/relationships/app/data/id" + }, + { + "toolField": "platform", + "sourceKind": "requestBody", + "operationId": "reviewSubmissions_createInstance", + "jsonPointer": "/data/attributes/platform" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "reviewSubmissions_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "reviewSubmissions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulCreate" }, - { "outputField": "submission", "operationId": "reviewSubmissions_createInstance", "jsonPointer": "/data" }, - { "outputField": "submission.item_ids", "operationId": "reviewSubmissions_createInstance", "jsonPointer": "/data/relationships/items/data/*/id", "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." }, - { "outputField": "submission.item_included_count", "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded item identifiers, including zero for an explicit empty page." }, - { "outputField": "submission.item_total", "operationId": "reviewSubmissions_createInstance", "jsonPointer": "/data/relationships/items/meta/paging/total" }, - { "outputField": "submission.item_limit", "operationId": "reviewSubmissions_createInstance", "jsonPointer": "/data/relationships/items/meta/paging/limit" }, - { "outputField": "submission.item_next_cursor", "operationId": "reviewSubmissions_createInstance", "jsonPointer": "/data/relationships/items/meta/paging/nextCursor" }, - { "outputField": "submission.items_truncated", "localRole": "True for a nested next cursor, or when the relationship total exceeds a known embedded item count; otherwise null when truncation cannot be inferred." }, - { "outputField": "submission.items_complete", "localRole": "Inverse of items_truncated when truncation is known; otherwise null." }, - { "outputField": "submission.items_completeness_known", "localRole": "True exactly when items_truncated can be determined." }, - { "outputField": "submission.items_inspection", "localRole": "Emit only when items_truncated is true, with full-pagination review_submissions_list_items guidance." }, - { "outputField": "submission.items_inspection.tool", "localRole": "Use review_submissions_list_items for nested item inspection." }, - { "outputField": "submission.items_inspection.arguments.submission_id", "localRole": "Inspect the exact parent submission." }, - { "outputField": "submission.items_inspection.arguments.limit", "localRole": "Use the maximum bounded page size of 200." }, - { "outputField": "submission.items_inspection.continue_with_next_url", "localRole": "Continue through every strict next_url page." } + { + "outputField": "success", + "localRole": "successfulCreate" + }, + { + "outputField": "submission", + "operationId": "reviewSubmissions_createInstance", + "jsonPointer": "/data" + }, + { + "outputField": "submission.item_ids", + "operationId": "reviewSubmissions_createInstance", + "jsonPointer": "/data/relationships/items/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "submission.item_included_count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded item identifiers, including zero for an explicit empty page." + }, + { + "outputField": "submission.item_total", + "operationId": "reviewSubmissions_createInstance", + "jsonPointer": "/data/relationships/items/meta/paging/total" + }, + { + "outputField": "submission.item_limit", + "operationId": "reviewSubmissions_createInstance", + "jsonPointer": "/data/relationships/items/meta/paging/limit" + }, + { + "outputField": "submission.item_next_cursor", + "operationId": "reviewSubmissions_createInstance", + "jsonPointer": "/data/relationships/items/meta/paging/nextCursor" + }, + { + "outputField": "submission.items_truncated", + "localRole": "True for a nested next cursor, or when the relationship total exceeds a known embedded item count; otherwise null when truncation cannot be inferred." + }, + { + "outputField": "submission.items_complete", + "localRole": "Inverse of items_truncated when truncation is known; otherwise null." + }, + { + "outputField": "submission.items_completeness_known", + "localRole": "True exactly when items_truncated can be determined." + }, + { + "outputField": "submission.items_inspection", + "localRole": "Emit only when items_truncated is true, with full-pagination review_submissions_list_items guidance." + }, + { + "outputField": "submission.items_inspection.tool", + "localRole": "Use review_submissions_list_items for nested item inspection." + }, + { + "outputField": "submission.items_inspection.arguments.submission_id", + "localRole": "Inspect the exact parent submission." + }, + { + "outputField": "submission.items_inspection.arguments.limit", + "localRole": "Use the maximum bounded page size of 200." + }, + { + "outputField": "submission.items_inspection.continue_with_next_url", + "localRole": "Continue through every strict next_url page." + } ] }, "note": "The platform input preserves omitted versus explicit null and all four Apple 4.4.1 Platform values; failed writes retain the app ID and deterministic list recovery." @@ -176,42 +508,195 @@ "path": "/v1/reviewSubmissions/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[reviewSubmissions]", "fixedValue": ["platform", "submittedDate", "state", "app", "items", "appStoreVersionForReview", "submittedByActor", "lastUpdatedByActor"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[apps]", "fixedValue": ["name", "bundleId", "sku", "primaryLocale"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[reviewSubmissionItems]", "fixedValue": ["state", "appStoreVersion", "appCustomProductPageVersion", "appStoreVersionExperiment", "appStoreVersionExperimentV2", "appEvent", "appAssetLibraryImage", "appAssetLibraryVideo", "backgroundAssetVersion", "gameCenterAchievementVersion", "gameCenterActivityVersion", "gameCenterChallengeVersion", "gameCenterLeaderboardSetVersion", "gameCenterLeaderboardVersion", "inAppPurchaseVersion", "subscriptionVersion", "subscriptionGroupVersion"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersions]", "fixedValue": ["platform", "versionString", "appStoreState", "appVersionState", "reviewType", "releaseType", "createdDate"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[actors]", "fixedValue": ["actorType", "userFirstName", "userLastName", "userEmail", "apiKeyId"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[reviewSubmissions]", + "fixedValue": [ + "platform", + "submittedDate", + "state", + "app", + "items", + "appStoreVersionForReview", + "submittedByActor", + "lastUpdatedByActor" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[apps]", + "fixedValue": [ + "name", + "bundleId", + "sku", + "primaryLocale" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[reviewSubmissionItems]", + "fixedValue": [ + "state", + "appStoreVersion", + "appCustomProductPageVersion", + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", + "backgroundAssetVersion", + "gameCenterAchievementVersion", + "gameCenterActivityVersion", + "gameCenterChallengeVersion", + "gameCenterLeaderboardSetVersion", + "gameCenterLeaderboardVersion", + "inAppPurchaseVersion", + "subscriptionVersion", + "subscriptionGroupVersion", + "retentionMessageVersion" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appStoreVersions]", + "fixedValue": [ + "platform", + "versionString", + "appStoreState", + "appVersionState", + "reviewType", + "releaseType", + "createdDate" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[actors]", + "fixedValue": [ + "actorType", + "userFirstName", + "userLastName", + "userEmail", + "apiKeyId" + ] + } ] } ], "fields": [ - { "toolField": "submission_id", "sourceKind": "parameter", "operationId": "reviewSubmissions_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "reviewSubmissions_getInstance", "location": "query", "appleName": "include" }, - { "toolField": "item_limit", "sourceKind": "parameter", "operationId": "reviewSubmissions_getInstance", "location": "query", "appleName": "limit[items]" } + { + "toolField": "submission_id", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_getInstance", + "location": "query", + "appleName": "include" + }, + { + "toolField": "item_limit", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_getInstance", + "location": "query", + "appleName": "limit[items]" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "reviewSubmissions_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "reviewSubmissions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "submission", "operationId": "reviewSubmissions_getInstance", "jsonPointer": "/data" }, - { "outputField": "submission.item_ids", "operationId": "reviewSubmissions_getInstance", "jsonPointer": "/data/relationships/items/data/*/id", "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." }, - { "outputField": "submission.item_included_count", "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded item identifiers, including zero for an explicit empty page." }, - { "outputField": "submission.item_total", "operationId": "reviewSubmissions_getInstance", "jsonPointer": "/data/relationships/items/meta/paging/total" }, - { "outputField": "submission.item_limit", "operationId": "reviewSubmissions_getInstance", "jsonPointer": "/data/relationships/items/meta/paging/limit" }, - { "outputField": "submission.item_next_cursor", "operationId": "reviewSubmissions_getInstance", "jsonPointer": "/data/relationships/items/meta/paging/nextCursor" }, - { "outputField": "submission.items_truncated", "localRole": "True for a nested next cursor, or when the relationship total exceeds a known embedded item count; otherwise null when truncation cannot be inferred." }, - { "outputField": "submission.items_complete", "localRole": "Inverse of items_truncated when truncation is known; otherwise null." }, - { "outputField": "submission.items_completeness_known", "localRole": "True exactly when items_truncated can be determined." }, - { "outputField": "submission.items_inspection", "localRole": "Emit only when items_truncated is true, with full-pagination review_submissions_list_items guidance." }, - { "outputField": "submission.items_inspection.tool", "localRole": "Use review_submissions_list_items for nested item inspection." }, - { "outputField": "submission.items_inspection.arguments.submission_id", "localRole": "Inspect the exact parent submission." }, - { "outputField": "submission.items_inspection.arguments.limit", "localRole": "Use the maximum bounded page size of 200." }, - { "outputField": "submission.items_inspection.continue_with_next_url", "localRole": "Continue through every strict next_url page." }, - { "outputField": "included", "operationId": "reviewSubmissions_getInstance", "jsonPointer": "/included" }, - { "outputField": "actors", "operationId": "reviewSubmissions_getInstance", "jsonPointer": "/included" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "submission", + "operationId": "reviewSubmissions_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "submission.item_ids", + "operationId": "reviewSubmissions_getInstance", + "jsonPointer": "/data/relationships/items/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "submission.item_included_count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded item identifiers, including zero for an explicit empty page." + }, + { + "outputField": "submission.item_total", + "operationId": "reviewSubmissions_getInstance", + "jsonPointer": "/data/relationships/items/meta/paging/total" + }, + { + "outputField": "submission.item_limit", + "operationId": "reviewSubmissions_getInstance", + "jsonPointer": "/data/relationships/items/meta/paging/limit" + }, + { + "outputField": "submission.item_next_cursor", + "operationId": "reviewSubmissions_getInstance", + "jsonPointer": "/data/relationships/items/meta/paging/nextCursor" + }, + { + "outputField": "submission.items_truncated", + "localRole": "True for a nested next cursor, or when the relationship total exceeds a known embedded item count; otherwise null when truncation cannot be inferred." + }, + { + "outputField": "submission.items_complete", + "localRole": "Inverse of items_truncated when truncation is known; otherwise null." + }, + { + "outputField": "submission.items_completeness_known", + "localRole": "True exactly when items_truncated can be determined." + }, + { + "outputField": "submission.items_inspection", + "localRole": "Emit only when items_truncated is true, with full-pagination review_submissions_list_items guidance." + }, + { + "outputField": "submission.items_inspection.tool", + "localRole": "Use review_submissions_list_items for nested item inspection." + }, + { + "outputField": "submission.items_inspection.arguments.submission_id", + "localRole": "Inspect the exact parent submission." + }, + { + "outputField": "submission.items_inspection.arguments.limit", + "localRole": "Use the maximum bounded page size of 200." + }, + { + "outputField": "submission.items_inspection.continue_with_next_url", + "localRole": "Continue through every strict next_url page." + }, + { + "outputField": "included", + "operationId": "reviewSubmissions_getInstance", + "jsonPointer": "/included" + }, + { + "outputField": "actors", + "operationId": "reviewSubmissions_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The fixed sparse projections and caller-selected includes provide all identifiers and actor context needed to resume a partial submission workflow." @@ -229,48 +714,234 @@ "path": "/v1/reviewSubmissions", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[reviewSubmissions]", "fixedValue": ["platform", "submittedDate", "state", "app", "items", "appStoreVersionForReview", "submittedByActor", "lastUpdatedByActor"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[apps]", "fixedValue": ["name", "bundleId", "sku", "primaryLocale"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[reviewSubmissionItems]", "fixedValue": ["state", "appStoreVersion", "appCustomProductPageVersion", "appStoreVersionExperiment", "appStoreVersionExperimentV2", "appEvent", "appAssetLibraryImage", "appAssetLibraryVideo", "backgroundAssetVersion", "gameCenterAchievementVersion", "gameCenterActivityVersion", "gameCenterChallengeVersion", "gameCenterLeaderboardSetVersion", "gameCenterLeaderboardVersion", "inAppPurchaseVersion", "subscriptionVersion", "subscriptionGroupVersion"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersions]", "fixedValue": ["platform", "versionString", "appStoreState", "appVersionState", "reviewType", "releaseType", "createdDate"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[actors]", "fixedValue": ["actorType", "userFirstName", "userLastName", "userEmail", "apiKeyId"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[reviewSubmissions]", + "fixedValue": [ + "platform", + "submittedDate", + "state", + "app", + "items", + "appStoreVersionForReview", + "submittedByActor", + "lastUpdatedByActor" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[apps]", + "fixedValue": [ + "name", + "bundleId", + "sku", + "primaryLocale" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[reviewSubmissionItems]", + "fixedValue": [ + "state", + "appStoreVersion", + "appCustomProductPageVersion", + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", + "backgroundAssetVersion", + "gameCenterAchievementVersion", + "gameCenterActivityVersion", + "gameCenterChallengeVersion", + "gameCenterLeaderboardSetVersion", + "gameCenterLeaderboardVersion", + "inAppPurchaseVersion", + "subscriptionVersion", + "subscriptionGroupVersion", + "retentionMessageVersion" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appStoreVersions]", + "fixedValue": [ + "platform", + "versionString", + "appStoreState", + "appVersionState", + "reviewType", + "releaseType", + "createdDate" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[actors]", + "fixedValue": [ + "actorType", + "userFirstName", + "userLastName", + "userEmail", + "apiKeyId" + ] + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "reviewSubmissions_getCollection", "location": "query", "appleName": "filter[app]" }, - { "toolField": "states", "sourceKind": "parameter", "operationId": "reviewSubmissions_getCollection", "location": "query", "appleName": "filter[state]" }, - { "toolField": "platforms", "sourceKind": "parameter", "operationId": "reviewSubmissions_getCollection", "location": "query", "appleName": "filter[platform]" }, - { "toolField": "include", "sourceKind": "derived", "operationId": "reviewSubmissions_getCollection", "location": "query", "appleName": "include", "derivedFrom": ["include"], "localRole": "Preserve the caller-selected relationships and always add app so every returned submission can be validated against the required app_id filter." }, - { "toolField": "item_limit", "sourceKind": "parameter", "operationId": "reviewSubmissions_getCollection", "location": "query", "appleName": "limit[items]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "reviewSubmissions_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Validate the exact origin, collection path, complete originating query, query allowlist, and non-empty cursor." } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_getCollection", + "location": "query", + "appleName": "filter[app]" + }, + { + "toolField": "states", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_getCollection", + "location": "query", + "appleName": "filter[state]" + }, + { + "toolField": "platforms", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_getCollection", + "location": "query", + "appleName": "filter[platform]" + }, + { + "toolField": "include", + "sourceKind": "derived", + "operationId": "reviewSubmissions_getCollection", + "location": "query", + "appleName": "include", + "derivedFrom": [ + "include" + ], + "localRole": "Preserve the caller-selected relationships and always add app so every returned submission can be validated against the required app_id filter." + }, + { + "toolField": "item_limit", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_getCollection", + "location": "query", + "appleName": "limit[items]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Validate the exact origin, collection path, complete originating query, query allowlist, and non-empty cursor." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "reviewSubmissions_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "reviewSubmissions_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "app_id", "localRole": "Echo the required ownership filter." }, - { "outputField": "submissions", "operationId": "reviewSubmissions_getCollection", "jsonPointer": "/data" }, - { "outputField": "submissions.*.item_ids", "operationId": "reviewSubmissions_getCollection", "jsonPointer": "/data/*/relationships/items/data/*/id", "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." }, - { "outputField": "submissions.*.item_included_count", "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded item identifiers, including zero for an explicit empty page." }, - { "outputField": "submissions.*.item_total", "operationId": "reviewSubmissions_getCollection", "jsonPointer": "/data/*/relationships/items/meta/paging/total" }, - { "outputField": "submissions.*.item_limit", "operationId": "reviewSubmissions_getCollection", "jsonPointer": "/data/*/relationships/items/meta/paging/limit" }, - { "outputField": "submissions.*.item_next_cursor", "operationId": "reviewSubmissions_getCollection", "jsonPointer": "/data/*/relationships/items/meta/paging/nextCursor" }, - { "outputField": "submissions.*.items_truncated", "localRole": "True for a nested next cursor, or when the relationship total exceeds a known embedded item count; otherwise null when truncation cannot be inferred." }, - { "outputField": "submissions.*.items_complete", "localRole": "Inverse of items_truncated when truncation is known; otherwise null." }, - { "outputField": "submissions.*.items_completeness_known", "localRole": "True exactly when items_truncated can be determined." }, - { "outputField": "submissions.*.items_inspection", "localRole": "Emit only when items_truncated is true, with full-pagination review_submissions_list_items guidance." }, - { "outputField": "submissions.*.items_inspection.tool", "localRole": "Use review_submissions_list_items for nested item inspection." }, - { "outputField": "submissions.*.items_inspection.arguments.submission_id", "localRole": "Inspect the exact parent submission." }, - { "outputField": "submissions.*.items_inspection.arguments.limit", "localRole": "Use the maximum bounded page size of 200." }, - { "outputField": "submissions.*.items_inspection.continue_with_next_url", "localRole": "Continue through every strict next_url page." }, - { "outputField": "included", "operationId": "reviewSubmissions_getCollection", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "reviewSubmissions_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "reviewSubmissions_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "app_id", + "localRole": "Echo the required ownership filter." + }, + { + "outputField": "submissions", + "operationId": "reviewSubmissions_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "submissions.*.item_ids", + "operationId": "reviewSubmissions_getCollection", + "jsonPointer": "/data/*/relationships/items/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "submissions.*.item_included_count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded item identifiers, including zero for an explicit empty page." + }, + { + "outputField": "submissions.*.item_total", + "operationId": "reviewSubmissions_getCollection", + "jsonPointer": "/data/*/relationships/items/meta/paging/total" + }, + { + "outputField": "submissions.*.item_limit", + "operationId": "reviewSubmissions_getCollection", + "jsonPointer": "/data/*/relationships/items/meta/paging/limit" + }, + { + "outputField": "submissions.*.item_next_cursor", + "operationId": "reviewSubmissions_getCollection", + "jsonPointer": "/data/*/relationships/items/meta/paging/nextCursor" + }, + { + "outputField": "submissions.*.items_truncated", + "localRole": "True for a nested next cursor, or when the relationship total exceeds a known embedded item count; otherwise null when truncation cannot be inferred." + }, + { + "outputField": "submissions.*.items_complete", + "localRole": "Inverse of items_truncated when truncation is known; otherwise null." + }, + { + "outputField": "submissions.*.items_completeness_known", + "localRole": "True exactly when items_truncated can be determined." + }, + { + "outputField": "submissions.*.items_inspection", + "localRole": "Emit only when items_truncated is true, with full-pagination review_submissions_list_items guidance." + }, + { + "outputField": "submissions.*.items_inspection.tool", + "localRole": "Use review_submissions_list_items for nested item inspection." + }, + { + "outputField": "submissions.*.items_inspection.arguments.submission_id", + "localRole": "Inspect the exact parent submission." + }, + { + "outputField": "submissions.*.items_inspection.arguments.limit", + "localRole": "Use the maximum bounded page size of 200." + }, + { + "outputField": "submissions.*.items_inspection.continue_with_next_url", + "localRole": "Continue through every strict next_url page." + }, + { + "outputField": "included", + "operationId": "reviewSubmissions_getCollection", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "reviewSubmissions_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "reviewSubmissions_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "App ownership is mandatory; scalar, strict CSV, and unique-array filters are validated before the request, and the effective include always contains app even when the caller selects a narrower relationship subset. Continuation URLs preserve every effective originating query value. Apple collection responses are bounded by the effective requested limit, require scoped self/next links, preserve cursor consistency, and reject invalid or duplicate resource identities." @@ -288,38 +959,244 @@ "path": "/v1/reviewSubmissions/{id}/items", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[reviewSubmissionItems]", "fixedValue": ["state", "appStoreVersion", "appCustomProductPageVersion", "appStoreVersionExperiment", "appStoreVersionExperimentV2", "appEvent", "appAssetLibraryImage", "appAssetLibraryVideo", "backgroundAssetVersion", "gameCenterAchievementVersion", "gameCenterActivityVersion", "gameCenterChallengeVersion", "gameCenterLeaderboardSetVersion", "gameCenterLeaderboardVersion", "inAppPurchaseVersion", "subscriptionVersion", "subscriptionGroupVersion"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersions]", "fixedValue": ["platform", "versionString", "appStoreState", "appVersionState", "reviewType", "releaseType", "createdDate"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[appCustomProductPageVersions]", "fixedValue": ["version", "state", "deepLink"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersionExperiments]", "fixedValue": ["name", "trafficProportion", "state", "reviewRequired", "startDate", "endDate", "platform"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[appEvents]", "fixedValue": ["referenceName", "badge", "eventState", "deepLink", "purchaseRequirement", "primaryLocale", "priority", "purpose"] }, - {"sourceKind": "fixed", "location": "query", "appleName": "fields[appAssetLibraryImages]", "fixedValue": ["category", "createdDate", "lastModifiedDate", "fileName", "fileSize", "referenceName", "specId", "state", "stateDetails"]}, - {"sourceKind": "fixed", "location": "query", "appleName": "fields[appAssetLibraryVideos]", "fixedValue": ["category", "createdDate", "lastModifiedDate", "fileName", "fileSize", "referenceName", "specId", "state", "stateDetails"]}, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[backgroundAssetVersions]", "fixedValue": ["createdDate", "platforms", "state", "stateDetails", "version", "locale"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[inAppPurchaseVersions]", "fixedValue": ["version", "state"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[subscriptionVersions]", "fixedValue": ["version", "state"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[subscriptionGroupVersions]", "fixedValue": ["version", "state"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "include", "fixedValue": ["appAssetLibraryImage", "appAssetLibraryVideo", "appStoreVersion", "appCustomProductPageVersion", "appStoreVersionExperimentV2", "appEvent", "backgroundAssetVersion", "inAppPurchaseVersion", "subscriptionVersion", "subscriptionGroupVersion"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[reviewSubmissionItems]", + "fixedValue": [ + "state", + "appStoreVersion", + "appCustomProductPageVersion", + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", + "backgroundAssetVersion", + "gameCenterAchievementVersion", + "gameCenterActivityVersion", + "gameCenterChallengeVersion", + "gameCenterLeaderboardSetVersion", + "gameCenterLeaderboardVersion", + "inAppPurchaseVersion", + "subscriptionVersion", + "subscriptionGroupVersion", + "retentionMessageVersion" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appStoreVersions]", + "fixedValue": [ + "platform", + "versionString", + "appStoreState", + "appVersionState", + "reviewType", + "releaseType", + "createdDate" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appCustomProductPageVersions]", + "fixedValue": [ + "version", + "state", + "deepLink" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appStoreVersionExperiments]", + "fixedValue": [ + "name", + "trafficProportion", + "state", + "reviewRequired", + "startDate", + "endDate", + "platform" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appEvents]", + "fixedValue": [ + "referenceName", + "badge", + "eventState", + "deepLink", + "purchaseRequirement", + "primaryLocale", + "priority", + "purpose" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appAssetLibraryImages]", + "fixedValue": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "referenceName", + "specId", + "state", + "stateDetails" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[appAssetLibraryVideos]", + "fixedValue": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "referenceName", + "specId", + "state", + "stateDetails" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[backgroundAssetVersions]", + "fixedValue": [ + "createdDate", + "platforms", + "state", + "stateDetails", + "version", + "locale" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[inAppPurchaseVersions]", + "fixedValue": [ + "version", + "state" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[subscriptionVersions]", + "fixedValue": [ + "version", + "state" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[subscriptionGroupVersions]", + "fixedValue": [ + "version", + "state" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "include", + "fixedValue": [ + "appAssetLibraryImage", + "appAssetLibraryVideo", + "appStoreVersion", + "appCustomProductPageVersion", + "appStoreVersionExperimentV2", + "appEvent", + "backgroundAssetVersion", + "inAppPurchaseVersion", + "subscriptionVersion", + "subscriptionGroupVersion", + "retentionMessageVersion" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[retentionMessageVersions]", + "fixedValue": [ + "state" + ] + } ] } ], "fields": [ - { "toolField": "submission_id", "sourceKind": "parameter", "operationId": "reviewSubmissions_items_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "reviewSubmissions_items_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Validate the exact parent path, complete fixed projection, effective limit, query allowlist, and non-empty cursor." } + { + "toolField": "submission_id", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_items_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_items_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Validate the exact parent path, complete fixed projection, effective limit, query allowlist, and non-empty cursor." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "reviewSubmissions_items_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "reviewSubmissions_items_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "submission_id", "localRole": "Echo the parent review submission ID." }, - { "outputField": "items", "operationId": "reviewSubmissions_items_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "reviewSubmissions_items_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "reviewSubmissions_items_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "reviewSubmissions_items_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "submission_id", + "localRole": "Echo the parent review submission ID." + }, + { + "outputField": "items", + "operationId": "reviewSubmissions_items_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "reviewSubmissions_items_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "reviewSubmissions_items_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "reviewSubmissions_items_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "All Apple relationship identity fields are requested so legacy PPO and scoped Game Center items remain identifiable, while compound includes stay limited to the eight relationships this worker can add; the linkage-only twin endpoint remains deferred. Apple collection responses are bounded by the effective requested limit, require scoped self/next links, preserve cursor consistency, and reject invalid or duplicate resource identities." @@ -339,19 +1216,45 @@ } ], "fields": [ - { "toolField": "submission_id", "sourceKind": "local", "localRole": "Retain the exact parent submission ID for scope-locked, fully paginated recovery inspection without sending it to the delete endpoint." }, - { "toolField": "item_id", "sourceKind": "parameter", "operationId": "reviewSubmissionItems_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_item_id", "sourceKind": "local", "localRole": "Require an exact canonical match with item_id before any Apple request is sent." } + { + "toolField": "submission_id", + "sourceKind": "local", + "localRole": "Retain the exact parent submission ID for scope-locked, fully paginated recovery inspection without sending it to the delete endpoint." + }, + { + "toolField": "item_id", + "sourceKind": "parameter", + "operationId": "reviewSubmissionItems_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_item_id", + "sourceKind": "local", + "localRole": "Require an exact canonical match with item_id before any Apple request is sent." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "reviewSubmissionItems_deleteInstance", "statusCode": "204" } + { + "operationId": "reviewSubmissionItems_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "successful204" }, - { "outputField": "item_id", "localRole": "Echo the deleted review item ID." }, - { "outputField": "message", "localRole": "Deterministic deletion confirmation." } + { + "outputField": "success", + "localRole": "successful204" + }, + { + "outputField": "item_id", + "localRole": "Echo the deleted review item ID." + }, + { + "outputField": "message", + "localRole": "Deterministic deletion confirmation." + } ] }, "note": "Apple returns 204 without a body; the confirmation is synthesized locally, while failed writes retain the item ID and parent-inspection guidance." @@ -369,40 +1272,128 @@ "path": "/v1/reviewSubmissions/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/attributes/platform", "disposition": "intentionallyOmitted", "reason": "Submission preserves the platform selected when the submission was created.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/attributes/canceled", "disposition": "intentionallyOmitted", "reason": "Submission never combines submitted=true with the distinct cancellation transition.", "reviewAtSpec": "4.5.1" } + { + "location": "body", + "appleName": "/data/attributes/platform", + "disposition": "intentionallyOmitted", + "reason": "Submission preserves the platform selected when the submission was created.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/canceled", + "disposition": "intentionallyOmitted", + "reason": "Submission never combines submitted=true with the distinct cancellation transition.", + "reviewAtSpec": "4.6" + } ], "inputs": [ - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["submission_id"], "localRole": "Copy the path ID into the JSON:API resource identifier." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "reviewSubmissions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/attributes/submitted", "fixedValue": true } + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "submission_id" + ], + "localRole": "Copy the path ID into the JSON:API resource identifier." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "reviewSubmissions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/submitted", + "fixedValue": true + } ] } ], "fields": [ - { "toolField": "submission_id", "sourceKind": "parameter", "operationId": "reviewSubmissions_updateInstance", "location": "path", "appleName": "id" } + { + "toolField": "submission_id", + "sourceKind": "parameter", + "operationId": "reviewSubmissions_updateInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "reviewSubmissions_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "reviewSubmissions_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulUpdate" }, - { "outputField": "submission", "operationId": "reviewSubmissions_updateInstance", "jsonPointer": "/data" }, - { "outputField": "submission.item_ids", "operationId": "reviewSubmissions_updateInstance", "jsonPointer": "/data/relationships/items/data/*/id", "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." }, - { "outputField": "submission.item_included_count", "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded item identifiers, including zero for an explicit empty page." }, - { "outputField": "submission.item_total", "operationId": "reviewSubmissions_updateInstance", "jsonPointer": "/data/relationships/items/meta/paging/total" }, - { "outputField": "submission.item_limit", "operationId": "reviewSubmissions_updateInstance", "jsonPointer": "/data/relationships/items/meta/paging/limit" }, - { "outputField": "submission.item_next_cursor", "operationId": "reviewSubmissions_updateInstance", "jsonPointer": "/data/relationships/items/meta/paging/nextCursor" }, - { "outputField": "submission.items_truncated", "localRole": "True for a nested next cursor, or when the relationship total exceeds a known embedded item count; otherwise null when truncation cannot be inferred." }, - { "outputField": "submission.items_complete", "localRole": "Inverse of items_truncated when truncation is known; otherwise null." }, - { "outputField": "submission.items_completeness_known", "localRole": "True exactly when items_truncated can be determined." }, - { "outputField": "submission.items_inspection", "localRole": "Emit only when items_truncated is true, with full-pagination review_submissions_list_items guidance." }, - { "outputField": "submission.items_inspection.tool", "localRole": "Use review_submissions_list_items for nested item inspection." }, - { "outputField": "submission.items_inspection.arguments.submission_id", "localRole": "Inspect the exact parent submission." }, - { "outputField": "submission.items_inspection.arguments.limit", "localRole": "Use the maximum bounded page size of 200." }, - { "outputField": "submission.items_inspection.continue_with_next_url", "localRole": "Continue through every strict next_url page." } + { + "outputField": "success", + "localRole": "successfulUpdate" + }, + { + "outputField": "submission", + "operationId": "reviewSubmissions_updateInstance", + "jsonPointer": "/data" + }, + { + "outputField": "submission.item_ids", + "operationId": "reviewSubmissions_updateInstance", + "jsonPointer": "/data/relationships/items/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "submission.item_included_count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded item identifiers, including zero for an explicit empty page." + }, + { + "outputField": "submission.item_total", + "operationId": "reviewSubmissions_updateInstance", + "jsonPointer": "/data/relationships/items/meta/paging/total" + }, + { + "outputField": "submission.item_limit", + "operationId": "reviewSubmissions_updateInstance", + "jsonPointer": "/data/relationships/items/meta/paging/limit" + }, + { + "outputField": "submission.item_next_cursor", + "operationId": "reviewSubmissions_updateInstance", + "jsonPointer": "/data/relationships/items/meta/paging/nextCursor" + }, + { + "outputField": "submission.items_truncated", + "localRole": "True for a nested next cursor, or when the relationship total exceeds a known embedded item count; otherwise null when truncation cannot be inferred." + }, + { + "outputField": "submission.items_complete", + "localRole": "Inverse of items_truncated when truncation is known; otherwise null." + }, + { + "outputField": "submission.items_completeness_known", + "localRole": "True exactly when items_truncated can be determined." + }, + { + "outputField": "submission.items_inspection", + "localRole": "Emit only when items_truncated is true, with full-pagination review_submissions_list_items guidance." + }, + { + "outputField": "submission.items_inspection.tool", + "localRole": "Use review_submissions_list_items for nested item inspection." + }, + { + "outputField": "submission.items_inspection.arguments.submission_id", + "localRole": "Inspect the exact parent submission." + }, + { + "outputField": "submission.items_inspection.arguments.limit", + "localRole": "Use the maximum bounded page size of 200." + }, + { + "outputField": "submission.items_inspection.continue_with_next_url", + "localRole": "Continue through every strict next_url page." + } ] }, "note": "Dedicated submission transition with a normalized submission projection; failed writes retain the submission ID and deterministic inspection steps." @@ -420,26 +1411,71 @@ "path": "/v1/reviewSubmissionItems/{id}", "role": "primary", "inputs": [ - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["item_id"], "localRole": "Copy the path ID into the JSON:API resource identifier." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "reviewSubmissionItems" } + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "item_id" + ], + "localRole": "Copy the path ID into the JSON:API resource identifier." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "reviewSubmissionItems" + } ] } ], "fields": [ - { "toolField": "submission_id", "sourceKind": "local", "localRole": "Retain the exact parent submission ID for postflight validation and fully paginated recovery inspection without sending it to the update endpoint." }, - { "toolField": "item_id", "sourceKind": "parameter", "operationId": "reviewSubmissionItems_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "resolved", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_updateInstance", "jsonPointer": "/data/attributes/resolved" }, - { "toolField": "removed", "sourceKind": "requestBody", "operationId": "reviewSubmissionItems_updateInstance", "jsonPointer": "/data/attributes/removed" } + { + "toolField": "submission_id", + "sourceKind": "local", + "localRole": "Retain the exact parent submission ID for postflight validation and fully paginated recovery inspection without sending it to the update endpoint." + }, + { + "toolField": "item_id", + "sourceKind": "parameter", + "operationId": "reviewSubmissionItems_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "resolved", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_updateInstance", + "jsonPointer": "/data/attributes/resolved" + }, + { + "toolField": "removed", + "sourceKind": "requestBody", + "operationId": "reviewSubmissionItems_updateInstance", + "jsonPointer": "/data/attributes/removed" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "reviewSubmissionItems_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "reviewSubmissionItems_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulUpdate" }, - { "outputField": "item", "operationId": "reviewSubmissionItems_updateInstance", "jsonPointer": "/data" }, - { "outputField": "recovery", "localRole": "Expose deterministic update and remove tool references." } + { + "outputField": "success", + "localRole": "successfulUpdate" + }, + { + "outputField": "item", + "operationId": "reviewSubmissionItems_updateInstance", + "jsonPointer": "/data" + }, + { + "outputField": "recovery", + "localRole": "Expose deterministic update and remove tool references." + } ] }, "note": "Both Apple attributes retain tri-state omitted, Boolean, and explicit null semantics; at least one must be present, and failed writes retain the item ID and parent-inspection guidance." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/reviews.json b/Sources/asc-mcp/Resources/OperationManifest/tools/reviews.json index e203092..792a610 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/reviews.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/reviews.json @@ -14,8 +14,16 @@ "path": "/v1/customerReviewResponses", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "customerReviewResponses" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/review/data/type", "fixedValue": "customerReviews" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "customerReviewResponses" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/review/data/type", + "fixedValue": "customerReviews" + } ] } ], @@ -102,7 +110,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "customerReviewResponses_deleteInstance", "statusCode": "204" } + { + "operationId": "customerReviewResponses_deleteInstance", + "statusCode": "204" + } ], "fields": [ { @@ -135,7 +146,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The detail tool returns the review attributes and response relationship presence; the full response has a dedicated reviews_get_response tool and territory is already projected from review attributes.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -226,7 +237,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The caller already supplies the review ID and can use reviews_get when the full related review resource is needed.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -242,7 +253,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The conditional lookup only confirms that the parent review exists and does not project related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -335,7 +346,7 @@ "appleName": "filter[reviewTerritory]", "disposition": "intentionallyOmitted", "reason": "The public territory and territories inputs use Apple's documented three-letter filter[territory] values; the related-resource-ID filter would duplicate that capability with opaque IDs.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -479,7 +490,7 @@ "appleName": "filter[reviewTerritory]", "disposition": "intentionallyOmitted", "reason": "The public territory and territories inputs use Apple's documented three-letter filter[territory] values; the related-resource-ID filter would duplicate that capability with opaque IDs.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -629,7 +640,9 @@ "sourceKind": "fixed", "location": "query", "appleName": "sort", - "fixedValue": ["-createdDate"] + "fixedValue": [ + "-createdDate" + ] } ], "optionalParameterClassifications": [ @@ -638,21 +651,21 @@ "appleName": "filter[rating]", "disposition": "intentionallyOmitted", "reason": "The aggregate must retrieve every rating to calculate a complete 1-through-5 distribution.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[reviewTerritory]", "disposition": "intentionallyOmitted", "reason": "The statistics tool uses public alpha-3 filter[territory] values instead of opaque related territory resource IDs.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Statistics require only review attributes and do not download related response or territory resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -788,7 +801,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The tool returns Apple's summarization resources unchanged and preserves the related territory ID already present on each resource; callers do not need duplicated included territory resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/sandbox.json b/Sources/asc-mcp/Resources/OperationManifest/tools/sandbox.json index 2ac2f52..8d5dead 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/sandbox.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/sandbox.json @@ -15,8 +15,16 @@ "role": "primary", "condition": null, "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "sandboxTestersClearPurchaseHistoryRequest" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/sandboxTesters/data/*/type", "fixedValue": "sandboxTesters" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "sandboxTestersClearPurchaseHistoryRequest" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/sandboxTesters/data/*/type", + "fixedValue": "sandboxTesters" + } ] } ], @@ -31,7 +39,11 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "sandboxTestersClearPurchaseHistoryRequestV2_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "sandboxTestersClearPurchaseHistoryRequestV2_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ { @@ -83,7 +95,11 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "sandboxTestersV2_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "sandboxTestersV2_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { @@ -130,10 +146,16 @@ { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["sandbox_tester_id"], + "derivedFrom": [ + "sandbox_tester_id" + ], "localRole": "copyPathIdentifierIntoResourceBody" }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "sandboxTesters" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "sandboxTesters" + } ] } ], @@ -167,7 +189,11 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "sandboxTestersV2_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "sandboxTestersV2_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ { diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/screenshots.json b/Sources/asc-mcp/Resources/OperationManifest/tools/screenshots.json index 76e9f91..0aeffc0 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/screenshots.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/screenshots.json @@ -14,10 +14,26 @@ "path": "/v1/appPreviewSets", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appPreviewSets" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/type", "fixedValue": "appStoreVersionLocalizations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/type", "fixedValue": "appCustomProductPageLocalizations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/type", "fixedValue": "appStoreVersionExperimentTreatmentLocalizations" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appPreviewSets" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/type", + "fixedValue": "appStoreVersionLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/type", + "fixedValue": "appCustomProductPageLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/type", + "fixedValue": "appStoreVersionExperimentTreatmentLocalizations" + } ] }, { @@ -27,13 +43,42 @@ "role": "supporting", "condition": "When the selected parent is an App Store version localization, fully paginate exact previewType preflight, postflight, and diagnostic collections.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected App Store parent and exact previewType, so cross-parent filters are unnecessary.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected App Store parent and exact previewType, so cross-parent filters are unnecessary.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and previewType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appPreviews]", "disposition": "intentionallyOmitted", "reason": "Create recovery does not include child previews.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected App Store parent and exact previewType, so cross-parent filters are unnecessary.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected App Store parent and exact previewType, so cross-parent filters are unnecessary.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and previewType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appPreviews]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery does not include child previews.", + "reviewAtSpec": "4.6" + } ] }, { @@ -43,13 +88,42 @@ "role": "supporting", "condition": "When the selected parent is a custom product page localization, fully paginate exact previewType preflight, postflight, and diagnostic collections.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected custom-page parent and exact previewType.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected custom-page parent and exact previewType.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and previewType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appPreviews]", "disposition": "intentionallyOmitted", "reason": "Create recovery does not include child previews.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected custom-page parent and exact previewType.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected custom-page parent and exact previewType.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and previewType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appPreviews]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery does not include child previews.", + "reviewAtSpec": "4.6" + } ] }, { @@ -59,61 +133,239 @@ "role": "supporting", "condition": "When the selected parent is a PPO treatment localization, fully paginate exact previewType preflight, postflight, and diagnostic collections.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected treatment parent and exact previewType.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected treatment parent and exact previewType.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and previewType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appPreviews]", "disposition": "intentionallyOmitted", "reason": "Create recovery does not include child previews.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected treatment parent and exact previewType.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected treatment parent and exact previewType.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and previewType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appPreviews]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery does not include child previews.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "requestBody", "operationId": "appPreviewSets_createInstance", "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id" }, - { "toolField": "app_store_version_localization_id", "sourceKind": "requestBody", "operationId": "appPreviewSets_createInstance", "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id" }, - { "toolField": "custom_product_page_localization_id", "sourceKind": "requestBody", "operationId": "appPreviewSets_createInstance", "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/id" }, - { "toolField": "treatment_localization_id", "sourceKind": "requestBody", "operationId": "appPreviewSets_createInstance", "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/id" }, - { "toolField": "preview_type", "sourceKind": "requestBody", "operationId": "appPreviewSets_createInstance", "jsonPointer": "/data/attributes/previewType" }, - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "app_store_version_localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "custom_product_page_localization_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "treatment_localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "preview_type", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[previewType]" }, - { "toolField": "preview_type", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[previewType]" }, - { "toolField": "preview_type", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[previewType]" } + { + "toolField": "localization_id", + "sourceKind": "requestBody", + "operationId": "appPreviewSets_createInstance", + "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id" + }, + { + "toolField": "app_store_version_localization_id", + "sourceKind": "requestBody", + "operationId": "appPreviewSets_createInstance", + "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id" + }, + { + "toolField": "custom_product_page_localization_id", + "sourceKind": "requestBody", + "operationId": "appPreviewSets_createInstance", + "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/id" + }, + { + "toolField": "treatment_localization_id", + "sourceKind": "requestBody", + "operationId": "appPreviewSets_createInstance", + "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/id" + }, + { + "toolField": "preview_type", + "sourceKind": "requestBody", + "operationId": "appPreviewSets_createInstance", + "jsonPointer": "/data/attributes/previewType" + }, + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_store_version_localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "custom_product_page_localization_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "treatment_localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "preview_type", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[previewType]" + }, + { + "toolField": "preview_type", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[previewType]" + }, + { + "toolField": "preview_type", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[previewType]" + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "appPreviewSets_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appPreviewSets_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulCreate" }, - { "outputField": "operation", "localRole": "Create discriminator." }, - { "outputField": "operationCommitted", "localRole": "True only after exact POST 201 and unique fully paginated parent-scoped postflight confirmation." }, - { "outputField": "operationCommitState", "localRole": "Committed only for an exact attributed create; ambiguous or malformed accepted outcomes remain committed_unverified or unknown." }, - { "outputField": "createdByInvocation", "localRole": "True only when the exact POST response ID is the unique matching resource in the fresh parent-scoped postflight." }, - { "outputField": "candidateAttributionConfirmed", "localRole": "True only for unique exact-ID postflight attribution." }, - { "outputField": "retrySafe", "localRole": "False after any attempted create; inspect the full parent collection before retrying an ambiguous outcome." }, - { "outputField": "statusCode", "localRole": "Exact verified 201 status." }, - { "outputField": "parent", "localRole": "Validated localization-parent request scope." }, - { "outputField": "preview_set", "localRole": "Fresh resource projection returned by the fully paginated parent-scoped GET postflight, not the POST body." }, - { "outputField": "mutationAttempted", "localRole": "Whether the create POST was attempted." }, - { "outputField": "write_outcome", "localRole": "Rejected, unknown, or committed_unverified failure disposition." }, - { "outputField": "error", "localRole": "Redacted validation, request, response, or postflight failure." }, - { "outputField": "mediaType", "localRole": "Validated preview_type request echo on failure." }, - { "outputField": "existingCandidates", "localRole": "Matching resources proven by the complete preflight when creation is not attempted." }, - { "outputField": "setId", "localRole": "Known canonical created-resource candidate ID when available." }, - { "outputField": "responseSetId", "localRole": "Canonical ID decoded from an accepted POST response when available." }, - { "outputField": "observedCandidates", "localRole": "Fresh diagnostic collection candidates without attribution to this invocation." }, - { "outputField": "inspectionError", "localRole": "Redacted diagnostic collection failure." }, - { "outputField": "outcomeUnknown", "localRole": "True when request commitment cannot be determined." }, - { "outputField": "inspectionRequired", "localRole": "True when full parent-scoped inspection is required before retry." }, - { "outputField": "inspection", "localRole": "Executable complete parent-scoped inspection guidance." } + { + "outputField": "success", + "localRole": "successfulCreate" + }, + { + "outputField": "operation", + "localRole": "Create discriminator." + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact POST 201 and unique fully paginated parent-scoped postflight confirmation." + }, + { + "outputField": "operationCommitState", + "localRole": "Committed only for an exact attributed create; ambiguous or malformed accepted outcomes remain committed_unverified or unknown." + }, + { + "outputField": "createdByInvocation", + "localRole": "True only when the exact POST response ID is the unique matching resource in the fresh parent-scoped postflight." + }, + { + "outputField": "candidateAttributionConfirmed", + "localRole": "True only for unique exact-ID postflight attribution." + }, + { + "outputField": "retrySafe", + "localRole": "False after any attempted create; inspect the full parent collection before retrying an ambiguous outcome." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 201 status." + }, + { + "outputField": "parent", + "localRole": "Validated localization-parent request scope." + }, + { + "outputField": "preview_set", + "localRole": "Fresh resource projection returned by the fully paginated parent-scoped GET postflight, not the POST body." + }, + { + "outputField": "mutationAttempted", + "localRole": "Whether the create POST was attempted." + }, + { + "outputField": "write_outcome", + "localRole": "Rejected, unknown, or committed_unverified failure disposition." + }, + { + "outputField": "error", + "localRole": "Redacted validation, request, response, or postflight failure." + }, + { + "outputField": "mediaType", + "localRole": "Validated preview_type request echo on failure." + }, + { + "outputField": "existingCandidates", + "localRole": "Matching resources proven by the complete preflight when creation is not attempted." + }, + { + "outputField": "setId", + "localRole": "Known canonical created-resource candidate ID when available." + }, + { + "outputField": "responseSetId", + "localRole": "Canonical ID decoded from an accepted POST response when available." + }, + { + "outputField": "observedCandidates", + "localRole": "Fresh diagnostic collection candidates without attribution to this invocation." + }, + { + "outputField": "inspectionError", + "localRole": "Redacted diagnostic collection failure." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when request commitment cannot be determined." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when full parent-scoped inspection is required before retry." + }, + { + "outputField": "inspection", + "localRole": "Executable complete parent-scoped inspection guidance." + } ] }, "note": "The handler requires exactly one canonical localization relationship, proves matching-set absence through a fully paginated parent-scoped preflight, requires exact POST 201 identity and previewType, and confirms the response ID through a fresh fully paginated parent-scoped postflight. Ambiguous or malformed outcomes are never attributed from observed state and return retry-safe inspection guidance." @@ -131,10 +383,26 @@ "path": "/v1/appScreenshotSets", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appScreenshotSets" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/type", "fixedValue": "appStoreVersionLocalizations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/type", "fixedValue": "appCustomProductPageLocalizations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/type", "fixedValue": "appStoreVersionExperimentTreatmentLocalizations" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appScreenshotSets" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/type", + "fixedValue": "appStoreVersionLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/type", + "fixedValue": "appCustomProductPageLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/type", + "fixedValue": "appStoreVersionExperimentTreatmentLocalizations" + } ] }, { @@ -144,13 +412,42 @@ "role": "supporting", "condition": "When the selected parent is an App Store version localization, fully paginate exact screenshotDisplayType preflight, postflight, and diagnostic collections.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected App Store parent and exact screenshotDisplayType.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected App Store parent and exact screenshotDisplayType.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and screenshotDisplayType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshots]", "disposition": "intentionallyOmitted", "reason": "Create recovery does not include child screenshots.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected App Store parent and exact screenshotDisplayType.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected App Store parent and exact screenshotDisplayType.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and screenshotDisplayType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshots]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery does not include child screenshots.", + "reviewAtSpec": "4.6" + } ] }, { @@ -160,13 +457,42 @@ "role": "supporting", "condition": "When the selected parent is a custom product page localization, fully paginate exact screenshotDisplayType preflight, postflight, and diagnostic collections.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected custom-page parent and exact screenshotDisplayType.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected custom-page parent and exact screenshotDisplayType.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and screenshotDisplayType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshots]", "disposition": "intentionallyOmitted", "reason": "Create recovery does not include child screenshots.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected custom-page parent and exact screenshotDisplayType.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected custom-page parent and exact screenshotDisplayType.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and screenshotDisplayType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshots]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery does not include child screenshots.", + "reviewAtSpec": "4.6" + } ] }, { @@ -176,61 +502,239 @@ "role": "supporting", "condition": "When the selected parent is a PPO treatment localization, fully paginate exact screenshotDisplayType preflight, postflight, and diagnostic collections.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ - { "location": "query", "appleName": "filter[appStoreVersionLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected treatment parent and exact screenshotDisplayType.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "filter[appCustomProductPageLocalization]", "disposition": "intentionallyOmitted", "reason": "Create recovery scopes by the selected treatment parent and exact screenshotDisplayType.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and screenshotDisplayType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshots]", "disposition": "intentionallyOmitted", "reason": "Create recovery does not include child screenshots.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "filter[appStoreVersionLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected treatment parent and exact screenshotDisplayType.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery scopes by the selected treatment parent and exact screenshotDisplayType.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The exact parent-scoped relationship path proves localization scope; the base projection validates identity and screenshotDisplayType plus optional resource self and parent linkage when present, so included resources are unnecessary and not decoded.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshots]", + "disposition": "intentionallyOmitted", + "reason": "Create recovery does not include child screenshots.", + "reviewAtSpec": "4.6" + } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "requestBody", "operationId": "appScreenshotSets_createInstance", "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id" }, - { "toolField": "app_store_version_localization_id", "sourceKind": "requestBody", "operationId": "appScreenshotSets_createInstance", "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id" }, - { "toolField": "custom_product_page_localization_id", "sourceKind": "requestBody", "operationId": "appScreenshotSets_createInstance", "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/id" }, - { "toolField": "treatment_localization_id", "sourceKind": "requestBody", "operationId": "appScreenshotSets_createInstance", "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/id" }, - { "toolField": "display_type", "sourceKind": "requestBody", "operationId": "appScreenshotSets_createInstance", "jsonPointer": "/data/attributes/screenshotDisplayType" }, - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "app_store_version_localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "custom_product_page_localization_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "treatment_localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "display_type", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[screenshotDisplayType]" }, - { "toolField": "display_type", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[screenshotDisplayType]" }, - { "toolField": "display_type", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[screenshotDisplayType]" } + { + "toolField": "localization_id", + "sourceKind": "requestBody", + "operationId": "appScreenshotSets_createInstance", + "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id" + }, + { + "toolField": "app_store_version_localization_id", + "sourceKind": "requestBody", + "operationId": "appScreenshotSets_createInstance", + "jsonPointer": "/data/relationships/appStoreVersionLocalization/data/id" + }, + { + "toolField": "custom_product_page_localization_id", + "sourceKind": "requestBody", + "operationId": "appScreenshotSets_createInstance", + "jsonPointer": "/data/relationships/appCustomProductPageLocalization/data/id" + }, + { + "toolField": "treatment_localization_id", + "sourceKind": "requestBody", + "operationId": "appScreenshotSets_createInstance", + "jsonPointer": "/data/relationships/appStoreVersionExperimentTreatmentLocalization/data/id" + }, + { + "toolField": "display_type", + "sourceKind": "requestBody", + "operationId": "appScreenshotSets_createInstance", + "jsonPointer": "/data/attributes/screenshotDisplayType" + }, + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_store_version_localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "custom_product_page_localization_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "treatment_localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "display_type", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[screenshotDisplayType]" + }, + { + "toolField": "display_type", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[screenshotDisplayType]" + }, + { + "toolField": "display_type", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[screenshotDisplayType]" + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "appScreenshotSets_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appScreenshotSets_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulCreate" }, - { "outputField": "operation", "localRole": "Create discriminator." }, - { "outputField": "operationCommitted", "localRole": "True only after exact POST 201 and unique fully paginated parent-scoped postflight confirmation." }, - { "outputField": "operationCommitState", "localRole": "Committed only for an exact attributed create; ambiguous or malformed accepted outcomes remain committed_unverified or unknown." }, - { "outputField": "createdByInvocation", "localRole": "True only when the exact POST response ID is the unique matching resource in the fresh parent-scoped postflight." }, - { "outputField": "candidateAttributionConfirmed", "localRole": "True only for unique exact-ID postflight attribution." }, - { "outputField": "retrySafe", "localRole": "False after any attempted create; inspect the full parent collection before retrying an ambiguous outcome." }, - { "outputField": "statusCode", "localRole": "Exact verified 201 status." }, - { "outputField": "parent", "localRole": "Validated localization-parent request scope." }, - { "outputField": "screenshot_set", "localRole": "Fresh resource projection returned by the fully paginated parent-scoped GET postflight, not the POST body." }, - { "outputField": "mutationAttempted", "localRole": "Whether the create POST was attempted." }, - { "outputField": "write_outcome", "localRole": "Rejected, unknown, or committed_unverified failure disposition." }, - { "outputField": "error", "localRole": "Redacted validation, request, response, or postflight failure." }, - { "outputField": "mediaType", "localRole": "Validated display_type request echo on failure." }, - { "outputField": "existingCandidates", "localRole": "Matching resources proven by the complete preflight when creation is not attempted." }, - { "outputField": "setId", "localRole": "Known canonical created-resource candidate ID when available." }, - { "outputField": "responseSetId", "localRole": "Canonical ID decoded from an accepted POST response when available." }, - { "outputField": "observedCandidates", "localRole": "Fresh diagnostic collection candidates without attribution to this invocation." }, - { "outputField": "inspectionError", "localRole": "Redacted diagnostic collection failure." }, - { "outputField": "outcomeUnknown", "localRole": "True when request commitment cannot be determined." }, - { "outputField": "inspectionRequired", "localRole": "True when full parent-scoped inspection is required before retry." }, - { "outputField": "inspection", "localRole": "Executable complete parent-scoped inspection guidance." } + { + "outputField": "success", + "localRole": "successfulCreate" + }, + { + "outputField": "operation", + "localRole": "Create discriminator." + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact POST 201 and unique fully paginated parent-scoped postflight confirmation." + }, + { + "outputField": "operationCommitState", + "localRole": "Committed only for an exact attributed create; ambiguous or malformed accepted outcomes remain committed_unverified or unknown." + }, + { + "outputField": "createdByInvocation", + "localRole": "True only when the exact POST response ID is the unique matching resource in the fresh parent-scoped postflight." + }, + { + "outputField": "candidateAttributionConfirmed", + "localRole": "True only for unique exact-ID postflight attribution." + }, + { + "outputField": "retrySafe", + "localRole": "False after any attempted create; inspect the full parent collection before retrying an ambiguous outcome." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 201 status." + }, + { + "outputField": "parent", + "localRole": "Validated localization-parent request scope." + }, + { + "outputField": "screenshot_set", + "localRole": "Fresh resource projection returned by the fully paginated parent-scoped GET postflight, not the POST body." + }, + { + "outputField": "mutationAttempted", + "localRole": "Whether the create POST was attempted." + }, + { + "outputField": "write_outcome", + "localRole": "Rejected, unknown, or committed_unverified failure disposition." + }, + { + "outputField": "error", + "localRole": "Redacted validation, request, response, or postflight failure." + }, + { + "outputField": "mediaType", + "localRole": "Validated display_type request echo on failure." + }, + { + "outputField": "existingCandidates", + "localRole": "Matching resources proven by the complete preflight when creation is not attempted." + }, + { + "outputField": "setId", + "localRole": "Known canonical created-resource candidate ID when available." + }, + { + "outputField": "responseSetId", + "localRole": "Canonical ID decoded from an accepted POST response when available." + }, + { + "outputField": "observedCandidates", + "localRole": "Fresh diagnostic collection candidates without attribution to this invocation." + }, + { + "outputField": "inspectionError", + "localRole": "Redacted diagnostic collection failure." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when request commitment cannot be determined." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when full parent-scoped inspection is required before retry." + }, + { + "outputField": "inspection", + "localRole": "Executable complete parent-scoped inspection guidance." + } ] }, "note": "The handler requires exactly one canonical localization relationship, proves matching-set absence through a fully paginated parent-scoped preflight, requires exact POST 201 identity and screenshotDisplayType, and confirms the response ID through a fresh fully paginated parent-scoped postflight. Ambiguous or malformed outcomes are never attributed from observed state and return retry-safe inspection guidance." @@ -242,30 +746,92 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "appScreenshots_deleteInstance", "method": "delete", "path": "/v1/appScreenshots/{id}", "role": "primary" } + { + "operationId": "appScreenshots_deleteInstance", + "method": "delete", + "path": "/v1/appScreenshots/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "screenshot_id", "sourceKind": "parameter", "operationId": "appScreenshots_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_screenshot_id", "sourceKind": "local", "localRole": "Must exactly match screenshot_id before DELETE is attempted." } + { + "toolField": "screenshot_id", + "sourceKind": "parameter", + "operationId": "appScreenshots_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_screenshot_id", + "sourceKind": "local", + "localRole": "Must exactly match screenshot_id before DELETE is attempted." + } ], "response": { "mode": "local", - "sources": [{ "operationId": "appScreenshots_deleteInstance", "statusCode": "204" }], + "sources": [ + { + "operationId": "appScreenshots_deleteInstance", + "statusCode": "204" + } + ], "fields": [ - { "outputField": "success", "localRole": "True only after exact confirmation and HTTP 204." }, - { "outputField": "operationCommitState", "localRole": "Committed only for exact 204; rejected, unknown, and committed_unverified remain error outcomes." }, - { "outputField": "operationCommitted", "localRole": "True only for exact 204." }, - { "outputField": "retrySafe", "localRole": "False after an attempted delete; inspect the exact resource before retrying ambiguity." }, - { "outputField": "statusCode", "localRole": "Exact verified 204 status." }, - { "outputField": "message", "localRole": "Deterministic deletion confirmation built from screenshot_id." }, - { "outputField": "operation", "localRole": "Delete discriminator returned by structured failure outcomes." }, - { "outputField": "write_outcome", "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." }, - { "outputField": "mutationAttempted", "localRole": "Whether the DELETE request may have reached Apple." }, - { "outputField": "resourceId", "localRole": "Validated canonical screenshot ID on structured failure outcomes." }, - { "outputField": "error", "localRole": "Redacted diagnostic for rejected or unverified outcomes." }, - { "outputField": "inspection", "localRole": "Executable exact-resource inspection guidance when retry safety is unknown." }, - { "outputField": "outcomeUnknown", "localRole": "True when DELETE commitment cannot be determined." }, - { "outputField": "inspectionRequired", "localRole": "True when exact-resource inspection is required before retry." } + { + "outputField": "success", + "localRole": "True only after exact confirmation and HTTP 204." + }, + { + "outputField": "operationCommitState", + "localRole": "Committed only for exact 204; rejected, unknown, and committed_unverified remain error outcomes." + }, + { + "outputField": "operationCommitted", + "localRole": "True only for exact 204." + }, + { + "outputField": "retrySafe", + "localRole": "False after an attempted delete; inspect the exact resource before retrying ambiguity." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 204 status." + }, + { + "outputField": "message", + "localRole": "Deterministic deletion confirmation built from screenshot_id." + }, + { + "outputField": "operation", + "localRole": "Delete discriminator returned by structured failure outcomes." + }, + { + "outputField": "write_outcome", + "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." + }, + { + "outputField": "mutationAttempted", + "localRole": "Whether the DELETE request may have reached Apple." + }, + { + "outputField": "resourceId", + "localRole": "Validated canonical screenshot ID on structured failure outcomes." + }, + { + "outputField": "error", + "localRole": "Redacted diagnostic for rejected or unverified outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable exact-resource inspection guidance when retry safety is unknown." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when DELETE commitment cannot be determined." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when exact-resource inspection is required before retry." + } ] }, "note": "Runtime validation requires canonical IDs and exact confirm_screenshot_id. Only HTTP 204 confirms deletion; rejected, unknown, and unexpected successful outcomes remain distinct and never become false success." @@ -277,30 +843,92 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "appPreviews_deleteInstance", "method": "delete", "path": "/v1/appPreviews/{id}", "role": "primary" } + { + "operationId": "appPreviews_deleteInstance", + "method": "delete", + "path": "/v1/appPreviews/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "preview_id", "sourceKind": "parameter", "operationId": "appPreviews_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_preview_id", "sourceKind": "local", "localRole": "Must exactly match preview_id before DELETE is attempted." } + { + "toolField": "preview_id", + "sourceKind": "parameter", + "operationId": "appPreviews_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_preview_id", + "sourceKind": "local", + "localRole": "Must exactly match preview_id before DELETE is attempted." + } ], "response": { "mode": "local", - "sources": [{ "operationId": "appPreviews_deleteInstance", "statusCode": "204" }], + "sources": [ + { + "operationId": "appPreviews_deleteInstance", + "statusCode": "204" + } + ], "fields": [ - { "outputField": "success", "localRole": "True only after exact confirmation and HTTP 204." }, - { "outputField": "operationCommitState", "localRole": "Committed only for exact 204; rejected, unknown, and committed_unverified remain error outcomes." }, - { "outputField": "operationCommitted", "localRole": "True only for exact 204." }, - { "outputField": "retrySafe", "localRole": "False after an attempted delete; inspect the exact resource before retrying ambiguity." }, - { "outputField": "statusCode", "localRole": "Exact verified 204 status." }, - { "outputField": "message", "localRole": "Deterministic deletion confirmation built from preview_id." }, - { "outputField": "operation", "localRole": "Delete discriminator returned by structured failure outcomes." }, - { "outputField": "write_outcome", "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." }, - { "outputField": "mutationAttempted", "localRole": "Whether the DELETE request may have reached Apple." }, - { "outputField": "resourceId", "localRole": "Validated canonical preview ID on structured failure outcomes." }, - { "outputField": "error", "localRole": "Redacted diagnostic for rejected or unverified outcomes." }, - { "outputField": "inspection", "localRole": "Executable exact-resource inspection guidance when retry safety is unknown." }, - { "outputField": "outcomeUnknown", "localRole": "True when DELETE commitment cannot be determined." }, - { "outputField": "inspectionRequired", "localRole": "True when exact-resource inspection is required before retry." } + { + "outputField": "success", + "localRole": "True only after exact confirmation and HTTP 204." + }, + { + "outputField": "operationCommitState", + "localRole": "Committed only for exact 204; rejected, unknown, and committed_unverified remain error outcomes." + }, + { + "outputField": "operationCommitted", + "localRole": "True only for exact 204." + }, + { + "outputField": "retrySafe", + "localRole": "False after an attempted delete; inspect the exact resource before retrying ambiguity." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 204 status." + }, + { + "outputField": "message", + "localRole": "Deterministic deletion confirmation built from preview_id." + }, + { + "outputField": "operation", + "localRole": "Delete discriminator returned by structured failure outcomes." + }, + { + "outputField": "write_outcome", + "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." + }, + { + "outputField": "mutationAttempted", + "localRole": "Whether the DELETE request may have reached Apple." + }, + { + "outputField": "resourceId", + "localRole": "Validated canonical preview ID on structured failure outcomes." + }, + { + "outputField": "error", + "localRole": "Redacted diagnostic for rejected or unverified outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable exact-resource inspection guidance when retry safety is unknown." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when DELETE commitment cannot be determined." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when exact-resource inspection is required before retry." + } ] }, "note": "Runtime validation requires canonical IDs and exact confirm_preview_id. Only HTTP 204 confirms deletion; rejected, unknown, and unexpected successful outcomes remain distinct and never become false success." @@ -319,35 +947,120 @@ "role": "supporting", "condition": "Confirm the canonical target identity before the cascade delete.", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Delete preflight needs only the exact base set identity.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appPreviews]", "disposition": "intentionallyOmitted", "reason": "The preflight does not include previews.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Delete preflight needs only the exact base set identity.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appPreviews]", + "disposition": "intentionallyOmitted", + "reason": "The preflight does not include previews.", + "reviewAtSpec": "4.6" + } ] }, - { "operationId": "appPreviewSets_deleteInstance", "method": "delete", "path": "/v1/appPreviewSets/{id}", "role": "primary" } + { + "operationId": "appPreviewSets_deleteInstance", + "method": "delete", + "path": "/v1/appPreviewSets/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appPreviewSets_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appPreviewSets_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_set_id", "sourceKind": "local", "localRole": "Must exactly match set_id before the cascade delete preflight." } + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appPreviewSets_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appPreviewSets_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_set_id", + "sourceKind": "local", + "localRole": "Must exactly match set_id before the cascade delete preflight." + } ], "response": { "mode": "local", - "sources": [{ "operationId": "appPreviewSets_getInstance", "statusCode": "200", "mediaType": "application/json" }, { "operationId": "appPreviewSets_deleteInstance", "statusCode": "204" }], + "sources": [ + { + "operationId": "appPreviewSets_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appPreviewSets_deleteInstance", + "statusCode": "204" + } + ], "fields": [ - { "outputField": "success", "localRole": "True only after exact-ID preflight and HTTP 204." }, - { "outputField": "operation", "localRole": "Delete discriminator." }, - { "outputField": "operationCommitState", "localRole": "Committed only for exact 204; accepted but unverified and unknown outcomes remain errors." }, - { "outputField": "operationCommitted", "localRole": "True only for exact 204." }, - { "outputField": "retrySafe", "localRole": "False after an attempted cascade delete." }, - { "outputField": "statusCode", "localRole": "Exact verified 204 status." }, - { "outputField": "setId", "localRole": "Validated canonical request ID." }, - { "outputField": "message", "localRole": "Deterministic cascade-deletion confirmation." }, - { "outputField": "write_outcome", "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." }, - { "outputField": "mutationAttempted", "localRole": "Whether the cascade DELETE request may have reached Apple." }, - { "outputField": "error", "localRole": "Redacted diagnostic for rejected or unverified outcomes." }, - { "outputField": "inspection", "localRole": "Executable exact-set inspection guidance when retry safety is unknown." }, - { "outputField": "outcomeUnknown", "localRole": "True when DELETE commitment cannot be determined." }, - { "outputField": "inspectionRequired", "localRole": "True when exact-set inspection is required before retry." } + { + "outputField": "success", + "localRole": "True only after exact-ID preflight and HTTP 204." + }, + { + "outputField": "operation", + "localRole": "Delete discriminator." + }, + { + "outputField": "operationCommitState", + "localRole": "Committed only for exact 204; accepted but unverified and unknown outcomes remain errors." + }, + { + "outputField": "operationCommitted", + "localRole": "True only for exact 204." + }, + { + "outputField": "retrySafe", + "localRole": "False after an attempted cascade delete." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 204 status." + }, + { + "outputField": "setId", + "localRole": "Validated canonical request ID." + }, + { + "outputField": "message", + "localRole": "Deterministic cascade-deletion confirmation." + }, + { + "outputField": "write_outcome", + "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." + }, + { + "outputField": "mutationAttempted", + "localRole": "Whether the cascade DELETE request may have reached Apple." + }, + { + "outputField": "error", + "localRole": "Redacted diagnostic for rejected or unverified outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable exact-set inspection guidance when retry safety is unknown." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when DELETE commitment cannot be determined." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when exact-set inspection is required before retry." + } ] }, "note": "Requires canonical set_id, exact confirm_set_id, an exact identity GET, and HTTP 204. Unknown or unexpected successful DELETE outcomes remain unverified." @@ -361,40 +1074,125 @@ "operations": [ { "operationId": "appScreenshotSets_getInstance", - "method": "get", - "path": "/v1/appScreenshotSets/{id}", - "role": "supporting", - "condition": "Confirm the canonical target identity before the cascade delete.", - "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Delete preflight needs only the exact base set identity.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appScreenshots]", "disposition": "intentionallyOmitted", "reason": "The preflight does not include screenshots.", "reviewAtSpec": "4.5.1" } - ] + "method": "get", + "path": "/v1/appScreenshotSets/{id}", + "role": "supporting", + "condition": "Confirm the canonical target identity before the cascade delete.", + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "Delete preflight needs only the exact base set identity.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appScreenshots]", + "disposition": "intentionallyOmitted", + "reason": "The preflight does not include screenshots.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "operationId": "appScreenshotSets_deleteInstance", + "method": "delete", + "path": "/v1/appScreenshotSets/{id}", + "role": "primary" + } + ], + "fields": [ + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appScreenshotSets_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appScreenshotSets_getInstance", + "location": "path", + "appleName": "id" }, - { "operationId": "appScreenshotSets_deleteInstance", "method": "delete", "path": "/v1/appScreenshotSets/{id}", "role": "primary" } - ], - "fields": [ - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appScreenshotSets_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appScreenshotSets_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_set_id", "sourceKind": "local", "localRole": "Must exactly match set_id before the cascade delete preflight." } + { + "toolField": "confirm_set_id", + "sourceKind": "local", + "localRole": "Must exactly match set_id before the cascade delete preflight." + } ], "response": { "mode": "local", - "sources": [{ "operationId": "appScreenshotSets_getInstance", "statusCode": "200", "mediaType": "application/json" }, { "operationId": "appScreenshotSets_deleteInstance", "statusCode": "204" }], + "sources": [ + { + "operationId": "appScreenshotSets_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appScreenshotSets_deleteInstance", + "statusCode": "204" + } + ], "fields": [ - { "outputField": "success", "localRole": "True only after exact-ID preflight and HTTP 204." }, - { "outputField": "operation", "localRole": "Delete discriminator." }, - { "outputField": "operationCommitState", "localRole": "Committed only for exact 204; accepted but unverified and unknown outcomes remain errors." }, - { "outputField": "operationCommitted", "localRole": "True only for exact 204." }, - { "outputField": "retrySafe", "localRole": "False after an attempted cascade delete." }, - { "outputField": "statusCode", "localRole": "Exact verified 204 status." }, - { "outputField": "setId", "localRole": "Validated canonical request ID." }, - { "outputField": "message", "localRole": "Deterministic cascade-deletion confirmation." }, - { "outputField": "write_outcome", "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." }, - { "outputField": "mutationAttempted", "localRole": "Whether the cascade DELETE request may have reached Apple." }, - { "outputField": "error", "localRole": "Redacted diagnostic for rejected or unverified outcomes." }, - { "outputField": "inspection", "localRole": "Executable exact-set inspection guidance when retry safety is unknown." }, - { "outputField": "outcomeUnknown", "localRole": "True when DELETE commitment cannot be determined." }, - { "outputField": "inspectionRequired", "localRole": "True when exact-set inspection is required before retry." } + { + "outputField": "success", + "localRole": "True only after exact-ID preflight and HTTP 204." + }, + { + "outputField": "operation", + "localRole": "Delete discriminator." + }, + { + "outputField": "operationCommitState", + "localRole": "Committed only for exact 204; accepted but unverified and unknown outcomes remain errors." + }, + { + "outputField": "operationCommitted", + "localRole": "True only for exact 204." + }, + { + "outputField": "retrySafe", + "localRole": "False after an attempted cascade delete." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 204 status." + }, + { + "outputField": "setId", + "localRole": "Validated canonical request ID." + }, + { + "outputField": "message", + "localRole": "Deterministic cascade-deletion confirmation." + }, + { + "outputField": "write_outcome", + "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." + }, + { + "outputField": "mutationAttempted", + "localRole": "Whether the cascade DELETE request may have reached Apple." + }, + { + "outputField": "error", + "localRole": "Redacted diagnostic for rejected or unverified outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable exact-set inspection guidance when retry safety is unknown." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when DELETE commitment cannot be determined." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when exact-set inspection is required before retry." + } ] }, "note": "Requires canonical set_id, exact confirm_set_id, an exact identity GET, and HTTP 204. Unknown or unexpected successful DELETE outcomes remain unverified." @@ -417,29 +1215,45 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact-ID path proves resource identity; the base appPreviewSet projection includes validated attributes plus optional self and parent linkage when present, so included localization and appPreview resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[appPreviews]", "disposition": "intentionallyOmitted", "reason": "The nested limit applies only when appPreviews is included; callers page previews through screenshots_list_previews.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appPreviewSets_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appPreviewSets_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appPreviewSets_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appPreviewSets_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "preview_set", "localRole": "Validated base appPreviewSet projection with identity, previewType, optional self, and optional canonical parent linkage; not the raw Apple document." } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "preview_set", + "localRole": "Validated base appPreviewSet projection with identity, previewType, optional self, and optional canonical parent linkage; not the raw Apple document." + } ] }, "note": "The handler validates the exact canonical set identity and appPreviewSets resource type." @@ -462,29 +1276,45 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact-ID path proves resource identity; the base appScreenshotSet projection includes validated attributes plus optional self and parent linkage when present, so included localization and appScreenshot resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[appScreenshots]", "disposition": "intentionallyOmitted", "reason": "The nested limit applies only when appScreenshots is included; callers page screenshots through screenshots_list.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appScreenshotSets_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appScreenshotSets_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appScreenshotSets_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appScreenshotSets_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "screenshot_set", "localRole": "Validated base appScreenshotSet projection with identity, screenshotDisplayType, optional self, and optional canonical parent linkage; not the raw Apple document." } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "screenshot_set", + "localRole": "Validated base appScreenshotSet projection with identity, screenshotDisplayType, optional self, and optional canonical parent linkage; not the raw Apple document." + } ] }, "note": "The handler validates the exact canonical set identity and appScreenshotSets resource type." @@ -507,25 +1337,54 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact-ID path proves resource identity; screenshots_get returns a validated base projection with attributes plus optional resource self and screenshot-set linkage when present, so included appScreenshotSet resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "screenshot_id", "sourceKind": "parameter", "operationId": "appScreenshots_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "screenshot_id", + "sourceKind": "parameter", + "operationId": "appScreenshots_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appScreenshots_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appScreenshots_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "screenshot", "localRole": "Validated redacted appScreenshot projection; upload operations, signed URLs, and headers are omitted." }, - { "outputField": "screenshot.assetDeliveryState.warnings", "operationId": "appScreenshots_getInstance", "jsonPointer": "/data/attributes/assetDeliveryState/warnings" }, - { "outputField": "screenshot.selfLink", "operationId": "appScreenshots_getInstance", "jsonPointer": "/data/links/self" }, - { "outputField": "screenshot.screenshotSet", "operationId": "appScreenshots_getInstance", "jsonPointer": "/data/relationships/appScreenshotSet/data", "localRole": "Projected only when Apple supplies canonical relationship linkage; absent optional linkage is not invented." } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "screenshot", + "localRole": "Validated redacted appScreenshot projection; upload operations, signed URLs, and headers are omitted." + }, + { + "outputField": "screenshot.assetDeliveryState.warnings", + "operationId": "appScreenshots_getInstance", + "jsonPointer": "/data/attributes/assetDeliveryState/warnings" + }, + { + "outputField": "screenshot.selfLink", + "operationId": "appScreenshots_getInstance", + "jsonPointer": "/data/links/self" + }, + { + "outputField": "screenshot.screenshotSet", + "operationId": "appScreenshots_getInstance", + "jsonPointer": "/data/relationships/appScreenshotSet/data", + "localRole": "Projected only when Apple supplies canonical relationship linkage; absent optional linkage is not invented." + } ] } }, @@ -547,29 +1406,74 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact-ID path proves resource identity; screenshots_get_preview returns a validated base projection with attributes plus optional resource self and preview-set linkage when present, so included appPreviewSet resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "preview_id", "sourceKind": "parameter", "operationId": "appPreviews_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "preview_id", + "sourceKind": "parameter", + "operationId": "appPreviews_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appPreviews_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appPreviews_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "preview", "localRole": "Validated redacted appPreview projection; upload operations, signed URLs, and headers are omitted." }, - { "outputField": "preview.previewFrameTimeCode", "operationId": "appPreviews_getInstance", "jsonPointer": "/data/attributes/previewFrameTimeCode" }, - { "outputField": "preview.previewFrameImage", "operationId": "appPreviews_getInstance", "jsonPointer": "/data/attributes/previewFrameImage" }, - { "outputField": "preview.previewImage", "operationId": "appPreviews_getInstance", "jsonPointer": "/data/attributes/previewImage" }, - { "outputField": "preview.assetDeliveryState.warnings", "operationId": "appPreviews_getInstance", "jsonPointer": "/data/attributes/assetDeliveryState/warnings" }, - { "outputField": "preview.videoDeliveryState.warnings", "operationId": "appPreviews_getInstance", "jsonPointer": "/data/attributes/videoDeliveryState/warnings" }, - { "outputField": "preview.selfLink", "operationId": "appPreviews_getInstance", "jsonPointer": "/data/links/self" }, - { "outputField": "preview.previewSet", "operationId": "appPreviews_getInstance", "jsonPointer": "/data/relationships/appPreviewSet/data", "localRole": "Projected only when Apple supplies canonical relationship linkage; absent optional linkage is not invented." } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "preview", + "localRole": "Validated redacted appPreview projection; upload operations, signed URLs, and headers are omitted." + }, + { + "outputField": "preview.previewFrameTimeCode", + "operationId": "appPreviews_getInstance", + "jsonPointer": "/data/attributes/previewFrameTimeCode" + }, + { + "outputField": "preview.previewFrameImage", + "operationId": "appPreviews_getInstance", + "jsonPointer": "/data/attributes/previewFrameImage" + }, + { + "outputField": "preview.previewImage", + "operationId": "appPreviews_getInstance", + "jsonPointer": "/data/attributes/previewImage" + }, + { + "outputField": "preview.assetDeliveryState.warnings", + "operationId": "appPreviews_getInstance", + "jsonPointer": "/data/attributes/assetDeliveryState/warnings" + }, + { + "outputField": "preview.videoDeliveryState.warnings", + "operationId": "appPreviews_getInstance", + "jsonPointer": "/data/attributes/videoDeliveryState/warnings" + }, + { + "outputField": "preview.selfLink", + "operationId": "appPreviews_getInstance", + "jsonPointer": "/data/links/self" + }, + { + "outputField": "preview.previewSet", + "operationId": "appPreviews_getInstance", + "jsonPointer": "/data/relationships/appPreviewSet/data", + "localRole": "Projected only when Apple supplies canonical relationship linkage; absent optional linkage is not invented." + } ] }, "note": "The projection exposes Apple previewFrameImage and retains deprecated previewImage for compatibility with existing MCP consumers." @@ -592,30 +1496,80 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact appScreenshotSet relationship path proves set scope; screenshots_list returns ordered validated base projections with attributes plus optional resource self and set linkage when present, so included appScreenshotSet resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "screenshots", "localRole": "Ordered validated redacted appScreenshot projections from the exact parent-set page; upload operations, signed URLs, and headers are omitted." }, - { "outputField": "count", "localRole": "Count of validated resources on this page." }, - { "outputField": "next_url", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "screenshots.*.assetDeliveryState.warnings", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "jsonPointer": "/data/*/attributes/assetDeliveryState/warnings" }, - { "outputField": "screenshots.*.selfLink", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "jsonPointer": "/data/*/links/self" }, - { "outputField": "screenshots.*.screenshotSet", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "jsonPointer": "/data/*/relationships/appScreenshotSet/data", "localRole": "Projected only when Apple supplies canonical linkage; the exact parent endpoint remains the scope proof." } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "screenshots", + "localRole": "Ordered validated redacted appScreenshot projections from the exact parent-set page; upload operations, signed URLs, and headers are omitted." + }, + { + "outputField": "count", + "localRole": "Count of validated resources on this page." + }, + { + "outputField": "next_url", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "screenshots.*.assetDeliveryState.warnings", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "jsonPointer": "/data/*/attributes/assetDeliveryState/warnings" + }, + { + "outputField": "screenshots.*.selfLink", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "jsonPointer": "/data/*/links/self" + }, + { + "outputField": "screenshots.*.screenshotSet", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "jsonPointer": "/data/*/relationships/appScreenshotSet/data", + "localRole": "Projected only when Apple supplies canonical linkage; the exact parent endpoint remains the scope proof." + } ] } }, @@ -638,14 +1592,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact localization relationship path proves parent scope; each base preview-set projection includes validated identity, previewType, optional self, and optional parent linkage when present, so included resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[appPreviews]", "disposition": "intentionallyOmitted", "reason": "Apple applies this limit only when appPreviews is included; screenshots_list_preview_sets does not request that relationship, and callers page previews through screenshots_list_previews instead.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -661,14 +1615,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact localization relationship path proves parent scope; each base preview-set projection includes validated identity, previewType, optional self, and optional parent linkage when present, so included resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[appPreviews]", "disposition": "intentionallyOmitted", "reason": "The tool does not include child previews; callers page them through screenshots_list_previews.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -684,53 +1638,189 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact localization relationship path proves parent scope; each base preview-set projection includes validated identity, previewType, optional self, and optional parent linkage when present, so included resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[appPreviews]", "disposition": "intentionallyOmitted", "reason": "The tool does not include child previews; callers page them through screenshots_list_previews.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "app_store_version_localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "custom_product_page_localization_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "treatment_localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "preview_types", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[previewType]" }, - { "toolField": "preview_types", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[previewType]" }, - { "toolField": "preview_types", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[previewType]" }, - { "toolField": "custom_product_page_localization_ids", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[appCustomProductPageLocalization]" }, - { "toolField": "treatment_localization_ids", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]" }, - { "toolField": "app_store_version_localization_ids", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[appStoreVersionLocalization]" }, - { "toolField": "treatment_localization_ids", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]" }, - { "toolField": "app_store_version_localization_ids", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[appStoreVersionLocalization]" }, - { "toolField": "custom_product_page_localization_ids", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "filter[appCustomProductPageLocalization]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_store_version_localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "custom_product_page_localization_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "treatment_localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "preview_types", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[previewType]" + }, + { + "toolField": "preview_types", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[previewType]" + }, + { + "toolField": "preview_types", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[previewType]" + }, + { + "toolField": "custom_product_page_localization_ids", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]" + }, + { + "toolField": "treatment_localization_ids", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]" + }, + { + "toolField": "app_store_version_localization_ids", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[appStoreVersionLocalization]" + }, + { + "toolField": "treatment_localization_ids", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]" + }, + { + "toolField": "app_store_version_localization_ids", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[appStoreVersionLocalization]" + }, + { + "toolField": "custom_product_page_localization_ids", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "preview_sets", "localRole": "Validated base resources from the selected one-of-three parent-scoped operation." }, - { "outputField": "count", "localRole": "Count of validated resources on this page." }, - { "outputField": "parent", "localRole": "Validated selected localization-parent scope." }, - { "outputField": "next_url", "localRole": "Apple continuation after configured-origin, exact-path, query, and cursor validation." }, - { "outputField": "total", "localRole": "Optional Apple paging total after limit and count validation." }, - { "outputField": "preview_sets.*.selfLink", "localRole": "Optional resource links.self from the selected parent-scoped operation, validated when present." }, - { "outputField": "preview_sets.*.parent", "localRole": "Projected only when Apple supplies canonical relationship linkage; no unverified lineage is invented." } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "preview_sets", + "localRole": "Validated base resources from the selected one-of-three parent-scoped operation." + }, + { + "outputField": "count", + "localRole": "Count of validated resources on this page." + }, + { + "outputField": "parent", + "localRole": "Validated selected localization-parent scope." + }, + { + "outputField": "next_url", + "localRole": "Apple continuation after configured-origin, exact-path, query, and cursor validation." + }, + { + "outputField": "total", + "localRole": "Optional Apple paging total after limit and count validation." + }, + { + "outputField": "preview_sets.*.selfLink", + "localRole": "Optional resource links.self from the selected parent-scoped operation, validated when present." + }, + { + "outputField": "preview_sets.*.parent", + "localRole": "Projected only when Apple supplies canonical relationship linkage; no unverified lineage is invented." + } ] }, "note": "Exactly one canonical parent selects one Apple relationship endpoint. Parent-specific filters are forwarded only where Apple exposes them, limits are validated in 1...200, and next_url remains within the selected relationship scope." @@ -753,34 +1843,100 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact appPreviewSet relationship path proves set scope; screenshots_list_previews returns ordered validated base projections with attributes plus optional resource self and set linkage when present, so included appPreviewSet resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appPreviewSets_appPreviews_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "previews", "localRole": "Ordered validated redacted appPreview projections from the exact parent-set page; upload operations, signed URLs, and headers are omitted." }, - { "outputField": "count", "localRole": "Count of validated resources on this page." }, - { "outputField": "previews.*.previewFrameTimeCode", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "jsonPointer": "/data/*/attributes/previewFrameTimeCode" }, - { "outputField": "previews.*.previewFrameImage", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "jsonPointer": "/data/*/attributes/previewFrameImage" }, - { "outputField": "previews.*.previewImage", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "jsonPointer": "/data/*/attributes/previewImage" }, - { "outputField": "previews.*.assetDeliveryState.warnings", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "jsonPointer": "/data/*/attributes/assetDeliveryState/warnings" }, - { "outputField": "previews.*.videoDeliveryState.warnings", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "jsonPointer": "/data/*/attributes/videoDeliveryState/warnings" }, - { "outputField": "previews.*.selfLink", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "jsonPointer": "/data/*/links/self" }, - { "outputField": "previews.*.previewSet", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "jsonPointer": "/data/*/relationships/appPreviewSet/data", "localRole": "Projected only when Apple supplies canonical linkage; the exact parent endpoint remains the scope proof." }, - { "outputField": "next_url", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "previews", + "localRole": "Ordered validated redacted appPreview projections from the exact parent-set page; upload operations, signed URLs, and headers are omitted." + }, + { + "outputField": "count", + "localRole": "Count of validated resources on this page." + }, + { + "outputField": "previews.*.previewFrameTimeCode", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "jsonPointer": "/data/*/attributes/previewFrameTimeCode" + }, + { + "outputField": "previews.*.previewFrameImage", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "jsonPointer": "/data/*/attributes/previewFrameImage" + }, + { + "outputField": "previews.*.previewImage", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "jsonPointer": "/data/*/attributes/previewImage" + }, + { + "outputField": "previews.*.assetDeliveryState.warnings", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "jsonPointer": "/data/*/attributes/assetDeliveryState/warnings" + }, + { + "outputField": "previews.*.videoDeliveryState.warnings", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "jsonPointer": "/data/*/attributes/videoDeliveryState/warnings" + }, + { + "outputField": "previews.*.selfLink", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "jsonPointer": "/data/*/links/self" + }, + { + "outputField": "previews.*.previewSet", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "jsonPointer": "/data/*/relationships/appPreviewSet/data", + "localRole": "Projected only when Apple supplies canonical linkage; the exact parent endpoint remains the scope proof." + }, + { + "outputField": "next_url", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] } }, @@ -803,14 +1959,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact localization relationship path proves parent scope; each base screenshot-set projection includes validated identity, screenshotDisplayType, optional self, and optional parent linkage when present, so included resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[appScreenshots]", "disposition": "intentionallyOmitted", "reason": "Apple applies this limit only when appScreenshots is included; screenshots_list_sets does not request that relationship, and callers page screenshots through screenshots_list instead.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -826,14 +1982,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact localization relationship path proves parent scope; each base screenshot-set projection includes validated identity, screenshotDisplayType, optional self, and optional parent linkage when present, so included resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[appScreenshots]", "disposition": "intentionallyOmitted", "reason": "The tool does not include child screenshots; callers page them through screenshots_list.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -849,53 +2005,189 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact localization relationship path proves parent scope; each base screenshot-set projection includes validated identity, screenshotDisplayType, optional self, and optional parent linkage when present, so included resources are unnecessary and not decoded.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[appScreenshots]", "disposition": "intentionallyOmitted", "reason": "The tool does not include child screenshots; callers page them through screenshots_list.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } ], "fields": [ - { "toolField": "localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "app_store_version_localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "custom_product_page_localization_id", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "treatment_localization_id", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "display_types", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[screenshotDisplayType]" }, - { "toolField": "display_types", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[screenshotDisplayType]" }, - { "toolField": "display_types", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[screenshotDisplayType]" }, - { "toolField": "custom_product_page_localization_ids", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[appCustomProductPageLocalization]" }, - { "toolField": "treatment_localization_ids", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]" }, - { "toolField": "app_store_version_localization_ids", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[appStoreVersionLocalization]" }, - { "toolField": "treatment_localization_ids", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]" }, - { "toolField": "app_store_version_localization_ids", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[appStoreVersionLocalization]" }, - { "toolField": "custom_product_page_localization_ids", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "filter[appCustomProductPageLocalization]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_store_version_localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "custom_product_page_localization_id", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "treatment_localization_id", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "display_types", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[screenshotDisplayType]" + }, + { + "toolField": "display_types", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[screenshotDisplayType]" + }, + { + "toolField": "display_types", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[screenshotDisplayType]" + }, + { + "toolField": "custom_product_page_localization_ids", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]" + }, + { + "toolField": "treatment_localization_ids", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]" + }, + { + "toolField": "app_store_version_localization_ids", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[appStoreVersionLocalization]" + }, + { + "toolField": "treatment_localization_ids", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[appStoreVersionExperimentTreatmentLocalization]" + }, + { + "toolField": "app_store_version_localization_ids", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[appStoreVersionLocalization]" + }, + { + "toolField": "custom_product_page_localization_ids", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "filter[appCustomProductPageLocalization]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "screenshot_sets", "localRole": "Validated base resources from the selected one-of-three parent-scoped operation." }, - { "outputField": "count", "localRole": "Count of validated resources on this page." }, - { "outputField": "parent", "localRole": "Validated selected localization-parent scope." }, - { "outputField": "next_url", "localRole": "Apple continuation after configured-origin, exact-path, query, and cursor validation." }, - { "outputField": "total", "localRole": "Optional Apple paging total after limit and count validation." }, - { "outputField": "screenshot_sets.*.selfLink", "localRole": "Optional resource links.self from the selected parent-scoped operation, validated when present." }, - { "outputField": "screenshot_sets.*.parent", "localRole": "Projected only when Apple supplies canonical relationship linkage; no unverified lineage is invented." } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "screenshot_sets", + "localRole": "Validated base resources from the selected one-of-three parent-scoped operation." + }, + { + "outputField": "count", + "localRole": "Count of validated resources on this page." + }, + { + "outputField": "parent", + "localRole": "Validated selected localization-parent scope." + }, + { + "outputField": "next_url", + "localRole": "Apple continuation after configured-origin, exact-path, query, and cursor validation." + }, + { + "outputField": "total", + "localRole": "Optional Apple paging total after limit and count validation." + }, + { + "outputField": "screenshot_sets.*.selfLink", + "localRole": "Optional resource links.self from the selected parent-scoped operation, validated when present." + }, + { + "outputField": "screenshot_sets.*.parent", + "localRole": "Projected only when Apple supplies canonical relationship linkage; no unverified lineage is invented." + } ] }, "note": "Exactly one canonical parent selects one Apple relationship endpoint. Parent-specific filters are forwarded only where Apple exposes them, limits are validated in 1...200, and next_url remains within the selected relationship scope." @@ -914,7 +2206,12 @@ "role": "supporting", "condition": "Fully paginate before PATCH to prove exact membership and after PATCH to prove the exact order.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ { @@ -922,7 +2219,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Reorder verification needs only ordered base screenshot IDs.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -932,33 +2229,108 @@ "path": "/v1/appScreenshotSets/{id}/relationships/appScreenshots", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/*/type", "fixedValue": "appScreenshots" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "appScreenshots" + } ] } ], "fields": [ - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appScreenshotSets_appScreenshots_replaceToManyRelationship", "location": "path", "appleName": "id" }, - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "screenshot_ids", "sourceKind": "requestBody", "operationId": "appScreenshotSets_appScreenshots_replaceToManyRelationship", "jsonPointer": "/data" } + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appScreenshotSets_appScreenshots_replaceToManyRelationship", + "location": "path", + "appleName": "id" + }, + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "screenshot_ids", + "sourceKind": "requestBody", + "operationId": "appScreenshotSets_appScreenshots_replaceToManyRelationship", + "jsonPointer": "/data" + } ], "response": { "mode": "aggregate", - "sources": [{ "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, { "operationId": "appScreenshotSets_appScreenshots_replaceToManyRelationship", "statusCode": "204" }], + "sources": [ + { + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appScreenshotSets_appScreenshots_replaceToManyRelationship", + "statusCode": "204" + } + ], "fields": [ - { "outputField": "success", "localRole": "True only after complete preflight membership, exact PATCH 204, and exact fully paginated postflight order." }, - { "outputField": "operation", "localRole": "Reorder discriminator." }, - { "outputField": "operationCommitted", "localRole": "True only after exact 204 and exact postflight order." }, - { "outputField": "operationCommitState", "localRole": "Committed only after full postflight verification; accepted but invalid, truncated, or ambiguous outcomes remain unverified." }, - { "outputField": "retrySafe", "localRole": "False after an attempted PATCH; inspect complete current membership before retrying." }, - { "outputField": "statusCode", "localRole": "Exact verified 204 status." }, - { "outputField": "setId", "localRole": "Validated canonical request ID." }, - { "outputField": "order", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "jsonPointer": "/data/*/id", "localRole": "Exact fully paginated postflight order." }, - { "outputField": "write_outcome", "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." }, - { "outputField": "mutationAttempted", "localRole": "Whether the reorder PATCH may have reached Apple." }, - { "outputField": "error", "localRole": "Redacted diagnostic for rejected or unverified outcomes." }, - { "outputField": "inspection", "localRole": "Executable fully paginated set-membership inspection guidance." }, - { "outputField": "outcomeUnknown", "localRole": "True when reorder commitment cannot be determined." }, - { "outputField": "inspectionRequired", "localRole": "True when full membership inspection is required before retry." } + { + "outputField": "success", + "localRole": "True only after complete preflight membership, exact PATCH 204, and exact fully paginated postflight order." + }, + { + "outputField": "operation", + "localRole": "Reorder discriminator." + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact 204 and exact postflight order." + }, + { + "outputField": "operationCommitState", + "localRole": "Committed only after full postflight verification; accepted but invalid, truncated, or ambiguous outcomes remain unverified." + }, + { + "outputField": "retrySafe", + "localRole": "False after an attempted PATCH; inspect complete current membership before retrying." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 204 status." + }, + { + "outputField": "setId", + "localRole": "Validated canonical request ID." + }, + { + "outputField": "order", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "jsonPointer": "/data/*/id", + "localRole": "Exact fully paginated postflight order." + }, + { + "outputField": "write_outcome", + "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." + }, + { + "outputField": "mutationAttempted", + "localRole": "Whether the reorder PATCH may have reached Apple." + }, + { + "outputField": "error", + "localRole": "Redacted diagnostic for rejected or unverified outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable fully paginated set-membership inspection guidance." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when reorder commitment cannot be determined." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when full membership inspection is required before retry." + } ] }, "note": "The handler accepts a unique ordered array of 1...200 canonical IDs, fully paginates current membership before mutation, requires exact set equality, requires PATCH 204, and fully paginates again to verify exact order. Ambiguous or mismatched outcomes remain unverified." @@ -977,7 +2349,12 @@ "role": "supporting", "condition": "Fully paginate before PATCH to prove exact membership and after PATCH to prove the exact order.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ { @@ -985,7 +2362,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Reorder verification needs only ordered base preview IDs.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -995,33 +2372,108 @@ "path": "/v1/appPreviewSets/{id}/relationships/appPreviews", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/*/type", "fixedValue": "appPreviews" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "appPreviews" + } ] } ], "fields": [ - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appPreviewSets_appPreviews_replaceToManyRelationship", "location": "path", "appleName": "id" }, - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "preview_ids", "sourceKind": "requestBody", "operationId": "appPreviewSets_appPreviews_replaceToManyRelationship", "jsonPointer": "/data" } + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appPreviewSets_appPreviews_replaceToManyRelationship", + "location": "path", + "appleName": "id" + }, + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "preview_ids", + "sourceKind": "requestBody", + "operationId": "appPreviewSets_appPreviews_replaceToManyRelationship", + "jsonPointer": "/data" + } ], "response": { "mode": "aggregate", - "sources": [{ "operationId": "appPreviewSets_appPreviews_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, { "operationId": "appPreviewSets_appPreviews_replaceToManyRelationship", "statusCode": "204" }], + "sources": [ + { + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appPreviewSets_appPreviews_replaceToManyRelationship", + "statusCode": "204" + } + ], "fields": [ - { "outputField": "success", "localRole": "True only after complete preflight membership, exact PATCH 204, and exact fully paginated postflight order." }, - { "outputField": "operation", "localRole": "Reorder discriminator." }, - { "outputField": "operationCommitted", "localRole": "True only after exact 204 and exact postflight order." }, - { "outputField": "operationCommitState", "localRole": "Committed only after full postflight verification; accepted but invalid, truncated, or ambiguous outcomes remain unverified." }, - { "outputField": "retrySafe", "localRole": "False after an attempted PATCH; inspect complete current membership before retrying." }, - { "outputField": "statusCode", "localRole": "Exact verified 204 status." }, - { "outputField": "setId", "localRole": "Validated canonical request ID." }, - { "outputField": "order", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "jsonPointer": "/data/*/id", "localRole": "Exact fully paginated postflight order." }, - { "outputField": "write_outcome", "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." }, - { "outputField": "mutationAttempted", "localRole": "Whether the reorder PATCH may have reached Apple." }, - { "outputField": "error", "localRole": "Redacted diagnostic for rejected or unverified outcomes." }, - { "outputField": "inspection", "localRole": "Executable fully paginated set-membership inspection guidance." }, - { "outputField": "outcomeUnknown", "localRole": "True when reorder commitment cannot be determined." }, - { "outputField": "inspectionRequired", "localRole": "True when full membership inspection is required before retry." } + { + "outputField": "success", + "localRole": "True only after complete preflight membership, exact PATCH 204, and exact fully paginated postflight order." + }, + { + "outputField": "operation", + "localRole": "Reorder discriminator." + }, + { + "outputField": "operationCommitted", + "localRole": "True only after exact 204 and exact postflight order." + }, + { + "outputField": "operationCommitState", + "localRole": "Committed only after full postflight verification; accepted but invalid, truncated, or ambiguous outcomes remain unverified." + }, + { + "outputField": "retrySafe", + "localRole": "False after an attempted PATCH; inspect complete current membership before retrying." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 204 status." + }, + { + "outputField": "setId", + "localRole": "Validated canonical request ID." + }, + { + "outputField": "order", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "jsonPointer": "/data/*/id", + "localRole": "Exact fully paginated postflight order." + }, + { + "outputField": "write_outcome", + "localRole": "Stable rejected, unknown, or accepted-but-unverified write classification." + }, + { + "outputField": "mutationAttempted", + "localRole": "Whether the reorder PATCH may have reached Apple." + }, + { + "outputField": "error", + "localRole": "Redacted diagnostic for rejected or unverified outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable fully paginated set-membership inspection guidance." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when reorder commitment cannot be determined." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when full membership inspection is required before retry." + } ] }, "note": "The handler accepts a unique ordered array of 1...200 canonical IDs, fully paginates current membership before mutation, requires exact set equality, requires PATCH 204, and fully paginates again to verify exact order. Ambiguous or mismatched outcomes remain unverified." @@ -1040,20 +2492,32 @@ "role": "supporting", "condition": "Reserves the asset and returns signed upload operations.", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appScreenshots" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appScreenshots" + }, { "sourceKind": "derived", "jsonPointer": "/data/attributes/fileName", - "derivedFrom": ["file_path"], + "derivedFrom": [ + "file_path" + ], "localRole": "Derive the reservation file name from the immutable local snapshot prepared before reservation." }, { "sourceKind": "derived", "jsonPointer": "/data/attributes/fileSize", - "derivedFrom": ["file_path"], + "derivedFrom": [ + "file_path" + ], "localRole": "Use the immutable snapshot size captured before reserving the asset." }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appScreenshotSet/data/type", "fixedValue": "appScreenshotSets" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appScreenshotSet/data/type", + "fixedValue": "appScreenshotSets" + } ] }, { @@ -1067,23 +2531,38 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appScreenshots_createInstance:/data/id"], + "derivedFrom": [ + "appScreenshots_createInstance:/data/id" + ], "localRole": "Use the screenshot ID returned by the reservation response." }, { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["appScreenshots_createInstance:/data/id"], + "derivedFrom": [ + "appScreenshots_createInstance:/data/id" + ], "localRole": "Copy the reservation response ID into the commit resource identifier." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appScreenshots" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appScreenshots" + }, { "sourceKind": "derived", "jsonPointer": "/data/attributes/sourceFileChecksum", - "derivedFrom": ["file_path", "appScreenshots_createInstance:/data/attributes/uploadOperations"], + "derivedFrom": [ + "file_path", + "appScreenshots_createInstance:/data/attributes/uploadOperations" + ], "localRole": "Use the local MD5 of the same immutable snapshot bytes after their successful signed transfer." }, - { "sourceKind": "fixed", "jsonPointer": "/data/attributes/uploaded", "fixedValue": true } + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/uploaded", + "fixedValue": true + } ] }, { @@ -1098,7 +2577,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "This conditional GET only reconciles the reserved appScreenshot's assetDeliveryState; Apple's appScreenshotSet inclusion cannot affect processing classification and the upload decoder intentionally ignores included resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ], "inputs": [ @@ -1106,7 +2585,9 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appScreenshots_createInstance:/data/id"], + "derivedFrom": [ + "appScreenshots_createInstance:/data/id" + ], "localRole": "Inspect the exact screenshot created by the reservation operation." } ] @@ -1118,10 +2599,21 @@ "role": "conditional", "condition": "When POST 201 omits optional appScreenshotSet relationship linkage, fully paginate the exact requested set collection before byte transfer and require the reservation ID to be present.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact appScreenshotSet relationship path proves set scope; optional returned linkage is validated when present and any contradiction is rejected.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The exact appScreenshotSet relationship path proves set scope; optional returned linkage is validated when present and any contradiction is rejected.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1135,51 +2627,164 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appScreenshots_createInstance:/data/id"], + "derivedFrom": [ + "appScreenshots_createInstance:/data/id" + ], "localRole": "Rollback only the known reservation for this upload attempt." } ] } ], "fields": [ - { "toolField": "set_id", "sourceKind": "requestBody", "operationId": "appScreenshots_createInstance", "jsonPointer": "/data/relationships/appScreenshotSet/data/id" }, - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "file_path", "sourceKind": "local", "localRole": "Create an immutable temporary snapshot before reservation, then derive fileName, fileSize, transfer bytes, and sourceFileChecksum from that same snapshot.", "derivedFrom": ["fileName", "fileSize", "sourceFileChecksum"] } + { + "toolField": "set_id", + "sourceKind": "requestBody", + "operationId": "appScreenshots_createInstance", + "jsonPointer": "/data/relationships/appScreenshotSet/data/id" + }, + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "file_path", + "sourceKind": "local", + "localRole": "Create an immutable temporary snapshot before reservation, then derive fileName, fileSize, transfer bytes, and sourceFileChecksum from that same snapshot.", + "derivedFrom": [ + "fileName", + "fileSize", + "sourceFileChecksum" + ] + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "appScreenshots_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "appScreenshots_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appScreenshots_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appScreenshots_deleteInstance", "statusCode": "204" } + { + "operationId": "appScreenshots_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appScreenshots_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appScreenshots_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appScreenshots_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "True only for COMPLETE or a semantically valid exact-200 commit that remains processing-pending." }, - { "outputField": "screenshot", "localRole": "Validated redacted screenshot projection selected from the reservation, commit, or exact-ID reconciliation response; signed URLs and headers are omitted." }, - { "outputField": "screenshot.assetDeliveryState.warnings", "localRole": "Apple warning projection from whichever validated screenshot response supplies the final state." }, - { "outputField": "uploadCommitted", "localRole": "True only after exact PATCH 200 without a latched identity, lineage, or link-scope conflict." }, - { "outputField": "processingComplete", "localRole": "False for an accepted nonterminal processing result." }, - { "outputField": "deliveryPending", "localRole": "True while a confirmed commit remains nonterminal or post-commit resolution remains required." }, - { "outputField": "retrySafe", "localRole": "False after any unresolved reservation or commit; true only before reservation or after confirmed rollback." }, - { "outputField": "cleanup", "localRole": "Exact rollback outcome or executable get/delete guidance for a retained known reservation." }, - { "outputField": "reservationFingerprint", "localRole": "Ambiguous-reservation fileName/fileSize hints only; never a unique attribution claim." }, - { "outputField": "sourceFileChecksumReceipt", "localRole": "Local immutable-snapshot checksum receipt kept separate from reservation candidate matching." }, - { "outputField": "operationCommitState", "localRole": "Stable unknown or committed_unverified discriminator on unresolved outcomes." }, - { "outputField": "inspection", "localRole": "Executable fully paginated parent-set inspection guidance." }, - { "outputField": "reconciledAfterCommit", "localRole": "True when exact-ID GET reconciliation supplied the final accepted state." }, - { "outputField": "error", "localRole": "Redacted diagnostic for rejected, terminal, or unresolved upload outcomes." }, - { "outputField": "resourceId", "localRole": "Canonical known reservation ID on retained or failed outcomes." }, - { "outputField": "screenshot_id", "localRole": "Canonical known screenshot reservation ID for executable follow-up." }, - { "outputField": "reservationCreated", "localRole": "False only when failure is proven to precede reservation creation." }, - { "outputField": "reservationDeleted", "localRole": "Whether a known pre-commit reservation was confirmed deleted." }, - { "outputField": "reservationState", "localRole": "Rejected, unknown, or committed-unverified reservation classification." }, - { "outputField": "reservationIdKnown", "localRole": "Whether an ambiguous reservation outcome produced a canonical resource ID." }, - { "outputField": "operationCommitted", "localRole": "True only for a confirmed accepted-but-unverified reservation, commit, or cleanup response." }, - { "outputField": "outcomeUnknown", "localRole": "True when reservation or cleanup commitment cannot be determined." }, - { "outputField": "inspectionRequired", "localRole": "True when exact-resource or full parent-set inspection is required before retry." }, - { "outputField": "statusCode", "localRole": "Unexpected successful Apple status retained for recovery classification." } + { + "outputField": "success", + "localRole": "True only for COMPLETE or a semantically valid exact-200 commit that remains processing-pending." + }, + { + "outputField": "screenshot", + "localRole": "Validated redacted screenshot projection selected from the reservation, commit, or exact-ID reconciliation response; signed URLs and headers are omitted." + }, + { + "outputField": "screenshot.assetDeliveryState.warnings", + "localRole": "Apple warning projection from whichever validated screenshot response supplies the final state." + }, + { + "outputField": "uploadCommitted", + "localRole": "True only after exact PATCH 200 without a latched identity, lineage, or link-scope conflict." + }, + { + "outputField": "processingComplete", + "localRole": "False for an accepted nonterminal processing result." + }, + { + "outputField": "deliveryPending", + "localRole": "True while a confirmed commit remains nonterminal or post-commit resolution remains required." + }, + { + "outputField": "retrySafe", + "localRole": "False after any unresolved reservation or commit; true only before reservation or after confirmed rollback." + }, + { + "outputField": "cleanup", + "localRole": "Exact rollback outcome or executable get/delete guidance for a retained known reservation." + }, + { + "outputField": "reservationFingerprint", + "localRole": "Ambiguous-reservation fileName/fileSize hints only; never a unique attribution claim." + }, + { + "outputField": "sourceFileChecksumReceipt", + "localRole": "Local immutable-snapshot checksum receipt kept separate from reservation candidate matching." + }, + { + "outputField": "operationCommitState", + "localRole": "Stable unknown or committed_unverified discriminator on unresolved outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable fully paginated parent-set inspection guidance." + }, + { + "outputField": "reconciledAfterCommit", + "localRole": "True when exact-ID GET reconciliation supplied the final accepted state." + }, + { + "outputField": "error", + "localRole": "Redacted diagnostic for rejected, terminal, or unresolved upload outcomes." + }, + { + "outputField": "resourceId", + "localRole": "Canonical known reservation ID on retained or failed outcomes." + }, + { + "outputField": "screenshot_id", + "localRole": "Canonical known screenshot reservation ID for executable follow-up." + }, + { + "outputField": "reservationCreated", + "localRole": "False only when failure is proven to precede reservation creation." + }, + { + "outputField": "reservationDeleted", + "localRole": "Whether a known pre-commit reservation was confirmed deleted." + }, + { + "outputField": "reservationState", + "localRole": "Rejected, unknown, or committed-unverified reservation classification." + }, + { + "outputField": "reservationIdKnown", + "localRole": "Whether an ambiguous reservation outcome produced a canonical resource ID." + }, + { + "outputField": "operationCommitted", + "localRole": "True only for a confirmed accepted-but-unverified reservation, commit, or cleanup response." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when reservation or cleanup commitment cannot be determined." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when exact-resource or full parent-set inspection is required before retry." + }, + { + "outputField": "statusCode", + "localRole": "Unexpected successful Apple status retained for recovery classification." + } ] }, "note": "The handler accepts only a canonical set ID and an absolute readable regular-file path, creates one immutable snapshot before network I/O, and binds the POST reservation to that snapshot's exact fileName, fileSize, and optional returned checksum. Transfer requires exact POST 201, required document links.self, canonical appScreenshots identity, AWAITING_UPLOAD, and requested-set proof: contradictory returned linkage is rejected, while omitted optional linkage is confirmed through the fully paginated parent-set inventory before transfer. Resource links.self is optional but must match the configured origin and exact resource path when present; every continuation is scoped likewise, and root-relative links are accepted. The same snapshot bytes produce the checksum receipt and commit body, and only PATCH 200 is a confirmed commit response. Any returned post-commit fileName, fileSize, or checksum must still match the snapshot. A semantic conflict in a confirmed PATCH 200 response is latched and cannot be converted into success by a later valid GET. COMPLETE is successful, FAILED is terminal failure, and other states remain processing-pending. Ambiguous reservation outcomes expose a 200-item parent inspection with next_url guidance and a fileName/fileSize candidate fingerprint; the local checksum receipt is separate and is not a server-side candidate field." @@ -1198,20 +2803,32 @@ "role": "supporting", "condition": "Repeated once per local file to reserve each asset.", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appScreenshots" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appScreenshots" + }, { "sourceKind": "derived", "jsonPointer": "/data/attributes/fileName", - "derivedFrom": ["file_paths"], + "derivedFrom": [ + "file_paths" + ], "localRole": "Derive each reservation file name from its immutable snapshot after every batch item has passed local preflight." }, { "sourceKind": "derived", "jsonPointer": "/data/attributes/fileSize", - "derivedFrom": ["file_paths"], + "derivedFrom": [ + "file_paths" + ], "localRole": "Use each immutable snapshot size after every batch item has passed local preflight." }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appScreenshotSet/data/type", "fixedValue": "appScreenshotSets" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appScreenshotSet/data/type", + "fixedValue": "appScreenshotSets" + } ] }, { @@ -1225,23 +2842,38 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appScreenshots_createInstance:/data/id"], + "derivedFrom": [ + "appScreenshots_createInstance:/data/id" + ], "localRole": "Use the current screenshot reservation ID for the matching batch item." }, { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["appScreenshots_createInstance:/data/id"], + "derivedFrom": [ + "appScreenshots_createInstance:/data/id" + ], "localRole": "Copy the current reservation ID into the matching commit resource identifier." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appScreenshots" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appScreenshots" + }, { "sourceKind": "derived", "jsonPointer": "/data/attributes/sourceFileChecksum", - "derivedFrom": ["file_paths", "appScreenshots_createInstance:/data/attributes/uploadOperations"], + "derivedFrom": [ + "file_paths", + "appScreenshots_createInstance:/data/attributes/uploadOperations" + ], "localRole": "Use the local MD5 of the current item's immutable snapshot bytes after their successful signed transfer." }, - { "sourceKind": "fixed", "jsonPointer": "/data/attributes/uploaded", "fixedValue": true } + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/uploaded", + "fixedValue": true + } ] }, { @@ -1256,7 +2888,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Each conditional GET only reconciles that appScreenshot's assetDeliveryState; Apple's appScreenshotSet inclusion cannot affect batch processing classification and the upload decoder intentionally ignores included resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ], "inputs": [ @@ -1264,7 +2896,9 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appScreenshots_createInstance:/data/id"], + "derivedFrom": [ + "appScreenshots_createInstance:/data/id" + ], "localRole": "Inspect only the current batch item's reservation." } ] @@ -1276,10 +2910,21 @@ "role": "conditional", "condition": "For any batch reservation whose POST 201 omits optional appScreenshotSet linkage, fully paginate the exact requested set collection before that item's byte transfer and require its reservation ID to be present.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact appScreenshotSet relationship path proves set scope; optional returned linkage is validated when present and any contradiction is rejected.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The exact appScreenshotSet relationship path proves set scope; optional returned linkage is validated when present and any contradiction is rejected.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1293,64 +2938,216 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appScreenshots_createInstance:/data/id"], + "derivedFrom": [ + "appScreenshots_createInstance:/data/id" + ], "localRole": "Rollback only the current batch item's known reservation." } ] } ], "fields": [ - { "toolField": "set_id", "sourceKind": "requestBody", "operationId": "appScreenshots_createInstance", "jsonPointer": "/data/relationships/appScreenshotSet/data/id" }, - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "file_paths", "sourceKind": "local", "localRole": "Validate all 1...50 paths as absolute readable regular files and create every immutable snapshot before the first reservation; derive each item's fileName, fileSize, transfer bytes, and sourceFileChecksum from its snapshot.", "derivedFrom": ["per-file fileName", "per-file fileSize", "per-file sourceFileChecksum"] } + { + "toolField": "set_id", + "sourceKind": "requestBody", + "operationId": "appScreenshots_createInstance", + "jsonPointer": "/data/relationships/appScreenshotSet/data/id" + }, + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "file_paths", + "sourceKind": "local", + "localRole": "Validate all 1...50 paths as absolute readable regular files and create every immutable snapshot before the first reservation; derive each item's fileName, fileSize, transfer bytes, and sourceFileChecksum from its snapshot.", + "derivedFrom": [ + "per-file fileName", + "per-file fileSize", + "per-file sourceFileChecksum" + ] + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "appScreenshots_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "appScreenshots_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appScreenshots_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appScreenshots_deleteInstance", "statusCode": "204" } + { + "operationId": "appScreenshots_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appScreenshots_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appScreenshots_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appScreenshots_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "True only when every independently reported item succeeds or remains confirmed processing-pending." }, - { "outputField": "total", "localRole": "Validated batch item count from 1 through 50." }, - { "outputField": "uploaded", "localRole": "Count of COMPLETE and confirmed processing-pending item outcomes." }, - { "outputField": "failed", "localRole": "Count of failed or unresolved item outcomes." }, - { "outputField": "results", "localRole": "Ordered per-file redacted outcome projections; remote work is sequential and not atomic." }, - { "outputField": "results.*.file", "localRole": "Immutable snapshot file name for the matching input item." }, - { "outputField": "results.*.screenshot_id", "localRole": "Canonical known screenshot reservation ID across success, processing-pending, or structured failure outcomes." }, - { "outputField": "results.*.state", "localRole": "Latest validated Apple delivery state for a known item." }, - { "outputField": "results.*.upload_committed", "localRole": "True only for a confirmed processing-pending exact-200 commit." }, - { "outputField": "results.*.delivery_pending", "localRole": "True only while a confirmed item commit remains nonterminal." }, - { "outputField": "results.*.retry_safe", "localRole": "Per-item retry safety; false for retained or unresolved reservations and commits." }, - { "outputField": "results.*.inspection", "localRole": "Per-item exact-resource or fully paginated set inspection guidance on ambiguous outcomes." }, - { "outputField": "results.*.success", "localRole": "Per-item success discriminator across complete, processing-pending, and failure outcomes." }, - { "outputField": "results.*.processing_complete", "localRole": "False for a successful item whose confirmed commit remains nonterminal." }, - { "outputField": "results.*.reconciled_after_commit", "localRole": "True when exact-ID reconciliation supplied the accepted item state." }, - { "outputField": "results.*.inspect_tool", "localRole": "Exact single-resource inspection tool for a processing-pending item." }, - { "outputField": "results.*.inspect_arguments", "localRole": "Canonical exact-resource arguments for the processing-pending inspection tool." }, - { "outputField": "results.*.inspect_arguments.screenshot_id", "localRole": "Canonical screenshot ID passed to screenshots_get for processing-pending inspection." }, - { "outputField": "results.*.error", "localRole": "Redacted per-item diagnostic for rejected, terminal, or unresolved outcomes." }, - { "outputField": "results.*.screenshot", "localRole": "Validated redacted screenshot projection on known failure or retained outcomes." }, - { "outputField": "results.*.resourceId", "localRole": "Canonical known reservation ID on retained or failed item outcomes." }, - { "outputField": "results.*.reservationCreated", "localRole": "False only when the item failure is proven to precede reservation creation." }, - { "outputField": "results.*.reservationDeleted", "localRole": "Whether the item's known pre-commit reservation was confirmed deleted." }, - { "outputField": "results.*.reservationState", "localRole": "Rejected, unknown, or committed-unverified reservation classification for the item." }, - { "outputField": "results.*.reservationIdKnown", "localRole": "Whether an ambiguous item reservation produced a canonical resource ID." }, - { "outputField": "results.*.operationCommitState", "localRole": "Stable unknown or committed-unverified discriminator for unresolved item outcomes." }, - { "outputField": "results.*.operationCommitted", "localRole": "True only for a confirmed accepted-but-unverified reservation, commit, or cleanup response." }, - { "outputField": "results.*.outcomeUnknown", "localRole": "True when item reservation or cleanup commitment cannot be determined." }, - { "outputField": "results.*.inspectionRequired", "localRole": "True when item inspection is required before retry." }, - { "outputField": "results.*.retrySafe", "localRole": "Camel-case retry classification inherited from structured failure payloads." }, - { "outputField": "results.*.cleanup", "localRole": "Exact rollback outcome or executable retained-resource guidance for the item." }, - { "outputField": "results.*.reservationFingerprint", "localRole": "Ambiguous item reservation fileName/fileSize hints only; never a unique attribution claim." }, - { "outputField": "results.*.sourceFileChecksumReceipt", "localRole": "Local immutable-snapshot checksum receipt kept separate from candidate matching." }, - { "outputField": "results.*.statusCode", "localRole": "Unexpected successful Apple status retained for item recovery classification." }, - { "outputField": "results.*.uploadCommitted", "localRole": "True for a confirmed commit represented by a structured failure or pending payload." }, - { "outputField": "results.*.processingComplete", "localRole": "False for a committed-but-unverified structured item payload." }, - { "outputField": "results.*.deliveryPending", "localRole": "Camel-case delivery-pending classification inherited from structured item payloads." } + { + "outputField": "success", + "localRole": "True only when every independently reported item succeeds or remains confirmed processing-pending." + }, + { + "outputField": "total", + "localRole": "Validated batch item count from 1 through 50." + }, + { + "outputField": "uploaded", + "localRole": "Count of COMPLETE and confirmed processing-pending item outcomes." + }, + { + "outputField": "failed", + "localRole": "Count of failed or unresolved item outcomes." + }, + { + "outputField": "results", + "localRole": "Ordered per-file redacted outcome projections; remote work is sequential and not atomic." + }, + { + "outputField": "results.*.file", + "localRole": "Immutable snapshot file name for the matching input item." + }, + { + "outputField": "results.*.screenshot_id", + "localRole": "Canonical known screenshot reservation ID across success, processing-pending, or structured failure outcomes." + }, + { + "outputField": "results.*.state", + "localRole": "Latest validated Apple delivery state for a known item." + }, + { + "outputField": "results.*.upload_committed", + "localRole": "True only for a confirmed processing-pending exact-200 commit." + }, + { + "outputField": "results.*.delivery_pending", + "localRole": "True only while a confirmed item commit remains nonterminal." + }, + { + "outputField": "results.*.retry_safe", + "localRole": "Per-item retry safety; false for retained or unresolved reservations and commits." + }, + { + "outputField": "results.*.inspection", + "localRole": "Per-item exact-resource or fully paginated set inspection guidance on ambiguous outcomes." + }, + { + "outputField": "results.*.success", + "localRole": "Per-item success discriminator across complete, processing-pending, and failure outcomes." + }, + { + "outputField": "results.*.processing_complete", + "localRole": "False for a successful item whose confirmed commit remains nonterminal." + }, + { + "outputField": "results.*.reconciled_after_commit", + "localRole": "True when exact-ID reconciliation supplied the accepted item state." + }, + { + "outputField": "results.*.inspect_tool", + "localRole": "Exact single-resource inspection tool for a processing-pending item." + }, + { + "outputField": "results.*.inspect_arguments", + "localRole": "Canonical exact-resource arguments for the processing-pending inspection tool." + }, + { + "outputField": "results.*.inspect_arguments.screenshot_id", + "localRole": "Canonical screenshot ID passed to screenshots_get for processing-pending inspection." + }, + { + "outputField": "results.*.error", + "localRole": "Redacted per-item diagnostic for rejected, terminal, or unresolved outcomes." + }, + { + "outputField": "results.*.screenshot", + "localRole": "Validated redacted screenshot projection on known failure or retained outcomes." + }, + { + "outputField": "results.*.resourceId", + "localRole": "Canonical known reservation ID on retained or failed item outcomes." + }, + { + "outputField": "results.*.reservationCreated", + "localRole": "False only when the item failure is proven to precede reservation creation." + }, + { + "outputField": "results.*.reservationDeleted", + "localRole": "Whether the item's known pre-commit reservation was confirmed deleted." + }, + { + "outputField": "results.*.reservationState", + "localRole": "Rejected, unknown, or committed-unverified reservation classification for the item." + }, + { + "outputField": "results.*.reservationIdKnown", + "localRole": "Whether an ambiguous item reservation produced a canonical resource ID." + }, + { + "outputField": "results.*.operationCommitState", + "localRole": "Stable unknown or committed-unverified discriminator for unresolved item outcomes." + }, + { + "outputField": "results.*.operationCommitted", + "localRole": "True only for a confirmed accepted-but-unverified reservation, commit, or cleanup response." + }, + { + "outputField": "results.*.outcomeUnknown", + "localRole": "True when item reservation or cleanup commitment cannot be determined." + }, + { + "outputField": "results.*.inspectionRequired", + "localRole": "True when item inspection is required before retry." + }, + { + "outputField": "results.*.retrySafe", + "localRole": "Camel-case retry classification inherited from structured failure payloads." + }, + { + "outputField": "results.*.cleanup", + "localRole": "Exact rollback outcome or executable retained-resource guidance for the item." + }, + { + "outputField": "results.*.reservationFingerprint", + "localRole": "Ambiguous item reservation fileName/fileSize hints only; never a unique attribution claim." + }, + { + "outputField": "results.*.sourceFileChecksumReceipt", + "localRole": "Local immutable-snapshot checksum receipt kept separate from candidate matching." + }, + { + "outputField": "results.*.statusCode", + "localRole": "Unexpected successful Apple status retained for item recovery classification." + }, + { + "outputField": "results.*.uploadCommitted", + "localRole": "True for a confirmed commit represented by a structured failure or pending payload." + }, + { + "outputField": "results.*.processingComplete", + "localRole": "False for a committed-but-unverified structured item payload." + }, + { + "outputField": "results.*.deliveryPending", + "localRole": "Camel-case delivery-pending classification inherited from structured item payloads." + } ] }, "note": "The batch is preflight-atomic only: all 1...50 unique paths must be absolute readable regular files and every immutable snapshot must be ready before the first Apple reservation. Remote operations are deliberately sequential and per-item, not remotely atomic; earlier committed items are not rolled back when a later item fails. Each item requires exact POST 201 and PATCH 200 responses, required document links.self, canonical identity, snapshot-matching fileName/fileSize/optional checksum, and AWAITING_UPLOAD. Contradictory set linkage is rejected; omitted optional linkage is confirmed through the fully paginated parent-set inventory before transfer. Resource links.self is optional but exact when present, and continuation links stay on the configured origin and endpoint scope. Returned post-commit snapshot evidence is validated when present. A semantic conflict in a confirmed PATCH 200 response is latched and cannot be laundered into success by later reconciliation. COMPLETE, FAILED, pending, rollback, and ambiguous-recovery outcomes are reported independently per item." @@ -1369,20 +3166,32 @@ "role": "supporting", "condition": "Reserves the video asset and returns signed upload operations.", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appPreviews" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appPreviews" + }, { "sourceKind": "derived", "jsonPointer": "/data/attributes/fileName", - "derivedFrom": ["file_path"], + "derivedFrom": [ + "file_path" + ], "localRole": "Derive the reservation file name from the immutable video snapshot prepared before reservation." }, { "sourceKind": "derived", "jsonPointer": "/data/attributes/fileSize", - "derivedFrom": ["file_path"], + "derivedFrom": [ + "file_path" + ], "localRole": "Use the immutable video snapshot size captured before reserving the asset." }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/appPreviewSet/data/type", "fixedValue": "appPreviewSets" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/appPreviewSet/data/type", + "fixedValue": "appPreviewSets" + } ] }, { @@ -1396,23 +3205,38 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appPreviews_createInstance:/data/id"], + "derivedFrom": [ + "appPreviews_createInstance:/data/id" + ], "localRole": "Use the preview ID returned by the reservation response." }, { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["appPreviews_createInstance:/data/id"], + "derivedFrom": [ + "appPreviews_createInstance:/data/id" + ], "localRole": "Copy the reservation response ID into the commit resource identifier." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "appPreviews" }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "appPreviews" + }, { "sourceKind": "derived", "jsonPointer": "/data/attributes/sourceFileChecksum", - "derivedFrom": ["file_path", "appPreviews_createInstance:/data/attributes/uploadOperations"], + "derivedFrom": [ + "file_path", + "appPreviews_createInstance:/data/attributes/uploadOperations" + ], "localRole": "Use the local MD5 of the same immutable video snapshot bytes after their successful signed transfer." }, - { "sourceKind": "fixed", "jsonPointer": "/data/attributes/uploaded", "fixedValue": true } + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/uploaded", + "fixedValue": true + } ] }, { @@ -1427,7 +3251,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "This conditional GET only reconciles the reserved appPreview's videoDeliveryState or assetDeliveryState; Apple's appPreviewSet inclusion cannot affect processing classification and the upload decoder intentionally ignores included resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ], "inputs": [ @@ -1435,7 +3259,9 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appPreviews_createInstance:/data/id"], + "derivedFrom": [ + "appPreviews_createInstance:/data/id" + ], "localRole": "Inspect the exact preview created by the reservation operation." } ] @@ -1447,10 +3273,21 @@ "role": "conditional", "condition": "When POST 201 omits optional appPreviewSet relationship linkage, fully paginate the exact requested set collection before byte transfer and require the reservation ID to be present.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + } ], "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The exact appPreviewSet relationship path proves set scope; optional returned linkage is validated when present and any contradiction is rejected.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The exact appPreviewSet relationship path proves set scope; optional returned linkage is validated when present and any contradiction is rejected.", + "reviewAtSpec": "4.6" + } ] }, { @@ -1464,58 +3301,201 @@ "sourceKind": "derived", "location": "path", "appleName": "id", - "derivedFrom": ["appPreviews_createInstance:/data/id"], + "derivedFrom": [ + "appPreviews_createInstance:/data/id" + ], "localRole": "Rollback only the known reservation for this upload attempt." } ] } ], "fields": [ - { "toolField": "set_id", "sourceKind": "requestBody", "operationId": "appPreviews_createInstance", "jsonPointer": "/data/relationships/appPreviewSet/data/id" }, - { "toolField": "set_id", "sourceKind": "parameter", "operationId": "appPreviewSets_appPreviews_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "file_path", "sourceKind": "local", "localRole": "Create an immutable temporary snapshot before reservation, then derive fileName, fileSize, transfer bytes, and sourceFileChecksum from that same snapshot.", "derivedFrom": ["fileName", "fileSize", "sourceFileChecksum"] }, - { "toolField": "mime_type", "sourceKind": "requestBody", "operationId": "appPreviews_createInstance", "jsonPointer": "/data/attributes/mimeType", "localRole": "Omission preserves compatibility by sending video/mp4; explicit null asks Apple to infer the type; any concrete non-empty MIME string allowed by Apple 4.4.1 is preserved after whitespace validation." }, - { "toolField": "preview_frame_time_code", "sourceKind": "requestBody", "operationId": "appPreviews_createInstance", "jsonPointer": "/data/attributes/previewFrameTimeCode", "localRole": "Omission leaves the attribute absent, explicit null is preserved, and a concrete non-empty value is sent on both reservation and commit." }, - { "toolField": "preview_frame_time_code", "sourceKind": "requestBody", "operationId": "appPreviews_updateInstance", "jsonPointer": "/data/attributes/previewFrameTimeCode", "localRole": "Omission leaves the attribute absent, explicit null is preserved, and a concrete non-empty value is sent on both reservation and commit." } + { + "toolField": "set_id", + "sourceKind": "requestBody", + "operationId": "appPreviews_createInstance", + "jsonPointer": "/data/relationships/appPreviewSet/data/id" + }, + { + "toolField": "set_id", + "sourceKind": "parameter", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "file_path", + "sourceKind": "local", + "localRole": "Create an immutable temporary snapshot before reservation, then derive fileName, fileSize, transfer bytes, and sourceFileChecksum from that same snapshot.", + "derivedFrom": [ + "fileName", + "fileSize", + "sourceFileChecksum" + ] + }, + { + "toolField": "mime_type", + "sourceKind": "requestBody", + "operationId": "appPreviews_createInstance", + "jsonPointer": "/data/attributes/mimeType", + "localRole": "Omission preserves compatibility by sending video/mp4; explicit null asks Apple to infer the type; any concrete non-empty MIME string allowed by Apple 4.4.1 is preserved after whitespace validation." + }, + { + "toolField": "preview_frame_time_code", + "sourceKind": "requestBody", + "operationId": "appPreviews_createInstance", + "jsonPointer": "/data/attributes/previewFrameTimeCode", + "localRole": "Omission leaves the attribute absent, explicit null is preserved, and a concrete non-empty value is sent on both reservation and commit." + }, + { + "toolField": "preview_frame_time_code", + "sourceKind": "requestBody", + "operationId": "appPreviews_updateInstance", + "jsonPointer": "/data/attributes/previewFrameTimeCode", + "localRole": "Omission leaves the attribute absent, explicit null is preserved, and a concrete non-empty value is sent on both reservation and commit." + } ], "response": { "mode": "aggregate", "sources": [ - { "operationId": "appPreviews_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "appPreviews_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appPreviews_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appPreviewSets_appPreviews_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appPreviews_deleteInstance", "statusCode": "204" } + { + "operationId": "appPreviews_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appPreviews_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appPreviews_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appPreviews_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "success", "localRole": "True only for COMPLETE or a semantically valid exact-200 commit that remains processing-pending." }, - { "outputField": "preview", "localRole": "Validated redacted preview projection selected from the reservation, commit, or exact-ID reconciliation response; signed URLs and headers are omitted." }, - { "outputField": "preview.previewFrameTimeCode", "localRole": "Apple preview frame time code from the selected validated response." }, - { "outputField": "preview.previewFrameImage", "localRole": "Apple current preview-frame image projection from the selected validated response." }, - { "outputField": "preview.previewImage", "localRole": "Deprecated Apple previewImage projection retained for compatibility when supplied." }, - { "outputField": "preview.assetDeliveryState.warnings", "localRole": "Warnings from Apple's deprecated asset delivery state when supplied." }, - { "outputField": "preview.videoDeliveryState.warnings", "localRole": "Warnings from Apple's current video delivery state when supplied." }, - { "outputField": "uploadCommitted", "localRole": "True only after exact PATCH 200 without a latched identity, lineage, or link-scope conflict." }, - { "outputField": "processingComplete", "localRole": "False for an accepted nonterminal processing result." }, - { "outputField": "deliveryPending", "localRole": "True while a confirmed commit remains nonterminal or post-commit resolution remains required." }, - { "outputField": "retrySafe", "localRole": "False after any unresolved reservation or commit; true only before reservation or after confirmed rollback." }, - { "outputField": "cleanup", "localRole": "Exact rollback outcome or executable get/delete guidance for a retained known reservation." }, - { "outputField": "reservationFingerprint", "localRole": "Ambiguous-reservation fileName/fileSize hints only; never a unique attribution claim." }, - { "outputField": "sourceFileChecksumReceipt", "localRole": "Local immutable-snapshot checksum receipt kept separate from reservation candidate matching." }, - { "outputField": "operationCommitState", "localRole": "Stable unknown or committed_unverified discriminator on unresolved outcomes." }, - { "outputField": "inspection", "localRole": "Executable fully paginated parent-set inspection guidance." }, - { "outputField": "reconciledAfterCommit", "localRole": "True when exact-ID GET reconciliation supplied the final accepted state." }, - { "outputField": "error", "localRole": "Redacted diagnostic for rejected, terminal, or unresolved upload outcomes." }, - { "outputField": "resourceId", "localRole": "Canonical known reservation ID on retained or failed outcomes." }, - { "outputField": "preview_id", "localRole": "Canonical known preview reservation ID for executable follow-up." }, - { "outputField": "reservationCreated", "localRole": "False only when failure is proven to precede reservation creation." }, - { "outputField": "reservationDeleted", "localRole": "Whether a known pre-commit reservation was confirmed deleted." }, - { "outputField": "reservationState", "localRole": "Rejected, unknown, or committed-unverified reservation classification." }, - { "outputField": "reservationIdKnown", "localRole": "Whether an ambiguous reservation outcome produced a canonical resource ID." }, - { "outputField": "operationCommitted", "localRole": "True only for a confirmed accepted-but-unverified reservation, commit, or cleanup response." }, - { "outputField": "outcomeUnknown", "localRole": "True when reservation or cleanup commitment cannot be determined." }, - { "outputField": "inspectionRequired", "localRole": "True when exact-resource or full parent-set inspection is required before retry." }, - { "outputField": "statusCode", "localRole": "Unexpected successful Apple status retained for recovery classification." } + { + "outputField": "success", + "localRole": "True only for COMPLETE or a semantically valid exact-200 commit that remains processing-pending." + }, + { + "outputField": "preview", + "localRole": "Validated redacted preview projection selected from the reservation, commit, or exact-ID reconciliation response; signed URLs and headers are omitted." + }, + { + "outputField": "preview.previewFrameTimeCode", + "localRole": "Apple preview frame time code from the selected validated response." + }, + { + "outputField": "preview.previewFrameImage", + "localRole": "Apple current preview-frame image projection from the selected validated response." + }, + { + "outputField": "preview.previewImage", + "localRole": "Deprecated Apple previewImage projection retained for compatibility when supplied." + }, + { + "outputField": "preview.assetDeliveryState.warnings", + "localRole": "Warnings from Apple's deprecated asset delivery state when supplied." + }, + { + "outputField": "preview.videoDeliveryState.warnings", + "localRole": "Warnings from Apple's current video delivery state when supplied." + }, + { + "outputField": "uploadCommitted", + "localRole": "True only after exact PATCH 200 without a latched identity, lineage, or link-scope conflict." + }, + { + "outputField": "processingComplete", + "localRole": "False for an accepted nonterminal processing result." + }, + { + "outputField": "deliveryPending", + "localRole": "True while a confirmed commit remains nonterminal or post-commit resolution remains required." + }, + { + "outputField": "retrySafe", + "localRole": "False after any unresolved reservation or commit; true only before reservation or after confirmed rollback." + }, + { + "outputField": "cleanup", + "localRole": "Exact rollback outcome or executable get/delete guidance for a retained known reservation." + }, + { + "outputField": "reservationFingerprint", + "localRole": "Ambiguous-reservation fileName/fileSize hints only; never a unique attribution claim." + }, + { + "outputField": "sourceFileChecksumReceipt", + "localRole": "Local immutable-snapshot checksum receipt kept separate from reservation candidate matching." + }, + { + "outputField": "operationCommitState", + "localRole": "Stable unknown or committed_unverified discriminator on unresolved outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable fully paginated parent-set inspection guidance." + }, + { + "outputField": "reconciledAfterCommit", + "localRole": "True when exact-ID GET reconciliation supplied the final accepted state." + }, + { + "outputField": "error", + "localRole": "Redacted diagnostic for rejected, terminal, or unresolved upload outcomes." + }, + { + "outputField": "resourceId", + "localRole": "Canonical known reservation ID on retained or failed outcomes." + }, + { + "outputField": "preview_id", + "localRole": "Canonical known preview reservation ID for executable follow-up." + }, + { + "outputField": "reservationCreated", + "localRole": "False only when failure is proven to precede reservation creation." + }, + { + "outputField": "reservationDeleted", + "localRole": "Whether a known pre-commit reservation was confirmed deleted." + }, + { + "outputField": "reservationState", + "localRole": "Rejected, unknown, or committed-unverified reservation classification." + }, + { + "outputField": "reservationIdKnown", + "localRole": "Whether an ambiguous reservation outcome produced a canonical resource ID." + }, + { + "outputField": "operationCommitted", + "localRole": "True only for a confirmed accepted-but-unverified reservation, commit, or cleanup response." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when reservation or cleanup commitment cannot be determined." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when exact-resource or full parent-set inspection is required before retry." + }, + { + "outputField": "statusCode", + "localRole": "Unexpected successful Apple status retained for recovery classification." + } ] }, "note": "The handler accepts only a canonical set ID and an absolute readable regular-file path, snapshots the video before network I/O, and binds the reservation to that snapshot's fileName, fileSize, and optional returned checksum. Transfer requires exact POST 201, required document links.self, canonical appPreviews identity, AWAITING_UPLOAD videoDeliveryState (deprecated assetDeliveryState fallback), and requested-set proof: contradictory linkage is rejected, while omitted optional linkage is confirmed through the fully paginated parent-set inventory before transfer. Resource links.self is optional but exact when present; every continuation remains on the configured origin and endpoint scope. The same bytes produce the separate checksum receipt and commit body, and only PATCH 200 confirms the commit response; returned post-commit snapshot evidence is validated when present. A semantic conflict in a confirmed PATCH 200 response is latched and cannot be converted into success by a later valid GET. Nullable previewFrameTimeCode preserves omission, explicit null, and value; mimeType preserves its compatibility default and explicit null. Ambiguous reservations use a 200-item parent inspection with next_url and fileName/fileSize candidate matching, never checksum as a server-side candidate field." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/subscriptions.json b/Sources/asc-mcp/Resources/OperationManifest/tools/subscriptions.json index e3024cf..24b4204 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/subscriptions.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/subscriptions.json @@ -75,7 +75,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -137,7 +141,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodeCustomCodes_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodeCustomCodes_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -187,7 +195,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionGroups_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionGroups_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -249,7 +261,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionGroupLocalizations_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionGroupLocalizations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -274,7 +290,7 @@ "appleName": "/included", "disposition": "intentionallyOmitted", "reason": "The tool links an existing subscription price point by ID. Apple's inline price-point graph adds no independent caller value and would duplicate typed price-point discovery and validation.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ], "inputs": [ @@ -362,7 +378,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionIntroductoryOffers_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionIntroductoryOffers_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -424,7 +444,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionLocalizations_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionLocalizations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -544,7 +568,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodes_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodes_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -612,26 +640,95 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "subscriptionPlanAvailabilities_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionPlanAvailabilities_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after Apple creates the resource." }, - { "outputField": "plan_availability.id", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/id" }, - { "outputField": "plan_availability.type", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/type" }, - { "outputField": "plan_availability.plan_type", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/attributes/planType" }, - { "outputField": "plan_availability.available_in_new_territories", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/attributes/availableInNewTerritories" }, - { "outputField": "plan_availability.available_territory_ids", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/relationships/availableTerritories/data/*/id" }, - { "outputField": "plan_availability.available_territories", "localRole": "Build one projected territory per availableTerritories linkage; emit null when Apple omits linkage data." }, - { "outputField": "plan_availability.available_territories.*.id", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/relationships/availableTerritories/data/*/id" }, - { "outputField": "plan_availability.available_territories.*.type", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/relationships/availableTerritories/data/*/type" }, - { "outputField": "plan_availability.available_territories.*.currency", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/included", "localRole": "Join the included territory matching each availableTerritories linkage ID; emit null when it is not included." }, - { "outputField": "plan_availability.available_territories_total", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/relationships/availableTerritories/meta/paging/total" }, - { "outputField": "plan_availability.available_territories_limit", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/relationships/availableTerritories/meta/paging/limit" }, - { "outputField": "plan_availability.available_territories_count", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/relationships/availableTerritories/data", "localRole": "Count the availableTerritories relationship identifiers; emit null when Apple omits linkage data." }, - { "outputField": "plan_availability.available_territories_next_cursor", "operationId": "subscriptionPlanAvailabilities_createInstance", "jsonPointer": "/data/relationships/availableTerritories/meta/paging/nextCursor" }, - { "outputField": "plan_availability.available_territories_included_count", "localRole": "Count related identifiers with a matching included territory resource; emit null when linkage data is absent." }, - { "outputField": "plan_availability.available_territories_truncated", "localRole": "True when Apple supplies a next cursor or the relationship total exceeds its identifier count; emit null when linkage data is absent and truncation cannot be determined." }, - { "outputField": "plan_availability.available_territories_completeness_known", "localRole": "When linkage data is present, report whether Apple supplied a relationship total or next cursor; otherwise emit null." } + { + "outputField": "success", + "localRole": "Set true after Apple creates the resource." + }, + { + "outputField": "plan_availability.id", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "plan_availability.type", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "plan_availability.plan_type", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/attributes/planType" + }, + { + "outputField": "plan_availability.available_in_new_territories", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/attributes/availableInNewTerritories" + }, + { + "outputField": "plan_availability.available_territory_ids", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/relationships/availableTerritories/data/*/id" + }, + { + "outputField": "plan_availability.available_territories", + "localRole": "Build one projected territory per availableTerritories linkage; emit null when Apple omits linkage data." + }, + { + "outputField": "plan_availability.available_territories.*.id", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/relationships/availableTerritories/data/*/id" + }, + { + "outputField": "plan_availability.available_territories.*.type", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/relationships/availableTerritories/data/*/type" + }, + { + "outputField": "plan_availability.available_territories.*.currency", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/included", + "localRole": "Join the included territory matching each availableTerritories linkage ID; emit null when it is not included." + }, + { + "outputField": "plan_availability.available_territories_total", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/relationships/availableTerritories/meta/paging/total" + }, + { + "outputField": "plan_availability.available_territories_limit", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/relationships/availableTerritories/meta/paging/limit" + }, + { + "outputField": "plan_availability.available_territories_count", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/relationships/availableTerritories/data", + "localRole": "Count the availableTerritories relationship identifiers; emit null when Apple omits linkage data." + }, + { + "outputField": "plan_availability.available_territories_next_cursor", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "jsonPointer": "/data/relationships/availableTerritories/meta/paging/nextCursor" + }, + { + "outputField": "plan_availability.available_territories_included_count", + "localRole": "Count related identifiers with a matching included territory resource; emit null when linkage data is absent." + }, + { + "outputField": "plan_availability.available_territories_truncated", + "localRole": "True when Apple supplies a next cursor or the relationship total exceeds its identifier count; emit null when linkage data is absent and truncation cannot be determined." + }, + { + "outputField": "plan_availability.available_territories_completeness_known", + "localRole": "When linkage data is present, report whether Apple supplied a relationship total or next cursor; otherwise emit null." + } ] }, "note": "Implements Apple's plan-type-aware availability create contract with typed planType, exact JSON:API linkage, and nullable availableInNewTerritories semantics. An ambiguous POST or response decode returns write_outcome=not_confirmed, retrySafe=false, the complete requested availability fingerprint, and list/get recovery guidance instead of encouraging a duplicate create." @@ -714,7 +811,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionPrices_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionPrices_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -822,7 +923,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionPromotionalOffers_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionPromotionalOffers_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -977,7 +1082,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "winBackOffers_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "winBackOffers_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1030,7 +1139,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodeCustomCodes_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodeCustomCodes_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1083,7 +1196,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodes_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodes_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1116,7 +1233,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptions_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -1149,7 +1269,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionGroups_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptionGroups_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -1182,7 +1305,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionGroupLocalizations_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptionGroupLocalizations_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -1215,7 +1341,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionImages_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptionImages_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -1248,7 +1377,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionIntroductoryOffers_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptionIntroductoryOffers_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -1281,7 +1413,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionLocalizations_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptionLocalizations_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -1314,7 +1449,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionPrices_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptionPrices_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -1347,7 +1485,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionPromotionalOffers_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptionPromotionalOffers_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -1380,7 +1521,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionAppStoreReviewScreenshots_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptionAppStoreReviewScreenshots_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -1413,7 +1557,10 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "winBackOffers_deleteInstance", "statusCode": "204" } + { + "operationId": "winBackOffers_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -1475,7 +1622,11 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "subscriptionOfferCodeOneTimeUseCodes_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodeOneTimeUseCodes_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ { @@ -1514,70 +1665,84 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[images]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[introductoryOffers]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[offerCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[planAvailabilities]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[prices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[promotionalOffers]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptionLocalizations]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[versions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[winBackOffers]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionMessageOffers]", + "disposition": "intentionallyOmitted", + "reason": "Retention message offers are read through the dedicated subscriptions_list_retention_offers tool.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionOffers]", + "disposition": "intentionallyOmitted", + "reason": "Retention offers are read through the dedicated subscriptions_list_retention_offers tool.", + "reviewAtSpec": "4.6" } ] } @@ -1684,14 +1849,14 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[availableTerritories]", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1708,7 +1873,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_subscriptionAvailability_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_subscriptionAvailability_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1733,7 +1902,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1750,7 +1919,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodeCustomCodes_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodeCustomCodes_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1775,28 +1948,28 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptionGroupLocalizations]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[versions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1813,7 +1986,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionGroups_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionGroups_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1838,7 +2015,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1855,7 +2032,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionGroupLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionGroupLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1880,7 +2061,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1897,7 +2078,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionImages_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionImages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1922,7 +2107,7 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -1939,7 +2124,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionLocalizations_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1964,28 +2153,28 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[customCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[oneTimeUseCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[prices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2002,7 +2191,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodes_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodes_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2027,7 +2220,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2044,7 +2237,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodeOneTimeUseCodes_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodeOneTimeUseCodes_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2122,10 +2319,38 @@ "role": "primary", "condition": null, "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "include", "fixedValue": ["availableTerritories"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[subscriptionPlanAvailabilities]", "fixedValue": ["availableInNewTerritories", "planType", "availableTerritories"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[territories]", "fixedValue": ["currency"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "limit[availableTerritories]", "fixedValue": 50 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "include", + "fixedValue": [ + "availableTerritories" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[subscriptionPlanAvailabilities]", + "fixedValue": [ + "availableInNewTerritories", + "planType", + "availableTerritories" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[territories]", + "fixedValue": [ + "currency" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit[availableTerritories]", + "fixedValue": 50 + } ] } ], @@ -2141,26 +2366,95 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "subscriptionPlanAvailabilities_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionPlanAvailabilities_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after a successful Apple response." }, - { "outputField": "plan_availability.id", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/id" }, - { "outputField": "plan_availability.type", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/type" }, - { "outputField": "plan_availability.plan_type", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/attributes/planType" }, - { "outputField": "plan_availability.available_in_new_territories", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/attributes/availableInNewTerritories" }, - { "outputField": "plan_availability.available_territory_ids", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/relationships/availableTerritories/data/*/id" }, - { "outputField": "plan_availability.available_territories", "localRole": "Build one projected territory per availableTerritories linkage; emit null when Apple omits linkage data." }, - { "outputField": "plan_availability.available_territories.*.id", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/relationships/availableTerritories/data/*/id" }, - { "outputField": "plan_availability.available_territories.*.type", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/relationships/availableTerritories/data/*/type" }, - { "outputField": "plan_availability.available_territories.*.currency", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/included", "localRole": "Join the included territory matching each availableTerritories linkage ID; emit null when it is not included." }, - { "outputField": "plan_availability.available_territories_total", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/relationships/availableTerritories/meta/paging/total" }, - { "outputField": "plan_availability.available_territories_limit", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/relationships/availableTerritories/meta/paging/limit" }, - { "outputField": "plan_availability.available_territories_count", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/relationships/availableTerritories/data", "localRole": "Count the availableTerritories relationship identifiers; emit null when Apple omits linkage data." }, - { "outputField": "plan_availability.available_territories_next_cursor", "operationId": "subscriptionPlanAvailabilities_getInstance", "jsonPointer": "/data/relationships/availableTerritories/meta/paging/nextCursor" }, - { "outputField": "plan_availability.available_territories_included_count", "localRole": "Count related identifiers with a matching included territory resource; emit null when linkage data is absent." }, - { "outputField": "plan_availability.available_territories_truncated", "localRole": "True when Apple supplies a next cursor or the relationship total exceeds its identifier count; emit null when linkage data is absent and truncation cannot be determined." }, - { "outputField": "plan_availability.available_territories_completeness_known", "localRole": "When linkage data is present, report whether Apple supplied a relationship total or next cursor; otherwise emit null." } + { + "outputField": "success", + "localRole": "Set true after a successful Apple response." + }, + { + "outputField": "plan_availability.id", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "plan_availability.type", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "plan_availability.plan_type", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/attributes/planType" + }, + { + "outputField": "plan_availability.available_in_new_territories", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/attributes/availableInNewTerritories" + }, + { + "outputField": "plan_availability.available_territory_ids", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/relationships/availableTerritories/data/*/id" + }, + { + "outputField": "plan_availability.available_territories", + "localRole": "Build one projected territory per availableTerritories linkage; emit null when Apple omits linkage data." + }, + { + "outputField": "plan_availability.available_territories.*.id", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/relationships/availableTerritories/data/*/id" + }, + { + "outputField": "plan_availability.available_territories.*.type", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/relationships/availableTerritories/data/*/type" + }, + { + "outputField": "plan_availability.available_territories.*.currency", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/included", + "localRole": "Join the included territory matching each availableTerritories linkage ID; emit null when it is not included." + }, + { + "outputField": "plan_availability.available_territories_total", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/relationships/availableTerritories/meta/paging/total" + }, + { + "outputField": "plan_availability.available_territories_limit", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/relationships/availableTerritories/meta/paging/limit" + }, + { + "outputField": "plan_availability.available_territories_count", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/relationships/availableTerritories/data", + "localRole": "Count the availableTerritories relationship identifiers; emit null when Apple omits linkage data." + }, + { + "outputField": "plan_availability.available_territories_next_cursor", + "operationId": "subscriptionPlanAvailabilities_getInstance", + "jsonPointer": "/data/relationships/availableTerritories/meta/paging/nextCursor" + }, + { + "outputField": "plan_availability.available_territories_included_count", + "localRole": "Count related identifiers with a matching included territory resource; emit null when linkage data is absent." + }, + { + "outputField": "plan_availability.available_territories_truncated", + "localRole": "True when Apple supplies a next cursor or the relationship total exceeds its identifier count; emit null when linkage data is absent and truncation cannot be determined." + }, + { + "outputField": "plan_availability.available_territories_completeness_known", + "localRole": "When linkage data is present, report whether Apple supplied a relationship total or next cursor; otherwise emit null." + } ] }, "note": "Uses a fixed sparse-field projection and includes at most 50 related territories; callers use the dedicated paginated territory tool for the full collection." @@ -2184,7 +2478,7 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2201,7 +2495,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionPricePoints_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionPricePoints_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2226,7 +2524,7 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2243,7 +2541,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_promotedPurchase_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_promotedPurchase_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2268,14 +2570,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[prices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2292,7 +2594,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionPromotionalOffers_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionPromotionalOffers_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2317,7 +2623,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2334,7 +2640,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionAppStoreReviewScreenshots_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionAppStoreReviewScreenshots_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2359,7 +2669,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2376,7 +2686,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_appStoreReviewScreenshot_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_appStoreReviewScreenshot_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2401,14 +2715,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[prices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2425,7 +2739,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "winBackOffers_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "winBackOffers_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2450,49 +2768,49 @@ "appleName": "filter[referenceName]", "disposition": "intentionallyOmitted", "reason": "This deprecated compatibility inventory keeps its narrow legacy contract; authoritative list tools provide filtered discovery.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[subscriptions.state]", "disposition": "intentionallyOmitted", "reason": "This deprecated compatibility inventory keeps its narrow legacy contract; authoritative list tools provide filtered discovery.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptionGroupLocalizations]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[versions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "This deprecated compatibility inventory keeps its narrow legacy contract; authoritative list tools provide filtered discovery.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -2519,14 +2837,14 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[availableTerritories]", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -2553,28 +2871,28 @@ "appleName": "filter[planType]", "disposition": "intentionallyOmitted", "reason": "The current tool retains territory-focused pricing semantics; plan-aware selection requires a dedicated result contract.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[subscriptionPricePoint]", "disposition": "intentionallyOmitted", "reason": "The current tool retains territory-focused pricing semantics; plan-aware selection requires a dedicated result contract.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2605,9 +2923,21 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "apps_subscriptionGroups_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "subscriptions_prices_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "subscriptions_subscriptionAvailability_getToOneRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_subscriptionGroups_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptions_prices_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptions_subscriptionAvailability_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2632,70 +2962,84 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[images]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[introductoryOffers]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[offerCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[planAvailabilities]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[prices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[promotionalOffers]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptionLocalizations]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[versions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[winBackOffers]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionMessageOffers]", + "disposition": "intentionallyOmitted", + "reason": "Retention message offers are read through the dedicated subscriptions_list_retention_offers tool.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionOffers]", + "disposition": "intentionallyOmitted", + "reason": "Retention offers are read through the dedicated subscriptions_list_retention_offers tool.", + "reviewAtSpec": "4.6" } ] } @@ -2873,7 +3217,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionAvailabilities_availableTerritories_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionAvailabilities_availableTerritories_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2898,7 +3246,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -2927,7 +3275,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionGroups_subscriptionGroupLocalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionGroups_subscriptionGroupLocalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -2952,28 +3304,28 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptionGroupLocalizations]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[subscriptions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[versions]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3023,8 +3375,12 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "apps_subscriptionGroups_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } - ], + { + "operationId": "apps_subscriptionGroups_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], "fields": [] }, "note": "Apple 4.4.1 operation identity and all public inputs are classified; response remains opaque, so the semantic mapping is partial." @@ -3048,7 +3404,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3077,7 +3433,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_images_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_images_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3102,7 +3462,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3138,7 +3498,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_introductoryOffers_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_introductoryOffers_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3163,7 +3527,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3192,7 +3556,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_subscriptionLocalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_subscriptionLocalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3217,7 +3585,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3253,7 +3621,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodes_prices_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodes_prices_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3278,28 +3650,28 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[customCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[oneTimeUseCodes]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[prices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3335,7 +3707,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_offerCodes_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_offerCodes_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3360,7 +3736,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3389,7 +3765,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodes_oneTimeUseCodes_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodes_oneTimeUseCodes_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3409,10 +3789,38 @@ "role": "primary", "condition": null, "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "include", "fixedValue": ["availableTerritories"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[subscriptionPlanAvailabilities]", "fixedValue": ["availableInNewTerritories", "planType", "availableTerritories"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[territories]", "fixedValue": ["currency"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "limit[availableTerritories]", "fixedValue": 50 } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "include", + "fixedValue": [ + "availableTerritories" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[subscriptionPlanAvailabilities]", + "fixedValue": [ + "availableInNewTerritories", + "planType", + "availableTerritories" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[territories]", + "fixedValue": [ + "currency" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit[availableTerritories]", + "fixedValue": 50 + } ] } ], @@ -3440,30 +3848,117 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "subscriptions_planAvailabilities_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after a successful Apple response." }, - { "outputField": "plan_availabilities", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "plan_availabilities.*.id", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/id" }, - { "outputField": "plan_availabilities.*.type", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/type" }, - { "outputField": "plan_availabilities.*.plan_type", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/attributes/planType" }, - { "outputField": "plan_availabilities.*.available_in_new_territories", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/attributes/availableInNewTerritories" }, - { "outputField": "plan_availabilities.*.available_territory_ids", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/relationships/availableTerritories/data/*/id" }, - { "outputField": "plan_availabilities.*.available_territories", "localRole": "Build one projected territory per availability linkage; emit null when Apple omits linkage data." }, - { "outputField": "plan_availabilities.*.available_territories.*.id", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/relationships/availableTerritories/data/*/id" }, - { "outputField": "plan_availabilities.*.available_territories.*.type", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/relationships/availableTerritories/data/*/type" }, - { "outputField": "plan_availabilities.*.available_territories.*.currency", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/included", "localRole": "Join the included territory matching each availability linkage ID; emit null when it is not included." }, - { "outputField": "plan_availabilities.*.available_territories_total", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/relationships/availableTerritories/meta/paging/total" }, - { "outputField": "plan_availabilities.*.available_territories_limit", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/relationships/availableTerritories/meta/paging/limit" }, - { "outputField": "plan_availabilities.*.available_territories_count", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/relationships/availableTerritories/data", "localRole": "Count each availability's related territory identifiers; emit null when Apple omits linkage data." }, - { "outputField": "plan_availabilities.*.available_territories_next_cursor", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data/*/relationships/availableTerritories/meta/paging/nextCursor" }, - { "outputField": "plan_availabilities.*.available_territories_included_count", "localRole": "Count related identifiers with a matching included territory resource; emit null when linkage data is absent." }, - { "outputField": "plan_availabilities.*.available_territories_truncated", "localRole": "True when Apple supplies a next cursor or the relationship total exceeds its identifier count; emit null when linkage data is absent and truncation cannot be determined." }, - { "outputField": "plan_availabilities.*.available_territories_completeness_known", "localRole": "When linkage data is present, report whether Apple supplied a relationship total or next cursor; otherwise emit null." }, - { "outputField": "count", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/data", "localRole": "Current Apple page resource count." }, - { "outputField": "total", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "next_url", "operationId": "subscriptions_planAvailabilities_getToManyRelated", "jsonPointer": "/links/next", "localRole": "Apple continuation URL or null." } + { + "outputField": "success", + "localRole": "Set true after a successful Apple response." + }, + { + "outputField": "plan_availabilities", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "plan_availabilities.*.id", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/id" + }, + { + "outputField": "plan_availabilities.*.type", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/type" + }, + { + "outputField": "plan_availabilities.*.plan_type", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/attributes/planType" + }, + { + "outputField": "plan_availabilities.*.available_in_new_territories", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/attributes/availableInNewTerritories" + }, + { + "outputField": "plan_availabilities.*.available_territory_ids", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/relationships/availableTerritories/data/*/id" + }, + { + "outputField": "plan_availabilities.*.available_territories", + "localRole": "Build one projected territory per availability linkage; emit null when Apple omits linkage data." + }, + { + "outputField": "plan_availabilities.*.available_territories.*.id", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/relationships/availableTerritories/data/*/id" + }, + { + "outputField": "plan_availabilities.*.available_territories.*.type", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/relationships/availableTerritories/data/*/type" + }, + { + "outputField": "plan_availabilities.*.available_territories.*.currency", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/included", + "localRole": "Join the included territory matching each availability linkage ID; emit null when it is not included." + }, + { + "outputField": "plan_availabilities.*.available_territories_total", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/relationships/availableTerritories/meta/paging/total" + }, + { + "outputField": "plan_availabilities.*.available_territories_limit", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/relationships/availableTerritories/meta/paging/limit" + }, + { + "outputField": "plan_availabilities.*.available_territories_count", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/relationships/availableTerritories/data", + "localRole": "Count each availability's related territory identifiers; emit null when Apple omits linkage data." + }, + { + "outputField": "plan_availabilities.*.available_territories_next_cursor", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data/*/relationships/availableTerritories/meta/paging/nextCursor" + }, + { + "outputField": "plan_availabilities.*.available_territories_included_count", + "localRole": "Count related identifiers with a matching included territory resource; emit null when linkage data is absent." + }, + { + "outputField": "plan_availabilities.*.available_territories_truncated", + "localRole": "True when Apple supplies a next cursor or the relationship total exceeds its identifier count; emit null when linkage data is absent and truncation cannot be determined." + }, + { + "outputField": "plan_availabilities.*.available_territories_completeness_known", + "localRole": "When linkage data is present, report whether Apple supplied a relationship total or next cursor; otherwise emit null." + }, + { + "outputField": "count", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Current Apple page resource count." + }, + { + "outputField": "total", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "next_url", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "jsonPointer": "/links/next", + "localRole": "Apple continuation URL or null." + } ] }, "note": "Lists plan-type-aware availability resources with a fixed territory projection and a continuation bound to the complete originating query." @@ -3482,7 +3977,14 @@ "role": "primary", "condition": null, "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "fields[territories]", "fixedValue": ["currency"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[territories]", + "fixedValue": [ + "currency" + ] + } ] } ], @@ -3510,16 +4012,49 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after a successful Apple response." }, - { "outputField": "territories", "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "territories.*.id", "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", "jsonPointer": "/data/*/id" }, - { "outputField": "territories.*.currency", "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", "jsonPointer": "/data/*/attributes/currency" }, - { "outputField": "count", "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", "jsonPointer": "/data", "localRole": "Current Apple page resource count." }, - { "outputField": "total", "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "next_url", "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", "jsonPointer": "/links/next", "localRole": "Apple continuation URL or null." } + { + "outputField": "success", + "localRole": "Set true after a successful Apple response." + }, + { + "outputField": "territories", + "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "territories.*.id", + "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", + "jsonPointer": "/data/*/id" + }, + { + "outputField": "territories.*.currency", + "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", + "jsonPointer": "/data/*/attributes/currency" + }, + { + "outputField": "count", + "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Current Apple page resource count." + }, + { + "outputField": "total", + "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "next_url", + "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", + "jsonPointer": "/links/next", + "localRole": "Apple continuation URL or null." + } ] }, "note": "Provides the complete paginated territory collection without exposing the duplicate relationship-linkage reader or replacement endpoint." @@ -3538,9 +4073,34 @@ "role": "primary", "condition": null, "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "include", "fixedValue": ["territory"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[subscriptionPricePoints]", "fixedValue": ["customerPrice", "proceeds", "proceedsYear2", "territory", "adjustedEqualizations"] }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[territories]", "fixedValue": ["currency"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "include", + "fixedValue": [ + "territory" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[subscriptionPricePoints]", + "fixedValue": [ + "customerPrice", + "proceeds", + "proceedsYear2", + "territory", + "adjustedEqualizations" + ] + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[territories]", + "fixedValue": [ + "currency" + ] + } ] } ], @@ -3596,20 +4156,70 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after a successful Apple response." }, - { "outputField": "price_points", "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "price_points.*.id", "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "jsonPointer": "/data/*/id" }, - { "outputField": "price_points.*.territory_id", "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "jsonPointer": "/data/*/relationships/territory/data/id" }, - { "outputField": "price_points.*.currency", "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "jsonPointer": "/included", "localRole": "Resolve currency from the included territory matching the relationship ID." }, - { "outputField": "price_points.*.customer_price", "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "jsonPointer": "/data/*/attributes/customerPrice" }, - { "outputField": "price_points.*.proceeds", "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "jsonPointer": "/data/*/attributes/proceeds" }, - { "outputField": "price_points.*.proceeds_year2", "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "jsonPointer": "/data/*/attributes/proceedsYear2" }, - { "outputField": "count", "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "jsonPointer": "/data", "localRole": "Current Apple page resource count." }, - { "outputField": "total", "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "jsonPointer": "/meta/paging/total" }, - { "outputField": "next_url", "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "jsonPointer": "/links/next", "localRole": "Apple continuation URL or null." } + { + "outputField": "success", + "localRole": "Set true after a successful Apple response." + }, + { + "outputField": "price_points", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "price_points.*.id", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "jsonPointer": "/data/*/id" + }, + { + "outputField": "price_points.*.territory_id", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "jsonPointer": "/data/*/relationships/territory/data/id" + }, + { + "outputField": "price_points.*.currency", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "jsonPointer": "/included", + "localRole": "Resolve currency from the included territory matching the relationship ID." + }, + { + "outputField": "price_points.*.customer_price", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "jsonPointer": "/data/*/attributes/customerPrice" + }, + { + "outputField": "price_points.*.proceeds", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "jsonPointer": "/data/*/attributes/proceeds" + }, + { + "outputField": "price_points.*.proceeds_year2", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "jsonPointer": "/data/*/attributes/proceedsYear2" + }, + { + "outputField": "count", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Current Apple page resource count." + }, + { + "outputField": "total", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "next_url", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "jsonPointer": "/links/next", + "localRole": "Apple continuation URL or null." + } ] }, "note": "Exposes Apple 4.4.1 adjusted equalizations with all four documented filters, typed plan values, the 8000-item limit, included territory currency, total, and strict continuation scope." @@ -3633,7 +4243,7 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control and requires the same value on every continuation; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3690,8 +4300,16 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionPricePoints_equalizations_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "subscriptionPricePoints_equalizations_getToManyRelated", "statusCode": "200", "mediaType": "text/csv" } + { + "operationId": "subscriptionPricePoints_equalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptionPricePoints_equalizations_getToManyRelated", + "statusCode": "200", + "mediaType": "text/csv" + } ], "fields": [] }, @@ -3716,7 +4334,7 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control and requires the same value on every continuation; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3766,8 +4384,16 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_pricePoints_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "subscriptions_pricePoints_getToManyRelated", "statusCode": "200", "mediaType": "text/csv" } + { + "operationId": "subscriptions_pricePoints_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptions_pricePoints_getToManyRelated", + "statusCode": "200", + "mediaType": "text/csv" + } ], "fields": [] }, @@ -3792,7 +4418,7 @@ "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control and requires the same value on every continuation; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3842,7 +4468,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_prices_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_prices_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3867,7 +4497,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3903,7 +4533,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionPromotionalOffers_prices_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionPromotionalOffers_prices_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3928,14 +4562,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[prices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -3971,7 +4605,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_promotionalOffers_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_promotionalOffers_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -3996,7 +4634,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -4032,7 +4670,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "winBackOffers_prices_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "winBackOffers_prices_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4057,14 +4699,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[prices]", "disposition": "intentionallyOmitted", "reason": "The corresponding embedded relationship is not caller-configurable; dedicated relationship tools provide paginated access where supported.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -4093,7 +4735,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_winBackOffers_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_winBackOffers_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4118,28 +4764,28 @@ "appleName": "filter[planType]", "disposition": "intentionallyOmitted", "reason": "The current tool retains territory-focused pricing semantics; plan-aware selection requires a dedicated result contract.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "filter[upfrontPricePointId]", "disposition": "intentionallyOmitted", "reason": "The current tool retains territory-focused pricing semantics; plan-aware selection requires a dedicated result contract.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit", "disposition": "internalControl", "reason": "The handler fixes this query control on the initial request; it is not exposed as a direct public input.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -4173,8 +4819,16 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptions_pricePoints_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "subscriptions_pricePoints_getToManyRelated", "statusCode": "200", "mediaType": "text/csv" } + { + "operationId": "subscriptions_pricePoints_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptions_pricePoints_getToManyRelated", + "statusCode": "200", + "mediaType": "text/csv" + } ], "fields": [] }, @@ -4198,25 +4852,42 @@ "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["territory", "subscriptionPricePoint"] + "fixedValue": [ + "territory", + "subscriptionPricePoint" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[subscriptionPrices]", - "fixedValue": ["startDate", "preserved", "planType", "territory", "subscriptionPricePoint"] + "fixedValue": [ + "startDate", + "preserved", + "planType", + "territory", + "subscriptionPricePoint" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[subscriptionPricePoints]", - "fixedValue": ["customerPrice", "proceeds", "proceedsYear2", "territory", "equalizations"] + "fixedValue": [ + "customerPrice", + "proceeds", + "proceedsYear2", + "territory", + "equalizations" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[territories]", - "fixedValue": ["currency"] + "fixedValue": [ + "currency" + ] } ], "optionalParameterClassifications": [ @@ -4225,7 +4896,7 @@ "appleName": "filter[subscriptionPricePoint]", "disposition": "intentionallyOmitted", "reason": "The aggregate summarizes the complete territory and optional plan schedule; narrowing to one price point would make current and scheduled classifications incomplete.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] } @@ -4273,59 +4944,135 @@ "response": { "mode": "aggregate", "sources": [ - { "operationId": "subscriptions_prices_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptions_prices_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "successEnvelope" }, - { "outputField": "subscription_id", "localRole": "normalizedRequestEcho" }, - { "outputField": "territory_id", "localRole": "normalizedRequestEcho" }, - { "outputField": "plan_type", "localRole": "normalizedOptionalRequestEcho" }, - { "outputField": "available_plan_types", "operationId": "subscriptions_prices_getToManyRelated", "jsonPointer": "/data/*/attributes/planType", "localRole": "sortedDistinctPlanTypes" }, - { "outputField": "plan_summaries", "operationId": "subscriptions_prices_getToManyRelated", "jsonPointer": "/data", "localRole": "perPlanEffectiveScheduledAndUndatedProjectionWithCurrentPriceOnlyForCompleteTraversal" }, - { "outputField": "legacy_summary_unambiguous", "localRole": "singlePlanCompatibilitySafety" }, - { "outputField": "current_price", "localRole": "singlePlanLatestDatedEffectivePriceOrStableUndatedFallback" }, - { "outputField": "effective_prices", "localRole": "allStartedPricesNewestFirstIncludingPreservedCohortsForSinglePlan" }, - { "outputField": "scheduled_prices", "localRole": "singlePlanCompatibilityProjection" }, - { "outputField": "undated_prices", "localRole": "singlePlanCompatibilityProjection" }, - { "outputField": "as_of_date", "localRole": "utcCalendarDateUsedForScheduleClassification" }, - { "outputField": "price_count", "operationId": "subscriptions_prices_getToManyRelated", "jsonPointer": "/data", "localRole": "deduplicatedPriceCountAcrossFetchedPages" }, - { "outputField": "duplicates_skipped", "localRole": "identicalDuplicateResourceIdsExcludedAcrossPages; conflicting duplicates fail" }, - { "outputField": "pages_fetched", "localRole": "paginationRequestCount" }, - { "outputField": "limit", "localRole": "applePageSizeEcho" }, - { "outputField": "max_pages", "localRole": "localTraversalCapEcho" }, - { "outputField": "started_from_continuation", "localRole": "continuationScopeMarker" }, - { "outputField": "continuation_exhausted", "localRole": "noRemainingNextLink" }, - { "outputField": "complete", "localRole": "fullCollectionTraversalFromFirstPage" }, - { "outputField": "truncated", "localRole": "remainingNextPageAfterLocalCap" }, - { "outputField": "next_url", "localRole": "validatedOnUseAppleContinuationOrNull" } - ] - }, - "note": "Validates the request before network access, keeps MONTHLY and UPFRONT schedules separate, skips only identical duplicate resource IDs and rejects conflicting duplicates, classifies dated prices against one UTC day, preserves every effective, scheduled, and undated price, and reports continuation and truncation without claiming partial data is complete. A complete plan uses its latest dated effective price as current, falling back deterministically to an undated starting price. Legacy current_price and scheduled_prices are populated only when the fetched records form one unambiguous plan summary." - }, - { - "tool": "subscriptions_set_availability", - "kind": "direct", - "status": "deprecated", - "effect": "write", - "implementationState": "asBuilt", - "replacementTool": "subscriptions_create_plan_availability", - "operations": [ - { - "operationId": "subscriptionAvailabilities_createInstance", - "method": "post", - "path": "/v1/subscriptionAvailabilities", - "role": "primary", - "condition": null, - "inputs": [ - { - "sourceKind": "fixed", - "jsonPointer": "/data/type", - "fixedValue": "subscriptionAvailabilities" - }, - { - "sourceKind": "fixed", - "jsonPointer": "/data/relationships/subscription/data/type", - "fixedValue": "subscriptions" + { + "outputField": "success", + "localRole": "successEnvelope" + }, + { + "outputField": "subscription_id", + "localRole": "normalizedRequestEcho" + }, + { + "outputField": "territory_id", + "localRole": "normalizedRequestEcho" + }, + { + "outputField": "plan_type", + "localRole": "normalizedOptionalRequestEcho" + }, + { + "outputField": "available_plan_types", + "operationId": "subscriptions_prices_getToManyRelated", + "jsonPointer": "/data/*/attributes/planType", + "localRole": "sortedDistinctPlanTypes" + }, + { + "outputField": "plan_summaries", + "operationId": "subscriptions_prices_getToManyRelated", + "jsonPointer": "/data", + "localRole": "perPlanEffectiveScheduledAndUndatedProjectionWithCurrentPriceOnlyForCompleteTraversal" + }, + { + "outputField": "legacy_summary_unambiguous", + "localRole": "singlePlanCompatibilitySafety" + }, + { + "outputField": "current_price", + "localRole": "singlePlanLatestDatedEffectivePriceOrStableUndatedFallback" + }, + { + "outputField": "effective_prices", + "localRole": "allStartedPricesNewestFirstIncludingPreservedCohortsForSinglePlan" + }, + { + "outputField": "scheduled_prices", + "localRole": "singlePlanCompatibilityProjection" + }, + { + "outputField": "undated_prices", + "localRole": "singlePlanCompatibilityProjection" + }, + { + "outputField": "as_of_date", + "localRole": "utcCalendarDateUsedForScheduleClassification" + }, + { + "outputField": "price_count", + "operationId": "subscriptions_prices_getToManyRelated", + "jsonPointer": "/data", + "localRole": "deduplicatedPriceCountAcrossFetchedPages" + }, + { + "outputField": "duplicates_skipped", + "localRole": "identicalDuplicateResourceIdsExcludedAcrossPages; conflicting duplicates fail" + }, + { + "outputField": "pages_fetched", + "localRole": "paginationRequestCount" + }, + { + "outputField": "limit", + "localRole": "applePageSizeEcho" + }, + { + "outputField": "max_pages", + "localRole": "localTraversalCapEcho" + }, + { + "outputField": "started_from_continuation", + "localRole": "continuationScopeMarker" + }, + { + "outputField": "continuation_exhausted", + "localRole": "noRemainingNextLink" + }, + { + "outputField": "complete", + "localRole": "fullCollectionTraversalFromFirstPage" + }, + { + "outputField": "truncated", + "localRole": "remainingNextPageAfterLocalCap" + }, + { + "outputField": "next_url", + "localRole": "validatedOnUseAppleContinuationOrNull" + } + ] + }, + "note": "Validates the request before network access, keeps MONTHLY and UPFRONT schedules separate, skips only identical duplicate resource IDs and rejects conflicting duplicates, classifies dated prices against one UTC day, preserves every effective, scheduled, and undated price, and reports continuation and truncation without claiming partial data is complete. A complete plan uses its latest dated effective price as current, falling back deterministically to an undated starting price. Legacy current_price and scheduled_prices are populated only when the fetched records form one unambiguous plan summary." + }, + { + "tool": "subscriptions_set_availability", + "kind": "direct", + "status": "deprecated", + "effect": "write", + "implementationState": "asBuilt", + "replacementTool": "subscriptions_create_plan_availability", + "operations": [ + { + "operationId": "subscriptionAvailabilities_createInstance", + "method": "post", + "path": "/v1/subscriptionAvailabilities", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "subscriptionAvailabilities" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/subscription/data/type", + "fixedValue": "subscriptions" } ] } @@ -4353,7 +5100,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionAvailabilities_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionAvailabilities_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4397,7 +5148,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionSubmissions_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionSubmissions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4441,7 +5196,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionGroupSubmissions_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "subscriptionGroupSubmissions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4466,28 +5225,42 @@ "appleName": "/data/relationships/introductoryOffers", "disposition": "intentionallyOmitted", "reason": "The general subscription update remains attribute-only; dedicated introductory-offer tools manage this relationship without exposing a replacement-capable inline graph.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "body", "appleName": "/data/relationships/prices", "disposition": "intentionallyOmitted", "reason": "The general subscription update remains attribute-only; dedicated price tools validate territory and price-point identifiers without exposing a replacement-capable inline graph.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "body", "appleName": "/data/relationships/promotionalOffers", "disposition": "intentionallyOmitted", "reason": "The general subscription update remains attribute-only; dedicated promotional-offer tools preserve offer and pricing invariants without exposing a replacement-capable inline graph.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "body", "appleName": "/included", "disposition": "intentionallyOmitted", "reason": "Apple's included resources form the inline create graph coupled to the omitted offer and price relationships; dedicated typed lifecycle tools provide safer validated mutations and returned resource IDs.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/retentionMessage", + "disposition": "intentionallyOmitted", + "reason": "Subscription retention message and retention offer linkages are mutated through dedicated relationship tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/retentionMessageOffers", + "disposition": "intentionallyOmitted", + "reason": "Subscription retention message and retention offer linkages are mutated through dedicated relationship tools.", + "reviewAtSpec": "4.6" } ], "inputs": [ @@ -4679,7 +5452,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodeCustomCodes_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodeCustomCodes_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4733,7 +5510,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionGroups_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionGroups_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4793,7 +5574,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionGroupLocalizations_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionGroupLocalizations_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4847,7 +5632,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionIntroductoryOffers_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionIntroductoryOffers_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4907,7 +5696,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionLocalizations_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionLocalizations_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4961,7 +5754,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionOfferCodes_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionOfferCodes_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -4989,7 +5786,9 @@ { "sourceKind": "derived", "jsonPointer": "/data/id", - "derivedFrom": ["plan_availability_id"], + "derivedFrom": [ + "plan_availability_id" + ], "localRole": "Reuse the validated path identifier as the JSON:API resource ID." }, { @@ -5026,26 +5825,95 @@ "response": { "mode": "projection", "sources": [ - { "operationId": "subscriptionPlanAvailabilities_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "success", "localRole": "Set true after Apple updates the resource." }, - { "outputField": "plan_availability.id", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/id" }, - { "outputField": "plan_availability.type", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/type" }, - { "outputField": "plan_availability.plan_type", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/attributes/planType" }, - { "outputField": "plan_availability.available_in_new_territories", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/attributes/availableInNewTerritories" }, - { "outputField": "plan_availability.available_territory_ids", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/relationships/availableTerritories/data/*/id" }, - { "outputField": "plan_availability.available_territories", "localRole": "Build one projected territory per availableTerritories linkage; emit null when Apple omits linkage data." }, - { "outputField": "plan_availability.available_territories.*.id", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/relationships/availableTerritories/data/*/id" }, - { "outputField": "plan_availability.available_territories.*.type", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/relationships/availableTerritories/data/*/type" }, - { "outputField": "plan_availability.available_territories.*.currency", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/included", "localRole": "Join the included territory matching each availableTerritories linkage ID; emit null when it is not included." }, - { "outputField": "plan_availability.available_territories_total", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/relationships/availableTerritories/meta/paging/total" }, - { "outputField": "plan_availability.available_territories_limit", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/relationships/availableTerritories/meta/paging/limit" }, - { "outputField": "plan_availability.available_territories_count", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/relationships/availableTerritories/data", "localRole": "Count the availableTerritories relationship identifiers; emit null when Apple omits linkage data." }, - { "outputField": "plan_availability.available_territories_next_cursor", "operationId": "subscriptionPlanAvailabilities_updateInstance", "jsonPointer": "/data/relationships/availableTerritories/meta/paging/nextCursor" }, - { "outputField": "plan_availability.available_territories_included_count", "localRole": "Count related identifiers with a matching included territory resource; emit null when linkage data is absent." }, - { "outputField": "plan_availability.available_territories_truncated", "localRole": "True when Apple supplies a next cursor or the relationship total exceeds its identifier count; emit null when linkage data is absent and truncation cannot be determined." }, - { "outputField": "plan_availability.available_territories_completeness_known", "localRole": "When linkage data is present, report whether Apple supplied a relationship total or next cursor; otherwise emit null." } + { + "outputField": "success", + "localRole": "Set true after Apple updates the resource." + }, + { + "outputField": "plan_availability.id", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/id" + }, + { + "outputField": "plan_availability.type", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/type" + }, + { + "outputField": "plan_availability.plan_type", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/attributes/planType" + }, + { + "outputField": "plan_availability.available_in_new_territories", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/attributes/availableInNewTerritories" + }, + { + "outputField": "plan_availability.available_territory_ids", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/relationships/availableTerritories/data/*/id" + }, + { + "outputField": "plan_availability.available_territories", + "localRole": "Build one projected territory per availableTerritories linkage; emit null when Apple omits linkage data." + }, + { + "outputField": "plan_availability.available_territories.*.id", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/relationships/availableTerritories/data/*/id" + }, + { + "outputField": "plan_availability.available_territories.*.type", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/relationships/availableTerritories/data/*/type" + }, + { + "outputField": "plan_availability.available_territories.*.currency", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/included", + "localRole": "Join the included territory matching each availableTerritories linkage ID; emit null when it is not included." + }, + { + "outputField": "plan_availability.available_territories_total", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/relationships/availableTerritories/meta/paging/total" + }, + { + "outputField": "plan_availability.available_territories_limit", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/relationships/availableTerritories/meta/paging/limit" + }, + { + "outputField": "plan_availability.available_territories_count", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/relationships/availableTerritories/data", + "localRole": "Count the availableTerritories relationship identifiers; emit null when Apple omits linkage data." + }, + { + "outputField": "plan_availability.available_territories_next_cursor", + "operationId": "subscriptionPlanAvailabilities_updateInstance", + "jsonPointer": "/data/relationships/availableTerritories/meta/paging/nextCursor" + }, + { + "outputField": "plan_availability.available_territories_included_count", + "localRole": "Count related identifiers with a matching included territory resource; emit null when linkage data is absent." + }, + { + "outputField": "plan_availability.available_territories_truncated", + "localRole": "True when Apple supplies a next cursor or the relationship total exceeds its identifier count; emit null when linkage data is absent and truncation cannot be determined." + }, + { + "outputField": "plan_availability.available_territories_completeness_known", + "localRole": "When linkage data is present, report whether Apple supplied a relationship total or next cursor; otherwise emit null." + } ] }, "note": "Updates only Apple's mutable fields, preserves nullable Boolean tri-state semantics, and keeps planType immutable." @@ -5120,7 +5988,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionPromotionalOffers_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "subscriptionPromotionalOffers_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -5224,7 +6096,11 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "winBackOffers_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "winBackOffers_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -5323,7 +6199,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -5367,10 +6243,25 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionImages_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "subscriptionImages_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "subscriptionImages_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "subscriptionImages_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptionImages_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "subscriptionImages_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptionImages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptionImages_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -5469,7 +6360,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated commerce tools cover related resources.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -5513,10 +6404,25 @@ "response": { "mode": "opaque", "sources": [ - { "operationId": "subscriptionAppStoreReviewScreenshots_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "subscriptionAppStoreReviewScreenshots_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "subscriptionAppStoreReviewScreenshots_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "subscriptionAppStoreReviewScreenshots_deleteInstance", "statusCode": "204" } + { + "operationId": "subscriptionAppStoreReviewScreenshots_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "subscriptionAppStoreReviewScreenshots_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptionAppStoreReviewScreenshots_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptionAppStoreReviewScreenshots_deleteInstance", + "statusCode": "204" + } ], "fields": [] }, @@ -5528,444 +6434,3360 @@ "status": "partial", "effect": "write", "implementationState": "asBuilt", - "operations": [{ - "operationId": "subscriptionVersions_createInstance", "method": "post", "path": "/v1/subscriptionVersions", "role": "primary", "condition": null, - "inputs": [ - {"sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "subscriptionVersions"}, - {"sourceKind": "fixed", "jsonPointer": "/data/relationships/subscription/data/type", "fixedValue": "subscriptions"} - ] - }], - "fields": [{"toolField": "subscription_id", "sourceKind": "requestBody", "operationId": "subscriptionVersions_createInstance", "jsonPointer": "/data/relationships/subscription/data/id"}], + "operations": [ + { + "operationId": "subscriptionVersions_createInstance", + "method": "post", + "path": "/v1/subscriptionVersions", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "subscriptionVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/subscription/data/type", + "fixedValue": "subscriptions" + } + ] + } + ], + "fields": [ + { + "toolField": "subscription_id", + "sourceKind": "requestBody", + "operationId": "subscriptionVersions_createInstance", + "jsonPointer": "/data/relationships/subscription/data/id" + } + ], "response": { "mode": "projection", - "sources": [{"operationId": "subscriptionVersions_createInstance", "statusCode": "201", "mediaType": "application/json"}], + "sources": [ + { + "operationId": "subscriptionVersions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } + ], "fields": [ - {"outputField":"success","localRole":"Set true after the created version and its identity pass validation."}, - {"outputField":"version","operationId":"subscriptionVersions_createInstance","jsonPointer":"/data","localRole":"Project stable version fields and bounded relationship-page metadata when Apple supplies it."}, - {"outputField":"version.images_page.ids","operationId":"subscriptionVersions_createInstance","jsonPointer":"/data/relationships/images/data/*/id","localRole":"Emit null when Apple omits relationship.data; preserve an explicit empty data array as []."}, - {"outputField":"version.images_page.count","localRole":"Emit null when Apple omits relationship.data; otherwise count the embedded image identifiers, including zero for an explicit empty page."}, - {"outputField":"version.images_page.total","operationId":"subscriptionVersions_createInstance","jsonPointer":"/data/relationships/images/meta/paging/total"}, - {"outputField":"version.images_page.limit","operationId":"subscriptionVersions_createInstance","jsonPointer":"/data/relationships/images/meta/paging/limit"}, - {"outputField":"version.images_page.next_cursor","operationId":"subscriptionVersions_createInstance","jsonPointer":"/data/relationships/images/meta/paging/nextCursor"}, - {"outputField":"version.images_page.truncated","localRole":"Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded image ID count."}, - {"outputField":"version.images_page.completeness_known","localRole":"Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor."}, - {"outputField":"version.localizations_page.ids","operationId":"subscriptionVersions_createInstance","jsonPointer":"/data/relationships/localizations/data/*/id","localRole":"Emit null when Apple omits relationship.data; preserve an explicit empty data array as []."}, - {"outputField":"version.localizations_page.count","localRole":"Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page."}, - {"outputField":"version.localizations_page.total","operationId":"subscriptionVersions_createInstance","jsonPointer":"/data/relationships/localizations/meta/paging/total"}, - {"outputField":"version.localizations_page.limit","operationId":"subscriptionVersions_createInstance","jsonPointer":"/data/relationships/localizations/meta/paging/limit"}, - {"outputField":"version.localizations_page.next_cursor","operationId":"subscriptionVersions_createInstance","jsonPointer":"/data/relationships/localizations/meta/paging/nextCursor"}, - {"outputField":"version.localizations_page.truncated","localRole":"Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded localization ID count."}, - {"outputField":"version.localizations_page.completeness_known","localRole":"Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor."} - ] - }, - "note": "Creates one explicit Apple 4.4.1 subscription metadata version; legacy product-scoped tools never create versions implicitly. An ambiguous POST or response decode returns write_outcome=not_confirmed, retrySafe=false, the subscription ID, and list/get recovery guidance instead of encouraging a duplicate create." - }, - { - "tool": "subscriptions_get_version", - "kind": "direct", - "status": "partial", - "effect": "read", - "implementationState": "asBuilt", - "operations": [{ - "operationId": "subscriptionVersions_getInstance", "method": "get", "path": "/v1/subscriptionVersions/{id}", "role": "primary", "condition": null, - "optionalParameterClassifications": [ - {"location":"query","appleName":"include","disposition":"intentionallyOmitted","reason":"The stable projection does not expose arbitrary relationship expansion.","reviewAtSpec":"4.5.1"}, - {"location":"query","appleName":"limit[images]","disposition":"intentionallyOmitted","reason":"Images are paged through subscriptions_list_version_images.","reviewAtSpec":"4.5.1"}, - {"location":"query","appleName":"limit[localizations]","disposition":"intentionallyOmitted","reason":"Localizations are paged through subscriptions_list_version_localizations.","reviewAtSpec":"4.5.1"} - ] - }], - "fields": [{"toolField":"version_id","sourceKind":"parameter","operationId":"subscriptionVersions_getInstance","location":"path","appleName":"id"}], - "response": { - "mode":"projection", - "sources":[{"operationId":"subscriptionVersions_getInstance","statusCode":"200","mediaType":"application/json"}], - "fields":[ - {"outputField":"success","localRole":"Set true after the version identity and self link pass validation."}, - {"outputField":"version","operationId":"subscriptionVersions_getInstance","jsonPointer":"/data","localRole":"Project stable version fields and bounded relationship-page metadata when Apple supplies it."}, - {"outputField":"version.images_page.ids","operationId":"subscriptionVersions_getInstance","jsonPointer":"/data/relationships/images/data/*/id","localRole":"Emit null when Apple omits relationship.data; preserve an explicit empty data array as []."}, - {"outputField":"version.images_page.count","localRole":"Emit null when Apple omits relationship.data; otherwise count the embedded image identifiers, including zero for an explicit empty page."}, - {"outputField":"version.images_page.total","operationId":"subscriptionVersions_getInstance","jsonPointer":"/data/relationships/images/meta/paging/total"}, - {"outputField":"version.images_page.limit","operationId":"subscriptionVersions_getInstance","jsonPointer":"/data/relationships/images/meta/paging/limit"}, - {"outputField":"version.images_page.next_cursor","operationId":"subscriptionVersions_getInstance","jsonPointer":"/data/relationships/images/meta/paging/nextCursor"}, - {"outputField":"version.images_page.truncated","localRole":"Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded image ID count."}, - {"outputField":"version.images_page.completeness_known","localRole":"Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor."}, - {"outputField":"version.localizations_page.ids","operationId":"subscriptionVersions_getInstance","jsonPointer":"/data/relationships/localizations/data/*/id","localRole":"Emit null when Apple omits relationship.data; preserve an explicit empty data array as []."}, - {"outputField":"version.localizations_page.count","localRole":"Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page."}, - {"outputField":"version.localizations_page.total","operationId":"subscriptionVersions_getInstance","jsonPointer":"/data/relationships/localizations/meta/paging/total"}, - {"outputField":"version.localizations_page.limit","operationId":"subscriptionVersions_getInstance","jsonPointer":"/data/relationships/localizations/meta/paging/limit"}, - {"outputField":"version.localizations_page.next_cursor","operationId":"subscriptionVersions_getInstance","jsonPointer":"/data/relationships/localizations/meta/paging/nextCursor"}, - {"outputField":"version.localizations_page.truncated","localRole":"Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded localization ID count."}, - {"outputField":"version.localizations_page.completeness_known","localRole":"Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor."} - ] - }, - "note": "Returns the stable version projection and relationship identifiers from Apple's discrete subscription version resource." - }, - { - "tool": "subscriptions_list_versions", - "kind": "direct", - "status": "partial", - "effect": "read", - "implementationState": "asBuilt", - "operations": [{ - "operationId":"subscriptions_versions_getToManyRelated","method":"get","path":"/v1/subscriptions/{id}/versions","role":"primary","condition":null, - "optionalParameterClassifications":[ - {"location":"query","appleName":"include","disposition":"intentionallyOmitted","reason":"The stable paginated projection does not expose arbitrary relationship expansion.","reviewAtSpec":"4.5.1"}, - {"location":"query","appleName":"limit[images]","disposition":"intentionallyOmitted","reason":"Images have their own bounded continuation tool.","reviewAtSpec":"4.5.1"}, - {"location":"query","appleName":"limit[localizations]","disposition":"intentionallyOmitted","reason":"Localizations have their own bounded continuation tool.","reviewAtSpec":"4.5.1"} - ] - }], - "fields":[ - {"toolField":"subscription_id","sourceKind":"parameter","operationId":"subscriptions_versions_getToManyRelated","location":"path","appleName":"id"}, - {"toolField":"filter_state","sourceKind":"parameter","operationId":"subscriptions_versions_getToManyRelated","location":"query","appleName":"filter[state]"}, - {"toolField":"limit","sourceKind":"parameter","operationId":"subscriptions_versions_getToManyRelated","location":"query","appleName":"limit"}, - {"toolField":"next_url","sourceKind":"local","localRole":"Continue only an Apple URL whose origin, path, fixed filter, limit, unique non-empty cursor, and parameter set match the original request."} - ], - "response":{ - "mode":"projection", - "sources":[{"operationId":"subscriptions_versions_getToManyRelated","statusCode":"200","mediaType":"application/json"}], - "fields":[ - {"outputField":"success","localRole":"Set true after the page passes parent identity, paging, and self-link validation."}, - {"outputField":"versions","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/data","localRole":"Project stable version fields and bounded relationship-page metadata when Apple supplies it."}, - {"outputField":"versions.*.images_page.ids","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/data/*/relationships/images/data/*/id","localRole":"Emit null when Apple omits relationship.data; preserve an explicit empty data array as []."}, - {"outputField":"versions.*.images_page.count","localRole":"Emit null when Apple omits relationship.data; otherwise count the embedded image identifiers, including zero for an explicit empty page."}, - {"outputField":"versions.*.images_page.total","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/data/*/relationships/images/meta/paging/total"}, - {"outputField":"versions.*.images_page.limit","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/data/*/relationships/images/meta/paging/limit"}, - {"outputField":"versions.*.images_page.next_cursor","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/data/*/relationships/images/meta/paging/nextCursor"}, - {"outputField":"versions.*.images_page.truncated","localRole":"Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds that version's embedded image ID count."}, - {"outputField":"versions.*.images_page.completeness_known","localRole":"Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor."}, - {"outputField":"versions.*.localizations_page.ids","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/data/*/relationships/localizations/data/*/id","localRole":"Emit null when Apple omits relationship.data; preserve an explicit empty data array as []."}, - {"outputField":"versions.*.localizations_page.count","localRole":"Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page."}, - {"outputField":"versions.*.localizations_page.total","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/data/*/relationships/localizations/meta/paging/total"}, - {"outputField":"versions.*.localizations_page.limit","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/data/*/relationships/localizations/meta/paging/limit"}, - {"outputField":"versions.*.localizations_page.next_cursor","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/data/*/relationships/localizations/meta/paging/nextCursor"}, - {"outputField":"versions.*.localizations_page.truncated","localRole":"Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds that version's embedded localization ID count."}, - {"outputField":"versions.*.localizations_page.completeness_known","localRole":"Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor."}, - {"outputField":"count","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/data","localRole":"Current validated Apple page resource count."}, - {"outputField":"total","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/meta/paging/total"}, - {"outputField":"next_url","operationId":"subscriptions_versions_getToManyRelated","jsonPointer":"/links/next","localRole":"Apple continuation URL when another page exists; otherwise omitted."} - ] - }, - "note":"Lists Apple 4.4.1 subscription versions with exact state validation and scope-locked pagination." - }, - { - "tool":"subscriptions_list_version_localizations","kind":"direct","status":"partial","effect":"read","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionVersions_localizations_getToManyRelated","method":"get","path":"/v1/subscriptionVersions/{id}/localizations","role":"primary","condition":null,"optionalParameterClassifications":[ - {"location":"query","appleName":"include","disposition":"intentionallyOmitted","reason":"The stable projection does not expose arbitrary relationship expansion.","reviewAtSpec":"4.5.1"} - ]}], - "fields":[ - {"toolField":"version_id","sourceKind":"parameter","operationId":"subscriptionVersions_localizations_getToManyRelated","location":"path","appleName":"id"}, - {"toolField":"limit","sourceKind":"parameter","operationId":"subscriptionVersions_localizations_getToManyRelated","location":"query","appleName":"limit"}, - {"toolField":"next_url","sourceKind":"local","localRole":"Continue only an Apple URL whose origin, path, limit, unique non-empty cursor, and parameter set match the original request."} - ], - "response":{"mode":"opaque","sources":[{"operationId":"subscriptionVersions_localizations_getToManyRelated","statusCode":"200","mediaType":"application/json"}],"fields":[]}, - "note":"Lists localizations owned by one explicit subscription version." - }, - { - "tool":"subscriptions_create_version_localization","kind":"direct","status":"partial","effect":"write","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionLocalizationsV2_createInstance","method":"post","path":"/v2/subscriptionLocalizations","role":"primary","condition":null,"inputs":[ - {"sourceKind":"fixed","jsonPointer":"/data/type","fixedValue":"subscriptionLocalizations"}, - {"sourceKind":"fixed","jsonPointer":"/data/relationships/version/data/type","fixedValue":"subscriptionVersions"} - ]}], - "fields":[ - {"toolField":"version_id","sourceKind":"requestBody","operationId":"subscriptionLocalizationsV2_createInstance","jsonPointer":"/data/relationships/version/data/id"}, - {"toolField":"locale","sourceKind":"requestBody","operationId":"subscriptionLocalizationsV2_createInstance","jsonPointer":"/data/attributes/locale"}, - {"toolField":"name","sourceKind":"requestBody","operationId":"subscriptionLocalizationsV2_createInstance","jsonPointer":"/data/attributes/name"}, - {"toolField":"description","sourceKind":"requestBody","operationId":"subscriptionLocalizationsV2_createInstance","jsonPointer":"/data/attributes/description"} - ], - "response":{"mode":"opaque","sources":[{"operationId":"subscriptionLocalizationsV2_createInstance","statusCode":"201","mediaType":"application/json"}],"fields":[]}, - "note":"Creates localization metadata directly under an explicit subscription version and preserves omitted, string, and null description semantics. An ambiguous POST or response decode returns write_outcome=not_confirmed, retrySafe=false, the requested parent and metadata fingerprint, and list/get recovery guidance instead of encouraging a duplicate localization." - }, + { + "outputField": "success", + "localRole": "Set true after the created version and its identity pass validation." + }, + { + "outputField": "version", + "operationId": "subscriptionVersions_createInstance", + "jsonPointer": "/data", + "localRole": "Project stable version fields and bounded relationship-page metadata when Apple supplies it." + }, + { + "outputField": "version.images_page.ids", + "operationId": "subscriptionVersions_createInstance", + "jsonPointer": "/data/relationships/images/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "version.images_page.count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded image identifiers, including zero for an explicit empty page." + }, + { + "outputField": "version.images_page.total", + "operationId": "subscriptionVersions_createInstance", + "jsonPointer": "/data/relationships/images/meta/paging/total" + }, + { + "outputField": "version.images_page.limit", + "operationId": "subscriptionVersions_createInstance", + "jsonPointer": "/data/relationships/images/meta/paging/limit" + }, + { + "outputField": "version.images_page.next_cursor", + "operationId": "subscriptionVersions_createInstance", + "jsonPointer": "/data/relationships/images/meta/paging/nextCursor" + }, + { + "outputField": "version.images_page.truncated", + "localRole": "Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded image ID count." + }, + { + "outputField": "version.images_page.completeness_known", + "localRole": "Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor." + }, + { + "outputField": "version.localizations_page.ids", + "operationId": "subscriptionVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "version.localizations_page.count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page." + }, + { + "outputField": "version.localizations_page.total", + "operationId": "subscriptionVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/total" + }, + { + "outputField": "version.localizations_page.limit", + "operationId": "subscriptionVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/limit" + }, + { + "outputField": "version.localizations_page.next_cursor", + "operationId": "subscriptionVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/nextCursor" + }, + { + "outputField": "version.localizations_page.truncated", + "localRole": "Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded localization ID count." + }, + { + "outputField": "version.localizations_page.completeness_known", + "localRole": "Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor." + } + ] + }, + "note": "Creates one explicit Apple 4.4.1 subscription metadata version; legacy product-scoped tools never create versions implicitly. An ambiguous POST or response decode returns write_outcome=not_confirmed, retrySafe=false, the subscription ID, and list/get recovery guidance instead of encouraging a duplicate create." + }, + { + "tool": "subscriptions_get_version", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionVersions_getInstance", + "method": "get", + "path": "/v1/subscriptionVersions/{id}", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The stable projection does not expose arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[images]", + "disposition": "intentionallyOmitted", + "reason": "Images are paged through subscriptions_list_version_images.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are paged through subscriptions_list_version_localizations.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "subscriptionVersions_getInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "subscriptionVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "Set true after the version identity and self link pass validation." + }, + { + "outputField": "version", + "operationId": "subscriptionVersions_getInstance", + "jsonPointer": "/data", + "localRole": "Project stable version fields and bounded relationship-page metadata when Apple supplies it." + }, + { + "outputField": "version.images_page.ids", + "operationId": "subscriptionVersions_getInstance", + "jsonPointer": "/data/relationships/images/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "version.images_page.count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded image identifiers, including zero for an explicit empty page." + }, + { + "outputField": "version.images_page.total", + "operationId": "subscriptionVersions_getInstance", + "jsonPointer": "/data/relationships/images/meta/paging/total" + }, + { + "outputField": "version.images_page.limit", + "operationId": "subscriptionVersions_getInstance", + "jsonPointer": "/data/relationships/images/meta/paging/limit" + }, + { + "outputField": "version.images_page.next_cursor", + "operationId": "subscriptionVersions_getInstance", + "jsonPointer": "/data/relationships/images/meta/paging/nextCursor" + }, + { + "outputField": "version.images_page.truncated", + "localRole": "Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded image ID count." + }, + { + "outputField": "version.images_page.completeness_known", + "localRole": "Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor." + }, + { + "outputField": "version.localizations_page.ids", + "operationId": "subscriptionVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "version.localizations_page.count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page." + }, + { + "outputField": "version.localizations_page.total", + "operationId": "subscriptionVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/total" + }, + { + "outputField": "version.localizations_page.limit", + "operationId": "subscriptionVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/limit" + }, + { + "outputField": "version.localizations_page.next_cursor", + "operationId": "subscriptionVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/nextCursor" + }, + { + "outputField": "version.localizations_page.truncated", + "localRole": "Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded localization ID count." + }, + { + "outputField": "version.localizations_page.completeness_known", + "localRole": "Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor." + } + ] + }, + "note": "Returns the stable version projection and relationship identifiers from Apple's discrete subscription version resource." + }, + { + "tool": "subscriptions_list_versions", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptions_versions_getToManyRelated", + "method": "get", + "path": "/v1/subscriptions/{id}/versions", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The stable paginated projection does not expose arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[images]", + "disposition": "intentionallyOmitted", + "reason": "Images have their own bounded continuation tool.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations have their own bounded continuation tool.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "subscription_id", + "sourceKind": "parameter", + "operationId": "subscriptions_versions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "filter_state", + "sourceKind": "parameter", + "operationId": "subscriptions_versions_getToManyRelated", + "location": "query", + "appleName": "filter[state]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "subscriptions_versions_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Continue only an Apple URL whose origin, path, fixed filter, limit, unique non-empty cursor, and parameter set match the original request." + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "subscriptions_versions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "Set true after the page passes parent identity, paging, and self-link validation." + }, + { + "outputField": "versions", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Project stable version fields and bounded relationship-page metadata when Apple supplies it." + }, + { + "outputField": "versions.*.images_page.ids", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/images/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "versions.*.images_page.count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded image identifiers, including zero for an explicit empty page." + }, + { + "outputField": "versions.*.images_page.total", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/images/meta/paging/total" + }, + { + "outputField": "versions.*.images_page.limit", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/images/meta/paging/limit" + }, + { + "outputField": "versions.*.images_page.next_cursor", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/images/meta/paging/nextCursor" + }, + { + "outputField": "versions.*.images_page.truncated", + "localRole": "Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds that version's embedded image ID count." + }, + { + "outputField": "versions.*.images_page.completeness_known", + "localRole": "Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor." + }, + { + "outputField": "versions.*.localizations_page.ids", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "versions.*.localizations_page.count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page." + }, + { + "outputField": "versions.*.localizations_page.total", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/meta/paging/total" + }, + { + "outputField": "versions.*.localizations_page.limit", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/meta/paging/limit" + }, + { + "outputField": "versions.*.localizations_page.next_cursor", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/meta/paging/nextCursor" + }, + { + "outputField": "versions.*.localizations_page.truncated", + "localRole": "Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds that version's embedded localization ID count." + }, + { + "outputField": "versions.*.localizations_page.completeness_known", + "localRole": "Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor." + }, + { + "outputField": "count", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Current validated Apple page resource count." + }, + { + "outputField": "total", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "next_url", + "operationId": "subscriptions_versions_getToManyRelated", + "jsonPointer": "/links/next", + "localRole": "Apple continuation URL when another page exists; otherwise omitted." + } + ] + }, + "note": "Lists Apple 4.4.1 subscription versions with exact state validation and scope-locked pagination." + }, + { + "tool": "subscriptions_list_version_localizations", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionVersions_localizations_getToManyRelated", + "method": "get", + "path": "/v1/subscriptionVersions/{id}/localizations", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The stable projection does not expose arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "subscriptionVersions_localizations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "subscriptionVersions_localizations_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Continue only an Apple URL whose origin, path, limit, unique non-empty cursor, and parameter set match the original request." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionVersions_localizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Lists localizations owned by one explicit subscription version." + }, + { + "tool": "subscriptions_create_version_localization", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionLocalizationsV2_createInstance", + "method": "post", + "path": "/v2/subscriptionLocalizations", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "subscriptionLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/version/data/type", + "fixedValue": "subscriptionVersions" + } + ] + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "requestBody", + "operationId": "subscriptionLocalizationsV2_createInstance", + "jsonPointer": "/data/relationships/version/data/id" + }, + { + "toolField": "locale", + "sourceKind": "requestBody", + "operationId": "subscriptionLocalizationsV2_createInstance", + "jsonPointer": "/data/attributes/locale" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "subscriptionLocalizationsV2_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "description", + "sourceKind": "requestBody", + "operationId": "subscriptionLocalizationsV2_createInstance", + "jsonPointer": "/data/attributes/description" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionLocalizationsV2_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Creates localization metadata directly under an explicit subscription version and preserves omitted, string, and null description semantics. An ambiguous POST or response decode returns write_outcome=not_confirmed, retrySafe=false, the requested parent and metadata fingerprint, and list/get recovery guidance instead of encouraging a duplicate localization." + }, + { + "tool": "subscriptions_get_version_localization", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionLocalizationsV2_getInstance", + "method": "get", + "path": "/v2/subscriptionLocalizations/{id}", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The stable projection does not expose arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "subscriptionLocalizationsV2_getInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionLocalizationsV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Gets one v2 subscription version localization by resource ID." + }, + { + "tool": "subscriptions_update_version_localization", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionLocalizationsV2_updateInstance", + "method": "patch", + "path": "/v2/subscriptionLocalizations/{id}", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "subscriptionLocalizations" + } + ] + } + ], + "fields": [ + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "subscriptionLocalizationsV2_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "localization_id", + "sourceKind": "requestBody", + "operationId": "subscriptionLocalizationsV2_updateInstance", + "jsonPointer": "/data/id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "subscriptionLocalizationsV2_updateInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "description", + "sourceKind": "requestBody", + "operationId": "subscriptionLocalizationsV2_updateInstance", + "jsonPointer": "/data/attributes/description" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionLocalizationsV2_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Updates at least one v2 localization attribute and preserves string versus explicit null." + }, + { + "tool": "subscriptions_delete_version_localization", + "kind": "direct", + "status": "partial", + "effect": "destructive", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionLocalizationsV2_deleteInstance", + "method": "delete", + "path": "/v2/subscriptionLocalizations/{id}", + "role": "primary", + "condition": null + } + ], + "fields": [ + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "subscriptionLocalizationsV2_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_localization_id", + "sourceKind": "local", + "localRole": "Require an exact canonical match with localization_id before any Apple request is sent." + } + ], + "response": { + "mode": "local", + "sources": [ + { + "operationId": "subscriptionLocalizationsV2_deleteInstance", + "statusCode": "204" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "Set true after Apple confirms deletion with 204." + }, + { + "outputField": "localization_id", + "localRole": "Echo the exact deleted localization ID." + }, + { + "outputField": "deleted", + "localRole": "Set true after confirmed deletion." + }, + { + "outputField": "deletionState", + "localRole": "Set to confirmed after Apple's 204 response." + }, + { + "outputField": "outcomeUnknown", + "localRole": "Set false for a confirmed deletion." + }, + { + "outputField": "retrySafe", + "localRole": "Set false because the destructive operation is already confirmed." + } + ] + }, + "note": "Deletes one v2 localization resource by its exact ID." + }, + { + "tool": "subscriptions_list_version_images", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionVersions_images_getToManyRelated", + "method": "get", + "path": "/v1/subscriptionVersions/{id}/images", + "role": "primary", + "condition": null + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "subscriptionVersions_images_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "subscriptionVersions_images_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Continue only an Apple URL whose origin, path, limit, unique non-empty cursor, and parameter set match the original request." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionVersions_images_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Lists all promotional images owned by one explicit subscription version while intentionally omitting Apple's opaque assetToken from the public projection." + }, + { + "tool": "subscriptions_upload_version_image", + "kind": "compound", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionImagesV2_createInstance", + "method": "post", + "path": "/v2/subscriptionImages", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "subscriptionImages" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/version/data/type", + "fixedValue": "subscriptionVersions" + } + ] + }, + { + "operationId": "subscriptionImagesV2_updateInstance", + "method": "patch", + "path": "/v2/subscriptionImages/{id}", + "role": "supporting", + "condition": null, + "inputs": [ + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "subscriptionImagesV2_createInstance:/data/id" + ], + "localRole": "Use Apple's reserved image ID as the commit path ID." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "subscriptionImages" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "subscriptionImagesV2_createInstance:/data/id" + ], + "localRole": "Use Apple's reserved image ID as the commit resource ID." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/attributes/uploaded", + "fixedValue": true + } + ] + }, + { + "operationId": "subscriptionImagesV2_getInstance", + "method": "get", + "path": "/v2/subscriptionImages/{id}", + "role": "conditional", + "condition": "After PATCH returns a nonterminal assetDeliveryState, or when PATCH is ambiguous, reconcile and poll the exact reserved image.", + "inputs": [ + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "subscriptionImagesV2_createInstance:/data/id" + ], + "localRole": "Inspect the exact image created by the reservation." + } + ] + }, + { + "operationId": "subscriptionImagesV2_deleteInstance", + "method": "delete", + "path": "/v2/subscriptionImages/{id}", + "role": "conditional", + "condition": "Before commit, best-effort delete a confirmed reservation after cancellation, missing upload operations, transfer failure, or commit-body failure; treat 404 as already absent.", + "inputs": [ + { + "sourceKind": "derived", + "location": "path", + "appleName": "id", + "derivedFrom": [ + "subscriptionImagesV2_createInstance:/data/id" + ], + "localRole": "Rollback only the confirmed reservation for this upload attempt." + } + ] + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "requestBody", + "operationId": "subscriptionImagesV2_createInstance", + "jsonPointer": "/data/relationships/version/data/id" + }, + { + "toolField": "file_path", + "sourceKind": "derived", + "operationId": "subscriptionImagesV2_createInstance", + "jsonPointer": "/data/attributes", + "derivedFrom": [ + "file_path" + ], + "localRole": "Create an immutable snapshot, derive fileName and fileSize, transfer its bytes through Apple's signed operations, and discard it after reconciliation." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionImagesV2_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "subscriptionImagesV2_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptionImagesV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptionImagesV2_deleteInstance", + "statusCode": "204" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "False on structured recovery failures; true on completed or accepted upload results." + }, + { + "outputField": "error", + "localRole": "Stable failure summary when reservation or commit verification cannot complete." + }, + { + "outputField": "statusCode", + "localRole": "Apple status code when a 2xx reservation response was committed but could not be verified." + }, + { + "outputField": "reservationState", + "localRole": "Unknown or committed_unverified reservation state for ambiguous reserve outcomes." + }, + { + "outputField": "reservationIdKnown", + "localRole": "False when Apple did not return a safely attributable reservation ID." + }, + { + "outputField": "operationCommitState", + "localRole": "Unknown when Apple may have committed an operation that cannot be reconciled." + }, + { + "outputField": "operationCommitted", + "localRole": "True when a 2xx response proves commit despite response verification failure." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True when Apple may have committed the operation and safe retry cannot be established." + }, + { + "outputField": "inspectionRequired", + "localRole": "True when deterministic collection or exact-resource inspection is required." + }, + { + "outputField": "retrySafe", + "localRole": "False for all unresolved, committed-unverified, retained, or confirmed destructive outcomes." + }, + { + "outputField": "reservationFingerprint", + "localRole": "Stable reservation fingerprint emitted when the reserve outcome cannot be identified safely." + }, + { + "outputField": "reservationFingerprint.file_name", + "localRole": "Snapshot file name used to match inspection candidates." + }, + { + "outputField": "reservationFingerprint.file_size", + "localRole": "Snapshot byte count used to match inspection candidates." + }, + { + "outputField": "reservationFingerprint.checksum", + "localRole": "Snapshot checksum used as the authoritative reservation fingerprint." + }, + { + "outputField": "inspection", + "localRole": "Full-pagination reservation inspection guidance for ambiguous create outcomes." + }, + { + "outputField": "inspection.tool", + "localRole": "Use subscriptions_list_version_images for collection recovery." + }, + { + "outputField": "inspection.arguments", + "localRole": "Scope the collection inspection to the parent version and a bounded page size." + }, + { + "outputField": "inspection.arguments.version_id", + "localRole": "Inspect only the exact parent version." + }, + { + "outputField": "inspection.arguments.limit", + "localRole": "Use the maximum bounded page size of 200." + }, + { + "outputField": "inspection.continue_with_next_url", + "localRole": "Continue through every strict next_url page before deciding whether the reservation exists." + }, + { + "outputField": "inspection.next_url_argument", + "localRole": "Names next_url as the transport-only continuation input." + }, + { + "outputField": "inspection.candidate_match.fingerprint_key", + "localRole": "Match candidates against reservationFingerprint." + }, + { + "outputField": "inspection.candidate_match.candidate_fields", + "localRole": "Compare candidate file_name and file_size fields." + }, + { + "outputField": "inspection.candidate_match.require_unique_match_before_retry", + "localRole": "Retry only after inspection establishes a unique candidate outcome." + }, + { + "outputField": "cleanup", + "localRole": "Describe rollback state or retained-resource inspect/delete guidance." + }, + { + "outputField": "cleanup.status", + "localRole": "Rollback or retention state for the reserved resource." + }, + { + "outputField": "cleanup.resourceId", + "localRole": "Confirmed reserved resource ID when Apple returned one." + }, + { + "outputField": "cleanup.reason", + "localRole": "Reason cleanup failed, was unavailable, or was intentionally not attempted." + }, + { + "outputField": "cleanup.tool", + "localRole": "Explicit destructive cleanup tool when deletion remains available." + }, + { + "outputField": "cleanup.arguments", + "localRole": "Exact destructive cleanup arguments, including the confirmation ID." + }, + { + "outputField": "cleanup.arguments.image_id", + "localRole": "Use the exact retained reservation ID as the destructive cleanup target." + }, + { + "outputField": "cleanup.arguments.confirm_image_id", + "localRole": "Repeat the exact retained reservation ID as the required delete confirmation." + }, + { + "outputField": "cleanup.operationCommitState", + "localRole": "Expose unknown or committed commit reconciliation state." + }, + { + "outputField": "cleanup.outcomeUnknown", + "localRole": "True only when Apple may have committed the operation but reconciliation cannot prove it." + }, + { + "outputField": "cleanup.retrySafe", + "localRole": "False whenever retry could duplicate or destroy an unresolved upload." + }, + { + "outputField": "cleanup.inspectTool", + "localRole": "Read tool for retained-resource inspection." + }, + { + "outputField": "cleanup.inspectArguments", + "localRole": "Exact arguments for retained-resource inspection." + }, + { + "outputField": "cleanup.inspectArguments.image_id", + "localRole": "Inspect only the exact confirmed reservation ID." + }, + { + "outputField": "cleanup.statusCode", + "localRole": "Apple status code for a committed but unverified operation." + }, + { + "outputField": "cleanup.operationCommitted", + "localRole": "True when a 2xx response proves the operation was committed even though projection verification failed." + }, + { + "outputField": "cleanup.inspectionRequired", + "localRole": "True when the retained resource needs deterministic inspection." + } + ] + }, + "note": "The safe Apple 4.4.1 version-image workflow snapshots before reserve, transfers through signed operations, commits only uploaded=true because the v2 schema has no checksum field, reconciles processing, rolls back only pre-commit failures, and returns exact inspect/delete guidance for retained resources." + }, + { + "tool": "subscriptions_get_version_image", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionImagesV2_getInstance", + "method": "get", + "path": "/v2/subscriptionImages/{id}", + "role": "primary", + "condition": null + } + ], + "fields": [ + { + "toolField": "image_id", + "sourceKind": "parameter", + "operationId": "subscriptionImagesV2_getInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionImagesV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Gets one v2 subscription version image resource by exact ID while intentionally omitting Apple's opaque assetToken from the public projection." + }, + { + "tool": "subscriptions_delete_version_image", + "kind": "direct", + "status": "partial", + "effect": "destructive", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionImagesV2_deleteInstance", + "method": "delete", + "path": "/v2/subscriptionImages/{id}", + "role": "primary", + "condition": null + } + ], + "fields": [ + { + "toolField": "image_id", + "sourceKind": "parameter", + "operationId": "subscriptionImagesV2_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_image_id", + "sourceKind": "local", + "localRole": "Require an exact canonical match with image_id before any Apple request is sent." + } + ], + "response": { + "mode": "local", + "sources": [ + { + "operationId": "subscriptionImagesV2_deleteInstance", + "statusCode": "204" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "Set true after Apple confirms deletion with 204." + }, + { + "outputField": "image_id", + "localRole": "Echo the exact deleted image ID." + }, + { + "outputField": "deleted", + "localRole": "Set true after confirmed deletion." + }, + { + "outputField": "deletionState", + "localRole": "Set to confirmed after Apple's 204 response." + }, + { + "outputField": "outcomeUnknown", + "localRole": "Set false for a confirmed deletion." + }, + { + "outputField": "retrySafe", + "localRole": "Set false because the destructive operation is already confirmed." + } + ] + }, + "note": "Deletes one v2 subscription version image resource by exact ID." + }, + { + "tool": "subscriptions_create_group_version", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionGroupVersions_createInstance", + "method": "post", + "path": "/v1/subscriptionGroupVersions", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "subscriptionGroupVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/subscriptionGroup/data/type", + "fixedValue": "subscriptionGroups" + } + ] + } + ], + "fields": [ + { + "toolField": "group_id", + "sourceKind": "requestBody", + "operationId": "subscriptionGroupVersions_createInstance", + "jsonPointer": "/data/relationships/subscriptionGroup/data/id" + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "subscriptionGroupVersions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "Set true after the created group version and its identity pass validation." + }, + { + "outputField": "version", + "operationId": "subscriptionGroupVersions_createInstance", + "jsonPointer": "/data", + "localRole": "Project stable group-version fields and bounded localization-page metadata when Apple supplies it." + }, + { + "outputField": "version.localizations_page.ids", + "operationId": "subscriptionGroupVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "version.localizations_page.count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page." + }, + { + "outputField": "version.localizations_page.total", + "operationId": "subscriptionGroupVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/total" + }, + { + "outputField": "version.localizations_page.limit", + "operationId": "subscriptionGroupVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/limit" + }, + { + "outputField": "version.localizations_page.next_cursor", + "operationId": "subscriptionGroupVersions_createInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/nextCursor" + }, + { + "outputField": "version.localizations_page.truncated", + "localRole": "Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded localization ID count." + }, + { + "outputField": "version.localizations_page.completeness_known", + "localRole": "Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor." + } + ] + }, + "note": "Creates one explicit Apple 4.4.1 subscription group metadata version. An ambiguous POST or response decode returns write_outcome=not_confirmed, retrySafe=false, the group ID, and list/get recovery guidance instead of encouraging a duplicate create." + }, + { + "tool": "subscriptions_get_group_version", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionGroupVersions_getInstance", + "method": "get", + "path": "/v1/subscriptionGroupVersions/{id}", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The stable projection does not expose arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are paged through subscriptions_list_group_version_localizations.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "subscriptionGroupVersions_getInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "subscriptionGroupVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "Set true after the group version identity and self link pass validation." + }, + { + "outputField": "version", + "operationId": "subscriptionGroupVersions_getInstance", + "jsonPointer": "/data", + "localRole": "Project stable group-version fields and bounded localization-page metadata when Apple supplies it." + }, + { + "outputField": "version.localizations_page.ids", + "operationId": "subscriptionGroupVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "version.localizations_page.count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page." + }, + { + "outputField": "version.localizations_page.total", + "operationId": "subscriptionGroupVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/total" + }, + { + "outputField": "version.localizations_page.limit", + "operationId": "subscriptionGroupVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/limit" + }, + { + "outputField": "version.localizations_page.next_cursor", + "operationId": "subscriptionGroupVersions_getInstance", + "jsonPointer": "/data/relationships/localizations/meta/paging/nextCursor" + }, + { + "outputField": "version.localizations_page.truncated", + "localRole": "Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded localization ID count." + }, + { + "outputField": "version.localizations_page.completeness_known", + "localRole": "Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor." + } + ] + }, + "note": "Returns the stable projection for one discrete subscription group version." + }, + { + "tool": "subscriptions_list_group_versions", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionGroups_versions_getToManyRelated", + "method": "get", + "path": "/v1/subscriptionGroups/{id}/versions", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The stable paginated projection does not expose arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations have their own bounded continuation tool.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "group_id", + "sourceKind": "parameter", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "filter_state", + "sourceKind": "parameter", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "location": "query", + "appleName": "filter[state]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Continue only an Apple URL whose origin, path, fixed filter, limit, unique non-empty cursor, and parameter set match the original request." + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "subscriptionGroups_versions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "Set true after the page passes parent identity, paging, and self-link validation." + }, + { + "outputField": "versions", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Project stable group-version fields and bounded localization-page metadata when Apple supplies it." + }, + { + "outputField": "versions.*.localizations_page.ids", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/data/*/id", + "localRole": "Emit null when Apple omits relationship.data; preserve an explicit empty data array as []." + }, + { + "outputField": "versions.*.localizations_page.count", + "localRole": "Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page." + }, + { + "outputField": "versions.*.localizations_page.total", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/meta/paging/total" + }, + { + "outputField": "versions.*.localizations_page.limit", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/meta/paging/limit" + }, + { + "outputField": "versions.*.localizations_page.next_cursor", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "jsonPointer": "/data/*/relationships/localizations/meta/paging/nextCursor" + }, + { + "outputField": "versions.*.localizations_page.truncated", + "localRole": "Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds that version's embedded localization ID count." + }, + { + "outputField": "versions.*.localizations_page.completeness_known", + "localRole": "Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor." + }, + { + "outputField": "count", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "jsonPointer": "/data", + "localRole": "Current validated Apple page resource count." + }, + { + "outputField": "total", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "jsonPointer": "/meta/paging/total" + }, + { + "outputField": "next_url", + "operationId": "subscriptionGroups_versions_getToManyRelated", + "jsonPointer": "/links/next", + "localRole": "Apple continuation URL when another page exists; otherwise omitted." + } + ] + }, + "note": "Lists Apple 4.4.1 subscription group versions with exact state validation and scope-locked pagination." + }, + { + "tool": "subscriptions_list_group_version_localizations", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionGroupVersions_localizations_getToManyRelated", + "method": "get", + "path": "/v1/subscriptionGroupVersions/{id}/localizations", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The stable projection does not expose arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "subscriptionGroupVersions_localizations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "subscriptionGroupVersions_localizations_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Continue only an Apple URL whose origin, path, limit, unique non-empty cursor, and parameter set match the original request." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionGroupVersions_localizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Lists localizations owned by one explicit subscription group version." + }, + { + "tool": "subscriptions_create_group_version_localization", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionGroupLocalizationsV2_createInstance", + "method": "post", + "path": "/v2/subscriptionGroupLocalizations", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "subscriptionGroupLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/version/data/type", + "fixedValue": "subscriptionGroupVersions" + } + ] + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "requestBody", + "operationId": "subscriptionGroupLocalizationsV2_createInstance", + "jsonPointer": "/data/relationships/version/data/id" + }, + { + "toolField": "locale", + "sourceKind": "requestBody", + "operationId": "subscriptionGroupLocalizationsV2_createInstance", + "jsonPointer": "/data/attributes/locale" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "subscriptionGroupLocalizationsV2_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "custom_app_name", + "sourceKind": "requestBody", + "operationId": "subscriptionGroupLocalizationsV2_createInstance", + "jsonPointer": "/data/attributes/customAppName" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionGroupLocalizationsV2_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Creates localization metadata directly under an explicit group version and preserves omitted, string, and null customAppName semantics. An ambiguous POST or response decode returns write_outcome=not_confirmed, retrySafe=false, the requested parent and metadata fingerprint, and list/get recovery guidance instead of encouraging a duplicate localization." + }, + { + "tool": "subscriptions_get_group_version_localization", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionGroupLocalizationsV2_getInstance", + "method": "get", + "path": "/v2/subscriptionGroupLocalizations/{id}", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The stable projection does not expose arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "subscriptionGroupLocalizationsV2_getInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionGroupLocalizationsV2_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Gets one v2 subscription group version localization by resource ID." + }, + { + "tool": "subscriptions_update_group_version_localization", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionGroupLocalizationsV2_updateInstance", + "method": "patch", + "path": "/v2/subscriptionGroupLocalizations/{id}", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "subscriptionGroupLocalizations" + } + ] + } + ], + "fields": [ + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "subscriptionGroupLocalizationsV2_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "localization_id", + "sourceKind": "requestBody", + "operationId": "subscriptionGroupLocalizationsV2_updateInstance", + "jsonPointer": "/data/id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "subscriptionGroupLocalizationsV2_updateInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "custom_app_name", + "sourceKind": "requestBody", + "operationId": "subscriptionGroupLocalizationsV2_updateInstance", + "jsonPointer": "/data/attributes/customAppName" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptionGroupLocalizationsV2_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Updates at least one v2 group localization attribute and preserves string versus explicit null." + }, + { + "tool": "subscriptions_delete_group_version_localization", + "kind": "direct", + "status": "partial", + "effect": "destructive", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptionGroupLocalizationsV2_deleteInstance", + "method": "delete", + "path": "/v2/subscriptionGroupLocalizations/{id}", + "role": "primary", + "condition": null + } + ], + "fields": [ + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "subscriptionGroupLocalizationsV2_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_localization_id", + "sourceKind": "local", + "localRole": "Require an exact canonical match with localization_id before any Apple request is sent." + } + ], + "response": { + "mode": "local", + "sources": [ + { + "operationId": "subscriptionGroupLocalizationsV2_deleteInstance", + "statusCode": "204" + } + ], + "fields": [ + { + "outputField": "success", + "localRole": "Set true after Apple confirms deletion with 204." + }, + { + "outputField": "localization_id", + "localRole": "Echo the exact deleted localization ID." + }, + { + "outputField": "deleted", + "localRole": "Set true after confirmed deletion." + }, + { + "outputField": "deletionState", + "localRole": "Set to confirmed after Apple's 204 response." + }, + { + "outputField": "outcomeUnknown", + "localRole": "Set false for a confirmed deletion." + }, + { + "outputField": "retrySafe", + "localRole": "Set false because the destructive operation is already confirmed." + } + ] + }, + "note": "Deletes one v2 group localization resource by its exact ID." + }, + { + "tool": "subscriptions_list_retention_messages", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "apps_retentionMessages_getToManyRelated", + "method": "get", + "path": "/v1/apps/{id}/retentionMessages", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated tools cover versions and subscriptions.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptions]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_message_subscriptions provides paginated access.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[versions]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_message_versions provides paginated access.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_retentionMessages_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_retentionMessages_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Validated Apple pagination URL override." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "apps_retentionMessages_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Lists retention messages for an app with bounded pagination." + }, + { + "tool": "subscriptions_get_retention_message", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessages_getInstance", + "method": "get", + "path": "/v1/retentionMessages/{id}", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated tools cover versions and subscriptions.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptions]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_message_subscriptions provides paginated access.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[versions]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_message_versions provides paginated access.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "retention_message_id", + "sourceKind": "parameter", + "operationId": "retentionMessages_getInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessages_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Gets a single retention message by ID." + }, + { + "tool": "subscriptions_create_retention_message", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessages_createInstance", + "method": "post", + "path": "/v1/retentionMessages", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "retentionMessages" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + } + ] + } + ], + "fields": [ + { + "toolField": "app_id", + "sourceKind": "requestBody", + "operationId": "retentionMessages_createInstance", + "jsonPointer": "/data/relationships/app/data/id" + }, + { + "toolField": "reference_name", + "sourceKind": "requestBody", + "operationId": "retentionMessages_createInstance", + "jsonPointer": "/data/attributes/referenceName" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessages_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Creates a retention message for an app." + }, + { + "tool": "subscriptions_delete_retention_message", + "kind": "direct", + "status": "partial", + "effect": "destructive", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessages_deleteInstance", + "method": "delete", + "path": "/v1/retentionMessages/{id}", + "role": "primary", + "condition": null + } + ], + "fields": [ + { + "toolField": "retention_message_id", + "sourceKind": "parameter", + "operationId": "retentionMessages_deleteInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessages_deleteInstance", + "statusCode": "204" + } + ], + "fields": [] + }, + "note": "Deletes a retention message by ID." + }, + { + "tool": "subscriptions_list_retention_message_versions", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessages_versions_getToManyRelated", + "method": "get", + "path": "/v1/retentionMessages/{id}/versions", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated tools cover localizations and placements.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_message_localizations provides paginated access.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "retention_message_id", + "sourceKind": "parameter", + "operationId": "retentionMessages_versions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "retentionMessages_versions_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Validated Apple pagination URL override." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessages_versions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Lists versions for a retention message." + }, + { + "tool": "subscriptions_get_retention_message_version", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessageVersions_getInstance", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; dedicated tools cover localizations and placements.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[localizations]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_message_localizations provides paginated access.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "retentionMessageVersions_getInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessageVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Gets a single retention message version by ID." + }, + { + "tool": "subscriptions_create_retention_message_version", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessageVersions_createInstance", + "method": "post", + "path": "/v1/retentionMessageVersions", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "body", + "appleName": "/data/relationships/placement", + "disposition": "intentionallyOmitted", + "reason": "Retention message version placements are managed through the dedicated Asset Library placement tools.", + "reviewAtSpec": "4.6" + } + ], + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "retentionMessageVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/retentionMessage/data/type", + "fixedValue": "retentionMessages" + } + ] + } + ], + "fields": [ + { + "toolField": "retention_message_id", + "sourceKind": "requestBody", + "operationId": "retentionMessageVersions_createInstance", + "jsonPointer": "/data/relationships/retentionMessage/data/id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessageVersions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Creates a new version for a retention message." + }, + { + "tool": "subscriptions_list_retention_message_subscriptions", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessages_subscriptions_getToManyRelated", + "method": "get", + "path": "/v1/retentionMessages/{id}/subscriptions", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "filter[productId]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[name]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "filter[state]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "sort", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[introductoryOffers]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[promotionalOffers]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[offerCodes]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[prices]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[winBackOffers]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[images]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[planAvailabilities]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[versions]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionOffers]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionMessageOffers]", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns the base list of subscriptions linked to this retention message; dedicated subscription tools cover filtering, sorting, and nested relationships.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "retention_message_id", + "sourceKind": "parameter", + "operationId": "retentionMessages_subscriptions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "retentionMessages_subscriptions_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Validated Apple pagination URL override." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessages_subscriptions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Lists subscriptions linked to a retention message." + }, + { + "tool": "subscriptions_list_retention_message_localizations", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessageVersions_localizations_getToManyRelated", + "method": "get", + "path": "/v1/retentionMessageVersions/{id}/localizations", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "parameter", + "operationId": "retentionMessageVersions_localizations_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "retentionMessageVersions_localizations_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Validated Apple pagination URL override." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessageVersions_localizations_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Lists localizations for a retention message version." + }, { - "tool":"subscriptions_get_version_localization","kind":"direct","status":"partial","effect":"read","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionLocalizationsV2_getInstance","method":"get","path":"/v2/subscriptionLocalizations/{id}","role":"primary","condition":null,"optionalParameterClassifications":[ - {"location":"query","appleName":"include","disposition":"intentionallyOmitted","reason":"The stable projection does not expose arbitrary relationship expansion.","reviewAtSpec":"4.5.1"} - ]}], - "fields":[{"toolField":"localization_id","sourceKind":"parameter","operationId":"subscriptionLocalizationsV2_getInstance","location":"path","appleName":"id"}], - "response":{"mode":"opaque","sources":[{"operationId":"subscriptionLocalizationsV2_getInstance","statusCode":"200","mediaType":"application/json"}],"fields":[]}, - "note":"Gets one v2 subscription version localization by resource ID." + "tool": "subscriptions_get_retention_message_localization", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessageLocalizations_getInstance", + "method": "get", + "path": "/v1/retentionMessageLocalizations/{id}", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "retentionMessageLocalizations_getInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessageLocalizations_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Gets a single retention message localization by ID." }, { - "tool":"subscriptions_update_version_localization","kind":"direct","status":"partial","effect":"write","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionLocalizationsV2_updateInstance","method":"patch","path":"/v2/subscriptionLocalizations/{id}","role":"primary","condition":null,"inputs":[{"sourceKind":"fixed","jsonPointer":"/data/type","fixedValue":"subscriptionLocalizations"}]}], - "fields":[ - {"toolField":"localization_id","sourceKind":"parameter","operationId":"subscriptionLocalizationsV2_updateInstance","location":"path","appleName":"id"}, - {"toolField":"localization_id","sourceKind":"requestBody","operationId":"subscriptionLocalizationsV2_updateInstance","jsonPointer":"/data/id"}, - {"toolField":"name","sourceKind":"requestBody","operationId":"subscriptionLocalizationsV2_updateInstance","jsonPointer":"/data/attributes/name"}, - {"toolField":"description","sourceKind":"requestBody","operationId":"subscriptionLocalizationsV2_updateInstance","jsonPointer":"/data/attributes/description"} - ], - "response":{"mode":"opaque","sources":[{"operationId":"subscriptionLocalizationsV2_updateInstance","statusCode":"200","mediaType":"application/json"}],"fields":[]}, - "note":"Updates at least one v2 localization attribute and preserves string versus explicit null." + "tool": "subscriptions_create_retention_message_localization", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessageLocalizations_createInstance", + "method": "post", + "path": "/v1/retentionMessageLocalizations", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "retentionMessageLocalizations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/retentionMessageVersion/data/type", + "fixedValue": "retentionMessageVersions" + } + ] + } + ], + "fields": [ + { + "toolField": "version_id", + "sourceKind": "requestBody", + "operationId": "retentionMessageLocalizations_createInstance", + "jsonPointer": "/data/relationships/retentionMessageVersion/data/id" + }, + { + "toolField": "locale", + "sourceKind": "requestBody", + "operationId": "retentionMessageLocalizations_createInstance", + "jsonPointer": "/data/attributes/locale" + }, + { + "toolField": "header", + "sourceKind": "requestBody", + "operationId": "retentionMessageLocalizations_createInstance", + "jsonPointer": "/data/attributes/header" + }, + { + "toolField": "body", + "sourceKind": "requestBody", + "operationId": "retentionMessageLocalizations_createInstance", + "jsonPointer": "/data/attributes/body" + }, + { + "toolField": "allow_price_mentions", + "sourceKind": "local", + "localRole": "Controls local App Review copy safety validation for currency, discount, and price mentions." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessageLocalizations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Validates character limits, emojis, and price/discount mentions before creating a retention message localization." }, { - "tool":"subscriptions_delete_version_localization","kind":"direct","status":"partial","effect":"destructive","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionLocalizationsV2_deleteInstance","method":"delete","path":"/v2/subscriptionLocalizations/{id}","role":"primary","condition":null}], - "fields":[ - {"toolField":"localization_id","sourceKind":"parameter","operationId":"subscriptionLocalizationsV2_deleteInstance","location":"path","appleName":"id"}, - {"toolField":"confirm_localization_id","sourceKind":"local","localRole":"Require an exact canonical match with localization_id before any Apple request is sent."} - ], - "response":{"mode":"local","sources":[{"operationId":"subscriptionLocalizationsV2_deleteInstance","statusCode":"204"}],"fields":[ - {"outputField":"success","localRole":"Set true after Apple confirms deletion with 204."}, - {"outputField":"localization_id","localRole":"Echo the exact deleted localization ID."}, - {"outputField":"deleted","localRole":"Set true after confirmed deletion."}, - {"outputField":"deletionState","localRole":"Set to confirmed after Apple's 204 response."}, - {"outputField":"outcomeUnknown","localRole":"Set false for a confirmed deletion."}, - {"outputField":"retrySafe","localRole":"Set false because the destructive operation is already confirmed."} - ]}, - "note":"Deletes one v2 localization resource by its exact ID." + "tool": "subscriptions_update_retention_message_localization", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessageLocalizations_updateInstance", + "method": "patch", + "path": "/v1/retentionMessageLocalizations/{id}", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "retentionMessageLocalizations" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "localization_id" + ], + "localRole": "Reuse the public localization ID as the JSON:API resource ID in the update body." + } + ] + } + ], + "fields": [ + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "retentionMessageLocalizations_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "header", + "sourceKind": "requestBody", + "operationId": "retentionMessageLocalizations_updateInstance", + "jsonPointer": "/data/attributes/header" + }, + { + "toolField": "body", + "sourceKind": "requestBody", + "operationId": "retentionMessageLocalizations_updateInstance", + "jsonPointer": "/data/attributes/body" + }, + { + "toolField": "allow_price_mentions", + "sourceKind": "local", + "localRole": "Controls local App Review copy safety validation for currency, discount, and price mentions." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessageLocalizations_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Validates character limits, emojis, and price/discount mentions before updating a retention message localization." }, { - "tool":"subscriptions_list_version_images","kind":"direct","status":"partial","effect":"read","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionVersions_images_getToManyRelated","method":"get","path":"/v1/subscriptionVersions/{id}/images","role":"primary","condition":null}], - "fields":[ - {"toolField":"version_id","sourceKind":"parameter","operationId":"subscriptionVersions_images_getToManyRelated","location":"path","appleName":"id"}, - {"toolField":"limit","sourceKind":"parameter","operationId":"subscriptionVersions_images_getToManyRelated","location":"query","appleName":"limit"}, - {"toolField":"next_url","sourceKind":"local","localRole":"Continue only an Apple URL whose origin, path, limit, unique non-empty cursor, and parameter set match the original request."} - ], - "response":{"mode":"opaque","sources":[{"operationId":"subscriptionVersions_images_getToManyRelated","statusCode":"200","mediaType":"application/json"}],"fields":[]}, - "note":"Lists all promotional images owned by one explicit subscription version while intentionally omitting Apple's opaque assetToken from the public projection." + "tool": "subscriptions_delete_retention_message_localization", + "kind": "direct", + "status": "partial", + "effect": "destructive", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionMessageLocalizations_deleteInstance", + "method": "delete", + "path": "/v1/retentionMessageLocalizations/{id}", + "role": "primary", + "condition": null + } + ], + "fields": [ + { + "toolField": "localization_id", + "sourceKind": "parameter", + "operationId": "retentionMessageLocalizations_deleteInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionMessageLocalizations_deleteInstance", + "statusCode": "204" + } + ], + "fields": [] + }, + "note": "Deletes a retention message localization by ID." }, { - "tool":"subscriptions_upload_version_image","kind":"compound","status":"partial","effect":"write","implementationState":"asBuilt", - "operations":[ - {"operationId":"subscriptionImagesV2_createInstance","method":"post","path":"/v2/subscriptionImages","role":"primary","condition":null,"inputs":[ - {"sourceKind":"fixed","jsonPointer":"/data/type","fixedValue":"subscriptionImages"}, - {"sourceKind":"fixed","jsonPointer":"/data/relationships/version/data/type","fixedValue":"subscriptionVersions"} - ]}, - {"operationId":"subscriptionImagesV2_updateInstance","method":"patch","path":"/v2/subscriptionImages/{id}","role":"supporting","condition":null,"inputs":[ - {"sourceKind":"derived","location":"path","appleName":"id","derivedFrom":["subscriptionImagesV2_createInstance:/data/id"],"localRole":"Use Apple's reserved image ID as the commit path ID."}, - {"sourceKind":"fixed","jsonPointer":"/data/type","fixedValue":"subscriptionImages"}, - {"sourceKind":"derived","jsonPointer":"/data/id","derivedFrom":["subscriptionImagesV2_createInstance:/data/id"],"localRole":"Use Apple's reserved image ID as the commit resource ID."}, - {"sourceKind":"fixed","jsonPointer":"/data/attributes/uploaded","fixedValue":true} - ]}, - {"operationId":"subscriptionImagesV2_getInstance","method":"get","path":"/v2/subscriptionImages/{id}","role":"conditional","condition":"After PATCH returns a nonterminal assetDeliveryState, or when PATCH is ambiguous, reconcile and poll the exact reserved image.","inputs":[ - {"sourceKind":"derived","location":"path","appleName":"id","derivedFrom":["subscriptionImagesV2_createInstance:/data/id"],"localRole":"Inspect the exact image created by the reservation."} - ]}, - {"operationId":"subscriptionImagesV2_deleteInstance","method":"delete","path":"/v2/subscriptionImages/{id}","role":"conditional","condition":"Before commit, best-effort delete a confirmed reservation after cancellation, missing upload operations, transfer failure, or commit-body failure; treat 404 as already absent.","inputs":[ - {"sourceKind":"derived","location":"path","appleName":"id","derivedFrom":["subscriptionImagesV2_createInstance:/data/id"],"localRole":"Rollback only the confirmed reservation for this upload attempt."} - ]} - ], - "fields":[ - {"toolField":"version_id","sourceKind":"requestBody","operationId":"subscriptionImagesV2_createInstance","jsonPointer":"/data/relationships/version/data/id"}, - {"toolField":"file_path","sourceKind":"derived","operationId":"subscriptionImagesV2_createInstance","jsonPointer":"/data/attributes","derivedFrom":["file_path"],"localRole":"Create an immutable snapshot, derive fileName and fileSize, transfer its bytes through Apple's signed operations, and discard it after reconciliation."} - ], - "response":{"mode":"opaque","sources":[ - {"operationId":"subscriptionImagesV2_createInstance","statusCode":"201","mediaType":"application/json"}, - {"operationId":"subscriptionImagesV2_updateInstance","statusCode":"200","mediaType":"application/json"}, - {"operationId":"subscriptionImagesV2_getInstance","statusCode":"200","mediaType":"application/json"}, - {"operationId":"subscriptionImagesV2_deleteInstance","statusCode":"204"} - ],"fields":[ - {"outputField":"success","localRole":"False on structured recovery failures; true on completed or accepted upload results."}, - {"outputField":"error","localRole":"Stable failure summary when reservation or commit verification cannot complete."}, - {"outputField":"statusCode","localRole":"Apple status code when a 2xx reservation response was committed but could not be verified."}, - {"outputField":"reservationState","localRole":"Unknown or committed_unverified reservation state for ambiguous reserve outcomes."}, - {"outputField":"reservationIdKnown","localRole":"False when Apple did not return a safely attributable reservation ID."}, - {"outputField":"operationCommitState","localRole":"Unknown when Apple may have committed an operation that cannot be reconciled."}, - {"outputField":"operationCommitted","localRole":"True when a 2xx response proves commit despite response verification failure."}, - {"outputField":"outcomeUnknown","localRole":"True when Apple may have committed the operation and safe retry cannot be established."}, - {"outputField":"inspectionRequired","localRole":"True when deterministic collection or exact-resource inspection is required."}, - {"outputField":"retrySafe","localRole":"False for all unresolved, committed-unverified, retained, or confirmed destructive outcomes."}, - {"outputField":"reservationFingerprint","localRole":"Stable reservation fingerprint emitted when the reserve outcome cannot be identified safely."}, - {"outputField":"reservationFingerprint.file_name","localRole":"Snapshot file name used to match inspection candidates."}, - {"outputField":"reservationFingerprint.file_size","localRole":"Snapshot byte count used to match inspection candidates."}, - {"outputField":"reservationFingerprint.checksum","localRole":"Snapshot checksum used as the authoritative reservation fingerprint."}, - {"outputField":"inspection","localRole":"Full-pagination reservation inspection guidance for ambiguous create outcomes."}, - {"outputField":"inspection.tool","localRole":"Use subscriptions_list_version_images for collection recovery."}, - {"outputField":"inspection.arguments","localRole":"Scope the collection inspection to the parent version and a bounded page size."}, - {"outputField":"inspection.arguments.version_id","localRole":"Inspect only the exact parent version."}, - {"outputField":"inspection.arguments.limit","localRole":"Use the maximum bounded page size of 200."}, - {"outputField":"inspection.continue_with_next_url","localRole":"Continue through every strict next_url page before deciding whether the reservation exists."}, - {"outputField":"inspection.next_url_argument","localRole":"Names next_url as the transport-only continuation input."}, - {"outputField":"inspection.candidate_match.fingerprint_key","localRole":"Match candidates against reservationFingerprint."}, - {"outputField":"inspection.candidate_match.candidate_fields","localRole":"Compare candidate file_name and file_size fields."}, - {"outputField":"inspection.candidate_match.require_unique_match_before_retry","localRole":"Retry only after inspection establishes a unique candidate outcome."}, - {"outputField":"cleanup","localRole":"Describe rollback state or retained-resource inspect/delete guidance."}, - {"outputField":"cleanup.status","localRole":"Rollback or retention state for the reserved resource."}, - {"outputField":"cleanup.resourceId","localRole":"Confirmed reserved resource ID when Apple returned one."}, - {"outputField":"cleanup.reason","localRole":"Reason cleanup failed, was unavailable, or was intentionally not attempted."}, - {"outputField":"cleanup.tool","localRole":"Explicit destructive cleanup tool when deletion remains available."}, - {"outputField":"cleanup.arguments","localRole":"Exact destructive cleanup arguments, including the confirmation ID."}, - {"outputField":"cleanup.arguments.image_id","localRole":"Use the exact retained reservation ID as the destructive cleanup target."}, - {"outputField":"cleanup.arguments.confirm_image_id","localRole":"Repeat the exact retained reservation ID as the required delete confirmation."}, - {"outputField":"cleanup.operationCommitState","localRole":"Expose unknown or committed commit reconciliation state."}, - {"outputField":"cleanup.outcomeUnknown","localRole":"True only when Apple may have committed the operation but reconciliation cannot prove it."}, - {"outputField":"cleanup.retrySafe","localRole":"False whenever retry could duplicate or destroy an unresolved upload."}, - {"outputField":"cleanup.inspectTool","localRole":"Read tool for retained-resource inspection."}, - {"outputField":"cleanup.inspectArguments","localRole":"Exact arguments for retained-resource inspection."}, - {"outputField":"cleanup.inspectArguments.image_id","localRole":"Inspect only the exact confirmed reservation ID."}, - {"outputField":"cleanup.statusCode","localRole":"Apple status code for a committed but unverified operation."}, - {"outputField":"cleanup.operationCommitted","localRole":"True when a 2xx response proves the operation was committed even though projection verification failed."}, - {"outputField":"cleanup.inspectionRequired","localRole":"True when the retained resource needs deterministic inspection."} - ]}, - "note":"The safe Apple 4.4.1 version-image workflow snapshots before reserve, transfers through signed operations, commits only uploaded=true because the v2 schema has no checksum field, reconciles processing, rolls back only pre-commit failures, and returns exact inspect/delete guidance for retained resources." + "tool": "subscriptions_list_retention_offers", + "kind": "compound", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptions_retentionOffers_getToManyRelated", + "method": "get", + "path": "/v1/subscriptions/{id}/retentionOffers", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; subscriptions_list_retention_offer_prices covers prices.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[prices]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_offer_prices provides paginated access.", + "reviewAtSpec": "4.6" + } + ] + }, + { + "operationId": "subscriptions_retentionMessageOffers_getToManyRelated", + "method": "get", + "path": "/v1/subscriptions/{id}/retentionMessageOffers", + "role": "conditional", + "condition": "message_offers_only is true", + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; subscriptions_list_retention_offer_prices covers prices.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[prices]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_offer_prices provides paginated access.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "subscription_id", + "sourceKind": "parameter", + "operationId": "subscriptions_retentionOffers_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "subscription_id", + "sourceKind": "parameter", + "operationId": "subscriptions_retentionMessageOffers_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "subscriptions_retentionOffers_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "subscriptions_retentionMessageOffers_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "message_offers_only", + "sourceKind": "local", + "localRole": "Selects /v1/subscriptions/{id}/retentionMessageOffers when true, or /v1/subscriptions/{id}/retentionOffers when false." + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Validated Apple pagination URL override." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptions_retentionOffers_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "subscriptions_retentionMessageOffers_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Lists retention offers or retention-message-linked offers for a subscription." }, { - "tool":"subscriptions_get_version_image","kind":"direct","status":"partial","effect":"read","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionImagesV2_getInstance","method":"get","path":"/v2/subscriptionImages/{id}","role":"primary","condition":null}], - "fields":[{"toolField":"image_id","sourceKind":"parameter","operationId":"subscriptionImagesV2_getInstance","location":"path","appleName":"id"}], - "response":{"mode":"opaque","sources":[{"operationId":"subscriptionImagesV2_getInstance","statusCode":"200","mediaType":"application/json"}],"fields":[]}, - "note":"Gets one v2 subscription version image resource by exact ID while intentionally omitting Apple's opaque assetToken from the public projection." + "tool": "subscriptions_get_retention_offer", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionOffers_getInstance", + "method": "get", + "path": "/v1/retentionOffers/{id}", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion; subscriptions_list_retention_offer_prices covers prices.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[prices]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_offer_prices provides paginated access.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "offer_id", + "sourceKind": "parameter", + "operationId": "retentionOffers_getInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionOffers_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Gets a single retention offer by ID." }, { - "tool":"subscriptions_delete_version_image","kind":"direct","status":"partial","effect":"destructive","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionImagesV2_deleteInstance","method":"delete","path":"/v2/subscriptionImages/{id}","role":"primary","condition":null}], - "fields":[ - {"toolField":"image_id","sourceKind":"parameter","operationId":"subscriptionImagesV2_deleteInstance","location":"path","appleName":"id"}, - {"toolField":"confirm_image_id","sourceKind":"local","localRole":"Require an exact canonical match with image_id before any Apple request is sent."} - ], - "response":{"mode":"local","sources":[{"operationId":"subscriptionImagesV2_deleteInstance","statusCode":"204"}],"fields":[ - {"outputField":"success","localRole":"Set true after Apple confirms deletion with 204."}, - {"outputField":"image_id","localRole":"Echo the exact deleted image ID."}, - {"outputField":"deleted","localRole":"Set true after confirmed deletion."}, - {"outputField":"deletionState","localRole":"Set to confirmed after Apple's 204 response."}, - {"outputField":"outcomeUnknown","localRole":"Set false for a confirmed deletion."}, - {"outputField":"retrySafe","localRole":"Set false because the destructive operation is already confirmed."} - ]}, - "note":"Deletes one v2 subscription version image resource by exact ID." + "tool": "subscriptions_create_retention_offer", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionOffers_createInstance", + "method": "post", + "path": "/v1/retentionOffers", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "retentionOffers" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/subscription/data/type", + "fixedValue": "subscriptions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/prices/data/*/type", + "fixedValue": "retentionOfferPrices" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/relationships/prices/data/*/id", + "derivedFrom": [ + "price_point_ids" + ], + "localRole": "Generate the same ${price-index} linkage IDs used by inline retention offer price resources." + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/attributes/offerId", + "derivedFrom": [ + "reference_name" + ], + "localRole": "Offer identifier validated alongside the retention offer creation payload." + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/attributes/customerEligibilityPaidSubscriptionDurationInMonths", + "derivedFrom": [ + "eligibility_duration_type", + "eligibility_duration_min", + "eligibility_duration_max" + ], + "localRole": "Constructs the paid subscription duration eligibility range from eligibility_duration_type, eligibility_duration_min, and eligibility_duration_max." + } + ], + "optionalParameterClassifications": [ + { + "location": "body", + "appleName": "/data/attributes/targetSubscriptionPlanType", + "disposition": "intentionallyOmitted", + "reason": "The retention offer create tool targets the parent subscription's plan configuration without exposing a separate targetSubscriptionPlanType selector.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "subscription_id", + "sourceKind": "requestBody", + "operationId": "retentionOffers_createInstance", + "jsonPointer": "/data/relationships/subscription/data/id" + }, + { + "toolField": "reference_name", + "sourceKind": "requestBody", + "operationId": "retentionOffers_createInstance", + "jsonPointer": "/data/attributes/referenceName" + }, + { + "toolField": "duration", + "sourceKind": "requestBody", + "operationId": "retentionOffers_createInstance", + "jsonPointer": "/data/attributes/duration" + }, + { + "toolField": "offer_mode", + "sourceKind": "requestBody", + "operationId": "retentionOffers_createInstance", + "jsonPointer": "/data/attributes/offerMode" + }, + { + "toolField": "periods", + "sourceKind": "requestBody", + "operationId": "retentionOffers_createInstance", + "jsonPointer": "/data/attributes/periodCount" + }, + { + "toolField": "eligibility_duration_type", + "sourceKind": "local", + "localRole": "Validated locally alongside eligibility_duration_min and eligibility_duration_max before constructing the retention offer payload." + }, + { + "toolField": "eligibility_duration_min", + "sourceKind": "local", + "localRole": "Validated locally as the minimum paid subscription duration in months for AT_LEAST and RANGE rules." + }, + { + "toolField": "eligibility_duration_max", + "sourceKind": "local", + "localRole": "Validated locally as the maximum paid subscription duration in months for UP_TO and RANGE rules." + }, + { + "toolField": "wait_between_offers_months", + "sourceKind": "requestBody", + "operationId": "retentionOffers_createInstance", + "jsonPointer": "/data/attributes/customerEligibilityWaitBetweenOffersInMonths" + }, + { + "toolField": "territory_ids", + "sourceKind": "local", + "localRole": "Validated one-to-one against price_point_ids and encoded into inline retentionOfferPrices resources." + }, + { + "toolField": "price_point_ids", + "sourceKind": "requestBody", + "operationId": "retentionOffers_createInstance", + "jsonPointer": "/included", + "localRole": "Creates inline retentionOfferPrices resources with subscriptionPricePoint and territory relationships." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionOffers_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Creates a retention offer with inline territory pricing and validated eligibility rules." }, { - "tool":"subscriptions_create_group_version","kind":"direct","status":"partial","effect":"write","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionGroupVersions_createInstance","method":"post","path":"/v1/subscriptionGroupVersions","role":"primary","condition":null,"inputs":[ - {"sourceKind":"fixed","jsonPointer":"/data/type","fixedValue":"subscriptionGroupVersions"}, - {"sourceKind":"fixed","jsonPointer":"/data/relationships/subscriptionGroup/data/type","fixedValue":"subscriptionGroups"} - ]}], - "fields":[{"toolField":"group_id","sourceKind":"requestBody","operationId":"subscriptionGroupVersions_createInstance","jsonPointer":"/data/relationships/subscriptionGroup/data/id"}], - "response":{ - "mode":"projection", - "sources":[{"operationId":"subscriptionGroupVersions_createInstance","statusCode":"201","mediaType":"application/json"}], - "fields":[ - {"outputField":"success","localRole":"Set true after the created group version and its identity pass validation."}, - {"outputField":"version","operationId":"subscriptionGroupVersions_createInstance","jsonPointer":"/data","localRole":"Project stable group-version fields and bounded localization-page metadata when Apple supplies it."}, - {"outputField":"version.localizations_page.ids","operationId":"subscriptionGroupVersions_createInstance","jsonPointer":"/data/relationships/localizations/data/*/id","localRole":"Emit null when Apple omits relationship.data; preserve an explicit empty data array as []."}, - {"outputField":"version.localizations_page.count","localRole":"Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page."}, - {"outputField":"version.localizations_page.total","operationId":"subscriptionGroupVersions_createInstance","jsonPointer":"/data/relationships/localizations/meta/paging/total"}, - {"outputField":"version.localizations_page.limit","operationId":"subscriptionGroupVersions_createInstance","jsonPointer":"/data/relationships/localizations/meta/paging/limit"}, - {"outputField":"version.localizations_page.next_cursor","operationId":"subscriptionGroupVersions_createInstance","jsonPointer":"/data/relationships/localizations/meta/paging/nextCursor"}, - {"outputField":"version.localizations_page.truncated","localRole":"Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded localization ID count."}, - {"outputField":"version.localizations_page.completeness_known","localRole":"Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor."} - ] + "tool": "subscriptions_update_retention_offer", + "kind": "direct", + "status": "partial", + "effect": "write", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionOffers_updateInstance", + "method": "patch", + "path": "/v1/retentionOffers/{id}", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "retentionOffers" + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "offer_id" + ], + "localRole": "Reuse the public retention-offer ID as the JSON:API resource ID in the update body." + }, + { + "sourceKind": "derived", + "jsonPointer": "/data/attributes/customerEligibilityPaidSubscriptionDurationInMonths", + "derivedFrom": [ + "eligibility_duration_type", + "eligibility_duration_min", + "eligibility_duration_max" + ], + "localRole": "Updates or clears the paid subscription duration eligibility range from eligibility_duration_type, eligibility_duration_min, and eligibility_duration_max." + } + ] + } + ], + "fields": [ + { + "toolField": "offer_id", + "sourceKind": "parameter", + "operationId": "retentionOffers_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "eligibility_duration_type", + "sourceKind": "local", + "localRole": "Validated locally alongside eligibility_duration_min and eligibility_duration_max when provided." + }, + { + "toolField": "eligibility_duration_min", + "sourceKind": "local", + "localRole": "Validated locally as the minimum paid subscription duration in months when updating eligibility." + }, + { + "toolField": "eligibility_duration_max", + "sourceKind": "local", + "localRole": "Validated locally as the maximum paid subscription duration in months when updating eligibility." + }, + { + "toolField": "wait_between_offers_months", + "sourceKind": "requestBody", + "operationId": "retentionOffers_updateInstance", + "jsonPointer": "/data/attributes/customerEligibilityWaitBetweenOffersInMonths" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionOffers_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] }, - "note":"Creates one explicit Apple 4.4.1 subscription group metadata version. An ambiguous POST or response decode returns write_outcome=not_confirmed, retrySafe=false, the group ID, and list/get recovery guidance instead of encouraging a duplicate create." + "note": "Updates mutable retention offer attributes and rejects no-op updates before network I/O." }, { - "tool":"subscriptions_get_group_version","kind":"direct","status":"partial","effect":"read","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionGroupVersions_getInstance","method":"get","path":"/v1/subscriptionGroupVersions/{id}","role":"primary","condition":null,"optionalParameterClassifications":[ - {"location":"query","appleName":"include","disposition":"intentionallyOmitted","reason":"The stable projection does not expose arbitrary relationship expansion.","reviewAtSpec":"4.5.1"}, - {"location":"query","appleName":"limit[localizations]","disposition":"intentionallyOmitted","reason":"Localizations are paged through subscriptions_list_group_version_localizations.","reviewAtSpec":"4.5.1"} - ]}], - "fields":[{"toolField":"version_id","sourceKind":"parameter","operationId":"subscriptionGroupVersions_getInstance","location":"path","appleName":"id"}], - "response":{ - "mode":"projection", - "sources":[{"operationId":"subscriptionGroupVersions_getInstance","statusCode":"200","mediaType":"application/json"}], - "fields":[ - {"outputField":"success","localRole":"Set true after the group version identity and self link pass validation."}, - {"outputField":"version","operationId":"subscriptionGroupVersions_getInstance","jsonPointer":"/data","localRole":"Project stable group-version fields and bounded localization-page metadata when Apple supplies it."}, - {"outputField":"version.localizations_page.ids","operationId":"subscriptionGroupVersions_getInstance","jsonPointer":"/data/relationships/localizations/data/*/id","localRole":"Emit null when Apple omits relationship.data; preserve an explicit empty data array as []."}, - {"outputField":"version.localizations_page.count","localRole":"Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page."}, - {"outputField":"version.localizations_page.total","operationId":"subscriptionGroupVersions_getInstance","jsonPointer":"/data/relationships/localizations/meta/paging/total"}, - {"outputField":"version.localizations_page.limit","operationId":"subscriptionGroupVersions_getInstance","jsonPointer":"/data/relationships/localizations/meta/paging/limit"}, - {"outputField":"version.localizations_page.next_cursor","operationId":"subscriptionGroupVersions_getInstance","jsonPointer":"/data/relationships/localizations/meta/paging/nextCursor"}, - {"outputField":"version.localizations_page.truncated","localRole":"Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds the embedded localization ID count."}, - {"outputField":"version.localizations_page.completeness_known","localRole":"Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor."} - ] + "tool": "subscriptions_delete_retention_offer", + "kind": "direct", + "status": "partial", + "effect": "destructive", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionOffers_deleteInstance", + "method": "delete", + "path": "/v1/retentionOffers/{id}", + "role": "primary", + "condition": null + } + ], + "fields": [ + { + "toolField": "offer_id", + "sourceKind": "parameter", + "operationId": "retentionOffers_deleteInstance", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionOffers_deleteInstance", + "statusCode": "204" + } + ], + "fields": [] }, - "note":"Returns the stable projection for one discrete subscription group version." + "note": "Deletes a retention offer by ID." }, { - "tool":"subscriptions_list_group_versions","kind":"direct","status":"partial","effect":"read","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionGroups_versions_getToManyRelated","method":"get","path":"/v1/subscriptionGroups/{id}/versions","role":"primary","condition":null,"optionalParameterClassifications":[ - {"location":"query","appleName":"include","disposition":"intentionallyOmitted","reason":"The stable paginated projection does not expose arbitrary relationship expansion.","reviewAtSpec":"4.5.1"}, - {"location":"query","appleName":"limit[localizations]","disposition":"intentionallyOmitted","reason":"Localizations have their own bounded continuation tool.","reviewAtSpec":"4.5.1"} - ]}], - "fields":[ - {"toolField":"group_id","sourceKind":"parameter","operationId":"subscriptionGroups_versions_getToManyRelated","location":"path","appleName":"id"}, - {"toolField":"filter_state","sourceKind":"parameter","operationId":"subscriptionGroups_versions_getToManyRelated","location":"query","appleName":"filter[state]"}, - {"toolField":"limit","sourceKind":"parameter","operationId":"subscriptionGroups_versions_getToManyRelated","location":"query","appleName":"limit"}, - {"toolField":"next_url","sourceKind":"local","localRole":"Continue only an Apple URL whose origin, path, fixed filter, limit, unique non-empty cursor, and parameter set match the original request."} - ], - "response":{ - "mode":"projection", - "sources":[{"operationId":"subscriptionGroups_versions_getToManyRelated","statusCode":"200","mediaType":"application/json"}], - "fields":[ - {"outputField":"success","localRole":"Set true after the page passes parent identity, paging, and self-link validation."}, - {"outputField":"versions","operationId":"subscriptionGroups_versions_getToManyRelated","jsonPointer":"/data","localRole":"Project stable group-version fields and bounded localization-page metadata when Apple supplies it."}, - {"outputField":"versions.*.localizations_page.ids","operationId":"subscriptionGroups_versions_getToManyRelated","jsonPointer":"/data/*/relationships/localizations/data/*/id","localRole":"Emit null when Apple omits relationship.data; preserve an explicit empty data array as []."}, - {"outputField":"versions.*.localizations_page.count","localRole":"Emit null when Apple omits relationship.data; otherwise count the embedded localization identifiers, including zero for an explicit empty page."}, - {"outputField":"versions.*.localizations_page.total","operationId":"subscriptionGroups_versions_getToManyRelated","jsonPointer":"/data/*/relationships/localizations/meta/paging/total"}, - {"outputField":"versions.*.localizations_page.limit","operationId":"subscriptionGroups_versions_getToManyRelated","jsonPointer":"/data/*/relationships/localizations/meta/paging/limit"}, - {"outputField":"versions.*.localizations_page.next_cursor","operationId":"subscriptionGroups_versions_getToManyRelated","jsonPointer":"/data/*/relationships/localizations/meta/paging/nextCursor"}, - {"outputField":"versions.*.localizations_page.truncated","localRole":"Emit null when Apple omits relationship.data; otherwise true when Apple supplies a next cursor or the relationship total exceeds that version's embedded localization ID count."}, - {"outputField":"versions.*.localizations_page.completeness_known","localRole":"Emit false when Apple omits relationship.data; otherwise report whether Apple supplied a relationship total or next cursor."}, - {"outputField":"count","operationId":"subscriptionGroups_versions_getToManyRelated","jsonPointer":"/data","localRole":"Current validated Apple page resource count."}, - {"outputField":"total","operationId":"subscriptionGroups_versions_getToManyRelated","jsonPointer":"/meta/paging/total"}, - {"outputField":"next_url","operationId":"subscriptionGroups_versions_getToManyRelated","jsonPointer":"/links/next","localRole":"Apple continuation URL when another page exists; otherwise omitted."} - ] + "tool": "subscriptions_list_retention_offer_prices", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "retentionOffers_prices_getToManyRelated", + "method": "get", + "path": "/v1/retentionOffers/{id}/prices", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "offer_id", + "sourceKind": "parameter", + "operationId": "retentionOffers_prices_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "territory", + "sourceKind": "parameter", + "operationId": "retentionOffers_prices_getToManyRelated", + "location": "query", + "appleName": "filter[territory]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "retentionOffers_prices_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Validated Apple pagination URL override." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "retentionOffers_prices_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] }, - "note":"Lists Apple 4.4.1 subscription group versions with exact state validation and scope-locked pagination." - }, - { - "tool":"subscriptions_list_group_version_localizations","kind":"direct","status":"partial","effect":"read","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionGroupVersions_localizations_getToManyRelated","method":"get","path":"/v1/subscriptionGroupVersions/{id}/localizations","role":"primary","condition":null,"optionalParameterClassifications":[ - {"location":"query","appleName":"include","disposition":"intentionallyOmitted","reason":"The stable projection does not expose arbitrary relationship expansion.","reviewAtSpec":"4.5.1"} - ]}], - "fields":[ - {"toolField":"version_id","sourceKind":"parameter","operationId":"subscriptionGroupVersions_localizations_getToManyRelated","location":"path","appleName":"id"}, - {"toolField":"limit","sourceKind":"parameter","operationId":"subscriptionGroupVersions_localizations_getToManyRelated","location":"query","appleName":"limit"}, - {"toolField":"next_url","sourceKind":"local","localRole":"Continue only an Apple URL whose origin, path, limit, unique non-empty cursor, and parameter set match the original request."} - ], - "response":{"mode":"opaque","sources":[{"operationId":"subscriptionGroupVersions_localizations_getToManyRelated","statusCode":"200","mediaType":"application/json"}],"fields":[]}, - "note":"Lists localizations owned by one explicit subscription group version." + "note": "Lists territory prices for a retention offer." }, { - "tool":"subscriptions_create_group_version_localization","kind":"direct","status":"partial","effect":"write","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionGroupLocalizationsV2_createInstance","method":"post","path":"/v2/subscriptionGroupLocalizations","role":"primary","condition":null,"inputs":[ - {"sourceKind":"fixed","jsonPointer":"/data/type","fixedValue":"subscriptionGroupLocalizations"}, - {"sourceKind":"fixed","jsonPointer":"/data/relationships/version/data/type","fixedValue":"subscriptionGroupVersions"} - ]}], - "fields":[ - {"toolField":"version_id","sourceKind":"requestBody","operationId":"subscriptionGroupLocalizationsV2_createInstance","jsonPointer":"/data/relationships/version/data/id"}, - {"toolField":"locale","sourceKind":"requestBody","operationId":"subscriptionGroupLocalizationsV2_createInstance","jsonPointer":"/data/attributes/locale"}, - {"toolField":"name","sourceKind":"requestBody","operationId":"subscriptionGroupLocalizationsV2_createInstance","jsonPointer":"/data/attributes/name"}, - {"toolField":"custom_app_name","sourceKind":"requestBody","operationId":"subscriptionGroupLocalizationsV2_createInstance","jsonPointer":"/data/attributes/customAppName"} - ], - "response":{"mode":"opaque","sources":[{"operationId":"subscriptionGroupLocalizationsV2_createInstance","statusCode":"201","mediaType":"application/json"}],"fields":[]}, - "note":"Creates localization metadata directly under an explicit group version and preserves omitted, string, and null customAppName semantics. An ambiguous POST or response decode returns write_outcome=not_confirmed, retrySafe=false, the requested parent and metadata fingerprint, and list/get recovery guidance instead of encouraging a duplicate localization." + "tool": "subscriptions_get_retention_message_for_subscription", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptions_retentionMessage_getToOneRelated", + "method": "get", + "path": "/v1/subscriptions/{id}/retentionMessage", + "role": "primary", + "condition": null, + "optionalParameterClassifications": [ + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The public tool returns its stable base projection instead of arbitrary relationship expansion.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptions]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_message_subscriptions provides paginated access.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[versions]", + "disposition": "intentionallyOmitted", + "reason": "The corresponding embedded relationship is not caller-configurable; subscriptions_list_retention_message_versions provides paginated access.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "subscription_id", + "sourceKind": "parameter", + "operationId": "subscriptions_retentionMessage_getToOneRelated", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptions_retentionMessage_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [] + }, + "note": "Gets the retention message currently assigned to a subscription, including null data when none is assigned." }, { - "tool":"subscriptions_get_group_version_localization","kind":"direct","status":"partial","effect":"read","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionGroupLocalizationsV2_getInstance","method":"get","path":"/v2/subscriptionGroupLocalizations/{id}","role":"primary","condition":null,"optionalParameterClassifications":[ - {"location":"query","appleName":"include","disposition":"intentionallyOmitted","reason":"The stable projection does not expose arbitrary relationship expansion.","reviewAtSpec":"4.5.1"} - ]}], - "fields":[{"toolField":"localization_id","sourceKind":"parameter","operationId":"subscriptionGroupLocalizationsV2_getInstance","location":"path","appleName":"id"}], - "response":{"mode":"opaque","sources":[{"operationId":"subscriptionGroupLocalizationsV2_getInstance","statusCode":"200","mediaType":"application/json"}],"fields":[]}, - "note":"Gets one v2 subscription group version localization by resource ID." + "tool": "subscriptions_set_retention_message", + "kind": "direct", + "status": "partial", + "effect": "destructive", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptions_retentionMessage_updateToOneRelationship", + "method": "patch", + "path": "/v1/subscriptions/{id}/relationships/retentionMessage", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "retentionMessages", + "localRole": "Emit when assigning a non-null retention_message_id; send explicit null data when clearing." + } + ] + } + ], + "fields": [ + { + "toolField": "subscription_id", + "sourceKind": "parameter", + "operationId": "subscriptions_retentionMessage_updateToOneRelationship", + "location": "path", + "appleName": "id" + }, + { + "toolField": "retention_message_id", + "sourceKind": "requestBody", + "operationId": "subscriptions_retentionMessage_updateToOneRelationship", + "jsonPointer": "/data/id" + }, + { + "toolField": "clear", + "sourceKind": "local", + "localRole": "Explicitly clears the subscription retentionMessage relationship to null when true." + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptions_retentionMessage_updateToOneRelationship", + "statusCode": "204" + } + ], + "fields": [] + }, + "note": "Assigns or clears the retention message relationship for a subscription." }, { - "tool":"subscriptions_update_group_version_localization","kind":"direct","status":"partial","effect":"write","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionGroupLocalizationsV2_updateInstance","method":"patch","path":"/v2/subscriptionGroupLocalizations/{id}","role":"primary","condition":null,"inputs":[{"sourceKind":"fixed","jsonPointer":"/data/type","fixedValue":"subscriptionGroupLocalizations"}]}], - "fields":[ - {"toolField":"localization_id","sourceKind":"parameter","operationId":"subscriptionGroupLocalizationsV2_updateInstance","location":"path","appleName":"id"}, - {"toolField":"localization_id","sourceKind":"requestBody","operationId":"subscriptionGroupLocalizationsV2_updateInstance","jsonPointer":"/data/id"}, - {"toolField":"name","sourceKind":"requestBody","operationId":"subscriptionGroupLocalizationsV2_updateInstance","jsonPointer":"/data/attributes/name"}, - {"toolField":"custom_app_name","sourceKind":"requestBody","operationId":"subscriptionGroupLocalizationsV2_updateInstance","jsonPointer":"/data/attributes/customAppName"} - ], - "response":{"mode":"opaque","sources":[{"operationId":"subscriptionGroupLocalizationsV2_updateInstance","statusCode":"200","mediaType":"application/json"}],"fields":[]}, - "note":"Updates at least one v2 group localization attribute and preserves string versus explicit null." + "tool": "subscriptions_add_retention_message_offers", + "kind": "direct", + "status": "partial", + "effect": "destructive", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptions_retentionMessageOffers_createToManyRelationship", + "method": "post", + "path": "/v1/subscriptions/{id}/relationships/retentionMessageOffers", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "retentionOffers" + } + ] + } + ], + "fields": [ + { + "toolField": "subscription_id", + "sourceKind": "parameter", + "operationId": "subscriptions_retentionMessageOffers_createToManyRelationship", + "location": "path", + "appleName": "id" + }, + { + "toolField": "offer_ids", + "sourceKind": "requestBody", + "operationId": "subscriptions_retentionMessageOffers_createToManyRelationship", + "jsonPointer": "/data/*/id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptions_retentionMessageOffers_createToManyRelationship", + "statusCode": "204" + } + ], + "fields": [] + }, + "note": "Adds retention offer linkages to a subscription retention message." }, { - "tool":"subscriptions_delete_group_version_localization","kind":"direct","status":"partial","effect":"destructive","implementationState":"asBuilt", - "operations":[{"operationId":"subscriptionGroupLocalizationsV2_deleteInstance","method":"delete","path":"/v2/subscriptionGroupLocalizations/{id}","role":"primary","condition":null}], - "fields":[ - {"toolField":"localization_id","sourceKind":"parameter","operationId":"subscriptionGroupLocalizationsV2_deleteInstance","location":"path","appleName":"id"}, - {"toolField":"confirm_localization_id","sourceKind":"local","localRole":"Require an exact canonical match with localization_id before any Apple request is sent."} - ], - "response":{"mode":"local","sources":[{"operationId":"subscriptionGroupLocalizationsV2_deleteInstance","statusCode":"204"}],"fields":[ - {"outputField":"success","localRole":"Set true after Apple confirms deletion with 204."}, - {"outputField":"localization_id","localRole":"Echo the exact deleted localization ID."}, - {"outputField":"deleted","localRole":"Set true after confirmed deletion."}, - {"outputField":"deletionState","localRole":"Set to confirmed after Apple's 204 response."}, - {"outputField":"outcomeUnknown","localRole":"Set false for a confirmed deletion."}, - {"outputField":"retrySafe","localRole":"Set false because the destructive operation is already confirmed."} - ]}, - "note":"Deletes one v2 group localization resource by its exact ID." + "tool": "subscriptions_remove_retention_message_offers", + "kind": "direct", + "status": "partial", + "effect": "destructive", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "subscriptions_retentionMessageOffers_deleteToManyRelationship", + "method": "delete", + "path": "/v1/subscriptions/{id}/relationships/retentionMessageOffers", + "role": "primary", + "condition": null, + "inputs": [ + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "retentionOffers" + } + ] + } + ], + "fields": [ + { + "toolField": "subscription_id", + "sourceKind": "parameter", + "operationId": "subscriptions_retentionMessageOffers_deleteToManyRelationship", + "location": "path", + "appleName": "id" + }, + { + "toolField": "offer_ids", + "sourceKind": "requestBody", + "operationId": "subscriptions_retentionMessageOffers_deleteToManyRelationship", + "jsonPointer": "/data/*/id" + } + ], + "response": { + "mode": "opaque", + "sources": [ + { + "operationId": "subscriptions_retentionMessageOffers_deleteToManyRelationship", + "statusCode": "204" + } + ], + "fields": [] + }, + "note": "Removes retention offer linkages from a subscription retention message." } ], "implementationAliases": [] diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/users.json b/Sources/asc-mcp/Resources/OperationManifest/tools/users.json index 395ec7b..7db442d 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/users.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/users.json @@ -14,21 +14,43 @@ "path": "/v1/users/{id}/relationships/visibleApps", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/*/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "apps" + } ] } ], "fields": [ - { "toolField": "user_id", "sourceKind": "parameter", "operationId": "users_visibleApps_createToManyRelationship", "location": "path", "appleName": "id" }, - { "toolField": "app_ids", "sourceKind": "requestBody", "operationId": "users_visibleApps_createToManyRelationship", "jsonPointer": "/data/*/id", "localRole": "each non-empty unique string ID is encoded as an apps resource linkage; invalid arrays are rejected before the request" } + { + "toolField": "user_id", + "sourceKind": "parameter", + "operationId": "users_visibleApps_createToManyRelationship", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_ids", + "sourceKind": "requestBody", + "operationId": "users_visibleApps_createToManyRelationship", + "jsonPointer": "/data/*/id", + "localRole": "each non-empty unique string ID is encoded as an apps resource linkage; invalid arrays are rejected before the request" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "users_visibleApps_createToManyRelationship", "statusCode": "204" } + { + "operationId": "users_visibleApps_createToManyRelationship", + "statusCode": "204" + } ], "fields": [ - { "outputField": "message", "localRole": "confirmation synthesized after Apple's content-free 204 response" } + { + "outputField": "message", + "localRole": "confirmation synthesized after Apple's content-free 204 response" + } ] }, "note": "Exact Apple relationship-add operation. The handler strictly validates app_ids before the request and returns a local count-based confirmation after Apple's content-free 204 response." @@ -40,18 +62,35 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "userInvitations_deleteInstance", "method": "delete", "path": "/v1/userInvitations/{id}", "role": "primary" } + { + "operationId": "userInvitations_deleteInstance", + "method": "delete", + "path": "/v1/userInvitations/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "invitation_id", "sourceKind": "parameter", "operationId": "userInvitations_deleteInstance", "location": "path", "appleName": "id" } + { + "toolField": "invitation_id", + "sourceKind": "parameter", + "operationId": "userInvitations_deleteInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "userInvitations_deleteInstance", "statusCode": "204" } + { + "operationId": "userInvitations_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "message", "localRole": "confirmation synthesized after Apple's content-free 204 response" } + { + "outputField": "message", + "localRole": "confirmation synthesized after Apple's content-free 204 response" + } ] }, "note": "Apple returns 204 with no response document; the MCP result is a local cancellation confirmation." @@ -63,22 +102,61 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "users_getInstance", "method": "get", "path": "/v1/users/{id}", "role": "primary" } + { + "operationId": "users_getInstance", + "method": "get", + "path": "/v1/users/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "user_id", "sourceKind": "parameter", "operationId": "users_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "users_getInstance", "location": "query", "appleName": "include" }, - { "toolField": "limit_visible_apps", "sourceKind": "parameter", "operationId": "users_getInstance", "location": "query", "appleName": "limit[visibleApps]" } + { + "toolField": "user_id", + "sourceKind": "parameter", + "operationId": "users_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "users_getInstance", + "location": "query", + "appleName": "include" + }, + { + "toolField": "limit_visible_apps", + "sourceKind": "parameter", + "operationId": "users_getInstance", + "location": "query", + "appleName": "limit[visibleApps]" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "users_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "users_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "user", "operationId": "users_getInstance", "jsonPointer": "/data" }, - { "outputField": "user.visibleAppIds", "operationId": "users_getInstance", "jsonPointer": "/data/relationships/visibleApps/data/*/id" }, - { "outputField": "included", "operationId": "users_getInstance", "jsonPointer": "/included" } + { + "outputField": "user", + "operationId": "users_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "user.visibleAppIds", + "operationId": "users_getInstance", + "jsonPointer": "/data/relationships/visibleApps/data/*/id" + }, + { + "outputField": "included", + "operationId": "users_getInstance", + "jsonPointer": "/included" + } ] }, "note": "Supports Apple's visibleApps include and nested include limit, preserves top-level included app resources, and projects visible-app relationship IDs. Sparse fieldsets are intentionally handled by the manifest-wide fields policy." @@ -96,31 +174,102 @@ "path": "/v1/userInvitations", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "userInvitations" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/visibleApps/data/*/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "userInvitations" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/visibleApps/data/*/type", + "fixedValue": "apps" + } ] } ], "fields": [ - { "toolField": "email", "sourceKind": "requestBody", "operationId": "userInvitations_createInstance", "jsonPointer": "/data/attributes/email", "localRole": "validated as an email address before the request" }, - { "toolField": "first_name", "sourceKind": "requestBody", "operationId": "userInvitations_createInstance", "jsonPointer": "/data/attributes/firstName" }, - { "toolField": "last_name", "sourceKind": "requestBody", "operationId": "userInvitations_createInstance", "jsonPointer": "/data/attributes/lastName" }, - { "toolField": "roles", "sourceKind": "requestBody", "operationId": "userInvitations_createInstance", "jsonPointer": "/data/attributes/roles", "localRole": "validated as a non-empty unique array against Apple 4.4.1 UserRole values" }, - { "toolField": "all_apps_visible", "sourceKind": "requestBody", "operationId": "userInvitations_createInstance", "jsonPointer": "/data/attributes/allAppsVisible", "localRole": "preserves omission, explicit null, and Boolean values" }, - { "toolField": "provisioning_allowed", "sourceKind": "requestBody", "operationId": "userInvitations_createInstance", "jsonPointer": "/data/attributes/provisioningAllowed", "localRole": "preserves omission, explicit null, and Boolean values" }, - { "toolField": "visible_app_ids", "sourceKind": "requestBody", "operationId": "userInvitations_createInstance", "jsonPointer": "/data/relationships/visibleApps/data/*/id", "localRole": "explicit arrays are validated for non-empty unique string IDs and preserved, including an explicit empty relationship" } + { + "toolField": "email", + "sourceKind": "requestBody", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/data/attributes/email", + "localRole": "validated as an email address before the request" + }, + { + "toolField": "first_name", + "sourceKind": "requestBody", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/data/attributes/firstName" + }, + { + "toolField": "last_name", + "sourceKind": "requestBody", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/data/attributes/lastName" + }, + { + "toolField": "roles", + "sourceKind": "requestBody", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/data/attributes/roles", + "localRole": "validated as a non-empty unique array against Apple 4.4.1 UserRole values" + }, + { + "toolField": "all_apps_visible", + "sourceKind": "requestBody", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/data/attributes/allAppsVisible", + "localRole": "preserves omission, explicit null, and Boolean values" + }, + { + "toolField": "provisioning_allowed", + "sourceKind": "requestBody", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/data/attributes/provisioningAllowed", + "localRole": "preserves omission, explicit null, and Boolean values" + }, + { + "toolField": "visible_app_ids", + "sourceKind": "requestBody", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/data/relationships/visibleApps/data/*/id", + "localRole": "explicit arrays are validated for non-empty unique string IDs and preserved, including an explicit empty relationship" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "userInvitations_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "userInvitations_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "invitation", "operationId": "userInvitations_createInstance", "jsonPointer": "/data" }, - { "outputField": "invitation.provisioningAllowed", "operationId": "userInvitations_createInstance", "jsonPointer": "/data/attributes/provisioningAllowed" }, - { "outputField": "invitation.visibleAppIds", "operationId": "userInvitations_createInstance", "jsonPointer": "/data/relationships/visibleApps/data/*/id" }, - { "outputField": "included", "operationId": "userInvitations_createInstance", "jsonPointer": "/included" }, - { "outputField": "warnings", "localRole": "present when deprecated ACCESS_TO_REPORTS is submitted" } + { + "outputField": "invitation", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/data" + }, + { + "outputField": "invitation.provisioningAllowed", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/data/attributes/provisioningAllowed" + }, + { + "outputField": "invitation.visibleAppIds", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/data/relationships/visibleApps/data/*/id" + }, + { + "outputField": "included", + "operationId": "userInvitations_createInstance", + "jsonPointer": "/included" + }, + { + "outputField": "warnings", + "localRole": "present when deprecated ACCESS_TO_REPORTS is submitted" + } ] }, "note": "Covers every Apple 4.4.1 invitation-create attribute and optional visibleApps relationship. Roles and app IDs are strictly validated before the request; account-specific consistency between allAppsVisible and visibleApps remains Apple validation." @@ -132,29 +281,104 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "users_getCollection", "method": "get", "path": "/v1/users", "role": "primary" } + { + "operationId": "users_getCollection", + "method": "get", + "path": "/v1/users", + "role": "primary" + } ], "fields": [ - { "toolField": "limit", "sourceKind": "parameter", "operationId": "users_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "filter_username", "sourceKind": "parameter", "operationId": "users_getCollection", "location": "query", "appleName": "filter[username]" }, - { "toolField": "filter_roles", "sourceKind": "parameter", "operationId": "users_getCollection", "location": "query", "appleName": "filter[roles]" }, - { "toolField": "filter_visible_apps", "sourceKind": "parameter", "operationId": "users_getCollection", "location": "query", "appleName": "filter[visibleApps]" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "users_getCollection", "location": "query", "appleName": "sort" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "users_getCollection", "location": "query", "appleName": "include" }, - { "toolField": "limit_visible_apps", "sourceKind": "parameter", "operationId": "users_getCollection", "location": "query", "appleName": "limit[visibleApps]" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "users_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "filter_username", + "sourceKind": "parameter", + "operationId": "users_getCollection", + "location": "query", + "appleName": "filter[username]" + }, + { + "toolField": "filter_roles", + "sourceKind": "parameter", + "operationId": "users_getCollection", + "location": "query", + "appleName": "filter[roles]" + }, + { + "toolField": "filter_visible_apps", + "sourceKind": "parameter", + "operationId": "users_getCollection", + "location": "query", + "appleName": "filter[visibleApps]" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "users_getCollection", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "users_getCollection", + "location": "query", + "appleName": "include" + }, + { + "toolField": "limit_visible_apps", + "sourceKind": "parameter", + "operationId": "users_getCollection", + "location": "query", + "appleName": "limit[visibleApps]" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "users_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "users_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "users", "operationId": "users_getCollection", "jsonPointer": "/data" }, - { "outputField": "users.visibleAppIds", "operationId": "users_getCollection", "jsonPointer": "/data/*/relationships/visibleApps/data/*/id" }, - { "outputField": "included", "operationId": "users_getCollection", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "users_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "users_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "users", + "operationId": "users_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "users.visibleAppIds", + "operationId": "users_getCollection", + "jsonPointer": "/data/*/relationships/visibleApps/data/*/id" + }, + { + "outputField": "included", + "operationId": "users_getCollection", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "users_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "users_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Supports every non-fieldset Apple 4.4.1 collection control, preserves included visible apps, and returns visible-app relationship IDs. Continuation URLs must retain caller-supplied filters, sort, include, and nested limit invariants." @@ -166,30 +390,109 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "userInvitations_getCollection", "method": "get", "path": "/v1/userInvitations", "role": "primary" } + { + "operationId": "userInvitations_getCollection", + "method": "get", + "path": "/v1/userInvitations", + "role": "primary" + } ], "fields": [ - { "toolField": "limit", "sourceKind": "parameter", "operationId": "userInvitations_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "filter_email", "sourceKind": "parameter", "operationId": "userInvitations_getCollection", "location": "query", "appleName": "filter[email]" }, - { "toolField": "filter_roles", "sourceKind": "parameter", "operationId": "userInvitations_getCollection", "location": "query", "appleName": "filter[roles]" }, - { "toolField": "filter_visible_apps", "sourceKind": "parameter", "operationId": "userInvitations_getCollection", "location": "query", "appleName": "filter[visibleApps]" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "userInvitations_getCollection", "location": "query", "appleName": "sort" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "userInvitations_getCollection", "location": "query", "appleName": "include" }, - { "toolField": "limit_visible_apps", "sourceKind": "parameter", "operationId": "userInvitations_getCollection", "location": "query", "appleName": "limit[visibleApps]" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "userInvitations_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "filter_email", + "sourceKind": "parameter", + "operationId": "userInvitations_getCollection", + "location": "query", + "appleName": "filter[email]" + }, + { + "toolField": "filter_roles", + "sourceKind": "parameter", + "operationId": "userInvitations_getCollection", + "location": "query", + "appleName": "filter[roles]" + }, + { + "toolField": "filter_visible_apps", + "sourceKind": "parameter", + "operationId": "userInvitations_getCollection", + "location": "query", + "appleName": "filter[visibleApps]" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "userInvitations_getCollection", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "userInvitations_getCollection", + "location": "query", + "appleName": "include" + }, + { + "toolField": "limit_visible_apps", + "sourceKind": "parameter", + "operationId": "userInvitations_getCollection", + "location": "query", + "appleName": "limit[visibleApps]" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "userInvitations_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "userInvitations_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "invitations", "operationId": "userInvitations_getCollection", "jsonPointer": "/data" }, - { "outputField": "invitations.provisioningAllowed", "operationId": "userInvitations_getCollection", "jsonPointer": "/data/*/attributes/provisioningAllowed" }, - { "outputField": "invitations.visibleAppIds", "operationId": "userInvitations_getCollection", "jsonPointer": "/data/*/relationships/visibleApps/data/*/id" }, - { "outputField": "included", "operationId": "userInvitations_getCollection", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "userInvitations_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "userInvitations_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "invitations", + "operationId": "userInvitations_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "invitations.provisioningAllowed", + "operationId": "userInvitations_getCollection", + "jsonPointer": "/data/*/attributes/provisioningAllowed" + }, + { + "outputField": "invitations.visibleAppIds", + "operationId": "userInvitations_getCollection", + "jsonPointer": "/data/*/relationships/visibleApps/data/*/id" + }, + { + "outputField": "included", + "operationId": "userInvitations_getCollection", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "userInvitations_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "userInvitations_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Supports every non-fieldset Apple 4.4.1 invitation collection control, preserves included visible apps, and returns current provisioning and relationship data. Continuation URLs retain caller-supplied query invariants." @@ -201,22 +504,59 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "users_visibleApps_getToManyRelated", "method": "get", "path": "/v1/users/{id}/visibleApps", "role": "primary" } + { + "operationId": "users_visibleApps_getToManyRelated", + "method": "get", + "path": "/v1/users/{id}/visibleApps", + "role": "primary" + } ], "fields": [ - { "toolField": "user_id", "sourceKind": "parameter", "operationId": "users_visibleApps_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "users_visibleApps_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "user_id", + "sourceKind": "parameter", + "operationId": "users_visibleApps_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "users_visibleApps_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "users_visibleApps_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "users_visibleApps_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "apps", "operationId": "users_visibleApps_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "users_visibleApps_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "users_visibleApps_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "apps", + "operationId": "users_visibleApps_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "users_visibleApps_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "users_visibleApps_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Covers every non-fieldset Apple 4.4.1 input for the related visible-app collection. The formatter intentionally returns a stable selected app projection." @@ -228,18 +568,35 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "users_deleteInstance", "method": "delete", "path": "/v1/users/{id}", "role": "primary" } + { + "operationId": "users_deleteInstance", + "method": "delete", + "path": "/v1/users/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "user_id", "sourceKind": "parameter", "operationId": "users_deleteInstance", "location": "path", "appleName": "id" } + { + "toolField": "user_id", + "sourceKind": "parameter", + "operationId": "users_deleteInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "users_deleteInstance", "statusCode": "204" } + { + "operationId": "users_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "message", "localRole": "confirmation synthesized after Apple's content-free 204 response" } + { + "outputField": "message", + "localRole": "confirmation synthesized after Apple's content-free 204 response" + } ] }, "note": "Apple returns 204 with no response document; the MCP result is a local removal confirmation." @@ -257,21 +614,43 @@ "path": "/v1/users/{id}/relationships/visibleApps", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/*/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/*/type", + "fixedValue": "apps" + } ] } ], "fields": [ - { "toolField": "user_id", "sourceKind": "parameter", "operationId": "users_visibleApps_deleteToManyRelationship", "location": "path", "appleName": "id" }, - { "toolField": "app_ids", "sourceKind": "requestBody", "operationId": "users_visibleApps_deleteToManyRelationship", "jsonPointer": "/data/*/id", "localRole": "each non-empty unique string ID is encoded as an apps resource linkage; invalid arrays are rejected before the request" } + { + "toolField": "user_id", + "sourceKind": "parameter", + "operationId": "users_visibleApps_deleteToManyRelationship", + "location": "path", + "appleName": "id" + }, + { + "toolField": "app_ids", + "sourceKind": "requestBody", + "operationId": "users_visibleApps_deleteToManyRelationship", + "jsonPointer": "/data/*/id", + "localRole": "each non-empty unique string ID is encoded as an apps resource linkage; invalid arrays are rejected before the request" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "users_visibleApps_deleteToManyRelationship", "statusCode": "204" } + { + "operationId": "users_visibleApps_deleteToManyRelationship", + "statusCode": "204" + } ], "fields": [ - { "outputField": "message", "localRole": "confirmation synthesized after Apple's content-free 204 response" } + { + "outputField": "message", + "localRole": "confirmation synthesized after Apple's content-free 204 response" + } ] }, "note": "Exact Apple relationship-delete operation. The handler strictly validates app_ids before the request and returns a local count-based confirmation after Apple's content-free 204 response." @@ -289,29 +668,91 @@ "path": "/v1/users/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "users" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/visibleApps/data/*/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "users" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/visibleApps/data/*/type", + "fixedValue": "apps" + } ] } ], "fields": [ - { "toolField": "user_id", "sourceKind": "parameter", "operationId": "users_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "user_id", "sourceKind": "requestBody", "operationId": "users_updateInstance", "jsonPointer": "/data/id" }, - { "toolField": "roles", "sourceKind": "requestBody", "operationId": "users_updateInstance", "jsonPointer": "/data/attributes/roles", "localRole": "preserves explicit null or validates a non-empty array against Apple 4.4.1 UserRole values; ACCESS_TO_REPORTS remains accepted with a deprecation warning" }, - { "toolField": "all_apps_visible", "sourceKind": "requestBody", "operationId": "users_updateInstance", "jsonPointer": "/data/attributes/allAppsVisible", "localRole": "preserves omission, explicit null, and Boolean values" }, - { "toolField": "provisioning_allowed", "sourceKind": "requestBody", "operationId": "users_updateInstance", "jsonPointer": "/data/attributes/provisioningAllowed", "localRole": "preserves omission, explicit null, and Boolean values" }, - { "toolField": "visible_app_ids", "sourceKind": "requestBody", "operationId": "users_updateInstance", "jsonPointer": "/data/relationships/visibleApps/data/*/id", "localRole": "each non-empty unique ID is encoded as an apps resource linkage; an empty array clears the relationship" } + { + "toolField": "user_id", + "sourceKind": "parameter", + "operationId": "users_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "user_id", + "sourceKind": "requestBody", + "operationId": "users_updateInstance", + "jsonPointer": "/data/id" + }, + { + "toolField": "roles", + "sourceKind": "requestBody", + "operationId": "users_updateInstance", + "jsonPointer": "/data/attributes/roles", + "localRole": "preserves explicit null or validates a non-empty array against Apple 4.4.1 UserRole values; ACCESS_TO_REPORTS remains accepted with a deprecation warning" + }, + { + "toolField": "all_apps_visible", + "sourceKind": "requestBody", + "operationId": "users_updateInstance", + "jsonPointer": "/data/attributes/allAppsVisible", + "localRole": "preserves omission, explicit null, and Boolean values" + }, + { + "toolField": "provisioning_allowed", + "sourceKind": "requestBody", + "operationId": "users_updateInstance", + "jsonPointer": "/data/attributes/provisioningAllowed", + "localRole": "preserves omission, explicit null, and Boolean values" + }, + { + "toolField": "visible_app_ids", + "sourceKind": "requestBody", + "operationId": "users_updateInstance", + "jsonPointer": "/data/relationships/visibleApps/data/*/id", + "localRole": "each non-empty unique ID is encoded as an apps resource linkage; an empty array clears the relationship" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "users_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "users_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "user", "operationId": "users_updateInstance", "jsonPointer": "/data" }, - { "outputField": "user.visibleAppIds", "operationId": "users_updateInstance", "jsonPointer": "/data/relationships/visibleApps/data/*/id" }, - { "outputField": "included", "operationId": "users_updateInstance", "jsonPointer": "/included" }, - { "outputField": "warnings", "localRole": "present when deprecated ACCESS_TO_REPORTS is submitted" } + { + "outputField": "user", + "operationId": "users_updateInstance", + "jsonPointer": "/data" + }, + { + "outputField": "user.visibleAppIds", + "operationId": "users_updateInstance", + "jsonPointer": "/data/relationships/visibleApps/data/*/id" + }, + { + "outputField": "included", + "operationId": "users_updateInstance", + "jsonPointer": "/included" + }, + { + "outputField": "warnings", + "localRole": "present when deprecated ACCESS_TO_REPORTS is submitted" + } ] }, "note": "Covers every writable field in Apple 4.4.1 UserUpdateRequest. At least one update field is required locally. TECHNICAL and unknown roles are rejected before the request; ACCESS_TO_REPORTS remains accepted for compatibility because it is still in Apple's enum, with an explicit deprecation warning from current Apple documentation. No local mutual exclusion is imposed between allAppsVisible and visibleApps because Apple 4.4.1 declares both optional without a cross-field constraint; Apple remains responsible for account-specific validation. Relationship IDs and any included resources are preserved in the structured response." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/versions.json b/Sources/asc-mcp/Resources/OperationManifest/tools/versions.json index 07f0a97..cce883a 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/versions.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/versions.json @@ -40,7 +40,10 @@ "response": { "mode": "local", "sources": [ - { "operationId": "appStoreVersions_build_updateToOneRelationship", "statusCode": "204" } + { + "operationId": "appStoreVersions_build_updateToOneRelationship", + "statusCode": "204" + } ], "fields": [] }, @@ -59,8 +62,20 @@ "path": "/v1/reviewSubmissions/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/attributes/platform", "disposition": "intentionallyOmitted", "reason": "Cancellation targets an existing submission and does not change its platform.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/attributes/submitted", "disposition": "intentionallyOmitted", "reason": "Cancellation fixes canceled=true and never combines cancellation with the distinct submit transition.", "reviewAtSpec": "4.5.1" } + { + "location": "body", + "appleName": "/data/attributes/platform", + "disposition": "intentionallyOmitted", + "reason": "Cancellation targets an existing submission and does not change its platform.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/submitted", + "disposition": "intentionallyOmitted", + "reason": "Cancellation fixes canceled=true and never combines cancellation with the distinct submit transition.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -119,8 +134,20 @@ "path": "/v1/appStoreVersions", "role": "primary", "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/relationships/appStoreVersionLocalizations", "disposition": "intentionallyOmitted", "reason": "Version creation and localization creation are separate MCP operations with independent validation and recovery.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/build", "disposition": "intentionallyOmitted", "reason": "Build attachment is intentionally handled by app_versions_attach_build after version creation.", "reviewAtSpec": "4.5.1" } + { + "location": "body", + "appleName": "/data/relationships/appStoreVersionLocalizations", + "disposition": "intentionallyOmitted", + "reason": "Version creation and localization creation are separate MCP operations with independent validation and recovery.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/build", + "disposition": "intentionallyOmitted", + "reason": "Build attachment is intentionally handled by app_versions_attach_build after version creation.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -287,13 +314,28 @@ "response": { "mode": "local", "sources": [ - { "operationId": "appStoreVersions_deleteInstance", "statusCode": "204" } + { + "operationId": "appStoreVersions_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "deletionState", "localRole": "Confirmed on 204; committed_unverified for an unexpected successful status; commit_unknown for network, 408, or 5xx outcomes; rejected for definite non-success responses." }, - { "outputField": "outcomeUnknown", "localRole": "True only when Apple may have committed DELETE despite an ambiguous transport or server outcome." }, - { "outputField": "retrySafe", "localRole": "False for confirmed, committed-unverified, or commit-unknown outcomes; true only for a definite rejection." }, - { "outputField": "inspection", "localRole": "Exact app_versions_get guidance included when DELETE completion is unknown or unverified." } + { + "outputField": "deletionState", + "localRole": "Confirmed on 204; committed_unverified for an unexpected successful status; commit_unknown for network, 408, or 5xx outcomes; rejected for definite non-success responses." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True only when Apple may have committed DELETE despite an ambiguous transport or server outcome." + }, + { + "outputField": "retrySafe", + "localRole": "False for confirmed, committed-unverified, or commit-unknown outcomes; true only for a definite rejection." + }, + { + "outputField": "inspection", + "localRole": "Exact app_versions_get guidance included when DELETE completion is unknown or unverified." + } ] }, "note": "Apple documents 204 with no response document. The handler requires exact version-ID confirmation and never repeats DELETE after an ambiguous outcome; explicit 401 and 429 rejections may be retried safely. Network, 408, and 5xx outcomes are commit_unknown, while an unexpected successful status is committed_unverified; both require exact-version inspection with retrySafe=false." @@ -329,13 +371,28 @@ "response": { "mode": "local", "sources": [ - { "operationId": "appStoreVersionPhasedReleases_deleteInstance", "statusCode": "204" } + { + "operationId": "appStoreVersionPhasedReleases_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "deletionState", "localRole": "Confirmed on 204; committed_unverified for an unexpected successful status; commit_unknown for network, 408, or 5xx outcomes; rejected for definite non-success responses." }, - { "outputField": "outcomeUnknown", "localRole": "True only when Apple may have committed DELETE despite an ambiguous transport or server outcome." }, - { "outputField": "retrySafe", "localRole": "False for confirmed, committed-unverified, or commit-unknown outcomes; true only for a definite rejection." }, - { "outputField": "inspection", "localRole": "Owning-version relationship or App Store Connect UI guidance included when DELETE completion is unknown or unverified because Apple has no direct GET by phased-release ID." } + { + "outputField": "deletionState", + "localRole": "Confirmed on 204; committed_unverified for an unexpected successful status; commit_unknown for network, 408, or 5xx outcomes; rejected for definite non-success responses." + }, + { + "outputField": "outcomeUnknown", + "localRole": "True only when Apple may have committed DELETE despite an ambiguous transport or server outcome." + }, + { + "outputField": "retrySafe", + "localRole": "False for confirmed, committed-unverified, or commit-unknown outcomes; true only for a definite rejection." + }, + { + "outputField": "inspection", + "localRole": "Owning-version relationship or App Store Connect UI guidance included when DELETE completion is unknown or unverified because Apple has no direct GET by phased-release ID." + } ] }, "note": "Apple permits deletion only for an eligible planned rollout that has not started and documents 204 without a response document. The handler requires exact-ID confirmation and never repeats DELETE after an ambiguous outcome; explicit 401 and 429 rejections may be retried safely. Network, 408, and 5xx outcomes are commit_unknown, while an unexpected successful status is committed_unverified; both use retrySafe=false. Apple 4.4.1 exposes no direct GET by phased-release ID, so recovery guidance uses the owning version relationship or App Store Connect UI." @@ -353,16 +410,37 @@ "path": "/v1/appStoreVersions/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Legacy experiments are not included by the fixed version detail projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "V2 experiments are not included by the fixed version detail projection.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are not included by the fixed version detail projection.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Legacy experiments are not included by the fixed version detail projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "V2 experiments are not included by the fixed version detail projection.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are not included by the fixed version detail projection.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["build", "appStoreVersionPhasedRelease"] + "fixedValue": [ + "build", + "appStoreVersionPhasedRelease" + ] } ] } @@ -422,9 +500,19 @@ } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "app_info_id", "localRole": "Echo the selected App Info ID." }, - { "outputField": "age_rating_declaration", "operationId": "appInfos_ageRatingDeclaration_getToOneRelated", "jsonPointer": "/data" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "app_info_id", + "localRole": "Echo the selected App Info ID." + }, + { + "outputField": "age_rating_declaration", + "operationId": "appInfos_ageRatingDeclaration_getToOneRelated", + "jsonPointer": "/data" + } ] }, "note": "Age rating declarations are owned by App Info, not App Store version resources. The complete questionnaire is returned for review-readiness inspection." @@ -477,16 +565,37 @@ "path": "/v1/apps/{id}/appStoreVersions", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Legacy experiments are not among the fixed included relationships for the version list.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "V2 experiments are not among the fixed included relationships for the version list.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are not among the fixed included relationships for the version list.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Legacy experiments are not among the fixed included relationships for the version list.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "V2 experiments are not among the fixed included relationships for the version list.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are not among the fixed included relationships for the version list.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["build", "appStoreVersionPhasedRelease"] + "fixedValue": [ + "build", + "appStoreVersionPhasedRelease" + ] } ] } @@ -564,14 +673,43 @@ } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "app_id", "localRole": "Echo the selected App ID." }, - { "outputField": "versions", "operationId": "apps_appStoreVersions_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "apps_appStoreVersions_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "apps_appStoreVersions_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "meta", "operationId": "apps_appStoreVersions_getToManyRelated", "jsonPointer": "/meta" }, - { "outputField": "count", "localRole": "Count the returned App Store version resources." }, - { "outputField": "total", "operationId": "apps_appStoreVersions_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "app_id", + "localRole": "Echo the selected App ID." + }, + { + "outputField": "versions", + "operationId": "apps_appStoreVersions_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "apps_appStoreVersions_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "apps_appStoreVersions_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "meta", + "operationId": "apps_appStoreVersions_getToManyRelated", + "jsonPointer": "/meta" + }, + { + "outputField": "count", + "localRole": "Count the returned App Store version resources." + }, + { + "outputField": "total", + "operationId": "apps_appStoreVersions_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "states preserves deprecated filter[appStoreState] compatibility; app_version_states exposes current filter[appVersionState]. platforms follows Apple's array contract while platform remains a deprecated scalar alias. Pagination preserves all supplied filters, page size, and fixed non-deprecated included relationships; output preserves count and Apple paging metadata." @@ -593,19 +731,26 @@ "sourceKind": "fixed", "location": "query", "appleName": "fields[territoryAgeRatings]", - "fixedValue": ["appStoreAgeRating", "territory"] + "fixedValue": [ + "appStoreAgeRating", + "territory" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "fields[territories]", - "fixedValue": ["currency"] + "fixedValue": [ + "currency" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["territory"] + "fixedValue": [ + "territory" + ] } ] } @@ -641,14 +786,43 @@ } ], "fields": [ - { "outputField": "success", "localRole": "successfulRead" }, - { "outputField": "app_info_id", "localRole": "Echo the selected App Info ID." }, - { "outputField": "territory_age_ratings", "operationId": "appInfos_territoryAgeRatings_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "included_territories", "operationId": "appInfos_territoryAgeRatings_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "appInfos_territoryAgeRatings_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "meta", "operationId": "appInfos_territoryAgeRatings_getToManyRelated", "jsonPointer": "/meta" }, - { "outputField": "count", "localRole": "Count the returned territory age rating resources." }, - { "outputField": "total", "operationId": "appInfos_territoryAgeRatings_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "success", + "localRole": "successfulRead" + }, + { + "outputField": "app_info_id", + "localRole": "Echo the selected App Info ID." + }, + { + "outputField": "territory_age_ratings", + "operationId": "appInfos_territoryAgeRatings_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "included_territories", + "operationId": "appInfos_territoryAgeRatings_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "appInfos_territoryAgeRatings_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "meta", + "operationId": "appInfos_territoryAgeRatings_getToManyRelated", + "jsonPointer": "/meta" + }, + { + "outputField": "count", + "localRole": "Count the returned territory age rating resources." + }, + { + "outputField": "total", + "operationId": "appInfos_territoryAgeRatings_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Returns Apple's calculated rating per territory with included territory currency data. Rating values remain future-compatible strings, including ZERO_ZERO introduced for Vietnam." @@ -667,17 +841,45 @@ "role": "supporting", "condition": "Always used to validate versionString and releasable state before the irreversible request.", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The irreversible-action preflight reads only fixed version attributes and does not expand relationships.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Legacy experiments are not included by the release preflight.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "V2 experiments are not included by the release preflight.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are not included by the release preflight.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The irreversible-action preflight reads only fixed version attributes and does not expand relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Legacy experiments are not included by the release preflight.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "V2 experiments are not included by the release preflight.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are not included by the release preflight.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersions]", - "fixedValue": ["platform", "versionString", "appVersionState"] + "fixedValue": [ + "platform", + "versionString", + "appVersionState" + ] } ] }, @@ -723,8 +925,16 @@ "response": { "mode": "aggregate", "sources": [ - { "operationId": "appStoreVersionReleaseRequests_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersionReleaseRequests_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] } @@ -743,20 +953,30 @@ "role": "supporting", "condition": "Determines whether to create review details or update the existing resource.", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appStoreReviewAttachments]", "disposition": "intentionallyOmitted", "reason": "Review attachments are managed by ReviewAttachmentsWorker and are not included in this existence lookup.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "limit[appStoreReviewAttachments]", + "disposition": "intentionallyOmitted", + "reason": "Review attachments are managed by ReviewAttachmentsWorker and are not included in this existence lookup.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreReviewDetails]", - "fixedValue": ["appStoreVersion"] + "fixedValue": [ + "appStoreVersion" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["appStoreVersion"] + "fixedValue": [ + "appStoreVersion" + ] } ] }, @@ -767,17 +987,43 @@ "role": "conditional", "condition": "Used only after a 404 from the related review-detail lookup to prove the parent version exists before creating a child resource.", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The parent-existence check needs only a fixed version field and does not expand relationships.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Experiments are not included by the parent-existence check.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "V2 experiments are not included by the parent-existence check.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are not included by the parent-existence check.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "The parent-existence check needs only a fixed version field and does not expand relationships.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Experiments are not included by the parent-existence check.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "V2 experiments are not included by the parent-existence check.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are not included by the parent-existence check.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersions]", - "fixedValue": ["versionString"] + "fixedValue": [ + "versionString" + ] } ] }, @@ -959,10 +1205,26 @@ "response": { "mode": "aggregate", "sources": [ - { "operationId": "appStoreReviewDetails_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "appStoreReviewDetails_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersions_appStoreReviewDetail_getToOneRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreReviewDetails_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "appStoreReviewDetails_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_appStoreReviewDetail_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -982,22 +1244,47 @@ "role": "supporting", "condition": "Always validates the version's owning app before creating a review submission.", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Legacy experiments are not included by the submission preflight.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "V2 experiments are not included by the submission preflight.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are not included by the submission preflight.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Legacy experiments are not included by the submission preflight.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "V2 experiments are not included by the submission preflight.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are not included by the submission preflight.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersions]", - "fixedValue": ["app", "platform", "versionString", "appVersionState"] + "fixedValue": [ + "app", + "platform", + "versionString", + "appVersionState" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["app"] + "fixedValue": [ + "app" + ] } ] }, @@ -1025,21 +1312,118 @@ "path": "/v1/reviewSubmissionItems", "role": "supporting", "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/relationships/appCustomProductPageVersion", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; custom product page versions require a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/appEvent", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; in-app events require a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/appStoreVersionExperiment", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; product-page experiments require a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/appStoreVersionExperimentV2", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; V2 experiments require a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/backgroundAssetVersion", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; background asset versions require a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/gameCenterAchievementVersion", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; Game Center content requires a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/gameCenterActivityVersion", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; Game Center content requires a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/gameCenterChallengeVersion", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; Game Center content requires a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/gameCenterLeaderboardSetVersion", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; Game Center content requires a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/gameCenterLeaderboardVersion", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; Game Center content requires a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/inAppPurchaseVersion", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; in-app purchase versions require a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/subscriptionGroupVersion", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; subscription group versions require a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/subscriptionVersion", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version; subscription versions require a separate review-item workflow.", "reviewAtSpec": "4.5.1" }, - {"location": "body", "appleName": "/data/relationships/appAssetLibraryImage", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version and does not add Asset Library items. Add an isolated image or video through the preview-protected assets_prepare_change/assets_apply_change or new review_submissions_add_item form; accepting an asset relationship here would bypass that preparation contract.", "reviewAtSpec": "4.5.1"}, - {"location": "body", "appleName": "/data/relationships/appAssetLibraryVideo", "disposition": "intentionallyOmitted", "reason": "This tool submits exactly one App Store version and does not add Asset Library items. Add an isolated image or video through the preview-protected assets_prepare_change/assets_apply_change or new review_submissions_add_item form; accepting an asset relationship here would bypass that preparation contract.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/relationships/appCustomProductPageVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; custom product page versions require a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/appEvent", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; in-app events require a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/appStoreVersionExperiment", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; product-page experiments require a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/appStoreVersionExperimentV2", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; V2 experiments require a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/backgroundAssetVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; background asset versions require a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterAchievementVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; Game Center content requires a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterActivityVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; Game Center content requires a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterChallengeVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; Game Center content requires a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterLeaderboardSetVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; Game Center content requires a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/gameCenterLeaderboardVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; Game Center content requires a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/inAppPurchaseVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; in-app purchase versions require a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/subscriptionGroupVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; subscription group versions require a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/subscriptionVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; subscription versions require a separate review-item workflow.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/appAssetLibraryImage", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version and does not add Asset Library items. Add an isolated image or video through the preview-protected assets_prepare_change/assets_apply_change or new review_submissions_add_item form; accepting an asset relationship here would bypass that preparation contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/appAssetLibraryVideo", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version and does not add Asset Library items. Add an isolated image or video through the preview-protected assets_prepare_change/assets_apply_change or new review_submissions_add_item form; accepting an asset relationship here would bypass that preparation contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/retentionMessageVersion", + "disposition": "intentionallyOmitted", + "reason": "This tool submits exactly one App Store version; retention message versions require a separate review-item workflow.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -1074,8 +1458,20 @@ "role": "primary", "condition": "Marks the assembled review submission as submitted.", "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/attributes/canceled", "disposition": "intentionallyOmitted", "reason": "Submission fixes submitted=true and never combines submission with the distinct cancellation transition.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/attributes/platform", "disposition": "intentionallyOmitted", "reason": "The platform is set when the review submission is created and is not changed during confirmation.", "reviewAtSpec": "4.5.1" } + { + "location": "body", + "appleName": "/data/attributes/canceled", + "disposition": "intentionallyOmitted", + "reason": "Submission fixes submitted=true and never combines submission with the distinct cancellation transition.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/platform", + "disposition": "intentionallyOmitted", + "reason": "The platform is set when the review submission is created and is not changed during confirmation.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -1141,10 +1537,26 @@ "response": { "mode": "aggregate", "sources": [ - { "operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "reviewSubmissionItems_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "reviewSubmissions_createInstance", "statusCode": "201", "mediaType": "application/json" }, - { "operationId": "reviewSubmissions_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissionItems_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissions_createInstance", + "statusCode": "201", + "mediaType": "application/json" + }, + { + "operationId": "reviewSubmissions_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1163,8 +1575,20 @@ "path": "/v1/appStoreVersions/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/relationships/appClipDefaultExperience", "disposition": "intentionallyOmitted", "reason": "App Clip default-experience relationship management is outside the version-attribute update contract.", "reviewAtSpec": "4.5.1" }, - { "location": "body", "appleName": "/data/relationships/build", "disposition": "intentionallyOmitted", "reason": "Build relationship updates are handled by app_versions_attach_build.", "reviewAtSpec": "4.5.1" } + { + "location": "body", + "appleName": "/data/relationships/appClipDefaultExperience", + "disposition": "intentionallyOmitted", + "reason": "App Clip default-experience relationship management is outside the version-attribute update contract.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/relationships/build", + "disposition": "intentionallyOmitted", + "reason": "Build relationship updates are handled by app_versions_attach_build.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -1261,22 +1685,45 @@ "role": "supporting", "condition": "Used only when app_info_id is omitted; resolves the owning app and current appVersionState from legacy version_id.", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appStoreVersionExperiments]", "disposition": "intentionallyOmitted", "reason": "Legacy experiments are not included during App Info resolution.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "V2 experiments are not included during App Info resolution.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionLocalizations]", "disposition": "intentionallyOmitted", "reason": "Localizations are not included during App Info resolution.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "limit[appStoreVersionExperiments]", + "disposition": "intentionallyOmitted", + "reason": "Legacy experiments are not included during App Info resolution.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "V2 experiments are not included during App Info resolution.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "Localizations are not included during App Info resolution.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { "sourceKind": "fixed", "location": "query", "appleName": "fields[appStoreVersions]", - "fixedValue": ["app", "appVersionState"] + "fixedValue": [ + "app", + "appVersionState" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["app"] + "fixedValue": [ + "app" + ] } ] }, @@ -1287,7 +1734,13 @@ "role": "supporting", "condition": "Used only for legacy version_id resolution; requires Apple's page links, strictly paginates the complete App Info collection, and selects exactly one AppInfo whose state equals the version state or an explicit documented state mapping.", "optionalParameterClassifications": [ - { "location": "query", "appleName": "limit[appInfoLocalizations]", "disposition": "intentionallyOmitted", "reason": "App Info localizations are not included during age-rating declaration resolution.", "reviewAtSpec": "4.5.1" } + { + "location": "query", + "appleName": "limit[appInfoLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "App Info localizations are not included during age-rating declaration resolution.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -1303,13 +1756,18 @@ "sourceKind": "fixed", "location": "query", "appleName": "fields[appInfos]", - "fixedValue": ["state", "app"] + "fixedValue": [ + "state", + "app" + ] }, { "sourceKind": "fixed", "location": "query", "appleName": "include", - "fixedValue": ["app"] + "fixedValue": [ + "app" + ] }, { "sourceKind": "fixed", @@ -1344,8 +1802,20 @@ "path": "/v1/ageRatingDeclarations/{id}", "role": "primary", "optionalParameterClassifications": [ - { "location": "body", "appleName": "/data/attributes/ageRatingOverride", "disposition": "intentionallyOmitted", "reason": "Apple 4.5.1 exposes the current ageRatingOverrideV2 field separately; the MCP age_rating_override input targets that current field.", "reviewAtSpec": "4.5.1" }, - {"location": "body", "appleName": "/data/attributes/gracRatingClassificationNumber", "disposition": "intentionallyOmitted", "reason": "The official GRAC classification number is a distinct field outside the approved Korea age-override enum scope. It is not implemented: exposing it requires documented identifier validation and authorized draft acceptance. This explicit omission remains a follow-up item; korea_age_rating_override does not set or clear it.", "reviewAtSpec": "4.5.1"} + { + "location": "body", + "appleName": "/data/attributes/ageRatingOverride", + "disposition": "intentionallyOmitted", + "reason": "Apple 4.5.1 exposes the current ageRatingOverrideV2 field separately; the MCP age_rating_override input targets that current field.", + "reviewAtSpec": "4.6" + }, + { + "location": "body", + "appleName": "/data/attributes/gracRatingClassificationNumber", + "disposition": "intentionallyOmitted", + "reason": "The official GRAC classification number is a distinct field outside the approved Korea age-override enum scope. It is not implemented: exposing it requires documented identifier validation and authorized draft acceptance. This explicit omission remains a follow-up item; korea_age_rating_override does not set or clear it.", + "reviewAtSpec": "4.6" + } ], "inputs": [ { @@ -1560,10 +2030,26 @@ "response": { "mode": "aggregate", "sources": [ - { "operationId": "ageRatingDeclarations_updateInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appInfos_ageRatingDeclaration_getToOneRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "appStoreVersions_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "apps_appInfos_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ageRatingDeclarations_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appInfos_ageRatingDeclaration_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "appStoreVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "apps_appInfos_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [] }, @@ -1612,10 +2098,10 @@ "operationId": "appStoreVersionPhasedReleases_updateInstance", "jsonPointer": "/data/attributes/phasedReleaseState" }, - { - "toolField": "confirm_phased_release_id", - "sourceKind": "local", - "localRole": "Exact phased release ID confirmation required when ACTIVE starts or resumes distribution, or COMPLETE immediately releases the version to all users." + { + "toolField": "confirm_phased_release_id", + "sourceKind": "local", + "localRole": "Exact phased release ID confirmation required when ACTIVE starts or resumes distribution, or COMPLETE immediately releases the version to all users." } ], "response": { @@ -1629,7 +2115,7 @@ ], "fields": [] }, - "note": "Runtime validation restricts updates to ACTIVE, PAUSED, or COMPLETE. ACTIVE and COMPLETE require exact phased-release-ID confirmation." + "note": "Runtime validation restricts updates to ACTIVE, PAUSED, or COMPLETE. ACTIVE and COMPLETE require exact phased-release-ID confirmation." } ], "implementationAliases": [] diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/webhooks.json b/Sources/asc-mcp/Resources/OperationManifest/tools/webhooks.json index 92c0bde..a5162ed 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/webhooks.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/webhooks.json @@ -14,26 +14,76 @@ "path": "/v1/webhooks", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "webhooks" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/app/data/type", "fixedValue": "apps" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "webhooks" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/app/data/type", + "fixedValue": "apps" + } ] } ], "fields": [ - { "toolField": "app_id", "sourceKind": "requestBody", "operationId": "webhooks_createInstance", "jsonPointer": "/data/relationships/app/data/id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "webhooks_createInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "url", "sourceKind": "requestBody", "operationId": "webhooks_createInstance", "jsonPointer": "/data/attributes/url", "localRole": "requires an absolute HTTPS URL with a non-empty host and rejects URL user/password or fragments; ports, paths, and queries are preserved" }, - { "toolField": "secret", "sourceKind": "requestBody", "operationId": "webhooks_createInstance", "jsonPointer": "/data/attributes/secret", "localRole": "local hardening requires at least 32 characters and rejects low-diversity or repeated-pattern values" }, - { "toolField": "event_types", "sourceKind": "requestBody", "operationId": "webhooks_createInstance", "jsonPointer": "/data/attributes/eventTypes", "localRole": "validated against the Apple 4.4.1 webhook event enum" }, - { "toolField": "enabled", "sourceKind": "requestBody", "operationId": "webhooks_createInstance", "jsonPointer": "/data/attributes/enabled", "localRole": "defaults to true when omitted" } + { + "toolField": "app_id", + "sourceKind": "requestBody", + "operationId": "webhooks_createInstance", + "jsonPointer": "/data/relationships/app/data/id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "webhooks_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "url", + "sourceKind": "requestBody", + "operationId": "webhooks_createInstance", + "jsonPointer": "/data/attributes/url", + "localRole": "requires an absolute HTTPS URL with a non-empty host and rejects URL user/password or fragments; ports, paths, and queries are preserved" + }, + { + "toolField": "secret", + "sourceKind": "requestBody", + "operationId": "webhooks_createInstance", + "jsonPointer": "/data/attributes/secret", + "localRole": "local hardening requires at least 32 characters and rejects low-diversity or repeated-pattern values" + }, + { + "toolField": "event_types", + "sourceKind": "requestBody", + "operationId": "webhooks_createInstance", + "jsonPointer": "/data/attributes/eventTypes", + "localRole": "validated against the Apple 4.4.1 webhook event enum" + }, + { + "toolField": "enabled", + "sourceKind": "requestBody", + "operationId": "webhooks_createInstance", + "jsonPointer": "/data/attributes/enabled", + "localRole": "defaults to true when omitted" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "webhooks_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "webhooks_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "webhook", "operationId": "webhooks_createInstance", "jsonPointer": "/data" } + { + "outputField": "webhook", + "operationId": "webhooks_createInstance", + "jsonPointer": "/data" + } ] }, "note": "Exact Apple 4.4.1 create operation. The handler returns a selected webhook projection and has no MCP output schema, so the contract remains partial." @@ -45,18 +95,35 @@ "effect": "destructive", "implementationState": "asBuilt", "operations": [ - { "operationId": "webhooks_deleteInstance", "method": "delete", "path": "/v1/webhooks/{id}", "role": "primary" } + { + "operationId": "webhooks_deleteInstance", + "method": "delete", + "path": "/v1/webhooks/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "webhook_id", "sourceKind": "parameter", "operationId": "webhooks_deleteInstance", "location": "path", "appleName": "id" } + { + "toolField": "webhook_id", + "sourceKind": "parameter", + "operationId": "webhooks_deleteInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "local", "sources": [ - { "operationId": "webhooks_deleteInstance", "statusCode": "204" } + { + "operationId": "webhooks_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "message", "localRole": "confirmation synthesized after Apple's content-free 204 response" } + { + "outputField": "message", + "localRole": "confirmation synthesized after Apple's content-free 204 response" + } ] }, "note": "Apple returns 204 with no response document; the MCP result is a local success confirmation." @@ -68,20 +135,51 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "webhooks_getInstance", "method": "get", "path": "/v1/webhooks/{id}", "role": "primary" } + { + "operationId": "webhooks_getInstance", + "method": "get", + "path": "/v1/webhooks/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "webhook_id", "sourceKind": "parameter", "operationId": "webhooks_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include_app", "sourceKind": "parameter", "operationId": "webhooks_getInstance", "location": "query", "appleName": "include", "localRole": "true emits the fixed query value app; false or omission emits no include parameter" } + { + "toolField": "webhook_id", + "sourceKind": "parameter", + "operationId": "webhooks_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include_app", + "sourceKind": "parameter", + "operationId": "webhooks_getInstance", + "location": "query", + "appleName": "include", + "localRole": "true emits the fixed query value app; false or omission emits no include parameter" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "webhooks_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "webhooks_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "webhook", "operationId": "webhooks_getInstance", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "webhooks_getInstance", "jsonPointer": "/included", "localRole": "lossless projection of the included app resource when include_app is true" } + { + "outputField": "webhook", + "operationId": "webhooks_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "webhooks_getInstance", + "jsonPointer": "/included", + "localRole": "lossless projection of the included app resource when include_app is true" + } ] }, "note": "The include=app request and Apple's top-level included app resource are preserved. Sparse fieldsets are intentionally omitted by the manifest-wide Apple 4.4.1 policy." @@ -93,24 +191,73 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "apps_webhooks_getToManyRelated", "method": "get", "path": "/v1/apps/{id}/webhooks", "role": "primary" } + { + "operationId": "apps_webhooks_getToManyRelated", + "method": "get", + "path": "/v1/apps/{id}/webhooks", + "role": "primary" + } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_webhooks_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "apps_webhooks_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "include_app", "sourceKind": "parameter", "operationId": "apps_webhooks_getToManyRelated", "location": "query", "appleName": "include", "localRole": "true emits the fixed query value app; false or omission emits no include parameter" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_webhooks_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "apps_webhooks_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "include_app", + "sourceKind": "parameter", + "operationId": "apps_webhooks_getToManyRelated", + "location": "query", + "appleName": "include", + "localRole": "true emits the fixed query value app; false or omission emits no include parameter" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "apps_webhooks_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "apps_webhooks_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "webhooks", "operationId": "apps_webhooks_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "apps_webhooks_getToManyRelated", "jsonPointer": "/included", "localRole": "lossless projection of included app resources when include_app is true" }, - { "outputField": "next_url", "operationId": "apps_webhooks_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "apps_webhooks_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "webhooks", + "operationId": "apps_webhooks_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "apps_webhooks_getToManyRelated", + "jsonPointer": "/included", + "localRole": "lossless projection of included app resources when include_app is true" + }, + { + "outputField": "next_url", + "operationId": "apps_webhooks_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "apps_webhooks_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "The include=app request and Apple's top-level included app resources are preserved. Sparse fieldsets are intentionally omitted by the manifest-wide Apple 4.4.1 policy." @@ -122,27 +269,93 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "webhooks_deliveries_getToManyRelated", "method": "get", "path": "/v1/webhooks/{id}/deliveries", "role": "primary" } + { + "operationId": "webhooks_deliveries_getToManyRelated", + "method": "get", + "path": "/v1/webhooks/{id}/deliveries", + "role": "primary" + } ], "fields": [ - { "toolField": "webhook_id", "sourceKind": "parameter", "operationId": "webhooks_deliveries_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "delivery_state", "sourceKind": "parameter", "operationId": "webhooks_deliveries_getToManyRelated", "location": "query", "appleName": "filter[deliveryState]" }, - { "toolField": "created_after", "sourceKind": "parameter", "operationId": "webhooks_deliveries_getToManyRelated", "location": "query", "appleName": "filter[createdDateGreaterThanOrEqualTo]" }, - { "toolField": "created_before", "sourceKind": "parameter", "operationId": "webhooks_deliveries_getToManyRelated", "location": "query", "appleName": "filter[createdDateLessThan]" }, - { "toolField": "include_event", "sourceKind": "parameter", "operationId": "webhooks_deliveries_getToManyRelated", "location": "query", "appleName": "include", "localRole": "true or omission emits the fixed query value event; false emits no include parameter" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "webhooks_deliveries_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." } + { + "toolField": "webhook_id", + "sourceKind": "parameter", + "operationId": "webhooks_deliveries_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "delivery_state", + "sourceKind": "parameter", + "operationId": "webhooks_deliveries_getToManyRelated", + "location": "query", + "appleName": "filter[deliveryState]" + }, + { + "toolField": "created_after", + "sourceKind": "parameter", + "operationId": "webhooks_deliveries_getToManyRelated", + "location": "query", + "appleName": "filter[createdDateGreaterThanOrEqualTo]" + }, + { + "toolField": "created_before", + "sourceKind": "parameter", + "operationId": "webhooks_deliveries_getToManyRelated", + "location": "query", + "appleName": "filter[createdDateLessThan]" + }, + { + "toolField": "include_event", + "sourceKind": "parameter", + "operationId": "webhooks_deliveries_getToManyRelated", + "location": "query", + "appleName": "include", + "localRole": "true or omission emits the fixed query value event; false emits no include parameter" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "webhooks_deliveries_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict Apple continuation URL for this exact collection. The caller must repeat every originating list control, including the effective/default limit, filters, sort, include, fields, and nested limits when supported; the exact query and a non-empty cursor are validated before sending the continuation request." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "webhooks_deliveries_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "webhooks_deliveries_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "deliveries", "operationId": "webhooks_deliveries_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "events", "operationId": "webhooks_deliveries_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "webhooks_deliveries_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "webhooks_deliveries_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "deliveries", + "operationId": "webhooks_deliveries_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "events", + "operationId": "webhooks_deliveries_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "webhooks_deliveries_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "webhooks_deliveries_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact Apple delivery filters and include mapping are represented. Sparse fieldsets are not exposed and the MCP response is a selected projection." @@ -155,19 +368,47 @@ "implementationState": "asBuilt", "operations": [], "fields": [ - { "toolField": "payload", "sourceKind": "local", "localRole": "exactly one raw-body alternative: UTF-8 webhook body" }, - { "toolField": "payload_base64", "sourceKind": "local", "localRole": "exactly one raw-body alternative: base64 raw webhook bytes" }, - { "toolField": "secret", "sourceKind": "local", "localRole": "optional HMAC-SHA256 verification key; must be supplied together with signature" }, - { "toolField": "signature", "sourceKind": "local", "localRole": "optional x-apple-signature value; must be supplied together with secret" } + { + "toolField": "payload", + "sourceKind": "local", + "localRole": "exactly one raw-body alternative: UTF-8 webhook body" + }, + { + "toolField": "payload_base64", + "sourceKind": "local", + "localRole": "exactly one raw-body alternative: base64 raw webhook bytes" + }, + { + "toolField": "secret", + "sourceKind": "local", + "localRole": "optional HMAC-SHA256 verification key; must be supplied together with signature" + }, + { + "toolField": "signature", + "sourceKind": "local", + "localRole": "optional x-apple-signature value; must be supplied together with secret" + } ], "response": { "mode": "local", "sources": [], "fields": [ - { "outputField": "event", "localRole": "ASCWebhookReceiverParser normalized event envelope" }, - { "outputField": "payload", "localRole": "decoded nested event payload" }, - { "outputField": "recommendedToolCalls", "localRole": "ASCWebhookTriagePolicy recommendations" }, - { "outputField": "signature", "localRole": "optional ASCWebhookSignatureVerifier result" } + { + "outputField": "event", + "localRole": "ASCWebhookReceiverParser normalized event envelope" + }, + { + "outputField": "payload", + "localRole": "decoded nested event payload" + }, + { + "outputField": "recommendedToolCalls", + "localRole": "ASCWebhookTriagePolicy recommendations" + }, + { + "outputField": "signature", + "localRole": "optional ASCWebhookSignatureVerifier result" + } ] }, "note": "Local receiver helper, not an Apple REST operation. Runtime validation requires exactly one raw-body representation and rejects incomplete secret/signature pairs before parsing. BUILD_UPLOAD triage recognizes buildUploads and calls build_uploads_get with build_upload_id. BUILD_BETA_DETAIL recognizes buildBetaDetails and uses delivery correlation without treating its identifier as a Build identifier. Direct background-resource relationships remain incomplete." @@ -185,21 +426,42 @@ "path": "/v1/webhookPings", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "webhookPings" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/webhook/data/type", "fixedValue": "webhooks" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "webhookPings" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/webhook/data/type", + "fixedValue": "webhooks" + } ] } ], "fields": [ - { "toolField": "webhook_id", "sourceKind": "requestBody", "operationId": "webhookPings_createInstance", "jsonPointer": "/data/relationships/webhook/data/id" } + { + "toolField": "webhook_id", + "sourceKind": "requestBody", + "operationId": "webhookPings_createInstance", + "jsonPointer": "/data/relationships/webhook/data/id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "webhookPings_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "webhookPings_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "ping", "operationId": "webhookPings_createInstance", "jsonPointer": "/data" } + { + "outputField": "ping", + "operationId": "webhookPings_createInstance", + "jsonPointer": "/data" + } ] }, "note": "Exact Apple 4.4.1 ping operation; the handler projects only the returned resource id and type." @@ -217,22 +479,47 @@ "path": "/v1/webhookDeliveries", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "webhookDeliveries" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/template/data/type", "fixedValue": "webhookDeliveries" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "webhookDeliveries" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/template/data/type", + "fixedValue": "webhookDeliveries" + } ] } ], "fields": [ - { "toolField": "delivery_id", "sourceKind": "requestBody", "operationId": "webhookDeliveries_createInstance", "jsonPointer": "/data/relationships/template/data/id" } + { + "toolField": "delivery_id", + "sourceKind": "requestBody", + "operationId": "webhookDeliveries_createInstance", + "jsonPointer": "/data/relationships/template/data/id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "webhookDeliveries_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "webhookDeliveries_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "delivery", "operationId": "webhookDeliveries_createInstance", "jsonPointer": "/data" }, - { "outputField": "events", "operationId": "webhookDeliveries_createInstance", "jsonPointer": "/included" } + { + "outputField": "delivery", + "operationId": "webhookDeliveries_createInstance", + "jsonPointer": "/data" + }, + { + "outputField": "events", + "operationId": "webhookDeliveries_createInstance", + "jsonPointer": "/included" + } ] }, "note": "Exact Apple 4.4.1 redelivery operation with a projected delivery/event response." @@ -245,24 +532,73 @@ "implementationState": "asBuilt", "operations": [], "fields": [ - { "toolField": "payload", "sourceKind": "local", "localRole": "optional UTF-8 webhook body; mutually exclusive with payload_base64" }, - { "toolField": "payload_base64", "sourceKind": "local", "localRole": "optional base64 raw webhook bytes; mutually exclusive with payload" }, - { "toolField": "event_type", "sourceKind": "local", "localRole": "explicit Apple webhook event type, preferred over the parsed payload value" }, - { "toolField": "resource_type", "sourceKind": "local", "localRole": "explicit related resource type used only when resource_id is also present" }, - { "toolField": "resource_id", "sourceKind": "local", "localRole": "explicit related resource identifier" }, - { "toolField": "delivery_id", "sourceKind": "local", "localRole": "failed-delivery recovery recommendation context" }, - { "toolField": "webhook_id", "sourceKind": "local", "localRole": "delivery-list and ping recommendation context" }, - { "toolField": "delivery_state", "sourceKind": "local", "localRole": "delivery severity and recovery context" }, - { "toolField": "http_status_code", "sourceKind": "local", "localRole": "receiver failure severity context" }, - { "toolField": "error_message", "sourceKind": "local", "localRole": "delivery diagnostic context" } + { + "toolField": "payload", + "sourceKind": "local", + "localRole": "optional UTF-8 webhook body; mutually exclusive with payload_base64" + }, + { + "toolField": "payload_base64", + "sourceKind": "local", + "localRole": "optional base64 raw webhook bytes; mutually exclusive with payload" + }, + { + "toolField": "event_type", + "sourceKind": "local", + "localRole": "explicit Apple webhook event type, preferred over the parsed payload value" + }, + { + "toolField": "resource_type", + "sourceKind": "local", + "localRole": "explicit related resource type used only when resource_id is also present" + }, + { + "toolField": "resource_id", + "sourceKind": "local", + "localRole": "explicit related resource identifier" + }, + { + "toolField": "delivery_id", + "sourceKind": "local", + "localRole": "failed-delivery recovery recommendation context" + }, + { + "toolField": "webhook_id", + "sourceKind": "local", + "localRole": "delivery-list and ping recommendation context" + }, + { + "toolField": "delivery_state", + "sourceKind": "local", + "localRole": "delivery severity and recovery context" + }, + { + "toolField": "http_status_code", + "sourceKind": "local", + "localRole": "receiver failure severity context" + }, + { + "toolField": "error_message", + "sourceKind": "local", + "localRole": "delivery diagnostic context" + } ], "response": { "mode": "local", "sources": [], "fields": [ - { "outputField": "severity", "localRole": "ASCWebhookTriagePolicy assessment" }, - { "outputField": "recommendedToolCalls", "localRole": "event-specific local recommendation policy" }, - { "outputField": "nextSteps", "localRole": "local recovery and lookup guidance" } + { + "outputField": "severity", + "localRole": "ASCWebhookTriagePolicy assessment" + }, + { + "outputField": "recommendedToolCalls", + "localRole": "event-specific local recommendation policy" + }, + { + "outputField": "nextSteps", + "localRole": "local recovery and lookup guidance" + } ] }, "note": "Local policy helper, not an Apple REST operation. Runtime validation requires event_type or one unambiguous raw-body representation. BUILD_UPLOAD maps buildUploads to build_uploads_get with build_upload_id. BUILD_BETA_DETAIL treats buildBetaDetails as a distinct identity and recommends delivery correlation instead of passing its identifier to Build tools. Some background/alternative-distribution relationship shapes remain incomplete." @@ -280,26 +616,79 @@ "path": "/v1/webhooks/{id}", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "webhooks" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "webhooks" + } ] } ], "fields": [ - { "toolField": "webhook_id", "sourceKind": "parameter", "operationId": "webhooks_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "webhook_id", "sourceKind": "requestBody", "operationId": "webhooks_updateInstance", "jsonPointer": "/data/id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "webhooks_updateInstance", "jsonPointer": "/data/attributes/name", "localRole": "omission leaves the value unchanged; explicit null clears the nullable Apple attribute" }, - { "toolField": "url", "sourceKind": "requestBody", "operationId": "webhooks_updateInstance", "jsonPointer": "/data/attributes/url", "localRole": "omission leaves the value unchanged; explicit null clears the nullable Apple attribute; a supplied value requires an absolute HTTPS URL with a non-empty host and rejects URL user/password or fragments; ports, paths, and queries are preserved" }, - { "toolField": "secret", "sourceKind": "requestBody", "operationId": "webhooks_updateInstance", "jsonPointer": "/data/attributes/secret", "localRole": "omission leaves the value unchanged; explicit null clears the nullable Apple attribute; a supplied value must contain at least 32 characters and cannot use low-diversity or repeated patterns" }, - { "toolField": "event_types", "sourceKind": "requestBody", "operationId": "webhooks_updateInstance", "jsonPointer": "/data/attributes/eventTypes", "localRole": "omission leaves the value unchanged; explicit null clears the nullable Apple attribute; supplied values are validated against the Apple 4.4.1 webhook event enum" }, - { "toolField": "enabled", "sourceKind": "requestBody", "operationId": "webhooks_updateInstance", "jsonPointer": "/data/attributes/enabled", "localRole": "omission leaves the value unchanged; explicit null clears the nullable Apple attribute" } + { + "toolField": "webhook_id", + "sourceKind": "parameter", + "operationId": "webhooks_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "webhook_id", + "sourceKind": "requestBody", + "operationId": "webhooks_updateInstance", + "jsonPointer": "/data/id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "webhooks_updateInstance", + "jsonPointer": "/data/attributes/name", + "localRole": "omission leaves the value unchanged; explicit null clears the nullable Apple attribute" + }, + { + "toolField": "url", + "sourceKind": "requestBody", + "operationId": "webhooks_updateInstance", + "jsonPointer": "/data/attributes/url", + "localRole": "omission leaves the value unchanged; explicit null clears the nullable Apple attribute; a supplied value requires an absolute HTTPS URL with a non-empty host and rejects URL user/password or fragments; ports, paths, and queries are preserved" + }, + { + "toolField": "secret", + "sourceKind": "requestBody", + "operationId": "webhooks_updateInstance", + "jsonPointer": "/data/attributes/secret", + "localRole": "omission leaves the value unchanged; explicit null clears the nullable Apple attribute; a supplied value must contain at least 32 characters and cannot use low-diversity or repeated patterns" + }, + { + "toolField": "event_types", + "sourceKind": "requestBody", + "operationId": "webhooks_updateInstance", + "jsonPointer": "/data/attributes/eventTypes", + "localRole": "omission leaves the value unchanged; explicit null clears the nullable Apple attribute; supplied values are validated against the Apple 4.4.1 webhook event enum" + }, + { + "toolField": "enabled", + "sourceKind": "requestBody", + "operationId": "webhooks_updateInstance", + "jsonPointer": "/data/attributes/enabled", + "localRole": "omission leaves the value unchanged; explicit null clears the nullable Apple attribute" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "webhooks_updateInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "webhooks_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "webhook", "operationId": "webhooks_updateInstance", "jsonPointer": "/data" } + { + "outputField": "webhook", + "operationId": "webhooks_updateInstance", + "jsonPointer": "/data" + } ] }, "note": "Exact Apple 4.4.1 update operation. All five Apple update attributes are nullable; the handler preserves the distinction between omission, explicit null, and a supplied value, enforces at least one changed attribute, and returns a selected projection without an MCP output schema." @@ -312,18 +701,43 @@ "implementationState": "asBuilt", "operations": [], "fields": [ - { "toolField": "secret", "sourceKind": "local", "localRole": "HMAC-SHA256 key" }, - { "toolField": "signature", "sourceKind": "local", "localRole": "x-apple-signature header normalization and constant-time comparison" }, - { "toolField": "payload", "sourceKind": "local", "localRole": "exactly one raw-body alternative: UTF-8 body" }, - { "toolField": "payload_base64", "sourceKind": "local", "localRole": "exactly one raw-body alternative: base64 raw bytes" } + { + "toolField": "secret", + "sourceKind": "local", + "localRole": "HMAC-SHA256 key" + }, + { + "toolField": "signature", + "sourceKind": "local", + "localRole": "x-apple-signature header normalization and constant-time comparison" + }, + { + "toolField": "payload", + "sourceKind": "local", + "localRole": "exactly one raw-body alternative: UTF-8 body" + }, + { + "toolField": "payload_base64", + "sourceKind": "local", + "localRole": "exactly one raw-body alternative: base64 raw bytes" + } ], "response": { "mode": "local", "sources": [], "fields": [ - { "outputField": "valid", "localRole": "constant-time comparison of provided and computed HMAC-SHA256 digests" }, - { "outputField": "computedSignature", "localRole": "locally computed digest" }, - { "outputField": "reason", "localRole": "local normalization or mismatch diagnostic" } + { + "outputField": "valid", + "localRole": "constant-time comparison of provided and computed HMAC-SHA256 digests" + }, + { + "outputField": "computedSignature", + "localRole": "locally computed digest" + }, + { + "outputField": "reason", + "localRole": "local normalization or mismatch diagnostic" + } ] }, "note": "Local receiver helper, not an Apple REST operation. Verification is byte-sensitive and runtime validation requires exactly one of payload or payload_base64 because Anthropic-compatible MCP schemas cannot retain a top-level oneOf constraint." diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/xcode_cloud.json b/Sources/asc-mcp/Resources/OperationManifest/tools/xcode_cloud.json index 1d174ba..da53d5b 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/xcode_cloud.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/xcode_cloud.json @@ -8,22 +8,59 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciBuildActions_artifacts_getToManyRelated", "method": "get", "path": "/v1/ciBuildActions/{id}/artifacts", "role": "primary" } + { + "operationId": "ciBuildActions_artifacts_getToManyRelated", + "method": "get", + "path": "/v1/ciBuildActions/{id}/artifacts", + "role": "primary" + } ], "fields": [ - { "toolField": "action_id", "sourceKind": "parameter", "operationId": "ciBuildActions_artifacts_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciBuildActions_artifacts_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "action_id", + "sourceKind": "parameter", + "operationId": "ciBuildActions_artifacts_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciBuildActions_artifacts_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciBuildActions_artifacts_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciBuildActions_artifacts_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "artifacts", "operationId": "ciBuildActions_artifacts_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "ciBuildActions_artifacts_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciBuildActions_artifacts_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "artifacts", + "operationId": "ciBuildActions_artifacts_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "ciBuildActions_artifacts_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciBuildActions_artifacts_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact Apple endpoint and exposed pagination mapping; sparse fields are not exposed and the handler returns a selected artifact projection without an MCP output schema." @@ -35,22 +72,59 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciBuildActions_issues_getToManyRelated", "method": "get", "path": "/v1/ciBuildActions/{id}/issues", "role": "primary" } + { + "operationId": "ciBuildActions_issues_getToManyRelated", + "method": "get", + "path": "/v1/ciBuildActions/{id}/issues", + "role": "primary" + } ], "fields": [ - { "toolField": "action_id", "sourceKind": "parameter", "operationId": "ciBuildActions_issues_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciBuildActions_issues_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "action_id", + "sourceKind": "parameter", + "operationId": "ciBuildActions_issues_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciBuildActions_issues_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciBuildActions_issues_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciBuildActions_issues_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "issues", "operationId": "ciBuildActions_issues_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "ciBuildActions_issues_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciBuildActions_issues_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "issues", + "operationId": "ciBuildActions_issues_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "ciBuildActions_issues_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciBuildActions_issues_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Sparse fields are omitted; the selected projection preserves Apple FileLocation.path and emits JSON null when fileSource is absent." @@ -62,22 +136,59 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciBuildActions_testResults_getToManyRelated", "method": "get", "path": "/v1/ciBuildActions/{id}/testResults", "role": "primary" } + { + "operationId": "ciBuildActions_testResults_getToManyRelated", + "method": "get", + "path": "/v1/ciBuildActions/{id}/testResults", + "role": "primary" + } ], "fields": [ - { "toolField": "action_id", "sourceKind": "parameter", "operationId": "ciBuildActions_testResults_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciBuildActions_testResults_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "action_id", + "sourceKind": "parameter", + "operationId": "ciBuildActions_testResults_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciBuildActions_testResults_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciBuildActions_testResults_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciBuildActions_testResults_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "testResults", "operationId": "ciBuildActions_testResults_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "next_url", "operationId": "ciBuildActions_testResults_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciBuildActions_testResults_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "testResults", + "operationId": "ciBuildActions_testResults_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "next_url", + "operationId": "ciBuildActions_testResults_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciBuildActions_testResults_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Sparse fields are omitted; the selected projection preserves FileLocation.path and destinationTestResults.uuid and exposes only Apple 4.4.1 destination fields." @@ -89,24 +200,73 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciBuildActions_getInstance", "method": "get", "path": "/v1/ciBuildActions/{id}", "role": "primary" } + { + "operationId": "ciBuildActions_getInstance", + "method": "get", + "path": "/v1/ciBuildActions/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "action_id", "sourceKind": "parameter", "operationId": "ciBuildActions_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciBuildActions_getInstance", "location": "query", "appleName": "include" } + { + "toolField": "action_id", + "sourceKind": "parameter", + "operationId": "ciBuildActions_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciBuildActions_getInstance", + "location": "query", + "appleName": "include" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciBuildActions_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciBuildActions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "action", "operationId": "ciBuildActions_getInstance", "jsonPointer": "/data" }, - { "outputField": "action.buildRunRelationshipUrl", "operationId": "ciBuildActions_getInstance", "jsonPointer": "/data/relationships/buildRun/links/self", "localRole": "Selected projection of JSON:API relationship self; buildRunUrl remains the related-resource URL." }, - { "outputField": "action.artifactsRelationshipUrl", "operationId": "ciBuildActions_getInstance", "jsonPointer": "/data/relationships/artifacts/links/self", "localRole": "Selected projection of JSON:API relationship self; artifactsUrl remains the related-resource URL." }, - { "outputField": "action.issuesRelationshipUrl", "operationId": "ciBuildActions_getInstance", "jsonPointer": "/data/relationships/issues/links/self", "localRole": "Selected projection of JSON:API relationship self; issuesUrl remains the related-resource URL." }, - { "outputField": "action.testResultsRelationshipUrl", "operationId": "ciBuildActions_getInstance", "jsonPointer": "/data/relationships/testResults/links/self", "localRole": "Selected projection of JSON:API relationship self; testResultsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciBuildActions_getInstance", "jsonPointer": "/included" } + { + "outputField": "action", + "operationId": "ciBuildActions_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "action.buildRunRelationshipUrl", + "operationId": "ciBuildActions_getInstance", + "jsonPointer": "/data/relationships/buildRun/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildRunUrl remains the related-resource URL." + }, + { + "outputField": "action.artifactsRelationshipUrl", + "operationId": "ciBuildActions_getInstance", + "jsonPointer": "/data/relationships/artifacts/links/self", + "localRole": "Selected projection of JSON:API relationship self; artifactsUrl remains the related-resource URL." + }, + { + "outputField": "action.issuesRelationshipUrl", + "operationId": "ciBuildActions_getInstance", + "jsonPointer": "/data/relationships/issues/links/self", + "localRole": "Selected projection of JSON:API relationship self; issuesUrl remains the related-resource URL." + }, + { + "outputField": "action.testResultsRelationshipUrl", + "operationId": "ciBuildActions_getInstance", + "jsonPointer": "/data/relationships/testResults/links/self", + "localRole": "Selected projection of JSON:API relationship self; testResultsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciBuildActions_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The include mapping is exact; sparse fields are omitted. The tool has no MCP output schema and returns a selected action projection that keeps each documented links.related URL as *Url and links.self URL as *RelationshipUrl." @@ -118,18 +278,37 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciArtifacts_getInstance", "method": "get", "path": "/v1/ciArtifacts/{id}", "role": "primary" } + { + "operationId": "ciArtifacts_getInstance", + "method": "get", + "path": "/v1/ciArtifacts/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "artifact_id", "sourceKind": "parameter", "operationId": "ciArtifacts_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "artifact_id", + "sourceKind": "parameter", + "operationId": "ciArtifacts_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciArtifacts_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciArtifacts_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "artifact", "operationId": "ciArtifacts_getInstance", "jsonPointer": "/data" } + { + "outputField": "artifact", + "operationId": "ciArtifacts_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Sparse artifact fields are not exposed; the handler returns a selected projection." @@ -141,28 +320,95 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciBuildRuns_actions_getToManyRelated", "method": "get", "path": "/v1/ciBuildRuns/{id}/actions", "role": "primary" } + { + "operationId": "ciBuildRuns_actions_getToManyRelated", + "method": "get", + "path": "/v1/ciBuildRuns/{id}/actions", + "role": "primary" + } ], "fields": [ - { "toolField": "build_run_id", "sourceKind": "parameter", "operationId": "ciBuildRuns_actions_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciBuildRuns_actions_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciBuildRuns_actions_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "build_run_id", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciBuildRuns_actions_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciBuildRuns_actions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "actions", "operationId": "ciBuildRuns_actions_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "actions.*.buildRunRelationshipUrl", "operationId": "ciBuildRuns_actions_getToManyRelated", "jsonPointer": "/data/*/relationships/buildRun/links/self", "localRole": "Selected projection of JSON:API relationship self; buildRunUrl remains the related-resource URL." }, - { "outputField": "actions.*.artifactsRelationshipUrl", "operationId": "ciBuildRuns_actions_getToManyRelated", "jsonPointer": "/data/*/relationships/artifacts/links/self", "localRole": "Selected projection of JSON:API relationship self; artifactsUrl remains the related-resource URL." }, - { "outputField": "actions.*.issuesRelationshipUrl", "operationId": "ciBuildRuns_actions_getToManyRelated", "jsonPointer": "/data/*/relationships/issues/links/self", "localRole": "Selected projection of JSON:API relationship self; issuesUrl remains the related-resource URL." }, - { "outputField": "actions.*.testResultsRelationshipUrl", "operationId": "ciBuildRuns_actions_getToManyRelated", "jsonPointer": "/data/*/relationships/testResults/links/self", "localRole": "Selected projection of JSON:API relationship self; testResultsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciBuildRuns_actions_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciBuildRuns_actions_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciBuildRuns_actions_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "actions", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "actions.*.buildRunRelationshipUrl", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "jsonPointer": "/data/*/relationships/buildRun/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildRunUrl remains the related-resource URL." + }, + { + "outputField": "actions.*.artifactsRelationshipUrl", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "jsonPointer": "/data/*/relationships/artifacts/links/self", + "localRole": "Selected projection of JSON:API relationship self; artifactsUrl remains the related-resource URL." + }, + { + "outputField": "actions.*.issuesRelationshipUrl", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "jsonPointer": "/data/*/relationships/issues/links/self", + "localRole": "Selected projection of JSON:API relationship self; issuesUrl remains the related-resource URL." + }, + { + "outputField": "actions.*.testResultsRelationshipUrl", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "jsonPointer": "/data/*/relationships/testResults/links/self", + "localRole": "Selected projection of JSON:API relationship self; testResultsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciBuildRuns_actions_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact path/include/limit mapping; sparse action/build-run fields are not exposed. The tool has no MCP output schema and returns selected action projections that keep links.related as *Url and links.self as *RelationshipUrl." @@ -182,54 +428,276 @@ } ], "fields": [ - { "toolField": "build_run_id", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "version", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[version]" }, - { "toolField": "expired", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[expired]" }, - { "toolField": "processing_state", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[processingState]" }, - { "toolField": "beta_review_states", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[betaAppReviewSubmission.betaReviewState]" }, - { "toolField": "uses_non_exempt_encryption", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[usesNonExemptEncryption]" }, - { "toolField": "pre_release_versions", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[preReleaseVersion.version]" }, - { "toolField": "pre_release_platforms", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[preReleaseVersion.platform]" }, - { "toolField": "build_audience_types", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[buildAudienceType]" }, - { "toolField": "pre_release_version_ids", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[preReleaseVersion]" }, - { "toolField": "app_ids", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[app]" }, - { "toolField": "beta_group_ids", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[betaGroups]" }, - { "toolField": "app_store_version_ids", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[appStoreVersion]" }, - { "toolField": "build_ids", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "filter[id]" }, - { "toolField": "uses_non_exempt_encryption_set", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "exists[usesNonExemptEncryption]" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "sort" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "individual_testers_limit", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "limit[individualTesters]" }, - { "toolField": "beta_groups_limit", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "limit[betaGroups]" }, - { "toolField": "beta_build_localizations_limit", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "limit[betaBuildLocalizations]" }, - { "toolField": "icons_limit", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "limit[icons]" }, - { "toolField": "build_bundles_limit", "sourceKind": "parameter", "operationId": "ciBuildRuns_builds_getToManyRelated", "location": "query", "appleName": "limit[buildBundles]" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "build_run_id", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "version", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[version]" + }, + { + "toolField": "expired", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[expired]" + }, + { + "toolField": "processing_state", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[processingState]" + }, + { + "toolField": "beta_review_states", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[betaAppReviewSubmission.betaReviewState]" + }, + { + "toolField": "uses_non_exempt_encryption", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[usesNonExemptEncryption]" + }, + { + "toolField": "pre_release_versions", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[preReleaseVersion.version]" + }, + { + "toolField": "pre_release_platforms", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[preReleaseVersion.platform]" + }, + { + "toolField": "build_audience_types", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[buildAudienceType]" + }, + { + "toolField": "pre_release_version_ids", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[preReleaseVersion]" + }, + { + "toolField": "app_ids", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[app]" + }, + { + "toolField": "beta_group_ids", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[betaGroups]" + }, + { + "toolField": "app_store_version_ids", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[appStoreVersion]" + }, + { + "toolField": "build_ids", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "uses_non_exempt_encryption_set", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "exists[usesNonExemptEncryption]" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "individual_testers_limit", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "limit[individualTesters]" + }, + { + "toolField": "beta_groups_limit", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "limit[betaGroups]" + }, + { + "toolField": "beta_build_localizations_limit", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "limit[betaBuildLocalizations]" + }, + { + "toolField": "icons_limit", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "limit[icons]" + }, + { + "toolField": "build_bundles_limit", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "location": "query", + "appleName": "limit[buildBundles]" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciBuildRuns_builds_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciBuildRuns_builds_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "builds", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "builds.*.preReleaseVersionRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/preReleaseVersion/links/self", "localRole": "Selected projection of JSON:API relationship self; preReleaseVersionUrl remains the related-resource URL." }, - { "outputField": "builds.*.individualTestersRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/individualTesters/links/self", "localRole": "Selected projection of JSON:API relationship self; individualTestersUrl remains the related-resource URL." }, - { "outputField": "builds.*.betaGroupsRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/betaGroups/links/self", "localRole": "Selected projection of JSON:API relationship self; betaGroupsUrl remains the related-resource URL." }, - { "outputField": "builds.*.betaBuildLocalizationsRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/betaBuildLocalizations/links/self", "localRole": "Selected projection of JSON:API relationship self; betaBuildLocalizationsUrl remains the related-resource URL." }, - { "outputField": "builds.*.appEncryptionDeclarationRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/appEncryptionDeclaration/links/self", "localRole": "Selected projection of JSON:API relationship self; appEncryptionDeclarationUrl remains the related-resource URL." }, - { "outputField": "builds.*.betaAppReviewSubmissionRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/betaAppReviewSubmission/links/self", "localRole": "Selected projection of JSON:API relationship self; betaAppReviewSubmissionUrl remains the related-resource URL." }, - { "outputField": "builds.*.appRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/app/links/self", "localRole": "Selected projection of JSON:API relationship self; appUrl remains the related-resource URL." }, - { "outputField": "builds.*.buildBetaDetailRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/buildBetaDetail/links/self", "localRole": "Selected projection of JSON:API relationship self; buildBetaDetailUrl remains the related-resource URL." }, - { "outputField": "builds.*.appStoreVersionRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/appStoreVersion/links/self", "localRole": "Selected projection of JSON:API relationship self; appStoreVersionUrl remains the related-resource URL." }, - { "outputField": "builds.*.iconsRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/icons/links/self", "localRole": "Selected projection of JSON:API relationship self; iconsUrl remains the related-resource URL." }, - { "outputField": "builds.*.perfPowerMetricsRelationshipUrl", "localRole": "Stable null projection because Apple 4.4.1 defines links.related but no links.self for this relationship; perfPowerMetricsUrl preserves the documented related URL." }, - { "outputField": "builds.*.diagnosticSignaturesRelationshipUrl", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/data/*/relationships/diagnosticSignatures/links/self", "localRole": "Selected projection of JSON:API relationship self; diagnosticSignaturesUrl remains the related-resource URL." }, - { "outputField": "builds.*.buildBundlesUrl", "localRole": "Stable null compatibility projection because Apple 4.4.1 defines no links object for the buildBundles relationship." }, - { "outputField": "builds.*.buildUploadUrl", "localRole": "Stable null compatibility projection because Apple 4.4.1 defines no links object for the buildUpload relationship." }, - { "outputField": "next_url", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciBuildRuns_builds_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "builds", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "builds.*.preReleaseVersionRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/preReleaseVersion/links/self", + "localRole": "Selected projection of JSON:API relationship self; preReleaseVersionUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.individualTestersRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/individualTesters/links/self", + "localRole": "Selected projection of JSON:API relationship self; individualTestersUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.betaGroupsRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/betaGroups/links/self", + "localRole": "Selected projection of JSON:API relationship self; betaGroupsUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.betaBuildLocalizationsRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/betaBuildLocalizations/links/self", + "localRole": "Selected projection of JSON:API relationship self; betaBuildLocalizationsUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.appEncryptionDeclarationRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/appEncryptionDeclaration/links/self", + "localRole": "Selected projection of JSON:API relationship self; appEncryptionDeclarationUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.betaAppReviewSubmissionRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/betaAppReviewSubmission/links/self", + "localRole": "Selected projection of JSON:API relationship self; betaAppReviewSubmissionUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.appRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/app/links/self", + "localRole": "Selected projection of JSON:API relationship self; appUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.buildBetaDetailRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/buildBetaDetail/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildBetaDetailUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.appStoreVersionRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/appStoreVersion/links/self", + "localRole": "Selected projection of JSON:API relationship self; appStoreVersionUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.iconsRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/icons/links/self", + "localRole": "Selected projection of JSON:API relationship self; iconsUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.perfPowerMetricsRelationshipUrl", + "localRole": "Stable null projection because Apple 4.4.1 defines links.related but no links.self for this relationship; perfPowerMetricsUrl preserves the documented related URL." + }, + { + "outputField": "builds.*.diagnosticSignaturesRelationshipUrl", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/data/*/relationships/diagnosticSignatures/links/self", + "localRole": "Selected projection of JSON:API relationship self; diagnosticSignaturesUrl remains the related-resource URL." + }, + { + "outputField": "builds.*.buildBundlesUrl", + "localRole": "Stable null compatibility projection because Apple 4.4.1 defines no links object for the buildBundles relationship." + }, + { + "outputField": "builds.*.buildUploadUrl", + "localRole": "Stable null compatibility projection because Apple 4.4.1 defines no links object for the buildUpload relationship." + }, + { + "outputField": "next_url", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciBuildRuns_builds_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Apple 4.4.1 build filters, sort expressions, include values, relationship limits, top-level limit, total, and continuation are exposed. Each relationship limit is accepted only with its matching include; sparse fields follow the global family policy. The tool has no MCP output schema and returns a selected build projection: documented links.related values remain *Url, documented links.self values are *RelationshipUrl, perfPowerMetricsRelationshipUrl is null because that relationship has no self link, and legacy buildBundlesUrl/buildUploadUrl compatibility keys are null because those relationships define no links." @@ -249,20 +717,60 @@ } ], "fields": [ - { "toolField": "build_run_id", "sourceKind": "parameter", "operationId": "ciBuildRuns_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciBuildRuns_getInstance", "location": "query", "appleName": "include" }, - { "toolField": "builds_limit", "sourceKind": "parameter", "operationId": "ciBuildRuns_getInstance", "location": "query", "appleName": "limit[builds]" } + { + "toolField": "build_run_id", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_getInstance", + "location": "query", + "appleName": "include" + }, + { + "toolField": "builds_limit", + "sourceKind": "parameter", + "operationId": "ciBuildRuns_getInstance", + "location": "query", + "appleName": "limit[builds]" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciBuildRuns_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciBuildRuns_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildRun", "operationId": "ciBuildRuns_getInstance", "jsonPointer": "/data" }, - { "outputField": "buildRun.buildsRelationshipUrl", "operationId": "ciBuildRuns_getInstance", "jsonPointer": "/data/relationships/builds/links/self", "localRole": "Selected projection of JSON:API relationship self; buildsUrl remains the related-resource URL." }, - { "outputField": "buildRun.actionsRelationshipUrl", "operationId": "ciBuildRuns_getInstance", "jsonPointer": "/data/relationships/actions/links/self", "localRole": "Selected projection of JSON:API relationship self; actionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciBuildRuns_getInstance", "jsonPointer": "/included" } + { + "outputField": "buildRun", + "operationId": "ciBuildRuns_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "buildRun.buildsRelationshipUrl", + "operationId": "ciBuildRuns_getInstance", + "jsonPointer": "/data/relationships/builds/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildsUrl remains the related-resource URL." + }, + { + "outputField": "buildRun.actionsRelationshipUrl", + "operationId": "ciBuildRuns_getInstance", + "jsonPointer": "/data/relationships/actions/links/self", + "localRole": "Selected projection of JSON:API relationship self; actionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciBuildRuns_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The include and dependent builds_limit mappings are exact; sparse fields follow the global family policy. The tool has no MCP output schema and returns a selected build-run projection that keeps links.related as *Url and links.self as *RelationshipUrl." @@ -280,31 +788,108 @@ "path": "/v1/ciBuildRuns", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "ciBuildRuns" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/workflow/data/type", "fixedValue": "ciWorkflows", "localRole": "presentOnlyWithWorkflowId" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/buildRun/data/type", "fixedValue": "ciBuildRuns", "localRole": "presentOnlyWithBuildRunId" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/sourceBranchOrTag/data/type", "fixedValue": "scmGitReferences", "localRole": "presentOnlyWithSourceBranchOrTagId" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/pullRequest/data/type", "fixedValue": "scmPullRequests", "localRole": "presentOnlyWithPullRequestId" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "ciBuildRuns" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/workflow/data/type", + "fixedValue": "ciWorkflows", + "localRole": "presentOnlyWithWorkflowId" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/buildRun/data/type", + "fixedValue": "ciBuildRuns", + "localRole": "presentOnlyWithBuildRunId" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/sourceBranchOrTag/data/type", + "fixedValue": "scmGitReferences", + "localRole": "presentOnlyWithSourceBranchOrTagId" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/pullRequest/data/type", + "fixedValue": "scmPullRequests", + "localRole": "presentOnlyWithPullRequestId" + } ] } ], "fields": [ - { "toolField": "workflow_id", "sourceKind": "requestBody", "operationId": "ciBuildRuns_createInstance", "jsonPointer": "/data/relationships/workflow/data/id", "localRole": "exactlyOneRunSelector" }, - { "toolField": "build_run_id", "sourceKind": "requestBody", "operationId": "ciBuildRuns_createInstance", "jsonPointer": "/data/relationships/buildRun/data/id", "localRole": "exactlyOneRunSelector" }, - { "toolField": "source_branch_or_tag_id", "sourceKind": "requestBody", "operationId": "ciBuildRuns_createInstance", "jsonPointer": "/data/relationships/sourceBranchOrTag/data/id", "localRole": "atMostOneSourceSelector" }, - { "toolField": "pull_request_id", "sourceKind": "requestBody", "operationId": "ciBuildRuns_createInstance", "jsonPointer": "/data/relationships/pullRequest/data/id", "localRole": "atMostOneSourceSelector" }, - { "toolField": "clean", "sourceKind": "requestBody", "operationId": "ciBuildRuns_createInstance", "jsonPointer": "/data/attributes/clean", "localRole": "Maps concrete Boolean values. Apple's explicit-null variant is intentionally omitted from the public Boolean schema because omission has the same default-selection semantics." } + { + "toolField": "workflow_id", + "sourceKind": "requestBody", + "operationId": "ciBuildRuns_createInstance", + "jsonPointer": "/data/relationships/workflow/data/id", + "localRole": "exactlyOneRunSelector" + }, + { + "toolField": "build_run_id", + "sourceKind": "requestBody", + "operationId": "ciBuildRuns_createInstance", + "jsonPointer": "/data/relationships/buildRun/data/id", + "localRole": "exactlyOneRunSelector" + }, + { + "toolField": "source_branch_or_tag_id", + "sourceKind": "requestBody", + "operationId": "ciBuildRuns_createInstance", + "jsonPointer": "/data/relationships/sourceBranchOrTag/data/id", + "localRole": "atMostOneSourceSelector" + }, + { + "toolField": "pull_request_id", + "sourceKind": "requestBody", + "operationId": "ciBuildRuns_createInstance", + "jsonPointer": "/data/relationships/pullRequest/data/id", + "localRole": "atMostOneSourceSelector" + }, + { + "toolField": "clean", + "sourceKind": "requestBody", + "operationId": "ciBuildRuns_createInstance", + "jsonPointer": "/data/attributes/clean", + "localRole": "Maps concrete Boolean values. Apple's explicit-null variant is intentionally omitted from the public Boolean schema because omission has the same default-selection semantics." + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciBuildRuns_createInstance", "statusCode": "201", "mediaType": "application/json" } + { + "operationId": "ciBuildRuns_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildRun", "operationId": "ciBuildRuns_createInstance", "jsonPointer": "/data" }, - { "outputField": "buildRun.buildsRelationshipUrl", "operationId": "ciBuildRuns_createInstance", "jsonPointer": "/data/relationships/builds/links/self", "localRole": "Selected projection of JSON:API relationship self; buildsUrl remains the related-resource URL." }, - { "outputField": "buildRun.actionsRelationshipUrl", "operationId": "ciBuildRuns_createInstance", "jsonPointer": "/data/relationships/actions/links/self", "localRole": "Selected projection of JSON:API relationship self; actionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciBuildRuns_createInstance", "jsonPointer": "/included", "localRole": "Preserved only when Apple returns a validated non-empty included resource array." } + { + "outputField": "buildRun", + "operationId": "ciBuildRuns_createInstance", + "jsonPointer": "/data" + }, + { + "outputField": "buildRun.buildsRelationshipUrl", + "operationId": "ciBuildRuns_createInstance", + "jsonPointer": "/data/relationships/builds/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildsUrl remains the related-resource URL." + }, + { + "outputField": "buildRun.actionsRelationshipUrl", + "operationId": "ciBuildRuns_createInstance", + "jsonPointer": "/data/relationships/actions/links/self", + "localRole": "Selected projection of JSON:API relationship self; actionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciBuildRuns_createInstance", + "jsonPointer": "/included", + "localRole": "Preserved only when Apple returns a validated non-empty included resource array." + } ] }, "note": "Exact Apple request fields. Runtime preflight requires exactly one of workflow_id and build_run_id; source_branch_or_tag_id and pull_request_id remain mutually exclusive. Apple permits explicit null for optional clean; that variant is intentionally omitted because MCP omission has the same default-selection semantics. Conditional JSON Schema keywords are intentionally omitted for broad MCP client compatibility. The tool has no MCP output schema; its selected committed build-run projection keeps links.related as *Url and links.self as *RelationshipUrl, and validated non-empty included resources are preserved." @@ -316,18 +901,37 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciIssues_getInstance", "method": "get", "path": "/v1/ciIssues/{id}", "role": "primary" } + { + "operationId": "ciIssues_getInstance", + "method": "get", + "path": "/v1/ciIssues/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "issue_id", "sourceKind": "parameter", "operationId": "ciIssues_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "issue_id", + "sourceKind": "parameter", + "operationId": "ciIssues_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciIssues_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciIssues_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "issue", "operationId": "ciIssues_getInstance", "jsonPointer": "/data" } + { + "outputField": "issue", + "operationId": "ciIssues_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Sparse fields are omitted; the selected projection preserves Apple FileLocation.path and emits JSON null when fileSource is absent." @@ -347,19 +951,54 @@ } ], "fields": [ - { "toolField": "macos_version_id", "sourceKind": "parameter", "operationId": "ciMacOsVersions_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciMacOsVersions_getInstance", "location": "query", "appleName": "include" }, - { "toolField": "xcode_versions_limit", "sourceKind": "parameter", "operationId": "ciMacOsVersions_getInstance", "location": "query", "appleName": "limit[xcodeVersions]" } + { + "toolField": "macos_version_id", + "sourceKind": "parameter", + "operationId": "ciMacOsVersions_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciMacOsVersions_getInstance", + "location": "query", + "appleName": "include" + }, + { + "toolField": "xcode_versions_limit", + "sourceKind": "parameter", + "operationId": "ciMacOsVersions_getInstance", + "location": "query", + "appleName": "limit[xcodeVersions]" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciMacOsVersions_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciMacOsVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "macOSVersion", "operationId": "ciMacOsVersions_getInstance", "jsonPointer": "/data" }, - { "outputField": "macOSVersion.xcodeVersionsRelationshipUrl", "operationId": "ciMacOsVersions_getInstance", "jsonPointer": "/data/relationships/xcodeVersions/links/self", "localRole": "Selected projection of JSON:API relationship self; xcodeVersionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciMacOsVersions_getInstance", "jsonPointer": "/included" } + { + "outputField": "macOSVersion", + "operationId": "ciMacOsVersions_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "macOSVersion.xcodeVersionsRelationshipUrl", + "operationId": "ciMacOsVersions_getInstance", + "jsonPointer": "/data/relationships/xcodeVersions/links/self", + "localRole": "Selected projection of JSON:API relationship self; xcodeVersionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciMacOsVersions_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The include and dependent xcode_versions_limit mappings are exact; sparse fields follow the global family policy. The tool has no MCP output schema and its selected projection keeps xcodeVersionsUrl from links.related and xcodeVersionsRelationshipUrl from links.self." @@ -379,22 +1018,69 @@ } ], "fields": [ - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciMacOsVersions_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciMacOsVersions_getCollection", "location": "query", "appleName": "include" }, - { "toolField": "xcode_versions_limit", "sourceKind": "parameter", "operationId": "ciMacOsVersions_getCollection", "location": "query", "appleName": "limit[xcodeVersions]" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciMacOsVersions_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciMacOsVersions_getCollection", + "location": "query", + "appleName": "include" + }, + { + "toolField": "xcode_versions_limit", + "sourceKind": "parameter", + "operationId": "ciMacOsVersions_getCollection", + "location": "query", + "appleName": "limit[xcodeVersions]" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciMacOsVersions_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciMacOsVersions_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "macOSVersions", "operationId": "ciMacOsVersions_getCollection", "jsonPointer": "/data" }, - { "outputField": "macOSVersions.*.xcodeVersionsRelationshipUrl", "operationId": "ciMacOsVersions_getCollection", "jsonPointer": "/data/*/relationships/xcodeVersions/links/self", "localRole": "Selected projection of JSON:API relationship self; xcodeVersionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciMacOsVersions_getCollection", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciMacOsVersions_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciMacOsVersions_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "macOSVersions", + "operationId": "ciMacOsVersions_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "macOSVersions.*.xcodeVersionsRelationshipUrl", + "operationId": "ciMacOsVersions_getCollection", + "jsonPointer": "/data/*/relationships/xcodeVersions/links/self", + "localRole": "Selected projection of JSON:API relationship self; xcodeVersionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciMacOsVersions_getCollection", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciMacOsVersions_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciMacOsVersions_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "The top-level limit, include, and dependent xcode_versions_limit map exactly; sparse fields follow the global family policy. The tool has no MCP output schema and its selected projections keep xcodeVersionsUrl from links.related and xcodeVersionsRelationshipUrl from links.self." @@ -414,26 +1100,96 @@ } ], "fields": [ - { "toolField": "product_id", "sourceKind": "parameter", "operationId": "ciProducts_buildRuns_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "build_id", "sourceKind": "parameter", "operationId": "ciProducts_buildRuns_getToManyRelated", "location": "query", "appleName": "filter[builds]" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "ciProducts_buildRuns_getToManyRelated", "location": "query", "appleName": "sort" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciProducts_buildRuns_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "builds_limit", "sourceKind": "parameter", "operationId": "ciProducts_buildRuns_getToManyRelated", "location": "query", "appleName": "limit[builds]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciProducts_buildRuns_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "product_id", + "sourceKind": "parameter", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "build_id", + "sourceKind": "parameter", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "location": "query", + "appleName": "filter[builds]" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "builds_limit", + "sourceKind": "parameter", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "location": "query", + "appleName": "limit[builds]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciProducts_buildRuns_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciProducts_buildRuns_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildRuns", "operationId": "ciProducts_buildRuns_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "buildRuns.*.buildsRelationshipUrl", "operationId": "ciProducts_buildRuns_getToManyRelated", "jsonPointer": "/data/*/relationships/builds/links/self", "localRole": "Selected projection of JSON:API relationship self; buildsUrl remains the related-resource URL." }, - { "outputField": "buildRuns.*.actionsRelationshipUrl", "operationId": "ciProducts_buildRuns_getToManyRelated", "jsonPointer": "/data/*/relationships/actions/links/self", "localRole": "Selected projection of JSON:API relationship self; actionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciProducts_buildRuns_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciProducts_buildRuns_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciProducts_buildRuns_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "buildRuns", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "buildRuns.*.buildsRelationshipUrl", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "jsonPointer": "/data/*/relationships/builds/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildsUrl remains the related-resource URL." + }, + { + "outputField": "buildRuns.*.actionsRelationshipUrl", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "jsonPointer": "/data/*/relationships/actions/links/self", + "localRole": "Selected projection of JSON:API relationship self; actionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "The build filter, sort, include, dependent builds_limit, and top-level limit map exactly; sparse fields follow the global family policy. The tool has no MCP output schema and returns selected build-run projections that keep links.related as *Url and links.self as *RelationshipUrl." @@ -445,26 +1201,83 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciProducts_workflows_getToManyRelated", "method": "get", "path": "/v1/ciProducts/{id}/workflows", "role": "primary" } + { + "operationId": "ciProducts_workflows_getToManyRelated", + "method": "get", + "path": "/v1/ciProducts/{id}/workflows", + "role": "primary" + } ], "fields": [ - { "toolField": "product_id", "sourceKind": "parameter", "operationId": "ciProducts_workflows_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciProducts_workflows_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciProducts_workflows_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "product_id", + "sourceKind": "parameter", + "operationId": "ciProducts_workflows_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciProducts_workflows_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciProducts_workflows_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciProducts_workflows_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciProducts_workflows_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "workflows", "operationId": "ciProducts_workflows_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "workflows.*.repositoryRelationshipUrl", "operationId": "ciProducts_workflows_getToManyRelated", "jsonPointer": "/data/*/relationships/repository/links/self", "localRole": "Selected projection of JSON:API relationship self; repositoryUrl remains the related-resource URL." }, - { "outputField": "workflows.*.buildRunsRelationshipUrl", "operationId": "ciProducts_workflows_getToManyRelated", "jsonPointer": "/data/*/relationships/buildRuns/links/self", "localRole": "Selected projection of JSON:API relationship self; buildRunsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciProducts_workflows_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciProducts_workflows_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciProducts_workflows_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "workflows", + "operationId": "ciProducts_workflows_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "workflows.*.repositoryRelationshipUrl", + "operationId": "ciProducts_workflows_getToManyRelated", + "jsonPointer": "/data/*/relationships/repository/links/self", + "localRole": "Selected projection of JSON:API relationship self; repositoryUrl remains the related-resource URL." + }, + { + "outputField": "workflows.*.buildRunsRelationshipUrl", + "operationId": "ciProducts_workflows_getToManyRelated", + "jsonPointer": "/data/*/relationships/buildRuns/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildRunsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciProducts_workflows_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciProducts_workflows_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciProducts_workflows_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact exposed mapping; sparse fields follow the global family policy. The tool has no MCP output schema and returns selected workflow projections that keep links.related as *Url and links.self as *RelationshipUrl." @@ -484,23 +1297,78 @@ } ], "fields": [ - { "toolField": "product_id", "sourceKind": "parameter", "operationId": "ciProducts_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciProducts_getInstance", "location": "query", "appleName": "include" }, - { "toolField": "primary_repositories_limit", "sourceKind": "parameter", "operationId": "ciProducts_getInstance", "location": "query", "appleName": "limit[primaryRepositories]" } + { + "toolField": "product_id", + "sourceKind": "parameter", + "operationId": "ciProducts_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciProducts_getInstance", + "location": "query", + "appleName": "include" + }, + { + "toolField": "primary_repositories_limit", + "sourceKind": "parameter", + "operationId": "ciProducts_getInstance", + "location": "query", + "appleName": "limit[primaryRepositories]" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciProducts_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciProducts_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "product", "operationId": "ciProducts_getInstance", "jsonPointer": "/data" }, - { "outputField": "product.appRelationshipUrl", "operationId": "ciProducts_getInstance", "jsonPointer": "/data/relationships/app/links/self", "localRole": "Selected projection of JSON:API relationship self; appUrl remains the related-resource URL." }, - { "outputField": "product.workflowsRelationshipUrl", "operationId": "ciProducts_getInstance", "jsonPointer": "/data/relationships/workflows/links/self", "localRole": "Selected projection of JSON:API relationship self; workflowsUrl remains the related-resource URL." }, - { "outputField": "product.primaryRepositoriesRelationshipUrl", "operationId": "ciProducts_getInstance", "jsonPointer": "/data/relationships/primaryRepositories/links/self", "localRole": "Selected projection of JSON:API relationship self; primaryRepositoriesUrl remains the related-resource URL." }, - { "outputField": "product.additionalRepositoriesRelationshipUrl", "operationId": "ciProducts_getInstance", "jsonPointer": "/data/relationships/additionalRepositories/links/self", "localRole": "Selected projection of JSON:API relationship self; additionalRepositoriesUrl remains the related-resource URL." }, - { "outputField": "product.buildRunsRelationshipUrl", "operationId": "ciProducts_getInstance", "jsonPointer": "/data/relationships/buildRuns/links/self", "localRole": "Selected projection of JSON:API relationship self; buildRunsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciProducts_getInstance", "jsonPointer": "/included" } + { + "outputField": "product", + "operationId": "ciProducts_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "product.appRelationshipUrl", + "operationId": "ciProducts_getInstance", + "jsonPointer": "/data/relationships/app/links/self", + "localRole": "Selected projection of JSON:API relationship self; appUrl remains the related-resource URL." + }, + { + "outputField": "product.workflowsRelationshipUrl", + "operationId": "ciProducts_getInstance", + "jsonPointer": "/data/relationships/workflows/links/self", + "localRole": "Selected projection of JSON:API relationship self; workflowsUrl remains the related-resource URL." + }, + { + "outputField": "product.primaryRepositoriesRelationshipUrl", + "operationId": "ciProducts_getInstance", + "jsonPointer": "/data/relationships/primaryRepositories/links/self", + "localRole": "Selected projection of JSON:API relationship self; primaryRepositoriesUrl remains the related-resource URL." + }, + { + "outputField": "product.additionalRepositoriesRelationshipUrl", + "operationId": "ciProducts_getInstance", + "jsonPointer": "/data/relationships/additionalRepositories/links/self", + "localRole": "Selected projection of JSON:API relationship self; additionalRepositoriesUrl remains the related-resource URL." + }, + { + "outputField": "product.buildRunsRelationshipUrl", + "operationId": "ciProducts_getInstance", + "jsonPointer": "/data/relationships/buildRuns/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildRunsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciProducts_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The include and dependent primary_repositories_limit mappings are exact; sparse fields follow the global family policy. The tool has no MCP output schema and returns a selected product projection that keeps links.related as *Url and links.self as *RelationshipUrl." @@ -520,28 +1388,107 @@ } ], "fields": [ - { "toolField": "product_type", "sourceKind": "parameter", "operationId": "ciProducts_getCollection", "location": "query", "appleName": "filter[productType]" }, - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "ciProducts_getCollection", "location": "query", "appleName": "filter[app]" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciProducts_getCollection", "location": "query", "appleName": "include" }, - { "toolField": "primary_repositories_limit", "sourceKind": "parameter", "operationId": "ciProducts_getCollection", "location": "query", "appleName": "limit[primaryRepositories]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciProducts_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "product_type", + "sourceKind": "parameter", + "operationId": "ciProducts_getCollection", + "location": "query", + "appleName": "filter[productType]" + }, + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "ciProducts_getCollection", + "location": "query", + "appleName": "filter[app]" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciProducts_getCollection", + "location": "query", + "appleName": "include" + }, + { + "toolField": "primary_repositories_limit", + "sourceKind": "parameter", + "operationId": "ciProducts_getCollection", + "location": "query", + "appleName": "limit[primaryRepositories]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciProducts_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciProducts_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciProducts_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "products", "operationId": "ciProducts_getCollection", "jsonPointer": "/data" }, - { "outputField": "products.*.appRelationshipUrl", "operationId": "ciProducts_getCollection", "jsonPointer": "/data/*/relationships/app/links/self", "localRole": "Selected projection of JSON:API relationship self; appUrl remains the related-resource URL." }, - { "outputField": "products.*.workflowsRelationshipUrl", "operationId": "ciProducts_getCollection", "jsonPointer": "/data/*/relationships/workflows/links/self", "localRole": "Selected projection of JSON:API relationship self; workflowsUrl remains the related-resource URL." }, - { "outputField": "products.*.primaryRepositoriesRelationshipUrl", "operationId": "ciProducts_getCollection", "jsonPointer": "/data/*/relationships/primaryRepositories/links/self", "localRole": "Selected projection of JSON:API relationship self; primaryRepositoriesUrl remains the related-resource URL." }, - { "outputField": "products.*.additionalRepositoriesRelationshipUrl", "operationId": "ciProducts_getCollection", "jsonPointer": "/data/*/relationships/additionalRepositories/links/self", "localRole": "Selected projection of JSON:API relationship self; additionalRepositoriesUrl remains the related-resource URL." }, - { "outputField": "products.*.buildRunsRelationshipUrl", "operationId": "ciProducts_getCollection", "jsonPointer": "/data/*/relationships/buildRuns/links/self", "localRole": "Selected projection of JSON:API relationship self; buildRunsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciProducts_getCollection", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciProducts_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciProducts_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "products", + "operationId": "ciProducts_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "products.*.appRelationshipUrl", + "operationId": "ciProducts_getCollection", + "jsonPointer": "/data/*/relationships/app/links/self", + "localRole": "Selected projection of JSON:API relationship self; appUrl remains the related-resource URL." + }, + { + "outputField": "products.*.workflowsRelationshipUrl", + "operationId": "ciProducts_getCollection", + "jsonPointer": "/data/*/relationships/workflows/links/self", + "localRole": "Selected projection of JSON:API relationship self; workflowsUrl remains the related-resource URL." + }, + { + "outputField": "products.*.primaryRepositoriesRelationshipUrl", + "operationId": "ciProducts_getCollection", + "jsonPointer": "/data/*/relationships/primaryRepositories/links/self", + "localRole": "Selected projection of JSON:API relationship self; primaryRepositoriesUrl remains the related-resource URL." + }, + { + "outputField": "products.*.additionalRepositoriesRelationshipUrl", + "operationId": "ciProducts_getCollection", + "jsonPointer": "/data/*/relationships/additionalRepositories/links/self", + "localRole": "Selected projection of JSON:API relationship self; additionalRepositoriesUrl remains the related-resource URL." + }, + { + "outputField": "products.*.buildRunsRelationshipUrl", + "operationId": "ciProducts_getCollection", + "jsonPointer": "/data/*/relationships/buildRuns/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildRunsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciProducts_getCollection", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciProducts_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciProducts_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "The exposed filters, include, dependent primary_repositories_limit, and top-level limit map exactly; sparse fields follow the global family policy. The tool has no MCP output schema and returns selected product projections that keep links.related as *Url and links.self as *RelationshipUrl." @@ -553,20 +1500,49 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "scmGitReferences_getInstance", "method": "get", "path": "/v1/scmGitReferences/{id}", "role": "primary" } + { + "operationId": "scmGitReferences_getInstance", + "method": "get", + "path": "/v1/scmGitReferences/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "git_reference_id", "sourceKind": "parameter", "operationId": "scmGitReferences_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "scmGitReferences_getInstance", "location": "query", "appleName": "include" } - ], - "response": { + { + "toolField": "git_reference_id", + "sourceKind": "parameter", + "operationId": "scmGitReferences_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "scmGitReferences_getInstance", + "location": "query", + "appleName": "include" + } + ], + "response": { "mode": "projection", "sources": [ - { "operationId": "scmGitReferences_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "scmGitReferences_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "gitReference", "operationId": "scmGitReferences_getInstance", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "scmGitReferences_getInstance", "jsonPointer": "/included" } + { + "outputField": "gitReference", + "operationId": "scmGitReferences_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "scmGitReferences_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The include mapping is exact; sparse fields are omitted and the response is projected." @@ -578,27 +1554,90 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "scmProviders_repositories_getToManyRelated", "method": "get", "path": "/v1/scmProviders/{id}/repositories", "role": "primary" } + { + "operationId": "scmProviders_repositories_getToManyRelated", + "method": "get", + "path": "/v1/scmProviders/{id}/repositories", + "role": "primary" + } ], "fields": [ - { "toolField": "provider_id", "sourceKind": "parameter", "operationId": "scmProviders_repositories_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "repository_id", "sourceKind": "parameter", "operationId": "scmProviders_repositories_getToManyRelated", "location": "query", "appleName": "filter[id]" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "scmProviders_repositories_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "scmProviders_repositories_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "provider_id", + "sourceKind": "parameter", + "operationId": "scmProviders_repositories_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "repository_id", + "sourceKind": "parameter", + "operationId": "scmProviders_repositories_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "scmProviders_repositories_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "scmProviders_repositories_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "scmProviders_repositories_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "scmProviders_repositories_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "repositories", "operationId": "scmProviders_repositories_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "repositories.*.gitReferencesRelationshipUrl", "operationId": "scmProviders_repositories_getToManyRelated", "jsonPointer": "/data/*/relationships/gitReferences/links/self", "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." }, - { "outputField": "repositories.*.pullRequestsRelationshipUrl", "operationId": "scmProviders_repositories_getToManyRelated", "jsonPointer": "/data/*/relationships/pullRequests/links/self", "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "scmProviders_repositories_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "scmProviders_repositories_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "scmProviders_repositories_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "repositories", + "operationId": "scmProviders_repositories_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "repositories.*.gitReferencesRelationshipUrl", + "operationId": "scmProviders_repositories_getToManyRelated", + "jsonPointer": "/data/*/relationships/gitReferences/links/self", + "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." + }, + { + "outputField": "repositories.*.pullRequestsRelationshipUrl", + "operationId": "scmProviders_repositories_getToManyRelated", + "jsonPointer": "/data/*/relationships/pullRequests/links/self", + "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "scmProviders_repositories_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "scmProviders_repositories_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "scmProviders_repositories_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact exposed filter/include/limit mapping; Apple sparse fields are omitted. The tool has no MCP output schema and returns selected repository projections that keep links.related as *Url and links.self as *RelationshipUrl." @@ -610,19 +1649,43 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "scmProviders_getInstance", "method": "get", "path": "/v1/scmProviders/{id}", "role": "primary" } + { + "operationId": "scmProviders_getInstance", + "method": "get", + "path": "/v1/scmProviders/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "provider_id", "sourceKind": "parameter", "operationId": "scmProviders_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "provider_id", + "sourceKind": "parameter", + "operationId": "scmProviders_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "scmProviders_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "scmProviders_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "provider", "operationId": "scmProviders_getInstance", "jsonPointer": "/data" }, - { "outputField": "provider.repositoriesRelationshipUrl", "operationId": "scmProviders_getInstance", "jsonPointer": "/data/relationships/repositories/links/self", "localRole": "Selected projection of JSON:API relationship self; repositoriesUrl remains the related-resource URL." } + { + "outputField": "provider", + "operationId": "scmProviders_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "provider.repositoriesRelationshipUrl", + "operationId": "scmProviders_getInstance", + "jsonPointer": "/data/relationships/repositories/links/self", + "localRole": "Selected projection of JSON:API relationship self; repositoriesUrl remains the related-resource URL." + } ] }, "note": "The tool has no MCP output schema. Its selected projection keeps scmProviderType.kind as the stable scalar, exposes displayName and isOnPremise, and preserves the links-only repository relationship as repositoriesUrl from links.related plus repositoriesRelationshipUrl from links.self." @@ -634,22 +1697,58 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "scmProviders_getCollection", "method": "get", "path": "/v1/scmProviders", "role": "primary" } + { + "operationId": "scmProviders_getCollection", + "method": "get", + "path": "/v1/scmProviders", + "role": "primary" + } ], "fields": [ - { "toolField": "limit", "sourceKind": "parameter", "operationId": "scmProviders_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "scmProviders_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "scmProviders_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "scmProviders_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "providers", "operationId": "scmProviders_getCollection", "jsonPointer": "/data" }, - { "outputField": "providers.*.repositoriesRelationshipUrl", "operationId": "scmProviders_getCollection", "jsonPointer": "/data/*/relationships/repositories/links/self", "localRole": "Selected projection of JSON:API relationship self; repositoriesUrl remains the related-resource URL." }, - { "outputField": "next_url", "operationId": "scmProviders_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "scmProviders_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "providers", + "operationId": "scmProviders_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "providers.*.repositoriesRelationshipUrl", + "operationId": "scmProviders_getCollection", + "jsonPointer": "/data/*/relationships/repositories/links/self", + "localRole": "Selected projection of JSON:API relationship self; repositoriesUrl remains the related-resource URL." + }, + { + "outputField": "next_url", + "operationId": "scmProviders_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "scmProviders_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Limit and pagination map exactly. The tool has no MCP output schema; its selected projections keep scmProviderType.kind, displayName, isOnPremise, and the links-only repository relationship as repositoriesUrl from links.related plus repositoriesRelationshipUrl from links.self." @@ -661,20 +1760,49 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "scmPullRequests_getInstance", "method": "get", "path": "/v1/scmPullRequests/{id}", "role": "primary" } + { + "operationId": "scmPullRequests_getInstance", + "method": "get", + "path": "/v1/scmPullRequests/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "pull_request_id", "sourceKind": "parameter", "operationId": "scmPullRequests_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "scmPullRequests_getInstance", "location": "query", "appleName": "include" } + { + "toolField": "pull_request_id", + "sourceKind": "parameter", + "operationId": "scmPullRequests_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "scmPullRequests_getInstance", + "location": "query", + "appleName": "include" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "scmPullRequests_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "scmPullRequests_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "pullRequest", "operationId": "scmPullRequests_getInstance", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "scmPullRequests_getInstance", "jsonPointer": "/included" } + { + "outputField": "pullRequest", + "operationId": "scmPullRequests_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "scmPullRequests_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The include mapping is exact; sparse fields are omitted and the response is projected." @@ -686,22 +1814,61 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "scmRepositories_getInstance", "method": "get", "path": "/v1/scmRepositories/{id}", "role": "primary" } + { + "operationId": "scmRepositories_getInstance", + "method": "get", + "path": "/v1/scmRepositories/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "repository_id", "sourceKind": "parameter", "operationId": "scmRepositories_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "scmRepositories_getInstance", "location": "query", "appleName": "include" } + { + "toolField": "repository_id", + "sourceKind": "parameter", + "operationId": "scmRepositories_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "scmRepositories_getInstance", + "location": "query", + "appleName": "include" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "scmRepositories_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "scmRepositories_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "repository", "operationId": "scmRepositories_getInstance", "jsonPointer": "/data" }, - { "outputField": "repository.gitReferencesRelationshipUrl", "operationId": "scmRepositories_getInstance", "jsonPointer": "/data/relationships/gitReferences/links/self", "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." }, - { "outputField": "repository.pullRequestsRelationshipUrl", "operationId": "scmRepositories_getInstance", "jsonPointer": "/data/relationships/pullRequests/links/self", "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "scmRepositories_getInstance", "jsonPointer": "/included" } + { + "outputField": "repository", + "operationId": "scmRepositories_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "repository.gitReferencesRelationshipUrl", + "operationId": "scmRepositories_getInstance", + "jsonPointer": "/data/relationships/gitReferences/links/self", + "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." + }, + { + "outputField": "repository.pullRequestsRelationshipUrl", + "operationId": "scmRepositories_getInstance", + "jsonPointer": "/data/relationships/pullRequests/links/self", + "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "scmRepositories_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The include mapping is exact and sparse fields are omitted. The tool has no MCP output schema and returns a selected repository projection that keeps links.related as *Url and links.self as *RelationshipUrl." @@ -713,26 +1880,83 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "scmRepositories_getCollection", "method": "get", "path": "/v1/scmRepositories", "role": "primary" } + { + "operationId": "scmRepositories_getCollection", + "method": "get", + "path": "/v1/scmRepositories", + "role": "primary" + } ], "fields": [ - { "toolField": "repository_id", "sourceKind": "parameter", "operationId": "scmRepositories_getCollection", "location": "query", "appleName": "filter[id]" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "scmRepositories_getCollection", "location": "query", "appleName": "include" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "scmRepositories_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "repository_id", + "sourceKind": "parameter", + "operationId": "scmRepositories_getCollection", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "scmRepositories_getCollection", + "location": "query", + "appleName": "include" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "scmRepositories_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "scmRepositories_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "scmRepositories_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "repositories", "operationId": "scmRepositories_getCollection", "jsonPointer": "/data" }, - { "outputField": "repositories.*.gitReferencesRelationshipUrl", "operationId": "scmRepositories_getCollection", "jsonPointer": "/data/*/relationships/gitReferences/links/self", "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." }, - { "outputField": "repositories.*.pullRequestsRelationshipUrl", "operationId": "scmRepositories_getCollection", "jsonPointer": "/data/*/relationships/pullRequests/links/self", "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "scmRepositories_getCollection", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "scmRepositories_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "scmRepositories_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "repositories", + "operationId": "scmRepositories_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "repositories.*.gitReferencesRelationshipUrl", + "operationId": "scmRepositories_getCollection", + "jsonPointer": "/data/*/relationships/gitReferences/links/self", + "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." + }, + { + "outputField": "repositories.*.pullRequestsRelationshipUrl", + "operationId": "scmRepositories_getCollection", + "jsonPointer": "/data/*/relationships/pullRequests/links/self", + "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "scmRepositories_getCollection", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "scmRepositories_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "scmRepositories_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact exposed id/include/limit mapping; Apple sparse fields are omitted. The tool has no MCP output schema and returns selected repository projections that keep links.related as *Url and links.self as *RelationshipUrl." @@ -744,24 +1968,71 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "scmRepositories_gitReferences_getToManyRelated", "method": "get", "path": "/v1/scmRepositories/{id}/gitReferences", "role": "primary" } + { + "operationId": "scmRepositories_gitReferences_getToManyRelated", + "method": "get", + "path": "/v1/scmRepositories/{id}/gitReferences", + "role": "primary" + } ], "fields": [ - { "toolField": "repository_id", "sourceKind": "parameter", "operationId": "scmRepositories_gitReferences_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "scmRepositories_gitReferences_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "scmRepositories_gitReferences_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "repository_id", + "sourceKind": "parameter", + "operationId": "scmRepositories_gitReferences_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "scmRepositories_gitReferences_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "scmRepositories_gitReferences_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "scmRepositories_gitReferences_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "scmRepositories_gitReferences_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "gitReferences", "operationId": "scmRepositories_gitReferences_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "scmRepositories_gitReferences_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "scmRepositories_gitReferences_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "scmRepositories_gitReferences_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "gitReferences", + "operationId": "scmRepositories_gitReferences_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "scmRepositories_gitReferences_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "scmRepositories_gitReferences_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "scmRepositories_gitReferences_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact exposed path/include/limit mapping; Apple sparse fields are omitted." @@ -773,24 +2044,71 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "scmRepositories_pullRequests_getToManyRelated", "method": "get", "path": "/v1/scmRepositories/{id}/pullRequests", "role": "primary" } + { + "operationId": "scmRepositories_pullRequests_getToManyRelated", + "method": "get", + "path": "/v1/scmRepositories/{id}/pullRequests", + "role": "primary" + } ], "fields": [ - { "toolField": "repository_id", "sourceKind": "parameter", "operationId": "scmRepositories_pullRequests_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "scmRepositories_pullRequests_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "scmRepositories_pullRequests_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "repository_id", + "sourceKind": "parameter", + "operationId": "scmRepositories_pullRequests_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "scmRepositories_pullRequests_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "scmRepositories_pullRequests_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "scmRepositories_pullRequests_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "scmRepositories_pullRequests_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "pullRequests", "operationId": "scmRepositories_pullRequests_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "included", "operationId": "scmRepositories_pullRequests_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "scmRepositories_pullRequests_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "scmRepositories_pullRequests_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "pullRequests", + "operationId": "scmRepositories_pullRequests_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "included", + "operationId": "scmRepositories_pullRequests_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "scmRepositories_pullRequests_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "scmRepositories_pullRequests_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact exposed path/include/limit mapping; Apple sparse fields are omitted." @@ -802,18 +2120,37 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciTestResults_getInstance", "method": "get", "path": "/v1/ciTestResults/{id}", "role": "primary" } + { + "operationId": "ciTestResults_getInstance", + "method": "get", + "path": "/v1/ciTestResults/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "test_result_id", "sourceKind": "parameter", "operationId": "ciTestResults_getInstance", "location": "path", "appleName": "id" } + { + "toolField": "test_result_id", + "sourceKind": "parameter", + "operationId": "ciTestResults_getInstance", + "location": "path", + "appleName": "id" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciTestResults_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciTestResults_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "testResult", "operationId": "ciTestResults_getInstance", "jsonPointer": "/data" } + { + "outputField": "testResult", + "operationId": "ciTestResults_getInstance", + "jsonPointer": "/data" + } ] }, "note": "Sparse fields are omitted; the selected projection preserves FileLocation.path and destinationTestResults.uuid and exposes only Apple 4.4.1 destination fields." @@ -833,26 +2170,96 @@ } ], "fields": [ - { "toolField": "workflow_id", "sourceKind": "parameter", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "build_id", "sourceKind": "parameter", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "location": "query", "appleName": "filter[builds]" }, - { "toolField": "sort", "sourceKind": "parameter", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "location": "query", "appleName": "sort" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "builds_limit", "sourceKind": "parameter", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "location": "query", "appleName": "limit[builds]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "workflow_id", + "sourceKind": "parameter", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "build_id", + "sourceKind": "parameter", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "location": "query", + "appleName": "filter[builds]" + }, + { + "toolField": "sort", + "sourceKind": "parameter", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "location": "query", + "appleName": "sort" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "builds_limit", + "sourceKind": "parameter", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "location": "query", + "appleName": "limit[builds]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciWorkflows_buildRuns_getToManyRelated", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "buildRuns", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "buildRuns.*.buildsRelationshipUrl", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "jsonPointer": "/data/*/relationships/builds/links/self", "localRole": "Selected projection of JSON:API relationship self; buildsUrl remains the related-resource URL." }, - { "outputField": "buildRuns.*.actionsRelationshipUrl", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "jsonPointer": "/data/*/relationships/actions/links/self", "localRole": "Selected projection of JSON:API relationship self; actionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "buildRuns", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "buildRuns.*.buildsRelationshipUrl", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "jsonPointer": "/data/*/relationships/builds/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildsUrl remains the related-resource URL." + }, + { + "outputField": "buildRuns.*.actionsRelationshipUrl", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "jsonPointer": "/data/*/relationships/actions/links/self", + "localRole": "Selected projection of JSON:API relationship self; actionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "The exposed build filter, sort, include, dependent builds_limit, and top-level limit map exactly; sparse fields follow the global family policy. The tool has no MCP output schema and returns selected build-run projections that keep links.related as *Url and links.self as *RelationshipUrl." @@ -864,22 +2271,61 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciWorkflows_getInstance", "method": "get", "path": "/v1/ciWorkflows/{id}", "role": "primary" } + { + "operationId": "ciWorkflows_getInstance", + "method": "get", + "path": "/v1/ciWorkflows/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "workflow_id", "sourceKind": "parameter", "operationId": "ciWorkflows_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciWorkflows_getInstance", "location": "query", "appleName": "include" } + { + "toolField": "workflow_id", + "sourceKind": "parameter", + "operationId": "ciWorkflows_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciWorkflows_getInstance", + "location": "query", + "appleName": "include" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciWorkflows_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciWorkflows_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "workflow", "operationId": "ciWorkflows_getInstance", "jsonPointer": "/data" }, - { "outputField": "workflow.repositoryRelationshipUrl", "operationId": "ciWorkflows_getInstance", "jsonPointer": "/data/relationships/repository/links/self", "localRole": "Selected projection of JSON:API relationship self; repositoryUrl remains the related-resource URL." }, - { "outputField": "workflow.buildRunsRelationshipUrl", "operationId": "ciWorkflows_getInstance", "jsonPointer": "/data/relationships/buildRuns/links/self", "localRole": "Selected projection of JSON:API relationship self; buildRunsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciWorkflows_getInstance", "jsonPointer": "/included" } + { + "outputField": "workflow", + "operationId": "ciWorkflows_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "workflow.repositoryRelationshipUrl", + "operationId": "ciWorkflows_getInstance", + "jsonPointer": "/data/relationships/repository/links/self", + "localRole": "Selected projection of JSON:API relationship self; repositoryUrl remains the related-resource URL." + }, + { + "outputField": "workflow.buildRunsRelationshipUrl", + "operationId": "ciWorkflows_getInstance", + "jsonPointer": "/data/relationships/buildRuns/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildRunsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciWorkflows_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The include mapping is exact; sparse fields follow the global family policy. The tool has no MCP output schema and returns a selected workflow projection that keeps links.related as *Url and links.self as *RelationshipUrl." @@ -899,19 +2345,54 @@ } ], "fields": [ - { "toolField": "xcode_version_id", "sourceKind": "parameter", "operationId": "ciXcodeVersions_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciXcodeVersions_getInstance", "location": "query", "appleName": "include" }, - { "toolField": "macos_versions_limit", "sourceKind": "parameter", "operationId": "ciXcodeVersions_getInstance", "location": "query", "appleName": "limit[macOsVersions]" } + { + "toolField": "xcode_version_id", + "sourceKind": "parameter", + "operationId": "ciXcodeVersions_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciXcodeVersions_getInstance", + "location": "query", + "appleName": "include" + }, + { + "toolField": "macos_versions_limit", + "sourceKind": "parameter", + "operationId": "ciXcodeVersions_getInstance", + "location": "query", + "appleName": "limit[macOsVersions]" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciXcodeVersions_getInstance", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciXcodeVersions_getInstance", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "xcodeVersion", "operationId": "ciXcodeVersions_getInstance", "jsonPointer": "/data" }, - { "outputField": "xcodeVersion.macOSVersionsRelationshipUrl", "operationId": "ciXcodeVersions_getInstance", "jsonPointer": "/data/relationships/macOsVersions/links/self", "localRole": "Selected projection of JSON:API relationship self; macOSVersionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciXcodeVersions_getInstance", "jsonPointer": "/included" } + { + "outputField": "xcodeVersion", + "operationId": "ciXcodeVersions_getInstance", + "jsonPointer": "/data" + }, + { + "outputField": "xcodeVersion.macOSVersionsRelationshipUrl", + "operationId": "ciXcodeVersions_getInstance", + "jsonPointer": "/data/relationships/macOsVersions/links/self", + "localRole": "Selected projection of JSON:API relationship self; macOSVersionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciXcodeVersions_getInstance", + "jsonPointer": "/included" + } ] }, "note": "The include and dependent macos_versions_limit mappings are exact; sparse fields follow the global family policy. The tool has no MCP output schema and its selected projection keeps macOSVersionsUrl from links.related and macOSVersionsRelationshipUrl from links.self." @@ -931,22 +2412,69 @@ } ], "fields": [ - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciXcodeVersions_getCollection", "location": "query", "appleName": "limit" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciXcodeVersions_getCollection", "location": "query", "appleName": "include" }, - { "toolField": "macos_versions_limit", "sourceKind": "parameter", "operationId": "ciXcodeVersions_getCollection", "location": "query", "appleName": "limit[macOsVersions]" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "paginationContinuation" } + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciXcodeVersions_getCollection", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciXcodeVersions_getCollection", + "location": "query", + "appleName": "include" + }, + { + "toolField": "macos_versions_limit", + "sourceKind": "parameter", + "operationId": "ciXcodeVersions_getCollection", + "location": "query", + "appleName": "limit[macOsVersions]" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "paginationContinuation" + } ], "response": { "mode": "projection", "sources": [ - { "operationId": "ciXcodeVersions_getCollection", "statusCode": "200", "mediaType": "application/json" } + { + "operationId": "ciXcodeVersions_getCollection", + "statusCode": "200", + "mediaType": "application/json" + } ], "fields": [ - { "outputField": "xcodeVersions", "operationId": "ciXcodeVersions_getCollection", "jsonPointer": "/data" }, - { "outputField": "xcodeVersions.*.macOSVersionsRelationshipUrl", "operationId": "ciXcodeVersions_getCollection", "jsonPointer": "/data/*/relationships/macOsVersions/links/self", "localRole": "Selected projection of JSON:API relationship self; macOSVersionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciXcodeVersions_getCollection", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciXcodeVersions_getCollection", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciXcodeVersions_getCollection", "jsonPointer": "/meta/paging/total" } + { + "outputField": "xcodeVersions", + "operationId": "ciXcodeVersions_getCollection", + "jsonPointer": "/data" + }, + { + "outputField": "xcodeVersions.*.macOSVersionsRelationshipUrl", + "operationId": "ciXcodeVersions_getCollection", + "jsonPointer": "/data/*/relationships/macOsVersions/links/self", + "localRole": "Selected projection of JSON:API relationship self; macOSVersionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciXcodeVersions_getCollection", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciXcodeVersions_getCollection", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciXcodeVersions_getCollection", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "The top-level limit, include, and dependent macos_versions_limit map exactly; sparse fields follow the global family policy. The tool has no MCP output schema and its selected projections keep macOSVersionsUrl from links.related and macOSVersionsRelationshipUrl from links.self." @@ -958,25 +2486,91 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "apps_ciProduct_getToOneRelated", "method": "get", "path": "/v1/apps/{id}/ciProduct", "role": "primary" } + { + "operationId": "apps_ciProduct_getToOneRelated", + "method": "get", + "path": "/v1/apps/{id}/ciProduct", + "role": "primary" + } ], "fields": [ - { "toolField": "app_id", "sourceKind": "parameter", "operationId": "apps_ciProduct_getToOneRelated", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "apps_ciProduct_getToOneRelated", "location": "query", "appleName": "include" }, - { "toolField": "primary_repositories_limit", "sourceKind": "parameter", "operationId": "apps_ciProduct_getToOneRelated", "location": "query", "appleName": "limit[primaryRepositories]" } + { + "toolField": "app_id", + "sourceKind": "parameter", + "operationId": "apps_ciProduct_getToOneRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "apps_ciProduct_getToOneRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "primary_repositories_limit", + "sourceKind": "parameter", + "operationId": "apps_ciProduct_getToOneRelated", + "location": "query", + "appleName": "limit[primaryRepositories]" + } ], "response": { "mode": "projection", - "sources": [{ "operationId": "apps_ciProduct_getToOneRelated", "statusCode": "200", "mediaType": "application/json" }], + "sources": [ + { + "operationId": "apps_ciProduct_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], "fields": [ - { "outputField": "product", "operationId": "apps_ciProduct_getToOneRelated", "jsonPointer": "/data" }, - { "outputField": "product.appRelationshipUrl", "operationId": "apps_ciProduct_getToOneRelated", "jsonPointer": "/data/relationships/app/links/self", "localRole": "Selected projection of JSON:API relationship self; appUrl remains the related-resource URL." }, - { "outputField": "product.workflowsRelationshipUrl", "operationId": "apps_ciProduct_getToOneRelated", "jsonPointer": "/data/relationships/workflows/links/self", "localRole": "Selected projection of JSON:API relationship self; workflowsUrl remains the related-resource URL." }, - { "outputField": "product.primaryRepositoriesRelationshipUrl", "operationId": "apps_ciProduct_getToOneRelated", "jsonPointer": "/data/relationships/primaryRepositories/links/self", "localRole": "Selected projection of JSON:API relationship self; primaryRepositoriesUrl remains the related-resource URL." }, - { "outputField": "product.additionalRepositoriesRelationshipUrl", "operationId": "apps_ciProduct_getToOneRelated", "jsonPointer": "/data/relationships/additionalRepositories/links/self", "localRole": "Selected projection of JSON:API relationship self; additionalRepositoriesUrl remains the related-resource URL." }, - { "outputField": "product.buildRunsRelationshipUrl", "operationId": "apps_ciProduct_getToOneRelated", "jsonPointer": "/data/relationships/buildRuns/links/self", "localRole": "Selected projection of JSON:API relationship self; buildRunsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "apps_ciProduct_getToOneRelated", "jsonPointer": "/included" }, - { "outputField": "self_url", "operationId": "apps_ciProduct_getToOneRelated", "jsonPointer": "/links/self" } + { + "outputField": "product", + "operationId": "apps_ciProduct_getToOneRelated", + "jsonPointer": "/data" + }, + { + "outputField": "product.appRelationshipUrl", + "operationId": "apps_ciProduct_getToOneRelated", + "jsonPointer": "/data/relationships/app/links/self", + "localRole": "Selected projection of JSON:API relationship self; appUrl remains the related-resource URL." + }, + { + "outputField": "product.workflowsRelationshipUrl", + "operationId": "apps_ciProduct_getToOneRelated", + "jsonPointer": "/data/relationships/workflows/links/self", + "localRole": "Selected projection of JSON:API relationship self; workflowsUrl remains the related-resource URL." + }, + { + "outputField": "product.primaryRepositoriesRelationshipUrl", + "operationId": "apps_ciProduct_getToOneRelated", + "jsonPointer": "/data/relationships/primaryRepositories/links/self", + "localRole": "Selected projection of JSON:API relationship self; primaryRepositoriesUrl remains the related-resource URL." + }, + { + "outputField": "product.additionalRepositoriesRelationshipUrl", + "operationId": "apps_ciProduct_getToOneRelated", + "jsonPointer": "/data/relationships/additionalRepositories/links/self", + "localRole": "Selected projection of JSON:API relationship self; additionalRepositoriesUrl remains the related-resource URL." + }, + { + "outputField": "product.buildRunsRelationshipUrl", + "operationId": "apps_ciProduct_getToOneRelated", + "jsonPointer": "/data/relationships/buildRuns/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildRunsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "apps_ciProduct_getToOneRelated", + "jsonPointer": "/included" + }, + { + "outputField": "self_url", + "operationId": "apps_ciProduct_getToOneRelated", + "jsonPointer": "/links/self" + } ] }, "note": "Exact related-resource GET with validated product identity, include lineage, and dependent primary-repository cardinality. Sparse fields follow the global family policy. The tool has no MCP output schema and returns a selected product projection that keeps links.related as *Url and links.self as *RelationshipUrl." @@ -988,22 +2582,73 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciBuildActions_buildRun_getToOneRelated", "method": "get", "path": "/v1/ciBuildActions/{id}/buildRun", "role": "primary" } + { + "operationId": "ciBuildActions_buildRun_getToOneRelated", + "method": "get", + "path": "/v1/ciBuildActions/{id}/buildRun", + "role": "primary" + } ], "fields": [ - { "toolField": "action_id", "sourceKind": "parameter", "operationId": "ciBuildActions_buildRun_getToOneRelated", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciBuildActions_buildRun_getToOneRelated", "location": "query", "appleName": "include" }, - { "toolField": "builds_limit", "sourceKind": "parameter", "operationId": "ciBuildActions_buildRun_getToOneRelated", "location": "query", "appleName": "limit[builds]" } + { + "toolField": "action_id", + "sourceKind": "parameter", + "operationId": "ciBuildActions_buildRun_getToOneRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciBuildActions_buildRun_getToOneRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "builds_limit", + "sourceKind": "parameter", + "operationId": "ciBuildActions_buildRun_getToOneRelated", + "location": "query", + "appleName": "limit[builds]" + } ], "response": { "mode": "projection", - "sources": [{ "operationId": "ciBuildActions_buildRun_getToOneRelated", "statusCode": "200", "mediaType": "application/json" }], + "sources": [ + { + "operationId": "ciBuildActions_buildRun_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], "fields": [ - { "outputField": "buildRun", "operationId": "ciBuildActions_buildRun_getToOneRelated", "jsonPointer": "/data" }, - { "outputField": "buildRun.buildsRelationshipUrl", "operationId": "ciBuildActions_buildRun_getToOneRelated", "jsonPointer": "/data/relationships/builds/links/self", "localRole": "Selected projection of JSON:API relationship self; buildsUrl remains the related-resource URL." }, - { "outputField": "buildRun.actionsRelationshipUrl", "operationId": "ciBuildActions_buildRun_getToOneRelated", "jsonPointer": "/data/relationships/actions/links/self", "localRole": "Selected projection of JSON:API relationship self; actionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciBuildActions_buildRun_getToOneRelated", "jsonPointer": "/included" }, - { "outputField": "self_url", "operationId": "ciBuildActions_buildRun_getToOneRelated", "jsonPointer": "/links/self" } + { + "outputField": "buildRun", + "operationId": "ciBuildActions_buildRun_getToOneRelated", + "jsonPointer": "/data" + }, + { + "outputField": "buildRun.buildsRelationshipUrl", + "operationId": "ciBuildActions_buildRun_getToOneRelated", + "jsonPointer": "/data/relationships/builds/links/self", + "localRole": "Selected projection of JSON:API relationship self; buildsUrl remains the related-resource URL." + }, + { + "outputField": "buildRun.actionsRelationshipUrl", + "operationId": "ciBuildActions_buildRun_getToOneRelated", + "jsonPointer": "/data/relationships/actions/links/self", + "localRole": "Selected projection of JSON:API relationship self; actionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciBuildActions_buildRun_getToOneRelated", + "jsonPointer": "/included" + }, + { + "outputField": "self_url", + "operationId": "ciBuildActions_buildRun_getToOneRelated", + "jsonPointer": "/links/self" + } ] }, "note": "Exact related-resource GET with validated build-run identity, include lineage, and dependent build cardinality. Sparse fields follow the global family policy. The tool has no MCP output schema and returns a selected build-run projection that keeps links.related as *Url and links.self as *RelationshipUrl." @@ -1015,24 +2660,84 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "method": "get", "path": "/v1/ciMacOsVersions/{id}/xcodeVersions", "role": "primary" } + { + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "method": "get", + "path": "/v1/ciMacOsVersions/{id}/xcodeVersions", + "role": "primary" + } ], "fields": [ - { "toolField": "macos_version_id", "sourceKind": "parameter", "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "macos_versions_limit", "sourceKind": "parameter", "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "location": "query", "appleName": "limit[macOsVersions]" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict continuation for the original parent, include, limits, and configured App Store Connect origin." } + { + "toolField": "macos_version_id", + "sourceKind": "parameter", + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "macos_versions_limit", + "sourceKind": "parameter", + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "location": "query", + "appleName": "limit[macOsVersions]" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict continuation for the original parent, include, limits, and configured App Store Connect origin." + } ], "response": { "mode": "projection", - "sources": [{ "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }], + "sources": [ + { + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], "fields": [ - { "outputField": "xcodeVersions", "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "xcodeVersions.*.macOSVersionsRelationshipUrl", "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "jsonPointer": "/data/*/relationships/macOsVersions/links/self", "localRole": "Selected projection of JSON:API relationship self; macOSVersionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "xcodeVersions", + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "xcodeVersions.*.macOSVersionsRelationshipUrl", + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "jsonPointer": "/data/*/relationships/macOsVersions/links/self", + "localRole": "Selected projection of JSON:API relationship self; macOSVersionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact paginated related-resource collection; macos_versions_limit is accepted only with include=macOsVersions. Sparse fields follow the global family policy. The tool has no MCP output schema and its selected projections keep macOSVersionsUrl from links.related and macOSVersionsRelationshipUrl from links.self." @@ -1044,25 +2749,90 @@ "effect": "read", "implementationState": "asBuilt", "operations": [ - { "operationId": "ciProducts_additionalRepositories_getToManyRelated", "method": "get", "path": "/v1/ciProducts/{id}/additionalRepositories", "role": "primary" } + { + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "method": "get", + "path": "/v1/ciProducts/{id}/additionalRepositories", + "role": "primary" + } ], "fields": [ - { "toolField": "product_id", "sourceKind": "parameter", "operationId": "ciProducts_additionalRepositories_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "repository_id", "sourceKind": "parameter", "operationId": "ciProducts_additionalRepositories_getToManyRelated", "location": "query", "appleName": "filter[id]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciProducts_additionalRepositories_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciProducts_additionalRepositories_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict continuation for the original parent, filter, include, limit, and configured App Store Connect origin." } + { + "toolField": "product_id", + "sourceKind": "parameter", + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "repository_id", + "sourceKind": "parameter", + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict continuation for the original parent, filter, include, limit, and configured App Store Connect origin." + } ], "response": { "mode": "projection", - "sources": [{ "operationId": "ciProducts_additionalRepositories_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }], + "sources": [ + { + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], "fields": [ - { "outputField": "repositories", "operationId": "ciProducts_additionalRepositories_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "repositories.*.gitReferencesRelationshipUrl", "operationId": "ciProducts_additionalRepositories_getToManyRelated", "jsonPointer": "/data/*/relationships/gitReferences/links/self", "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." }, - { "outputField": "repositories.*.pullRequestsRelationshipUrl", "operationId": "ciProducts_additionalRepositories_getToManyRelated", "jsonPointer": "/data/*/relationships/pullRequests/links/self", "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciProducts_additionalRepositories_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciProducts_additionalRepositories_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciProducts_additionalRepositories_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "repositories", + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "repositories.*.gitReferencesRelationshipUrl", + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "jsonPointer": "/data/*/relationships/gitReferences/links/self", + "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." + }, + { + "outputField": "repositories.*.pullRequestsRelationshipUrl", + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "jsonPointer": "/data/*/relationships/pullRequests/links/self", + "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact paginated related-resource collection with ID filtering and validated included SCM provider/default-branch lineage. Sparse fields follow the global family policy. The tool has no MCP output schema and returns selected repository projections that keep links.related as *Url and links.self as *RelationshipUrl." @@ -1080,122 +2850,434 @@ "path": "/v1/ciProducts/{id}/app", "role": "primary", "optionalParameterClassifications": [ - { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "This tool is a compact product-to-app membership projection; apps_get_details, apps_get_metadata, and domain-specific app tools replace the very large transitive app include graph.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appEncryptionDeclarations]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include appEncryptionDeclarations; use the existing app and export-compliance tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaGroups]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include betaGroups; use the existing beta group tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersions]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include appStoreVersions; use apps_list_versions and version tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[preReleaseVersions]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include preReleaseVersions; use the existing pre-release tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[betaAppLocalizations]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include betaAppLocalizations; use the existing beta app tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include builds; use the existing build tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appInfos]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include appInfos; use the existing app info tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appClips]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include appClips; this unrelated graph is outside the membership lookup.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[inAppPurchases]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include inAppPurchases; use the existing IAP tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[subscriptionGroups]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include subscriptionGroups; use the existing subscription tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[gameCenterEnabledVersions]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include gameCenterEnabledVersions; this unrelated graph is outside the membership lookup.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appCustomProductPages]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include appCustomProductPages; use the existing custom page tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[inAppPurchasesV2]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include inAppPurchasesV2; use the existing IAP tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[promotedPurchases]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include promotedPurchases; use the existing promoted purchase tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appEvents]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include appEvents; use the existing app event tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[reviewSubmissions]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include reviewSubmissions; use the existing review submission tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[appStoreVersionExperimentsV2]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include appStoreVersionExperimentsV2; use the existing product page optimization tools.", "reviewAtSpec": "4.5.1" }, - { "location": "query", "appleName": "limit[androidToIosAppMappingDetails]", "disposition": "intentionallyOmitted", "reason": "The compact membership projection does not include androidToIosAppMappingDetails; this unrelated graph is outside the membership lookup.", "reviewAtSpec": "4.5.1" } - ] - } - ], - "fields": [ - { "toolField": "product_id", "sourceKind": "parameter", "operationId": "ciProducts_app_getToOneRelated", "location": "path", "appleName": "id" } - ], - "response": { - "mode": "projection", - "sources": [{ "operationId": "ciProducts_app_getToOneRelated", "statusCode": "200", "mediaType": "application/json" }], - "fields": [ - { "outputField": "app", "operationId": "ciProducts_app_getToOneRelated", "jsonPointer": "/data", "localRole": "Compact identity and membership projection containing id, type, selected app attributes, and optional canonical resource URL." }, - { "outputField": "self_url", "operationId": "ciProducts_app_getToOneRelated", "jsonPointer": "/links/self" } - ] - }, - "note": "This endpoint proves the product-to-app membership and returns a compact app projection. The enormous optional include graph and its nested limits are intentionally delegated to existing typed app/domain tools; sparse fields follow the global family policy." - }, - { - "tool": "xcode_cloud_product_primary_repositories_list", - "kind": "direct", - "status": "partial", - "effect": "read", - "implementationState": "asBuilt", - "operations": [ - { "operationId": "ciProducts_primaryRepositories_getToManyRelated", "method": "get", "path": "/v1/ciProducts/{id}/primaryRepositories", "role": "primary" } - ], - "fields": [ - { "toolField": "product_id", "sourceKind": "parameter", "operationId": "ciProducts_primaryRepositories_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "repository_id", "sourceKind": "parameter", "operationId": "ciProducts_primaryRepositories_getToManyRelated", "location": "query", "appleName": "filter[id]" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciProducts_primaryRepositories_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciProducts_primaryRepositories_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict continuation for the original parent, filter, include, limit, and configured App Store Connect origin." } - ], - "response": { - "mode": "projection", - "sources": [{ "operationId": "ciProducts_primaryRepositories_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }], - "fields": [ - { "outputField": "repositories", "operationId": "ciProducts_primaryRepositories_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "repositories.*.gitReferencesRelationshipUrl", "operationId": "ciProducts_primaryRepositories_getToManyRelated", "jsonPointer": "/data/*/relationships/gitReferences/links/self", "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." }, - { "outputField": "repositories.*.pullRequestsRelationshipUrl", "operationId": "ciProducts_primaryRepositories_getToManyRelated", "jsonPointer": "/data/*/relationships/pullRequests/links/self", "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciProducts_primaryRepositories_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciProducts_primaryRepositories_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciProducts_primaryRepositories_getToManyRelated", "jsonPointer": "/meta/paging/total" } - ] - }, - "note": "Exact paginated related-resource collection with ID filtering and validated included SCM provider/default-branch lineage. Sparse fields follow the global family policy. The tool has no MCP output schema and returns selected repository projections that keep links.related as *Url and links.self as *RelationshipUrl." - }, - { - "tool": "xcode_cloud_workflow_repository_get", - "kind": "direct", - "status": "partial", - "effect": "read", - "implementationState": "asBuilt", - "operations": [ - { "operationId": "ciWorkflows_repository_getToOneRelated", "method": "get", "path": "/v1/ciWorkflows/{id}/repository", "role": "primary" } - ], - "fields": [ - { "toolField": "workflow_id", "sourceKind": "parameter", "operationId": "ciWorkflows_repository_getToOneRelated", "location": "path", "appleName": "id" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciWorkflows_repository_getToOneRelated", "location": "query", "appleName": "include" } - ], - "response": { - "mode": "projection", - "sources": [{ "operationId": "ciWorkflows_repository_getToOneRelated", "statusCode": "200", "mediaType": "application/json" }], - "fields": [ - { "outputField": "repository", "operationId": "ciWorkflows_repository_getToOneRelated", "jsonPointer": "/data" }, - { "outputField": "repository.gitReferencesRelationshipUrl", "operationId": "ciWorkflows_repository_getToOneRelated", "jsonPointer": "/data/relationships/gitReferences/links/self", "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." }, - { "outputField": "repository.pullRequestsRelationshipUrl", "operationId": "ciWorkflows_repository_getToOneRelated", "jsonPointer": "/data/relationships/pullRequests/links/self", "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciWorkflows_repository_getToOneRelated", "jsonPointer": "/included" }, - { "outputField": "self_url", "operationId": "ciWorkflows_repository_getToOneRelated", "jsonPointer": "/links/self" } - ] - }, - "note": "Exact related-resource GET with canonical repository identity and validated SCM provider/default-branch include lineage. Sparse fields follow the global family policy. The tool has no MCP output schema and returns a selected repository projection that keeps links.related as *Url and links.self as *RelationshipUrl." - }, - { - "tool": "xcode_cloud_xcode_version_macos_versions_list", - "kind": "direct", - "status": "partial", - "effect": "read", - "implementationState": "asBuilt", - "operations": [ - { "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "method": "get", "path": "/v1/ciXcodeVersions/{id}/macOsVersions", "role": "primary" } - ], - "fields": [ - { "toolField": "xcode_version_id", "sourceKind": "parameter", "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "limit", "sourceKind": "parameter", "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "location": "query", "appleName": "limit" }, - { "toolField": "include", "sourceKind": "parameter", "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "location": "query", "appleName": "include" }, - { "toolField": "xcode_versions_limit", "sourceKind": "parameter", "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "location": "query", "appleName": "limit[xcodeVersions]" }, - { "toolField": "next_url", "sourceKind": "local", "localRole": "Strict continuation for the original parent, include, limits, and configured App Store Connect origin." } - ], + { + "location": "query", + "appleName": "include", + "disposition": "intentionallyOmitted", + "reason": "This tool is a compact product-to-app membership projection; apps_get_details, apps_get_metadata, and domain-specific app tools replace the very large transitive app include graph.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEncryptionDeclarations]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include appEncryptionDeclarations; use the existing app and export-compliance tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaGroups]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include betaGroups; use the existing beta group tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersions]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include appStoreVersions; use apps_list_versions and version tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[preReleaseVersions]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include preReleaseVersions; use the existing pre-release tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[betaAppLocalizations]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include betaAppLocalizations; use the existing beta app tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[builds]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include builds; use the existing build tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appInfos]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include appInfos; use the existing app info tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appClips]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include appClips; this unrelated graph is outside the membership lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[inAppPurchases]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include inAppPurchases; use the existing IAP tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[subscriptionGroups]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include subscriptionGroups; use the existing subscription tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[gameCenterEnabledVersions]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include gameCenterEnabledVersions; this unrelated graph is outside the membership lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appCustomProductPages]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include appCustomProductPages; use the existing custom page tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[inAppPurchasesV2]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include inAppPurchasesV2; use the existing IAP tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[promotedPurchases]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include promotedPurchases; use the existing promoted purchase tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appEvents]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include appEvents; use the existing app event tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[reviewSubmissions]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include reviewSubmissions; use the existing review submission tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[appStoreVersionExperimentsV2]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include appStoreVersionExperimentsV2; use the existing product page optimization tools.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[androidToIosAppMappingDetails]", + "disposition": "intentionallyOmitted", + "reason": "The compact membership projection does not include androidToIosAppMappingDetails; this unrelated graph is outside the membership lookup.", + "reviewAtSpec": "4.6" + }, + { + "location": "query", + "appleName": "limit[retentionMessages]", + "disposition": "intentionallyOmitted", + "reason": "Retention messages are read through the dedicated app-scoped subscriptions_list_retention_messages tool.", + "reviewAtSpec": "4.6" + } + ] + } + ], + "fields": [ + { + "toolField": "product_id", + "sourceKind": "parameter", + "operationId": "ciProducts_app_getToOneRelated", + "location": "path", + "appleName": "id" + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "ciProducts_app_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "app", + "operationId": "ciProducts_app_getToOneRelated", + "jsonPointer": "/data", + "localRole": "Compact identity and membership projection containing id, type, selected app attributes, and optional canonical resource URL." + }, + { + "outputField": "self_url", + "operationId": "ciProducts_app_getToOneRelated", + "jsonPointer": "/links/self" + } + ] + }, + "note": "This endpoint proves the product-to-app membership and returns a compact app projection. The enormous optional include graph and its nested limits are intentionally delegated to existing typed app/domain tools; sparse fields follow the global family policy." + }, + { + "tool": "xcode_cloud_product_primary_repositories_list", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "method": "get", + "path": "/v1/ciProducts/{id}/primaryRepositories", + "role": "primary" + } + ], + "fields": [ + { + "toolField": "product_id", + "sourceKind": "parameter", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "repository_id", + "sourceKind": "parameter", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "location": "query", + "appleName": "filter[id]" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict continuation for the original parent, filter, include, limit, and configured App Store Connect origin." + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "repositories", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "repositories.*.gitReferencesRelationshipUrl", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "jsonPointer": "/data/*/relationships/gitReferences/links/self", + "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." + }, + { + "outputField": "repositories.*.pullRequestsRelationshipUrl", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "jsonPointer": "/data/*/relationships/pullRequests/links/self", + "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } + ] + }, + "note": "Exact paginated related-resource collection with ID filtering and validated included SCM provider/default-branch lineage. Sparse fields follow the global family policy. The tool has no MCP output schema and returns selected repository projections that keep links.related as *Url and links.self as *RelationshipUrl." + }, + { + "tool": "xcode_cloud_workflow_repository_get", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "ciWorkflows_repository_getToOneRelated", + "method": "get", + "path": "/v1/ciWorkflows/{id}/repository", + "role": "primary" + } + ], + "fields": [ + { + "toolField": "workflow_id", + "sourceKind": "parameter", + "operationId": "ciWorkflows_repository_getToOneRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciWorkflows_repository_getToOneRelated", + "location": "query", + "appleName": "include" + } + ], "response": { "mode": "projection", - "sources": [{ "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }], + "sources": [ + { + "operationId": "ciWorkflows_repository_getToOneRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], "fields": [ - { "outputField": "macOSVersions", "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "jsonPointer": "/data" }, - { "outputField": "macOSVersions.*.xcodeVersionsRelationshipUrl", "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "jsonPointer": "/data/*/relationships/xcodeVersions/links/self", "localRole": "Selected projection of JSON:API relationship self; xcodeVersionsUrl remains the related-resource URL." }, - { "outputField": "included", "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "jsonPointer": "/included" }, - { "outputField": "next_url", "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "jsonPointer": "/links/next" }, - { "outputField": "total", "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "jsonPointer": "/meta/paging/total" } + { + "outputField": "repository", + "operationId": "ciWorkflows_repository_getToOneRelated", + "jsonPointer": "/data" + }, + { + "outputField": "repository.gitReferencesRelationshipUrl", + "operationId": "ciWorkflows_repository_getToOneRelated", + "jsonPointer": "/data/relationships/gitReferences/links/self", + "localRole": "Selected projection of JSON:API relationship self; gitReferencesUrl remains the related-resource URL." + }, + { + "outputField": "repository.pullRequestsRelationshipUrl", + "operationId": "ciWorkflows_repository_getToOneRelated", + "jsonPointer": "/data/relationships/pullRequests/links/self", + "localRole": "Selected projection of JSON:API relationship self; pullRequestsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciWorkflows_repository_getToOneRelated", + "jsonPointer": "/included" + }, + { + "outputField": "self_url", + "operationId": "ciWorkflows_repository_getToOneRelated", + "jsonPointer": "/links/self" + } + ] + }, + "note": "Exact related-resource GET with canonical repository identity and validated SCM provider/default-branch include lineage. Sparse fields follow the global family policy. The tool has no MCP output schema and returns a selected repository projection that keeps links.related as *Url and links.self as *RelationshipUrl." + }, + { + "tool": "xcode_cloud_xcode_version_macos_versions_list", + "kind": "direct", + "status": "partial", + "effect": "read", + "implementationState": "asBuilt", + "operations": [ + { + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "method": "get", + "path": "/v1/ciXcodeVersions/{id}/macOsVersions", + "role": "primary" + } + ], + "fields": [ + { + "toolField": "xcode_version_id", + "sourceKind": "parameter", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "limit", + "sourceKind": "parameter", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "location": "query", + "appleName": "limit" + }, + { + "toolField": "include", + "sourceKind": "parameter", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "location": "query", + "appleName": "include" + }, + { + "toolField": "xcode_versions_limit", + "sourceKind": "parameter", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "location": "query", + "appleName": "limit[xcodeVersions]" + }, + { + "toolField": "next_url", + "sourceKind": "local", + "localRole": "Strict continuation for the original parent, include, limits, and configured App Store Connect origin." + } + ], + "response": { + "mode": "projection", + "sources": [ + { + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + } + ], + "fields": [ + { + "outputField": "macOSVersions", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "jsonPointer": "/data" + }, + { + "outputField": "macOSVersions.*.xcodeVersionsRelationshipUrl", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "jsonPointer": "/data/*/relationships/xcodeVersions/links/self", + "localRole": "Selected projection of JSON:API relationship self; xcodeVersionsUrl remains the related-resource URL." + }, + { + "outputField": "included", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "jsonPointer": "/included" + }, + { + "outputField": "next_url", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "jsonPointer": "/links/next" + }, + { + "outputField": "total", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "jsonPointer": "/meta/paging/total" + } ] }, "note": "Exact paginated related-resource collection; xcode_versions_limit is accepted only with include=xcodeVersions. Sparse fields follow the global family policy. The tool has no MCP output schema and its selected projections keep xcodeVersionsUrl from links.related and xcodeVersionsRelationshipUrl from links.self." @@ -1219,14 +3301,14 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Deletion preflight validates only the exact product identity and current name; it inventories workflows and build runs through dedicated fully paginated supporting operations.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[primaryRepositories]", "disposition": "intentionallyOmitted", "reason": "Primary repositories are not included by the exact deletion identity preflight.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -1237,8 +3319,20 @@ "role": "supporting", "condition": "Every call inventories all workflow identities across strict pagination before previewing or attempting deletion.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[ciWorkflows]", "fixedValue": ["name"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[ciWorkflows]", + "fixedValue": [ + "name" + ] + } ], "optionalParameterClassifications": [ { @@ -1246,7 +3340,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The deletion receipt needs the complete direct workflow identity inventory, not expanded workflow relationships.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -1257,8 +3351,20 @@ "role": "supporting", "condition": "Every call inventories all build-run identities across strict pagination before previewing or attempting deletion.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[ciBuildRuns]", "fixedValue": ["number"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[ciBuildRuns]", + "fixedValue": [ + "number" + ] + } ], "optionalParameterClassifications": [ { @@ -1266,62 +3372,153 @@ "appleName": "filter[builds]", "disposition": "intentionallyOmitted", "reason": "Deletion impact must inventory every build run for the product rather than a caller-selected build subset.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "The confirmation digest sorts validated identities locally, so Apple response ordering cannot affect the receipt.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The deletion receipt needs the complete direct build-run identity inventory, not expanded relationships.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Build resources are not included by the deletion inventory request.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, - { "operationId": "ciProducts_deleteInstance", "method": "delete", "path": "/v1/ciProducts/{id}", "role": "primary" } + { + "operationId": "ciProducts_deleteInstance", + "method": "delete", + "path": "/v1/ciProducts/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "product_id", "sourceKind": "parameter", "operationId": "ciProducts_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "product_id", "sourceKind": "parameter", "operationId": "ciProducts_workflows_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "product_id", "sourceKind": "parameter", "operationId": "ciProducts_buildRuns_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "product_id", "sourceKind": "parameter", "operationId": "ciProducts_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_permanent_deletion", "sourceKind": "local", "localRole": "Must be true together with every fresh preview receipt before DELETE is attempted." }, - { "toolField": "confirmation_receipt", "sourceKind": "local", "localRole": "Must match the checksum-bound receipt over the latest product identity/name plus the exact sorted workflow-ID and build-run-ID inventories." }, - { "toolField": "expected_product_name", "sourceKind": "local", "localRole": "Must exactly match the latest preflight product name." }, - { "toolField": "expected_workflow_count", "sourceKind": "local", "localRole": "Must exactly match the fully paginated latest workflow count." }, - { "toolField": "expected_build_run_count", "sourceKind": "local", "localRole": "Must exactly match the fully paginated latest build-run count." } + { + "toolField": "product_id", + "sourceKind": "parameter", + "operationId": "ciProducts_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "product_id", + "sourceKind": "parameter", + "operationId": "ciProducts_workflows_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "product_id", + "sourceKind": "parameter", + "operationId": "ciProducts_buildRuns_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "product_id", + "sourceKind": "parameter", + "operationId": "ciProducts_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_permanent_deletion", + "sourceKind": "local", + "localRole": "Must be true together with every fresh preview receipt before DELETE is attempted." + }, + { + "toolField": "confirmation_receipt", + "sourceKind": "local", + "localRole": "Must match the checksum-bound receipt over the latest product identity/name plus the exact sorted workflow-ID and build-run-ID inventories." + }, + { + "toolField": "expected_product_name", + "sourceKind": "local", + "localRole": "Must exactly match the latest preflight product name." + }, + { + "toolField": "expected_workflow_count", + "sourceKind": "local", + "localRole": "Must exactly match the fully paginated latest workflow count." + }, + { + "toolField": "expected_build_run_count", + "sourceKind": "local", + "localRole": "Must exactly match the fully paginated latest build-run count." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "ciProducts_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "ciProducts_workflows_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "ciProducts_buildRuns_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "ciProducts_deleteInstance", "statusCode": "204" } + { + "operationId": "ciProducts_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "ciProducts_workflows_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "ciProducts_buildRuns_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "ciProducts_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "previewOnly", "localRole": "True when the call performs fresh read-only product and cardinality preflight without sending DELETE." }, - { "outputField": "confirmation", "localRole": "Fresh checksum-bound receipt over the exact sorted workflow/build-run identity inventories, plus the exact product name and public impact counts." }, - { "outputField": "success", "localRole": "True for a preview or an exact empty HTTP 204 deletion response; mutation fields distinguish the two states." }, - { "outputField": "deleted", "localRole": "True only after Apple's exact empty HTTP 204 response." }, - { "outputField": "operationCommitState", "localRole": "committed only for exact empty 204; not_attempted, rejected, unknown, or committed_unverified otherwise." }, - { "outputField": "inspectionRequired", "localRole": "True for unknown or committed_unverified outcomes." }, - { "outputField": "inspection", "localRole": "Executable xcode_cloud_products_get exact-target inspection before any retry." }, - { "outputField": "retrySafe", "localRole": "False for every attempted deletion, including unknown and committed_unverified outcomes." }, - { "outputField": "statusCode", "localRole": "Exact verified 204 status on committed deletion." } + { + "outputField": "previewOnly", + "localRole": "True when the call performs fresh read-only product and cardinality preflight without sending DELETE." + }, + { + "outputField": "confirmation", + "localRole": "Fresh checksum-bound receipt over the exact sorted workflow/build-run identity inventories, plus the exact product name and public impact counts." + }, + { + "outputField": "success", + "localRole": "True for a preview or an exact empty HTTP 204 deletion response; mutation fields distinguish the two states." + }, + { + "outputField": "deleted", + "localRole": "True only after Apple's exact empty HTTP 204 response." + }, + { + "outputField": "operationCommitState", + "localRole": "committed only for exact empty 204; not_attempted, rejected, unknown, or committed_unverified otherwise." + }, + { + "outputField": "inspectionRequired", + "localRole": "True for unknown or committed_unverified outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable xcode_cloud_products_get exact-target inspection before any retry." + }, + { + "outputField": "retrySafe", + "localRole": "False for every attempted deletion, including unknown and committed_unverified outcomes." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 204 status on committed deletion." + } ] }, "note": "Permanent deletion is a two-step safety contract: every call refreshes exact identity and fully paginates workflow and build-run inventories with fixed limit=200 sparse requests. The receipt hashes the canonical product identity/name and exact sorted length-delimited workflow/build-run IDs, while the caller must also echo the public name/count confirmations. Exact empty 204 is the only committed success. Ambiguous or malformed accepted outcomes preserve product_id and xcode_cloud_products_get recovery guidance and are never replayed automatically." @@ -1339,48 +3536,208 @@ "path": "/v1/ciWorkflows", "role": "primary", "inputs": [ - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "ciWorkflows" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/product/data/type", "fixedValue": "ciProducts" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/repository/data/type", "fixedValue": "scmRepositories" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/xcodeVersion/data/type", "fixedValue": "ciXcodeVersions" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/macOsVersion/data/type", "fixedValue": "ciMacOsVersions" } + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "ciWorkflows" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/product/data/type", + "fixedValue": "ciProducts" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/repository/data/type", + "fixedValue": "scmRepositories" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/xcodeVersion/data/type", + "fixedValue": "ciXcodeVersions" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/macOsVersion/data/type", + "fixedValue": "ciMacOsVersions" + } ] } ], "fields": [ - { "toolField": "name", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/name" }, - { "toolField": "description", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/description" }, - { "toolField": "branch_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/branchStartCondition", "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." }, - { "toolField": "tag_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/tagStartCondition", "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." }, - { "toolField": "pull_request_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/pullRequestStartCondition", "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." }, - { "toolField": "scheduled_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/scheduledStartCondition", "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." }, - { "toolField": "manual_branch_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/manualBranchStartCondition", "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." }, - { "toolField": "manual_tag_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/manualTagStartCondition", "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." }, - { "toolField": "manual_pull_request_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/manualPullRequestStartCondition", "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." }, - { "toolField": "actions", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/actions" }, - { "toolField": "is_enabled", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/isEnabled" }, - { "toolField": "is_locked_for_editing", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/isLockedForEditing", "localRole": "Preserves explicit JSON null distinctly from omission." }, - { "toolField": "clean", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/clean" }, - { "toolField": "container_file_path", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/attributes/containerFilePath" }, - { "toolField": "product_id", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/relationships/product/data/id" }, - { "toolField": "repository_id", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/relationships/repository/data/id" }, - { "toolField": "xcode_version_id", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/relationships/xcodeVersion/data/id" }, - { "toolField": "macos_version_id", "sourceKind": "requestBody", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data/relationships/macOsVersion/data/id" } + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/name" + }, + { + "toolField": "description", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/description" + }, + { + "toolField": "branch_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/branchStartCondition", + "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." + }, + { + "toolField": "tag_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/tagStartCondition", + "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." + }, + { + "toolField": "pull_request_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/pullRequestStartCondition", + "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." + }, + { + "toolField": "scheduled_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/scheduledStartCondition", + "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." + }, + { + "toolField": "manual_branch_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/manualBranchStartCondition", + "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." + }, + { + "toolField": "manual_tag_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/manualTagStartCondition", + "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." + }, + { + "toolField": "manual_pull_request_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/manualPullRequestStartCondition", + "localRole": "Preserves explicit JSON null distinctly from omission for Apple's nullable optional condition." + }, + { + "toolField": "actions", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/actions" + }, + { + "toolField": "is_enabled", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/isEnabled" + }, + { + "toolField": "is_locked_for_editing", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/isLockedForEditing", + "localRole": "Preserves explicit JSON null distinctly from omission." + }, + { + "toolField": "clean", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/clean" + }, + { + "toolField": "container_file_path", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/attributes/containerFilePath" + }, + { + "toolField": "product_id", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/relationships/product/data/id" + }, + { + "toolField": "repository_id", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/relationships/repository/data/id" + }, + { + "toolField": "xcode_version_id", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/relationships/xcodeVersion/data/id" + }, + { + "toolField": "macos_version_id", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data/relationships/macOsVersion/data/id" + } ], "response": { "mode": "projection", - "sources": [{ "operationId": "ciWorkflows_createInstance", "statusCode": "201", "mediaType": "application/json" }], + "sources": [ + { + "operationId": "ciWorkflows_createInstance", + "statusCode": "201", + "mediaType": "application/json" + } + ], "fields": [ - { "outputField": "workflow", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/data", "localRole": "Returned only after exact 201, canonical workflow identity, canonical links, and exact requested relationship lineage validation." }, - { "outputField": "self_url", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/links/self", "localRole": "Validated canonical document self URL for the created workflow." }, - { "outputField": "included", "operationId": "ciWorkflows_createInstance", "jsonPointer": "/included", "localRole": "Preserved when present, including an empty array, only after typed identity, duplicate, relationship, and link validation." }, - { "outputField": "operationCommitState", "localRole": "committed for a validated 201, rejected for a definitive rejection, unknown for request ambiguity, or committed_unverified for an invalid accepted response." }, - { "outputField": "operationCommitted", "localRole": "True only for committed or committed_unverified; null for unknown." }, - { "outputField": "inspectionRequired", "localRole": "True for unknown or committed_unverified outcomes." }, - { "outputField": "inspection", "localRole": "Executable xcode_cloud_product_workflows_list guidance scoped to the requested product; observed membership does not by itself attribute an ambiguous create." }, - { "outputField": "identifiers", "localRole": "Validated requested product and repository relationship identifiers retained for recovery." }, - { "outputField": "retrySafe", "localRole": "False for every mutation outcome; inspect before any retry." }, - { "outputField": "statusCode", "localRole": "Exact verified 201 status." } + { + "outputField": "workflow", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/data", + "localRole": "Returned only after exact 201, canonical workflow identity, canonical links, and exact requested relationship lineage validation." + }, + { + "outputField": "self_url", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/links/self", + "localRole": "Validated canonical document self URL for the created workflow." + }, + { + "outputField": "included", + "operationId": "ciWorkflows_createInstance", + "jsonPointer": "/included", + "localRole": "Preserved when present, including an empty array, only after typed identity, duplicate, relationship, and link validation." + }, + { + "outputField": "operationCommitState", + "localRole": "committed for a validated 201, rejected for a definitive rejection, unknown for request ambiguity, or committed_unverified for an invalid accepted response." + }, + { + "outputField": "operationCommitted", + "localRole": "True only for committed or committed_unverified; null for unknown." + }, + { + "outputField": "inspectionRequired", + "localRole": "True for unknown or committed_unverified outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable xcode_cloud_product_workflows_list guidance scoped to the requested product; observed membership does not by itself attribute an ambiguous create." + }, + { + "outputField": "identifiers", + "localRole": "Validated requested product and repository relationship identifiers retained for recovery." + }, + { + "outputField": "retrySafe", + "localRole": "False for every mutation outcome; inspect before any retry." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 201 status." + } ] }, "note": "Complete Apple 4.4.1 workflow-create body, including every start-condition/action attribute and required relationship. Nullable optional create attributes preserve omission versus explicit null. Success requires exact 201 plus canonical identity, document self_url, resource links, requested relationship lineage, and strict validation of Apple's optional included resource union; valid included presence is preserved exactly. Ambiguous or malformed accepted outcomes fail closed with product-scoped inspection and no automatic replay." @@ -1398,46 +3755,209 @@ "path": "/v1/ciWorkflows/{id}", "role": "primary", "inputs": [ - { "sourceKind": "derived", "jsonPointer": "/data/id", "derivedFrom": ["workflow_id"], "localRole": "Copy the validated path identifier into the JSON:API resource body." }, - { "sourceKind": "fixed", "jsonPointer": "/data/type", "fixedValue": "ciWorkflows" }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/xcodeVersion/data/type", "fixedValue": "ciXcodeVersions", "localRole": "Present only with xcode_version_id." }, - { "sourceKind": "fixed", "jsonPointer": "/data/relationships/macOsVersion/data/type", "fixedValue": "ciMacOsVersions", "localRole": "Present only with macos_version_id." } + { + "sourceKind": "derived", + "jsonPointer": "/data/id", + "derivedFrom": [ + "workflow_id" + ], + "localRole": "Copy the validated path identifier into the JSON:API resource body." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/type", + "fixedValue": "ciWorkflows" + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/xcodeVersion/data/type", + "fixedValue": "ciXcodeVersions", + "localRole": "Present only with xcode_version_id." + }, + { + "sourceKind": "fixed", + "jsonPointer": "/data/relationships/macOsVersion/data/type", + "fixedValue": "ciMacOsVersions", + "localRole": "Present only with macos_version_id." + } ] } ], "fields": [ - { "toolField": "workflow_id", "sourceKind": "parameter", "operationId": "ciWorkflows_updateInstance", "location": "path", "appleName": "id" }, - { "toolField": "name", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/name", "localRole": "Preserves value, explicit JSON null, and omission as three distinct states." }, - { "toolField": "description", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/description", "localRole": "Preserves value, explicit JSON null, and omission as three distinct states." }, - { "toolField": "branch_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/branchStartCondition", "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." }, - { "toolField": "tag_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/tagStartCondition", "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." }, - { "toolField": "pull_request_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/pullRequestStartCondition", "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." }, - { "toolField": "scheduled_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/scheduledStartCondition", "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." }, - { "toolField": "manual_branch_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/manualBranchStartCondition", "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." }, - { "toolField": "manual_tag_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/manualTagStartCondition", "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." }, - { "toolField": "manual_pull_request_start_condition", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/manualPullRequestStartCondition", "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." }, - { "toolField": "actions", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/actions", "localRole": "Preserves array, explicit JSON null, and omission as three distinct states." }, - { "toolField": "is_enabled", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/isEnabled", "localRole": "Preserves Boolean, explicit JSON null, and omission as three distinct states." }, - { "toolField": "is_locked_for_editing", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/isLockedForEditing", "localRole": "Preserves Boolean, explicit JSON null, and omission as three distinct states." }, - { "toolField": "clean", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/clean", "localRole": "Preserves Boolean, explicit JSON null, and omission as three distinct states." }, - { "toolField": "container_file_path", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/attributes/containerFilePath", "localRole": "Preserves string, explicit JSON null, and omission as three distinct states." }, - { "toolField": "xcode_version_id", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/relationships/xcodeVersion/data/id" }, - { "toolField": "macos_version_id", "sourceKind": "requestBody", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data/relationships/macOsVersion/data/id" } + { + "toolField": "workflow_id", + "sourceKind": "parameter", + "operationId": "ciWorkflows_updateInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "name", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/name", + "localRole": "Preserves value, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "description", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/description", + "localRole": "Preserves value, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "branch_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/branchStartCondition", + "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "tag_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/tagStartCondition", + "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "pull_request_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/pullRequestStartCondition", + "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "scheduled_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/scheduledStartCondition", + "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "manual_branch_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/manualBranchStartCondition", + "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "manual_tag_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/manualTagStartCondition", + "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "manual_pull_request_start_condition", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/manualPullRequestStartCondition", + "localRole": "Preserves object, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "actions", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/actions", + "localRole": "Preserves array, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "is_enabled", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/isEnabled", + "localRole": "Preserves Boolean, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "is_locked_for_editing", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/isLockedForEditing", + "localRole": "Preserves Boolean, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "clean", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/clean", + "localRole": "Preserves Boolean, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "container_file_path", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/attributes/containerFilePath", + "localRole": "Preserves string, explicit JSON null, and omission as three distinct states." + }, + { + "toolField": "xcode_version_id", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/relationships/xcodeVersion/data/id" + }, + { + "toolField": "macos_version_id", + "sourceKind": "requestBody", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data/relationships/macOsVersion/data/id" + } ], "response": { "mode": "projection", - "sources": [{ "operationId": "ciWorkflows_updateInstance", "statusCode": "200", "mediaType": "application/json" }], + "sources": [ + { + "operationId": "ciWorkflows_updateInstance", + "statusCode": "200", + "mediaType": "application/json" + } + ], "fields": [ - { "outputField": "workflow", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/data", "localRole": "Returned only after exact 200, exact workflow identity/path, canonical links, and requested patch lineage validation." }, - { "outputField": "self_url", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/links/self", "localRole": "Validated canonical document self URL for the updated workflow." }, - { "outputField": "included", "operationId": "ciWorkflows_updateInstance", "jsonPointer": "/included", "localRole": "Preserved when present, including an empty array, only after typed identity, duplicate, relationship, and link validation." }, - { "outputField": "operationCommitState", "localRole": "committed for a validated 200, rejected for a definitive rejection, unknown for request ambiguity, or committed_unverified for an invalid accepted response." }, - { "outputField": "operationCommitted", "localRole": "True only for committed or committed_unverified; null for unknown." }, - { "outputField": "inspectionRequired", "localRole": "True for unknown or committed_unverified outcomes." }, - { "outputField": "inspection", "localRole": "Executable xcode_cloud_workflows_get exact-target inspection before any retry." }, - { "outputField": "identifiers", "localRole": "Validated workflow identifier retained for recovery." }, - { "outputField": "retrySafe", "localRole": "False for every attempted update; inspect before any retry." }, - { "outputField": "statusCode", "localRole": "Exact verified 200 status." } + { + "outputField": "workflow", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/data", + "localRole": "Returned only after exact 200, exact workflow identity/path, canonical links, and requested patch lineage validation." + }, + { + "outputField": "self_url", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/links/self", + "localRole": "Validated canonical document self URL for the updated workflow." + }, + { + "outputField": "included", + "operationId": "ciWorkflows_updateInstance", + "jsonPointer": "/included", + "localRole": "Preserved when present, including an empty array, only after typed identity, duplicate, relationship, and link validation." + }, + { + "outputField": "operationCommitState", + "localRole": "committed for a validated 200, rejected for a definitive rejection, unknown for request ambiguity, or committed_unverified for an invalid accepted response." + }, + { + "outputField": "operationCommitted", + "localRole": "True only for committed or committed_unverified; null for unknown." + }, + { + "outputField": "inspectionRequired", + "localRole": "True for unknown or committed_unverified outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable xcode_cloud_workflows_get exact-target inspection before any retry." + }, + { + "outputField": "identifiers", + "localRole": "Validated workflow identifier retained for recovery." + }, + { + "outputField": "retrySafe", + "localRole": "False for every attempted update; inspect before any retry." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 200 status." + } ] }, "note": "Complete mutable Apple 4.4.1 workflow PATCH contract. Every nullable attribute preserves value, explicit null, and omission independently; empty patches fail before network I/O. Exact 200 plus identity/path/request-lineage, document self_url, and strict optional included-union validation is required for committed success; valid included presence is preserved exactly. Ambiguous or malformed accepted outcomes fail closed with exact-target inspection." @@ -1461,7 +3981,7 @@ "appleName": "include", "disposition": "intentionallyOmitted", "reason": "Deletion preflight validates only the exact workflow identity and current name; it inventories build runs through the dedicated fully paginated supporting operation.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, @@ -1472,8 +3992,20 @@ "role": "supporting", "condition": "Every call inventories all build-run identities across strict pagination before previewing or attempting deletion.", "inputs": [ - { "sourceKind": "fixed", "location": "query", "appleName": "limit", "fixedValue": 200 }, - { "sourceKind": "fixed", "location": "query", "appleName": "fields[ciBuildRuns]", "fixedValue": ["number"] } + { + "sourceKind": "fixed", + "location": "query", + "appleName": "limit", + "fixedValue": 200 + }, + { + "sourceKind": "fixed", + "location": "query", + "appleName": "fields[ciBuildRuns]", + "fixedValue": [ + "number" + ] + } ], "optionalParameterClassifications": [ { @@ -1481,59 +4013,136 @@ "appleName": "filter[builds]", "disposition": "intentionallyOmitted", "reason": "Deletion impact must inventory every build run for the workflow rather than a caller-selected build subset.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "sort", "disposition": "intentionallyOmitted", "reason": "The confirmation digest sorts validated identities locally, so Apple response ordering cannot affect the receipt.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "include", "disposition": "intentionallyOmitted", "reason": "The deletion receipt needs the complete direct build-run identity inventory, not expanded relationships.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" }, { "location": "query", "appleName": "limit[builds]", "disposition": "intentionallyOmitted", "reason": "Build resources are not included by the deletion inventory request.", - "reviewAtSpec": "4.5.1" + "reviewAtSpec": "4.6" } ] }, - { "operationId": "ciWorkflows_deleteInstance", "method": "delete", "path": "/v1/ciWorkflows/{id}", "role": "primary" } + { + "operationId": "ciWorkflows_deleteInstance", + "method": "delete", + "path": "/v1/ciWorkflows/{id}", + "role": "primary" + } ], "fields": [ - { "toolField": "workflow_id", "sourceKind": "parameter", "operationId": "ciWorkflows_getInstance", "location": "path", "appleName": "id" }, - { "toolField": "workflow_id", "sourceKind": "parameter", "operationId": "ciWorkflows_buildRuns_getToManyRelated", "location": "path", "appleName": "id" }, - { "toolField": "workflow_id", "sourceKind": "parameter", "operationId": "ciWorkflows_deleteInstance", "location": "path", "appleName": "id" }, - { "toolField": "confirm_permanent_deletion", "sourceKind": "local", "localRole": "Must be true together with every fresh preview receipt before DELETE is attempted." }, - { "toolField": "confirmation_receipt", "sourceKind": "local", "localRole": "Must match the checksum-bound receipt over the latest workflow identity/name plus the exact sorted build-run-ID inventory." }, - { "toolField": "expected_workflow_name", "sourceKind": "local", "localRole": "Must exactly match the latest preflight workflow name." }, - { "toolField": "expected_build_run_count", "sourceKind": "local", "localRole": "Must exactly match the fully paginated latest build-run count." } + { + "toolField": "workflow_id", + "sourceKind": "parameter", + "operationId": "ciWorkflows_getInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "workflow_id", + "sourceKind": "parameter", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "location": "path", + "appleName": "id" + }, + { + "toolField": "workflow_id", + "sourceKind": "parameter", + "operationId": "ciWorkflows_deleteInstance", + "location": "path", + "appleName": "id" + }, + { + "toolField": "confirm_permanent_deletion", + "sourceKind": "local", + "localRole": "Must be true together with every fresh preview receipt before DELETE is attempted." + }, + { + "toolField": "confirmation_receipt", + "sourceKind": "local", + "localRole": "Must match the checksum-bound receipt over the latest workflow identity/name plus the exact sorted build-run-ID inventory." + }, + { + "toolField": "expected_workflow_name", + "sourceKind": "local", + "localRole": "Must exactly match the latest preflight workflow name." + }, + { + "toolField": "expected_build_run_count", + "sourceKind": "local", + "localRole": "Must exactly match the fully paginated latest build-run count." + } ], "response": { "mode": "local", "sources": [ - { "operationId": "ciWorkflows_getInstance", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "ciWorkflows_buildRuns_getToManyRelated", "statusCode": "200", "mediaType": "application/json" }, - { "operationId": "ciWorkflows_deleteInstance", "statusCode": "204" } + { + "operationId": "ciWorkflows_getInstance", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "statusCode": "200", + "mediaType": "application/json" + }, + { + "operationId": "ciWorkflows_deleteInstance", + "statusCode": "204" + } ], "fields": [ - { "outputField": "previewOnly", "localRole": "True when the call performs fresh read-only workflow and cardinality preflight without sending DELETE." }, - { "outputField": "confirmation", "localRole": "Fresh checksum-bound receipt over the exact sorted build-run identity inventory, plus the exact workflow name and public impact count." }, - { "outputField": "success", "localRole": "True for a preview or an exact empty HTTP 204 deletion response; mutation fields distinguish the two states." }, - { "outputField": "deleted", "localRole": "True only after Apple's exact empty HTTP 204 response." }, - { "outputField": "operationCommitState", "localRole": "committed only for exact empty 204; not_attempted, rejected, unknown, or committed_unverified otherwise." }, - { "outputField": "inspectionRequired", "localRole": "True for unknown or committed_unverified outcomes." }, - { "outputField": "inspection", "localRole": "Executable xcode_cloud_workflows_get exact-target inspection before any retry." }, - { "outputField": "retrySafe", "localRole": "False for every attempted deletion, including unknown and committed_unverified outcomes." }, - { "outputField": "statusCode", "localRole": "Exact verified 204 status on committed deletion." } + { + "outputField": "previewOnly", + "localRole": "True when the call performs fresh read-only workflow and cardinality preflight without sending DELETE." + }, + { + "outputField": "confirmation", + "localRole": "Fresh checksum-bound receipt over the exact sorted build-run identity inventory, plus the exact workflow name and public impact count." + }, + { + "outputField": "success", + "localRole": "True for a preview or an exact empty HTTP 204 deletion response; mutation fields distinguish the two states." + }, + { + "outputField": "deleted", + "localRole": "True only after Apple's exact empty HTTP 204 response." + }, + { + "outputField": "operationCommitState", + "localRole": "committed only for exact empty 204; not_attempted, rejected, unknown, or committed_unverified otherwise." + }, + { + "outputField": "inspectionRequired", + "localRole": "True for unknown or committed_unverified outcomes." + }, + { + "outputField": "inspection", + "localRole": "Executable xcode_cloud_workflows_get exact-target inspection before any retry." + }, + { + "outputField": "retrySafe", + "localRole": "False for every attempted deletion, including unknown and committed_unverified outcomes." + }, + { + "outputField": "statusCode", + "localRole": "Exact verified 204 status on committed deletion." + } ] }, "note": "Permanent deletion is a two-step safety contract: every call refreshes exact identity and fully paginates the build-run inventory with a fixed limit=200 sparse request. The receipt hashes the canonical workflow identity/name and exact sorted length-delimited build-run IDs, while the caller must also echo the public name/count confirmations. Exact empty 204 is the only committed success. Ambiguous or malformed accepted outcomes preserve workflow_id and xcode_cloud_workflows_get recovery guidance and are never replayed automatically." diff --git a/Sources/asc-mcp/Tooling/ASCOpenAPICoverage.swift b/Sources/asc-mcp/Tooling/ASCOpenAPICoverage.swift index 9ad2f97..6963d8e 100644 --- a/Sources/asc-mcp/Tooling/ASCOpenAPICoverage.swift +++ b/Sources/asc-mcp/Tooling/ASCOpenAPICoverage.swift @@ -177,6 +177,8 @@ enum ASCOpenAPICoverageRules { "Webhook notification receiver resources": [], "In-app purchases, subscriptions, and offers": [ "/v1/inAppPurchase", + "/v1/retentionMessage", + "/v1/retentionOffers", "/v1/subscription", "/v1/subscriptions", "/v1/winBackOffers", diff --git a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Execution.swift b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Execution.swift index df77da7..8b48e24 100644 --- a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Execution.swift +++ b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Execution.swift @@ -101,7 +101,7 @@ extension AssetsWorker { let placement = try await createPlacement(change, operation: &operation) operation.resourceIDs["placement_id"] = placement.id try await store.checkpoint(operation) - if change.action == .replacePlacement, change.target != .appEventLocalization { + if change.action == .replacePlacement, change.target?.supportsOrdering == true { let order = (change.orderedPlacementIDs ?? []).map { $0 == change.placementID ? placement.id : $0 } try await reorder(change, ids: order, operation: &operation) } @@ -166,7 +166,7 @@ extension AssetsWorker { } func reorder(_ change: AssetLibraryChange, ids: [String], operation: inout AssetLibraryOperation) async throws { - guard let target = change.target, target != .appEventLocalization, let targetID = change.targetID, let group = change.placementGroup else { throw AssetLibraryError("Unsupported ordering target") } + guard let target = change.target, target.supportsOrdering, let targetID = change.targetID, let group = change.placementGroup else { throw AssetLibraryError("Unsupported ordering target") } let before = try await targetPlacements(target: target, id: targetID).filter { $0.attributes?["placementGroup"]?.stringValue == group } guard ids.count == before.count, Set(ids) == Set(before.map(\.id)) else { throw AssetLibraryError("Ordering membership changed before mutation") } let ordered: [JSONValue] = ids.map { .object(["type": .string("appAssetLibraryPlacements"), "id": .string($0)]) } diff --git a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Preparation.swift b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Preparation.swift index 4922d31..813d24a 100644 --- a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Preparation.swift +++ b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Preparation.swift @@ -98,9 +98,14 @@ extension AssetsWorker { } if [.replacePlacement, .deletePlacement].contains(action) { change.placementID = try identifier("placement_id", arguments) } if action == .reorderPlacements { - guard change.target != .appEventLocalization else { throw AssetLibraryError("Apple does not support ordering event placements") } + guard change.target?.supportsOrdering == true else { + throw AssetLibraryError("Apple does not support ordering \(change.target == .retentionMessageVersion ? "retention message version" : "event") placements") + } change.orderedPlacementIDs = try stringList("ordered_placement_ids", arguments).map { try AssetLibraryJSON.identifier($0, field: "ordered_placement_ids") } } + if change.target == .retentionMessageVersion, change.kind == .video { + throw AssetLibraryError("Retention message versions only support image placements; video placements are not supported") + } if action == .addReviewItem { change.submissionID = try identifier("submission_id", arguments) } if action.isUpload, change.referenceName == nil, change.resumeOperationID == nil { change.referenceName = "asc-mcp-" + UUID().uuidString } return change @@ -142,11 +147,17 @@ extension AssetsWorker { } var existing: [AssetLibraryResource] = [] if let target = change.target, let targetID = change.targetID { + if target == .retentionMessageVersion, change.kind == .video { + throw AssetLibraryError("Retention message versions only support image placements; video placements are not supported") + } change.baseline.merge(try await targetScope(appID: change.appID, target: target, id: targetID, requireEditable: true)) { _, new in new } if let group = change.placementGroup { - try validatePlatform(catalog, group: group, platforms: change.baseline["target_platforms"] ?? "") + try validatePlatform(catalog, group: group, platforms: change.baseline["target_platforms"]) } existing = try await targetPlacements(target: target, id: targetID) + if target.isToOnePlacementEndpoint, change.action == .createPlacement, !existing.isEmpty { + throw AssetLibraryError("Retention message version already has a placement; use replace_placement or delete_placement") + } change.baseline["target_placement_ids"] = existing.map(\.id).sorted().joined(separator: ",") change.baseline["target_placements"] = try AssetLibraryJSON.fingerprint(try existing.map { try $0.fingerprint() }) if let id = change.placementID { @@ -227,13 +238,13 @@ extension AssetsWorker { static let knownAssetStates: Set = ["AWAITING_UPLOAD", "UPLOAD_COMPLETE", "FAILED", "COMPLETE", "PREPARE_FOR_SUBMISSION", "READY_FOR_REVIEW", "WAITING_FOR_REVIEW", "IN_REVIEW", "ACCEPTED", "APPROVED", "REJECTED", "ARCHIVED"] static let placeableStates: Set = ["COMPLETE", "PREPARE_FOR_SUBMISSION", "READY_FOR_REVIEW", "APPROVED", "REJECTED"] - func validatePlatform(_ catalog: AssetLibraryResource, group: String, platforms: String) throws { + func validatePlatform(_ catalog: AssetLibraryResource, group: String, platforms: String?) throws { guard let profile = catalog.attributes?["placementProfileGroups"]?.arrayValue?.first(where: { $0.objectValue?["placementProfileGroupId"]?.stringValue == group })?.objectValue, let platform = profile["platform"]?.stringValue else { throw AssetLibraryError("Placement group has no known platform") } - if platform == "ANY" { return } + guard let platforms, platform != "ANY" else { return } let mapping = ["IPHONE_APP_STORE": "IOS", "IPAD_APP_STORE": "IOS", "WATCH_APP_STORE": "IOS", "IMESSAGE_APP_STORE": "IOS", "VISION_PRO_APP_STORE": "VISION_OS", "MAC_APP_STORE": "MAC_OS", "TV_APP_STORE": "TV_OS"] guard let expected = mapping[platform], platforms.split(separator: ",").contains(Substring(expected)) else { diff --git a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Reads.swift b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Reads.swift index eb44736..3495321 100644 --- a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Reads.swift +++ b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Reads.swift @@ -47,7 +47,36 @@ extension AssetsWorker { } else { let (target, id) = try targetArguments(arguments) _ = try await targetScope(appID: appID, target: target, id: id, requireEditable: false) - path = "/v1/\(try ASCPathSegment.encode(target.resourceType))/\(try ASCPathSegment.encode(id))/placements" + if target.isToOnePlacementEndpoint { + guard arguments["next_url"] == nil else { + throw AssetLibraryError("next_url is not supported for to-one placement targets") + } + if let input = arguments["limit"] { + guard let value = input.intValue, (1...200).contains(value) else { + throw AssetLibraryError("limit must be an integer between 1 and 200") + } + } + let allowedTypes = arguments["placement_types"] != nil ? Set(try stringList("placement_types", arguments)) : nil + let allowedGroups = arguments["placement_groups"] != nil ? Set(try stringList("placement_groups", arguments)) : nil + let placements = try await targetPlacements(target: target, id: id).filter { placement in + let matchesType = allowedTypes.map { + guard let type = placement.attributes?["placementType"]?.stringValue else { return false } + return $0.contains(type) + } ?? true + let matchesGroup = allowedGroups.map { + guard let group = placement.attributes?["placementGroup"]?.stringValue else { return false } + return $0.contains(group) + } ?? true + return matchesType && matchesGroup + } + return MCPResult.jsonObject([ + "success": true, + "app_id": appID, + "resources": placements.map { $0.projection() }, + "count": placements.count + ]) + } + path = try target.placementsPath(id: id) } type = "appAssetLibraryPlacements" query = try filterQuery(arguments, mapping: ["placement_types": "placementType", "placement_groups": "placementGroup"]) @@ -97,9 +126,14 @@ extension AssetsWorker { case .appCustomProductPageLocalization: parentRelation = "appCustomProductPageVersion" case .appStoreVersionExperimentTreatmentLocalization: parentRelation = "appStoreVersionExperimentTreatment" case .appEventLocalization: parentRelation = "appEvent" + case .retentionMessageVersion: parentRelation = "retentionMessage" } let localization = try await resource(target.resourceType, id, include: parentRelation) - guard let parentID = localization.related(parentRelation), parentID.type == parentRelation + "s" else { throw AssetLibraryError("Localization has no verifiable parent") } + guard let parentID = localization.related(parentRelation), + parentID.type == parentRelation + "s", + (try? AssetLibraryJSON.identifier(parentID.id, field: parentRelation)) == parentID.id else { + throw AssetLibraryError("Localization has no verifiable parent") + } var checked = [localization] let owner: AssetLibraryResourceID? let state: String? @@ -130,6 +164,14 @@ extension AssetsWorker { checked.append(event) owner = AssetLibraryResourceID(type: "apps", id: appID) state = event.attributes?["eventState"]?.stringValue + case .retentionMessageVersion: + let members = try await all("/v1/apps/\(try ASCPathSegment.encode(appID))/retentionMessages", query: ["filter[id]": parentID.id], type: "retentionMessages") + guard let message = members.first(where: { $0.id == parentID.id }), members.count == 1 else { + throw AssetLibraryError("Retention message does not belong to this app") + } + checked.append(message) + owner = AssetLibraryResourceID(type: "apps", id: appID) + state = localization.state } guard owner == AssetLibraryResourceID(type: "apps", id: appID) else { throw AssetLibraryError("Localization belongs to another application") } if requireEditable { @@ -139,12 +181,14 @@ extension AssetsWorker { guard let state, allowed.contains(state) else { throw AssetLibraryError("Parent is not in a supported editable draft state") } } var result = try Dictionary(uniqueKeysWithValues: checked.map { ($0.type + ":" + $0.id, try $0.fingerprint()) }) - var platforms = Set(checked.compactMap { $0.attributes?["platform"]?.stringValue }) - if platforms.isEmpty { - let versions = try await all("/v1/apps/\(try ASCPathSegment.encode(appID))/appStoreVersions", type: "appStoreVersions") - platforms = Set(versions.compactMap { $0.attributes?["platform"]?.stringValue }) + if target != .retentionMessageVersion { + var platforms = Set(checked.compactMap { $0.attributes?["platform"]?.stringValue }) + if platforms.isEmpty { + let versions = try await all("/v1/apps/\(try ASCPathSegment.encode(appID))/appStoreVersions", type: "appStoreVersions") + platforms = Set(versions.compactMap { $0.attributes?["platform"]?.stringValue }) + } + result["target_platforms"] = platforms.sorted().joined(separator: ",") } - result["target_platforms"] = platforms.sorted().joined(separator: ",") return result } @@ -160,7 +204,31 @@ extension AssetsWorker { } func targetPlacements(target: AssetLibraryTarget, id: String) async throws -> [AssetLibraryResource] { - try await all("/v1/\(try ASCPathSegment.encode(target.resourceType))/\(try ASCPathSegment.encode(id))/placements", query: ["include": Self.placementIncludes, "sort": "placementGroupPosition"], type: "appAssetLibraryPlacements") + let path = try target.placementsPath(id: id) + if target.isToOnePlacementEndpoint { + let doc = try await httpClient.get(path, parameters: ["include": Self.placementIncludes], as: AssetOptionalLibraryDocument.self) + if let selfLink = doc.links?["self"]?.stringValue { + _ = try httpClient.validatedScopedLink(selfLink, scope: PaginationScope(path: path, allowedParameters: ["include"])) + } + guard let placement = doc.data else { return [] } + guard placement.type == "appAssetLibraryPlacements", + (try? AssetLibraryJSON.identifier(placement.id, field: "placement_id")) == placement.id else { + throw AssetLibraryError("Invalid appAssetLibraryPlacements resource") + } + let targets = AssetLibraryTarget.allCases.compactMap { candidate -> (AssetLibraryTarget, AssetLibraryResourceID)? in + guard let related = placement.related(candidate.rawValue) else { return nil } + return (candidate, related) + } + if !targets.isEmpty { + guard targets.count == 1, + targets.first?.0 == target, + targets.first?.1 == AssetLibraryResourceID(type: target.resourceType, id: id) else { + throw AssetLibraryError("Placement target mismatch for \(target.rawValue)") + } + } + return [placement] + } + return try await all(path, query: ["include": Self.placementIncludes, "sort": "placementGroupPosition"], type: "appAssetLibraryPlacements") } func filterQuery(_ arguments: [String: Value], mapping: [String: String]) throws -> [String: String] { diff --git a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Recovery.swift b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Recovery.swift index 06992b7..b1090bb 100644 --- a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Recovery.swift +++ b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Recovery.swift @@ -109,7 +109,7 @@ extension AssetsWorker { guard placements.contains(where: { $0.id == id && placementMatches($0, change: change) }) else { throw AssetLibraryError("New placement is not confirmed in the intended localization") } if change.action == .replacePlacement { guard !placements.contains(where: { $0.id == change.placementID }) else { throw AssetLibraryError("Old placement is still present; replacement is incomplete") } - if target != .appEventLocalization { + if target.supportsOrdering { let expected = (change.orderedPlacementIDs ?? []).map { $0 == change.placementID ? id : $0 } guard group == expected else { throw AssetLibraryError("Replacement exists but its requested order is incomplete. Prepare a separate reorder preview.") } } diff --git a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+ToolDefinitions.swift b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+ToolDefinitions.swift index c3dfaec..da4a72a 100644 --- a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+ToolDefinitions.swift +++ b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+ToolDefinitions.swift @@ -5,8 +5,8 @@ extension AssetsWorker { let app = field("App Store Connect app ID; all resource ownership is checked against this app") let asset = field("Exact Asset Library asset ID; legacy screenshot IDs are not interchangeable") let kind = enumeration(["image", "video"], "Asset media kind") - let target = enumeration(AssetLibraryTarget.allCases.map(\.rawValue), "Exactly one localization resource type") - let targetID = field("Exact localization resource ID") + let target = enumeration(AssetLibraryTarget.allCases.map(\.rawValue), "Exactly one target localization or retention message version resource type") + let targetID = field("Exact target localization or retention message version resource ID") let pagination: [String: Value] = [ "limit": .object(["type": .string("integer"), "minimum": .int(1), "maximum": .int(200)]), "next_url": field("Continuation returned by this exact collection and query") diff --git a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker.swift b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker.swift index 2163b80..b033613 100644 --- a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker.swift +++ b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker.swift @@ -131,5 +131,5 @@ public final class AssetsWorker: Sendable { try await all("/v1/\(try ASCPathSegment.encode(kind.resourceType))/\(try ASCPathSegment.encode(try AssetLibraryJSON.identifier(id, field: "asset_id")))/placements", query: ["include": Self.placementIncludes], type: "appAssetLibraryPlacements") } - static let placementIncludes = "image,video,appEventLocalization,appStoreVersionLocalization,appCustomProductPageLocalization,appStoreVersionExperimentTreatmentLocalization" + static let placementIncludes = "image,video,appEventLocalization,appStoreVersionLocalization,appCustomProductPageLocalization,appStoreVersionExperimentTreatmentLocalization,retentionMessageVersion" } diff --git a/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker+Handlers.swift b/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker+Handlers.swift index 23fc8d4..c63f172 100644 --- a/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker+Handlers.swift +++ b/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker+Handlers.swift @@ -36,7 +36,8 @@ extension ReviewSubmissionsWorker { "gameCenterLeaderboardVersion", "inAppPurchaseVersion", "subscriptionVersion", - "subscriptionGroupVersion" + "subscriptionGroupVersion", + "retentionMessageVersion" ].joined(separator: ",") private static let supportedItemIncludes = [ "appAssetLibraryImage", @@ -48,7 +49,8 @@ extension ReviewSubmissionsWorker { "backgroundAssetVersion", "inAppPurchaseVersion", "subscriptionVersion", - "subscriptionGroupVersion" + "subscriptionGroupVersion", + "retentionMessageVersion" ] private static let submissionIncludedTypes: Set = [ "actors", @@ -72,7 +74,8 @@ extension ReviewSubmissionsWorker { "gameCenterLeaderboardVersion": "gameCenterLeaderboardVersions", "inAppPurchaseVersion": "inAppPurchaseVersions", "subscriptionVersion": "subscriptionVersions", - "subscriptionGroupVersion": "subscriptionGroupVersions" + "subscriptionGroupVersion": "subscriptionGroupVersions", + "retentionMessageVersion": "retentionMessageVersions" ] private static let itemRelationFields: [(String, ASCReviewSubmissionItemRelation)] = [ @@ -83,7 +86,8 @@ extension ReviewSubmissionsWorker { ("background_asset_version_id", .backgroundAssetVersion), ("in_app_purchase_version_id", .inAppPurchaseVersion), ("subscription_version_id", .subscriptionVersion), - ("subscription_group_version_id", .subscriptionGroupVersion) + ("subscription_group_version_id", .subscriptionGroupVersion), + ("retention_message_version_id", .retentionMessageVersion) ] /// Lists review submissions for one app using Apple's required ownership filter. @@ -876,6 +880,7 @@ extension ReviewSubmissionsWorker { "fields[inAppPurchaseVersions]": "version,state", "fields[subscriptionVersions]": "version,state", "fields[subscriptionGroupVersions]": "version,state", + "fields[retentionMessageVersions]": "state", "include": Self.supportedItemIncludes.joined(separator: ",") ] } @@ -1569,7 +1574,8 @@ extension ReviewSubmissionsWorker { ("gameCenterLeaderboardVersion", relationships.gameCenterLeaderboardVersion, true), ("inAppPurchaseVersion", relationships.inAppPurchaseVersion, false), ("subscriptionVersion", relationships.subscriptionVersion, false), - ("subscriptionGroupVersion", relationships.subscriptionGroupVersion, false) + ("subscriptionGroupVersion", relationships.subscriptionGroupVersion, false), + ("retentionMessageVersion", relationships.retentionMessageVersion, false) ] return candidates.compactMap { name, relationship, scoped in relationship?.data.map { (name, $0, scoped) } diff --git a/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker+ToolDefinitions.swift b/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker+ToolDefinitions.swift index ea0ff62..0e10e7f 100644 --- a/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker+ToolDefinitions.swift +++ b/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker+ToolDefinitions.swift @@ -133,6 +133,7 @@ extension ReviewSubmissionsWorker { "in_app_purchase_version_id": idSchema("In-app purchase version ID"), "subscription_version_id": idSchema("Subscription version ID"), "subscription_group_version_id": idSchema("Subscription group version ID"), + "retention_message_version_id": idSchema("Retention message version ID"), "app_asset_library_image_id": idSchema("Asset Library image ID bound to the preview"), "app_asset_library_video_id": idSchema("Asset Library video ID bound to the preview"), "preview_id": idSchema("One-time preview from assets_prepare_change for adding this asset to this submission") diff --git a/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker.swift b/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker.swift index 92206ff..bebfbd7 100644 --- a/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker.swift +++ b/Sources/asc-mcp/Workers/ReviewSubmissionsWorker/ReviewSubmissionsWorker.swift @@ -22,6 +22,7 @@ public final class ReviewSubmissionsWorker: Sendable { "in_app_purchase_version_id", "subscription_version_id", "subscription_group_version_id", + "retention_message_version_id", "app_asset_library_image_id", "app_asset_library_video_id", "preview_id" diff --git a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift new file mode 100644 index 0000000..5950e39 --- /dev/null +++ b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift @@ -0,0 +1,1884 @@ +import Foundation +import MCP + +// MARK: - Retention Messaging Tool Handlers (ASC OpenAPI 4.6) +extension SubscriptionsWorker { + + private struct RetentionPaginationParams: Sendable { + let limit: Int? + let nextURL: String? + } + + private static let allowedRetentionOfferModes: Set = [ + "PAY_AS_YOU_GO", + "PAY_UP_FRONT", + "FREE_TRIAL" + ] + + private static let allowedRetentionOfferDurations: Set = [ + "THREE_DAYS", + "ONE_WEEK", + "TWO_WEEKS", + "ONE_MONTH", + "TWO_MONTHS", + "THREE_MONTHS", + "SIX_MONTHS", + "ONE_YEAR" + ] + + private static let allowedRetentionEligibilityDurationTypes: Set = [ + "AT_LEAST", + "UP_TO", + "RANGE" + ] + + private static let allowedRetentionWaitBetweenOffersMonths: Set = [ + 0, 1, 2, 3, 6, 9, 12, 24 + ] + + // MARK: - 1. List Retention Messages + + /// Lists retention messages configured for an app (`GET /v1/apps/{id}/retentionMessages`). + /// - Returns: JSON array of retention messages and optional pagination `next_url`. + func listRetentionMessages(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "app_id", "limit", "next_url" + ]) + let encodedAppId = try validateRetentionRequiredResourceID(params.arguments, key: "app_id") + let pagination = try parseRetentionPagination( + params.arguments, + allowedPaths: ["/v1/apps/\(try ASCPathSegment.encode(encodedAppId, field: "app_id"))/retentionMessages"] + ) + + let response: ASCRetentionMessagesResponse + if let nextURL = pagination.nextURL { + response = try await httpClient.get( + nextURL, + parameters: [:], + as: ASCRetentionMessagesResponse.self + ) + } else { + var queryParams: [String: String] = [:] + if let limit = pagination.limit { + queryParams["limit"] = String(limit) + } + response = try await httpClient.get( + "/v1/apps/\(try ASCPathSegment.encode(encodedAppId, field: "app_id"))/retentionMessages", + parameters: queryParams, + as: ASCRetentionMessagesResponse.self + ) + } + + let messages = response.data.map { formatRetentionMessage($0) } + var result: [String: Any] = [ + "success": true, + "data": messages, + "retention_messages": messages, + "count": messages.count + ] + if let next = response.links.next { + result["next_url"] = next + } + return MCPResult.jsonObject(result) + } catch { + return MCPResult.error("Failed to list retention messages: \(error.localizedDescription)") + } + } + + // MARK: - 2. Get Retention Message + + /// Gets details of a retention message by ID (`GET /v1/retentionMessages/{id}`). + /// - Returns: JSON object with retention message details. + func getRetentionMessage(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "retention_message_id" + ]) + let encodedMessageId = try validateRetentionRequiredResourceID( + params.arguments, + key: "retention_message_id" + ) + + let response: ASCRetentionMessageResponse = try await httpClient.get( + "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))", + as: ASCRetentionMessageResponse.self + ) + + let formatted = formatRetentionMessage(response.data) + return MCPResult.jsonObject([ + "success": true, + "data": formatted, + "retention_message": formatted + ]) + } catch { + return MCPResult.error("Failed to get retention message: \(error.localizedDescription)") + } + } + + // MARK: - 3. Create Retention Message + + /// Creates a retention message for an app (`POST /v1/retentionMessages`). + /// - Returns: JSON object with the created retention message. + func createRetentionMessage(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "app_id", "reference_name" + ]) + let appId = try validateRetentionRequiredResourceID(params.arguments, key: "app_id") + let referenceName = try validateRetentionReferenceName(params.arguments, key: "reference_name") + + let request = RetentionMessageCreateRequest( + appId: appId, + referenceName: referenceName + ) + + let response: ASCRetentionMessageResponse = try await httpClient.post( + "/v1/retentionMessages", + body: request, + as: ASCRetentionMessageResponse.self + ) + + let formatted = formatRetentionMessage(response.data) + return MCPResult.jsonObject([ + "success": true, + "data": formatted, + "retention_message": formatted + ]) + } catch { + return MCPResult.error("Failed to create retention message: \(error.localizedDescription)") + } + } + + // MARK: - 4. Delete Retention Message + + /// Deletes a retention message by ID (`DELETE /v1/retentionMessages/{id}`). + /// - Returns: JSON confirmation of deletion. + func deleteRetentionMessage(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "retention_message_id" + ]) + let encodedMessageId = try validateRetentionRequiredResourceID( + params.arguments, + key: "retention_message_id" + ) + + _ = try await httpClient.delete("/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))") + + return MCPResult.jsonObject([ + "success": true, + "deleted_id": encodedMessageId, + "message": "Retention message '\(encodedMessageId)' deleted" + ]) + } catch { + return MCPResult.error("Failed to delete retention message: \(error.localizedDescription)") + } + } + + // MARK: - 5. List Retention Message Versions + + /// Lists versions for a retention message (`GET /v1/retentionMessages/{id}/versions`). + /// - Returns: JSON array of retention message versions. + func listRetentionMessageVersions(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "retention_message_id", "limit", "next_url" + ]) + let encodedMessageId = try validateRetentionRequiredResourceID( + params.arguments, + key: "retention_message_id" + ) + let pagination = try parseRetentionPagination( + params.arguments, + allowedPaths: [ + "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/versions", + "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/retentionMessageVersions" + ] + ) + + let response: ASCRetentionMessageVersionsResponse + if let nextURL = pagination.nextURL { + response = try await httpClient.get( + nextURL, + parameters: [:], + as: ASCRetentionMessageVersionsResponse.self + ) + } else { + var queryParams: [String: String] = [:] + if let limit = pagination.limit { + queryParams["limit"] = String(limit) + } + response = try await httpClient.get( + "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/versions", + parameters: queryParams, + as: ASCRetentionMessageVersionsResponse.self + ) + } + + let versions = response.data.map { formatRetentionMessageVersion($0) } + var result: [String: Any] = [ + "success": true, + "data": versions, + "versions": versions, + "count": versions.count + ] + if let next = response.links.next { + result["next_url"] = next + } + return MCPResult.jsonObject(result) + } catch { + return MCPResult.error("Failed to list retention message versions: \(error.localizedDescription)") + } + } + + // MARK: - 6. Get Retention Message Version + + /// Gets details of a retention message version by ID (`GET /v1/retentionMessageVersions/{id}`). + /// - Returns: JSON object with retention message version details. + func getRetentionMessageVersion(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "version_id" + ]) + let encodedVersionId = try validateRetentionRequiredResourceID( + params.arguments, + key: "version_id" + ) + + let response: ASCRetentionMessageVersionResponse = try await httpClient.get( + "/v1/retentionMessageVersions/\(try ASCPathSegment.encode(encodedVersionId, field: "version_id"))", + as: ASCRetentionMessageVersionResponse.self + ) + + let formatted = formatRetentionMessageVersion(response.data) + return MCPResult.jsonObject([ + "success": true, + "data": formatted, + "version": formatted + ]) + } catch { + return MCPResult.error("Failed to get retention message version: \(error.localizedDescription)") + } + } + + // MARK: - 7. Create Retention Message Version + + /// Creates a new version for a retention message (`POST /v1/retentionMessageVersions`). + /// - Returns: JSON object with the created retention message version. + func createRetentionMessageVersion(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "retention_message_id" + ]) + let retentionMessageId = try validateRetentionRequiredResourceID( + params.arguments, + key: "retention_message_id" + ) + + let request = RetentionMessageVersionCreateRequest( + retentionMessageId: retentionMessageId + ) + + let response: ASCRetentionMessageVersionResponse = try await httpClient.post( + "/v1/retentionMessageVersions", + body: request, + as: ASCRetentionMessageVersionResponse.self + ) + + let formatted = formatRetentionMessageVersion(response.data) + return MCPResult.jsonObject([ + "success": true, + "data": formatted, + "version": formatted + ]) + } catch { + return MCPResult.error("Failed to create retention message version: \(error.localizedDescription)") + } + } + + // MARK: - 8. List Retention Message Localizations + + /// Lists localizations for a retention message version (`GET /v1/retentionMessageVersions/{id}/localizations`). + /// - Returns: JSON array of retention message localizations. + func listRetentionMessageLocalizations(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "version_id", "limit", "next_url" + ]) + let encodedVersionId = try validateRetentionRequiredResourceID( + params.arguments, + key: "version_id" + ) + let pagination = try parseRetentionPagination( + params.arguments, + allowedPaths: [ + "/v1/retentionMessageVersions/\(try ASCPathSegment.encode(encodedVersionId, field: "version_id"))/localizations", + "/v1/retentionMessageVersions/\(try ASCPathSegment.encode(encodedVersionId, field: "version_id"))/retentionMessageLocalizations" + ] + ) + + let response: ASCRetentionMessageLocalizationsResponse + if let nextURL = pagination.nextURL { + response = try await httpClient.get( + nextURL, + parameters: [:], + as: ASCRetentionMessageLocalizationsResponse.self + ) + } else { + var queryParams: [String: String] = [:] + if let limit = pagination.limit { + queryParams["limit"] = String(limit) + } + response = try await httpClient.get( + "/v1/retentionMessageVersions/\(try ASCPathSegment.encode(encodedVersionId, field: "version_id"))/localizations", + parameters: queryParams, + as: ASCRetentionMessageLocalizationsResponse.self + ) + } + + let localizations = response.data.map { formatRetentionMessageLocalization($0) } + var result: [String: Any] = [ + "success": true, + "data": localizations, + "localizations": localizations, + "count": localizations.count + ] + if let next = response.links.next { + result["next_url"] = next + } + return MCPResult.jsonObject(result) + } catch { + return MCPResult.error("Failed to list retention message localizations: \(error.localizedDescription)") + } + } + + // MARK: - 9. Get Retention Message Localization + + /// Gets details of a retention message localization by ID (`GET /v1/retentionMessageLocalizations/{id}`). + /// - Returns: JSON object with retention message localization details. + func getRetentionMessageLocalization(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "localization_id" + ]) + let encodedLocalizationId = try validateRetentionRequiredResourceID( + params.arguments, + key: "localization_id" + ) + + let response: ASCRetentionMessageLocalizationResponse = try await httpClient.get( + "/v1/retentionMessageLocalizations/\(try ASCPathSegment.encode(encodedLocalizationId, field: "localization_id"))", + as: ASCRetentionMessageLocalizationResponse.self + ) + + let formatted = formatRetentionMessageLocalization(response.data) + return MCPResult.jsonObject([ + "success": true, + "data": formatted, + "localization": formatted + ]) + } catch { + return MCPResult.error("Failed to get retention message localization: \(error.localizedDescription)") + } + } + + // MARK: - 10. Create Retention Message Localization + + /// Creates a localization for a retention message version (`POST /v1/retentionMessageLocalizations`). + /// - Returns: JSON object with the created retention message localization. + func createRetentionMessageLocalization(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "version_id", "locale", "header", "body", "allow_price_mentions" + ]) + let versionId = try validateRetentionRequiredResourceID(params.arguments, key: "version_id") + let locale = try validateRetentionRequiredLocale(params.arguments, key: "locale") + let allowPriceMentions = try parseOptionalBooleanArgument( + params.arguments, + key: "allow_price_mentions" + ) ?? false + + let header = try validateRequiredRetentionCopyField( + params.arguments, + key: "header", + maxLength: 66, + allowPriceMentions: allowPriceMentions + ) + let body = try validateRequiredRetentionCopyField( + params.arguments, + key: "body", + maxLength: 144, + allowPriceMentions: allowPriceMentions + ) + + let request = RetentionMessageLocalizationCreateRequest( + versionId: versionId, + locale: locale, + header: header, + body: body + ) + + let response: ASCRetentionMessageLocalizationResponse = try await httpClient.post( + "/v1/retentionMessageLocalizations", + body: request, + as: ASCRetentionMessageLocalizationResponse.self + ) + + let formatted = formatRetentionMessageLocalization(response.data) + return MCPResult.jsonObject([ + "success": true, + "data": formatted, + "localization": formatted + ]) + } catch { + return MCPResult.error("Failed to create retention message localization: \(error.localizedDescription)") + } + } + + // MARK: - 11. Update Retention Message Localization + + /// Updates a retention message localization (`PATCH /v1/retentionMessageLocalizations/{id}`). + /// - Returns: JSON object with the updated retention message localization. + func updateRetentionMessageLocalization(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "localization_id", "header", "body", "allow_price_mentions" + ]) + let encodedLocalizationId = try validateRetentionRequiredResourceID( + params.arguments, + key: "localization_id" + ) + let allowPriceMentions = try parseOptionalBooleanArgument( + params.arguments, + key: "allow_price_mentions" + ) ?? false + + let headerPatch = try validateOptionalRetentionCopyPatchField( + params.arguments, + key: "header", + maxLength: 66, + allowPriceMentions: allowPriceMentions + ) + let bodyPatch = try validateOptionalRetentionCopyPatchField( + params.arguments, + key: "body", + maxLength: 144, + allowPriceMentions: allowPriceMentions + ) + + guard headerPatch != nil || bodyPatch != nil else { + return MCPResult.error( + "At least one of 'header' or 'body' must be provided when updating a retention message localization" + ) + } + + let request = RetentionMessageLocalizationUpdateRequest( + localizationId: encodedLocalizationId, + header: headerPatch, + body: bodyPatch + ) + + let response: ASCRetentionMessageLocalizationResponse = try await httpClient.patch( + "/v1/retentionMessageLocalizations/\(try ASCPathSegment.encode(encodedLocalizationId, field: "localization_id"))", + body: request, + as: ASCRetentionMessageLocalizationResponse.self + ) + + let formatted = formatRetentionMessageLocalization(response.data) + return MCPResult.jsonObject([ + "success": true, + "data": formatted, + "localization": formatted + ]) + } catch { + return MCPResult.error("Failed to update retention message localization: \(error.localizedDescription)") + } + } + + // MARK: - 12. Delete Retention Message Localization + + /// Deletes a retention message localization by ID (`DELETE /v1/retentionMessageLocalizations/{id}`). + /// - Returns: JSON confirmation of deletion. + func deleteRetentionMessageLocalization(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "localization_id" + ]) + let encodedLocalizationId = try validateRetentionRequiredResourceID( + params.arguments, + key: "localization_id" + ) + + _ = try await httpClient.delete("/v1/retentionMessageLocalizations/\(try ASCPathSegment.encode(encodedLocalizationId, field: "localization_id"))") + + return MCPResult.jsonObject([ + "success": true, + "deleted_id": encodedLocalizationId, + "message": "Retention message localization '\(encodedLocalizationId)' deleted" + ]) + } catch { + return MCPResult.error("Failed to delete retention message localization: \(error.localizedDescription)") + } + } + + // MARK: - 13. List Retention Message Subscriptions + + /// Lists subscriptions associated with a retention message (`GET /v1/retentionMessages/{id}/subscriptions`). + /// - Returns: JSON array of subscriptions linked to the retention message. + func listRetentionMessageSubscriptions(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "retention_message_id", "limit", "next_url" + ]) + let encodedMessageId = try validateRetentionRequiredResourceID( + params.arguments, + key: "retention_message_id" + ) + let pagination = try parseRetentionPagination( + params.arguments, + allowedPaths: [ + "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/subscriptions", + "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/relationships/subscriptions" + ] + ) + + let response: ASCRetentionMessageSubscriptionsResponse + if let nextURL = pagination.nextURL { + response = try await httpClient.get( + nextURL, + parameters: [:], + as: ASCRetentionMessageSubscriptionsResponse.self + ) + } else { + var queryParams: [String: String] = [:] + if let limit = pagination.limit { + queryParams["limit"] = String(limit) + } + response = try await httpClient.get( + "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/subscriptions", + parameters: queryParams, + as: ASCRetentionMessageSubscriptionsResponse.self + ) + } + + let subscriptions = response.data.map { sub -> [String: Any] in + var item: [String: Any] = [ + "id": sub.id, + "type": sub.type + ] + if let name = sub.attributes?.name { item["name"] = name } + if let productId = sub.attributes?.productId { item["productId"] = productId } + if let state = sub.attributes?.state { item["state"] = state } + if let period = sub.attributes?.subscriptionPeriod { item["subscriptionPeriod"] = period } + return item + } + + var result: [String: Any] = [ + "success": true, + "data": subscriptions, + "subscriptions": subscriptions, + "count": subscriptions.count + ] + if let next = response.links.next { + result["next_url"] = next + } + return MCPResult.jsonObject(result) + } catch { + return MCPResult.error("Failed to list retention message subscriptions: \(error.localizedDescription)") + } + } + + // MARK: - 14. List Retention Offers + + /// Lists retention offers for a subscription (`GET /v1/subscriptions/{id}/retentionOffers` or `/retentionMessageOffers`). + /// - Returns: JSON array of retention offers. + func listRetentionOffers(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "subscription_id", "message_offers_only", "limit", "next_url" + ]) + let encodedSubId = try validateRetentionRequiredResourceID( + params.arguments, + key: "subscription_id" + ) + let messageOffersOnly = try parseOptionalBooleanArgument( + params.arguments, + key: "message_offers_only" + ) ?? false + + let endpointPath = messageOffersOnly + ? "/v1/subscriptions/\(try ASCPathSegment.encode(encodedSubId, field: "subscription_id"))/retentionMessageOffers" + : "/v1/subscriptions/\(try ASCPathSegment.encode(encodedSubId, field: "subscription_id"))/retentionOffers" + + let pagination = try parseRetentionPagination( + params.arguments, + allowedPaths: [ + "/v1/subscriptions/\(try ASCPathSegment.encode(encodedSubId, field: "subscription_id"))/retentionOffers", + "/v1/subscriptions/\(try ASCPathSegment.encode(encodedSubId, field: "subscription_id"))/retentionMessageOffers" + ] + ) + + let response: ASCRetentionOffersResponse + if let nextURL = pagination.nextURL { + response = try await httpClient.get( + nextURL, + parameters: [:], + as: ASCRetentionOffersResponse.self + ) + } else { + var queryParams: [String: String] = [:] + if let limit = pagination.limit { + queryParams["limit"] = String(limit) + } + response = try await httpClient.get( + endpointPath, + parameters: queryParams, + as: ASCRetentionOffersResponse.self + ) + } + + let offers = response.data.map { formatRetentionOffer($0) } + var result: [String: Any] = [ + "success": true, + "data": offers, + "offers": offers, + "message_offers_only": messageOffersOnly, + "count": offers.count + ] + if let next = response.links.next { + result["next_url"] = next + } + return MCPResult.jsonObject(result) + } catch { + return MCPResult.error("Failed to list retention offers: \(error.localizedDescription)") + } + } + + // MARK: - 15. Get Retention Offer + + /// Gets details of a retention offer by ID (`GET /v1/retentionOffers/{id}`). + /// - Returns: JSON object with retention offer details. + func getRetentionOffer(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "offer_id" + ]) + let encodedOfferId = try validateRetentionRequiredResourceID( + params.arguments, + key: "offer_id" + ) + + let response: ASCRetentionOfferResponse = try await httpClient.get( + "/v1/retentionOffers/\(try ASCPathSegment.encode(encodedOfferId, field: "offer_id"))", + as: ASCRetentionOfferResponse.self + ) + + let formatted = formatRetentionOffer(response.data) + return MCPResult.jsonObject([ + "success": true, + "data": formatted, + "offer": formatted + ]) + } catch { + return MCPResult.error("Failed to get retention offer: \(error.localizedDescription)") + } + } + + // MARK: - 16. Create Retention Offer + + /// Creates a retention offer with inline prices (`POST /v1/retentionOffers`). + /// - Returns: JSON object with the created retention offer. + func createRetentionOffer(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "subscription_id", + "reference_name", + "offer_mode", + "duration", + "periods", + "eligibility_duration_type", + "eligibility_duration_min", + "eligibility_duration_max", + "wait_between_offers_months", + "price_point_ids", + "territory_ids" + ]) + + let subscriptionId = try validateRetentionRequiredResourceID( + params.arguments, + key: "subscription_id" + ) + let referenceName = try validateRetentionReferenceName( + params.arguments, + key: "reference_name" + ) + let offerMode = try validateRequiredEnumString( + params.arguments, + key: "offer_mode", + allowed: Self.allowedRetentionOfferModes + ) + let duration = try validateRequiredEnumString( + params.arguments, + key: "duration", + allowed: Self.allowedRetentionOfferDurations + ) + let periods = try parseRequiredStrictPositiveInt( + params.arguments, + key: "periods" + ) + let eligibilityDurationType = try validateRequiredEnumString( + params.arguments, + key: "eligibility_duration_type", + allowed: Self.allowedRetentionEligibilityDurationTypes + ) + let eligibilityMin = try parseOptionalStrictPositiveInt( + params.arguments, + key: "eligibility_duration_min" + ) + let eligibilityMax = try parseOptionalStrictPositiveInt( + params.arguments, + key: "eligibility_duration_max" + ) + + let eligibilityRange = try validateRetentionEligibilityRange( + durationType: eligibilityDurationType, + minimum: eligibilityMin, + maximum: eligibilityMax + ) + + let waitBetweenOffersMonths = try parseRequiredRetentionWaitMonths( + params.arguments, + key: "wait_between_offers_months" + ) + + let pricePointIds = try parseRequiredUniqueCanonicalIDArray( + params.arguments, + key: "price_point_ids" + ) + let territoryIds = try parseOptionalCanonicalIDArray( + params.arguments, + key: "territory_ids" + ) + + if let territoryIds, !territoryIds.isEmpty, territoryIds.count != pricePointIds.count { + return MCPResult.error( + "'territory_ids' count (\(territoryIds.count)) must match 'price_point_ids' count (\(pricePointIds.count))" + ) + } + + var priceIdentifiers: [ASCResourceIdentifier] = [] + var inlinePrices: [RetentionOfferPriceInlineCreate] = [] + + for (index, pricePointId) in pricePointIds.enumerated() { + let inlineId = "${price-\(index)}" + priceIdentifiers.append( + ASCResourceIdentifier(type: "retentionOfferPrices", id: inlineId) + ) + let territoryRel: RetentionOfferPriceInlineCreate.TerritoryRelationship? + if let territoryIds, !territoryIds.isEmpty { + territoryRel = RetentionOfferPriceInlineCreate.TerritoryRelationship( + data: ASCResourceIdentifier(type: "territories", id: territoryIds[index]) + ) + } else { + territoryRel = nil + } + + inlinePrices.append( + RetentionOfferPriceInlineCreate( + id: inlineId, + relationships: RetentionOfferPriceInlineCreate.Relationships( + subscriptionPricePoint: RetentionOfferPriceInlineCreate.PricePointRelationship( + data: ASCResourceIdentifier(type: "subscriptionPricePoints", id: pricePointId) + ), + territory: territoryRel + ) + ) + ) + } + + let request = RetentionOfferCreateRequest( + data: RetentionOfferCreateRequest.CreateData( + attributes: RetentionOfferCreateRequest.Attributes( + referenceName: referenceName, + offerMode: offerMode, + duration: duration, + periods: periods, + eligibilitySubscriberDurationType: eligibilityDurationType, + eligibilitySubscriberDurationInMonths: eligibilityRange, + waitBetweenOffersInMonths: waitBetweenOffersMonths + ), + relationships: RetentionOfferCreateRequest.Relationships( + subscription: RetentionOfferCreateRequest.SubscriptionRelationship( + data: ASCResourceIdentifier(type: "subscriptions", id: subscriptionId) + ), + prices: RetentionOfferCreateRequest.PricesRelationship( + data: priceIdentifiers + ) + ) + ), + included: inlinePrices + ) + + let response: ASCRetentionOfferResponse = try await httpClient.post( + "/v1/retentionOffers", + body: request, + as: ASCRetentionOfferResponse.self + ) + + let formatted = formatRetentionOffer(response.data) + return MCPResult.jsonObject([ + "success": true, + "data": formatted, + "offer": formatted + ]) + } catch { + return MCPResult.error("Failed to create retention offer: \(error.localizedDescription)") + } + } + + // MARK: - 17. Update Retention Offer + + /// Updates a retention offer (`PATCH /v1/retentionOffers/{id}`). + /// - Returns: JSON object with the updated retention offer. + func updateRetentionOffer(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "offer_id", + "eligibility_duration_type", + "eligibility_duration_min", + "eligibility_duration_max", + "wait_between_offers_months" + ]) + + let encodedOfferId = try validateRetentionRequiredResourceID( + params.arguments, + key: "offer_id" + ) + + let durationTypePatch = try parseNullableEnumString( + params.arguments, + key: "eligibility_duration_type", + allowed: Self.allowedRetentionEligibilityDurationTypes + ) + let minPatch = try parseNullableStrictPositiveInt( + params.arguments, + key: "eligibility_duration_min" + ) + let maxPatch = try parseNullableStrictPositiveInt( + params.arguments, + key: "eligibility_duration_max" + ) + let waitPatch = try parseNullableRetentionWaitMonths( + params.arguments, + key: "wait_between_offers_months" + ) + + guard durationTypePatch != nil || minPatch != nil || maxPatch != nil || waitPatch != nil else { + return MCPResult.error( + "At least one of 'eligibility_duration_type', 'eligibility_duration_min', 'eligibility_duration_max', or 'wait_between_offers_months' must be provided" + ) + } + + let durationRangePatch = try buildRetentionEligibilityRangePatch( + durationTypePatch: durationTypePatch, + minPatch: minPatch, + maxPatch: maxPatch + ) + + let request = RetentionOfferUpdateRequest( + offerId: encodedOfferId, + eligibilitySubscriberDurationType: durationTypePatch, + eligibilitySubscriberDurationInMonths: durationRangePatch, + waitBetweenOffersInMonths: waitPatch + ) + + let response: ASCRetentionOfferResponse = try await httpClient.patch( + "/v1/retentionOffers/\(try ASCPathSegment.encode(encodedOfferId, field: "offer_id"))", + body: request, + as: ASCRetentionOfferResponse.self + ) + + let formatted = formatRetentionOffer(response.data) + return MCPResult.jsonObject([ + "success": true, + "data": formatted, + "offer": formatted + ]) + } catch { + return MCPResult.error("Failed to update retention offer: \(error.localizedDescription)") + } + } + + // MARK: - 18. Delete Retention Offer + + /// Deletes a retention offer by ID (`DELETE /v1/retentionOffers/{id}`). + /// - Returns: JSON confirmation of deletion. + func deleteRetentionOffer(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "offer_id" + ]) + let encodedOfferId = try validateRetentionRequiredResourceID( + params.arguments, + key: "offer_id" + ) + + _ = try await httpClient.delete("/v1/retentionOffers/\(try ASCPathSegment.encode(encodedOfferId, field: "offer_id"))") + + return MCPResult.jsonObject([ + "success": true, + "deleted_id": encodedOfferId, + "message": "Retention offer '\(encodedOfferId)' deleted" + ]) + } catch { + return MCPResult.error("Failed to delete retention offer: \(error.localizedDescription)") + } + } + + // MARK: - 19. List Retention Offer Prices + + /// Lists territory prices for a retention offer (`GET /v1/retentionOffers/{id}/prices`). + /// - Returns: JSON array of retention offer prices. + func listRetentionOfferPrices(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "offer_id", "territory", "limit", "next_url" + ]) + let encodedOfferId = try validateRetentionRequiredResourceID( + params.arguments, + key: "offer_id" + ) + let territories = try parseOptionalTerritoryFilter(params.arguments, key: "territory") + + let pagination = try parseRetentionPagination( + params.arguments, + allowedPaths: ["/v1/retentionOffers/\(try ASCPathSegment.encode(encodedOfferId, field: "offer_id"))/prices"], + allowedQueryKeys: [ + "limit", + "cursor", + "filter[territory]", + "include", + "fields[retentionOfferPrices]", + "fields[territories]", + "fields[subscriptionPricePoints]" + ] + ) + + let response: ASCRetentionOfferPricesResponse + if let nextURL = pagination.nextURL { + response = try await httpClient.get( + nextURL, + parameters: [:], + as: ASCRetentionOfferPricesResponse.self + ) + } else { + var queryParams: [String: String] = [:] + if let limit = pagination.limit { + queryParams["limit"] = String(limit) + } + if let territories, !territories.isEmpty { + queryParams["filter[territory]"] = territories.joined(separator: ",") + } + response = try await httpClient.get( + "/v1/retentionOffers/\(try ASCPathSegment.encode(encodedOfferId, field: "offer_id"))/prices", + parameters: queryParams, + as: ASCRetentionOfferPricesResponse.self + ) + } + + let prices = response.data.map { formatRetentionOfferPrice($0) } + var result: [String: Any] = [ + "success": true, + "data": prices, + "prices": prices, + "count": prices.count + ] + if let next = response.links.next { + result["next_url"] = next + } + return MCPResult.jsonObject(result) + } catch { + return MCPResult.error("Failed to list retention offer prices: \(error.localizedDescription)") + } + } + + // MARK: - 20. Get Retention Message For Subscription + + /// Gets the retention message assigned to a subscription (`GET /v1/subscriptions/{id}/retentionMessage`). + /// Handles `{"data": null}` when no retention message is currently assigned. + /// - Returns: JSON object with the assigned retention message or `null`. + func getRetentionMessageForSubscription(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "subscription_id" + ]) + let encodedSubId = try validateRetentionRequiredResourceID( + params.arguments, + key: "subscription_id" + ) + + let response: ASCRetentionMessageOptionalResponse = try await httpClient.get( + "/v1/subscriptions/\(try ASCPathSegment.encode(encodedSubId, field: "subscription_id"))/retentionMessage", + as: ASCRetentionMessageOptionalResponse.self + ) + + if let message = response.data { + let formatted = formatRetentionMessage(message) + return MCPResult.jsonObject([ + "success": true, + "subscription_id": encodedSubId, + "has_retention_message": true, + "data": formatted, + "retention_message": formatted + ]) + } else { + return MCPResult.jsonObject([ + "success": true, + "subscription_id": encodedSubId, + "has_retention_message": false, + "data": NSNull(), + "retention_message": NSNull() + ]) + } + } catch { + return MCPResult.error("Failed to get retention message for subscription: \(error.localizedDescription)") + } + } + + // MARK: - 21. Set Retention Message For Subscription + + /// Assigns or clears the retention message for a subscription (`PATCH /v1/subscriptions/{id}/relationships/retentionMessage`). + /// - Returns: JSON confirmation of assignment or clearing. + func setRetentionMessage(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "subscription_id", "retention_message_id", "clear" + ]) + let encodedSubId = try validateRetentionRequiredResourceID( + params.arguments, + key: "subscription_id" + ) + + let targetMessageId = try resolveRetentionMessageAssignmentTarget(params.arguments) + let request = SubscriptionRetentionMessageLinkageRequest( + retentionMessageId: targetMessageId + ) + let bodyData = try JSONEncoder().encode(request) + + let receipt = try await httpClient.patchReceipt( + "/v1/subscriptions/\(try ASCPathSegment.encode(encodedSubId, field: "subscription_id"))/relationships/retentionMessage", + body: bodyData + ) + guard [200, 204].contains(receipt.statusCode) else { + throw ASCError.network("Unexpected HTTP status \(receipt.statusCode)") + } + + if let targetMessageId { + return MCPResult.jsonObject([ + "success": true, + "subscription_id": encodedSubId, + "retention_message_id": targetMessageId, + "cleared": false + ]) + } else { + return MCPResult.jsonObject([ + "success": true, + "subscription_id": encodedSubId, + "retention_message_id": NSNull(), + "cleared": true + ]) + } + } catch { + return MCPResult.error("Failed to set retention message for subscription: \(error.localizedDescription)") + } + } + + // MARK: - 22. Add Retention Message Offers + + /// Attaches retention offers to a subscription (`POST /v1/subscriptions/{id}/relationships/retentionMessageOffers`). + /// - Returns: JSON confirmation of attached offer IDs. + func addRetentionMessageOffers(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "subscription_id", "offer_ids" + ]) + let encodedSubId = try validateRetentionRequiredResourceID( + params.arguments, + key: "subscription_id" + ) + let offerIds = try parseRequiredUniqueCanonicalIDArray( + params.arguments, + key: "offer_ids" + ) + + let request = SubscriptionRetentionMessageOffersLinkagesRequest(offerIds: offerIds) + let bodyData = try JSONEncoder().encode(request) + + let receipt = try await httpClient.postReceipt( + "/v1/subscriptions/\(try ASCPathSegment.encode(encodedSubId, field: "subscription_id"))/relationships/retentionMessageOffers", + body: bodyData + ) + guard [200, 201, 204].contains(receipt.statusCode) else { + throw ASCError.network("Unexpected HTTP status \(receipt.statusCode)") + } + + return MCPResult.jsonObject([ + "success": true, + "subscription_id": encodedSubId, + "added_offer_ids": offerIds, + "count": offerIds.count + ]) + } catch { + return MCPResult.error("Failed to add retention message offers: \(error.localizedDescription)") + } + } + + // MARK: - 23. Remove Retention Message Offers + + /// Removes retention offers from a subscription (`DELETE /v1/subscriptions/{id}/relationships/retentionMessageOffers`). + /// - Returns: JSON confirmation of removed offer IDs. + func removeRetentionMessageOffers(_ params: CallTool.Parameters) async -> CallTool.Result { + do { + try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ + "subscription_id", "offer_ids" + ]) + let encodedSubId = try validateRetentionRequiredResourceID( + params.arguments, + key: "subscription_id" + ) + let offerIds = try parseRequiredUniqueCanonicalIDArray( + params.arguments, + key: "offer_ids" + ) + + let request = SubscriptionRetentionMessageOffersLinkagesRequest(offerIds: offerIds) + _ = try await httpClient.delete( + "/v1/subscriptions/\(try ASCPathSegment.encode(encodedSubId, field: "subscription_id"))/relationships/retentionMessageOffers", + body: request + ) + + return MCPResult.jsonObject([ + "success": true, + "subscription_id": encodedSubId, + "removed_offer_ids": offerIds, + "count": offerIds.count + ]) + } catch { + return MCPResult.error("Failed to remove retention message offers: \(error.localizedDescription)") + } + } + + // MARK: - Validation Helpers + + private func validateRetentionAllowedArguments( + _ arguments: [String: Value]?, + allowedKeys: Set + ) throws { + guard let arguments else { return } + let unknown = Set(arguments.keys).subtracting(allowedKeys).sorted() + guard unknown.isEmpty else { + throw ASCError.parsing("Unsupported parameter(s): \(unknown.joined(separator: ", "))") + } + } + + private func validateRetentionRequiredResourceID( + _ arguments: [String: Value]?, + key: String + ) throws -> String { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") + } + guard case .string(let value) = rawValue else { + throw ASCError.parsing("Parameter '\(key)' must be a string") + } + return try validateCanonicalIDString(value, field: key) + } + + private func validateRetentionRequiredLocale( + _ arguments: [String: Value]?, + key: String + ) throws -> String { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") + } + guard case .string(let value) = rawValue else { + throw ASCError.parsing("Parameter '\(key)' must be a string") + } + let trimmed = value.trimmingCharacters(in: .whitespacesAndNewlines) + guard !trimmed.isEmpty, value == trimmed else { + throw ASCError.parsing("Parameter '\(key)' must be a non-empty locale code without surrounding whitespace") + } + let localeErrors = ASCMetadataValidator.validateLocale(value, field: key) + if let firstError = localeErrors.first { + throw ASCError.parsing(firstError.message) + } + return value + } + + private func parseRetentionPagination( + _ arguments: [String: Value]?, + allowedPaths: Set, + allowedQueryKeys: Set = ["limit", "cursor", "include"] + ) throws -> RetentionPaginationParams { + var parsedLimit: Int? + if let rawLimit = arguments?["limit"], rawLimit != .null { + guard case .int(let intLimit) = rawLimit, (1...200).contains(intLimit) else { + throw ASCError.parsing("Parameter 'limit' must be an integer between 1 and 200") + } + parsedLimit = intLimit + } + + var parsedNextURL: String? + if let rawNext = arguments?["next_url"], rawNext != .null { + guard case .string(let nextString) = rawNext else { + throw ASCError.parsing("Parameter 'next_url' must be a string") + } + let trimmed = nextString.trimmingCharacters(in: .whitespacesAndNewlines) + guard !trimmed.isEmpty, nextString == trimmed else { + throw ASCError.parsing("Parameter 'next_url' must be a non-empty URL without surrounding whitespace") + } + guard let components = URLComponents(string: nextString), + components.user == nil, + components.password == nil, + components.fragment == nil else { + throw ASCError.parsing("Invalid 'next_url' format") + } + + if let scheme = components.scheme { + guard scheme.lowercased() == "https", + components.host?.lowercased() == "api.appstoreconnect.apple.com", + components.port == nil else { + throw ASCError.parsing( + "Invalid 'next_url': must target https://api.appstoreconnect.apple.com" + ) + } + } else if components.host != nil { + throw ASCError.parsing("Invalid 'next_url' host") + } + + let path = components.percentEncodedPath + guard allowedPaths.contains(path) else { + throw ASCError.parsing( + "Invalid 'next_url' path '\(path)' for this endpoint" + ) + } + + if let queryItems = components.queryItems { + for item in queryItems { + guard allowedQueryKeys.contains(item.name) else { + throw ASCError.parsing( + "Unsupported query parameter '\(item.name)' in 'next_url'" + ) + } + if item.name == "limit", let val = item.value { + guard let intLimit = Int(val), (1...200).contains(intLimit) else { + throw ASCError.parsing( + "Invalid 'limit' in 'next_url': must be between 1 and 200" + ) + } + } + } + } + + parsedNextURL = nextString + } + + return RetentionPaginationParams(limit: parsedLimit, nextURL: parsedNextURL) + } + + private func validateRetentionReferenceName( + _ arguments: [String: Value]?, + key: String + ) throws -> String { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") + } + guard case .string(let value) = rawValue else { + throw ASCError.parsing("Parameter '\(key)' must be a string") + } + let trimmed = value.trimmingCharacters(in: .whitespacesAndNewlines) + guard !trimmed.isEmpty else { + throw ASCError.parsing("Parameter '\(key)' cannot be empty") + } + guard value.count <= 64 else { + throw ASCError.parsing("Parameter '\(key)' must be at most 64 characters (got \(value.count))") + } + try validateNoEmoji(in: value, field: key) + return value + } + + private func validateRequiredRetentionCopyField( + _ arguments: [String: Value]?, + key: String, + maxLength: Int, + allowPriceMentions: Bool + ) throws -> String { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") + } + guard case .string(let value) = rawValue else { + throw ASCError.parsing("Parameter '\(key)' must be a string") + } + return try validateRetentionCopyString( + value, + field: key, + maxLength: maxLength, + allowPriceMentions: allowPriceMentions + ) + } + + private func validateOptionalRetentionCopyPatchField( + _ arguments: [String: Value]?, + key: String, + maxLength: Int, + allowPriceMentions: Bool + ) throws -> ASCNullable? { + guard let rawValue = arguments?[key] else { + return nil + } + switch rawValue { + case .null: + return .null + case .string(let value): + let validated = try validateRetentionCopyString( + value, + field: key, + maxLength: maxLength, + allowPriceMentions: allowPriceMentions + ) + return .value(validated) + default: + throw ASCError.parsing("Parameter '\(key)' must be a string or null") + } + } + + private func validateRetentionCopyString( + _ value: String, + field: String, + maxLength: Int, + allowPriceMentions: Bool + ) throws -> String { + let trimmed = value.trimmingCharacters(in: .whitespacesAndNewlines) + guard !trimmed.isEmpty else { + throw ASCError.parsing("Parameter '\(field)' cannot be empty") + } + guard value.count <= maxLength else { + throw ASCError.parsing( + "Parameter '\(field)' exceeds maximum length of \(maxLength) characters (got \(value.count))" + ) + } + try validateNoEmoji(in: value, field: field) + + if !allowPriceMentions { + try validateNoPriceOrDiscountMentions(in: value, field: field) + } + return value + } + + private func validateNoEmoji(in text: String, field: String) throws { + let containsEmoji = text.unicodeScalars.contains { scalar in + scalar.properties.isEmojiPresentation + || scalar.value >= 0x1F000 + || (0x2600...0x27BF).contains(scalar.value) + || scalar.value == 0xFE0F + } + if containsEmoji { + throw ASCError.parsing("Parameter '\(field)' must not contain emoji characters") + } + } + + private func validateNoPriceOrDiscountMentions(in text: String, field: String) throws { + let forbiddenSymbols: Set = ["$", "€", "£", "¥", "₽", "%"] + if text.contains(where: { forbiddenSymbols.contains($0) }) { + throw ASCError.parsing( + "Parameter '\(field)' contains a currency or percentage symbol. Apple forbids price or discount references in Retention Message localizations because the message is shown to all cancelling subscribers regardless of offer eligibility. Pass 'allow_price_mentions: true' only if intentional." + ) + } + + let pricePattern = #"\d+[.,]\d{2}"# + if text.range(of: pricePattern, options: .regularExpression) != nil { + throw ASCError.parsing( + "Parameter '\(field)' contains a numeric price pattern. Apple forbids price or discount references in Retention Message localizations because the message is shown to all cancelling subscribers regardless of offer eligibility. Pass 'allow_price_mentions: true' only if intentional." + ) + } + } + + private func parseOptionalBooleanArgument( + _ arguments: [String: Value]?, + key: String + ) throws -> Bool? { + guard let rawValue = arguments?[key], rawValue != .null else { + return nil + } + guard case .bool(let boolValue) = rawValue else { + throw ASCError.parsing("Parameter '\(key)' must be a boolean") + } + return boolValue + } + + private func validateRequiredEnumString( + _ arguments: [String: Value]?, + key: String, + allowed: Set + ) throws -> String { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") + } + guard case .string(let value) = rawValue else { + throw ASCError.parsing("Parameter '\(key)' must be a string") + } + guard allowed.contains(value) else { + let sorted = allowed.sorted().joined(separator: ", ") + throw ASCError.parsing("Invalid '\(key)' value '\(value)'. Allowed values: \(sorted)") + } + return value + } + + private func parseNullableEnumString( + _ arguments: [String: Value]?, + key: String, + allowed: Set + ) throws -> ASCNullable? { + guard let rawValue = arguments?[key] else { + return nil + } + switch rawValue { + case .null: + return .null + case .string(let value): + guard allowed.contains(value) else { + let sorted = allowed.sorted().joined(separator: ", ") + throw ASCError.parsing("Invalid '\(key)' value '\(value)'. Allowed values: \(sorted)") + } + return .value(value) + default: + throw ASCError.parsing("Parameter '\(key)' must be a string or null") + } + } + + private func parseRequiredStrictPositiveInt( + _ arguments: [String: Value]?, + key: String + ) throws -> Int { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") + } + guard case .int(let intValue) = rawValue, intValue >= 1 else { + throw ASCError.parsing("Parameter '\(key)' must be an integer >= 1") + } + return intValue + } + + private func parseOptionalStrictPositiveInt( + _ arguments: [String: Value]?, + key: String + ) throws -> Int? { + guard let rawValue = arguments?[key], rawValue != .null else { + return nil + } + guard case .int(let intValue) = rawValue, intValue >= 1 else { + throw ASCError.parsing("Parameter '\(key)' must be an integer >= 1") + } + return intValue + } + + private func parseNullableStrictPositiveInt( + _ arguments: [String: Value]?, + key: String + ) throws -> ASCNullable? { + guard let rawValue = arguments?[key] else { + return nil + } + switch rawValue { + case .null: + return .null + case .int(let intValue) where intValue >= 1: + return .value(intValue) + default: + throw ASCError.parsing("Parameter '\(key)' must be an integer >= 1 or null") + } + } + + private func parseRequiredRetentionWaitMonths( + _ arguments: [String: Value]?, + key: String + ) throws -> Int { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") + } + guard case .int(let intValue) = rawValue, + Self.allowedRetentionWaitBetweenOffersMonths.contains(intValue) else { + let allowedList = Self.allowedRetentionWaitBetweenOffersMonths.sorted().map(String.init).joined(separator: ", ") + throw ASCError.parsing( + "Parameter '\(key)' must be one of [\(allowedList)]" + ) + } + return intValue + } + + private func parseNullableRetentionWaitMonths( + _ arguments: [String: Value]?, + key: String + ) throws -> ASCNullable? { + guard let rawValue = arguments?[key] else { + return nil + } + switch rawValue { + case .null: + return .null + case .int(let intValue) where Self.allowedRetentionWaitBetweenOffersMonths.contains(intValue): + return .value(intValue) + default: + let allowedList = Self.allowedRetentionWaitBetweenOffersMonths.sorted().map(String.init).joined(separator: ", ") + throw ASCError.parsing( + "Parameter '\(key)' must be one of [\(allowedList)] or null" + ) + } + } + + private func validateRetentionEligibilityRange( + durationType: String, + minimum: Int?, + maximum: Int? + ) throws -> RetentionIntegerRange { + switch durationType { + case "AT_LEAST": + guard let minimum, minimum >= 1 else { + throw ASCError.parsing( + "'eligibility_duration_min' (>= 1) is required when 'eligibility_duration_type' is 'AT_LEAST'" + ) + } + guard maximum == nil else { + throw ASCError.parsing( + "'eligibility_duration_max' must not be provided when 'eligibility_duration_type' is 'AT_LEAST'" + ) + } + return RetentionIntegerRange(minimum: minimum, maximum: nil) + + case "UP_TO": + guard let maximum, maximum >= 1 else { + throw ASCError.parsing( + "'eligibility_duration_max' (>= 1) is required when 'eligibility_duration_type' is 'UP_TO'" + ) + } + guard minimum == nil else { + throw ASCError.parsing( + "'eligibility_duration_min' must not be provided when 'eligibility_duration_type' is 'UP_TO'" + ) + } + return RetentionIntegerRange(minimum: nil, maximum: maximum) + + case "RANGE": + guard let minimum, minimum >= 1, let maximum, maximum >= 1 else { + throw ASCError.parsing( + "Both 'eligibility_duration_min' and 'eligibility_duration_max' (>= 1) are required when 'eligibility_duration_type' is 'RANGE'" + ) + } + guard minimum <= maximum else { + throw ASCError.parsing( + "'eligibility_duration_min' (\(minimum)) cannot be greater than 'eligibility_duration_max' (\(maximum))" + ) + } + return RetentionIntegerRange(minimum: minimum, maximum: maximum) + + default: + throw ASCError.parsing("Invalid 'eligibility_duration_type': \(durationType)") + } + } + + private func buildRetentionEligibilityRangePatch( + durationTypePatch: ASCNullable?, + minPatch: ASCNullable?, + maxPatch: ASCNullable? + ) throws -> ASCNullable? { + let minValue: Int? + if case .value(let minInt) = minPatch { + minValue = minInt + } else { + minValue = nil + } + + let maxValue: Int? + if case .value(let maxInt) = maxPatch { + maxValue = maxInt + } else { + maxValue = nil + } + + switch durationTypePatch { + case .value(let durationType): + let range = try validateRetentionEligibilityRange( + durationType: durationType, + minimum: minValue, + maximum: maxValue + ) + return .value(range) + + case .null: + if minValue != nil || maxValue != nil { + throw ASCError.parsing( + "Cannot provide non-null 'eligibility_duration_min' or 'eligibility_duration_max' when clearing 'eligibility_duration_type'" + ) + } + if minPatch == .null || maxPatch == .null { + return .null + } + return nil + + case nil: + if minPatch == nil && maxPatch == nil { + return nil + } + if minPatch == .null && maxPatch == .null { + return .null + } + if (minPatch == .null && maxValue == nil) || (maxPatch == .null && minValue == nil) { + return .null + } + if let minValue, let maxValue, minValue > maxValue { + throw ASCError.parsing( + "'eligibility_duration_min' (\(minValue)) cannot be greater than 'eligibility_duration_max' (\(maxValue))" + ) + } + return .value(RetentionIntegerRange(minimum: minValue, maximum: maxValue)) + } + } + + private func parseRequiredUniqueCanonicalIDArray( + _ arguments: [String: Value]?, + key: String + ) throws -> [String] { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") + } + guard case .array(let arrayValues) = rawValue, !arrayValues.isEmpty else { + throw ASCError.parsing("Parameter '\(key)' must be a non-empty array of strings") + } + + var result: [String] = [] + var seen: Set = [] + for (index, element) in arrayValues.enumerated() { + guard case .string(let rawId) = element else { + throw ASCError.parsing("Parameter '\(key)[\(index)]' must be a string") + } + let validatedId = try validateCanonicalIDString(rawId, field: "\(key)[\(index)]") + guard seen.insert(validatedId).inserted else { + throw ASCError.parsing("Duplicate ID '\(validatedId)' in '\(key)'") + } + result.append(validatedId) + } + return result + } + + private func parseOptionalCanonicalIDArray( + _ arguments: [String: Value]?, + key: String + ) throws -> [String]? { + guard let rawValue = arguments?[key], rawValue != .null else { + return nil + } + guard case .array(let arrayValues) = rawValue else { + throw ASCError.parsing("Parameter '\(key)' must be an array of strings") + } + + var result: [String] = [] + for (index, element) in arrayValues.enumerated() { + guard case .string(let rawId) = element else { + throw ASCError.parsing("Parameter '\(key)[\(index)]' must be a string") + } + let validatedId = try validateCanonicalIDString(rawId, field: "\(key)[\(index)]") + result.append(validatedId) + } + return result + } + + private func parseOptionalTerritoryFilter( + _ arguments: [String: Value]?, + key: String + ) throws -> [String]? { + guard let rawValue = arguments?[key], rawValue != .null else { + return nil + } + switch rawValue { + case .string(let rawString): + let parts = rawString + .split(separator: ",", omittingEmptySubsequences: false) + .map { String($0).trimmingCharacters(in: .whitespacesAndNewlines) } + guard !parts.isEmpty, parts.allSatisfy({ !$0.isEmpty }) else { + throw ASCError.parsing("Parameter '\(key)' must not be empty") + } + return try parts.enumerated().map { idx, part in + try validateCanonicalIDString(part, field: "\(key)[\(idx)]") + } + case .array(let items): + guard !items.isEmpty else { + throw ASCError.parsing("Parameter '\(key)' must not be an empty array") + } + return try items.enumerated().map { idx, element in + guard case .string(let str) = element else { + throw ASCError.parsing("Parameter '\(key)[\(idx)]' must be a string") + } + return try validateCanonicalIDString(str, field: "\(key)[\(idx)]") + } + default: + throw ASCError.parsing("Parameter '\(key)' must be a string or array of strings") + } + } + + private func validateCanonicalIDString(_ rawValue: String, field: String) throws -> String { + let trimmed = rawValue.trimmingCharacters(in: .whitespacesAndNewlines) + guard !trimmed.isEmpty, rawValue == trimmed else { + throw ASCError.parsing("Parameter '\(field)' must be a non-empty canonical ID without surrounding whitespace") + } + let encoded = try ASCPathSegment.encode(rawValue, field: field) + guard encoded == rawValue else { + throw ASCError.parsing("Parameter '\(field)' contains invalid characters") + } + return rawValue + } + + private func resolveRetentionMessageAssignmentTarget( + _ arguments: [String: Value]? + ) throws -> String? { + let rawMessageId = arguments?["retention_message_id"] + let clearFlag = try parseOptionalBooleanArgument(arguments, key: "clear") + + switch rawMessageId { + case .some(.string(let messageId)): + if clearFlag == true { + throw ASCError.parsing( + "Ambiguous parameters: cannot provide a non-null 'retention_message_id' together with 'clear: true'" + ) + } + return try validateCanonicalIDString(messageId, field: "retention_message_id") + + case .some(.null): + if clearFlag == false { + throw ASCError.parsing( + "Ambiguous parameters: cannot provide 'retention_message_id: null' together with 'clear: false'" + ) + } + return nil + + case .none: + guard clearFlag == true else { + throw ASCError.parsing( + "Provide either a non-empty 'retention_message_id' to assign a message, or 'clear: true' (or 'retention_message_id: null') to clear it" + ) + } + return nil + + case .some: + throw ASCError.parsing("Parameter 'retention_message_id' must be a string or null") + } + } + + // MARK: - Formatting Helpers + + private func formatRetentionMessage(_ message: ASCRetentionMessage) -> [String: Any] { + var result: [String: Any] = [ + "id": message.id, + "type": message.type + ] + if let referenceName = message.attributes?.referenceName { + result["referenceName"] = referenceName + } + if let appId = message.relationships?.app?.data?.id { + result["appId"] = appId + } + return result + } + + private func formatRetentionMessageVersion(_ version: ASCRetentionMessageVersion) -> [String: Any] { + var result: [String: Any] = [ + "id": version.id, + "type": version.type + ] + if let state = version.attributes?.state { + result["state"] = state + } + if let versionNumber = version.attributes?.version { + result["version"] = versionNumber + } + if let retentionMessageId = version.relationships?.retentionMessage?.data?.id { + result["retentionMessageId"] = retentionMessageId + } + if let placementId = version.relationships?.placement?.data?.id { + result["placementId"] = placementId + } + return result + } + + private func formatRetentionMessageLocalization(_ localization: ASCRetentionMessageLocalization) -> [String: Any] { + var result: [String: Any] = [ + "id": localization.id, + "type": localization.type + ] + if let locale = localization.attributes?.locale { + result["locale"] = locale + } + if let header = localization.attributes?.header { + result["header"] = header + } + if let body = localization.attributes?.body { + result["body"] = body + } + if let versionId = localization.relationships?.retentionMessageVersion?.data?.id + ?? localization.relationships?.version?.data?.id { + result["versionId"] = versionId + } + return result + } + + private func formatRetentionOffer(_ offer: ASCRetentionOffer) -> [String: Any] { + var result: [String: Any] = [ + "id": offer.id, + "type": offer.type + ] + if let attributes = offer.attributes { + if let referenceName = attributes.referenceName { + result["referenceName"] = referenceName + } + if let offerMode = attributes.offerMode { + result["offerMode"] = offerMode + } + if let duration = attributes.duration { + result["duration"] = duration + } + if let periods = attributes.periods { + result["periods"] = periods + } + if let eligibilityType = attributes.eligibilitySubscriberDurationType { + result["eligibilitySubscriberDurationType"] = eligibilityType + } + if let eligibilityRange = attributes.eligibilitySubscriberDurationInMonths { + var rangeDict: [String: Any] = [:] + if let min = eligibilityRange.minimum { rangeDict["minimum"] = min } + if let max = eligibilityRange.maximum { rangeDict["maximum"] = max } + result["eligibilitySubscriberDurationInMonths"] = rangeDict + } + if let waitMonths = attributes.waitBetweenOffersInMonths { + result["waitBetweenOffersInMonths"] = waitMonths + } + } + if let subscriptionId = offer.relationships?.subscription?.data?.id { + result["subscriptionId"] = subscriptionId + } + return result + } + + private func formatRetentionOfferPrice(_ price: ASCRetentionOfferPrice) -> [String: Any] { + var result: [String: Any] = [ + "id": price.id, + "type": price.type + ] + if let territoryId = price.relationships?.territory?.data?.id { + result["territoryId"] = territoryId + } + if let pricePointId = price.relationships?.subscriptionPricePoint?.data?.id { + result["subscriptionPricePointId"] = pricePointId + } + return result + } +} diff --git a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionToolDefinitions.swift b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionToolDefinitions.swift new file mode 100644 index 0000000..85613f6 --- /dev/null +++ b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionToolDefinitions.swift @@ -0,0 +1,703 @@ +import Foundation +import MCP + +// MARK: - Retention Messaging Tool Definitions (ASC OpenAPI 4.6) +extension SubscriptionsWorker { + + /// Returns the 23 Retention Messaging tools for App Store Connect API 4.6. + /// - Returns: Array of MCP tool definitions. + func retentionMessagingTools() -> [Tool] { + [ + listRetentionMessagesTool(), + getRetentionMessageTool(), + createRetentionMessageTool(), + deleteRetentionMessageTool(), + listRetentionMessageVersionsTool(), + getRetentionMessageVersionTool(), + createRetentionMessageVersionTool(), + listRetentionMessageLocalizationsTool(), + getRetentionMessageLocalizationTool(), + createRetentionMessageLocalizationTool(), + updateRetentionMessageLocalizationTool(), + deleteRetentionMessageLocalizationTool(), + listRetentionMessageSubscriptionsTool(), + listRetentionOffersTool(), + getRetentionOfferTool(), + createRetentionOfferTool(), + updateRetentionOfferTool(), + deleteRetentionOfferTool(), + listRetentionOfferPricesTool(), + getRetentionMessageForSubscriptionTool(), + setRetentionMessageTool(), + addRetentionMessageOffersTool(), + removeRetentionMessageOffersTool() + ] + } + + // MARK: - Retention Messages + + private func listRetentionMessagesTool() -> Tool { + Tool( + name: "subscriptions_list_retention_messages", + description: "List retention messages configured for an app", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "app_id": .object([ + "type": .string("string"), + "description": .string("App Store Connect app ID") + ]), + "limit": .object([ + "type": .string("integer"), + "description": .string("Max results (default: 25, max: 200)"), + "minimum": .int(1), + "maximum": .int(200) + ]), + "next_url": .object([ + "type": .string("string"), + "description": .string("Pagination URL from previous response to fetch next page") + ]) + ]), + "required": .array([.string("app_id")]) + ]) + ) + } + + private func getRetentionMessageTool() -> Tool { + Tool( + name: "subscriptions_get_retention_message", + description: "Get details of a specific retention message by ID", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "retention_message_id": .object([ + "type": .string("string"), + "description": .string("Retention message ID") + ]) + ]), + "required": .array([.string("retention_message_id")]) + ]) + ) + } + + private func createRetentionMessageTool() -> Tool { + Tool( + name: "subscriptions_create_retention_message", + description: "Create a new retention message for an app", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "app_id": .object([ + "type": .string("string"), + "description": .string("App Store Connect app ID") + ]), + "reference_name": .object([ + "type": .string("string"), + "description": .string("Internal reference name for the retention message (max 64 characters)"), + "maxLength": .int(64) + ]) + ]), + "required": .array([.string("app_id"), .string("reference_name")]) + ]) + ) + } + + private func deleteRetentionMessageTool() -> Tool { + Tool( + name: "subscriptions_delete_retention_message", + description: "Delete a retention message by ID", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "retention_message_id": .object([ + "type": .string("string"), + "description": .string("Retention message ID") + ]) + ]), + "required": .array([.string("retention_message_id")]) + ]) + ) + } + + // MARK: - Retention Message Versions + + private func listRetentionMessageVersionsTool() -> Tool { + Tool( + name: "subscriptions_list_retention_message_versions", + description: "List versions for a retention message", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "retention_message_id": .object([ + "type": .string("string"), + "description": .string("Retention message ID") + ]), + "limit": .object([ + "type": .string("integer"), + "description": .string("Max results (default: 25, max: 200)"), + "minimum": .int(1), + "maximum": .int(200) + ]), + "next_url": .object([ + "type": .string("string"), + "description": .string("Pagination URL from previous response to fetch next page") + ]) + ]), + "required": .array([.string("retention_message_id")]) + ]) + ) + } + + private func getRetentionMessageVersionTool() -> Tool { + Tool( + name: "subscriptions_get_retention_message_version", + description: "Get details of a retention message version by ID", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "version_id": .object([ + "type": .string("string"), + "description": .string("Retention message version ID") + ]) + ]), + "required": .array([.string("version_id")]) + ]) + ) + } + + private func createRetentionMessageVersionTool() -> Tool { + Tool( + name: "subscriptions_create_retention_message_version", + description: "Create a new version for a retention message", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "retention_message_id": .object([ + "type": .string("string"), + "description": .string("Retention message ID") + ]) + ]), + "required": .array([.string("retention_message_id")]) + ]) + ) + } + + // MARK: - Retention Message Localizations + + private func listRetentionMessageLocalizationsTool() -> Tool { + Tool( + name: "subscriptions_list_retention_message_localizations", + description: "List localizations for a retention message version", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "version_id": .object([ + "type": .string("string"), + "description": .string("Retention message version ID") + ]), + "limit": .object([ + "type": .string("integer"), + "description": .string("Max results (default: 25, max: 200)"), + "minimum": .int(1), + "maximum": .int(200) + ]), + "next_url": .object([ + "type": .string("string"), + "description": .string("Pagination URL from previous response to fetch next page") + ]) + ]), + "required": .array([.string("version_id")]) + ]) + ) + } + + private func getRetentionMessageLocalizationTool() -> Tool { + Tool( + name: "subscriptions_get_retention_message_localization", + description: "Get details of a retention message localization by ID", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "localization_id": .object([ + "type": .string("string"), + "description": .string("Retention message localization ID") + ]) + ]), + "required": .array([.string("localization_id")]) + ]) + ) + } + + private func createRetentionMessageLocalizationTool() -> Tool { + Tool( + name: "subscriptions_create_retention_message_localization", + description: "Create a localization for a retention message version", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "version_id": .object([ + "type": .string("string"), + "description": .string("Retention message version ID") + ]), + "locale": .object([ + "type": .string("string"), + "description": .string("Locale code (e.g. en-US, ru, de-DE)") + ]), + "header": .object([ + "type": .string("string"), + "description": .string("Retention message header text (max 66 characters, no emoji or price mentions)"), + "maxLength": .int(66) + ]), + "body": .object([ + "type": .string("string"), + "description": .string("Retention message body text (max 144 characters, no emoji or price mentions)"), + "maxLength": .int(144) + ]), + "allow_price_mentions": .object([ + "type": .string("boolean"), + "description": .string("Bypass App Review price/discount mention lint check when explicitly set to true") + ]) + ]), + "required": .array([ + .string("version_id"), + .string("locale"), + .string("header"), + .string("body") + ]) + ]) + ) + } + + private func updateRetentionMessageLocalizationTool() -> Tool { + Tool( + name: "subscriptions_update_retention_message_localization", + description: "Update header and/or body for a retention message localization", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "localization_id": .object([ + "type": .string("string"), + "description": .string("Retention message localization ID") + ]), + "header": .object([ + "type": .array([.string("string"), .string("null")]), + "description": .string("Updated retention message header text (max 66 characters)"), + "maxLength": .int(66) + ]), + "body": .object([ + "type": .array([.string("string"), .string("null")]), + "description": .string("Updated retention message body text (max 144 characters)"), + "maxLength": .int(144) + ]), + "allow_price_mentions": .object([ + "type": .string("boolean"), + "description": .string("Bypass App Review price/discount mention lint check when explicitly set to true") + ]) + ]), + "required": .array([.string("localization_id")]) + ]) + ) + } + + private func deleteRetentionMessageLocalizationTool() -> Tool { + Tool( + name: "subscriptions_delete_retention_message_localization", + description: "Delete a retention message localization by ID", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "localization_id": .object([ + "type": .string("string"), + "description": .string("Retention message localization ID") + ]) + ]), + "required": .array([.string("localization_id")]) + ]) + ) + } + + // MARK: - Retention Message Subscriptions + + private func listRetentionMessageSubscriptionsTool() -> Tool { + Tool( + name: "subscriptions_list_retention_message_subscriptions", + description: "List subscriptions associated with a retention message", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "retention_message_id": .object([ + "type": .string("string"), + "description": .string("Retention message ID") + ]), + "limit": .object([ + "type": .string("integer"), + "description": .string("Max results (default: 25, max: 200)"), + "minimum": .int(1), + "maximum": .int(200) + ]), + "next_url": .object([ + "type": .string("string"), + "description": .string("Pagination URL from previous response to fetch next page") + ]) + ]), + "required": .array([.string("retention_message_id")]) + ]) + ) + } + + // MARK: - Retention Offers + + private func listRetentionOffersTool() -> Tool { + Tool( + name: "subscriptions_list_retention_offers", + description: "List retention offers for a subscription (all offers or active retention message offers only)", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "subscription_id": .object([ + "type": .string("string"), + "description": .string("Subscription ID") + ]), + "message_offers_only": .object([ + "type": .string("boolean"), + "description": .string("When true, list only offers linked to the subscription's retention message") + ]), + "limit": .object([ + "type": .string("integer"), + "description": .string("Max results (default: 25, max: 200)"), + "minimum": .int(1), + "maximum": .int(200) + ]), + "next_url": .object([ + "type": .string("string"), + "description": .string("Pagination URL from previous response to fetch next page") + ]) + ]), + "required": .array([.string("subscription_id")]) + ]) + ) + } + + private func getRetentionOfferTool() -> Tool { + Tool( + name: "subscriptions_get_retention_offer", + description: "Get details of a retention offer by ID", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "offer_id": .object([ + "type": .string("string"), + "description": .string("Retention offer ID") + ]) + ]), + "required": .array([.string("offer_id")]) + ]) + ) + } + + private func createRetentionOfferTool() -> Tool { + Tool( + name: "subscriptions_create_retention_offer", + description: "Create a retention offer for a subscription with inline territory prices", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "subscription_id": .object([ + "type": .string("string"), + "description": .string("Subscription ID") + ]), + "reference_name": .object([ + "type": .string("string"), + "description": .string("Internal reference name for the retention offer (max 64 characters)"), + "maxLength": .int(64) + ]), + "offer_mode": .object([ + "type": .string("string"), + "description": .string("Offer payment mode"), + "enum": .array([ + .string("PAY_AS_YOU_GO"), + .string("PAY_UP_FRONT"), + .string("FREE_TRIAL") + ]) + ]), + "duration": .object([ + "type": .string("string"), + "description": .string("Duration of each offer period"), + "enum": .array([ + .string("THREE_DAYS"), + .string("ONE_WEEK"), + .string("TWO_WEEKS"), + .string("ONE_MONTH"), + .string("TWO_MONTHS"), + .string("THREE_MONTHS"), + .string("SIX_MONTHS"), + .string("ONE_YEAR") + ]) + ]), + "periods": .object([ + "type": .string("integer"), + "description": .string("Number of billing periods for the offer (minimum 1)"), + "minimum": .int(1) + ]), + "eligibility_duration_type": .object([ + "type": .string("string"), + "description": .string("Subscriber paid duration eligibility rule type"), + "enum": .array([ + .string("AT_LEAST"), + .string("UP_TO"), + .string("RANGE") + ]) + ]), + "eligibility_duration_min": .object([ + "type": .string("integer"), + "description": .string("Minimum paid subscription duration in months (required for AT_LEAST and RANGE)"), + "minimum": .int(1) + ]), + "eligibility_duration_max": .object([ + "type": .string("integer"), + "description": .string("Maximum paid subscription duration in months (required for UP_TO and RANGE)"), + "minimum": .int(1) + ]), + "wait_between_offers_months": .object([ + "type": .string("integer"), + "description": .string("Months a subscriber must wait between retention offers"), + "enum": .array([ + .int(0), + .int(1), + .int(2), + .int(3), + .int(6), + .int(9), + .int(12), + .int(24) + ]) + ]), + "price_point_ids": .object([ + "type": .string("array"), + "description": .string("Subscription price point IDs for the retention offer"), + "minItems": .int(1), + "items": .object([ + "type": .string("string") + ]) + ]), + "territory_ids": .object([ + "type": .string("array"), + "description": .string("Optional territory codes matching price_point_ids 1:1 (e.g. USA, GBR)"), + "items": .object([ + "type": .string("string") + ]) + ]) + ]), + "required": .array([ + .string("subscription_id"), + .string("reference_name"), + .string("offer_mode"), + .string("duration"), + .string("periods"), + .string("eligibility_duration_type"), + .string("wait_between_offers_months"), + .string("price_point_ids") + ]) + ]) + ) + } + + private func updateRetentionOfferTool() -> Tool { + Tool( + name: "subscriptions_update_retention_offer", + description: "Update eligibility duration or wait between offers for a retention offer", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "offer_id": .object([ + "type": .string("string"), + "description": .string("Retention offer ID") + ]), + "eligibility_duration_type": .object([ + "type": .array([.string("string"), .string("null")]), + "description": .string("Updated subscriber duration eligibility type (or null to clear)"), + "enum": .array([ + .string("AT_LEAST"), + .string("UP_TO"), + .string("RANGE"), + .null + ]) + ]), + "eligibility_duration_min": .object([ + "type": .array([.string("integer"), .string("null")]), + "description": .string("Updated minimum paid duration in months (or null to clear)"), + "minimum": .int(1) + ]), + "eligibility_duration_max": .object([ + "type": .array([.string("integer"), .string("null")]), + "description": .string("Updated maximum paid duration in months (or null to clear)"), + "minimum": .int(1) + ]), + "wait_between_offers_months": .object([ + "type": .array([.string("integer"), .string("null")]), + "description": .string("Updated wait between offers in months (or null to clear)"), + "enum": .array([ + .int(0), + .int(1), + .int(2), + .int(3), + .int(6), + .int(9), + .int(12), + .int(24), + .null + ]) + ]) + ]), + "required": .array([.string("offer_id")]) + ]) + ) + } + + private func deleteRetentionOfferTool() -> Tool { + Tool( + name: "subscriptions_delete_retention_offer", + description: "Delete a retention offer by ID", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "offer_id": .object([ + "type": .string("string"), + "description": .string("Retention offer ID") + ]) + ]), + "required": .array([.string("offer_id")]) + ]) + ) + } + + private func listRetentionOfferPricesTool() -> Tool { + Tool( + name: "subscriptions_list_retention_offer_prices", + description: "List territory prices for a retention offer", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "offer_id": .object([ + "type": .string("string"), + "description": .string("Retention offer ID") + ]), + "territory": .object([ + "type": .array([.string("string"), .string("array")]), + "description": .string("Optional territory code or array of territory codes for filter[territory]"), + "items": .object([ + "type": .string("string") + ]) + ]), + "limit": .object([ + "type": .string("integer"), + "description": .string("Max results (default: 25, max: 200)"), + "minimum": .int(1), + "maximum": .int(200) + ]), + "next_url": .object([ + "type": .string("string"), + "description": .string("Pagination URL from previous response to fetch next page") + ]) + ]), + "required": .array([.string("offer_id")]) + ]) + ) + } + + // MARK: - Subscription Retention Message & Offer Relationships + + private func getRetentionMessageForSubscriptionTool() -> Tool { + Tool( + name: "subscriptions_get_retention_message_for_subscription", + description: "Get the retention message currently assigned to a subscription", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "subscription_id": .object([ + "type": .string("string"), + "description": .string("Subscription ID") + ]) + ]), + "required": .array([.string("subscription_id")]) + ]) + ) + } + + private func setRetentionMessageTool() -> Tool { + Tool( + name: "subscriptions_set_retention_message", + description: "Assign or clear the retention message for a subscription", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "subscription_id": .object([ + "type": .string("string"), + "description": .string("Subscription ID") + ]), + "retention_message_id": .object([ + "type": .array([.string("string"), .string("null")]), + "description": .string("Retention message ID to assign, or null when clearing") + ]), + "clear": .object([ + "type": .string("boolean"), + "description": .string("Set to true to clear the assigned retention message from the subscription") + ]) + ]), + "required": .array([.string("subscription_id")]) + ]) + ) + } + + private func addRetentionMessageOffersTool() -> Tool { + Tool( + name: "subscriptions_add_retention_message_offers", + description: "Attach retention offers to a subscription's retention message configuration", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "subscription_id": .object([ + "type": .string("string"), + "description": .string("Subscription ID") + ]), + "offer_ids": .object([ + "type": .string("array"), + "description": .string("Retention offer IDs to attach"), + "minItems": .int(1), + "uniqueItems": .bool(true), + "items": .object([ + "type": .string("string") + ]) + ]) + ]), + "required": .array([.string("subscription_id"), .string("offer_ids")]) + ]) + ) + } + + private func removeRetentionMessageOffersTool() -> Tool { + Tool( + name: "subscriptions_remove_retention_message_offers", + description: "Remove retention offers from a subscription's retention message configuration", + inputSchema: .object([ + "type": .string("object"), + "properties": .object([ + "subscription_id": .object([ + "type": .string("string"), + "description": .string("Subscription ID") + ]), + "offer_ids": .object([ + "type": .string("array"), + "description": .string("Retention offer IDs to remove"), + "minItems": .int(1), + "uniqueItems": .bool(true), + "items": .object([ + "type": .string("string") + ]) + ]) + ]), + "required": .array([.string("subscription_id"), .string("offer_ids")]) + ]) + ) + } +} diff --git a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker.swift b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker.swift index c76c047..9fc37d4 100644 --- a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker.swift +++ b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker.swift @@ -86,7 +86,7 @@ public final class SubscriptionsWorker: Sendable { deleteSubscriptionReviewScreenshotTool(), listSubscriptionImagesTool(), getSubscriptionReviewScreenshotForSubscriptionTool() - ] + v3CommerceTools() + subscriptionPlanAvailabilityTools() + versionedMetadataTools() + ] + v3CommerceTools() + subscriptionPlanAvailabilityTools() + versionedMetadataTools() + retentionMessagingTools() } /// Handle tool calls (for WorkerManager routing) @@ -278,6 +278,52 @@ public final class SubscriptionsWorker: Sendable { return try await updateSubscriptionGroupVersionLocalization(params) case "subscriptions_delete_group_version_localization": return try await deleteSubscriptionGroupVersionLocalization(params) + case "subscriptions_list_retention_messages": + return await listRetentionMessages(params) + case "subscriptions_get_retention_message": + return await getRetentionMessage(params) + case "subscriptions_create_retention_message": + return await createRetentionMessage(params) + case "subscriptions_delete_retention_message": + return await deleteRetentionMessage(params) + case "subscriptions_list_retention_message_versions": + return await listRetentionMessageVersions(params) + case "subscriptions_get_retention_message_version": + return await getRetentionMessageVersion(params) + case "subscriptions_create_retention_message_version": + return await createRetentionMessageVersion(params) + case "subscriptions_list_retention_message_localizations": + return await listRetentionMessageLocalizations(params) + case "subscriptions_get_retention_message_localization": + return await getRetentionMessageLocalization(params) + case "subscriptions_create_retention_message_localization": + return await createRetentionMessageLocalization(params) + case "subscriptions_update_retention_message_localization": + return await updateRetentionMessageLocalization(params) + case "subscriptions_delete_retention_message_localization": + return await deleteRetentionMessageLocalization(params) + case "subscriptions_list_retention_message_subscriptions": + return await listRetentionMessageSubscriptions(params) + case "subscriptions_list_retention_offers": + return await listRetentionOffers(params) + case "subscriptions_get_retention_offer": + return await getRetentionOffer(params) + case "subscriptions_create_retention_offer": + return await createRetentionOffer(params) + case "subscriptions_update_retention_offer": + return await updateRetentionOffer(params) + case "subscriptions_delete_retention_offer": + return await deleteRetentionOffer(params) + case "subscriptions_list_retention_offer_prices": + return await listRetentionOfferPrices(params) + case "subscriptions_get_retention_message_for_subscription": + return await getRetentionMessageForSubscription(params) + case "subscriptions_set_retention_message": + return await setRetentionMessage(params) + case "subscriptions_add_retention_message_offers": + return await addRetentionMessageOffers(params) + case "subscriptions_remove_retention_message_offers": + return await removeRetentionMessageOffers(params) case "subscriptions_list_intro_offers", "subscriptions_create_intro_offer", "subscriptions_update_intro_offer", diff --git a/Tests/ASCMCPTests/Docs/ASCCoverageInventoryTests.swift b/Tests/ASCMCPTests/Docs/ASCCoverageInventoryTests.swift index 04d5bba..5fafa4a 100644 --- a/Tests/ASCMCPTests/Docs/ASCCoverageInventoryTests.swift +++ b/Tests/ASCMCPTests/Docs/ASCCoverageInventoryTests.swift @@ -10,7 +10,7 @@ struct ASCCoverageInventoryTests { let names = Set(areas.map(\.name)) #expect(ASCCoverageInventory.snapshotDate == "2026-10-15") - #expect(ASCCoverageInventory.appleAPIVersionBaseline == "4.5.1") + #expect(ASCCoverageInventory.appleAPIVersionBaseline == "4.6") #expect(areas.count == names.count) #expect(areas.count >= 10) @@ -36,6 +36,9 @@ struct ASCCoverageInventoryTests { #expect(commerce.coveredCapabilities.contains { $0.contains("paginated plural version-owned IAP review images") }) + #expect(commerce.coveredCapabilities.contains { + $0.contains("subscription retention messaging") + }) #expect(commerce.missingCapabilities.contains("authoritative fully paginated subscription inventory")) } diff --git a/Tests/ASCMCPTests/Docs/READMEWorkerCountsTests.swift b/Tests/ASCMCPTests/Docs/READMEWorkerCountsTests.swift index f6aa8dc..5e05763 100644 --- a/Tests/ASCMCPTests/Docs/READMEWorkerCountsTests.swift +++ b/Tests/ASCMCPTests/Docs/READMEWorkerCountsTests.swift @@ -13,7 +13,7 @@ struct READMEWorkerCountsTests { let snapshots = try await TestFactory.collectWorkerToolSnapshots() let totalTools = snapshots.reduce(0) { $0 + $1.count } - #expect(totalTools == 514) + #expect(totalTools == 537) #expect(snapshots.count == 36) #expect(readme.contains("**\(totalTools) tools**")) #expect(readme.contains("34 App Store tool domains + 2 core domains")) diff --git a/Tests/ASCMCPTests/Fixtures/OpenAPI/api-4.6-operation-decisions.json b/Tests/ASCMCPTests/Fixtures/OpenAPI/api-4.6-operation-decisions.json new file mode 100644 index 0000000..aec2578 --- /dev/null +++ b/Tests/ASCMCPTests/Fixtures/OpenAPI/api-4.6-operation-decisions.json @@ -0,0 +1,244 @@ +{ + "baselineVersion": "4.5.1", + "version": "4.6", + "operations": [ + { + "operationId": "apps_retentionMessages_getToManyRelated", + "method": "GET", + "path": "/v1/apps/{id}/retentionMessages", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "apps_retentionMessages_getToManyRelationship", + "method": "GET", + "path": "/v1/apps/{id}/relationships/retentionMessages", + "decision": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented." + }, + { + "operationId": "retentionMessageLocalizations_createInstance", + "method": "POST", + "path": "/v1/retentionMessageLocalizations", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessageLocalizations_deleteInstance", + "method": "DELETE", + "path": "/v1/retentionMessageLocalizations/{id}", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessageLocalizations_getInstance", + "method": "GET", + "path": "/v1/retentionMessageLocalizations/{id}", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessageLocalizations_updateInstance", + "method": "PATCH", + "path": "/v1/retentionMessageLocalizations/{id}", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessageVersions_createInstance", + "method": "POST", + "path": "/v1/retentionMessageVersions", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessageVersions_getInstance", + "method": "GET", + "path": "/v1/retentionMessageVersions/{id}", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessageVersions_localizations_getToManyRelated", + "method": "GET", + "path": "/v1/retentionMessageVersions/{id}/localizations", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessageVersions_localizations_getToManyRelationship", + "method": "GET", + "path": "/v1/retentionMessageVersions/{id}/relationships/localizations", + "decision": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented." + }, + { + "operationId": "retentionMessageVersions_placement_getToOneRelated", + "method": "GET", + "path": "/v1/retentionMessageVersions/{id}/placement", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessageVersions_placement_getToOneRelationship", + "method": "GET", + "path": "/v1/retentionMessageVersions/{id}/relationships/placement", + "decision": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented." + }, + { + "operationId": "retentionMessages_createInstance", + "method": "POST", + "path": "/v1/retentionMessages", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessages_deleteInstance", + "method": "DELETE", + "path": "/v1/retentionMessages/{id}", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessages_getInstance", + "method": "GET", + "path": "/v1/retentionMessages/{id}", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessages_subscriptions_getToManyRelated", + "method": "GET", + "path": "/v1/retentionMessages/{id}/subscriptions", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessages_subscriptions_getToManyRelationship", + "method": "GET", + "path": "/v1/retentionMessages/{id}/relationships/subscriptions", + "decision": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented." + }, + { + "operationId": "retentionMessages_versions_getToManyRelated", + "method": "GET", + "path": "/v1/retentionMessages/{id}/versions", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionMessages_versions_getToManyRelationship", + "method": "GET", + "path": "/v1/retentionMessages/{id}/relationships/versions", + "decision": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented." + }, + { + "operationId": "retentionOffers_createInstance", + "method": "POST", + "path": "/v1/retentionOffers", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionOffers_deleteInstance", + "method": "DELETE", + "path": "/v1/retentionOffers/{id}", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionOffers_getInstance", + "method": "GET", + "path": "/v1/retentionOffers/{id}", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionOffers_prices_getToManyRelated", + "method": "GET", + "path": "/v1/retentionOffers/{id}/prices", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "retentionOffers_prices_getToManyRelationship", + "method": "GET", + "path": "/v1/retentionOffers/{id}/relationships/prices", + "decision": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented." + }, + { + "operationId": "retentionOffers_updateInstance", + "method": "PATCH", + "path": "/v1/retentionOffers/{id}", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "subscriptions_retentionMessageOffers_createToManyRelationship", + "method": "POST", + "path": "/v1/subscriptions/{id}/relationships/retentionMessageOffers", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "subscriptions_retentionMessageOffers_deleteToManyRelationship", + "method": "DELETE", + "path": "/v1/subscriptions/{id}/relationships/retentionMessageOffers", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "subscriptions_retentionMessageOffers_getToManyRelated", + "method": "GET", + "path": "/v1/subscriptions/{id}/retentionMessageOffers", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "subscriptions_retentionMessageOffers_getToManyRelationship", + "method": "GET", + "path": "/v1/subscriptions/{id}/relationships/retentionMessageOffers", + "decision": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented." + }, + { + "operationId": "subscriptions_retentionMessage_getToOneRelated", + "method": "GET", + "path": "/v1/subscriptions/{id}/retentionMessage", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "subscriptions_retentionMessage_getToOneRelationship", + "method": "GET", + "path": "/v1/subscriptions/{id}/relationships/retentionMessage", + "decision": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented." + }, + { + "operationId": "subscriptions_retentionMessage_updateToOneRelationship", + "method": "PATCH", + "path": "/v1/subscriptions/{id}/relationships/retentionMessage", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "subscriptions_retentionOffers_getToManyRelated", + "method": "GET", + "path": "/v1/subscriptions/{id}/retentionOffers", + "decision": "requiredMapping", + "reason": "Must be bound to implemented Retention Messaging or Asset Library tools." + }, + { + "operationId": "subscriptions_retentionOffers_getToManyRelationship", + "method": "GET", + "path": "/v1/subscriptions/{id}/relationships/retentionOffers", + "decision": "unsupported", + "reason": "The relationship-only endpoint duplicates IDs exposed by the corresponding related-resource read; no separate relationship-ID tool or invocation is implemented." + } + ] +} diff --git a/Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.5.1.provenance.json b/Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.5.1.provenance.json deleted file mode 100644 index 2363d3d..0000000 --- a/Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.5.1.provenance.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "version": "4.5.1", - "sourceURL": "https://developer.apple.com/sample-code/app-store-connect/app-store-connect-openapi-specification.zip", - "retrievedAt": "2026-10-15", - "sha256": "7518d3a94a8bd701ac25c1c601b95b8f53aad92091affb15a2a9d331713dac1a", - "pathCount": 1001, - "operationCount": 1303, - "releaseNotes": [ - "https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-4-5-release-notes", - "https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-4-5-1-release-notes" - ] -} diff --git a/Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.5.1.oas.json b/Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.6.oas.json similarity index 97% rename from Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.5.1.oas.json rename to Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.6.oas.json index 2afe090..8324a41 100644 --- a/Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.5.1.oas.json +++ b/Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.6.oas.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "App Store Connect API", - "version": "4.5.1", + "version": "4.6", "x-platforms": { "app_store_connect_api": "App Store Connect API" } @@ -3268,7 +3268,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -3569,7 +3570,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -3823,7 +3825,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -3986,327 +3989,41 @@ "required": false }, { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" - ] - } - }, - "style": "form", - "explode": false, - "required": false - } - ], - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Single AppAssetLibraryPlacement", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppAssetLibraryPlacementResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "AppAssetLibraryPlacements" - ], - "operationId": "appAssetLibraryPlacements_deleteInstance", - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "Success (no content)" - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appAssetLibraryRefData": { - "get": { - "tags": [ - "AppAssetLibraryRefData" - ], - "operationId": "appAssetLibraryRefData_getCollection", - "parameters": [ - { - "name": "filter[placementTypes]", - "in": "query", - "description": "filter by attribute 'placementTypes'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "filter[placementProfileGroups]", - "in": "query", - "description": "filter by attribute 'placementProfileGroups'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "filter[features]", - "in": "query", - "description": "filter by attribute 'features'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "filter[specs]", + "name": "fields[retentionMessageVersions]", "in": "query", - "description": "filter by specs", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[appAssetLibraryRefData]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryRefData", + "description": "the fields to include for returned resources of type retentionMessageVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "features", - "placementProfileGroups", - "imageSpecs", - "videoSpecs", - "placementTypes", - "displayClasses" + "state", + "retentionMessage", + "localizations", + "placement" ] } }, "style": "form", "explode": false, "required": false - } - ], - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "List of AppAssetLibraryRefData", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppAssetLibraryRefDataResponse" - } - } - } }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/v1/appAssetLibraryRefData/{id}": { - "get": { - "tags": [ - "AppAssetLibraryRefData" - ], - "operationId": "appAssetLibraryRefData_getInstance", - "parameters": [ { - "name": "fields[appAssetLibraryRefData]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryRefData", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "features", - "placementProfileGroups", - "imageSpecs", - "videoSpecs", - "placementTypes", - "displayClasses" + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -4357,11 +4074,11 @@ } }, "200": { - "description": "Single AppAssetLibraryRefDatum", + "description": "Single AppAssetLibraryPlacement", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryRefDatumResponse" + "$ref": "#/components/schemas/AppAssetLibraryPlacementResponse" } } } @@ -4378,36 +4095,343 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appAssetLibraryVideos": { - "post": { + "delete": { "tags": [ - "AppAssetLibraryVideos" + "AppAssetLibraryPlacements" ], - "operationId": "appAssetLibraryVideos_createInstance", - "requestBody": { - "description": "AppAssetLibraryVideo representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppAssetLibraryVideoCreateRequest" - } - } - }, - "required": true - }, + "operationId": "appAssetLibraryPlacements_deleteInstance", + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "Success (no content)" + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraryRefData": { + "get": { + "tags": [ + "AppAssetLibraryRefData" + ], + "operationId": "appAssetLibraryRefData_getCollection", + "parameters": [ + { + "name": "filter[placementTypes]", + "in": "query", + "description": "filter by attribute 'placementTypes'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "filter[placementProfileGroups]", + "in": "query", + "description": "filter by attribute 'placementProfileGroups'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "filter[features]", + "in": "query", + "description": "filter by attribute 'features'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "filter[specs]", + "in": "query", + "description": "filter by specs", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[appAssetLibraryRefData]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryRefData", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "features", + "placementProfileGroups", + "imageSpecs", + "videoSpecs", + "placementTypes", + "displayClasses" + ] + } + }, + "style": "form", + "explode": false, + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of AppAssetLibraryRefData", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryRefDataResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/appAssetLibraryRefData/{id}": { + "get": { + "tags": [ + "AppAssetLibraryRefData" + ], + "operationId": "appAssetLibraryRefData_getInstance", + "parameters": [ + { + "name": "fields[appAssetLibraryRefData]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryRefData", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "features", + "placementProfileGroups", + "imageSpecs", + "videoSpecs", + "placementTypes", + "displayClasses" + ] + } + }, + "style": "form", + "explode": false, + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single AppAssetLibraryRefDatum", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryRefDatumResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appAssetLibraryVideos": { + "post": { + "tags": [ + "AppAssetLibraryVideos" + ], + "operationId": "appAssetLibraryVideos_createInstance", + "requestBody": { + "description": "AppAssetLibraryVideo representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryVideoCreateRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -4540,7 +4564,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -7724,6 +7749,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -8087,7 +8113,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -8926,6 +8953,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -9672,6 +9700,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -10036,6 +10065,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -10462,7 +10492,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -12469,6 +12500,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -13659,6 +13691,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -13962,6 +13995,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -15929,7 +15963,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -16732,6 +16767,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -17789,7 +17825,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -18802,6 +18839,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -19771,6 +19809,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -20209,6 +20248,25 @@ "explode": false, "required": false }, + { + "name": "fields[retentionMessages]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "referenceName", + "versions", + "subscriptions" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, { "name": "fields[gameCenterEnabledVersions]", "in": "query", @@ -20463,6 +20521,7 @@ "endUserLicenseAgreement", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "appCustomProductPages", "inAppPurchasesV2", @@ -20658,6 +20717,17 @@ "style": "form", "required": false }, + { + "name": "limit[retentionMessages]", + "in": "query", + "description": "maximum number of related retentionMessages returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, { "name": "limit[reviewSubmissions]", "in": "query", @@ -20784,6 +20854,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -21222,6 +21293,25 @@ "explode": false, "required": false }, + { + "name": "fields[retentionMessages]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "referenceName", + "versions", + "subscriptions" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, { "name": "fields[gameCenterEnabledVersions]", "in": "query", @@ -21466,6 +21556,7 @@ "endUserLicenseAgreement", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "appCustomProductPages", "inAppPurchasesV2", @@ -21662,9 +21753,9 @@ "required": false }, { - "name": "limit[reviewSubmissions]", + "name": "limit[retentionMessages]", "in": "query", - "description": "maximum number of related reviewSubmissions returned (when they are included)", + "description": "maximum number of related retentionMessages returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -21673,312 +21764,323 @@ "required": false }, { - "name": "limit[subscriptionGroups]", + "name": "limit[reviewSubmissions]", "in": "query", - "description": "maximum number of related subscriptionGroups returned (when they are included)", + "description": "maximum number of related reviewSubmissions 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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/backgroundAssetUploadFiles": { - "post": { - "tags": [ - "BackgroundAssetUploadFiles" - ], - "operationId": "backgroundAssetUploadFiles_createInstance", - "requestBody": { - "description": "BackgroundAssetUploadFile representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BackgroundAssetUploadFileCreateRequest" - } - } - }, - "required": true - }, - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "201": { - "description": "Single BackgroundAssetUploadFile", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BackgroundAssetUploadFileResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/v1/backgroundAssetUploadFiles/{id}": { - "get": { - "tags": [ - "BackgroundAssetUploadFiles" - ], - "operationId": "backgroundAssetUploadFiles_getInstance", - "parameters": [ { - "name": "fields[backgroundAssetUploadFiles]", + "name": "limit[subscriptionGroups]", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssetUploadFiles", + "description": "maximum number of related subscriptionGroups returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "assetDeliveryState", - "assetToken", - "assetType", - "fileName", - "fileSize", - "sourceFileChecksum", - "sourceFileChecksums", - "uploadOperations" - ] - } + "type": "integer", + "maximum": 50 }, "style": "form", - "explode": false, + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single App", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/backgroundAssetUploadFiles": { + "post": { + "tags": [ + "BackgroundAssetUploadFiles" + ], + "operationId": "backgroundAssetUploadFiles_createInstance", + "requestBody": { + "description": "BackgroundAssetUploadFile representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BackgroundAssetUploadFileCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Single BackgroundAssetUploadFile", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BackgroundAssetUploadFileResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/backgroundAssetUploadFiles/{id}": { + "get": { + "tags": [ + "BackgroundAssetUploadFiles" + ], + "operationId": "backgroundAssetUploadFiles_getInstance", + "parameters": [ + { + "name": "fields[backgroundAssetUploadFiles]", + "in": "query", + "description": "the fields to include for returned resources of type backgroundAssetUploadFiles", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "assetDeliveryState", + "assetToken", + "assetType", + "fileName", + "fileSize", + "sourceFileChecksum", + "sourceFileChecksums", + "uploadOperations" + ] + } + }, + "style": "form", + "explode": false, "required": false } ], @@ -23095,6 +23197,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -24115,6 +24218,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -24389,6 +24493,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -24762,6 +24867,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -24949,6 +25055,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -27054,6 +27161,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -27448,6 +27556,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -27924,6 +28033,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -28104,6 +28214,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -28989,6 +29100,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -29375,6 +29487,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -31330,6 +31443,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -31896,6 +32010,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -32816,6 +32931,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -33159,6 +33275,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -35258,6 +35375,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -35506,6 +35624,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -37834,6 +37953,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -46273,6 +46393,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -61755,6 +61876,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -63952,6 +64074,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -64349,6 +64472,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -65607,6 +65731,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -65843,6 +65968,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -66847,7 +66973,10 @@ "winBackOffers", "images", "planAvailabilities", - "versions" + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -67110,18 +67239,18 @@ } ] }, - "/v1/reviewSubmissionItems": { + "/v1/retentionMessageLocalizations": { "post": { "tags": [ - "ReviewSubmissionItems" + "RetentionMessageLocalizations" ], - "operationId": "reviewSubmissionItems_createInstance", + "operationId": "retentionMessageLocalizations_createInstance", "requestBody": { - "description": "ReviewSubmissionItem representation", + "description": "RetentionMessageLocalization representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReviewSubmissionItemCreateRequest" + "$ref": "#/components/schemas/RetentionMessageLocalizationCreateRequest" } } }, @@ -67169,11 +67298,11 @@ } }, "201": { - "description": "Single ReviewSubmissionItem", + "description": "Single RetentionMessageLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReviewSubmissionItemResponse" + "$ref": "#/components/schemas/RetentionMessageLocalizationResponse" } } } @@ -67201,18 +67330,145 @@ } } }, - "/v1/reviewSubmissionItems/{id}": { + "/v1/retentionMessageLocalizations/{id}": { + "get": { + "tags": [ + "RetentionMessageLocalizations" + ], + "operationId": "retentionMessageLocalizations_getInstance", + "parameters": [ + { + "name": "fields[retentionMessageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "header", + "body", + "retentionMessageVersion" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[retentionMessageVersions]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessageVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "state", + "retentionMessage", + "localizations", + "placement" + ] + } + }, + "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": [ + "retentionMessageVersion" + ] + } + }, + "style": "form", + "explode": false, + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single RetentionMessageLocalization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetentionMessageLocalizationResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, "patch": { "tags": [ - "ReviewSubmissionItems" + "RetentionMessageLocalizations" ], - "operationId": "reviewSubmissionItems_updateInstance", + "operationId": "retentionMessageLocalizations_updateInstance", "requestBody": { - "description": "ReviewSubmissionItem representation", + "description": "RetentionMessageLocalization representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReviewSubmissionItemUpdateRequest" + "$ref": "#/components/schemas/RetentionMessageLocalizationUpdateRequest" } } }, @@ -67270,11 +67526,11 @@ } }, "200": { - "description": "Single ReviewSubmissionItem", + "description": "Single RetentionMessageLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReviewSubmissionItemResponse" + "$ref": "#/components/schemas/RetentionMessageLocalizationResponse" } } } @@ -67303,9 +67559,9 @@ }, "delete": { "tags": [ - "ReviewSubmissionItems" + "RetentionMessageLocalizations" ], - "operationId": "reviewSubmissionItems_deleteInstance", + "operationId": "retentionMessageLocalizations_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -67375,160 +67631,117 @@ } ] }, - "/v1/reviewSubmissions": { - "get": { + "/v1/retentionMessageVersions": { + "post": { "tags": [ - "ReviewSubmissions" + "RetentionMessageVersions" ], - "operationId": "reviewSubmissions_getCollection", - "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" - ] + "operationId": "retentionMessageVersions_createInstance", + "requestBody": { + "description": "RetentionMessageVersion representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetentionMessageVersionCreateRequest" } - }, - "style": "form", - "explode": false, - "required": 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" - ] + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false, - "required": false + } }, - { - "name": "filter[app]", - "in": "query", - "description": "filter by id(s) of related 'app'", - "schema": { - "type": "array", - "items": { - "type": "string" + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false, - "required": true + } }, - { - "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" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false, - "required": false + } + }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, + "201": { + "description": "Single RetentionMessageVersion", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RetentionMessageVersionResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/retentionMessageVersions/{id}": { + "get": { + "tags": [ + "RetentionMessageVersions" + ], + "operationId": "retentionMessageVersions_getInstance", + "parameters": [ { - "name": "fields[apps]", + "name": "fields[retentionMessageVersions]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "the fields to include for returned resources of type retentionMessageVersions", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" + "state", + "retentionMessage", + "localizations", + "placement" ] } }, @@ -67537,31 +67750,17 @@ "required": false }, { - "name": "fields[reviewSubmissionItems]", + "name": "fields[retentionMessages]", "in": "query", - "description": "the fields to include for returned resources of type reviewSubmissionItems", + "description": "the fields to include for returned resources of type retentionMessages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "state", - "appStoreVersion", - "appCustomProductPageVersion", - "appStoreVersionExperiment", - "appStoreVersionExperimentV2", - "appEvent", - "appAssetLibraryImage", - "appAssetLibraryVideo", - "backgroundAssetVersion", - "gameCenterAchievementVersion", - "gameCenterActivityVersion", - "gameCenterChallengeVersion", - "gameCenterLeaderboardSetVersion", - "gameCenterLeaderboardVersion", - "inAppPurchaseVersion", - "subscriptionVersion", - "subscriptionGroupVersion" + "referenceName", + "versions", + "subscriptions" ] } }, @@ -67570,38 +67769,18 @@ "required": false }, { - "name": "fields[appStoreVersions]", + "name": "fields[retentionMessageLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "the fields to include for returned resources of type retentionMessageLocalizations", "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" + "locale", + "header", + "body", + "retentionMessageVersion" ] } }, @@ -67610,19 +67789,28 @@ "required": false }, { - "name": "fields[actors]", + "name": "fields[appAssetLibraryPlacements]", "in": "query", - "description": "the fields to include for returned resources of type actors", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "actorType", - "userFirstName", - "userLastName", - "userEmail", - "apiKeyId" + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -67630,16 +67818,6 @@ "explode": false, "required": false }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, { "name": "include", "in": "query", @@ -67649,11 +67827,9 @@ "items": { "type": "string", "enum": [ - "app", - "items", - "appStoreVersionForReview", - "submittedByActor", - "lastUpdatedByActor" + "retentionMessage", + "localizations", + "placement" ] } }, @@ -67662,9 +67838,9 @@ "required": false }, { - "name": "limit[items]", + "name": "limit[localizations]", "in": "query", - "description": "maximum number of related items returned (when they are included)", + "description": "maximum number of related localizations returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -67704,12 +67880,22 @@ } } }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { - "description": "List of ReviewSubmissions", + "description": "Single RetentionMessageVersion", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReviewSubmissionsResponse" + "$ref": "#/components/schemas/RetentionMessageVersionResponse" } } } @@ -67726,17 +67912,31 @@ } } }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/retentionMessages": { "post": { "tags": [ - "ReviewSubmissions" + "RetentionMessages" ], - "operationId": "reviewSubmissions_createInstance", + "operationId": "retentionMessages_createInstance", "requestBody": { - "description": "ReviewSubmission representation", + "description": "RetentionMessage representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReviewSubmissionCreateRequest" + "$ref": "#/components/schemas/RetentionMessageCreateRequest" } } }, @@ -67784,11 +67984,11 @@ } }, "201": { - "description": "Single ReviewSubmission", + "description": "Single RetentionMessage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReviewSubmissionResponse" + "$ref": "#/components/schemas/RetentionMessageResponse" } } } @@ -67816,103 +68016,25 @@ } } }, - "/v1/reviewSubmissions/{id}": { + "/v1/retentionMessages/{id}": { "get": { "tags": [ - "ReviewSubmissions" + "RetentionMessages" ], - "operationId": "reviewSubmissions_getInstance", + "operationId": "retentionMessages_getInstance", "parameters": [ { - "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[apps]", + "name": "fields[retentionMessages]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "the fields to include for returned resources of type retentionMessages", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" + "referenceName", + "versions", + "subscriptions" ] } }, @@ -67921,31 +68043,18 @@ "required": false }, { - "name": "fields[reviewSubmissionItems]", + "name": "fields[retentionMessageVersions]", "in": "query", - "description": "the fields to include for returned resources of type reviewSubmissionItems", + "description": "the fields to include for returned resources of type retentionMessageVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ "state", - "appStoreVersion", - "appCustomProductPageVersion", - "appStoreVersionExperiment", - "appStoreVersionExperimentV2", - "appEvent", - "appAssetLibraryImage", - "appAssetLibraryVideo", - "backgroundAssetVersion", - "gameCenterAchievementVersion", - "gameCenterActivityVersion", - "gameCenterChallengeVersion", - "gameCenterLeaderboardSetVersion", - "gameCenterLeaderboardVersion", - "inAppPurchaseVersion", - "subscriptionVersion", - "subscriptionGroupVersion" + "retentionMessage", + "localizations", + "placement" ] } }, @@ -67954,38 +68063,40 @@ "required": false }, { - "name": "fields[appStoreVersions]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "the fields to include for returned resources of type subscriptions", "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" + "name", + "productId", + "familySharable", + "state", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -67994,19 +68105,16 @@ "required": false }, { - "name": "fields[actors]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type actors", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "actorType", - "userFirstName", - "userLastName", - "userEmail", - "apiKeyId" + "versions", + "subscriptions" ] } }, @@ -68015,30 +68123,20 @@ "required": false }, { - "name": "include", + "name": "limit[subscriptions]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "maximum number of related subscriptions returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "app", - "items", - "appStoreVersionForReview", - "submittedByActor", - "lastUpdatedByActor" - ] - } + "type": "integer", + "maximum": 50 }, "style": "form", - "explode": false, "required": false }, { - "name": "limit[items]", + "name": "limit[versions]", "in": "query", - "description": "maximum number of related items returned (when they are included)", + "description": "maximum number of related versions returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -68089,11 +68187,11 @@ } }, "200": { - "description": "Single ReviewSubmission", + "description": "Single RetentionMessage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReviewSubmissionResponse" + "$ref": "#/components/schemas/RetentionMessageResponse" } } } @@ -68110,22 +68208,11 @@ } } }, - "patch": { + "delete": { "tags": [ - "ReviewSubmissions" + "RetentionMessages" ], - "operationId": "reviewSubmissions_updateInstance", - "requestBody": { - "description": "ReviewSubmission representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReviewSubmissionUpdateRequest" - } - } - }, - "required": true - }, + "operationId": "retentionMessages_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -68167,35 +68254,8 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Single ReviewSubmission", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReviewSubmissionResponse" - } - } - } - }, - "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", @@ -68222,18 +68282,18 @@ } ] }, - "/v1/routingAppCoverages": { + "/v1/retentionOffers": { "post": { "tags": [ - "RoutingAppCoverages" + "RetentionOffers" ], - "operationId": "routingAppCoverages_createInstance", + "operationId": "retentionOffers_createInstance", "requestBody": { - "description": "RoutingAppCoverage representation", + "description": "RetentionOffer representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RoutingAppCoverageCreateRequest" + "$ref": "#/components/schemas/RetentionOfferCreateRequest" } } }, @@ -68281,11 +68341,11 @@ } }, "201": { - "description": "Single RoutingAppCoverage", + "description": "Single RetentionOffer", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RoutingAppCoverageResponse" + "$ref": "#/components/schemas/RetentionOfferResponse" } } } @@ -68313,28 +68373,32 @@ } } }, - "/v1/routingAppCoverages/{id}": { + "/v1/retentionOffers/{id}": { "get": { "tags": [ - "RoutingAppCoverages" + "RetentionOffers" ], - "operationId": "routingAppCoverages_getInstance", + "operationId": "retentionOffers_getInstance", "parameters": [ { - "name": "fields[routingAppCoverages]", + "name": "fields[retentionOffers]", "in": "query", - "description": "the fields to include for returned resources of type routingAppCoverages", + "description": "the fields to include for returned resources of type retentionOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "uploadOperations", - "assetDeliveryState", - "appStoreVersion" + "referenceName", + "offerId", + "duration", + "offerMode", + "periodCount", + "customerEligibilityPaidSubscriptionDurationInMonths", + "customerEligibilityWaitBetweenOffersInMonths", + "targetSubscriptionPlanType", + "subscription", + "prices" ] } }, @@ -68343,38 +68407,58 @@ "required": false }, { - "name": "fields[appStoreVersions]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "the fields to include for returned resources of type subscriptions", "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" + "name", + "productId", + "familySharable", + "state", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[retentionOfferPrices]", + "in": "query", + "description": "the fields to include for returned resources of type retentionOfferPrices", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "territory", + "subscriptionPricePoint" ] } }, @@ -68391,13 +68475,25 @@ "items": { "type": "string", "enum": [ - "appStoreVersion" + "subscription", + "prices" ] } }, "style": "form", "explode": false, "required": false + }, + { + "name": "limit[prices]", + "in": "query", + "description": "maximum number of related prices returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false } ], "responses": { @@ -68442,11 +68538,11 @@ } }, "200": { - "description": "Single RoutingAppCoverage", + "description": "Single RetentionOffer", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RoutingAppCoverageResponse" + "$ref": "#/components/schemas/RetentionOfferResponse" } } } @@ -68465,15 +68561,15 @@ }, "patch": { "tags": [ - "RoutingAppCoverages" + "RetentionOffers" ], - "operationId": "routingAppCoverages_updateInstance", + "operationId": "retentionOffers_updateInstance", "requestBody": { - "description": "RoutingAppCoverage representation", + "description": "RetentionOffer representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RoutingAppCoverageUpdateRequest" + "$ref": "#/components/schemas/RetentionOfferUpdateRequest" } } }, @@ -68531,11 +68627,11 @@ } }, "200": { - "description": "Single RoutingAppCoverage", + "description": "Single RetentionOffer", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RoutingAppCoverageResponse" + "$ref": "#/components/schemas/RetentionOfferResponse" } } } @@ -68564,9 +68660,9 @@ }, "delete": { "tags": [ - "RoutingAppCoverages" + "RetentionOffers" ], - "operationId": "routingAppCoverages_deleteInstance", + "operationId": "retentionOffers_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -68636,123 +68732,23 @@ } ] }, - "/v1/salesReports": { - "get": { + "/v1/reviewSubmissionItems": { + "post": { "tags": [ - "SalesReports" + "ReviewSubmissionItems" ], - "operationId": "salesReports_getCollection", - "parameters": [ - { - "name": "filter[vendorNumber]", - "in": "query", - "description": "filter by attribute 'vendorNumber'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": true - }, - { - "name": "filter[reportType]", - "in": "query", - "description": "filter by attribute 'reportType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "SALES", - "PRE_ORDER", - "NEWSSTAND", - "SUBSCRIPTION", - "SUBSCRIPTION_EVENT", - "SUBSCRIBER", - "SUBSCRIPTION_OFFER_CODE_REDEMPTION", - "INSTALLS", - "FIRST_ANNUAL", - "WIN_BACK_ELIGIBILITY" - ] - } - }, - "style": "form", - "explode": false, - "required": true - }, - { - "name": "filter[reportSubType]", - "in": "query", - "description": "filter by attribute 'reportSubType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "SUMMARY", - "DETAILED", - "SUMMARY_INSTALL_TYPE", - "SUMMARY_TERRITORY", - "SUMMARY_CHANNEL" - ] - } - }, - "style": "form", - "explode": false, - "required": true - }, - { - "name": "filter[frequency]", - "in": "query", - "description": "filter by attribute 'frequency'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "DAILY", - "WEEKLY", - "MONTHLY", - "YEARLY" - ] - } - }, - "style": "form", - "explode": false, - "required": true - }, - { - "name": "filter[reportDate]", - "in": "query", - "description": "filter by attribute 'reportDate'", - "schema": { - "type": "array", - "items": { - "type": "string" + "operationId": "reviewSubmissionItems_createInstance", + "requestBody": { + "description": "ReviewSubmissionItem representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReviewSubmissionItemCreateRequest" } - }, - "style": "form", - "explode": false, - "required": false + } }, - { - "name": "filter[version]", - "in": "query", - "description": "filter by attribute 'version'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": false - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -68784,73 +68780,8 @@ } } }, - "200": { - "description": "List of SalesReports", - "content": { - "application/a-gzip": { - "schema": { - "$ref": "#/components/schemas/gzip" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/v2/sandboxTesters": { - "get": { - "tags": [ - "SandboxTesters" - ], - "operationId": "sandboxTestersV2_getCollection", - "parameters": [ - { - "name": "fields[sandboxTesters]", - "in": "query", - "description": "the fields to include for returned resources of type sandboxTesters", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "firstName", - "lastName", - "acAccountName", - "territory", - "applePayCompatible", - "interruptPurchases", - "subscriptionRenewalRate" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], - "responses": { - "400": { - "description": "Parameter error(s)", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { @@ -68859,18 +68790,18 @@ } } }, - "401": { - "description": "Unauthorized error(s)", + "201": { + "description": "Single ReviewSubmissionItem", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ReviewSubmissionItemResponse" } } } }, - "403": { - "description": "Forbidden error", + "409": { + "description": "Request entity error(s)", "content": { "application/json": { "schema": { @@ -68879,16 +68810,6 @@ } } }, - "200": { - "description": "List of SandboxTesters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SandboxTestersV2Response" - } - } - } - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -68902,18 +68823,18 @@ } } }, - "/v2/sandboxTesters/{id}": { + "/v1/reviewSubmissionItems/{id}": { "patch": { "tags": [ - "SandboxTesters" + "ReviewSubmissionItems" ], - "operationId": "sandboxTestersV2_updateInstance", + "operationId": "reviewSubmissionItems_updateInstance", "requestBody": { - "description": "SandboxTester representation", + "description": "ReviewSubmissionItem representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SandboxTesterV2UpdateRequest" + "$ref": "#/components/schemas/ReviewSubmissionItemUpdateRequest" } } }, @@ -68971,11 +68892,11 @@ } }, "200": { - "description": "Single SandboxTester", + "description": "Single ReviewSubmissionItem", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SandboxTesterV2Response" + "$ref": "#/components/schemas/ReviewSubmissionItemResponse" } } } @@ -69002,36 +68923,11 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v2/sandboxTestersClearPurchaseHistoryRequest": { - "post": { + "delete": { "tags": [ - "SandboxTestersClearPurchaseHistoryRequest" + "ReviewSubmissionItems" ], - "operationId": "sandboxTestersClearPurchaseHistoryRequestV2_createInstance", - "requestBody": { - "description": "SandboxTestersClearPurchaseHistoryRequest representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SandboxTestersClearPurchaseHistoryRequestV2CreateRequest" - } - } - }, - "required": true - }, + "operationId": "reviewSubmissionItems_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -69063,8 +68959,8 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", + "404": { + "description": "Not found error", "content": { "application/json": { "schema": { @@ -69073,25 +68969,8 @@ } } }, - "201": { - "description": "Single SandboxTestersClearPurchaseHistoryRequest", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SandboxTestersClearPurchaseHistoryRequestV2Response" - } - } - } - }, - "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", @@ -69104,29 +68983,175 @@ } } } - } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] }, - "/v1/scmGitReferences/{id}": { + "/v1/reviewSubmissions": { "get": { "tags": [ - "ScmGitReferences" + "ReviewSubmissions" ], - "operationId": "scmGitReferences_getInstance", + "operationId": "reviewSubmissions_getCollection", "parameters": [ { - "name": "fields[scmGitReferences]", + "name": "filter[platform]", "in": "query", - "description": "the fields to include for returned resources of type scmGitReferences", + "description": "filter by attribute 'platform'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "IOS", + "MAC_OS", + "TV_OS", + "VISION_OS" + ] + } + }, + "style": "form", + "explode": false, + "required": 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, + "required": false + }, + { + "name": "filter[app]", + "in": "query", + "description": "filter by id(s) of related 'app'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": true + }, + { + "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[apps]", + "in": "query", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "accessibilityUrl", "name", - "canonicalName", - "isDeleted", - "kind", - "repository" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, @@ -69135,23 +69160,93 @@ "required": false }, { - "name": "fields[scmRepositories]", + "name": "fields[reviewSubmissionItems]", "in": "query", - "description": "the fields to include for returned resources of type scmRepositories", + "description": "the fields to include for returned resources of type reviewSubmissionItems", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "lastAccessedDate", - "httpCloneUrl", - "sshCloneUrl", - "ownerName", - "repositoryName", - "scmProvider", - "defaultBranch", - "gitReferences", - "pullRequests" + "state", + "appStoreVersion", + "appCustomProductPageVersion", + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", + "backgroundAssetVersion", + "gameCenterAchievementVersion", + "gameCenterActivityVersion", + "gameCenterChallengeVersion", + "gameCenterLeaderboardSetVersion", + "gameCenterLeaderboardVersion", + "inAppPurchaseVersion", + "subscriptionVersion", + "subscriptionGroupVersion", + "retentionMessageVersion" + ] + } + }, + "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[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" ] } }, @@ -69159,6 +69254,16 @@ "explode": false, "required": false }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, { "name": "include", "in": "query", @@ -69168,13 +69273,28 @@ "items": { "type": "string", "enum": [ - "repository" + "app", + "items", + "appStoreVersionForReview", + "submittedByActor", + "lastUpdatedByActor" ] } }, "style": "form", "explode": false, "required": false + }, + { + "name": "limit[items]", + "in": "query", + "description": "maximum number of related items returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false } ], "responses": { @@ -69208,22 +69328,12 @@ } } }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { - "description": "Single ScmGitReference", + "description": "List of ReviewSubmissions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScmGitReferenceResponse" + "$ref": "#/components/schemas/ReviewSubmissionsResponse" } } } @@ -69240,56 +69350,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/scmProviders": { - "get": { + "post": { "tags": [ - "ScmProviders" + "ReviewSubmissions" ], - "operationId": "scmProviders_getCollection", - "parameters": [ - { - "name": "fields[scmProviders]", - "in": "query", - "description": "the fields to include for returned resources of type scmProviders", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "scmProviderType", - "url", - "repositories" - ] + "operationId": "reviewSubmissions_createInstance", + "requestBody": { + "description": "ReviewSubmission representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReviewSubmissionCreateRequest" } - }, - "style": "form", - "explode": false, - "required": false + } }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -69321,12 +69397,32 @@ } } }, - "200": { - "description": "List of ScmProviders", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScmProvidersResponse" + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Single ReviewSubmission", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReviewSubmissionResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -69344,137 +69440,30 @@ } } }, - "/v1/scmProviders/{id}": { - "get": { - "tags": [ - "ScmProviders" - ], - "operationId": "scmProviders_getInstance", - "parameters": [ - { - "name": "fields[scmProviders]", - "in": "query", - "description": "the fields to include for returned resources of type scmProviders", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "scmProviderType", - "url", - "repositories" - ] - } - }, - "style": "form", - "explode": false, - "required": false - } - ], - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Single ScmProvider", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScmProviderResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/scmPullRequests/{id}": { + "/v1/reviewSubmissions/{id}": { "get": { "tags": [ - "ScmPullRequests" + "ReviewSubmissions" ], - "operationId": "scmPullRequests_getInstance", + "operationId": "reviewSubmissions_getInstance", "parameters": [ { - "name": "fields[scmPullRequests]", + "name": "fields[reviewSubmissions]", "in": "query", - "description": "the fields to include for returned resources of type scmPullRequests", + "description": "the fields to include for returned resources of type reviewSubmissions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "title", - "number", - "webUrl", - "sourceRepositoryOwner", - "sourceRepositoryName", - "sourceBranchName", - "destinationRepositoryOwner", - "destinationRepositoryName", - "destinationBranchName", - "isClosed", - "isCrossRepository", - "repository" + "platform", + "submittedDate", + "state", + "app", + "items", + "appStoreVersionForReview", + "submittedByActor", + "lastUpdatedByActor" ] } }, @@ -69483,23 +69472,72 @@ "required": false }, { - "name": "fields[scmRepositories]", + "name": "fields[apps]", "in": "query", - "description": "the fields to include for returned resources of type scmRepositories", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "lastAccessedDate", - "httpCloneUrl", - "sshCloneUrl", - "ownerName", - "repositoryName", - "scmProvider", - "defaultBranch", - "gitReferences", - "pullRequests" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, @@ -69508,138 +69546,72 @@ "required": false }, { - "name": "include", + "name": "fields[reviewSubmissionItems]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type reviewSubmissionItems", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "repository" + "state", + "appStoreVersion", + "appCustomProductPageVersion", + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", + "backgroundAssetVersion", + "gameCenterAchievementVersion", + "gameCenterActivityVersion", + "gameCenterChallengeVersion", + "gameCenterLeaderboardSetVersion", + "gameCenterLeaderboardVersion", + "inAppPurchaseVersion", + "subscriptionVersion", + "subscriptionGroupVersion", + "retentionMessageVersion" ] } }, "style": "form", "explode": false, "required": false - } - ], - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Single ScmPullRequest", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScmPullRequestResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/scmRepositories": { - "get": { - "tags": [ - "ScmRepositories" - ], - "operationId": "scmRepositories_getCollection", - "parameters": [ - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": false }, { - "name": "fields[scmRepositories]", + "name": "fields[appStoreVersions]", "in": "query", - "description": "the fields to include for returned resources of type scmRepositories", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "lastAccessedDate", - "httpCloneUrl", - "sshCloneUrl", - "ownerName", - "repositoryName", - "scmProvider", - "defaultBranch", - "gitReferences", - "pullRequests" + "platform", + "versionString", + "appStoreState", + "appVersionState", + "copyright", + "reviewType", + "releaseType", + "earliestReleaseDate", + "usesIdfa", + "downloadable", + "createdDate", + "app", + "appStoreVersionLocalizations", + "build", + "appStoreVersionPhasedRelease", + "gameCenterAppVersion", + "routingAppCoverage", + "appStoreReviewDetail", + "appStoreVersionSubmission", + "appClipDefaultExperience", + "appStoreVersionExperiments", + "appStoreVersionExperimentsV2", + "customerReviews", + "alternativeDistributionPackage" ] } }, @@ -69648,17 +69620,19 @@ "required": false }, { - "name": "fields[scmProviders]", + "name": "fields[actors]", "in": "query", - "description": "the fields to include for returned resources of type scmProviders", + "description": "the fields to include for returned resources of type actors", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "scmProviderType", - "url", - "repositories" + "actorType", + "userFirstName", + "userLastName", + "userEmail", + "apiKeyId" ] } }, @@ -69667,19 +69641,19 @@ "required": false }, { - "name": "fields[scmGitReferences]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type scmGitReferences", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "canonicalName", - "isDeleted", - "kind", - "repository" + "app", + "items", + "appStoreVersionForReview", + "submittedByActor", + "lastUpdatedByActor" ] } }, @@ -69688,31 +69662,14 @@ "required": false }, { - "name": "limit", + "name": "limit[items]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related items returned (when they are included)", "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": [ - "scmProvider", - "defaultBranch" - ] - } + "maximum": 50 }, "style": "form", - "explode": false, "required": false } ], @@ -69747,12 +69704,22 @@ } } }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { - "description": "List of ScmRepositories", + "description": "Single ReviewSubmission", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScmRepositoriesResponse" + "$ref": "#/components/schemas/ReviewSubmissionResponse" } } } @@ -69768,99 +69735,23 @@ } } } - } - }, - "/v1/scmRepositories/{id}": { - "get": { + }, + "patch": { "tags": [ - "ScmRepositories" + "ReviewSubmissions" ], - "operationId": "scmRepositories_getInstance", - "parameters": [ - { - "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, - "required": false - }, - { - "name": "fields[scmProviders]", - "in": "query", - "description": "the fields to include for returned resources of type scmProviders", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "scmProviderType", - "url", - "repositories" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[scmGitReferences]", - "in": "query", - "description": "the fields to include for returned resources of type scmGitReferences", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "canonicalName", - "isDeleted", - "kind", - "repository" - ] + "operationId": "reviewSubmissions_updateInstance", + "requestBody": { + "description": "ReviewSubmission representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReviewSubmissionUpdateRequest" } - }, - "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": [ - "scmProvider", - "defaultBranch" - ] - } - }, - "style": "form", - "explode": false, - "required": false - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -69902,12 +69793,32 @@ } } }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { - "description": "Single ScmRepository", + "description": "Single ReviewSubmission", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScmRepositoryResponse" + "$ref": "#/components/schemas/ReviewSubmissionResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -69937,18 +69848,18 @@ } ] }, - "/v1/subscriptionAppStoreReviewScreenshots": { + "/v1/routingAppCoverages": { "post": { "tags": [ - "SubscriptionAppStoreReviewScreenshots" + "RoutingAppCoverages" ], - "operationId": "subscriptionAppStoreReviewScreenshots_createInstance", + "operationId": "routingAppCoverages_createInstance", "requestBody": { - "description": "SubscriptionAppStoreReviewScreenshot representation", + "description": "RoutingAppCoverage representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotCreateRequest" + "$ref": "#/components/schemas/RoutingAppCoverageCreateRequest" } } }, @@ -69996,11 +69907,11 @@ } }, "201": { - "description": "Single SubscriptionAppStoreReviewScreenshot", + "description": "Single RoutingAppCoverage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotResponse" + "$ref": "#/components/schemas/RoutingAppCoverageResponse" } } } @@ -70028,17 +69939,17 @@ } } }, - "/v1/subscriptionAppStoreReviewScreenshots/{id}": { + "/v1/routingAppCoverages/{id}": { "get": { "tags": [ - "SubscriptionAppStoreReviewScreenshots" + "RoutingAppCoverages" ], - "operationId": "subscriptionAppStoreReviewScreenshots_getInstance", + "operationId": "routingAppCoverages_getInstance", "parameters": [ { - "name": "fields[subscriptionAppStoreReviewScreenshots]", + "name": "fields[routingAppCoverages]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots", + "description": "the fields to include for returned resources of type routingAppCoverages", "schema": { "type": "array", "items": { @@ -70047,12 +69958,9 @@ "fileSize", "fileName", "sourceFileChecksum", - "imageAsset", - "assetToken", - "assetType", "uploadOperations", "assetDeliveryState", - "subscription" + "appStoreVersion" ] } }, @@ -70061,37 +69969,38 @@ "required": false }, { - "name": "fields[subscriptions]", + "name": "fields[appStoreVersions]", "in": "query", - "description": "the fields to include for returned resources of type subscriptions", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "familySharable", - "state", - "subscriptionPeriod", - "reviewNote", - "groupLevel", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" + "platform", + "versionString", + "appStoreState", + "appVersionState", + "copyright", + "reviewType", + "releaseType", + "earliestReleaseDate", + "usesIdfa", + "downloadable", + "createdDate", + "app", + "appStoreVersionLocalizations", + "build", + "appStoreVersionPhasedRelease", + "gameCenterAppVersion", + "routingAppCoverage", + "appStoreReviewDetail", + "appStoreVersionSubmission", + "appClipDefaultExperience", + "appStoreVersionExperiments", + "appStoreVersionExperimentsV2", + "customerReviews", + "alternativeDistributionPackage" ] } }, @@ -70108,7 +70017,7 @@ "items": { "type": "string", "enum": [ - "subscription" + "appStoreVersion" ] } }, @@ -70159,11 +70068,11 @@ } }, "200": { - "description": "Single SubscriptionAppStoreReviewScreenshot", + "description": "Single RoutingAppCoverage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotResponse" + "$ref": "#/components/schemas/RoutingAppCoverageResponse" } } } @@ -70182,15 +70091,15 @@ }, "patch": { "tags": [ - "SubscriptionAppStoreReviewScreenshots" + "RoutingAppCoverages" ], - "operationId": "subscriptionAppStoreReviewScreenshots_updateInstance", + "operationId": "routingAppCoverages_updateInstance", "requestBody": { - "description": "SubscriptionAppStoreReviewScreenshot representation", + "description": "RoutingAppCoverage representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotUpdateRequest" + "$ref": "#/components/schemas/RoutingAppCoverageUpdateRequest" } } }, @@ -70248,11 +70157,11 @@ } }, "200": { - "description": "Single SubscriptionAppStoreReviewScreenshot", + "description": "Single RoutingAppCoverage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotResponse" + "$ref": "#/components/schemas/RoutingAppCoverageResponse" } } } @@ -70281,9 +70190,9 @@ }, "delete": { "tags": [ - "SubscriptionAppStoreReviewScreenshots" + "RoutingAppCoverages" ], - "operationId": "subscriptionAppStoreReviewScreenshots_deleteInstance", + "operationId": "routingAppCoverages_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -70353,167 +70262,120 @@ } ] }, - "/v1/subscriptionAvailabilities": { - "post": { - "tags": [ - "SubscriptionAvailabilities" - ], - "operationId": "subscriptionAvailabilities_createInstance", - "deprecated": true, - "requestBody": { - "description": "SubscriptionAvailability representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionAvailabilityCreateRequest" - } - } - }, - "required": true - }, - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "201": { - "description": "Single SubscriptionAvailability", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionAvailabilityResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/v1/subscriptionAvailabilities/{id}": { + "/v1/salesReports": { "get": { "tags": [ - "SubscriptionAvailabilities" + "SalesReports" ], - "operationId": "subscriptionAvailabilities_getInstance", - "deprecated": true, + "operationId": "salesReports_getCollection", "parameters": [ { - "name": "fields[subscriptionAvailabilities]", + "name": "filter[vendorNumber]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionAvailabilities", + "description": "filter by attribute 'vendorNumber'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": true + }, + { + "name": "filter[reportType]", + "in": "query", + "description": "filter by attribute 'reportType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "availableInNewTerritories", - "availableTerritories" + "SALES", + "PRE_ORDER", + "NEWSSTAND", + "SUBSCRIPTION", + "SUBSCRIPTION_EVENT", + "SUBSCRIBER", + "SUBSCRIPTION_OFFER_CODE_REDEMPTION", + "INSTALLS", + "FIRST_ANNUAL", + "WIN_BACK_ELIGIBILITY" ] } }, "style": "form", "explode": false, - "required": false + "required": true }, { - "name": "fields[territories]", + "name": "filter[reportSubType]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "filter by attribute 'reportSubType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "SUMMARY", + "DETAILED", + "SUMMARY_INSTALL_TYPE", + "SUMMARY_TERRITORY", + "SUMMARY_CHANNEL" ] } }, "style": "form", "explode": false, - "required": false + "required": true }, { - "name": "include", + "name": "filter[frequency]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "filter by attribute 'frequency'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "availableTerritories" + "DAILY", + "WEEKLY", + "MONTHLY", + "YEARLY" ] } }, "style": "form", "explode": false, + "required": true + }, + { + "name": "filter[reportDate]", + "in": "query", + "description": "filter by attribute 'reportDate'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, "required": false }, { - "name": "limit[availableTerritories]", + "name": "filter[version]", "in": "query", - "description": "maximum number of related availableTerritories returned (when they are included)", + "description": "filter by attribute 'version'", "schema": { - "type": "integer", - "maximum": 50 + "type": "array", + "items": { + "type": "string" + } }, "style": "form", + "explode": false, "required": false } ], @@ -70548,22 +70410,12 @@ } } }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { - "description": "Single SubscriptionAvailability", + "description": "List of SalesReports", "content": { - "application/json": { + "application/a-gzip": { "schema": { - "$ref": "#/components/schemas/SubscriptionAvailabilityResponse" + "$ref": "#/components/schemas/gzip" } } } @@ -70579,46 +70431,47 @@ } } } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] + } }, - "/v1/subscriptionGracePeriods/{id}": { + "/v2/sandboxTesters": { "get": { "tags": [ - "SubscriptionGracePeriods" + "SandboxTesters" ], - "operationId": "subscriptionGracePeriods_getInstance", + "operationId": "sandboxTestersV2_getCollection", "parameters": [ { - "name": "fields[subscriptionGracePeriods]", + "name": "fields[sandboxTesters]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGracePeriods", + "description": "the fields to include for returned resources of type sandboxTesters", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "optIn", - "sandboxOptIn", - "duration", - "renewalType" + "firstName", + "lastName", + "acAccountName", + "territory", + "applePayCompatible", + "interruptPurchases", + "subscriptionRenewalRate" ] } }, "style": "form", "explode": false, "required": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" } ], "responses": { @@ -70652,22 +70505,12 @@ } } }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { - "description": "Single SubscriptionGracePeriod", + "description": "List of SandboxTesters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGracePeriodResponse" + "$ref": "#/components/schemas/SandboxTestersV2Response" } } } @@ -70683,18 +70526,20 @@ } } } - }, + } + }, + "/v2/sandboxTesters/{id}": { "patch": { "tags": [ - "SubscriptionGracePeriods" + "SandboxTesters" ], - "operationId": "subscriptionGracePeriods_updateInstance", + "operationId": "sandboxTestersV2_updateInstance", "requestBody": { - "description": "SubscriptionGracePeriod representation", + "description": "SandboxTester representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGracePeriodUpdateRequest" + "$ref": "#/components/schemas/SandboxTesterV2UpdateRequest" } } }, @@ -70752,11 +70597,11 @@ } }, "200": { - "description": "Single SubscriptionGracePeriod", + "description": "Single SandboxTester", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGracePeriodResponse" + "$ref": "#/components/schemas/SandboxTesterV2Response" } } } @@ -70796,18 +70641,18 @@ } ] }, - "/v2/subscriptionGroupLocalizations": { + "/v2/sandboxTestersClearPurchaseHistoryRequest": { "post": { "tags": [ - "SubscriptionGroupLocalizations" + "SandboxTestersClearPurchaseHistoryRequest" ], - "operationId": "subscriptionGroupLocalizationsV2_createInstance", + "operationId": "sandboxTestersClearPurchaseHistoryRequestV2_createInstance", "requestBody": { - "description": "SubscriptionGroupLocalization representation", + "description": "SandboxTestersClearPurchaseHistoryRequest representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationV2CreateRequest" + "$ref": "#/components/schemas/SandboxTestersClearPurchaseHistoryRequestV2CreateRequest" } } }, @@ -70855,11 +70700,11 @@ } }, "201": { - "description": "Single SubscriptionGroupLocalization", + "description": "Single SandboxTestersClearPurchaseHistoryRequest", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationV2Response" + "$ref": "#/components/schemas/SandboxTestersClearPurchaseHistoryRequestV2Response" } } } @@ -70887,26 +70732,27 @@ } } }, - "/v2/subscriptionGroupLocalizations/{id}": { + "/v1/scmGitReferences/{id}": { "get": { "tags": [ - "SubscriptionGroupLocalizations" + "ScmGitReferences" ], - "operationId": "subscriptionGroupLocalizationsV2_getInstance", + "operationId": "scmGitReferences_getInstance", "parameters": [ { - "name": "fields[subscriptionGroupLocalizations]", + "name": "fields[scmGitReferences]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupLocalizations", + "description": "the fields to include for returned resources of type scmGitReferences", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "customAppName", - "locale", - "version" + "canonicalName", + "isDeleted", + "kind", + "repository" ] } }, @@ -70915,18 +70761,23 @@ "required": false }, { - "name": "fields[subscriptionGroupVersions]", + "name": "fields[scmRepositories]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupVersions", + "description": "the fields to include for returned resources of type scmRepositories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "subscriptionGroup", - "localizations" + "lastAccessedDate", + "httpCloneUrl", + "sshCloneUrl", + "ownerName", + "repositoryName", + "scmProvider", + "defaultBranch", + "gitReferences", + "pullRequests" ] } }, @@ -70943,7 +70794,7 @@ "items": { "type": "string", "enum": [ - "version" + "repository" ] } }, @@ -70994,11 +70845,11 @@ } }, "200": { - "description": "Single SubscriptionGroupLocalization", + "description": "Single ScmGitReference", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationV2Response" + "$ref": "#/components/schemas/ScmGitReferenceResponse" } } } @@ -71015,110 +70866,56 @@ } } }, - "patch": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/scmProviders": { + "get": { "tags": [ - "SubscriptionGroupLocalizations" + "ScmProviders" ], - "operationId": "subscriptionGroupLocalizationsV2_updateInstance", - "requestBody": { - "description": "SubscriptionGroupLocalization representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationV2UpdateRequest" + "operationId": "scmProviders_getCollection", + "parameters": [ + { + "name": "fields[scmProviders]", + "in": "query", + "description": "the fields to include for returned resources of type scmProviders", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "scmProviderType", + "url", + "repositories" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "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 SubscriptionGroupLocalization", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationV2Response" - } - } - } - }, - "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" - } - } - } + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" } - } - }, - "delete": { - "tags": [ - "SubscriptionGroupLocalizations" ], - "operationId": "subscriptionGroupLocalizationsV2_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -71150,19 +70947,16 @@ } } }, - "404": { - "description": "Not found error", + "200": { + "description": "List of ScmProviders", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ScmProvidersResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -71174,37 +70968,35 @@ } } } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] + } }, - "/v1/subscriptionGroupLocalizations": { - "post": { + "/v1/scmProviders/{id}": { + "get": { "tags": [ - "SubscriptionGroupLocalizations" + "ScmProviders" ], - "operationId": "subscriptionGroupLocalizations_createInstance", - "requestBody": { - "description": "SubscriptionGroupLocalization representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationCreateRequest" + "operationId": "scmProviders_getInstance", + "parameters": [ + { + "name": "fields[scmProviders]", + "in": "query", + "description": "the fields to include for returned resources of type scmProviders", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "scmProviderType", + "url", + "repositories" + ] } - } - }, - "required": true - }, + }, + "style": "form", + "explode": false, + "required": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -71236,8 +71028,8 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", + "404": { + "description": "Not found error", "content": { "application/json": { "schema": { @@ -71246,22 +71038,12 @@ } } }, - "201": { - "description": "Single SubscriptionGroupLocalization", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Single ScmProvider", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ScmProviderResponse" } } } @@ -71277,29 +71059,48 @@ } } } - } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] }, - "/v1/subscriptionGroupLocalizations/{id}": { + "/v1/scmPullRequests/{id}": { "get": { "tags": [ - "SubscriptionGroupLocalizations" + "ScmPullRequests" ], - "operationId": "subscriptionGroupLocalizations_getInstance", + "operationId": "scmPullRequests_getInstance", "parameters": [ { - "name": "fields[subscriptionGroupLocalizations]", + "name": "fields[scmPullRequests]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupLocalizations", + "description": "the fields to include for returned resources of type scmPullRequests", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "customAppName", - "locale", - "state", - "subscriptionGroup" + "title", + "number", + "webUrl", + "sourceRepositoryOwner", + "sourceRepositoryName", + "sourceBranchName", + "destinationRepositoryOwner", + "destinationRepositoryName", + "destinationBranchName", + "isClosed", + "isCrossRepository", + "repository" ] } }, @@ -71308,18 +71109,23 @@ "required": false }, { - "name": "fields[subscriptionGroups]", + "name": "fields[scmRepositories]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroups", + "description": "the fields to include for returned resources of type scmRepositories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "subscriptions", - "subscriptionGroupLocalizations", - "versions" + "lastAccessedDate", + "httpCloneUrl", + "sshCloneUrl", + "ownerName", + "repositoryName", + "scmProvider", + "defaultBranch", + "gitReferences", + "pullRequests" ] } }, @@ -71336,7 +71142,7 @@ "items": { "type": "string", "enum": [ - "subscriptionGroup" + "repository" ] } }, @@ -71387,175 +71193,15 @@ } }, "200": { - "description": "Single SubscriptionGroupLocalization", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "patch": { - "tags": [ - "SubscriptionGroupLocalizations" - ], - "operationId": "subscriptionGroupLocalizations_updateInstance", - "requestBody": { - "description": "SubscriptionGroupLocalization representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationUpdateRequest" - } - } - }, - "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 SubscriptionGroupLocalization", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "SubscriptionGroupLocalizations" - ], - "operationId": "subscriptionGroupLocalizations_deleteInstance", - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found error", + "description": "Single ScmPullRequest", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ScmPullRequestResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -71581,114 +71227,121 @@ } ] }, - "/v1/subscriptionGroupSubmissions": { - "post": { + "/v1/scmRepositories": { + "get": { "tags": [ - "SubscriptionGroupSubmissions" + "ScmRepositories" ], - "operationId": "subscriptionGroupSubmissions_createInstance", - "requestBody": { - "description": "SubscriptionGroupSubmission representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupSubmissionCreateRequest" - } - } - }, - "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" - } + "operationId": "scmRepositories_getCollection", + "parameters": [ + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" } - } + }, + "style": "form", + "explode": false, + "required": false }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "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, + "required": false }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "fields[scmProviders]", + "in": "query", + "description": "the fields to include for returned resources of type scmProviders", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "scmProviderType", + "url", + "repositories" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "201": { - "description": "Single SubscriptionGroupSubmission", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupSubmissionResponse" - } + { + "name": "fields[scmGitReferences]", + "in": "query", + "description": "the fields to include for returned resources of type scmGitReferences", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "canonicalName", + "isDeleted", + "kind", + "repository" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "409": { - "description": "Request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "scmProvider", + "defaultBranch" + ] } - } + }, + "style": "form", + "explode": false, + "required": false } - } - } - }, - "/v1/subscriptionGroupVersions": { - "post": { - "tags": [ - "SubscriptionGroupVersions" ], - "operationId": "subscriptionGroupVersions_createInstance", - "requestBody": { - "description": "SubscriptionGroupVersion representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupVersionCreateRequest" - } - } - }, - "required": true - }, "responses": { "400": { "description": "Parameter error(s)", @@ -71720,32 +71373,12 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "201": { - "description": "Single SubscriptionGroupVersion", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupVersionResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of ScmRepositories", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ScmRepositoriesResponse" } } } @@ -71763,26 +71396,31 @@ } } }, - "/v1/subscriptionGroupVersions/{id}": { + "/v1/scmRepositories/{id}": { "get": { "tags": [ - "SubscriptionGroupVersions" + "ScmRepositories" ], - "operationId": "subscriptionGroupVersions_getInstance", + "operationId": "scmRepositories_getInstance", "parameters": [ { - "name": "fields[subscriptionGroupVersions]", + "name": "fields[scmRepositories]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupVersions", + "description": "the fields to include for returned resources of type scmRepositories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "subscriptionGroup", - "localizations" + "lastAccessedDate", + "httpCloneUrl", + "sshCloneUrl", + "ownerName", + "repositoryName", + "scmProvider", + "defaultBranch", + "gitReferences", + "pullRequests" ] } }, @@ -71791,18 +71429,17 @@ "required": false }, { - "name": "fields[subscriptionGroups]", + "name": "fields[scmProviders]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroups", + "description": "the fields to include for returned resources of type scmProviders", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "subscriptions", - "subscriptionGroupLocalizations", - "versions" + "scmProviderType", + "url", + "repositories" ] } }, @@ -71811,18 +71448,19 @@ "required": false }, { - "name": "fields[subscriptionGroupLocalizations]", + "name": "fields[scmGitReferences]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupLocalizations", + "description": "the fields to include for returned resources of type scmGitReferences", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "customAppName", - "locale", - "version" + "canonicalName", + "isDeleted", + "kind", + "repository" ] } }, @@ -71839,25 +71477,14 @@ "items": { "type": "string", "enum": [ - "subscriptionGroup", - "localizations" + "scmProvider", + "defaultBranch" ] } }, "style": "form", "explode": false, "required": false - }, - { - "name": "limit[localizations]", - "in": "query", - "description": "maximum number of related localizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false } ], "responses": { @@ -71902,11 +71529,11 @@ } }, "200": { - "description": "Single SubscriptionGroupVersion", + "description": "Single ScmRepository", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupVersionResponse" + "$ref": "#/components/schemas/ScmRepositoryResponse" } } } @@ -71936,18 +71563,18 @@ } ] }, - "/v1/subscriptionGroups": { + "/v1/subscriptionAppStoreReviewScreenshots": { "post": { "tags": [ - "SubscriptionGroups" + "SubscriptionAppStoreReviewScreenshots" ], - "operationId": "subscriptionGroups_createInstance", + "operationId": "subscriptionAppStoreReviewScreenshots_createInstance", "requestBody": { - "description": "SubscriptionGroup representation", + "description": "SubscriptionAppStoreReviewScreenshot representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupCreateRequest" + "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotCreateRequest" } } }, @@ -71995,11 +71622,11 @@ } }, "201": { - "description": "Single SubscriptionGroup", + "description": "Single SubscriptionAppStoreReviewScreenshot", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupResponse" + "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotResponse" } } } @@ -72027,26 +71654,31 @@ } } }, - "/v1/subscriptionGroups/{id}": { + "/v1/subscriptionAppStoreReviewScreenshots/{id}": { "get": { "tags": [ - "SubscriptionGroups" + "SubscriptionAppStoreReviewScreenshots" ], - "operationId": "subscriptionGroups_getInstance", + "operationId": "subscriptionAppStoreReviewScreenshots_getInstance", "parameters": [ { - "name": "fields[subscriptionGroups]", + "name": "fields[subscriptionAppStoreReviewScreenshots]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroups", + "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "subscriptions", - "subscriptionGroupLocalizations", - "versions" + "fileSize", + "fileName", + "sourceFileChecksum", + "imageAsset", + "assetToken", + "assetType", + "uploadOperations", + "assetDeliveryState", + "subscription" ] } }, @@ -72085,48 +71717,10 @@ "winBackOffers", "images", "planAvailabilities", - "versions" - ] - } - }, - "style": "form", - "explode": false, - "required": 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, - "required": false - }, - { - "name": "fields[subscriptionGroupVersions]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "subscriptionGroup", - "localizations" + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -72143,48 +71737,13 @@ "items": { "type": "string", "enum": [ - "subscriptions", - "subscriptionGroupLocalizations", - "versions" + "subscription" ] } }, "style": "form", "explode": false, "required": false - }, - { - "name": "limit[subscriptionGroupLocalizations]", - "in": "query", - "description": "maximum number of related subscriptionGroupLocalizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - }, - { - "name": "limit[subscriptions]", - "in": "query", - "description": "maximum number of related subscriptions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - }, - { - "name": "limit[versions]", - "in": "query", - "description": "maximum number of related versions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false } ], "responses": { @@ -72229,11 +71788,11 @@ } }, "200": { - "description": "Single SubscriptionGroup", + "description": "Single SubscriptionAppStoreReviewScreenshot", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupResponse" + "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotResponse" } } } @@ -72252,15 +71811,15 @@ }, "patch": { "tags": [ - "SubscriptionGroups" + "SubscriptionAppStoreReviewScreenshots" ], - "operationId": "subscriptionGroups_updateInstance", + "operationId": "subscriptionAppStoreReviewScreenshots_updateInstance", "requestBody": { - "description": "SubscriptionGroup representation", + "description": "SubscriptionAppStoreReviewScreenshot representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupUpdateRequest" + "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotUpdateRequest" } } }, @@ -72318,11 +71877,11 @@ } }, "200": { - "description": "Single SubscriptionGroup", + "description": "Single SubscriptionAppStoreReviewScreenshot", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupResponse" + "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotResponse" } } } @@ -72351,9 +71910,9 @@ }, "delete": { "tags": [ - "SubscriptionGroups" + "SubscriptionAppStoreReviewScreenshots" ], - "operationId": "subscriptionGroups_deleteInstance", + "operationId": "subscriptionAppStoreReviewScreenshots_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -72423,18 +71982,19 @@ } ] }, - "/v1/subscriptionImages": { + "/v1/subscriptionAvailabilities": { "post": { "tags": [ - "SubscriptionImages" + "SubscriptionAvailabilities" ], - "operationId": "subscriptionImages_createInstance", + "operationId": "subscriptionAvailabilities_createInstance", + "deprecated": true, "requestBody": { - "description": "SubscriptionImage representation", + "description": "SubscriptionAvailability representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImageCreateRequest" + "$ref": "#/components/schemas/SubscriptionAvailabilityCreateRequest" } } }, @@ -72482,11 +72042,11 @@ } }, "201": { - "description": "Single SubscriptionImage", + "description": "Single SubscriptionAvailability", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImageResponse" + "$ref": "#/components/schemas/SubscriptionAvailabilityResponse" } } } @@ -72514,30 +72074,25 @@ } } }, - "/v1/subscriptionImages/{id}": { + "/v1/subscriptionAvailabilities/{id}": { "get": { "tags": [ - "SubscriptionImages" + "SubscriptionAvailabilities" ], - "operationId": "subscriptionImages_getInstance", + "operationId": "subscriptionAvailabilities_getInstance", + "deprecated": true, "parameters": [ { - "name": "fields[subscriptionImages]", + "name": "fields[subscriptionAvailabilities]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionImages", + "description": "the fields to include for returned resources of type subscriptionAvailabilities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "assetToken", - "imageAsset", - "uploadOperations", - "state", - "subscription" + "availableInNewTerritories", + "availableTerritories" ] } }, @@ -72546,37 +72101,15 @@ "required": false }, { - "name": "fields[subscriptions]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type subscriptions", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "familySharable", - "state", - "subscriptionPeriod", - "reviewNote", - "groupLevel", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" + "currency" ] } }, @@ -72593,13 +72126,24 @@ "items": { "type": "string", "enum": [ - "subscription" + "availableTerritories" ] } }, "style": "form", "explode": false, "required": false + }, + { + "name": "limit[availableTerritories]", + "in": "query", + "description": "maximum number of related availableTerritories returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false } ], "responses": { @@ -72644,11 +72188,11 @@ } }, "200": { - "description": "Single SubscriptionImage", + "description": "Single SubscriptionAvailability", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImageResponse" + "$ref": "#/components/schemas/SubscriptionAvailabilityResponse" } } } @@ -72665,22 +72209,47 @@ } } }, - "patch": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/subscriptionGracePeriods/{id}": { + "get": { "tags": [ - "SubscriptionImages" + "SubscriptionGracePeriods" ], - "operationId": "subscriptionImages_updateInstance", - "requestBody": { - "description": "SubscriptionImage representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionImageUpdateRequest" + "operationId": "subscriptionGracePeriods_getInstance", + "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" + ] } - } - }, - "required": true - }, + }, + "style": "form", + "explode": false, + "required": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -72722,32 +72291,12 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { - "description": "Single SubscriptionImage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionImageResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "description": "Single SubscriptionGracePeriod", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/SubscriptionGracePeriodResponse" } } } @@ -72764,11 +72313,22 @@ } } }, - "delete": { + "patch": { "tags": [ - "SubscriptionImages" + "SubscriptionGracePeriods" ], - "operationId": "subscriptionImages_deleteInstance", + "operationId": "subscriptionGracePeriods_updateInstance", + "requestBody": { + "description": "SubscriptionGracePeriod representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionGracePeriodUpdateRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -72810,8 +72370,35 @@ } } }, - "204": { - "description": "Success (no content)" + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single SubscriptionGracePeriod", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionGracePeriodResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, "429": { "description": "Rate limit exceeded error", @@ -72838,18 +72425,18 @@ } ] }, - "/v2/subscriptionImages": { + "/v2/subscriptionGroupLocalizations": { "post": { "tags": [ - "SubscriptionImages" + "SubscriptionGroupLocalizations" ], - "operationId": "subscriptionImagesV2_createInstance", + "operationId": "subscriptionGroupLocalizationsV2_createInstance", "requestBody": { - "description": "SubscriptionImage representation", + "description": "SubscriptionGroupLocalization representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImageV2CreateRequest" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationV2CreateRequest" } } }, @@ -72897,11 +72484,11 @@ } }, "201": { - "description": "Single SubscriptionImage", + "description": "Single SubscriptionGroupLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImageV2Response" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationV2Response" } } } @@ -72929,28 +72516,63 @@ } } }, - "/v2/subscriptionImages/{id}": { + "/v2/subscriptionGroupLocalizations/{id}": { "get": { "tags": [ - "SubscriptionImages" + "SubscriptionGroupLocalizations" ], - "operationId": "subscriptionImagesV2_getInstance", + "operationId": "subscriptionGroupLocalizationsV2_getInstance", "parameters": [ { - "name": "fields[subscriptionImages]", + "name": "fields[subscriptionGroupLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionImages", + "description": "the fields to include for returned resources of type subscriptionGroupLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "assetToken", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "name", + "customAppName", + "locale", + "version" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[subscriptionGroupVersions]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionGroupVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "subscriptionGroup", + "localizations" + ] + } + }, + "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": [ + "version" ] } }, @@ -73001,11 +72623,11 @@ } }, "200": { - "description": "Single SubscriptionImage", + "description": "Single SubscriptionGroupLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImageV2Response" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationV2Response" } } } @@ -73024,15 +72646,15 @@ }, "patch": { "tags": [ - "SubscriptionImages" + "SubscriptionGroupLocalizations" ], - "operationId": "subscriptionImagesV2_updateInstance", + "operationId": "subscriptionGroupLocalizationsV2_updateInstance", "requestBody": { - "description": "SubscriptionImage representation", + "description": "SubscriptionGroupLocalization representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImageV2UpdateRequest" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationV2UpdateRequest" } } }, @@ -73090,11 +72712,11 @@ } }, "200": { - "description": "Single SubscriptionImage", + "description": "Single SubscriptionGroupLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImageV2Response" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationV2Response" } } } @@ -73123,9 +72745,9 @@ }, "delete": { "tags": [ - "SubscriptionImages" + "SubscriptionGroupLocalizations" ], - "operationId": "subscriptionImagesV2_deleteInstance", + "operationId": "subscriptionGroupLocalizationsV2_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -73195,18 +72817,18 @@ } ] }, - "/v1/subscriptionIntroductoryOffers": { + "/v1/subscriptionGroupLocalizations": { "post": { "tags": [ - "SubscriptionIntroductoryOffers" + "SubscriptionGroupLocalizations" ], - "operationId": "subscriptionIntroductoryOffers_createInstance", + "operationId": "subscriptionGroupLocalizations_createInstance", "requestBody": { - "description": "SubscriptionIntroductoryOffer representation", + "description": "SubscriptionGroupLocalization representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionIntroductoryOfferCreateRequest" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationCreateRequest" } } }, @@ -73254,11 +72876,11 @@ } }, "201": { - "description": "Single SubscriptionIntroductoryOffer", + "description": "Single SubscriptionGroupLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionIntroductoryOfferResponse" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationResponse" } } } @@ -73286,18 +72908,146 @@ } } }, - "/v1/subscriptionIntroductoryOffers/{id}": { + "/v1/subscriptionGroupLocalizations/{id}": { + "get": { + "tags": [ + "SubscriptionGroupLocalizations" + ], + "operationId": "subscriptionGroupLocalizations_getInstance", + "parameters": [ + { + "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, + "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", + "versions" + ] + } + }, + "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": [ + "subscriptionGroup" + ] + } + }, + "style": "form", + "explode": false, + "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single SubscriptionGroupLocalization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionGroupLocalizationResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, "patch": { "tags": [ - "SubscriptionIntroductoryOffers" + "SubscriptionGroupLocalizations" ], - "operationId": "subscriptionIntroductoryOffers_updateInstance", + "operationId": "subscriptionGroupLocalizations_updateInstance", "requestBody": { - "description": "SubscriptionIntroductoryOffer representation", + "description": "SubscriptionGroupLocalization representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionIntroductoryOfferUpdateRequest" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationUpdateRequest" } } }, @@ -73355,11 +73105,11 @@ } }, "200": { - "description": "Single SubscriptionIntroductoryOffer", + "description": "Single SubscriptionGroupLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionIntroductoryOfferResponse" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationResponse" } } } @@ -73388,9 +73138,9 @@ }, "delete": { "tags": [ - "SubscriptionIntroductoryOffers" + "SubscriptionGroupLocalizations" ], - "operationId": "subscriptionIntroductoryOffers_deleteInstance", + "operationId": "subscriptionGroupLocalizations_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -73460,18 +73210,18 @@ } ] }, - "/v2/subscriptionLocalizations": { + "/v1/subscriptionGroupSubmissions": { "post": { "tags": [ - "SubscriptionLocalizations" + "SubscriptionGroupSubmissions" ], - "operationId": "subscriptionLocalizationsV2_createInstance", + "operationId": "subscriptionGroupSubmissions_createInstance", "requestBody": { - "description": "SubscriptionLocalization representation", + "description": "SubscriptionGroupSubmission representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationV2CreateRequest" + "$ref": "#/components/schemas/SubscriptionGroupSubmissionCreateRequest" } } }, @@ -73519,11 +73269,11 @@ } }, "201": { - "description": "Single SubscriptionLocalization", + "description": "Single SubscriptionGroupSubmission", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationV2Response" + "$ref": "#/components/schemas/SubscriptionGroupSubmissionResponse" } } } @@ -73551,147 +73301,18 @@ } } }, - "/v2/subscriptionLocalizations/{id}": { - "get": { - "tags": [ - "SubscriptionLocalizations" - ], - "operationId": "subscriptionLocalizationsV2_getInstance", - "parameters": [ - { - "name": "fields[subscriptionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "locale", - "description", - "version" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionVersions]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "subscription", - "image", - "images", - "localizations" - ] - } - }, - "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": [ - "version" - ] - } - }, - "style": "form", - "explode": false, - "required": false - } - ], - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Single SubscriptionLocalization", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationV2Response" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "patch": { + "/v1/subscriptionGroupVersions": { + "post": { "tags": [ - "SubscriptionLocalizations" + "SubscriptionGroupVersions" ], - "operationId": "subscriptionLocalizationsV2_updateInstance", + "operationId": "subscriptionGroupVersions_createInstance", "requestBody": { - "description": "SubscriptionLocalization representation", + "description": "SubscriptionGroupVersion representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationV2UpdateRequest" + "$ref": "#/components/schemas/SubscriptionGroupVersionCreateRequest" } } }, @@ -73728,16 +73349,6 @@ } } }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "422": { "description": "Unprocessable request entity error(s)", "content": { @@ -73748,12 +73359,12 @@ } } }, - "200": { - "description": "Single SubscriptionLocalization", + "201": { + "description": "Single SubscriptionGroupVersion", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationV2Response" + "$ref": "#/components/schemas/SubscriptionGroupVersionResponse" } } } @@ -73779,12 +73390,105 @@ } } } - }, - "delete": { + } + }, + "/v1/subscriptionGroupVersions/{id}": { + "get": { "tags": [ - "SubscriptionLocalizations" + "SubscriptionGroupVersions" + ], + "operationId": "subscriptionGroupVersions_getInstance", + "parameters": [ + { + "name": "fields[subscriptionGroupVersions]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionGroupVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "subscriptionGroup", + "localizations" + ] + } + }, + "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", + "versions" + ] + } + }, + "style": "form", + "explode": false, + "required": 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", + "version" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "subscriptionGroup", + "localizations" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "limit[localizations]", + "in": "query", + "description": "maximum number of related localizations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + } ], - "operationId": "subscriptionLocalizationsV2_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -73826,8 +73530,15 @@ } } }, - "204": { - "description": "Success (no content)" + "200": { + "description": "Single SubscriptionGroupVersion", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionGroupVersionResponse" + } + } + } }, "429": { "description": "Rate limit exceeded error", @@ -73854,18 +73565,18 @@ } ] }, - "/v1/subscriptionLocalizations": { + "/v1/subscriptionGroups": { "post": { "tags": [ - "SubscriptionLocalizations" + "SubscriptionGroups" ], - "operationId": "subscriptionLocalizations_createInstance", + "operationId": "subscriptionGroups_createInstance", "requestBody": { - "description": "SubscriptionLocalization representation", + "description": "SubscriptionGroup representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationCreateRequest" + "$ref": "#/components/schemas/SubscriptionGroupCreateRequest" } } }, @@ -73913,11 +73624,11 @@ } }, "201": { - "description": "Single SubscriptionLocalization", + "description": "Single SubscriptionGroup", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationResponse" + "$ref": "#/components/schemas/SubscriptionGroupResponse" } } } @@ -73945,27 +73656,26 @@ } } }, - "/v1/subscriptionLocalizations/{id}": { + "/v1/subscriptionGroups/{id}": { "get": { "tags": [ - "SubscriptionLocalizations" + "SubscriptionGroups" ], - "operationId": "subscriptionLocalizations_getInstance", + "operationId": "subscriptionGroups_getInstance", "parameters": [ { - "name": "fields[subscriptionLocalizations]", + "name": "fields[subscriptionGroups]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionLocalizations", + "description": "the fields to include for returned resources of type subscriptionGroups", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "locale", - "description", - "state", - "subscription" + "referenceName", + "subscriptions", + "subscriptionGroupLocalizations", + "versions" ] } }, @@ -74004,7 +73714,51 @@ "winBackOffers", "images", "planAvailabilities", - "versions" + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] + } + }, + "style": "form", + "explode": false, + "required": 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, + "required": false + }, + { + "name": "fields[subscriptionGroupVersions]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionGroupVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "subscriptionGroup", + "localizations" ] } }, @@ -74021,13 +73775,48 @@ "items": { "type": "string", "enum": [ - "subscription" + "subscriptions", + "subscriptionGroupLocalizations", + "versions" ] } }, "style": "form", "explode": false, "required": false + }, + { + "name": "limit[subscriptionGroupLocalizations]", + "in": "query", + "description": "maximum number of related subscriptionGroupLocalizations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[subscriptions]", + "in": "query", + "description": "maximum number of related subscriptions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false } ], "responses": { @@ -74072,11 +73861,11 @@ } }, "200": { - "description": "Single SubscriptionLocalization", + "description": "Single SubscriptionGroup", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationResponse" + "$ref": "#/components/schemas/SubscriptionGroupResponse" } } } @@ -74095,15 +73884,15 @@ }, "patch": { "tags": [ - "SubscriptionLocalizations" + "SubscriptionGroups" ], - "operationId": "subscriptionLocalizations_updateInstance", + "operationId": "subscriptionGroups_updateInstance", "requestBody": { - "description": "SubscriptionLocalization representation", + "description": "SubscriptionGroup representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationUpdateRequest" + "$ref": "#/components/schemas/SubscriptionGroupUpdateRequest" } } }, @@ -74161,11 +73950,11 @@ } }, "200": { - "description": "Single SubscriptionLocalization", + "description": "Single SubscriptionGroup", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationResponse" + "$ref": "#/components/schemas/SubscriptionGroupResponse" } } } @@ -74194,9 +73983,9 @@ }, "delete": { "tags": [ - "SubscriptionLocalizations" + "SubscriptionGroups" ], - "operationId": "subscriptionLocalizations_deleteInstance", + "operationId": "subscriptionGroups_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -74266,18 +74055,18 @@ } ] }, - "/v1/subscriptionOfferCodeCustomCodes": { + "/v1/subscriptionImages": { "post": { "tags": [ - "SubscriptionOfferCodeCustomCodes" + "SubscriptionImages" ], - "operationId": "subscriptionOfferCodeCustomCodes_createInstance", + "operationId": "subscriptionImages_createInstance", "requestBody": { - "description": "SubscriptionOfferCodeCustomCode representation", + "description": "SubscriptionImage representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodeCreateRequest" + "$ref": "#/components/schemas/SubscriptionImageCreateRequest" } } }, @@ -74325,11 +74114,11 @@ } }, "201": { - "description": "Single SubscriptionOfferCodeCustomCode", + "description": "Single SubscriptionImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodeResponse" + "$ref": "#/components/schemas/SubscriptionImageResponse" } } } @@ -74357,28 +74146,30 @@ } } }, - "/v1/subscriptionOfferCodeCustomCodes/{id}": { + "/v1/subscriptionImages/{id}": { "get": { "tags": [ - "SubscriptionOfferCodeCustomCodes" + "SubscriptionImages" ], - "operationId": "subscriptionOfferCodeCustomCodes_getInstance", + "operationId": "subscriptionImages_getInstance", "parameters": [ { - "name": "fields[subscriptionOfferCodeCustomCodes]", + "name": "fields[subscriptionImages]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodeCustomCodes", + "description": "the fields to include for returned resources of type subscriptionImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customCode", - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "offerCode" + "fileSize", + "fileName", + "sourceFileChecksum", + "assetToken", + "imageAsset", + "uploadOperations", + "state", + "subscription" ] } }, @@ -74387,30 +74178,40 @@ "required": false }, { - "name": "fields[subscriptionOfferCodes]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodes", + "description": "the fields to include for returned resources of type subscriptions", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "customerEligibilities", - "offerEligibility", - "duration", - "offerMode", - "numberOfPeriods", - "totalNumberOfCodes", - "productionCodeCount", - "sandboxCodeCount", - "active", - "autoRenewEnabled", - "targetSubscriptionPlanType", - "subscription", - "oneTimeUseCodes", - "customCodes", - "prices" + "productId", + "familySharable", + "state", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -74427,7 +74228,7 @@ "items": { "type": "string", "enum": [ - "offerCode" + "subscription" ] } }, @@ -74478,11 +74279,11 @@ } }, "200": { - "description": "Single SubscriptionOfferCodeCustomCode", + "description": "Single SubscriptionImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodeResponse" + "$ref": "#/components/schemas/SubscriptionImageResponse" } } } @@ -74501,15 +74302,15 @@ }, "patch": { "tags": [ - "SubscriptionOfferCodeCustomCodes" + "SubscriptionImages" ], - "operationId": "subscriptionOfferCodeCustomCodes_updateInstance", + "operationId": "subscriptionImages_updateInstance", "requestBody": { - "description": "SubscriptionOfferCodeCustomCode representation", + "description": "SubscriptionImage representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodeUpdateRequest" + "$ref": "#/components/schemas/SubscriptionImageUpdateRequest" } } }, @@ -74567,11 +74368,11 @@ } }, "200": { - "description": "Single SubscriptionOfferCodeCustomCode", + "description": "Single SubscriptionImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodeResponse" + "$ref": "#/components/schemas/SubscriptionImageResponse" } } } @@ -74598,6 +74399,67 @@ } } }, + "delete": { + "tags": [ + "SubscriptionImages" + ], + "operationId": "subscriptionImages_deleteInstance", + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "Success (no content)" + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, "parameters": [ { "name": "id", @@ -74611,18 +74473,18 @@ } ] }, - "/v1/subscriptionOfferCodeOneTimeUseCodes": { + "/v2/subscriptionImages": { "post": { "tags": [ - "SubscriptionOfferCodeOneTimeUseCodes" + "SubscriptionImages" ], - "operationId": "subscriptionOfferCodeOneTimeUseCodes_createInstance", + "operationId": "subscriptionImagesV2_createInstance", "requestBody": { - "description": "SubscriptionOfferCodeOneTimeUseCode representation", + "description": "SubscriptionImage representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodeCreateRequest" + "$ref": "#/components/schemas/SubscriptionImageV2CreateRequest" } } }, @@ -74670,11 +74532,11 @@ } }, "201": { - "description": "Single SubscriptionOfferCodeOneTimeUseCode", + "description": "Single SubscriptionImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodeResponse" + "$ref": "#/components/schemas/SubscriptionImageV2Response" } } } @@ -74702,78 +74564,28 @@ } } }, - "/v1/subscriptionOfferCodeOneTimeUseCodes/{id}": { + "/v2/subscriptionImages/{id}": { "get": { "tags": [ - "SubscriptionOfferCodeOneTimeUseCodes" + "SubscriptionImages" ], - "operationId": "subscriptionOfferCodeOneTimeUseCodes_getInstance", + "operationId": "subscriptionImagesV2_getInstance", "parameters": [ { - "name": "fields[subscriptionOfferCodeOneTimeUseCodes]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodeOneTimeUseCodes", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "environment", - "offerCode", - "values" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionOfferCodes]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodes", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "customerEligibilities", - "offerEligibility", - "duration", - "offerMode", - "numberOfPeriods", - "totalNumberOfCodes", - "productionCodeCount", - "sandboxCodeCount", - "active", - "autoRenewEnabled", - "targetSubscriptionPlanType", - "subscription", - "oneTimeUseCodes", - "customCodes", - "prices" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "include", + "name": "fields[subscriptionImages]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type subscriptionImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "offerCode" + "fileSize", + "fileName", + "assetToken", + "imageAsset", + "uploadOperations", + "assetDeliveryState" ] } }, @@ -74824,11 +74636,11 @@ } }, "200": { - "description": "Single SubscriptionOfferCodeOneTimeUseCode", + "description": "Single SubscriptionImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodeResponse" + "$ref": "#/components/schemas/SubscriptionImageV2Response" } } } @@ -74847,15 +74659,15 @@ }, "patch": { "tags": [ - "SubscriptionOfferCodeOneTimeUseCodes" + "SubscriptionImages" ], - "operationId": "subscriptionOfferCodeOneTimeUseCodes_updateInstance", + "operationId": "subscriptionImagesV2_updateInstance", "requestBody": { - "description": "SubscriptionOfferCodeOneTimeUseCode representation", + "description": "SubscriptionImage representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodeUpdateRequest" + "$ref": "#/components/schemas/SubscriptionImageV2UpdateRequest" } } }, @@ -74913,11 +74725,11 @@ } }, "200": { - "description": "Single SubscriptionOfferCodeOneTimeUseCode", + "description": "Single SubscriptionImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodeResponse" + "$ref": "#/components/schemas/SubscriptionImageV2Response" } } } @@ -74944,305 +74756,11 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/subscriptionOfferCodes": { - "post": { - "tags": [ - "SubscriptionOfferCodes" - ], - "operationId": "subscriptionOfferCodes_createInstance", - "requestBody": { - "description": "SubscriptionOfferCode representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeCreateRequest" - } - } - }, - "required": true - }, - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "201": { - "description": "Single SubscriptionOfferCode", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/v1/subscriptionOfferCodes/{id}": { - "get": { + "delete": { "tags": [ - "SubscriptionOfferCodes" - ], - "operationId": "subscriptionOfferCodes_getInstance", - "parameters": [ - { - "name": "fields[subscriptionOfferCodes]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodes", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "customerEligibilities", - "offerEligibility", - "duration", - "offerMode", - "numberOfPeriods", - "totalNumberOfCodes", - "productionCodeCount", - "sandboxCodeCount", - "active", - "autoRenewEnabled", - "targetSubscriptionPlanType", - "subscription", - "oneTimeUseCodes", - "customCodes", - "prices" - ] - } - }, - "style": "form", - "explode": false, - "required": 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", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionOfferCodeOneTimeUseCodes]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodeOneTimeUseCodes", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "environment", - "offerCode", - "values" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionOfferCodeCustomCodes]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodeCustomCodes", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "customCode", - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "offerCode" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionOfferCodePrices]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodePrices", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "territory", - "subscriptionPricePoint" - ] - } - }, - "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": [ - "subscription", - "oneTimeUseCodes", - "customCodes", - "prices" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "limit[customCodes]", - "in": "query", - "description": "maximum number of related customCodes returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - }, - { - "name": "limit[oneTimeUseCodes]", - "in": "query", - "description": "maximum number of related oneTimeUseCodes returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - }, - { - "name": "limit[prices]", - "in": "query", - "description": "maximum number of related prices returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - } + "SubscriptionImages" ], + "operationId": "subscriptionImagesV2_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -75284,15 +74802,8 @@ } } }, - "200": { - "description": "Single SubscriptionOfferCode", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeResponse" - } - } - } + "204": { + "description": "Success (no content)" }, "429": { "description": "Rate limit exceeded error", @@ -75306,17 +74817,31 @@ } } }, - "patch": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/subscriptionIntroductoryOffers": { + "post": { "tags": [ - "SubscriptionOfferCodes" + "SubscriptionIntroductoryOffers" ], - "operationId": "subscriptionOfferCodes_updateInstance", + "operationId": "subscriptionIntroductoryOffers_createInstance", "requestBody": { - "description": "SubscriptionOfferCode representation", + "description": "SubscriptionIntroductoryOffer representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeUpdateRequest" + "$ref": "#/components/schemas/SubscriptionIntroductoryOfferCreateRequest" } } }, @@ -75353,16 +74878,6 @@ } } }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "422": { "description": "Unprocessable request entity error(s)", "content": { @@ -75373,12 +74888,12 @@ } } }, - "200": { - "description": "Single SubscriptionOfferCode", + "201": { + "description": "Single SubscriptionIntroductoryOffer", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeResponse" + "$ref": "#/components/schemas/SubscriptionIntroductoryOfferResponse" } } } @@ -75404,32 +74919,20 @@ } } } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] + } }, - "/v1/subscriptionPlanAvailabilities": { - "post": { + "/v1/subscriptionIntroductoryOffers/{id}": { + "patch": { "tags": [ - "SubscriptionPlanAvailabilities" + "SubscriptionIntroductoryOffers" ], - "operationId": "subscriptionPlanAvailabilities_createInstance", + "operationId": "subscriptionIntroductoryOffers_updateInstance", "requestBody": { - "description": "SubscriptionPlanAvailability representation", + "description": "SubscriptionIntroductoryOffer representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlanAvailabilityCreateRequest" + "$ref": "#/components/schemas/SubscriptionIntroductoryOfferUpdateRequest" } } }, @@ -75466,6 +74969,16 @@ } } }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "422": { "description": "Unprocessable request entity error(s)", "content": { @@ -75476,12 +74989,12 @@ } } }, - "201": { - "description": "Single SubscriptionPlanAvailability", + "200": { + "description": "Single SubscriptionIntroductoryOffer", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlanAvailabilityResponse" + "$ref": "#/components/schemas/SubscriptionIntroductoryOfferResponse" } } } @@ -75507,80 +75020,12 @@ } } } - } - }, - "/v1/subscriptionPlanAvailabilities/{id}": { - "get": { + }, + "delete": { "tags": [ - "SubscriptionPlanAvailabilities" - ], - "operationId": "subscriptionPlanAvailabilities_getInstance", - "parameters": [ - { - "name": "fields[subscriptionPlanAvailabilities]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPlanAvailabilities", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "availableInNewTerritories", - "planType", - "availableTerritories" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[territories]", - "in": "query", - "description": "the fields to include for returned resources of type territories", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "currency" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "availableTerritories" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "limit[availableTerritories]", - "in": "query", - "description": "maximum number of related availableTerritories returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - } + "SubscriptionIntroductoryOffers" ], + "operationId": "subscriptionIntroductoryOffers_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -75622,15 +75067,8 @@ } } }, - "200": { - "description": "Single SubscriptionPlanAvailability", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionPlanAvailabilityResponse" - } - } - } + "204": { + "description": "Success (no content)" }, "429": { "description": "Rate limit exceeded error", @@ -75644,17 +75082,31 @@ } } }, - "patch": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v2/subscriptionLocalizations": { + "post": { "tags": [ - "SubscriptionPlanAvailabilities" + "SubscriptionLocalizations" ], - "operationId": "subscriptionPlanAvailabilities_updateInstance", + "operationId": "subscriptionLocalizationsV2_createInstance", "requestBody": { - "description": "SubscriptionPlanAvailability representation", + "description": "SubscriptionLocalization representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlanAvailabilityUpdateRequest" + "$ref": "#/components/schemas/SubscriptionLocalizationV2CreateRequest" } } }, @@ -75691,16 +75143,6 @@ } } }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "422": { "description": "Unprocessable request entity error(s)", "content": { @@ -75711,12 +75153,12 @@ } } }, - "200": { - "description": "Single SubscriptionPlanAvailability", + "201": { + "description": "Single SubscriptionLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlanAvailabilityResponse" + "$ref": "#/components/schemas/SubscriptionLocalizationV2Response" } } } @@ -75742,42 +75184,28 @@ } } } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] + } }, - "/v1/subscriptionPricePoints/{id}": { + "/v2/subscriptionLocalizations/{id}": { "get": { "tags": [ - "SubscriptionPricePoints" + "SubscriptionLocalizations" ], - "operationId": "subscriptionPricePoints_getInstance", + "operationId": "subscriptionLocalizationsV2_getInstance", "parameters": [ { - "name": "fields[subscriptionPricePoints]", + "name": "fields[subscriptionLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionPricePoints", + "description": "the fields to include for returned resources of type subscriptionLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", - "proceedsYear2", - "territory", - "equalizations", - "adjustedEqualizations" + "name", + "locale", + "description", + "version" ] } }, @@ -75786,15 +75214,20 @@ "required": false }, { - "name": "fields[territories]", + "name": "fields[subscriptionVersions]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type subscriptionVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "version", + "state", + "subscription", + "image", + "images", + "localizations" ] } }, @@ -75811,7 +75244,7 @@ "items": { "type": "string", "enum": [ - "territory" + "version" ] } }, @@ -75862,11 +75295,11 @@ } }, "200": { - "description": "Single SubscriptionPricePoint", + "description": "Single SubscriptionLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPricePointResponse" + "$ref": "#/components/schemas/SubscriptionLocalizationV2Response" } } } @@ -75883,31 +75316,17 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/subscriptionPrices": { - "post": { + "patch": { "tags": [ - "SubscriptionPrices" + "SubscriptionLocalizations" ], - "operationId": "subscriptionPrices_createInstance", + "operationId": "subscriptionLocalizationsV2_updateInstance", "requestBody": { - "description": "SubscriptionPrice representation", + "description": "SubscriptionLocalization representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPriceCreateRequest" + "$ref": "#/components/schemas/SubscriptionLocalizationV2UpdateRequest" } } }, @@ -75944,6 +75363,16 @@ } } }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "422": { "description": "Unprocessable request entity error(s)", "content": { @@ -75954,12 +75383,12 @@ } } }, - "201": { - "description": "Single SubscriptionPrice", + "200": { + "description": "Single SubscriptionLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPriceResponse" + "$ref": "#/components/schemas/SubscriptionLocalizationV2Response" } } } @@ -75985,14 +75414,12 @@ } } } - } - }, - "/v1/subscriptionPrices/{id}": { + }, "delete": { "tags": [ - "SubscriptionPrices" + "SubscriptionLocalizations" ], - "operationId": "subscriptionPrices_deleteInstance", + "operationId": "subscriptionLocalizationsV2_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -76062,18 +75489,18 @@ } ] }, - "/v1/subscriptionPromotionalOffers": { + "/v1/subscriptionLocalizations": { "post": { "tags": [ - "SubscriptionPromotionalOffers" + "SubscriptionLocalizations" ], - "operationId": "subscriptionPromotionalOffers_createInstance", + "operationId": "subscriptionLocalizations_createInstance", "requestBody": { - "description": "SubscriptionPromotionalOffer representation", + "description": "SubscriptionLocalization representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPromotionalOfferCreateRequest" + "$ref": "#/components/schemas/SubscriptionLocalizationCreateRequest" } } }, @@ -76121,11 +75548,11 @@ } }, "201": { - "description": "Single SubscriptionPromotionalOffer", + "description": "Single SubscriptionLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPromotionalOfferResponse" + "$ref": "#/components/schemas/SubscriptionLocalizationResponse" } } } @@ -76153,30 +75580,27 @@ } } }, - "/v1/subscriptionPromotionalOffers/{id}": { + "/v1/subscriptionLocalizations/{id}": { "get": { "tags": [ - "SubscriptionPromotionalOffers" + "SubscriptionLocalizations" ], - "operationId": "subscriptionPromotionalOffers_getInstance", + "operationId": "subscriptionLocalizations_getInstance", "parameters": [ { - "name": "fields[subscriptionPromotionalOffers]", + "name": "fields[subscriptionLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionPromotionalOffers", + "description": "the fields to include for returned resources of type subscriptionLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "duration", "name", - "numberOfPeriods", - "offerCode", - "offerMode", - "targetSubscriptionPlanType", - "subscription", - "prices" + "locale", + "description", + "state", + "subscription" ] } }, @@ -76215,25 +75639,10 @@ "winBackOffers", "images", "planAvailabilities", - "versions" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionPromotionalOfferPrices]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPromotionalOfferPrices", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "territory", - "subscriptionPricePoint" + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -76250,25 +75659,13 @@ "items": { "type": "string", "enum": [ - "subscription", - "prices" + "subscription" ] } }, "style": "form", "explode": false, "required": false - }, - { - "name": "limit[prices]", - "in": "query", - "description": "maximum number of related prices returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false } ], "responses": { @@ -76313,11 +75710,11 @@ } }, "200": { - "description": "Single SubscriptionPromotionalOffer", + "description": "Single SubscriptionLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPromotionalOfferResponse" + "$ref": "#/components/schemas/SubscriptionLocalizationResponse" } } } @@ -76336,15 +75733,15 @@ }, "patch": { "tags": [ - "SubscriptionPromotionalOffers" + "SubscriptionLocalizations" ], - "operationId": "subscriptionPromotionalOffers_updateInstance", + "operationId": "subscriptionLocalizations_updateInstance", "requestBody": { - "description": "SubscriptionPromotionalOffer representation", + "description": "SubscriptionLocalization representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPromotionalOfferUpdateRequest" + "$ref": "#/components/schemas/SubscriptionLocalizationUpdateRequest" } } }, @@ -76402,11 +75799,11 @@ } }, "200": { - "description": "Single SubscriptionPromotionalOffer", + "description": "Single SubscriptionLocalization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPromotionalOfferResponse" + "$ref": "#/components/schemas/SubscriptionLocalizationResponse" } } } @@ -76435,9 +75832,9 @@ }, "delete": { "tags": [ - "SubscriptionPromotionalOffers" + "SubscriptionLocalizations" ], - "operationId": "subscriptionPromotionalOffers_deleteInstance", + "operationId": "subscriptionLocalizations_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -76507,18 +75904,18 @@ } ] }, - "/v1/subscriptionSubmissions": { + "/v1/subscriptionOfferCodeCustomCodes": { "post": { "tags": [ - "SubscriptionSubmissions" + "SubscriptionOfferCodeCustomCodes" ], - "operationId": "subscriptionSubmissions_createInstance", + "operationId": "subscriptionOfferCodeCustomCodes_createInstance", "requestBody": { - "description": "SubscriptionSubmission representation", + "description": "SubscriptionOfferCodeCustomCode representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionSubmissionCreateRequest" + "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodeCreateRequest" } } }, @@ -76566,11 +75963,11 @@ } }, "201": { - "description": "Single SubscriptionSubmission", + "description": "Single SubscriptionOfferCodeCustomCode", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionSubmissionResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodeResponse" } } } @@ -76598,23 +75995,85 @@ } } }, - "/v1/subscriptionVersions": { - "post": { + "/v1/subscriptionOfferCodeCustomCodes/{id}": { + "get": { "tags": [ - "SubscriptionVersions" + "SubscriptionOfferCodeCustomCodes" ], - "operationId": "subscriptionVersions_createInstance", - "requestBody": { - "description": "SubscriptionVersion representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionVersionCreateRequest" + "operationId": "subscriptionOfferCodeCustomCodes_getInstance", + "parameters": [ + { + "name": "fields[subscriptionOfferCodeCustomCodes]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionOfferCodeCustomCodes", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "customCode", + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "offerCode" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "required": true - }, + { + "name": "fields[subscriptionOfferCodes]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionOfferCodes", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "customerEligibilities", + "offerEligibility", + "duration", + "offerMode", + "numberOfPeriods", + "totalNumberOfCodes", + "productionCodeCount", + "sandboxCodeCount", + "active", + "autoRenewEnabled", + "targetSubscriptionPlanType", + "subscription", + "oneTimeUseCodes", + "customCodes", + "prices" + ] + } + }, + "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": [ + "offerCode" + ] + } + }, + "style": "form", + "explode": false, + "required": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -76646,8 +76105,8 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", + "404": { + "description": "Not found error", "content": { "application/json": { "schema": { @@ -76656,18 +76115,18 @@ } } }, - "201": { - "description": "Single SubscriptionVersion", + "200": { + "description": "Single SubscriptionOfferCodeCustomCode", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionVersionResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodeResponse" } } } }, - "409": { - "description": "Request entity error(s)", + "429": { + "description": "Rate limit exceeded error", "content": { "application/json": { "schema": { @@ -76675,9 +76134,28 @@ } } } + } + } + }, + "patch": { + "tags": [ + "SubscriptionOfferCodeCustomCodes" + ], + "operationId": "subscriptionOfferCodeCustomCodes_updateInstance", + "requestBody": { + "description": "SubscriptionOfferCodeCustomCode representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodeUpdateRequest" + } + } }, - "429": { - "description": "Rate limit exceeded error", + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", "content": { "application/json": { "schema": { @@ -76685,93 +76163,206 @@ } } } - } - } - } - }, - "/v1/subscriptionVersions/{id}": { - "get": { - "tags": [ - "SubscriptionVersions" - ], - "operationId": "subscriptionVersions_getInstance", - "parameters": [ - { - "name": "fields[subscriptionVersions]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "subscription", - "image", - "images", - "localizations" - ] + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false, - "required": 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", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false, - "required": false + } + }, + "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 SubscriptionOfferCodeCustomCode", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodeResponse" + } + } + } + }, + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/subscriptionOfferCodeOneTimeUseCodes": { + "post": { + "tags": [ + "SubscriptionOfferCodeOneTimeUseCodes" + ], + "operationId": "subscriptionOfferCodeOneTimeUseCodes_createInstance", + "requestBody": { + "description": "SubscriptionOfferCodeOneTimeUseCode representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodeCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Single SubscriptionOfferCodeOneTimeUseCode", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodeResponse" + } + } + } }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/subscriptionOfferCodeOneTimeUseCodes/{id}": { + "get": { + "tags": [ + "SubscriptionOfferCodeOneTimeUseCodes" + ], + "operationId": "subscriptionOfferCodeOneTimeUseCodes_getInstance", + "parameters": [ { - "name": "fields[subscriptionImages]", + "name": "fields[subscriptionOfferCodeOneTimeUseCodes]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionImages", + "description": "the fields to include for returned resources of type subscriptionOfferCodeOneTimeUseCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "assetToken", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "environment", + "offerCode", + "values" ] } }, @@ -76780,18 +76371,30 @@ "required": false }, { - "name": "fields[subscriptionLocalizations]", + "name": "fields[subscriptionOfferCodes]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionLocalizations", + "description": "the fields to include for returned resources of type subscriptionOfferCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "locale", - "description", - "version" + "customerEligibilities", + "offerEligibility", + "duration", + "offerMode", + "numberOfPeriods", + "totalNumberOfCodes", + "productionCodeCount", + "sandboxCodeCount", + "active", + "autoRenewEnabled", + "targetSubscriptionPlanType", + "subscription", + "oneTimeUseCodes", + "customCodes", + "prices" ] } }, @@ -76808,40 +76411,94 @@ "items": { "type": "string", "enum": [ - "subscription", - "image", - "images", - "localizations" + "offerCode" ] } }, "style": "form", "explode": false, "required": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "name": "limit[images]", - "in": "query", - "description": "maximum number of related images returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "name": "limit[localizations]", - "in": "query", - "description": "maximum number of related localizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false + "403": { + "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 SubscriptionOfferCodeOneTimeUseCode", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodeResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } + } + }, + "patch": { + "tags": [ + "SubscriptionOfferCodeOneTimeUseCodes" ], + "operationId": "subscriptionOfferCodeOneTimeUseCodes_updateInstance", + "requestBody": { + "description": "SubscriptionOfferCodeOneTimeUseCode representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodeUpdateRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -76883,12 +76540,32 @@ } } }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { - "description": "Single SubscriptionVersion", + "description": "Single SubscriptionOfferCodeOneTimeUseCode", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionVersionResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodeResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -76918,18 +76595,18 @@ } ] }, - "/v1/subscriptions": { + "/v1/subscriptionOfferCodes": { "post": { "tags": [ - "Subscriptions" + "SubscriptionOfferCodes" ], - "operationId": "subscriptions_createInstance", + "operationId": "subscriptionOfferCodes_createInstance", "requestBody": { - "description": "Subscription representation", + "description": "SubscriptionOfferCode representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCreateRequest" + "$ref": "#/components/schemas/SubscriptionOfferCodeCreateRequest" } } }, @@ -76977,11 +76654,11 @@ } }, "201": { - "description": "Single Subscription", + "description": "Single SubscriptionOfferCode", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodeResponse" } } } @@ -77009,167 +76686,13 @@ } } }, - "/v1/subscriptions/{id}": { + "/v1/subscriptionOfferCodes/{id}": { "get": { "tags": [ - "Subscriptions" + "SubscriptionOfferCodes" ], - "operationId": "subscriptions_getInstance", + "operationId": "subscriptionOfferCodes_getInstance", "parameters": [ - { - "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", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "locale", - "description", - "state", - "subscription" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionAppStoreReviewScreenshots]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "imageAsset", - "assetToken", - "assetType", - "uploadOperations", - "assetDeliveryState", - "subscription" - ] - } - }, - "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", - "versions" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionIntroductoryOffers]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionIntroductoryOffers", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "startDate", - "endDate", - "duration", - "offerMode", - "numberOfPeriods", - "targetSubscriptionPlanType", - "subscription", - "territory", - "subscriptionPricePoint" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionPromotionalOffers]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPromotionalOffers", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "duration", - "name", - "numberOfPeriods", - "offerCode", - "offerMode", - "targetSubscriptionPlanType", - "subscription", - "prices" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, { "name": "fields[subscriptionOfferCodes]", "in": "query", @@ -77203,89 +76726,40 @@ "required": false }, { - "name": "fields[subscriptionPrices]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPrices", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "startDate", - "preserved", - "planType", - "territory", - "subscriptionPricePoint" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[promotedPurchases]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type promotedPurchases", + "description": "the fields to include for returned resources of type subscriptions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "visibleForAllUsers", - "enabled", + "name", + "productId", + "familySharable", "state", - "inAppPurchaseV2", - "subscription" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[subscriptionAvailabilities]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionAvailabilities", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "availableInNewTerritories", - "availableTerritories" - ] - } - }, - "style": "form", - "explode": false, - "required": false, - "deprecated": true - }, - { - "name": "fields[winBackOffers]", - "in": "query", - "description": "the fields to include for returned resources of type winBackOffers", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "referenceName", - "offerId", - "duration", - "offerMode", - "periodCount", - "customerEligibilityPaidSubscriptionDurationInMonths", - "customerEligibilityTimeSinceLastSubscribedInMonths", - "customerEligibilityWaitBetweenOffersInMonths", - "startDate", - "endDate", - "priority", - "promotionIntent", - "targetSubscriptionPlanType", - "prices" + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -77294,22 +76768,21 @@ "required": false }, { - "name": "fields[subscriptionImages]", + "name": "fields[subscriptionOfferCodeOneTimeUseCodes]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionImages", + "description": "the fields to include for returned resources of type subscriptionOfferCodeOneTimeUseCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "assetToken", - "imageAsset", - "uploadOperations", - "state", - "subscription" + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "environment", + "offerCode", + "values" ] } }, @@ -77318,17 +76791,20 @@ "required": false }, { - "name": "fields[subscriptionPlanAvailabilities]", + "name": "fields[subscriptionOfferCodeCustomCodes]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionPlanAvailabilities", + "description": "the fields to include for returned resources of type subscriptionOfferCodeCustomCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "availableInNewTerritories", - "planType", - "availableTerritories" + "customCode", + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "offerCode" ] } }, @@ -77337,20 +76813,16 @@ "required": false }, { - "name": "fields[subscriptionVersions]", + "name": "fields[subscriptionOfferCodePrices]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionVersions", + "description": "the fields to include for returned resources of type subscriptionOfferCodePrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "subscription", - "image", - "images", - "localizations" + "territory", + "subscriptionPricePoint" ] } }, @@ -77367,19 +76839,10 @@ "items": { "type": "string", "enum": [ - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" + "subscription", + "oneTimeUseCodes", + "customCodes", + "prices" ] } }, @@ -77388,31 +76851,9 @@ "required": false }, { - "name": "limit[images]", - "in": "query", - "description": "maximum number of related images returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - }, - { - "name": "limit[introductoryOffers]", - "in": "query", - "description": "maximum number of related introductoryOffers returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - }, - { - "name": "limit[offerCodes]", + "name": "limit[customCodes]", "in": "query", - "description": "maximum number of related offerCodes returned (when they are included)", + "description": "maximum number of related customCodes returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -77421,9 +76862,9 @@ "required": false }, { - "name": "limit[planAvailabilities]", + "name": "limit[oneTimeUseCodes]", "in": "query", - "description": "maximum number of related planAvailabilities returned (when they are included)", + "description": "maximum number of related oneTimeUseCodes returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -77441,50 +76882,6 @@ }, "style": "form", "required": false - }, - { - "name": "limit[promotionalOffers]", - "in": "query", - "description": "maximum number of related promotionalOffers returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - }, - { - "name": "limit[subscriptionLocalizations]", - "in": "query", - "description": "maximum number of related subscriptionLocalizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - }, - { - "name": "limit[versions]", - "in": "query", - "description": "maximum number of related versions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - }, - { - "name": "limit[winBackOffers]", - "in": "query", - "description": "maximum number of related winBackOffers returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false } ], "responses": { @@ -77529,11 +76926,11 @@ } }, "200": { - "description": "Single Subscription", + "description": "Single SubscriptionOfferCode", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodeResponse" } } } @@ -77552,15 +76949,15 @@ }, "patch": { "tags": [ - "Subscriptions" + "SubscriptionOfferCodes" ], - "operationId": "subscriptions_updateInstance", + "operationId": "subscriptionOfferCodes_updateInstance", "requestBody": { - "description": "Subscription representation", + "description": "SubscriptionOfferCode representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionUpdateRequest" + "$ref": "#/components/schemas/SubscriptionOfferCodeUpdateRequest" } } }, @@ -77618,11 +77015,11 @@ } }, "200": { - "description": "Single Subscription", + "description": "Single SubscriptionOfferCode", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodeResponse" } } } @@ -77649,11 +77046,36 @@ } } }, - "delete": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/subscriptionPlanAvailabilities": { + "post": { "tags": [ - "Subscriptions" + "SubscriptionPlanAvailabilities" ], - "operationId": "subscriptions_deleteInstance", + "operationId": "subscriptionPlanAvailabilities_createInstance", + "requestBody": { + "description": "SubscriptionPlanAvailability representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionPlanAvailabilityCreateRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -77685,8 +77107,8 @@ } } }, - "404": { - "description": "Not found error", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { @@ -77695,8 +77117,25 @@ } } }, - "204": { - "description": "Success (no content)" + "201": { + "description": "Single SubscriptionPlanAvailability", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionPlanAvailabilityResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, "429": { "description": "Rate limit exceeded error", @@ -77709,27 +77148,34 @@ } } } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] + } }, - "/v1/territories": { + "/v1/subscriptionPlanAvailabilities/{id}": { "get": { "tags": [ - "Territories" + "SubscriptionPlanAvailabilities" ], - "operationId": "territories_getCollection", + "operationId": "subscriptionPlanAvailabilities_getInstance", "parameters": [ + { + "name": "fields[subscriptionPlanAvailabilities]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPlanAvailabilities", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "availableInNewTerritories", + "planType", + "availableTerritories" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, { "name": "fields[territories]", "in": "query", @@ -77748,14 +77194,32 @@ "required": false }, { - "name": "limit", + "name": "include", "in": "query", - "description": "maximum resources per page", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "availableTerritories" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "limit[availableTerritories]", + "in": "query", + "description": "maximum number of related availableTerritories returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "maximum": 50 }, - "style": "form" + "style": "form", + "required": false } ], "responses": { @@ -77789,12 +77253,22 @@ } } }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { - "description": "List of Territories", + "description": "Single SubscriptionPlanAvailability", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoriesResponse" + "$ref": "#/components/schemas/SubscriptionPlanAvailabilityResponse" } } } @@ -77810,20 +77284,18 @@ } } } - } - }, - "/v1/territoryAvailabilities/{id}": { + }, "patch": { "tags": [ - "TerritoryAvailabilities" + "SubscriptionPlanAvailabilities" ], - "operationId": "territoryAvailabilities_updateInstance", + "operationId": "subscriptionPlanAvailabilities_updateInstance", "requestBody": { - "description": "TerritoryAvailability representation", + "description": "SubscriptionPlanAvailability representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoryAvailabilityUpdateRequest" + "$ref": "#/components/schemas/SubscriptionPlanAvailabilityUpdateRequest" } } }, @@ -77881,11 +77353,11 @@ } }, "200": { - "description": "Single TerritoryAvailability", + "description": "Single SubscriptionPlanAvailability", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoryAvailabilityResponse" + "$ref": "#/components/schemas/SubscriptionPlanAvailabilityResponse" } } } @@ -77925,21 +77397,29 @@ } ] }, - "/v1/userInvitations": { + "/v1/subscriptionPricePoints/{id}": { "get": { "tags": [ - "UserInvitations" + "SubscriptionPricePoints" ], - "operationId": "userInvitations_getCollection", + "operationId": "subscriptionPricePoints_getInstance", "parameters": [ { - "name": "filter[email]", + "name": "fields[subscriptionPricePoints]", "in": "query", - "description": "filter by attribute 'email'", + "description": "the fields to include for returned resources of type subscriptionPricePoints", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "customerPrice", + "proceeds", + "proceedsYear2", + "territory", + "equalizations", + "adjustedEqualizations" + ] } }, "style": "form", @@ -77947,27 +77427,15 @@ "required": false }, { - "name": "filter[roles]", + "name": "fields[territories]", "in": "query", - "description": "filter by attribute 'roles'", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "ADMIN", - "FINANCE", - "ACCOUNT_HOLDER", - "SALES", - "MARKETING", - "APP_MANAGER", - "DEVELOPER", - "ACCESS_TO_REPORTS", - "CUSTOMER_SUPPORT", - "CREATE_APPS", - "CLOUD_MANAGED_DEVELOPER_ID", - "CLOUD_MANAGED_APP_DISTRIBUTION", - "GENERATE_INDIVIDUAL_KEYS" + "currency" ] } }, @@ -77976,173 +77444,21 @@ "required": false }, { - "name": "filter[visibleApps]", + "name": "include", "in": "query", - "description": "filter by id(s) of related 'visibleApps'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "sort", - "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "email", - "-email", - "lastName", - "-lastName" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[userInvitations]", - "in": "query", - "description": "the fields to include for returned resources of type userInvitations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "email", - "firstName", - "lastName", - "expirationDate", - "roles", - "allAppsVisible", - "provisioningAllowed", - "visibleApps" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[apps]", - "in": "query", - "description": "the fields to include for returned resources of type apps", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" - ] - } - }, - "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", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "visibleApps" + "territory" ] } }, "style": "form", "explode": false, "required": false - }, - { - "name": "limit[visibleApps]", - "in": "query", - "description": "maximum number of related visibleApps returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false } ], "responses": { @@ -78176,12 +77492,22 @@ } } }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { - "description": "List of UserInvitations", + "description": "Single SubscriptionPricePoint", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserInvitationsResponse" + "$ref": "#/components/schemas/SubscriptionPricePointResponse" } } } @@ -78198,17 +77524,31 @@ } } }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/subscriptionPrices": { "post": { "tags": [ - "UserInvitations" + "SubscriptionPrices" ], - "operationId": "userInvitations_createInstance", + "operationId": "subscriptionPrices_createInstance", "requestBody": { - "description": "UserInvitation representation", + "description": "SubscriptionPrice representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserInvitationCreateRequest" + "$ref": "#/components/schemas/SubscriptionPriceCreateRequest" } } }, @@ -78256,11 +77596,11 @@ } }, "201": { - "description": "Single UserInvitation", + "description": "Single SubscriptionPrice", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserInvitationResponse" + "$ref": "#/components/schemas/SubscriptionPriceResponse" } } } @@ -78288,207 +77628,12 @@ } } }, - "/v1/userInvitations/{id}": { - "get": { - "tags": [ - "UserInvitations" - ], - "operationId": "userInvitations_getInstance", - "parameters": [ - { - "name": "fields[userInvitations]", - "in": "query", - "description": "the fields to include for returned resources of type userInvitations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "email", - "firstName", - "lastName", - "expirationDate", - "roles", - "allAppsVisible", - "provisioningAllowed", - "visibleApps" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[apps]", - "in": "query", - "description": "the fields to include for returned resources of type apps", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "visibleApps" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "limit[visibleApps]", - "in": "query", - "description": "maximum number of related visibleApps returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - } - ], - "responses": { - "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 UserInvitation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInvitationResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, + "/v1/subscriptionPrices/{id}": { "delete": { "tags": [ - "UserInvitations" + "SubscriptionPrices" ], - "operationId": "userInvitations_deleteInstance", + "operationId": "subscriptionPrices_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -78558,225 +77703,23 @@ } ] }, - "/v1/users": { - "get": { + "/v1/subscriptionPromotionalOffers": { + "post": { "tags": [ - "Users" + "SubscriptionPromotionalOffers" ], - "operationId": "users_getCollection", - "parameters": [ - { - "name": "filter[username]", - "in": "query", - "description": "filter by attribute 'username'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "filter[roles]", - "in": "query", - "description": "filter by attribute 'roles'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "ADMIN", - "FINANCE", - "ACCOUNT_HOLDER", - "SALES", - "MARKETING", - "APP_MANAGER", - "DEVELOPER", - "ACCESS_TO_REPORTS", - "CUSTOMER_SUPPORT", - "CREATE_APPS", - "CLOUD_MANAGED_DEVELOPER_ID", - "CLOUD_MANAGED_APP_DISTRIBUTION", - "GENERATE_INDIVIDUAL_KEYS" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "filter[visibleApps]", - "in": "query", - "description": "filter by id(s) of related 'visibleApps'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "sort", - "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "username", - "-username", - "lastName", - "-lastName" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[users]", - "in": "query", - "description": "the fields to include for returned resources of type users", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "username", - "firstName", - "lastName", - "roles", - "allAppsVisible", - "provisioningAllowed", - "visibleApps" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "fields[apps]", - "in": "query", - "description": "the fields to include for returned resources of type apps", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "visibleApps" - ] + "operationId": "subscriptionPromotionalOffers_createInstance", + "requestBody": { + "description": "SubscriptionPromotionalOffer representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionPromotionalOfferCreateRequest" } - }, - "style": "form", - "explode": false, - "required": false + } }, - { - "name": "limit[visibleApps]", - "in": "query", - "description": "maximum number of related visibleApps returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "required": false - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -78808,12 +77751,32 @@ } } }, - "200": { - "description": "List of Users", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UsersResponse" + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Single SubscriptionPromotionalOffer", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionPromotionalOfferResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -78831,29 +77794,30 @@ } } }, - "/v1/users/{id}": { + "/v1/subscriptionPromotionalOffers/{id}": { "get": { "tags": [ - "Users" + "SubscriptionPromotionalOffers" ], - "operationId": "users_getInstance", + "operationId": "subscriptionPromotionalOffers_getInstance", "parameters": [ { - "name": "fields[users]", + "name": "fields[subscriptionPromotionalOffers]", "in": "query", - "description": "the fields to include for returned resources of type users", + "description": "the fields to include for returned resources of type subscriptionPromotionalOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "username", - "firstName", - "lastName", - "roles", - "allAppsVisible", - "provisioningAllowed", - "visibleApps" + "duration", + "name", + "numberOfPeriods", + "offerCode", + "offerMode", + "targetSubscriptionPlanType", + "subscription", + "prices" ] } }, @@ -78862,71 +77826,58 @@ "required": false }, { - "name": "fields[apps]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "the fields to include for returned resources of type subscriptions", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" + "productId", + "familySharable", + "state", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[subscriptionPromotionalOfferPrices]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPromotionalOfferPrices", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "territory", + "subscriptionPricePoint" ] } }, @@ -78943,7 +77894,8 @@ "items": { "type": "string", "enum": [ - "visibleApps" + "subscription", + "prices" ] } }, @@ -78952,9 +77904,9 @@ "required": false }, { - "name": "limit[visibleApps]", + "name": "limit[prices]", "in": "query", - "description": "maximum number of related visibleApps returned (when they are included)", + "description": "maximum number of related prices returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -79005,11 +77957,11 @@ } }, "200": { - "description": "Single User", + "description": "Single SubscriptionPromotionalOffer", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserResponse" + "$ref": "#/components/schemas/SubscriptionPromotionalOfferResponse" } } } @@ -79028,15 +77980,15 @@ }, "patch": { "tags": [ - "Users" + "SubscriptionPromotionalOffers" ], - "operationId": "users_updateInstance", + "operationId": "subscriptionPromotionalOffers_updateInstance", "requestBody": { - "description": "User representation", + "description": "SubscriptionPromotionalOffer representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserUpdateRequest" + "$ref": "#/components/schemas/SubscriptionPromotionalOfferUpdateRequest" } } }, @@ -79094,11 +78046,11 @@ } }, "200": { - "description": "Single User", + "description": "Single SubscriptionPromotionalOffer", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserResponse" + "$ref": "#/components/schemas/SubscriptionPromotionalOfferResponse" } } } @@ -79127,9 +78079,9 @@ }, "delete": { "tags": [ - "Users" + "SubscriptionPromotionalOffers" ], - "operationId": "users_deleteInstance", + "operationId": "subscriptionPromotionalOffers_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -79199,18 +78151,18 @@ } ] }, - "/v1/webhookDeliveries": { + "/v1/subscriptionSubmissions": { "post": { "tags": [ - "WebhookDeliveries" + "SubscriptionSubmissions" ], - "operationId": "webhookDeliveries_createInstance", + "operationId": "subscriptionSubmissions_createInstance", "requestBody": { - "description": "WebhookDelivery representation", + "description": "SubscriptionSubmission representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookDeliveryCreateRequest" + "$ref": "#/components/schemas/SubscriptionSubmissionCreateRequest" } } }, @@ -79258,11 +78210,11 @@ } }, "201": { - "description": "Single WebhookDelivery", + "description": "Single SubscriptionSubmission", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookDeliveryResponse" + "$ref": "#/components/schemas/SubscriptionSubmissionResponse" } } } @@ -79290,18 +78242,18 @@ } } }, - "/v1/webhookPings": { + "/v1/subscriptionVersions": { "post": { "tags": [ - "WebhookPings" + "SubscriptionVersions" ], - "operationId": "webhookPings_createInstance", + "operationId": "subscriptionVersions_createInstance", "requestBody": { - "description": "WebhookPing representation", + "description": "SubscriptionVersion representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookPingCreateRequest" + "$ref": "#/components/schemas/SubscriptionVersionCreateRequest" } } }, @@ -79349,11 +78301,11 @@ } }, "201": { - "description": "Single WebhookPing", + "description": "Single SubscriptionVersion", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookPingResponse" + "$ref": "#/components/schemas/SubscriptionVersionResponse" } } } @@ -79381,23 +78333,162 @@ } } }, - "/v1/webhooks": { - "post": { + "/v1/subscriptionVersions/{id}": { + "get": { "tags": [ - "Webhooks" + "SubscriptionVersions" ], - "operationId": "webhooks_createInstance", - "requestBody": { - "description": "Webhook representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookCreateRequest" + "operationId": "subscriptionVersions_getInstance", + "parameters": [ + { + "name": "fields[subscriptionVersions]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "subscription", + "image", + "images", + "localizations" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "required": true - }, + { + "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", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[subscriptionImages]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "assetToken", + "imageAsset", + "uploadOperations", + "assetDeliveryState" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[subscriptionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "locale", + "description", + "version" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "subscription", + "image", + "images", + "localizations" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "limit[images]", + "in": "query", + "description": "maximum number of related images returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[localizations]", + "in": "query", + "description": "maximum number of related localizations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -79429,8 +78520,8 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", + "404": { + "description": "Not found error", "content": { "application/json": { "schema": { @@ -79439,22 +78530,12 @@ } } }, - "201": { - "description": "Single Webhook", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Single SubscriptionVersion", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/SubscriptionVersionResponse" } } } @@ -79470,202 +78551,32 @@ } } } - } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] }, - "/v1/webhooks/{id}": { - "get": { - "tags": [ - "Webhooks" - ], - "operationId": "webhooks_getInstance", - "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, - "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" - ] - } - }, - "style": "form", - "explode": false, - "required": false - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "app" - ] - } - }, - "style": "form", - "explode": false, - "required": false - } - ], - "responses": { - "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 Webhook", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "patch": { + "/v1/subscriptions": { + "post": { "tags": [ - "Webhooks" + "Subscriptions" ], - "operationId": "webhooks_updateInstance", + "operationId": "subscriptions_createInstance", "requestBody": { - "description": "Webhook representation", + "description": "Subscription representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookUpdateRequest" + "$ref": "#/components/schemas/SubscriptionCreateRequest" } } }, @@ -79702,16 +78613,6 @@ } } }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "422": { "description": "Unprocessable request entity error(s)", "content": { @@ -79722,12 +78623,12 @@ } } }, - "200": { - "description": "Single Webhook", + "201": { + "description": "Single Subscription", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookResponse" + "$ref": "#/components/schemas/SubscriptionResponse" } } } @@ -79753,179 +78654,265 @@ } } } - }, - "delete": { + } + }, + "/v1/subscriptions/{id}": { + "get": { "tags": [ - "Webhooks" + "Subscriptions" ], - "operationId": "webhooks_deleteInstance", - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + "operationId": "subscriptions_getInstance", + "parameters": [ + { + "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", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "fields[subscriptionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "locale", + "description", + "state", + "subscription" + ] } - } - }, - "204": { - "description": "Success (no content)" + }, + "style": "form", + "explode": false, + "required": false }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "fields[subscriptionAppStoreReviewScreenshots]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "imageAsset", + "assetToken", + "assetType", + "uploadOperations", + "assetDeliveryState", + "subscription" + ] } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + }, + "style": "form", + "explode": false, + "required": false }, - "style": "simple", - "required": true - } - ] - }, - "/v1/winBackOffers": { - "post": { - "tags": [ - "WinBackOffers" - ], - "operationId": "winBackOffers_createInstance", - "requestBody": { - "description": "WinBackOffer representation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WinBackOfferCreateRequest" + { + "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", + "versions" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "required": true - }, - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "fields[subscriptionIntroductoryOffers]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionIntroductoryOffers", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "startDate", + "endDate", + "duration", + "offerMode", + "numberOfPeriods", + "targetSubscriptionPlanType", + "subscription", + "territory", + "subscriptionPricePoint" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "fields[subscriptionPromotionalOffers]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPromotionalOffers", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "duration", + "name", + "numberOfPeriods", + "offerCode", + "offerMode", + "targetSubscriptionPlanType", + "subscription", + "prices" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "fields[subscriptionOfferCodes]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionOfferCodes", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "customerEligibilities", + "offerEligibility", + "duration", + "offerMode", + "numberOfPeriods", + "totalNumberOfCodes", + "productionCodeCount", + "sandboxCodeCount", + "active", + "autoRenewEnabled", + "targetSubscriptionPlanType", + "subscription", + "oneTimeUseCodes", + "customCodes", + "prices" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "fields[subscriptionPrices]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPrices", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "startDate", + "preserved", + "planType", + "territory", + "subscriptionPricePoint" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "201": { - "description": "Single WinBackOffer", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WinBackOfferResponse" - } + { + "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 }, - "409": { - "description": "Request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "fields[subscriptionAvailabilities]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionAvailabilities", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "availableInNewTerritories", + "availableTerritories" + ] } - } + }, + "style": "form", + "explode": false, + "required": false, + "deprecated": true }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/v1/winBackOffers/{id}": { - "get": { - "tags": [ - "WinBackOffers" - ], - "operationId": "winBackOffers_getInstance", - "parameters": [ { "name": "fields[winBackOffers]", "in": "query", @@ -79957,16 +78944,108 @@ "required": false }, { - "name": "fields[winBackOfferPrices]", + "name": "fields[subscriptionImages]", "in": "query", - "description": "the fields to include for returned resources of type winBackOfferPrices", + "description": "the fields to include for returned resources of type subscriptionImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "territory", - "subscriptionPricePoint" + "fileSize", + "fileName", + "sourceFileChecksum", + "assetToken", + "imageAsset", + "uploadOperations", + "state", + "subscription" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[subscriptionPlanAvailabilities]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPlanAvailabilities", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "availableInNewTerritories", + "planType", + "availableTerritories" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[subscriptionVersions]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "subscription", + "image", + "images", + "localizations" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[retentionOffers]", + "in": "query", + "description": "the fields to include for returned resources of type retentionOffers", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "referenceName", + "offerId", + "duration", + "offerMode", + "periodCount", + "customerEligibilityPaidSubscriptionDurationInMonths", + "customerEligibilityWaitBetweenOffersInMonths", + "targetSubscriptionPlanType", + "subscription", + "prices" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[retentionMessages]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "referenceName", + "versions", + "subscriptions" ] } }, @@ -79983,7 +79062,22 @@ "items": { "type": "string", "enum": [ - "prices" + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -79991,6 +79085,50 @@ "explode": false, "required": false }, + { + "name": "limit[images]", + "in": "query", + "description": "maximum number of related images returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[introductoryOffers]", + "in": "query", + "description": "maximum number of related introductoryOffers returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[offerCodes]", + "in": "query", + "description": "maximum number of related offerCodes returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[planAvailabilities]", + "in": "query", + "description": "maximum number of related planAvailabilities returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, { "name": "limit[prices]", "in": "query", @@ -80001,6 +79139,72 @@ }, "style": "form", "required": false + }, + { + "name": "limit[promotionalOffers]", + "in": "query", + "description": "maximum number of related promotionalOffers returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[retentionMessageOffers]", + "in": "query", + "description": "maximum number of related retentionMessageOffers returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[retentionOffers]", + "in": "query", + "description": "maximum number of related retentionOffers returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[subscriptionLocalizations]", + "in": "query", + "description": "maximum number of related subscriptionLocalizations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false + }, + { + "name": "limit[winBackOffers]", + "in": "query", + "description": "maximum number of related winBackOffers returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false } ], "responses": { @@ -80045,11 +79249,11 @@ } }, "200": { - "description": "Single WinBackOffer", + "description": "Single Subscription", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WinBackOfferResponse" + "$ref": "#/components/schemas/SubscriptionResponse" } } } @@ -80068,15 +79272,15 @@ }, "patch": { "tags": [ - "WinBackOffers" + "Subscriptions" ], - "operationId": "winBackOffers_updateInstance", + "operationId": "subscriptions_updateInstance", "requestBody": { - "description": "WinBackOffer representation", + "description": "Subscription representation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WinBackOfferUpdateRequest" + "$ref": "#/components/schemas/SubscriptionUpdateRequest" } } }, @@ -80134,11 +79338,11 @@ } }, "200": { - "description": "Single WinBackOffer", + "description": "Single Subscription", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WinBackOfferResponse" + "$ref": "#/components/schemas/SubscriptionResponse" } } } @@ -80167,9 +79371,9 @@ }, "delete": { "tags": [ - "WinBackOffers" + "Subscriptions" ], - "operationId": "winBackOffers_deleteInstance", + "operationId": "subscriptions_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -80239,13 +79443,30 @@ } ] }, - "/v1/alternativeDistributionPackageVersions/{id}/relationships/deltas": { + "/v1/territories": { "get": { "tags": [ - "AlternativeDistributionPackageVersions" + "Territories" ], - "operationId": "alternativeDistributionPackageVersions_deltas_getToManyRelationship", + "operationId": "territories_getCollection", "parameters": [ + { + "name": "fields[territories]", + "in": "query", + "description": "the fields to include for returned resources of type territories", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "currency" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, { "name": "limit", "in": "query", @@ -80288,22 +79509,12 @@ } } }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { - "description": "List of related linkages", + "description": "List of Territories", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AlternativeDistributionPackageVersionDeltasLinkagesResponse" + "$ref": "#/components/schemas/TerritoriesResponse" } } } @@ -80319,57 +79530,25 @@ } } } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] + } }, - "/v1/alternativeDistributionPackageVersions/{id}/deltas": { - "get": { + "/v1/territoryAvailabilities/{id}": { + "patch": { "tags": [ - "AlternativeDistributionPackageVersions" + "TerritoryAvailabilities" ], - "operationId": "alternativeDistributionPackageVersions_deltas_getToManyRelated", - "parameters": [ - { - "name": "fields[alternativeDistributionPackageDeltas]", - "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionPackageDeltas", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "url", - "urlExpirationDate", - "alternativeDistributionKeyBlob", - "fileChecksum" - ] + "operationId": "territoryAvailabilities_updateInstance", + "requestBody": { + "description": "TerritoryAvailability representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TerritoryAvailabilityUpdateRequest" } - }, - "style": "form", - "explode": false + } }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -80411,72 +79590,8 @@ } } }, - "200": { - "description": "List of AlternativeDistributionPackageDeltas", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlternativeDistributionPackageDeltasResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/alternativeDistributionPackageVersions/{id}/relationships/variants": { - "get": { - "tags": [ - "AlternativeDistributionPackageVersions" - ], - "operationId": "alternativeDistributionPackageVersions_variants_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)", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { @@ -80485,18 +79600,18 @@ } } }, - "403": { - "description": "Forbidden error", + "200": { + "description": "Single TerritoryAvailability", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/TerritoryAvailabilityResponse" } } } }, - "404": { - "description": "Not found error", + "409": { + "description": "Request entity error(s)", "content": { "application/json": { "schema": { @@ -80505,16 +79620,6 @@ } } }, - "200": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlternativeDistributionPackageVersionVariantsLinkagesResponse" - } - } - } - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -80540,31 +79645,187 @@ } ] }, - "/v1/alternativeDistributionPackageVersions/{id}/variants": { + "/v1/userInvitations": { "get": { "tags": [ - "AlternativeDistributionPackageVersions" + "UserInvitations" ], - "operationId": "alternativeDistributionPackageVersions_variants_getToManyRelated", + "operationId": "userInvitations_getCollection", "parameters": [ { - "name": "fields[alternativeDistributionPackageVariants]", + "name": "filter[email]", "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionPackageVariants", + "description": "filter by attribute 'email'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "filter[roles]", + "in": "query", + "description": "filter by attribute 'roles'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "url", - "urlExpirationDate", - "alternativeDistributionKeyBlob", - "fileChecksum" + "ADMIN", + "FINANCE", + "ACCOUNT_HOLDER", + "SALES", + "MARKETING", + "APP_MANAGER", + "DEVELOPER", + "ACCESS_TO_REPORTS", + "CUSTOMER_SUPPORT", + "CREATE_APPS", + "CLOUD_MANAGED_DEVELOPER_ID", + "CLOUD_MANAGED_APP_DISTRIBUTION", + "GENERATE_INDIVIDUAL_KEYS" ] } }, "style": "form", - "explode": false + "explode": false, + "required": false + }, + { + "name": "filter[visibleApps]", + "in": "query", + "description": "filter by id(s) of related 'visibleApps'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "email", + "-email", + "lastName", + "-lastName" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[userInvitations]", + "in": "query", + "description": "the fields to include for returned resources of type userInvitations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "email", + "firstName", + "lastName", + "expirationDate", + "roles", + "allAppsVisible", + "provisioningAllowed", + "visibleApps" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "fields[apps]", + "in": "query", + "description": "the fields to include for returned resources of type apps", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" + ] + } + }, + "style": "form", + "explode": false, + "required": false }, { "name": "limit", @@ -80575,6 +79836,34 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "visibleApps" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "limit[visibleApps]", + "in": "query", + "description": "maximum number of related visibleApps returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false } ], "responses": { @@ -80608,22 +79897,12 @@ } } }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { - "description": "List of AlternativeDistributionPackageVariants", + "description": "List of UserInvitations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AlternativeDistributionPackageVariantsResponse" + "$ref": "#/components/schemas/UserInvitationsResponse" } } } @@ -80640,37 +79919,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/alternativeDistributionPackages/{id}/relationships/versions": { - "get": { + "post": { "tags": [ - "AlternativeDistributionPackages" - ], - "operationId": "alternativeDistributionPackages_versions_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "UserInvitations" ], + "operationId": "userInvitations_createInstance", + "requestBody": { + "description": "UserInvitation representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInvitationCreateRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -80702,8 +79966,8 @@ } } }, - "404": { - "description": "Not found error", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { @@ -80712,12 +79976,22 @@ } } }, - "200": { - "description": "List of related linkages", + "201": { + "description": "Single UserInvitation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AlternativeDistributionPackageVersionsLinkagesResponse" + "$ref": "#/components/schemas/UserInvitationResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -80733,131 +80007,112 @@ } } } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] + } }, - "/v1/alternativeDistributionPackages/{id}/versions": { + "/v1/userInvitations/{id}": { "get": { "tags": [ - "AlternativeDistributionPackages" + "UserInvitations" ], - "operationId": "alternativeDistributionPackages_versions_getToManyRelated", + "operationId": "userInvitations_getInstance", "parameters": [ { - "name": "filter[state]", - "in": "query", - "description": "filter by attribute 'state'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "COMPLETED", - "REPLACED" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[alternativeDistributionPackageVersions]", - "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionPackageVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "url", - "urlExpirationDate", - "version", - "fileChecksum", - "state", - "variants", - "deltas", - "alternativeDistributionPackage" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[alternativeDistributionPackageVariants]", - "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionPackageVariants", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "url", - "urlExpirationDate", - "alternativeDistributionKeyBlob", - "fileChecksum" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[alternativeDistributionPackageDeltas]", + "name": "fields[userInvitations]", "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionPackageDeltas", + "description": "the fields to include for returned resources of type userInvitations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "url", - "urlExpirationDate", - "alternativeDistributionKeyBlob", - "fileChecksum" + "email", + "firstName", + "lastName", + "expirationDate", + "roles", + "allAppsVisible", + "provisioningAllowed", + "visibleApps" ] } }, "style": "form", - "explode": false + "explode": false, + "required": false }, { - "name": "fields[alternativeDistributionPackages]", + "name": "fields[apps]", "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionPackages", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "sourceFileChecksum", - "versions" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "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" + "explode": false, + "required": false }, { "name": "include", @@ -80868,34 +80123,24 @@ "items": { "type": "string", "enum": [ - "variants", - "deltas", - "alternativeDistributionPackage" + "visibleApps" ] } }, "style": "form", - "explode": false - }, - { - "name": "limit[variants]", - "in": "query", - "description": "maximum number of related variants returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" + "explode": false, + "required": false }, { - "name": "limit[deltas]", + "name": "limit[visibleApps]", "in": "query", - "description": "maximum number of related deltas returned (when they are included)", + "description": "maximum number of related visibleApps returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, - "style": "form" + "style": "form", + "required": false } ], "responses": { @@ -80940,11 +80185,11 @@ } }, "200": { - "description": "List of AlternativeDistributionPackageVersions", + "description": "Single UserInvitation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AlternativeDistributionPackageVersionsResponse" + "$ref": "#/components/schemas/UserInvitationResponse" } } } @@ -80961,37 +80206,11 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/analyticsReportInstances/{id}/relationships/segments": { - "get": { + "delete": { "tags": [ - "AnalyticsReportInstances" - ], - "operationId": "analyticsReportInstances_segments_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "UserInvitations" ], + "operationId": "userInvitations_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -81033,15 +80252,8 @@ } } }, - "200": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnalyticsReportInstanceSegmentsLinkagesResponse" - } - } - } + "204": { + "description": "Success (no content)" }, "429": { "description": "Rate limit exceeded error", @@ -81068,125 +80280,187 @@ } ] }, - "/v1/analyticsReportInstances/{id}/segments": { + "/v1/users": { "get": { "tags": [ - "AnalyticsReportInstances" + "Users" ], - "operationId": "analyticsReportInstances_segments_getToManyRelated", + "operationId": "users_getCollection", "parameters": [ { - "name": "fields[analyticsReportSegments]", + "name": "filter[username]", "in": "query", - "description": "the fields to include for returned resources of type analyticsReportSegments", + "description": "filter by attribute 'username'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "filter[roles]", + "in": "query", + "description": "filter by attribute 'roles'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "checksum", - "sizeInBytes", - "url" + "ADMIN", + "FINANCE", + "ACCOUNT_HOLDER", + "SALES", + "MARKETING", + "APP_MANAGER", + "DEVELOPER", + "ACCESS_TO_REPORTS", + "CUSTOMER_SUPPORT", + "CREATE_APPS", + "CLOUD_MANAGED_DEVELOPER_ID", + "CLOUD_MANAGED_APP_DISTRIBUTION", + "GENERATE_INDIVIDUAL_KEYS" ] } }, "style": "form", - "explode": false + "explode": false, + "required": false }, { - "name": "limit", + "name": "filter[visibleApps]", "in": "query", - "description": "maximum resources per page", + "description": "filter by id(s) of related 'visibleApps'", "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" - } + "type": "array", + "items": { + "type": "string" } - } + }, + "style": "form", + "explode": false, + "required": false }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "username", + "-username", + "lastName", + "-lastName" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "200": { - "description": "List of AnalyticsReportSegments", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnalyticsReportSegmentsResponse" - } + { + "name": "fields[users]", + "in": "query", + "description": "the fields to include for returned resources of type users", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "username", + "firstName", + "lastName", + "roles", + "allAppsVisible", + "provisioningAllowed", + "visibleApps" + ] } - } + }, + "style": "form", + "explode": false, + "required": false }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" + ] } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + }, + "style": "form", + "explode": false, + "required": false }, - "style": "simple", - "required": true - } - ] - }, - "/v1/analyticsReportRequests/{id}/relationships/reports": { - "get": { - "tags": [ - "AnalyticsReportRequests" - ], - "operationId": "analyticsReportRequests_reports_getToManyRelationship", - "parameters": [ { "name": "limit", "in": "query", @@ -81196,6 +80470,34 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "visibleApps" + ] + } + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "limit[visibleApps]", + "in": "query", + "description": "maximum number of related visibleApps returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "required": false } ], "responses": { @@ -81229,22 +80531,12 @@ } } }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { - "description": "List of related linkages", + "description": "List of Users", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnalyticsReportRequestReportsLinkagesResponse" + "$ref": "#/components/schemas/UsersResponse" } } } @@ -81260,87 +80552,139 @@ } } } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] + } }, - "/v1/analyticsReportRequests/{id}/reports": { + "/v1/users/{id}": { "get": { "tags": [ - "AnalyticsReportRequests" + "Users" ], - "operationId": "analyticsReportRequests_reports_getToManyRelated", + "operationId": "users_getInstance", "parameters": [ { - "name": "filter[name]", + "name": "fields[users]", "in": "query", - "description": "filter by attribute 'name'", + "description": "the fields to include for returned resources of type users", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "username", + "firstName", + "lastName", + "roles", + "allAppsVisible", + "provisioningAllowed", + "visibleApps" + ] } }, "style": "form", - "explode": false + "explode": false, + "required": false }, { - "name": "filter[category]", + "name": "fields[apps]", "in": "query", - "description": "filter by attribute 'category'", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "APP_USAGE", - "APP_STORE_ENGAGEMENT", - "COMMERCE", - "FRAMEWORK_USAGE", - "PERFORMANCE" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, "style": "form", - "explode": false + "explode": false, + "required": false }, { - "name": "fields[analyticsReports]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type analyticsReports", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "category", - "instances" + "visibleApps" ] } }, "style": "form", - "explode": false + "explode": false, + "required": false }, { - "name": "limit", + "name": "limit[visibleApps]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related visibleApps returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "maximum": 50 }, - "style": "form" + "style": "form", + "required": false } ], "responses": { @@ -81385,11 +80729,11 @@ } }, "200": { - "description": "List of AnalyticsReports", + "description": "Single User", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnalyticsReportsResponse" + "$ref": "#/components/schemas/UserResponse" } } } @@ -81406,37 +80750,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/analyticsReports/{id}/relationships/instances": { - "get": { + "patch": { "tags": [ - "AnalyticsReports" - ], - "operationId": "analyticsReports_instances_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "Users" ], + "operationId": "users_updateInstance", + "requestBody": { + "description": "User representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserUpdateRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -81478,12 +80807,32 @@ } } }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { - "description": "List of related linkages", + "description": "Single User", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnalyticsReportInstancesLinkagesResponse" + "$ref": "#/components/schemas/UserResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -81500,86 +80849,11 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/analyticsReports/{id}/instances": { - "get": { + "delete": { "tags": [ - "AnalyticsReports" - ], - "operationId": "analyticsReports_instances_getToManyRelated", - "parameters": [ - { - "name": "filter[granularity]", - "in": "query", - "description": "filter by attribute 'granularity'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "DAILY", - "WEEKLY", - "MONTHLY" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[processingDate]", - "in": "query", - "description": "filter by attribute 'processingDate'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[analyticsReportInstances]", - "in": "query", - "description": "the fields to include for returned resources of type analyticsReportInstances", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "granularity", - "processingDate", - "segments" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "Users" ], + "operationId": "users_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -81621,15 +80895,8 @@ } } }, - "200": { - "description": "List of AnalyticsReportInstances", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnalyticsReportInstancesResponse" - } - } - } + "204": { + "description": "Success (no content)" }, "429": { "description": "Rate limit exceeded error", @@ -81656,24 +80923,23 @@ } ] }, - "/v1/appAssetLibraries/{id}/relationships/images": { - "get": { + "/v1/webhookDeliveries": { + "post": { "tags": [ - "AppAssetLibraries" - ], - "operationId": "appAssetLibraries_images_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "WebhookDeliveries" ], + "operationId": "webhookDeliveries_createInstance", + "requestBody": { + "description": "WebhookDelivery representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebhookDeliveryCreateRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -81705,8 +80971,8 @@ } } }, - "404": { - "description": "Not found error", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { @@ -81715,12 +80981,22 @@ } } }, - "200": { - "description": "List of related linkages", + "201": { + "description": "Single WebhookDelivery", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryImagesLinkagesResponse" + "$ref": "#/components/schemas/WebhookDeliveryResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -81736,195 +81012,292 @@ } } } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + } + }, + "/v1/webhookPings": { + "post": { + "tags": [ + "WebhookPings" + ], + "operationId": "webhookPings_createInstance", + "requestBody": { + "description": "WebhookPing representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebhookPingCreateRequest" + } + } }, - "style": "simple", "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Single WebhookPing", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebhookPingResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } } - ] + } }, - "/v1/appAssetLibraries/{id}/images": { - "get": { + "/v1/webhooks": { + "post": { "tags": [ - "AppAssetLibraries" + "Webhooks" ], - "operationId": "appAssetLibraries_images_getToManyRelated", - "parameters": [ - { - "name": "filter[category]", - "in": "query", - "description": "filter by attribute 'category'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "CREATIVE_ASSETS", - "APP_SCREENSHOTS_AND_PREVIEWS" - ] + "operationId": "webhooks_createInstance", + "requestBody": { + "description": "Webhook representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebhookCreateRequest" } - }, - "style": "form", - "explode": false + } }, - { - "name": "filter[state]", - "in": "query", - "description": "filter by attribute 'state'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "AWAITING_UPLOAD", - "UPLOAD_COMPLETE", - "FAILED", - "COMPLETE", - "PREPARE_FOR_SUBMISSION", - "READY_FOR_REVIEW", - "WAITING_FOR_REVIEW", - "IN_REVIEW", - "ACCEPTED", - "APPROVED", - "REJECTED", - "ARCHIVED" - ] + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "filter[referenceName]", - "in": "query", - "description": "filter by attribute 'referenceName'", - "schema": { - "type": "array", - "items": { - "type": "string" + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "filter[specId]", - "in": "query", - "description": "filter by attribute 'specId'", - "schema": { - "type": "array", - "items": { - "type": "string" + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "sort", - "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "createdDate", - "-createdDate", - "lastModifiedDate", - "-lastModifiedDate", - "referenceName", - "-referenceName" - ] + "201": { + "description": "Single Webhook", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebhookResponse" + } } - }, - "style": "form", - "explode": false + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/webhooks/{id}": { + "get": { + "tags": [ + "Webhooks" + ], + "operationId": "webhooks_getInstance", + "parameters": [ { - "name": "fields[appAssetLibraryImages]", + "name": "fields[webhooks]", "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryImages", + "description": "the fields to include for returned resources of type webhooks", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "imageAsset", - "referenceName", - "specId", - "state", - "stateDetails", - "uploadOperations", - "placements" + "enabled", + "eventTypes", + "name", + "url", + "app", + "deliveries" ] } }, "style": "form", - "explode": false + "explode": false, + "required": false }, { - "name": "fields[appAssetLibraryPlacements]", + "name": "fields[apps]", "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "mediaType", - "placementType", - "placementGroup", - "createdDate", - "lastModifiedDate", - "state", - "stateDetails", - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "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" + "explode": false, + "required": false }, { "name": "include", @@ -81935,22 +81308,13 @@ "items": { "type": "string", "enum": [ - "placements" + "app" ] } }, "style": "form", - "explode": false - }, - { - "name": "limit[placements]", - "in": "query", - "description": "maximum number of related placements returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" + "explode": false, + "required": false } ], "responses": { @@ -81995,11 +81359,11 @@ } }, "200": { - "description": "List of AppAssetLibraryImages", + "description": "Single Webhook", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryImagesResponse" + "$ref": "#/components/schemas/WebhookResponse" } } } @@ -82016,37 +81380,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appAssetLibraries/{id}/relationships/videos": { - "get": { + "patch": { "tags": [ - "AppAssetLibraries" - ], - "operationId": "appAssetLibraries_videos_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "Webhooks" ], + "operationId": "webhooks_updateInstance", + "requestBody": { + "description": "Webhook representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebhookUpdateRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -82088,16 +81437,97 @@ } } }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { - "description": "List of related linkages", + "description": "Single Webhook", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryVideosLinkagesResponse" + "$ref": "#/components/schemas/WebhookResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Webhooks" + ], + "operationId": "webhooks_deleteInstance", + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } }, + "204": { + "description": "Success (no content)" + }, "429": { "description": "Rate limit exceeded error", "content": { @@ -82123,183 +81553,151 @@ } ] }, - "/v1/appAssetLibraries/{id}/videos": { - "get": { + "/v1/winBackOffers": { + "post": { "tags": [ - "AppAssetLibraries" + "WinBackOffers" ], - "operationId": "appAssetLibraries_videos_getToManyRelated", - "parameters": [ - { - "name": "filter[category]", - "in": "query", - "description": "filter by attribute 'category'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "CREATIVE_ASSETS", - "APP_SCREENSHOTS_AND_PREVIEWS" - ] + "operationId": "winBackOffers_createInstance", + "requestBody": { + "description": "WinBackOffer representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WinBackOfferCreateRequest" } - }, - "style": "form", - "explode": false + } }, - { - "name": "filter[state]", - "in": "query", - "description": "filter by attribute 'state'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "AWAITING_UPLOAD", - "UPLOAD_COMPLETE", - "FAILED", - "COMPLETE", - "PREPARE_FOR_SUBMISSION", - "READY_FOR_REVIEW", - "WAITING_FOR_REVIEW", - "IN_REVIEW", - "ACCEPTED", - "APPROVED", - "REJECTED", - "ARCHIVED" - ] + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "filter[referenceName]", - "in": "query", - "description": "filter by attribute 'referenceName'", - "schema": { - "type": "array", - "items": { - "type": "string" + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "filter[specId]", - "in": "query", - "description": "filter by attribute 'specId'", - "schema": { - "type": "array", - "items": { - "type": "string" + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "sort", - "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "createdDate", - "-createdDate", - "lastModifiedDate", - "-lastModifiedDate", - "referenceName", - "-referenceName" - ] + "201": { + "description": "Single WinBackOffer", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WinBackOfferResponse" + } } - }, - "style": "form", - "explode": false + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/v1/winBackOffers/{id}": { + "get": { + "tags": [ + "WinBackOffers" + ], + "operationId": "winBackOffers_getInstance", + "parameters": [ { - "name": "fields[appAssetLibraryVideos]", + "name": "fields[winBackOffers]", "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "description": "the fields to include for returned resources of type winBackOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "previewFrameImage", - "previewFrameTimeCode", "referenceName", - "specId", - "state", - "stateDetails", - "uploadOperations", - "videoAsset", - "placements" + "offerId", + "duration", + "offerMode", + "periodCount", + "customerEligibilityPaidSubscriptionDurationInMonths", + "customerEligibilityTimeSinceLastSubscribedInMonths", + "customerEligibilityWaitBetweenOffersInMonths", + "startDate", + "endDate", + "priority", + "promotionIntent", + "targetSubscriptionPlanType", + "prices" ] } }, "style": "form", - "explode": false + "explode": false, + "required": false }, { - "name": "fields[appAssetLibraryPlacements]", + "name": "fields[winBackOfferPrices]", "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "description": "the fields to include for returned resources of type winBackOfferPrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "mediaType", - "placementType", - "placementGroup", - "createdDate", - "lastModifiedDate", - "state", - "stateDetails", - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "territory", + "subscriptionPricePoint" ] } }, "style": "form", - "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" + "explode": false, + "required": false }, { "name": "include", @@ -82310,22 +81708,24 @@ "items": { "type": "string", "enum": [ - "placements" + "prices" ] } }, "style": "form", - "explode": false + "explode": false, + "required": false }, { - "name": "limit[placements]", + "name": "limit[prices]", "in": "query", - "description": "maximum number of related placements returned (when they are included)", + "description": "maximum number of related prices returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, - "style": "form" + "style": "form", + "required": false } ], "responses": { @@ -82370,11 +81770,11 @@ } }, "200": { - "description": "List of AppAssetLibraryVideos", + "description": "Single WinBackOffer", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryVideosResponse" + "$ref": "#/components/schemas/WinBackOfferResponse" } } } @@ -82391,37 +81791,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appAssetLibraryImages/{id}/relationships/placements": { - "get": { + "patch": { "tags": [ - "AppAssetLibraryImages" - ], - "operationId": "appAssetLibraryImages_placements_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "WinBackOffers" ], + "operationId": "winBackOffers_updateInstance", + "requestBody": { + "description": "WinBackOffer representation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WinBackOfferUpdateRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -82463,12 +81848,32 @@ } } }, + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "200": { - "description": "List of related linkages", + "description": "Single WinBackOffer", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryImagePlacementsLinkagesResponse" + "$ref": "#/components/schemas/WinBackOfferResponse" + } + } + } + }, + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -82485,393 +81890,11 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appAssetLibraryImages/{id}/placements": { - "get": { + "delete": { "tags": [ - "AppAssetLibraryImages" - ], - "operationId": "appAssetLibraryImages_placements_getToManyRelated", - "parameters": [ - { - "name": "filter[placementType]", - "in": "query", - "description": "filter by attribute 'placementType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "APP_SCREENSHOT", - "IMESSAGE_APP_SCREENSHOT", - "APP_PREVIEW", - "PRODUCT_PAGE_HEADER_ASSET", - "APP_STORE_SEARCH_RESULTS_ASSET", - "SEARCH_RESULTS_ADS_ASSET", - "TODAY_TAB_ADS_ASSET", - "EVENT_CARD_ASSET", - "EVENT_DETAILS_PAGE_ASSET", - "RETENTION_MESSAGE_ASSET" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[placementGroup]", - "in": "query", - "description": "filter by attribute 'placementGroup'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[state]", - "in": "query", - "description": "filter by attribute 'state'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "ASSET_PROCESSING", - "FAILED", - "PARENT_PREPARE_FOR_SUBMISSION", - "PARENT_READY_FOR_REVIEW", - "PARENT_WAITING_FOR_REVIEW", - "PARENT_IN_REVIEW", - "PARENT_APPROVED" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[video]", - "in": "query", - "description": "filter by id(s) of related 'video'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appEventLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appEventLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appCustomProductPageLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appCustomProductPageLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionExperimentTreatmentLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "sort", - "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "createdDate", - "-createdDate", - "lastModifiedDate", - "-lastModifiedDate", - "placementGroupPosition", - "-placementGroupPosition" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryPlacements]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryPlacements", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "mediaType", - "placementType", - "placementGroup", - "createdDate", - "lastModifiedDate", - "state", - "stateDetails", - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryImages]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "imageAsset", - "referenceName", - "specId", - "state", - "stateDetails", - "uploadOperations", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryVideos]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryVideos", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "previewFrameImage", - "previewFrameTimeCode", - "referenceName", - "specId", - "state", - "stateDetails", - "uploadOperations", - "videoAsset", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appEventLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appEventLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "shortDescription", - "longDescription", - "appEvent", - "appEventScreenshots", - "appEventVideoClips", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appCustomProductPageLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "promotionalText", - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" - ] - } - }, - "style": "form", - "explode": false - } + "WinBackOffers" ], + "operationId": "winBackOffers_deleteInstance", "responses": { "400": { "description": "Parameter error(s)", @@ -82913,15 +81936,8 @@ } } }, - "200": { - "description": "List of AppAssetLibraryPlacements", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" - } - } - } + "204": { + "description": "Success (no content)" }, "429": { "description": "Rate limit exceeded error", @@ -82948,12 +81964,12 @@ } ] }, - "/v1/appAssetLibraryVideos/{id}/relationships/placements": { + "/v1/alternativeDistributionPackageVersions/{id}/relationships/deltas": { "get": { "tags": [ - "AppAssetLibraryVideos" + "AlternativeDistributionPackageVersions" ], - "operationId": "appAssetLibraryVideos_placements_getToManyRelationship", + "operationId": "alternativeDistributionPackageVersions_deltas_getToManyRelationship", "parameters": [ { "name": "limit", @@ -83012,7 +82028,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryVideoPlacementsLinkagesResponse" + "$ref": "#/components/schemas/AlternativeDistributionPackageVersionDeltasLinkagesResponse" } } } @@ -83042,342 +82058,26 @@ } ] }, - "/v1/appAssetLibraryVideos/{id}/placements": { + "/v1/alternativeDistributionPackageVersions/{id}/deltas": { "get": { "tags": [ - "AppAssetLibraryVideos" + "AlternativeDistributionPackageVersions" ], - "operationId": "appAssetLibraryVideos_placements_getToManyRelated", + "operationId": "alternativeDistributionPackageVersions_deltas_getToManyRelated", "parameters": [ { - "name": "filter[placementType]", - "in": "query", - "description": "filter by attribute 'placementType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "APP_SCREENSHOT", - "IMESSAGE_APP_SCREENSHOT", - "APP_PREVIEW", - "PRODUCT_PAGE_HEADER_ASSET", - "APP_STORE_SEARCH_RESULTS_ASSET", - "SEARCH_RESULTS_ADS_ASSET", - "TODAY_TAB_ADS_ASSET", - "EVENT_CARD_ASSET", - "EVENT_DETAILS_PAGE_ASSET", - "RETENTION_MESSAGE_ASSET" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[placementGroup]", - "in": "query", - "description": "filter by attribute 'placementGroup'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[state]", - "in": "query", - "description": "filter by attribute 'state'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "ASSET_PROCESSING", - "FAILED", - "PARENT_PREPARE_FOR_SUBMISSION", - "PARENT_READY_FOR_REVIEW", - "PARENT_WAITING_FOR_REVIEW", - "PARENT_IN_REVIEW", - "PARENT_APPROVED" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[image]", - "in": "query", - "description": "filter by id(s) of related 'image'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appEventLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appEventLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appCustomProductPageLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appCustomProductPageLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionExperimentTreatmentLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "sort", - "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "createdDate", - "-createdDate", - "lastModifiedDate", - "-lastModifiedDate", - "placementGroupPosition", - "-placementGroupPosition" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryPlacements]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryPlacements", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "mediaType", - "placementType", - "placementGroup", - "createdDate", - "lastModifiedDate", - "state", - "stateDetails", - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryImages]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "imageAsset", - "referenceName", - "specId", - "state", - "stateDetails", - "uploadOperations", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryVideos]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryVideos", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "previewFrameImage", - "previewFrameTimeCode", - "referenceName", - "specId", - "state", - "stateDetails", - "uploadOperations", - "videoAsset", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appEventLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appEventLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "shortDescription", - "longDescription", - "appEvent", - "appEventScreenshots", - "appEventVideoClips", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appCustomProductPageLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "promotionalText", - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "name": "fields[alternativeDistributionPackageDeltas]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "description": "the fields to include for returned resources of type alternativeDistributionPackageDeltas", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" + "url", + "urlExpirationDate", + "alternativeDistributionKeyBlob", + "fileChecksum" ] } }, @@ -83393,27 +82093,6 @@ "maximum": 200 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" - ] - } - }, - "style": "form", - "explode": false } ], "responses": { @@ -83458,11 +82137,11 @@ } }, "200": { - "description": "List of AppAssetLibraryPlacements", + "description": "List of AlternativeDistributionPackageDeltas", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" + "$ref": "#/components/schemas/AlternativeDistributionPackageDeltasResponse" } } } @@ -83492,12 +82171,12 @@ } ] }, - "/v2/appAvailabilities/{id}/relationships/territoryAvailabilities": { + "/v1/alternativeDistributionPackageVersions/{id}/relationships/variants": { "get": { "tags": [ - "AppAvailabilities" + "AlternativeDistributionPackageVersions" ], - "operationId": "appAvailabilitiesV2_territoryAvailabilities_getToManyRelationship", + "operationId": "alternativeDistributionPackageVersions_variants_getToManyRelationship", "parameters": [ { "name": "limit", @@ -83556,7 +82235,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAvailabilityV2TerritoryAvailabilitiesLinkagesResponse" + "$ref": "#/components/schemas/AlternativeDistributionPackageVersionVariantsLinkagesResponse" } } } @@ -83586,44 +82265,26 @@ } ] }, - "/v2/appAvailabilities/{id}/territoryAvailabilities": { + "/v1/alternativeDistributionPackageVersions/{id}/variants": { "get": { "tags": [ - "AppAvailabilities" + "AlternativeDistributionPackageVersions" ], - "operationId": "appAvailabilitiesV2_territoryAvailabilities_getToManyRelated", + "operationId": "alternativeDistributionPackageVersions_variants_getToManyRelated", "parameters": [ { - "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": "fields[territories]", + "name": "fields[alternativeDistributionPackageVariants]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type alternativeDistributionPackageVariants", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "url", + "urlExpirationDate", + "alternativeDistributionKeyBlob", + "fileChecksum" ] } }, @@ -83639,22 +82300,6 @@ "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": { @@ -83699,11 +82344,11 @@ } }, "200": { - "description": "List of TerritoryAvailabilities", + "description": "List of AlternativeDistributionPackageVariants", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoryAvailabilitiesResponse" + "$ref": "#/components/schemas/AlternativeDistributionPackageVariantsResponse" } } } @@ -83733,13 +82378,24 @@ } ] }, - "/v1/appCategories/{id}/relationships/parent": { + "/v1/alternativeDistributionPackages/{id}/relationships/versions": { "get": { "tags": [ - "AppCategories" + "AlternativeDistributionPackages" + ], + "operationId": "alternativeDistributionPackages_versions_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "appCategories_parent_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -83782,11 +82438,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCategoryParentLinkageResponse" + "$ref": "#/components/schemas/AlternativeDistributionPackageVersionsLinkagesResponse" } } } @@ -83816,30 +82472,155 @@ } ] }, - "/v1/appCategories/{id}/parent": { + "/v1/alternativeDistributionPackages/{id}/versions": { "get": { "tags": [ - "AppCategories" + "AlternativeDistributionPackages" ], - "operationId": "appCategories_parent_getToOneRelated", + "operationId": "alternativeDistributionPackages_versions_getToManyRelated", "parameters": [ { - "name": "fields[appCategories]", + "name": "filter[state]", "in": "query", - "description": "the fields to include for returned resources of type appCategories", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platforms", - "subcategories", - "parent" + "COMPLETED", + "REPLACED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[alternativeDistributionPackageVersions]", + "in": "query", + "description": "the fields to include for returned resources of type alternativeDistributionPackageVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "url", + "urlExpirationDate", + "version", + "fileChecksum", + "state", + "variants", + "deltas", + "alternativeDistributionPackage" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[alternativeDistributionPackageVariants]", + "in": "query", + "description": "the fields to include for returned resources of type alternativeDistributionPackageVariants", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "url", + "urlExpirationDate", + "alternativeDistributionKeyBlob", + "fileChecksum" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[alternativeDistributionPackageDeltas]", + "in": "query", + "description": "the fields to include for returned resources of type alternativeDistributionPackageDeltas", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "url", + "urlExpirationDate", + "alternativeDistributionKeyBlob", + "fileChecksum" + ] + } + }, + "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": [ + "variants", + "deltas", + "alternativeDistributionPackage" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[variants]", + "in": "query", + "description": "maximum number of related variants returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[deltas]", + "in": "query", + "description": "maximum number of related deltas returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -83884,11 +82665,11 @@ } }, "200": { - "description": "Single AppCategory with get", + "description": "List of AlternativeDistributionPackageVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCategoryWithoutIncludesResponse" + "$ref": "#/components/schemas/AlternativeDistributionPackageVersionsResponse" } } } @@ -83918,12 +82699,12 @@ } ] }, - "/v1/appCategories/{id}/relationships/subcategories": { + "/v1/analyticsReportInstances/{id}/relationships/segments": { "get": { "tags": [ - "AppCategories" + "AnalyticsReportInstances" ], - "operationId": "appCategories_subcategories_getToManyRelationship", + "operationId": "analyticsReportInstances_segments_getToManyRelationship", "parameters": [ { "name": "limit", @@ -83982,7 +82763,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCategorySubcategoriesLinkagesResponse" + "$ref": "#/components/schemas/AnalyticsReportInstanceSegmentsLinkagesResponse" } } } @@ -84012,25 +82793,25 @@ } ] }, - "/v1/appCategories/{id}/subcategories": { + "/v1/analyticsReportInstances/{id}/segments": { "get": { "tags": [ - "AppCategories" + "AnalyticsReportInstances" ], - "operationId": "appCategories_subcategories_getToManyRelated", + "operationId": "analyticsReportInstances_segments_getToManyRelated", "parameters": [ { - "name": "fields[appCategories]", + "name": "fields[analyticsReportSegments]", "in": "query", - "description": "the fields to include for returned resources of type appCategories", + "description": "the fields to include for returned resources of type analyticsReportSegments", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platforms", - "subcategories", - "parent" + "checksum", + "sizeInBytes", + "url" ] } }, @@ -84090,11 +82871,11 @@ } }, "200": { - "description": "List of AppCategories with get", + "description": "List of AnalyticsReportSegments", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCategoriesWithoutIncludesResponse" + "$ref": "#/components/schemas/AnalyticsReportSegmentsResponse" } } } @@ -84124,13 +82905,24 @@ } ] }, - "/v1/appClipDefaultExperienceLocalizations/{id}/relationships/appClipHeaderImage": { + "/v1/analyticsReportRequests/{id}/relationships/reports": { "get": { "tags": [ - "AppClipDefaultExperienceLocalizations" + "AnalyticsReportRequests" + ], + "operationId": "analyticsReportRequests_reports_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "appClipDefaultExperienceLocalizations_appClipHeaderImage_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -84173,11 +82965,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppClipDefaultExperienceLocalizationAppClipHeaderImageLinkageResponse" + "$ref": "#/components/schemas/AnalyticsReportRequestReportsLinkagesResponse" } } } @@ -84207,48 +82999,40 @@ } ] }, - "/v1/appClipDefaultExperienceLocalizations/{id}/appClipHeaderImage": { + "/v1/analyticsReportRequests/{id}/reports": { "get": { "tags": [ - "AppClipDefaultExperienceLocalizations" + "AnalyticsReportRequests" ], - "operationId": "appClipDefaultExperienceLocalizations_appClipHeaderImage_getToOneRelated", + "operationId": "analyticsReportRequests_reports_getToManyRelated", "parameters": [ { - "name": "fields[appClipHeaderImages]", + "name": "filter[name]", "in": "query", - "description": "the fields to include for returned resources of type appClipHeaderImages", + "description": "filter by attribute 'name'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "imageAsset", - "uploadOperations", - "assetDeliveryState", - "appClipDefaultExperienceLocalization" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appClipDefaultExperienceLocalizations]", + "name": "filter[category]", "in": "query", - "description": "the fields to include for returned resources of type appClipDefaultExperienceLocalizations", + "description": "filter by attribute 'category'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "subtitle", - "appClipDefaultExperience", - "appClipHeaderImage" + "APP_USAGE", + "APP_STORE_ENGAGEMENT", + "COMMERCE", + "FRAMEWORK_USAGE", + "PERFORMANCE" ] } }, @@ -84256,20 +83040,32 @@ "explode": false }, { - "name": "include", + "name": "fields[analyticsReports]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type analyticsReports", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "appClipDefaultExperienceLocalization" + "name", + "category", + "instances" ] } }, "style": "form", "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" } ], "responses": { @@ -84314,11 +83110,11 @@ } }, "200": { - "description": "Single AppClipHeaderImage", + "description": "List of AnalyticsReports", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppClipHeaderImageResponse" + "$ref": "#/components/schemas/AnalyticsReportsResponse" } } } @@ -84348,13 +83144,24 @@ } ] }, - "/v1/appClipDefaultExperiences/{id}/relationships/appClipAppStoreReviewDetail": { + "/v1/analyticsReports/{id}/relationships/instances": { "get": { "tags": [ - "AppClipDefaultExperiences" + "AnalyticsReports" + ], + "operationId": "analyticsReports_instances_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "appClipDefaultExperiences_appClipAppStoreReviewDetail_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -84397,11 +83204,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppClipDefaultExperienceAppClipAppStoreReviewDetailLinkageResponse" + "$ref": "#/components/schemas/AnalyticsReportInstancesLinkagesResponse" } } } @@ -84431,24 +83238,25 @@ } ] }, - "/v1/appClipDefaultExperiences/{id}/appClipAppStoreReviewDetail": { + "/v1/analyticsReports/{id}/instances": { "get": { "tags": [ - "AppClipDefaultExperiences" + "AnalyticsReports" ], - "operationId": "appClipDefaultExperiences_appClipAppStoreReviewDetail_getToOneRelated", + "operationId": "analyticsReports_instances_getToManyRelated", "parameters": [ { - "name": "fields[appClipAppStoreReviewDetails]", + "name": "filter[granularity]", "in": "query", - "description": "the fields to include for returned resources of type appClipAppStoreReviewDetails", + "description": "filter by attribute 'granularity'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "invocationUrls", - "appClipDefaultExperience" + "DAILY", + "WEEKLY", + "MONTHLY" ] } }, @@ -84456,40 +83264,45 @@ "explode": false }, { - "name": "fields[appClipDefaultExperiences]", + "name": "filter[processingDate]", "in": "query", - "description": "the fields to include for returned resources of type appClipDefaultExperiences", + "description": "filter by attribute 'processingDate'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "action", - "appClip", - "releaseWithAppStoreVersion", - "appClipDefaultExperienceLocalizations", - "appClipAppStoreReviewDetail" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "include", + "name": "fields[analyticsReportInstances]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type analyticsReportInstances", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "appClipDefaultExperience" + "granularity", + "processingDate", + "segments" ] } }, "style": "form", "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" } ], "responses": { @@ -84534,11 +83347,11 @@ } }, "200": { - "description": "Single AppClipAppStoreReviewDetail", + "description": "List of AnalyticsReportInstances", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppClipAppStoreReviewDetailResponse" + "$ref": "#/components/schemas/AnalyticsReportInstancesResponse" } } } @@ -84568,12 +83381,12 @@ } ] }, - "/v1/appClipDefaultExperiences/{id}/relationships/appClipDefaultExperienceLocalizations": { + "/v1/appAssetLibraries/{id}/relationships/images": { "get": { "tags": [ - "AppClipDefaultExperiences" + "AppAssetLibraries" ], - "operationId": "appClipDefaultExperiences_appClipDefaultExperienceLocalizations_getToManyRelationship", + "operationId": "appAssetLibraries_images_getToManyRelationship", "parameters": [ { "name": "limit", @@ -84632,7 +83445,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppClipDefaultExperienceAppClipDefaultExperienceLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/AppAssetLibraryImagesLinkagesResponse" } } } @@ -84662,39 +83475,51 @@ } ] }, - "/v1/appClipDefaultExperiences/{id}/appClipDefaultExperienceLocalizations": { + "/v1/appAssetLibraries/{id}/images": { "get": { "tags": [ - "AppClipDefaultExperiences" + "AppAssetLibraries" ], - "operationId": "appClipDefaultExperiences_appClipDefaultExperienceLocalizations_getToManyRelated", + "operationId": "appAssetLibraries_images_getToManyRelated", "parameters": [ { - "name": "filter[locale]", + "name": "filter[category]", "in": "query", - "description": "filter by attribute 'locale'", + "description": "filter by attribute 'category'", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "CREATIVE_ASSETS", + "APP_SCREENSHOTS_AND_PREVIEWS" + ] } }, "style": "form", "explode": false }, { - "name": "fields[appClipDefaultExperienceLocalizations]", + "name": "filter[state]", "in": "query", - "description": "the fields to include for returned resources of type appClipDefaultExperienceLocalizations", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "subtitle", - "appClipDefaultExperience", - "appClipHeaderImage" + "AWAITING_UPLOAD", + "UPLOAD_COMPLETE", + "FAILED", + "COMPLETE", + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "ACCEPTED", + "APPROVED", + "REJECTED", + "ARCHIVED" ] } }, @@ -84702,19 +83527,59 @@ "explode": false }, { - "name": "fields[appClipDefaultExperiences]", + "name": "filter[referenceName]", "in": "query", - "description": "the fields to include for returned resources of type appClipDefaultExperiences", + "description": "filter by attribute 'referenceName'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[specId]", + "in": "query", + "description": "filter by attribute 'specId'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "action", - "appClip", - "releaseWithAppStoreVersion", - "appClipDefaultExperienceLocalizations", - "appClipAppStoreReviewDetail" + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "referenceName", + "-referenceName" ] } }, @@ -84722,21 +83587,55 @@ "explode": false }, { - "name": "fields[appClipHeaderImages]", + "name": "fields[appAssetLibraryImages]", "in": "query", - "description": "the fields to include for returned resources of type appClipHeaderImages", + "description": "the fields to include for returned resources of type appAssetLibraryImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", + "category", + "createdDate", + "lastModifiedDate", "fileName", - "sourceFileChecksum", + "fileSize", "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", "uploadOperations", - "assetDeliveryState", - "appClipDefaultExperienceLocalization" + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -84762,13 +83661,22 @@ "items": { "type": "string", "enum": [ - "appClipDefaultExperience", - "appClipHeaderImage" + "placements" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -84813,11 +83721,11 @@ } }, "200": { - "description": "List of AppClipDefaultExperienceLocalizations", + "description": "List of AppAssetLibraryImages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppClipDefaultExperienceLocalizationsResponse" + "$ref": "#/components/schemas/AppAssetLibraryImagesResponse" } } } @@ -84847,92 +83755,24 @@ } ] }, - "/v1/appClipDefaultExperiences/{id}/relationships/releaseWithAppStoreVersion": { + "/v1/appAssetLibraries/{id}/relationships/videos": { "get": { "tags": [ - "AppClipDefaultExperiences" + "AppAssetLibraries" ], - "operationId": "appClipDefaultExperiences_releaseWithAppStoreVersion_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/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } + "operationId": "appAssetLibraries_videos_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" } - } - }, - "patch": { - "tags": [ - "AppClipDefaultExperiences" ], - "operationId": "appClipDefaultExperiences_releaseWithAppStoreVersion_updateToOneRelationship", - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageRequest" - } - } - }, - "required": true - }, "responses": { "400": { "description": "Parameter error(s)", @@ -84974,29 +83814,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/AppAssetLibraryVideosLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -85022,46 +83849,24 @@ } ] }, - "/v1/appClipDefaultExperiences/{id}/releaseWithAppStoreVersion": { + "/v1/appAssetLibraries/{id}/videos": { "get": { "tags": [ - "AppClipDefaultExperiences" + "AppAssetLibraries" ], - "operationId": "appClipDefaultExperiences_releaseWithAppStoreVersion_getToOneRelated", + "operationId": "appAssetLibraries_videos_getToManyRelated", "parameters": [ { - "name": "fields[appStoreVersions]", + "name": "filter[category]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "filter by attribute 'category'", "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" + "CREATIVE_ASSETS", + "APP_SCREENSHOTS_AND_PREVIEWS" ] } }, @@ -85069,71 +83874,26 @@ "explode": false }, { - "name": "fields[apps]", + "name": "filter[state]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "filter by attribute 'state'", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" + "AWAITING_UPLOAD", + "UPLOAD_COMPLETE", + "FAILED", + "COMPLETE", + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "ACCEPTED", + "APPROVED", + "REJECTED", + "ARCHIVED" ] } }, @@ -85141,104 +83901,59 @@ "explode": false }, { - "name": "fields[appStoreVersionLocalizations]", + "name": "filter[referenceName]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "description": "filter by attribute 'referenceName'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[builds]", + "name": "filter[specId]", "in": "query", - "description": "the fields to include for returned resources of type builds", + "description": "filter by attribute 'specId'", "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" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appStoreVersionPhasedReleases]", + "name": "filter[id]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionPhasedReleases", + "description": "filter by id(s)", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "phasedReleaseState", - "startDate", - "totalPauseDuration", - "currentDayNumber" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[gameCenterAppVersions]", + "name": "sort", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAppVersions", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "enabled", - "compatibilityVersions", - "appStoreVersion" + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "referenceName", + "-referenceName" ] } }, @@ -85246,81 +83961,28 @@ "explode": false }, { - "name": "fields[routingAppCoverages]", + "name": "fields[appAssetLibraryVideos]", "in": "query", - "description": "the fields to include for returned resources of type routingAppCoverages", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", + "category", + "createdDate", + "lastModifiedDate", "fileName", - "sourceFileChecksum", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", "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" + "videoAsset", + "placements" ] } }, @@ -85328,26 +83990,28 @@ "explode": false }, { - "name": "fields[appStoreVersionExperiments]", + "name": "fields[appAssetLibraryPlacements]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperiments", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "trafficProportion", + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", "state", - "reviewRequired", - "startDate", - "endDate", - "appStoreVersion", - "appStoreVersionExperimentTreatments", - "platform", - "app", - "latestControlVersion", - "controlVersions" + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -85355,21 +84019,14 @@ "explode": false }, { - "name": "fields[alternativeDistributionPackages]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionPackages", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "sourceFileChecksum", - "versions" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { "name": "include", @@ -85380,18 +84037,7 @@ "items": { "type": "string", "enum": [ - "app", - "appStoreVersionLocalizations", - "build", - "appStoreVersionPhasedRelease", - "gameCenterAppVersion", - "routingAppCoverage", - "appStoreReviewDetail", - "appStoreVersionSubmission", - "appClipDefaultExperience", - "appStoreVersionExperiments", - "appStoreVersionExperimentsV2", - "alternativeDistributionPackage" + "placements" ] } }, @@ -85399,30 +84045,9 @@ "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]", + "name": "limit[placements]", "in": "query", - "description": "maximum number of related appStoreVersionExperimentsV2 returned (when they are included)", + "description": "maximum number of related placements returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -85472,11 +84097,11 @@ } }, "200": { - "description": "Single AppStoreVersion", + "description": "List of AppAssetLibraryVideos", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionResponse" + "$ref": "#/components/schemas/AppAssetLibraryVideosResponse" } } } @@ -85506,12 +84131,12 @@ } ] }, - "/v1/appClips/{id}/relationships/appClipAdvancedExperiences": { + "/v1/appAssetLibraryImages/{id}/relationships/placements": { "get": { "tags": [ - "AppClips" + "AppAssetLibraryImages" ], - "operationId": "appClips_appClipAdvancedExperiences_getToManyRelationship", + "operationId": "appAssetLibraryImages_placements_getToManyRelationship", "parameters": [ { "name": "limit", @@ -85570,7 +84195,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppClipAppClipAdvancedExperiencesLinkagesResponse" + "$ref": "#/components/schemas/AppAssetLibraryImagePlacementsLinkagesResponse" } } } @@ -85600,25 +84225,32 @@ } ] }, - "/v1/appClips/{id}/appClipAdvancedExperiences": { + "/v1/appAssetLibraryImages/{id}/placements": { "get": { "tags": [ - "AppClips" + "AppAssetLibraryImages" ], - "operationId": "appClips_appClipAdvancedExperiences_getToManyRelated", + "operationId": "appAssetLibraryImages_placements_getToManyRelated", "parameters": [ { - "name": "filter[status]", + "name": "filter[placementType]", "in": "query", - "description": "filter by attribute 'status'", + "description": "filter by attribute 'placementType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "RECEIVED", - "DEACTIVATED", - "APP_TRANSFER_IN_PROGRESS" + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" ] } }, @@ -85626,35 +84258,34 @@ "explode": false }, { - "name": "filter[placeStatus]", + "name": "filter[placementGroup]", "in": "query", - "description": "filter by attribute 'placeStatus'", + "description": "filter by attribute 'placementGroup'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "PENDING", - "MATCHED", - "NO_MATCH" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "filter[action]", + "name": "filter[state]", "in": "query", - "description": "filter by attribute 'action'", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "OPEN", - "VIEW", - "PLAY" + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" ] } }, @@ -85662,112 +84293,98 @@ "explode": false }, { - "name": "fields[appClipAdvancedExperiences]", + "name": "filter[video]", "in": "query", - "description": "the fields to include for returned resources of type appClipAdvancedExperiences", + "description": "filter by id(s) of related 'video'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "link", - "version", - "status", - "action", - "isPoweredBy", - "place", - "placeStatus", - "businessCategory", - "defaultLanguage", - "appClip", - "headerImage", - "localizations" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appClips]", + "name": "filter[appEventLocalization]", "in": "query", - "description": "the fields to include for returned resources of type appClips", + "description": "filter by id(s) of related 'appEventLocalization'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "bundleId", - "app", - "appClipDefaultExperiences", - "appClipAdvancedExperiences" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appClipAdvancedExperienceImages]", + "name": "filter[appStoreVersionLocalization]", "in": "query", - "description": "the fields to include for returned resources of type appClipAdvancedExperienceImages", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "imageAsset", - "uploadOperations", - "assetDeliveryState" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appClipAdvancedExperienceLocalizations]", + "name": "filter[appCustomProductPageLocalization]", "in": "query", - "description": "the fields to include for returned resources of type appClipAdvancedExperienceLocalizations", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "language", - "title", - "subtitle" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "limit", + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", "in": "query", - "description": "maximum resources per page", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", "schema": { - "type": "integer", - "maximum": 200 + "type": "array", + "items": { + "type": "string" + } }, - "style": "form" + "style": "form", + "explode": false }, { - "name": "include", + "name": "filter[id]", "in": "query", - "description": "comma-separated list of relationships to include", + "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": [ - "appClip", - "headerImage", - "localizations" + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "placementGroupPosition", + "-placementGroupPosition" ] } }, @@ -85775,217 +84392,107 @@ "explode": false }, { - "name": "limit[localizations]", + "name": "fields[appAssetLibraryPlacements]", "in": "query", - "description": "maximum number of related localizations returned (when they are included)", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", "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 AppClipAdvancedExperiences", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppClipAdvancedExperiencesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ] } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + }, + "style": "form", + "explode": false }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appClips/{id}/relationships/appClipDefaultExperiences": { - "get": { - "tags": [ - "AppClips" - ], - "operationId": "appClips_appClipDefaultExperiences_getToManyRelationship", - "parameters": [ { - "name": "limit", + "name": "fields[appAssetLibraryImages]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type appAssetLibraryImages", "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/AppClipAppClipDefaultExperiencesLinkagesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + }, + "style": "form", + "explode": false }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appClips/{id}/appClipDefaultExperiences": { - "get": { - "tags": [ - "AppClips" - ], - "operationId": "appClips_appClipDefaultExperiences_getToManyRelated", - "parameters": [ { - "name": "exists[releaseWithAppStoreVersion]", + "name": "fields[appAssetLibraryVideos]", "in": "query", - "description": "filter by existence or non-existence of related 'releaseWithAppStoreVersion'", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", "schema": { - "type": "boolean" + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } }, "style": "form", "explode": false }, { - "name": "fields[appClipDefaultExperiences]", + "name": "fields[appEventLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appClipDefaultExperiences", + "description": "the fields to include for returned resources of type appEventLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "action", - "appClip", - "releaseWithAppStoreVersion", - "appClipDefaultExperienceLocalizations", - "appClipAppStoreReviewDetail" + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" ] } }, @@ -85993,18 +84500,26 @@ "explode": false }, { - "name": "fields[appClips]", + "name": "fields[appStoreVersionLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appClips", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "bundleId", - "app", - "appClipDefaultExperiences", - "appClipAdvancedExperiences" + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, @@ -86012,38 +84527,21 @@ "explode": false }, { - "name": "fields[appStoreVersions]", + "name": "fields[appCustomProductPageLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", "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" + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, @@ -86051,18 +84549,19 @@ "explode": false }, { - "name": "fields[appClipDefaultExperienceLocalizations]", + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appClipDefaultExperienceLocalizations", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ "locale", - "subtitle", - "appClipDefaultExperience", - "appClipHeaderImage" + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" ] } }, @@ -86070,16 +84569,18 @@ "explode": false }, { - "name": "fields[appClipAppStoreReviewDetails]", + "name": "fields[retentionMessageVersions]", "in": "query", - "description": "the fields to include for returned resources of type appClipAppStoreReviewDetails", + "description": "the fields to include for returned resources of type retentionMessageVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "invocationUrls", - "appClipDefaultExperience" + "state", + "retentionMessage", + "localizations", + "placement" ] } }, @@ -86105,25 +84606,18 @@ "items": { "type": "string", "enum": [ - "appClip", - "releaseWithAppStoreVersion", - "appClipDefaultExperienceLocalizations", - "appClipAppStoreReviewDetail" + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[appClipDefaultExperienceLocalizations]", - "in": "query", - "description": "maximum number of related appClipDefaultExperienceLocalizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -86168,11 +84662,11 @@ } }, "200": { - "description": "List of AppClipDefaultExperiences", + "description": "List of AppAssetLibraryPlacements", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppClipDefaultExperiencesResponse" + "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" } } } @@ -86202,12 +84696,12 @@ } ] }, - "/v1/appCustomProductPageLocalizations/{id}/relationships/appPreviewSets": { + "/v1/appAssetLibraryVideos/{id}/relationships/placements": { "get": { "tags": [ - "AppCustomProductPageLocalizations" + "AppAssetLibraryVideos" ], - "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelationship", + "operationId": "appAssetLibraryVideos_placements_getToManyRelationship", "parameters": [ { "name": "limit", @@ -86266,7 +84760,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCustomProductPageLocalizationAppPreviewSetsLinkagesResponse" + "$ref": "#/components/schemas/AppAssetLibraryVideoPlacementsLinkagesResponse" } } } @@ -86296,43 +84790,98 @@ } ] }, - "/v1/appCustomProductPageLocalizations/{id}/appPreviewSets": { + "/v1/appAssetLibraryVideos/{id}/placements": { "get": { "tags": [ - "AppCustomProductPageLocalizations" + "AppAssetLibraryVideos" ], - "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", + "operationId": "appAssetLibraryVideos_placements_getToManyRelated", "parameters": [ { - "name": "filter[previewType]", + "name": "filter[placementType]", "in": "query", - "description": "filter by attribute 'previewType'", + "description": "filter by attribute 'placementType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "IPHONE_67", - "IPHONE_61", - "IPHONE_65", - "IPHONE_58", - "IPHONE_55", - "IPHONE_47", - "IPHONE_40", - "IPHONE_35", - "IPAD_PRO_3GEN_129", - "IPAD_PRO_3GEN_11", - "IPAD_PRO_129", - "IPAD_105", - "IPAD_97", - "DESKTOP", - "APPLE_TV", - "APPLE_VISION_PRO" - ] - } - }, - "style": "form", - "explode": false + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[placementGroup]", + "in": "query", + "description": "filter by attribute 'placementGroup'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[image]", + "in": "query", + "description": "filter by id(s) of related 'image'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appEventLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appEventLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false }, { "name": "filter[appStoreVersionLocalization]", @@ -86347,6 +84896,19 @@ "style": "form", "explode": false }, + { + "name": "filter[appCustomProductPageLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, { "name": "filter[appStoreVersionExperimentTreatmentLocalization]", "in": "query", @@ -86361,19 +84923,141 @@ "explode": false }, { - "name": "fields[appPreviewSets]", + "name": "filter[id]", "in": "query", - "description": "the fields to include for returned resources of type appPreviewSets", + "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": [ - "previewType", + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "placementGroupPosition", + "-placementGroupPosition" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization", - "appPreviews" + "retentionMessageVersion" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appEventLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" ] } }, @@ -86450,26 +85134,18 @@ "explode": false }, { - "name": "fields[appPreviews]", + "name": "fields[retentionMessageVersions]", "in": "query", - "description": "the fields to include for returned resources of type appPreviews", + "description": "the fields to include for returned resources of type retentionMessageVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "previewFrameTimeCode", - "mimeType", - "videoUrl", - "previewFrameImage", - "previewImage", - "uploadOperations", - "assetDeliveryState", - "videoDeliveryState", - "appPreviewSet" + "state", + "retentionMessage", + "localizations", + "placement" ] } }, @@ -86495,25 +85171,18 @@ "items": { "type": "string", "enum": [ + "image", + "video", + "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization", - "appPreviews" + "retentionMessageVersion" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[appPreviews]", - "in": "query", - "description": "maximum number of related appPreviews returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -86558,11 +85227,11 @@ } }, "200": { - "description": "List of AppPreviewSets", + "description": "List of AppAssetLibraryPlacements", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPreviewSetsResponse" + "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" } } } @@ -86592,12 +85261,12 @@ } ] }, - "/v1/appCustomProductPageLocalizations/{id}/relationships/appScreenshotSets": { + "/v2/appAvailabilities/{id}/relationships/territoryAvailabilities": { "get": { "tags": [ - "AppCustomProductPageLocalizations" + "AppAvailabilities" ], - "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelationship", + "operationId": "appAvailabilitiesV2_territoryAvailabilities_getToManyRelationship", "parameters": [ { "name": "limit", @@ -86656,7 +85325,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCustomProductPageLocalizationAppScreenshotSetsLinkagesResponse" + "$ref": "#/components/schemas/AppAvailabilityV2TerritoryAvailabilitiesLinkagesResponse" } } } @@ -86686,170 +85355,28 @@ } ] }, - "/v1/appCustomProductPageLocalizations/{id}/appScreenshotSets": { + "/v2/appAvailabilities/{id}/territoryAvailabilities": { "get": { "tags": [ - "AppCustomProductPageLocalizations" + "AppAvailabilities" ], - "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", + "operationId": "appAvailabilitiesV2_territoryAvailabilities_getToManyRelated", "parameters": [ { - "name": "filter[screenshotDisplayType]", - "in": "query", - "description": "filter by attribute 'screenshotDisplayType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "APP_IPHONE_67", - "APP_IPHONE_61", - "APP_IPHONE_65", - "APP_IPHONE_58", - "APP_IPHONE_55", - "APP_IPHONE_47", - "APP_IPHONE_40", - "APP_IPHONE_35", - "APP_IPAD_PRO_3GEN_129", - "APP_IPAD_PRO_3GEN_11", - "APP_IPAD_PRO_129", - "APP_IPAD_105", - "APP_IPAD_97", - "APP_DESKTOP", - "APP_WATCH_ULTRA", - "APP_WATCH_SERIES_10", - "APP_WATCH_SERIES_7", - "APP_WATCH_SERIES_4", - "APP_WATCH_SERIES_3", - "APP_APPLE_TV", - "APP_APPLE_VISION_PRO", - "IMESSAGE_APP_IPHONE_67", - "IMESSAGE_APP_IPHONE_61", - "IMESSAGE_APP_IPHONE_65", - "IMESSAGE_APP_IPHONE_58", - "IMESSAGE_APP_IPHONE_55", - "IMESSAGE_APP_IPHONE_47", - "IMESSAGE_APP_IPHONE_40", - "IMESSAGE_APP_IPAD_PRO_3GEN_129", - "IMESSAGE_APP_IPAD_PRO_3GEN_11", - "IMESSAGE_APP_IPAD_PRO_129", - "IMESSAGE_APP_IPAD_105", - "IMESSAGE_APP_IPAD_97" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionExperimentTreatmentLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appScreenshotSets]", - "in": "query", - "description": "the fields to include for returned resources of type appScreenshotSets", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "screenshotDisplayType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appScreenshots" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appCustomProductPageLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "promotionalText", - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "name": "fields[territoryAvailabilities]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "description": "the fields to include for returned resources of type territoryAvailabilities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" + "available", + "releaseDate", + "preOrderEnabled", + "preOrderPublishDate", + "contentStatuses", + "territory" ] } }, @@ -86857,23 +85384,15 @@ "explode": false }, { - "name": "fields[appScreenshots]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type appScreenshots", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "imageAsset", - "assetToken", - "assetType", - "uploadOperations", - "assetDeliveryState", - "appScreenshotSet" + "currency" ] } }, @@ -86899,25 +85418,12 @@ "items": { "type": "string", "enum": [ - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appScreenshots" + "territory" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[appScreenshots]", - "in": "query", - "description": "maximum number of related appScreenshots returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -86962,11 +85468,11 @@ } }, "200": { - "description": "List of AppScreenshotSets", + "description": "List of TerritoryAvailabilities", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppScreenshotSetsResponse" + "$ref": "#/components/schemas/TerritoryAvailabilitiesResponse" } } } @@ -86996,24 +85502,13 @@ } ] }, - "/v1/appCustomProductPageLocalizations/{id}/relationships/placements": { + "/v1/appCategories/{id}/relationships/parent": { "get": { "tags": [ - "AppCustomProductPageLocalizations" - ], - "operationId": "appCustomProductPageLocalizations_placements_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppCategories" ], + "operationId": "appCategories_parent_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -87056,11 +85551,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCustomProductPageLocalizationPlacementsLinkagesResponse" + "$ref": "#/components/schemas/AppCategoryParentLinkageResponse" } } } @@ -87090,373 +85585,25 @@ } ] }, - "/v1/appCustomProductPageLocalizations/{id}/placements": { + "/v1/appCategories/{id}/parent": { "get": { "tags": [ - "AppCustomProductPageLocalizations" + "AppCategories" ], - "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", + "operationId": "appCategories_parent_getToOneRelated", "parameters": [ { - "name": "filter[placementType]", - "in": "query", - "description": "filter by attribute 'placementType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "APP_SCREENSHOT", - "IMESSAGE_APP_SCREENSHOT", - "APP_PREVIEW", - "PRODUCT_PAGE_HEADER_ASSET", - "APP_STORE_SEARCH_RESULTS_ASSET", - "SEARCH_RESULTS_ADS_ASSET", - "TODAY_TAB_ADS_ASSET", - "EVENT_CARD_ASSET", - "EVENT_DETAILS_PAGE_ASSET", - "RETENTION_MESSAGE_ASSET" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[placementGroup]", - "in": "query", - "description": "filter by attribute 'placementGroup'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[state]", - "in": "query", - "description": "filter by attribute 'state'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "ASSET_PROCESSING", - "FAILED", - "PARENT_PREPARE_FOR_SUBMISSION", - "PARENT_READY_FOR_REVIEW", - "PARENT_WAITING_FOR_REVIEW", - "PARENT_IN_REVIEW", - "PARENT_APPROVED" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[image]", - "in": "query", - "description": "filter by id(s) of related 'image'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[video]", - "in": "query", - "description": "filter by id(s) of related 'video'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appEventLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appEventLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionExperimentTreatmentLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "sort", - "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "createdDate", - "-createdDate", - "lastModifiedDate", - "-lastModifiedDate", - "placementGroupPosition", - "-placementGroupPosition" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryPlacements]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryPlacements", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "mediaType", - "placementType", - "placementGroup", - "createdDate", - "lastModifiedDate", - "state", - "stateDetails", - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryImages]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "imageAsset", - "referenceName", - "specId", - "state", - "stateDetails", - "uploadOperations", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryVideos]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryVideos", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "previewFrameImage", - "previewFrameTimeCode", - "referenceName", - "specId", - "state", - "stateDetails", - "uploadOperations", - "videoAsset", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appEventLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appEventLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "shortDescription", - "longDescription", - "appEvent", - "appEventScreenshots", - "appEventVideoClips", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appCustomProductPageLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "promotionalText", - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, - { - "name": "include", + "name": "fields[appCategories]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type appCategories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "platforms", + "subcategories", + "parent" ] } }, @@ -87506,11 +85653,11 @@ } }, "200": { - "description": "List of AppAssetLibraryPlacements", + "description": "Single AppCategory with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" + "$ref": "#/components/schemas/AppCategoryWithoutIncludesResponse" } } } @@ -87540,12 +85687,12 @@ } ] }, - "/v1/appCustomProductPageLocalizations/{id}/relationships/searchKeywords": { + "/v1/appCategories/{id}/relationships/subcategories": { "get": { "tags": [ - "AppCustomProductPageLocalizations" + "AppCategories" ], - "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelationship", + "operationId": "appCategories_subcategories_getToManyRelationship", "parameters": [ { "name": "limit", @@ -87604,7 +85751,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCustomProductPageLocalizationSearchKeywordsLinkagesResponse" + "$ref": "#/components/schemas/AppCategorySubcategoriesLinkagesResponse" } } } @@ -87621,22 +85768,55 @@ } } }, - "post": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appCategories/{id}/subcategories": { + "get": { "tags": [ - "AppCustomProductPageLocalizations" + "AppCategories" ], - "operationId": "appCustomProductPageLocalizations_searchKeywords_createToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppCustomProductPageLocalizationSearchKeywordsLinkagesRequest" + "operationId": "appCategories_subcategories_getToManyRelated", + "parameters": [ + { + "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 }, - "required": true - }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -87678,29 +85858,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of AppCategories with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/AppCategoriesWithoutIncludesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -87713,22 +85880,26 @@ } } }, - "delete": { - "tags": [ - "AppCustomProductPageLocalizations" - ], - "operationId": "appCustomProductPageLocalizations_searchKeywords_deleteToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppCustomProductPageLocalizationSearchKeywordsLinkagesRequest" - } - } + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", "required": true - }, + } + ] + }, + "/v1/appClipDefaultExperienceLocalizations/{id}/relationships/appClipHeaderImage": { + "get": { + "tags": [ + "AppClipDefaultExperienceLocalizations" + ], + "operationId": "appClipDefaultExperienceLocalizations_appClipHeaderImage_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -87770,29 +85941,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/AppClipDefaultExperienceLocalizationAppClipHeaderImageLinkageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -87818,62 +85976,69 @@ } ] }, - "/v1/appCustomProductPageLocalizations/{id}/searchKeywords": { + "/v1/appClipDefaultExperienceLocalizations/{id}/appClipHeaderImage": { "get": { "tags": [ - "AppCustomProductPageLocalizations" + "AppClipDefaultExperienceLocalizations" ], - "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", + "operationId": "appClipDefaultExperienceLocalizations_appClipHeaderImage_getToOneRelated", "parameters": [ { - "name": "filter[platform]", + "name": "fields[appClipHeaderImages]", "in": "query", - "description": "filter by platform", + "description": "the fields to include for returned resources of type appClipHeaderImages", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "appClipDefaultExperienceLocalization" + ] } }, "style": "form", "explode": false }, { - "name": "filter[locale]", + "name": "fields[appClipDefaultExperienceLocalizations]", "in": "query", - "description": "filter by locale", + "description": "the fields to include for returned resources of type appClipDefaultExperienceLocalizations", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "locale", + "subtitle", + "appClipDefaultExperience", + "appClipHeaderImage" + ] } }, "style": "form", "explode": false }, { - "name": "fields[appKeywords]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type appKeywords", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", - "enum": [] + "enum": [ + "appClipDefaultExperienceLocalization" + ] } }, "style": "form", "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" } ], "responses": { @@ -87918,11 +86083,11 @@ } }, "200": { - "description": "List of AppKeywords", + "description": "Single AppClipHeaderImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppKeywordsResponse" + "$ref": "#/components/schemas/AppClipHeaderImageResponse" } } } @@ -87952,24 +86117,13 @@ } ] }, - "/v1/appCustomProductPageVersions/{id}/relationships/appCustomProductPageLocalizations": { + "/v1/appClipDefaultExperiences/{id}/relationships/appClipAppStoreReviewDetail": { "get": { "tags": [ - "AppCustomProductPageVersions" - ], - "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppClipDefaultExperiences" ], + "operationId": "appClipDefaultExperiences_appClipAppStoreReviewDetail_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -88012,11 +86166,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCustomProductPageVersionAppCustomProductPageLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/AppClipDefaultExperienceAppClipAppStoreReviewDetailLinkageResponse" } } } @@ -88046,102 +86200,24 @@ } ] }, - "/v1/appCustomProductPageVersions/{id}/appCustomProductPageLocalizations": { + "/v1/appClipDefaultExperiences/{id}/appClipAppStoreReviewDetail": { "get": { "tags": [ - "AppCustomProductPageVersions" + "AppClipDefaultExperiences" ], - "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", + "operationId": "appClipDefaultExperiences_appClipAppStoreReviewDetail_getToOneRelated", "parameters": [ { - "name": "filter[locale]", - "in": "query", - "description": "filter by attribute 'locale'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appCustomProductPageLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "promotionalText", - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[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": "fields[appScreenshotSets]", - "in": "query", - "description": "the fields to include for returned resources of type appScreenshotSets", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "screenshotDisplayType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appScreenshots" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appPreviewSets]", + "name": "fields[appClipAppStoreReviewDetails]", "in": "query", - "description": "the fields to include for returned resources of type appPreviewSets", + "description": "the fields to include for returned resources of type appClipAppStoreReviewDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "previewType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appPreviews" + "invocationUrls", + "appClipDefaultExperience" ] } }, @@ -88149,57 +86225,25 @@ "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": "fields[appAssetLibraryPlacements]", + "name": "fields[appClipDefaultExperiences]", "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "description": "the fields to include for returned resources of type appClipDefaultExperiences", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "mediaType", - "placementType", - "placementGroup", - "createdDate", - "lastModifiedDate", - "state", - "stateDetails", - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "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", @@ -88209,56 +86253,12 @@ "items": { "type": "string", "enum": [ - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" + "appClipDefaultExperience" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[appScreenshotSets]", - "in": "query", - "description": "maximum number of related appScreenshotSets returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[appPreviewSets]", - "in": "query", - "description": "maximum number of related appPreviewSets returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[searchKeywords]", - "in": "query", - "description": "maximum number of related searchKeywords returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[placements]", - "in": "query", - "description": "maximum number of related placements returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -88303,11 +86303,11 @@ } }, "200": { - "description": "List of AppCustomProductPageLocalizations", + "description": "Single AppClipAppStoreReviewDetail", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCustomProductPageLocalizationsResponse" + "$ref": "#/components/schemas/AppClipAppStoreReviewDetailResponse" } } } @@ -88337,12 +86337,12 @@ } ] }, - "/v1/appCustomProductPages/{id}/relationships/appCustomProductPageVersions": { + "/v1/appClipDefaultExperiences/{id}/relationships/appClipDefaultExperienceLocalizations": { "get": { "tags": [ - "AppCustomProductPages" + "AppClipDefaultExperiences" ], - "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelationship", + "operationId": "appClipDefaultExperiences_appClipDefaultExperienceLocalizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -88401,7 +86401,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCustomProductPageAppCustomProductPageVersionsLinkagesResponse" + "$ref": "#/components/schemas/AppClipDefaultExperienceAppClipDefaultExperienceLocalizationsLinkagesResponse" } } } @@ -88431,50 +86431,39 @@ } ] }, - "/v1/appCustomProductPages/{id}/appCustomProductPageVersions": { + "/v1/appClipDefaultExperiences/{id}/appClipDefaultExperienceLocalizations": { "get": { "tags": [ - "AppCustomProductPages" + "AppClipDefaultExperiences" ], - "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", + "operationId": "appClipDefaultExperiences_appClipDefaultExperienceLocalizations_getToManyRelated", "parameters": [ { - "name": "filter[state]", + "name": "filter[locale]", "in": "query", - "description": "filter by attribute 'state'", + "description": "filter by attribute 'locale'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "PREPARE_FOR_SUBMISSION", - "READY_FOR_REVIEW", - "WAITING_FOR_REVIEW", - "IN_REVIEW", - "ACCEPTED", - "APPROVED", - "REPLACED_WITH_NEW_VERSION", - "REJECTED" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appCustomProductPageVersions]", + "name": "fields[appClipDefaultExperienceLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageVersions", + "description": "the fields to include for returned resources of type appClipDefaultExperienceLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "deepLink", - "appCustomProductPage", - "appCustomProductPageLocalizations" + "locale", + "subtitle", + "appClipDefaultExperience", + "appClipHeaderImage" ] } }, @@ -88482,19 +86471,19 @@ "explode": false }, { - "name": "fields[appCustomProductPages]", + "name": "fields[appClipDefaultExperiences]", "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPages", + "description": "the fields to include for returned resources of type appClipDefaultExperiences", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "url", - "visible", - "app", - "appCustomProductPageVersions" + "action", + "appClip", + "releaseWithAppStoreVersion", + "appClipDefaultExperienceLocalizations", + "appClipAppStoreReviewDetail" ] } }, @@ -88502,21 +86491,21 @@ "explode": false }, { - "name": "fields[appCustomProductPageLocalizations]", + "name": "fields[appClipHeaderImages]", "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "description": "the fields to include for returned resources of type appClipHeaderImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "promotionalText", - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" + "fileSize", + "fileName", + "sourceFileChecksum", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "appClipDefaultExperienceLocalization" ] } }, @@ -88542,23 +86531,13 @@ "items": { "type": "string", "enum": [ - "appCustomProductPage", - "appCustomProductPageLocalizations" + "appClipDefaultExperience", + "appClipHeaderImage" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[appCustomProductPageLocalizations]", - "in": "query", - "description": "maximum number of related appCustomProductPageLocalizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -88603,11 +86582,11 @@ } }, "200": { - "description": "List of AppCustomProductPageVersions", + "description": "List of AppClipDefaultExperienceLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCustomProductPageVersionsResponse" + "$ref": "#/components/schemas/AppClipDefaultExperienceLocalizationsResponse" } } } @@ -88637,13 +86616,12 @@ } ] }, - "/v1/appEncryptionDeclarations/{id}/relationships/app": { + "/v1/appClipDefaultExperiences/{id}/relationships/releaseWithAppStoreVersion": { "get": { "tags": [ - "AppEncryptionDeclarations" + "AppClipDefaultExperiences" ], - "operationId": "appEncryptionDeclarations_app_getToOneRelationship", - "deprecated": true, + "operationId": "appClipDefaultExperiences_releaseWithAppStoreVersion_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -88691,11 +86669,103 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEncryptionDeclarationAppLinkageResponse" + "$ref": "#/components/schemas/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "patch": { + "tags": [ + "AppClipDefaultExperiences" + ], + "operationId": "appClipDefaultExperiences_releaseWithAppStoreVersion_updateToOneRelationship", + "requestBody": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageRequest" + } + } + }, + "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": { @@ -88721,14 +86791,52 @@ } ] }, - "/v1/appEncryptionDeclarations/{id}/app": { + "/v1/appClipDefaultExperiences/{id}/releaseWithAppStoreVersion": { "get": { "tags": [ - "AppEncryptionDeclarations" + "AppClipDefaultExperiences" ], - "operationId": "appEncryptionDeclarations_app_getToOneRelated", - "deprecated": true, + "operationId": "appClipDefaultExperiences_releaseWithAppStoreVersion_getToOneRelated", "parameters": [ + { + "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", @@ -88771,6 +86879,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -88800,6 +86909,295 @@ }, "style": "form", "explode": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[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": "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": { @@ -88844,11 +87242,11 @@ } }, "200": { - "description": "Single App with get", + "description": "Single AppStoreVersion", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppWithoutIncludesResponse" + "$ref": "#/components/schemas/AppStoreVersionResponse" } } } @@ -88878,13 +87276,24 @@ } ] }, - "/v1/appEncryptionDeclarations/{id}/relationships/appEncryptionDeclarationDocument": { + "/v1/appClips/{id}/relationships/appClipAdvancedExperiences": { "get": { "tags": [ - "AppEncryptionDeclarations" + "AppClips" + ], + "operationId": "appClips_appClipAdvancedExperiences_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -88927,11 +87336,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEncryptionDeclarationAppEncryptionDeclarationDocumentLinkageResponse" + "$ref": "#/components/schemas/AppClipAppClipAdvancedExperiencesLinkagesResponse" } } } @@ -88961,17 +87370,117 @@ } ] }, - "/v1/appEncryptionDeclarations/{id}/appEncryptionDeclarationDocument": { + "/v1/appClips/{id}/appClipAdvancedExperiences": { "get": { "tags": [ - "AppEncryptionDeclarations" + "AppClips" ], - "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", + "operationId": "appClips_appClipAdvancedExperiences_getToManyRelated", "parameters": [ { - "name": "fields[appEncryptionDeclarationDocuments]", + "name": "filter[status]", "in": "query", - "description": "the fields to include for returned resources of type appEncryptionDeclarationDocuments", + "description": "filter by attribute 'status'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "RECEIVED", + "DEACTIVATED", + "APP_TRANSFER_IN_PROGRESS" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[placeStatus]", + "in": "query", + "description": "filter by attribute 'placeStatus'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "PENDING", + "MATCHED", + "NO_MATCH" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[action]", + "in": "query", + "description": "filter by attribute 'action'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "OPEN", + "VIEW", + "PLAY" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appClipAdvancedExperiences]", + "in": "query", + "description": "the fields to include for returned resources of type appClipAdvancedExperiences", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "link", + "version", + "status", + "action", + "isPoweredBy", + "place", + "placeStatus", + "businessCategory", + "defaultLanguage", + "appClip", + "headerImage", + "localizations" + ] + } + }, + "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[appClipAdvancedExperienceImages]", + "in": "query", + "description": "the fields to include for returned resources of type appClipAdvancedExperienceImages", "schema": { "type": "array", "items": { @@ -88979,9 +87488,8 @@ "enum": [ "fileSize", "fileName", - "assetToken", - "downloadUrl", "sourceFileChecksum", + "imageAsset", "uploadOperations", "assetDeliveryState" ] @@ -88989,6 +87497,62 @@ }, "style": "form", "explode": false + }, + { + "name": "fields[appClipAdvancedExperienceLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appClipAdvancedExperienceLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "language", + "title", + "subtitle" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appClip", + "headerImage", + "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": { @@ -89033,11 +87597,11 @@ } }, "200": { - "description": "Single AppEncryptionDeclarationDocument", + "description": "List of AppClipAdvancedExperiences", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEncryptionDeclarationDocumentResponse" + "$ref": "#/components/schemas/AppClipAdvancedExperiencesResponse" } } } @@ -89067,24 +87631,24 @@ } ] }, - "/v1/appEncryptionDeclarations/{id}/relationships/builds": { - "post": { + "/v1/appClips/{id}/relationships/appClipDefaultExperiences": { + "get": { "tags": [ - "AppEncryptionDeclarations" + "AppClips" + ], + "operationId": "appClips_appClipDefaultExperiences_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "appEncryptionDeclarations_builds_createToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppEncryptionDeclarationBuildsLinkagesRequest" - } - } - }, - "required": true - }, "responses": { "400": { "description": "Parameter error(s)", @@ -89126,29 +87690,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/AppClipAppClipDefaultExperiencesLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -89174,30 +87725,277 @@ } ] }, - "/v1/appEventLocalizations/{id}/relationships/appEventScreenshots": { + "/v1/appClips/{id}/appClipDefaultExperiences": { "get": { "tags": [ - "AppEventLocalizations" + "AppClips" ], - "operationId": "appEventLocalizations_appEventScreenshots_getToManyRelationship", + "operationId": "appClips_appClipDefaultExperiences_getToManyRelated", "parameters": [ { - "name": "limit", + "name": "exists[releaseWithAppStoreVersion]", "in": "query", - "description": "maximum resources per page", + "description": "filter by existence or non-existence of related 'releaseWithAppStoreVersion'", "schema": { - "type": "integer", - "maximum": 200 + "type": "boolean" }, - "style": "form" - } - ], - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { + "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[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[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[appClipDefaultExperienceLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appClipDefaultExperienceLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "subtitle", + "appClipDefaultExperience", + "appClipHeaderImage" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appClipAppStoreReviewDetails]", + "in": "query", + "description": "the fields to include for returned resources of type appClipAppStoreReviewDetails", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "invocationUrls", + "appClipDefaultExperience" + ] + } + }, + "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": [ + "appClip", + "releaseWithAppStoreVersion", + "appClipDefaultExperienceLocalizations", + "appClipAppStoreReviewDetail" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[appClipDefaultExperienceLocalizations]", + "in": "query", + "description": "maximum number of related appClipDefaultExperienceLocalizations 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 AppClipDefaultExperiences", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppClipDefaultExperiencesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appCustomProductPageLocalizations/{id}/relationships/appPreviewSets": { + "get": { + "tags": [ + "AppCustomProductPageLocalizations" + ], + "operationId": "appCustomProductPageLocalizations_appPreviewSets_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" } } @@ -89238,7 +88036,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEventLocalizationAppEventScreenshotsLinkagesResponse" + "$ref": "#/components/schemas/AppCustomProductPageLocalizationAppPreviewSetsLinkagesResponse" } } } @@ -89268,30 +88066,38 @@ } ] }, - "/v1/appEventLocalizations/{id}/appEventScreenshots": { + "/v1/appCustomProductPageLocalizations/{id}/appPreviewSets": { "get": { "tags": [ - "AppEventLocalizations" + "AppCustomProductPageLocalizations" ], - "operationId": "appEventLocalizations_appEventScreenshots_getToManyRelated", + "operationId": "appCustomProductPageLocalizations_appPreviewSets_getToManyRelated", "parameters": [ { - "name": "fields[appEventScreenshots]", + "name": "filter[previewType]", "in": "query", - "description": "the fields to include for returned resources of type appEventScreenshots", + "description": "filter by attribute 'previewType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "assetToken", - "uploadOperations", - "assetDeliveryState", - "appEventAssetType", - "appEventLocalization" + "IPHONE_67", + "IPHONE_61", + "IPHONE_65", + "IPHONE_58", + "IPHONE_55", + "IPHONE_47", + "IPHONE_40", + "IPHONE_35", + "IPAD_PRO_3GEN_129", + "IPAD_PRO_3GEN_11", + "IPAD_PRO_129", + "IPAD_105", + "IPAD_97", + "DESKTOP", + "APPLE_TV", + "APPLE_VISION_PRO" ] } }, @@ -89299,21 +88105,113 @@ "explode": false }, { - "name": "fields[appEventLocalizations]", + "name": "filter[appStoreVersionLocalization]", "in": "query", - "description": "the fields to include for returned resources of type appEventLocalizations", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appPreviewSets]", + "in": "query", + "description": "the fields to include for returned resources of type appPreviewSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "previewType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appPreviews" + ] + } + }, + "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", - "name", - "shortDescription", - "longDescription", - "appEvent", - "appEventScreenshots", - "appEventVideoClips", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", "placements" ] } @@ -89321,6 +88219,33 @@ "style": "form", "explode": false }, + { + "name": "fields[appPreviews]", + "in": "query", + "description": "the fields to include for returned resources of type appPreviews", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "previewFrameTimeCode", + "mimeType", + "videoUrl", + "previewFrameImage", + "previewImage", + "uploadOperations", + "assetDeliveryState", + "videoDeliveryState", + "appPreviewSet" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "limit", "in": "query", @@ -89340,12 +88265,25 @@ "items": { "type": "string", "enum": [ - "appEventLocalization" + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appPreviews" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[appPreviews]", + "in": "query", + "description": "maximum number of related appPreviews returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -89390,11 +88328,11 @@ } }, "200": { - "description": "List of AppEventScreenshots", + "description": "List of AppPreviewSets", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEventScreenshotsResponse" + "$ref": "#/components/schemas/AppPreviewSetsResponse" } } } @@ -89424,12 +88362,12 @@ } ] }, - "/v1/appEventLocalizations/{id}/relationships/appEventVideoClips": { + "/v1/appCustomProductPageLocalizations/{id}/relationships/appScreenshotSets": { "get": { "tags": [ - "AppEventLocalizations" + "AppCustomProductPageLocalizations" ], - "operationId": "appEventLocalizations_appEventVideoClips_getToManyRelationship", + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelationship", "parameters": [ { "name": "limit", @@ -89488,7 +88426,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEventLocalizationAppEventVideoClipsLinkagesResponse" + "$ref": "#/components/schemas/AppCustomProductPageLocalizationAppScreenshotSetsLinkagesResponse" } } } @@ -89518,33 +88456,55 @@ } ] }, - "/v1/appEventLocalizations/{id}/appEventVideoClips": { + "/v1/appCustomProductPageLocalizations/{id}/appScreenshotSets": { "get": { "tags": [ - "AppEventLocalizations" + "AppCustomProductPageLocalizations" ], - "operationId": "appEventLocalizations_appEventVideoClips_getToManyRelated", + "operationId": "appCustomProductPageLocalizations_appScreenshotSets_getToManyRelated", "parameters": [ { - "name": "fields[appEventVideoClips]", + "name": "filter[screenshotDisplayType]", "in": "query", - "description": "the fields to include for returned resources of type appEventVideoClips", + "description": "filter by attribute 'screenshotDisplayType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "previewFrameTimeCode", - "videoUrl", - "previewFrameImage", - "previewImage", - "uploadOperations", - "assetDeliveryState", - "videoDeliveryState", - "appEventAssetType", - "appEventLocalization" + "APP_IPHONE_67", + "APP_IPHONE_61", + "APP_IPHONE_65", + "APP_IPHONE_58", + "APP_IPHONE_55", + "APP_IPHONE_47", + "APP_IPHONE_40", + "APP_IPHONE_35", + "APP_IPAD_PRO_3GEN_129", + "APP_IPAD_PRO_3GEN_11", + "APP_IPAD_PRO_129", + "APP_IPAD_105", + "APP_IPAD_97", + "APP_DESKTOP", + "APP_WATCH_ULTRA", + "APP_WATCH_SERIES_10", + "APP_WATCH_SERIES_7", + "APP_WATCH_SERIES_4", + "APP_WATCH_SERIES_3", + "APP_APPLE_TV", + "APP_APPLE_VISION_PRO", + "IMESSAGE_APP_IPHONE_67", + "IMESSAGE_APP_IPHONE_61", + "IMESSAGE_APP_IPHONE_65", + "IMESSAGE_APP_IPHONE_58", + "IMESSAGE_APP_IPHONE_55", + "IMESSAGE_APP_IPHONE_47", + "IMESSAGE_APP_IPHONE_40", + "IMESSAGE_APP_IPAD_PRO_3GEN_129", + "IMESSAGE_APP_IPAD_PRO_3GEN_11", + "IMESSAGE_APP_IPAD_PRO_129", + "IMESSAGE_APP_IPAD_105", + "IMESSAGE_APP_IPAD_97" ] } }, @@ -89552,21 +88512,113 @@ "explode": false }, { - "name": "fields[appEventLocalizations]", + "name": "filter[appStoreVersionLocalization]", "in": "query", - "description": "the fields to include for returned resources of type appEventLocalizations", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appScreenshotSets]", + "in": "query", + "description": "the fields to include for returned resources of type appScreenshotSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "screenshotDisplayType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appScreenshots" + ] + } + }, + "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", - "name", - "shortDescription", - "longDescription", - "appEvent", - "appEventScreenshots", - "appEventVideoClips", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", "placements" ] } @@ -89574,6 +88626,30 @@ "style": "form", "explode": false }, + { + "name": "fields[appScreenshots]", + "in": "query", + "description": "the fields to include for returned resources of type appScreenshots", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "imageAsset", + "assetToken", + "assetType", + "uploadOperations", + "assetDeliveryState", + "appScreenshotSet" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "limit", "in": "query", @@ -89593,12 +88669,25 @@ "items": { "type": "string", "enum": [ - "appEventLocalization" + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appScreenshots" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[appScreenshots]", + "in": "query", + "description": "maximum number of related appScreenshots returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -89643,11 +88732,11 @@ } }, "200": { - "description": "List of AppEventVideoClips", + "description": "List of AppScreenshotSets", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEventVideoClipsResponse" + "$ref": "#/components/schemas/AppScreenshotSetsResponse" } } } @@ -89677,12 +88766,12 @@ } ] }, - "/v1/appEventLocalizations/{id}/relationships/placements": { + "/v1/appCustomProductPageLocalizations/{id}/relationships/placements": { "get": { "tags": [ - "AppEventLocalizations" + "AppCustomProductPageLocalizations" ], - "operationId": "appEventLocalizations_placements_getToManyRelationship", + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelationship", "parameters": [ { "name": "limit", @@ -89741,7 +88830,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEventLocalizationPlacementsLinkagesResponse" + "$ref": "#/components/schemas/AppCustomProductPageLocalizationPlacementsLinkagesResponse" } } } @@ -89771,12 +88860,12 @@ } ] }, - "/v1/appEventLocalizations/{id}/placements": { + "/v1/appCustomProductPageLocalizations/{id}/placements": { "get": { "tags": [ - "AppEventLocalizations" + "AppCustomProductPageLocalizations" ], - "operationId": "appEventLocalizations_placements_getToManyRelated", + "operationId": "appCustomProductPageLocalizations_placements_getToManyRelated", "parameters": [ { "name": "filter[placementType]", @@ -89865,9 +88954,9 @@ "explode": false }, { - "name": "filter[appStoreVersionLocalization]", + "name": "filter[appEventLocalization]", "in": "query", - "description": "filter by id(s) of related 'appStoreVersionLocalization'", + "description": "filter by id(s) of related 'appEventLocalization'", "schema": { "type": "array", "items": { @@ -89878,9 +88967,9 @@ "explode": false }, { - "name": "filter[appCustomProductPageLocalization]", + "name": "filter[appStoreVersionLocalization]", "in": "query", - "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", "schema": { "type": "array", "items": { @@ -89958,7 +89047,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -90113,6 +89203,25 @@ "style": "form", "explode": false }, + { + "name": "fields[retentionMessageVersions]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessageVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "state", + "retentionMessage", + "localizations", + "placement" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "limit", "in": "query", @@ -90137,7 +89246,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -90221,12 +89331,12 @@ } ] }, - "/v1/appEvents/{id}/relationships/localizations": { + "/v1/appCustomProductPageLocalizations/{id}/relationships/searchKeywords": { "get": { "tags": [ - "AppEvents" + "AppCustomProductPageLocalizations" ], - "operationId": "appEvents_localizations_getToManyRelationship", + "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelationship", "parameters": [ { "name": "limit", @@ -90285,7 +89395,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEventLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/AppCustomProductPageLocalizationSearchKeywordsLinkagesResponse" } } } @@ -90302,212 +89412,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appEvents/{id}/localizations": { - "get": { + "post": { "tags": [ - "AppEvents" + "AppCustomProductPageLocalizations" ], - "operationId": "appEvents_localizations_getToManyRelated", - "parameters": [ - { - "name": "fields[appEventLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appEventLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "shortDescription", - "longDescription", - "appEvent", - "appEventScreenshots", - "appEventVideoClips", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[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[appEventScreenshots]", - "in": "query", - "description": "the fields to include for returned resources of type appEventScreenshots", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "imageAsset", - "assetToken", - "uploadOperations", - "assetDeliveryState", - "appEventAssetType", - "appEventLocalization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appEventVideoClips]", - "in": "query", - "description": "the fields to include for returned resources of type appEventVideoClips", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "previewFrameTimeCode", - "videoUrl", - "previewFrameImage", - "previewImage", - "uploadOperations", - "assetDeliveryState", - "videoDeliveryState", - "appEventAssetType", - "appEventLocalization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryPlacements]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryPlacements", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "mediaType", - "placementType", - "placementGroup", - "createdDate", - "lastModifiedDate", - "state", - "stateDetails", - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "appEvent", - "appEventScreenshots", - "appEventVideoClips", - "placements" - ] + "operationId": "appCustomProductPageLocalizations_searchKeywords_createToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCustomProductPageLocalizationSearchKeywordsLinkagesRequest" } - }, - "style": "form", - "explode": false - }, - { - "name": "limit[appEventScreenshots]", - "in": "query", - "description": "maximum number of related appEventScreenshots returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[appEventVideoClips]", - "in": "query", - "description": "maximum number of related appEventVideoClips returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" + } }, - { - "name": "limit[placements]", - "in": "query", - "description": "maximum number of related placements returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -90549,16 +89469,29 @@ } } }, - "200": { - "description": "List of AppEventLocalizations", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEventLocalizationsResponse" + "$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": { @@ -90571,26 +89504,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appInfos/{id}/relationships/ageRatingDeclaration": { - "get": { + "delete": { "tags": [ - "AppInfos" + "AppCustomProductPageLocalizations" ], - "operationId": "appInfos_ageRatingDeclaration_getToOneRelationship", - "parameters": [], + "operationId": "appCustomProductPageLocalizations_searchKeywords_deleteToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCustomProductPageLocalizationSearchKeywordsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -90632,16 +89561,29 @@ } } }, - "200": { - "description": "Related linkage", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInfoAgeRatingDeclarationLinkageResponse" + "$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": { @@ -90667,57 +89609,62 @@ } ] }, - "/v1/appInfos/{id}/ageRatingDeclaration": { + "/v1/appCustomProductPageLocalizations/{id}/searchKeywords": { "get": { "tags": [ - "AppInfos" + "AppCustomProductPageLocalizations" ], - "operationId": "appInfos_ageRatingDeclaration_getToOneRelated", + "operationId": "appCustomProductPageLocalizations_searchKeywords_getToManyRelated", "parameters": [ { - "name": "fields[ageRatingDeclarations]", + "name": "filter[platform]", "in": "query", - "description": "the fields to include for returned resources of type ageRatingDeclarations", + "description": "filter by platform", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "advertising", - "alcoholTobaccoOrDrugUseOrReferences", - "contests", - "gambling", - "gamblingSimulated", - "gunsOrOtherWeapons", - "healthOrWellnessTopics", - "kidsAgeBand", - "lootBox", - "medicalOrTreatmentInformation", - "messagingAndChat", - "parentalControls", - "profanityOrCrudeHumor", - "ageAssurance", - "sexualContentGraphicAndNudity", - "sexualContentOrNudity", - "socialMedia", - "socialMediaAgeRestricted", - "horrorOrFearThemes", - "matureOrSuggestiveThemes", - "unrestrictedWebAccess", - "userGeneratedContent", - "violenceCartoonOrFantasy", - "violenceRealisticProlongedGraphicOrSadistic", - "violenceRealistic", - "ageRatingOverride", - "ageRatingOverrideV2", - "koreaAgeRatingOverride", - "gracRatingClassificationNumber", - "developerAgeRatingInfoUrl" - ] + "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": { @@ -90762,11 +89709,11 @@ } }, "200": { - "description": "Single AgeRatingDeclaration", + "description": "List of AppKeywords", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AgeRatingDeclarationResponse" + "$ref": "#/components/schemas/AppKeywordsResponse" } } } @@ -90796,12 +89743,12 @@ } ] }, - "/v1/appInfos/{id}/relationships/appInfoLocalizations": { + "/v1/appCustomProductPageVersions/{id}/relationships/appCustomProductPageLocalizations": { "get": { "tags": [ - "AppInfos" + "AppCustomProductPageVersions" ], - "operationId": "appInfos_appInfoLocalizations_getToManyRelationship", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -90860,7 +89807,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInfoAppInfoLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/AppCustomProductPageVersionAppCustomProductPageLocalizationsLinkagesResponse" } } } @@ -90890,12 +89837,12 @@ } ] }, - "/v1/appInfos/{id}/appInfoLocalizations": { + "/v1/appCustomProductPageVersions/{id}/appCustomProductPageLocalizations": { "get": { "tags": [ - "AppInfos" + "AppCustomProductPageVersions" ], - "operationId": "appInfos_appInfoLocalizations_getToManyRelated", + "operationId": "appCustomProductPageVersions_appCustomProductPageLocalizations_getToManyRelated", "parameters": [ { "name": "filter[locale]", @@ -90911,21 +89858,21 @@ "explode": false }, { - "name": "fields[appInfoLocalizations]", + "name": "fields[appCustomProductPageLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appInfoLocalizations", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ "locale", - "name", - "subtitle", - "privacyPolicyUrl", - "privacyChoicesUrl", - "privacyPolicyText", - "appInfo" + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, @@ -90933,32 +89880,102 @@ "explode": false }, { - "name": "fields[appInfos]", + "name": "fields[appCustomProductPageVersions]", "in": "query", - "description": "the fields to include for returned resources of type appInfos", + "description": "the fields to include for returned resources of type appCustomProductPageVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "appStoreState", + "version", "state", - "appStoreAgeRating", - "australiaAgeRating", - "brazilAgeRating", - "brazilAgeRatingV2", - "franceAgeRating", - "koreaAgeRating", - "app", - "ageRatingDeclaration", - "appInfoLocalizations", - "primaryCategory", - "primarySubcategoryOne", - "primarySubcategoryTwo", - "secondaryCategory", - "secondarySubcategoryOne", - "secondarySubcategoryTwo", - "territoryAgeRatings" + "deepLink", + "appCustomProductPage", + "appCustomProductPageLocalizations" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appScreenshotSets]", + "in": "query", + "description": "the fields to include for returned resources of type appScreenshotSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "screenshotDisplayType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appScreenshots" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appPreviewSets]", + "in": "query", + "description": "the fields to include for returned resources of type appPreviewSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "previewType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appPreviews" + ] + } + }, + "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": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -90984,12 +90001,56 @@ "items": { "type": "string", "enum": [ - "appInfo" + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[appScreenshotSets]", + "in": "query", + "description": "maximum number of related appScreenshotSets returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[appPreviewSets]", + "in": "query", + "description": "maximum number of related appPreviewSets returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[searchKeywords]", + "in": "query", + "description": "maximum number of related searchKeywords returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -91034,11 +90095,11 @@ } }, "200": { - "description": "List of AppInfoLocalizations", + "description": "List of AppCustomProductPageLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInfoLocalizationsResponse" + "$ref": "#/components/schemas/AppCustomProductPageLocalizationsResponse" } } } @@ -91068,13 +90129,24 @@ } ] }, - "/v1/appInfos/{id}/relationships/primaryCategory": { + "/v1/appCustomProductPages/{id}/relationships/appCustomProductPageVersions": { "get": { "tags": [ - "AppInfos" + "AppCustomProductPages" + ], + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "appInfos_primaryCategory_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -91117,11 +90189,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInfoPrimaryCategoryLinkageResponse" + "$ref": "#/components/schemas/AppCustomProductPageAppCustomProductPageVersionsLinkagesResponse" } } } @@ -91151,31 +90223,108 @@ } ] }, - "/v1/appInfos/{id}/primaryCategory": { + "/v1/appCustomProductPages/{id}/appCustomProductPageVersions": { "get": { "tags": [ - "AppInfos" + "AppCustomProductPages" ], - "operationId": "appInfos_primaryCategory_getToOneRelated", + "operationId": "appCustomProductPages_appCustomProductPageVersions_getToManyRelated", "parameters": [ { - "name": "fields[appCategories]", + "name": "filter[state]", "in": "query", - "description": "the fields to include for returned resources of type appCategories", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platforms", - "subcategories", - "parent" + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "ACCEPTED", + "APPROVED", + "REPLACED_WITH_NEW_VERSION", + "REJECTED" + ] + } + }, + "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": "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[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, "style": "form", "explode": false }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, { "name": "include", "in": "query", @@ -91185,8 +90334,8 @@ "items": { "type": "string", "enum": [ - "subcategories", - "parent" + "appCustomProductPage", + "appCustomProductPageLocalizations" ] } }, @@ -91194,9 +90343,9 @@ "explode": false }, { - "name": "limit[subcategories]", + "name": "limit[appCustomProductPageLocalizations]", "in": "query", - "description": "maximum number of related subcategories returned (when they are included)", + "description": "maximum number of related appCustomProductPageLocalizations returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -91246,11 +90395,11 @@ } }, "200": { - "description": "Single AppCategory", + "description": "List of AppCustomProductPageVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCategoryResponse" + "$ref": "#/components/schemas/AppCustomProductPageVersionsResponse" } } } @@ -91280,12 +90429,13 @@ } ] }, - "/v1/appInfos/{id}/relationships/primarySubcategoryOne": { + "/v1/appEncryptionDeclarations/{id}/relationships/app": { "get": { "tags": [ - "AppInfos" + "AppEncryptionDeclarations" ], - "operationId": "appInfos_primarySubcategoryOne_getToOneRelationship", + "operationId": "appEncryptionDeclarations_app_getToOneRelationship", + "deprecated": true, "parameters": [], "responses": { "400": { @@ -91333,7 +90483,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInfoPrimarySubcategoryOneLinkageResponse" + "$ref": "#/components/schemas/AppEncryptionDeclarationAppLinkageResponse" } } } @@ -91363,57 +90513,86 @@ } ] }, - "/v1/appInfos/{id}/primarySubcategoryOne": { + "/v1/appEncryptionDeclarations/{id}/app": { "get": { "tags": [ - "AppInfos" + "AppEncryptionDeclarations" ], - "operationId": "appInfos_primarySubcategoryOne_getToOneRelated", + "operationId": "appEncryptionDeclarations_app_getToOneRelated", + "deprecated": true, "parameters": [ { - "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": "include", + "name": "fields[apps]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "subcategories", - "parent" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[subcategories]", - "in": "query", - "description": "maximum number of related subcategories returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -91458,11 +90637,11 @@ } }, "200": { - "description": "Single AppCategory", + "description": "Single App with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCategoryResponse" + "$ref": "#/components/schemas/AppWithoutIncludesResponse" } } } @@ -91492,12 +90671,12 @@ } ] }, - "/v1/appInfos/{id}/relationships/primarySubcategoryTwo": { + "/v1/appEncryptionDeclarations/{id}/relationships/appEncryptionDeclarationDocument": { "get": { "tags": [ - "AppInfos" + "AppEncryptionDeclarations" ], - "operationId": "appInfos_primarySubcategoryTwo_getToOneRelationship", + "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -91545,7 +90724,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInfoPrimarySubcategoryTwoLinkageResponse" + "$ref": "#/components/schemas/AppEncryptionDeclarationAppEncryptionDeclarationDocumentLinkageResponse" } } } @@ -91575,57 +90754,34 @@ } ] }, - "/v1/appInfos/{id}/primarySubcategoryTwo": { + "/v1/appEncryptionDeclarations/{id}/appEncryptionDeclarationDocument": { "get": { "tags": [ - "AppInfos" + "AppEncryptionDeclarations" ], - "operationId": "appInfos_primarySubcategoryTwo_getToOneRelated", + "operationId": "appEncryptionDeclarations_appEncryptionDeclarationDocument_getToOneRelated", "parameters": [ { - "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": "include", + "name": "fields[appEncryptionDeclarationDocuments]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type appEncryptionDeclarationDocuments", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "subcategories", - "parent" + "fileSize", + "fileName", + "assetToken", + "downloadUrl", + "sourceFileChecksum", + "uploadOperations", + "assetDeliveryState" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[subcategories]", - "in": "query", - "description": "maximum number of related subcategories returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -91670,11 +90826,11 @@ } }, "200": { - "description": "Single AppCategory", + "description": "Single AppEncryptionDeclarationDocument", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCategoryResponse" + "$ref": "#/components/schemas/AppEncryptionDeclarationDocumentResponse" } } } @@ -91704,13 +90860,24 @@ } ] }, - "/v1/appInfos/{id}/relationships/secondaryCategory": { - "get": { + "/v1/appEncryptionDeclarations/{id}/relationships/builds": { + "post": { "tags": [ - "AppInfos" + "AppEncryptionDeclarations" ], - "operationId": "appInfos_secondaryCategory_getToOneRelationship", - "parameters": [], + "operationId": "appEncryptionDeclarations_builds_createToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppEncryptionDeclarationBuildsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -91752,117 +90919,8 @@ } } }, - "200": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfoSecondaryCategoryLinkageResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appInfos/{id}/secondaryCategory": { - "get": { - "tags": [ - "AppInfos" - ], - "operationId": "appInfos_secondaryCategory_getToOneRelated", - "parameters": [ - { - "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": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "subcategories", - "parent" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit[subcategories]", - "in": "query", - "description": "maximum number of related subcategories 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", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { @@ -91871,8 +90929,8 @@ } } }, - "404": { - "description": "Not found error", + "409": { + "description": "Request entity error(s)", "content": { "application/json": { "schema": { @@ -91881,15 +90939,8 @@ } } }, - "200": { - "description": "Single AppCategory", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppCategoryResponse" - } - } - } + "204": { + "description": "Success (no content)" }, "429": { "description": "Rate limit exceeded error", @@ -91916,13 +90967,24 @@ } ] }, - "/v1/appInfos/{id}/relationships/secondarySubcategoryOne": { + "/v1/appEventLocalizations/{id}/relationships/appEventScreenshots": { "get": { "tags": [ - "AppInfos" + "AppEventLocalizations" + ], + "operationId": "appEventLocalizations_appEventScreenshots_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "appInfos_secondarySubcategoryOne_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -91965,11 +91027,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInfoSecondarySubcategoryOneLinkageResponse" + "$ref": "#/components/schemas/AppEventLocalizationAppEventScreenshotsLinkagesResponse" } } } @@ -91999,25 +91061,30 @@ } ] }, - "/v1/appInfos/{id}/secondarySubcategoryOne": { + "/v1/appEventLocalizations/{id}/appEventScreenshots": { "get": { "tags": [ - "AppInfos" + "AppEventLocalizations" ], - "operationId": "appInfos_secondarySubcategoryOne_getToOneRelated", + "operationId": "appEventLocalizations_appEventScreenshots_getToManyRelated", "parameters": [ { - "name": "fields[appCategories]", + "name": "fields[appEventScreenshots]", "in": "query", - "description": "the fields to include for returned resources of type appCategories", + "description": "the fields to include for returned resources of type appEventScreenshots", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platforms", - "subcategories", - "parent" + "fileSize", + "fileName", + "imageAsset", + "assetToken", + "uploadOperations", + "assetDeliveryState", + "appEventAssetType", + "appEventLocalization" ] } }, @@ -92025,16 +91092,22 @@ "explode": false }, { - "name": "include", + "name": "fields[appEventLocalizations]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type appEventLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "subcategories", - "parent" + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" ] } }, @@ -92042,14 +91115,30 @@ "explode": false }, { - "name": "limit[subcategories]", + "name": "limit", "in": "query", - "description": "maximum number of related subcategories returned (when they are included)", + "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 50 + "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appEventLocalization" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -92094,11 +91183,11 @@ } }, "200": { - "description": "Single AppCategory", + "description": "List of AppEventScreenshots", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCategoryResponse" + "$ref": "#/components/schemas/AppEventScreenshotsResponse" } } } @@ -92128,13 +91217,24 @@ } ] }, - "/v1/appInfos/{id}/relationships/secondarySubcategoryTwo": { + "/v1/appEventLocalizations/{id}/relationships/appEventVideoClips": { "get": { "tags": [ - "AppInfos" + "AppEventLocalizations" + ], + "operationId": "appEventLocalizations_appEventVideoClips_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "appInfos_secondarySubcategoryTwo_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -92177,11 +91277,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInfoSecondarySubcategoryTwoLinkageResponse" + "$ref": "#/components/schemas/AppEventLocalizationAppEventVideoClipsLinkagesResponse" } } } @@ -92211,25 +91311,33 @@ } ] }, - "/v1/appInfos/{id}/secondarySubcategoryTwo": { + "/v1/appEventLocalizations/{id}/appEventVideoClips": { "get": { "tags": [ - "AppInfos" + "AppEventLocalizations" ], - "operationId": "appInfos_secondarySubcategoryTwo_getToOneRelated", + "operationId": "appEventLocalizations_appEventVideoClips_getToManyRelated", "parameters": [ { - "name": "fields[appCategories]", + "name": "fields[appEventVideoClips]", "in": "query", - "description": "the fields to include for returned resources of type appCategories", + "description": "the fields to include for returned resources of type appEventVideoClips", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platforms", - "subcategories", - "parent" + "fileSize", + "fileName", + "previewFrameTimeCode", + "videoUrl", + "previewFrameImage", + "previewImage", + "uploadOperations", + "assetDeliveryState", + "videoDeliveryState", + "appEventAssetType", + "appEventLocalization" ] } }, @@ -92237,16 +91345,22 @@ "explode": false }, { - "name": "include", + "name": "fields[appEventLocalizations]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type appEventLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "subcategories", - "parent" + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" ] } }, @@ -92254,14 +91368,30 @@ "explode": false }, { - "name": "limit[subcategories]", + "name": "limit", "in": "query", - "description": "maximum number of related subcategories returned (when they are included)", + "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 50 + "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appEventLocalization" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -92306,11 +91436,11 @@ } }, "200": { - "description": "Single AppCategory", + "description": "List of AppEventVideoClips", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCategoryResponse" + "$ref": "#/components/schemas/AppEventVideoClipsResponse" } } } @@ -92340,12 +91470,12 @@ } ] }, - "/v1/appInfos/{id}/relationships/territoryAgeRatings": { + "/v1/appEventLocalizations/{id}/relationships/placements": { "get": { "tags": [ - "AppInfos" + "AppEventLocalizations" ], - "operationId": "appInfos_territoryAgeRatings_getToManyRelationship", + "operationId": "appEventLocalizations_placements_getToManyRelationship", "parameters": [ { "name": "limit", @@ -92404,7 +91534,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInfoTerritoryAgeRatingsLinkagesResponse" + "$ref": "#/components/schemas/AppEventLocalizationPlacementsLinkagesResponse" } } } @@ -92434,24 +91564,32 @@ } ] }, - "/v1/appInfos/{id}/territoryAgeRatings": { + "/v1/appEventLocalizations/{id}/placements": { "get": { "tags": [ - "AppInfos" + "AppEventLocalizations" ], - "operationId": "appInfos_territoryAgeRatings_getToManyRelated", + "operationId": "appEventLocalizations_placements_getToManyRelated", "parameters": [ { - "name": "fields[territoryAgeRatings]", + "name": "filter[placementType]", "in": "query", - "description": "the fields to include for returned resources of type territoryAgeRatings", + "description": "filter by attribute 'placementType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "appStoreAgeRating", - "territory" + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" ] } }, @@ -92459,15 +91597,329 @@ "explode": false }, { - "name": "fields[territories]", + "name": "filter[placementGroup]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "filter by attribute 'placementGroup'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[image]", + "in": "query", + "description": "filter by id(s) of related 'image'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[video]", + "in": "query", + "description": "filter by id(s) of related 'video'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appCustomProductPageLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "placementGroupPosition", + "-placementGroupPosition" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryImages]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryVideos]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appEventLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[retentionMessageVersions]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessageVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "state", + "retentionMessage", + "localizations", + "placement" ] } }, @@ -92493,7 +91945,13 @@ "items": { "type": "string", "enum": [ - "territory" + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -92543,11 +92001,11 @@ } }, "200": { - "description": "List of TerritoryAgeRatings", + "description": "List of AppAssetLibraryPlacements", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoryAgeRatingsResponse" + "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" } } } @@ -92577,12 +92035,12 @@ } ] }, - "/v1/appPreviewSets/{id}/relationships/appPreviews": { + "/v1/appEvents/{id}/relationships/localizations": { "get": { "tags": [ - "AppPreviewSets" + "AppEvents" ], - "operationId": "appPreviewSets_appPreviews_getToManyRelationship", + "operationId": "appEvents_localizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -92641,103 +92099,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPreviewSetAppPreviewsLinkagesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "patch": { - "tags": [ - "AppPreviewSets" - ], - "operationId": "appPreviewSets_appPreviews_replaceToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppPreviewSetAppPreviewsLinkagesRequest" - } - } - }, - "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" + "$ref": "#/components/schemas/AppEventLocalizationsLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -92763,17 +92129,89 @@ } ] }, - "/v1/appPreviewSets/{id}/appPreviews": { + "/v1/appEvents/{id}/localizations": { "get": { "tags": [ - "AppPreviewSets" + "AppEvents" ], - "operationId": "appPreviewSets_appPreviews_getToManyRelated", + "operationId": "appEvents_localizations_getToManyRelated", "parameters": [ { - "name": "fields[appPreviews]", + "name": "fields[appEventLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appPreviews", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[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[appEventScreenshots]", + "in": "query", + "description": "the fields to include for returned resources of type appEventScreenshots", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "imageAsset", + "assetToken", + "uploadOperations", + "assetDeliveryState", + "appEventAssetType", + "appEventLocalization" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appEventVideoClips]", + "in": "query", + "description": "the fields to include for returned resources of type appEventVideoClips", "schema": { "type": "array", "items": { @@ -92781,16 +92219,15 @@ "enum": [ "fileSize", "fileName", - "sourceFileChecksum", "previewFrameTimeCode", - "mimeType", "videoUrl", "previewFrameImage", "previewImage", "uploadOperations", "assetDeliveryState", "videoDeliveryState", - "appPreviewSet" + "appEventAssetType", + "appEventLocalization" ] } }, @@ -92798,19 +92235,28 @@ "explode": false }, { - "name": "fields[appPreviewSets]", + "name": "fields[appAssetLibraryPlacements]", "in": "query", - "description": "the fields to include for returned resources of type appPreviewSets", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "previewType", + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", "appStoreVersionExperimentTreatmentLocalization", - "appPreviews" + "retentionMessageVersion" ] } }, @@ -92836,12 +92282,45 @@ "items": { "type": "string", "enum": [ - "appPreviewSet" + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[appEventScreenshots]", + "in": "query", + "description": "maximum number of related appEventScreenshots returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[appEventVideoClips]", + "in": "query", + "description": "maximum number of related appEventVideoClips returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -92886,11 +92365,11 @@ } }, "200": { - "description": "List of AppPreviews", + "description": "List of AppEventLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPreviewsResponse" + "$ref": "#/components/schemas/AppEventLocalizationsResponse" } } } @@ -92920,24 +92399,13 @@ } ] }, - "/v3/appPricePoints/{id}/relationships/equalizations": { + "/v1/appInfos/{id}/relationships/ageRatingDeclaration": { "get": { "tags": [ - "AppPricePoints" - ], - "operationId": "appPricePointsV3_equalizations_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppInfos" ], + "operationId": "appInfos_ageRatingDeclaration_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -92980,11 +92448,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPricePointV3EqualizationsLinkagesResponse" + "$ref": "#/components/schemas/AppInfoAgeRatingDeclarationLinkageResponse" } } } @@ -93014,155 +92482,52 @@ } ] }, - "/v3/appPricePoints/{id}/equalizations": { + "/v1/appInfos/{id}/ageRatingDeclaration": { "get": { "tags": [ - "AppPricePoints" + "AppInfos" ], - "operationId": "appPricePointsV3_equalizations_getToManyRelated", + "operationId": "appInfos_ageRatingDeclaration_getToOneRelated", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "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", + "name": "fields[ageRatingDeclarations]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type ageRatingDeclarations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "app", - "territory" + "advertising", + "alcoholTobaccoOrDrugUseOrReferences", + "contests", + "gambling", + "gamblingSimulated", + "gunsOrOtherWeapons", + "healthOrWellnessTopics", + "kidsAgeBand", + "lootBox", + "medicalOrTreatmentInformation", + "messagingAndChat", + "parentalControls", + "profanityOrCrudeHumor", + "ageAssurance", + "sexualContentGraphicAndNudity", + "sexualContentOrNudity", + "socialMedia", + "socialMediaAgeRestricted", + "horrorOrFearThemes", + "matureOrSuggestiveThemes", + "unrestrictedWebAccess", + "userGeneratedContent", + "violenceCartoonOrFantasy", + "violenceRealisticProlongedGraphicOrSadistic", + "violenceRealistic", + "ageRatingOverride", + "ageRatingOverrideV2", + "koreaAgeRatingOverride", + "gracRatingClassificationNumber", + "developerAgeRatingInfoUrl" ] } }, @@ -93212,16 +92577,11 @@ } }, "200": { - "description": "List of AppPricePoints", + "description": "Single AgeRatingDeclaration", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPricePointsV3Response" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/csv" + "$ref": "#/components/schemas/AgeRatingDeclarationResponse" } } } @@ -93251,12 +92611,12 @@ } ] }, - "/v1/appPriceSchedules/{id}/relationships/automaticPrices": { + "/v1/appInfos/{id}/relationships/appInfoLocalizations": { "get": { "tags": [ - "AppPriceSchedules" + "AppInfos" ], - "operationId": "appPriceSchedules_automaticPrices_getToManyRelationship", + "operationId": "appInfos_appInfoLocalizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -93315,7 +92675,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPriceScheduleAutomaticPricesLinkagesResponse" + "$ref": "#/components/schemas/AppInfoAppInfoLocalizationsLinkagesResponse" } } } @@ -93345,43 +92705,17 @@ } ] }, - "/v1/appPriceSchedules/{id}/automaticPrices": { + "/v1/appInfos/{id}/appInfoLocalizations": { "get": { "tags": [ - "AppPriceSchedules" + "AppInfos" ], - "operationId": "appPriceSchedules_automaticPrices_getToManyRelated", + "operationId": "appInfos_appInfoLocalizations_getToManyRelated", "parameters": [ { - "name": "filter[startDate]", - "in": "query", - "description": "filter by attribute 'startDate'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[endDate]", - "in": "query", - "description": "filter by attribute 'endDate'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[territory]", + "name": "filter[locale]", "in": "query", - "description": "filter by id(s) of related 'territory'", + "description": "filter by attribute 'locale'", "schema": { "type": "array", "items": { @@ -93392,19 +92726,21 @@ "explode": false }, { - "name": "fields[appPrices]", + "name": "fields[appInfoLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appPrices", + "description": "the fields to include for returned resources of type appInfoLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "manual", - "startDate", - "endDate", - "appPricePoint", - "territory" + "locale", + "name", + "subtitle", + "privacyPolicyUrl", + "privacyChoicesUrl", + "privacyPolicyText", + "appInfo" ] } }, @@ -93412,35 +92748,32 @@ "explode": false }, { - "name": "fields[appPricePoints]", + "name": "fields[appInfos]", "in": "query", - "description": "the fields to include for returned resources of type appPricePoints", + "description": "the fields to include for returned resources of type appInfos", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", + "appStoreState", + "state", + "appStoreAgeRating", + "australiaAgeRating", + "brazilAgeRating", + "brazilAgeRatingV2", + "franceAgeRating", + "koreaAgeRating", "app", - "equalizations", - "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" + "ageRatingDeclaration", + "appInfoLocalizations", + "primaryCategory", + "primarySubcategoryOne", + "primarySubcategoryTwo", + "secondaryCategory", + "secondarySubcategoryOne", + "secondarySubcategoryTwo", + "territoryAgeRatings" ] } }, @@ -93466,8 +92799,7 @@ "items": { "type": "string", "enum": [ - "appPricePoint", - "territory" + "appInfo" ] } }, @@ -93517,11 +92849,11 @@ } }, "200": { - "description": "List of AppPrices", + "description": "List of AppInfoLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPricesV2Response" + "$ref": "#/components/schemas/AppInfoLocalizationsResponse" } } } @@ -93551,12 +92883,12 @@ } ] }, - "/v1/appPriceSchedules/{id}/relationships/baseTerritory": { + "/v1/appInfos/{id}/relationships/primaryCategory": { "get": { "tags": [ - "AppPriceSchedules" + "AppInfos" ], - "operationId": "appPriceSchedules_baseTerritory_getToOneRelationship", + "operationId": "appInfos_primaryCategory_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -93604,7 +92936,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPriceScheduleBaseTerritoryLinkageResponse" + "$ref": "#/components/schemas/AppInfoPrimaryCategoryLinkageResponse" } } } @@ -93634,28 +92966,57 @@ } ] }, - "/v1/appPriceSchedules/{id}/baseTerritory": { + "/v1/appInfos/{id}/primaryCategory": { "get": { "tags": [ - "AppPriceSchedules" + "AppInfos" ], - "operationId": "appPriceSchedules_baseTerritory_getToOneRelated", + "operationId": "appInfos_primaryCategory_getToOneRelated", "parameters": [ { - "name": "fields[territories]", + "name": "fields[appCategories]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type appCategories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "platforms", + "subcategories", + "parent" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "subcategories", + "parent" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[subcategories]", + "in": "query", + "description": "maximum number of related subcategories returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -93700,11 +93061,11 @@ } }, "200": { - "description": "Single Territory", + "description": "Single AppCategory", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoryResponse" + "$ref": "#/components/schemas/AppCategoryResponse" } } } @@ -93734,24 +93095,13 @@ } ] }, - "/v1/appPriceSchedules/{id}/relationships/manualPrices": { + "/v1/appInfos/{id}/relationships/primarySubcategoryOne": { "get": { "tags": [ - "AppPriceSchedules" - ], - "operationId": "appPriceSchedules_manualPrices_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppInfos" ], + "operationId": "appInfos_primarySubcategoryOne_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -93794,11 +93144,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPriceScheduleManualPricesLinkagesResponse" + "$ref": "#/components/schemas/AppInfoPrimarySubcategoryOneLinkageResponse" } } } @@ -93828,136 +93178,142 @@ } ] }, - "/v1/appPriceSchedules/{id}/manualPrices": { + "/v1/appInfos/{id}/primarySubcategoryOne": { "get": { "tags": [ - "AppPriceSchedules" + "AppInfos" ], - "operationId": "appPriceSchedules_manualPrices_getToManyRelated", + "operationId": "appInfos_primarySubcategoryOne_getToOneRelated", "parameters": [ { - "name": "filter[startDate]", + "name": "fields[appCategories]", "in": "query", - "description": "filter by attribute 'startDate'", + "description": "the fields to include for returned resources of type appCategories", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "platforms", + "subcategories", + "parent" + ] } }, "style": "form", "explode": false }, { - "name": "filter[endDate]", + "name": "include", "in": "query", - "description": "filter by attribute 'endDate'", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "subcategories", + "parent" + ] } }, "style": "form", "explode": false }, { - "name": "filter[territory]", + "name": "limit[subcategories]", "in": "query", - "description": "filter by id(s) of related 'territory'", + "description": "maximum number of related subcategories returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string" - } + "type": "integer", + "maximum": 50 }, - "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" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "appPricePoint", - "territory" - ] + "200": { + "description": "Single AppCategory", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCategoryResponse" + } } - }, - "style": "form", - "explode": false + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appInfos/{id}/relationships/primarySubcategoryTwo": { + "get": { + "tags": [ + "AppInfos" ], + "operationId": "appInfos_primarySubcategoryTwo_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -94000,11 +93356,11 @@ } }, "200": { - "description": "List of AppPrices", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPricesV2Response" + "$ref": "#/components/schemas/AppInfoPrimarySubcategoryTwoLinkageResponse" } } } @@ -94034,20 +93390,55 @@ } ] }, - "/v1/appScreenshotSets/{id}/relationships/appScreenshots": { + "/v1/appInfos/{id}/primarySubcategoryTwo": { "get": { "tags": [ - "AppScreenshotSets" + "AppInfos" ], - "operationId": "appScreenshotSets_appScreenshots_getToManyRelationship", + "operationId": "appInfos_primarySubcategoryTwo_getToOneRelated", "parameters": [ { - "name": "limit", + "name": "fields[appCategories]", "in": "query", - "description": "maximum resources per page", + "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": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "subcategories", + "parent" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[subcategories]", + "in": "query", + "description": "maximum number of related subcategories returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "maximum": 50 }, "style": "form" } @@ -94094,11 +93485,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Single AppCategory", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppScreenshotSetAppScreenshotsLinkagesResponse" + "$ref": "#/components/schemas/AppCategoryResponse" } } } @@ -94115,22 +93506,26 @@ } } }, - "patch": { - "tags": [ - "AppScreenshotSets" - ], - "operationId": "appScreenshotSets_appScreenshots_replaceToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppScreenshotSetAppScreenshotsLinkagesRequest" - } - } + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", "required": true - }, + } + ] + }, + "/v1/appInfos/{id}/relationships/secondaryCategory": { + "get": { + "tags": [ + "AppInfos" + ], + "operationId": "appInfos_secondaryCategory_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -94172,29 +93567,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/AppInfoSecondaryCategoryLinkageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -94220,31 +93602,25 @@ } ] }, - "/v1/appScreenshotSets/{id}/appScreenshots": { + "/v1/appInfos/{id}/secondaryCategory": { "get": { "tags": [ - "AppScreenshotSets" + "AppInfos" ], - "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", + "operationId": "appInfos_secondaryCategory_getToOneRelated", "parameters": [ { - "name": "fields[appScreenshots]", + "name": "fields[appCategories]", "in": "query", - "description": "the fields to include for returned resources of type appScreenshots", + "description": "the fields to include for returned resources of type appCategories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "imageAsset", - "assetToken", - "assetType", - "uploadOperations", - "assetDeliveryState", - "appScreenshotSet" + "platforms", + "subcategories", + "parent" ] } }, @@ -94252,19 +93628,16 @@ "explode": false }, { - "name": "fields[appScreenshotSets]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type appScreenshotSets", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "screenshotDisplayType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appScreenshots" + "subcategories", + "parent" ] } }, @@ -94272,30 +93645,14 @@ "explode": false }, { - "name": "limit", + "name": "limit[subcategories]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related subcategories returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "maximum": 50 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "appScreenshotSet" - ] - } - }, - "style": "form", - "explode": false } ], "responses": { @@ -94340,11 +93697,11 @@ } }, "200": { - "description": "List of AppScreenshots", + "description": "Single AppCategory", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppScreenshotsResponse" + "$ref": "#/components/schemas/AppCategoryResponse" } } } @@ -94374,24 +93731,13 @@ } ] }, - "/v1/appStoreReviewDetails/{id}/relationships/appStoreReviewAttachments": { + "/v1/appInfos/{id}/relationships/secondarySubcategoryOne": { "get": { "tags": [ - "AppStoreReviewDetails" - ], - "operationId": "appStoreReviewDetails_appStoreReviewAttachments_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppInfos" ], + "operationId": "appInfos_secondarySubcategoryOne_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -94434,11 +93780,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreReviewDetailAppStoreReviewAttachmentsLinkagesResponse" + "$ref": "#/components/schemas/AppInfoSecondarySubcategoryOneLinkageResponse" } } } @@ -94468,28 +93814,25 @@ } ] }, - "/v1/appStoreReviewDetails/{id}/appStoreReviewAttachments": { + "/v1/appInfos/{id}/secondarySubcategoryOne": { "get": { "tags": [ - "AppStoreReviewDetails" + "AppInfos" ], - "operationId": "appStoreReviewDetails_appStoreReviewAttachments_getToManyRelated", + "operationId": "appInfos_secondarySubcategoryOne_getToOneRelated", "parameters": [ { - "name": "fields[appStoreReviewAttachments]", + "name": "fields[appCategories]", "in": "query", - "description": "the fields to include for returned resources of type appStoreReviewAttachments", + "description": "the fields to include for returned resources of type appCategories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "uploadOperations", - "assetDeliveryState", - "appStoreReviewDetail" + "platforms", + "subcategories", + "parent" ] } }, @@ -94497,24 +93840,16 @@ "explode": false }, { - "name": "fields[appStoreReviewDetails]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type appStoreReviewDetails", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "contactFirstName", - "contactLastName", - "contactPhone", - "contactEmail", - "demoAccountName", - "demoAccountPassword", - "demoAccountRequired", - "notes", - "appStoreVersion", - "appStoreReviewAttachments" + "subcategories", + "parent" ] } }, @@ -94522,30 +93857,14 @@ "explode": false }, { - "name": "limit", + "name": "limit[subcategories]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related subcategories returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "maximum": 50 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "appStoreReviewDetail" - ] - } - }, - "style": "form", - "explode": false } ], "responses": { @@ -94590,11 +93909,11 @@ } }, "200": { - "description": "List of AppStoreReviewAttachments", + "description": "Single AppCategory", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreReviewAttachmentsResponse" + "$ref": "#/components/schemas/AppCategoryResponse" } } } @@ -94624,24 +93943,13 @@ } ] }, - "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/relationships/appPreviewSets": { + "/v1/appInfos/{id}/relationships/secondarySubcategoryTwo": { "get": { "tags": [ - "AppStoreVersionExperimentTreatmentLocalizations" - ], - "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppInfos" ], + "operationId": "appInfos_secondarySubcategoryTwo_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -94684,11 +93992,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalizationAppPreviewSetsLinkagesResponse" + "$ref": "#/components/schemas/AppInfoSecondarySubcategoryTwoLinkageResponse" } } } @@ -94718,196 +94026,31 @@ } ] }, - "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/appPreviewSets": { + "/v1/appInfos/{id}/secondarySubcategoryTwo": { "get": { "tags": [ - "AppStoreVersionExperimentTreatmentLocalizations" + "AppInfos" ], - "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "operationId": "appInfos_secondarySubcategoryTwo_getToOneRelated", "parameters": [ { - "name": "filter[previewType]", - "in": "query", - "description": "filter by attribute 'previewType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "IPHONE_67", - "IPHONE_61", - "IPHONE_65", - "IPHONE_58", - "IPHONE_55", - "IPHONE_47", - "IPHONE_40", - "IPHONE_35", - "IPAD_PRO_3GEN_129", - "IPAD_PRO_3GEN_11", - "IPAD_PRO_129", - "IPAD_105", - "IPAD_97", - "DESKTOP", - "APPLE_TV", - "APPLE_VISION_PRO" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appCustomProductPageLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appCustomProductPageLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appPreviewSets]", - "in": "query", - "description": "the fields to include for returned resources of type appPreviewSets", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "previewType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appPreviews" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appCustomProductPageLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "promotionalText", - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appPreviews]", + "name": "fields[appCategories]", "in": "query", - "description": "the fields to include for returned resources of type appPreviews", + "description": "the fields to include for returned resources of type appCategories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "previewFrameTimeCode", - "mimeType", - "videoUrl", - "previewFrameImage", - "previewImage", - "uploadOperations", - "assetDeliveryState", - "videoDeliveryState", - "appPreviewSet" + "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", @@ -94917,10 +94060,8 @@ "items": { "type": "string", "enum": [ - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appPreviews" + "subcategories", + "parent" ] } }, @@ -94928,9 +94069,9 @@ "explode": false }, { - "name": "limit[appPreviews]", + "name": "limit[subcategories]", "in": "query", - "description": "maximum number of related appPreviews returned (when they are included)", + "description": "maximum number of related subcategories returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -94980,11 +94121,11 @@ } }, "200": { - "description": "List of AppPreviewSets", + "description": "Single AppCategory", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPreviewSetsResponse" + "$ref": "#/components/schemas/AppCategoryResponse" } } } @@ -95014,12 +94155,12 @@ } ] }, - "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/relationships/appScreenshotSets": { + "/v1/appInfos/{id}/relationships/territoryAgeRatings": { "get": { "tags": [ - "AppStoreVersionExperimentTreatmentLocalizations" + "AppInfos" ], - "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelationship", + "operationId": "appInfos_territoryAgeRatings_getToManyRelationship", "parameters": [ { "name": "limit", @@ -95078,7 +94219,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalizationAppScreenshotSetsLinkagesResponse" + "$ref": "#/components/schemas/AppInfoTerritoryAgeRatingsLinkagesResponse" } } } @@ -95108,170 +94249,24 @@ } ] }, - "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/appScreenshotSets": { + "/v1/appInfos/{id}/territoryAgeRatings": { "get": { "tags": [ - "AppStoreVersionExperimentTreatmentLocalizations" + "AppInfos" ], - "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "operationId": "appInfos_territoryAgeRatings_getToManyRelated", "parameters": [ { - "name": "filter[screenshotDisplayType]", - "in": "query", - "description": "filter by attribute 'screenshotDisplayType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "APP_IPHONE_67", - "APP_IPHONE_61", - "APP_IPHONE_65", - "APP_IPHONE_58", - "APP_IPHONE_55", - "APP_IPHONE_47", - "APP_IPHONE_40", - "APP_IPHONE_35", - "APP_IPAD_PRO_3GEN_129", - "APP_IPAD_PRO_3GEN_11", - "APP_IPAD_PRO_129", - "APP_IPAD_105", - "APP_IPAD_97", - "APP_DESKTOP", - "APP_WATCH_ULTRA", - "APP_WATCH_SERIES_10", - "APP_WATCH_SERIES_7", - "APP_WATCH_SERIES_4", - "APP_WATCH_SERIES_3", - "APP_APPLE_TV", - "APP_APPLE_VISION_PRO", - "IMESSAGE_APP_IPHONE_67", - "IMESSAGE_APP_IPHONE_61", - "IMESSAGE_APP_IPHONE_65", - "IMESSAGE_APP_IPHONE_58", - "IMESSAGE_APP_IPHONE_55", - "IMESSAGE_APP_IPHONE_47", - "IMESSAGE_APP_IPHONE_40", - "IMESSAGE_APP_IPAD_PRO_3GEN_129", - "IMESSAGE_APP_IPAD_PRO_3GEN_11", - "IMESSAGE_APP_IPAD_PRO_129", - "IMESSAGE_APP_IPAD_105", - "IMESSAGE_APP_IPAD_97" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appCustomProductPageLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appCustomProductPageLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appScreenshotSets]", - "in": "query", - "description": "the fields to include for returned resources of type appScreenshotSets", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "screenshotDisplayType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appScreenshots" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appCustomProductPageLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "promotionalText", - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "name": "fields[territoryAgeRatings]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "description": "the fields to include for returned resources of type territoryAgeRatings", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" + "appStoreAgeRating", + "territory" ] } }, @@ -95279,23 +94274,15 @@ "explode": false }, { - "name": "fields[appScreenshots]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type appScreenshots", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "imageAsset", - "assetToken", - "assetType", - "uploadOperations", - "assetDeliveryState", - "appScreenshotSet" + "currency" ] } }, @@ -95321,25 +94308,12 @@ "items": { "type": "string", "enum": [ - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appScreenshots" + "territory" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[appScreenshots]", - "in": "query", - "description": "maximum number of related appScreenshots returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -95384,11 +94358,11 @@ } }, "200": { - "description": "List of AppScreenshotSets", + "description": "List of TerritoryAgeRatings", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppScreenshotSetsResponse" + "$ref": "#/components/schemas/TerritoryAgeRatingsResponse" } } } @@ -95418,12 +94392,12 @@ } ] }, - "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/relationships/placements": { + "/v1/appPreviewSets/{id}/relationships/appPreviews": { "get": { "tags": [ - "AppStoreVersionExperimentTreatmentLocalizations" + "AppPreviewSets" ], - "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelationship", + "operationId": "appPreviewSets_appPreviews_getToManyRelationship", "parameters": [ { "name": "limit", @@ -95482,11 +94456,103 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalizationPlacementsLinkagesResponse" + "$ref": "#/components/schemas/AppPreviewSetAppPreviewsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "patch": { + "tags": [ + "AppPreviewSets" + ], + "operationId": "appPreviewSets_appPreviews_replaceToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPreviewSetAppPreviewsLinkagesRequest" + } + } + }, + "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": { @@ -95512,32 +94578,34 @@ } ] }, - "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/placements": { + "/v1/appPreviewSets/{id}/appPreviews": { "get": { "tags": [ - "AppStoreVersionExperimentTreatmentLocalizations" + "AppPreviewSets" ], - "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", + "operationId": "appPreviewSets_appPreviews_getToManyRelated", "parameters": [ { - "name": "filter[placementType]", + "name": "fields[appPreviews]", "in": "query", - "description": "filter by attribute 'placementType'", + "description": "the fields to include for returned resources of type appPreviews", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "APP_SCREENSHOT", - "IMESSAGE_APP_SCREENSHOT", - "APP_PREVIEW", - "PRODUCT_PAGE_HEADER_ASSET", - "APP_STORE_SEARCH_RESULTS_ASSET", - "SEARCH_RESULTS_ADS_ASSET", - "TODAY_TAB_ADS_ASSET", - "EVENT_CARD_ASSET", - "EVENT_DETAILS_PAGE_ASSET", - "RETENTION_MESSAGE_ASSET" + "fileSize", + "fileName", + "sourceFileChecksum", + "previewFrameTimeCode", + "mimeType", + "videoUrl", + "previewFrameImage", + "previewImage", + "uploadOperations", + "assetDeliveryState", + "videoDeliveryState", + "appPreviewSet" ] } }, @@ -95545,34 +94613,19 @@ "explode": false }, { - "name": "filter[placementGroup]", - "in": "query", - "description": "filter by attribute 'placementGroup'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[state]", + "name": "fields[appPreviewSets]", "in": "query", - "description": "filter by attribute 'state'", + "description": "the fields to include for returned resources of type appPreviewSets", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "ASSET_PROCESSING", - "FAILED", - "PARENT_PREPARE_FOR_SUBMISSION", - "PARENT_READY_FOR_REVIEW", - "PARENT_WAITING_FOR_REVIEW", - "PARENT_IN_REVIEW", - "PARENT_APPROVED" + "previewType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appPreviews" ] } }, @@ -95580,322 +94633,42 @@ "explode": false }, { - "name": "filter[image]", + "name": "limit", "in": "query", - "description": "filter by id(s) of related 'image'", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string" - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { - "name": "filter[video]", + "name": "include", "in": "query", - "description": "filter by id(s) of related 'video'", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "appPreviewSet" + ] } }, "style": "form", "explode": false - }, - { - "name": "filter[appEventLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appEventLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersionLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersionLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appCustomProductPageLocalization]", - "in": "query", - "description": "filter by id(s) of related 'appCustomProductPageLocalization'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "sort", - "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "createdDate", - "-createdDate", - "lastModifiedDate", - "-lastModifiedDate", - "placementGroupPosition", - "-placementGroupPosition" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryPlacements]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryPlacements", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "mediaType", - "placementType", - "placementGroup", - "createdDate", - "lastModifiedDate", - "state", - "stateDetails", - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryImages]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "imageAsset", - "referenceName", - "specId", - "state", - "stateDetails", - "uploadOperations", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appAssetLibraryVideos]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryVideos", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "previewFrameImage", - "previewFrameTimeCode", - "referenceName", - "specId", - "state", - "stateDetails", - "uploadOperations", - "videoAsset", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appEventLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appEventLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "shortDescription", - "longDescription", - "appEvent", - "appEventScreenshots", - "appEventVideoClips", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appCustomProductPageLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "promotionalText", - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" - ] - } - }, - "style": "form", - "explode": false - } - ], - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } + } }, "401": { "description": "Unauthorized error(s)", @@ -95928,11 +94701,11 @@ } }, "200": { - "description": "List of AppAssetLibraryPlacements", + "description": "List of AppPreviews", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" + "$ref": "#/components/schemas/AppPreviewsResponse" } } } @@ -95962,12 +94735,12 @@ } ] }, - "/v1/appStoreVersionExperimentTreatments/{id}/relationships/appStoreVersionExperimentTreatmentLocalizations": { + "/v3/appPricePoints/{id}/relationships/equalizations": { "get": { "tags": [ - "AppStoreVersionExperimentTreatments" + "AppPricePoints" ], - "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelationship", + "operationId": "appPricePointsV3_equalizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -96026,7 +94799,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentAppStoreVersionExperimentTreatmentLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/AppPricePointV3EqualizationsLinkagesResponse" } } } @@ -96056,17 +94829,17 @@ } ] }, - "/v1/appStoreVersionExperimentTreatments/{id}/appStoreVersionExperimentTreatmentLocalizations": { + "/v3/appPricePoints/{id}/equalizations": { "get": { "tags": [ - "AppStoreVersionExperimentTreatments" + "AppPricePoints" ], - "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", + "operationId": "appPricePointsV3_equalizations_getToManyRelated", "parameters": [ { - "name": "filter[locale]", + "name": "filter[territory]", "in": "query", - "description": "filter by attribute 'locale'", + "description": "filter by id(s) of related 'territory'", "schema": { "type": "array", "items": { @@ -96077,19 +94850,19 @@ "explode": false }, { - "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "name": "fields[appPricePoints]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "description": "the fields to include for returned resources of type appPricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" + "customerPrice", + "proceeds", + "app", + "equalizations", + "territory" ] } }, @@ -96097,61 +94870,72 @@ "explode": false }, { - "name": "fields[appStoreVersionExperimentTreatments]", + "name": "fields[apps]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatments", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "accessibilityUrl", "name", - "appIcon", - "appIconName", - "promotedDate", - "appStoreVersionExperiment", - "appStoreVersionExperimentV2", - "appStoreVersionExperimentTreatmentLocalizations" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appScreenshotSets]", - "in": "query", - "description": "the fields to include for returned resources of type appScreenshotSets", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "screenshotDisplayType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appScreenshots" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appPreviewSets]", - "in": "query", - "description": "the fields to include for returned resources of type appPreviewSets", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "previewType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appPreviews" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, @@ -96159,27 +94943,15 @@ "explode": false }, { - "name": "fields[appAssetLibraryPlacements]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "mediaType", - "placementType", - "placementGroup", - "createdDate", - "lastModifiedDate", - "state", - "stateDetails", - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "currency" ] } }, @@ -96205,45 +94977,13 @@ "items": { "type": "string", "enum": [ - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" + "app", + "territory" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[appScreenshotSets]", - "in": "query", - "description": "maximum number of related appScreenshotSets returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[appPreviewSets]", - "in": "query", - "description": "maximum number of related appPreviewSets returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[placements]", - "in": "query", - "description": "maximum number of related placements returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -96288,11 +95028,16 @@ } }, "200": { - "description": "List of AppStoreVersionExperimentTreatmentLocalizations", + "description": "List of AppPricePoints", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalizationsResponse" + "$ref": "#/components/schemas/AppPricePointsV3Response" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/csv" } } } @@ -96322,12 +95067,12 @@ } ] }, - "/v2/appStoreVersionExperiments/{id}/relationships/appStoreVersionExperimentTreatments": { + "/v1/appPriceSchedules/{id}/relationships/automaticPrices": { "get": { "tags": [ - "AppStoreVersionExperiments" + "AppPriceSchedules" ], - "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelationship", + "operationId": "appPriceSchedules_automaticPrices_getToManyRelationship", "parameters": [ { "name": "limit", @@ -96386,7 +95131,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentV2AppStoreVersionExperimentTreatmentsLinkagesResponse" + "$ref": "#/components/schemas/AppPriceScheduleAutomaticPricesLinkagesResponse" } } } @@ -96416,29 +95161,66 @@ } ] }, - "/v2/appStoreVersionExperiments/{id}/appStoreVersionExperimentTreatments": { + "/v1/appPriceSchedules/{id}/automaticPrices": { "get": { "tags": [ - "AppStoreVersionExperiments" + "AppPriceSchedules" ], - "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", + "operationId": "appPriceSchedules_automaticPrices_getToManyRelated", "parameters": [ { - "name": "fields[appStoreVersionExperimentTreatments]", + "name": "filter[startDate]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatments", + "description": "filter by attribute 'startDate'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[endDate]", + "in": "query", + "description": "filter by attribute 'endDate'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "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[appPrices]", + "in": "query", + "description": "the fields to include for returned resources of type appPrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "appIcon", - "appIconName", - "promotedDate", - "appStoreVersionExperiment", - "appStoreVersionExperimentV2", - "appStoreVersionExperimentTreatmentLocalizations" + "manual", + "startDate", + "endDate", + "appPricePoint", + "territory" ] } }, @@ -96446,26 +95228,19 @@ "explode": false }, { - "name": "fields[appStoreVersionExperiments]", + "name": "fields[appPricePoints]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperiments", + "description": "the fields to include for returned resources of type appPricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "trafficProportion", - "state", - "reviewRequired", - "startDate", - "endDate", - "appStoreVersion", - "appStoreVersionExperimentTreatments", - "platform", + "customerPrice", + "proceeds", "app", - "latestControlVersion", - "controlVersions" + "equalizations", + "territory" ] } }, @@ -96473,19 +95248,15 @@ "explode": false }, { - "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" + "currency" ] } }, @@ -96511,24 +95282,13 @@ "items": { "type": "string", "enum": [ - "appStoreVersionExperiment", - "appStoreVersionExperimentV2", - "appStoreVersionExperimentTreatmentLocalizations" + "appPricePoint", + "territory" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[appStoreVersionExperimentTreatmentLocalizations]", - "in": "query", - "description": "maximum number of related appStoreVersionExperimentTreatmentLocalizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -96573,11 +95333,11 @@ } }, "200": { - "description": "List of AppStoreVersionExperimentTreatments", + "description": "List of AppPrices", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentsResponse" + "$ref": "#/components/schemas/AppPricesV2Response" } } } @@ -96607,25 +95367,13 @@ } ] }, - "/v1/appStoreVersionExperiments/{id}/relationships/appStoreVersionExperimentTreatments": { + "/v1/appPriceSchedules/{id}/relationships/baseTerritory": { "get": { "tags": [ - "AppStoreVersionExperiments" - ], - "operationId": "appStoreVersionExperiments_appStoreVersionExperimentTreatments_getToManyRelationship", - "deprecated": true, - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppPriceSchedules" ], + "operationId": "appPriceSchedules_baseTerritory_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -96668,11 +95416,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentAppStoreVersionExperimentTreatmentsLinkagesResponse" + "$ref": "#/components/schemas/AppPriceScheduleBaseTerritoryLinkageResponse" } } } @@ -96702,120 +95450,28 @@ } ] }, - "/v1/appStoreVersionExperiments/{id}/appStoreVersionExperimentTreatments": { + "/v1/appPriceSchedules/{id}/baseTerritory": { "get": { "tags": [ - "AppStoreVersionExperiments" + "AppPriceSchedules" ], - "operationId": "appStoreVersionExperiments_appStoreVersionExperimentTreatments_getToManyRelated", - "deprecated": true, + "operationId": "appPriceSchedules_baseTerritory_getToOneRelated", "parameters": [ { - "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": "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[appStoreVersionExperimentTreatmentLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, - { - "name": "include", + "name": "fields[territories]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "appStoreVersionExperiment", - "appStoreVersionExperimentV2", - "appStoreVersionExperimentTreatmentLocalizations" + "currency" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[appStoreVersionExperimentTreatmentLocalizations]", - "in": "query", - "description": "maximum number of related appStoreVersionExperimentTreatmentLocalizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -96860,11 +95516,11 @@ } }, "200": { - "description": "List of AppStoreVersionExperimentTreatments", + "description": "Single Territory", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentsResponse" + "$ref": "#/components/schemas/TerritoryResponse" } } } @@ -96894,12 +95550,12 @@ } ] }, - "/v1/appStoreVersionLocalizations/{id}/relationships/appPreviewSets": { + "/v1/appPriceSchedules/{id}/relationships/manualPrices": { "get": { "tags": [ - "AppStoreVersionLocalizations" + "AppPriceSchedules" ], - "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelationship", + "operationId": "appPriceSchedules_manualPrices_getToManyRelationship", "parameters": [ { "name": "limit", @@ -96958,7 +95614,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionLocalizationAppPreviewSetsLinkagesResponse" + "$ref": "#/components/schemas/AppPriceScheduleManualPricesLinkagesResponse" } } } @@ -96988,48 +95644,17 @@ } ] }, - "/v1/appStoreVersionLocalizations/{id}/appPreviewSets": { + "/v1/appPriceSchedules/{id}/manualPrices": { "get": { "tags": [ - "AppStoreVersionLocalizations" + "AppPriceSchedules" ], - "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", + "operationId": "appPriceSchedules_manualPrices_getToManyRelated", "parameters": [ { - "name": "filter[previewType]", - "in": "query", - "description": "filter by attribute 'previewType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "IPHONE_67", - "IPHONE_61", - "IPHONE_65", - "IPHONE_58", - "IPHONE_55", - "IPHONE_47", - "IPHONE_40", - "IPHONE_35", - "IPAD_PRO_3GEN_129", - "IPAD_PRO_3GEN_11", - "IPAD_PRO_129", - "IPAD_105", - "IPAD_97", - "DESKTOP", - "APPLE_TV", - "APPLE_VISION_PRO" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appCustomProductPageLocalization]", + "name": "filter[startDate]", "in": "query", - "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "description": "filter by attribute 'startDate'", "schema": { "type": "array", "items": { @@ -97040,9 +95665,9 @@ "explode": false }, { - "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "name": "filter[endDate]", "in": "query", - "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "description": "filter by attribute 'endDate'", "schema": { "type": "array", "items": { @@ -97053,68 +95678,32 @@ "explode": false }, { - "name": "fields[appPreviewSets]", - "in": "query", - "description": "the fields to include for returned resources of type appPreviewSets", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "previewType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appPreviews" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionLocalizations]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "description": "filter by id(s) of related 'territory'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appCustomProductPageLocalizations]", + "name": "fields[appPrices]", "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "description": "the fields to include for returned resources of type appPrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "promotionalText", - "appCustomProductPageVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" + "manual", + "startDate", + "endDate", + "appPricePoint", + "territory" ] } }, @@ -97122,19 +95711,19 @@ "explode": false }, { - "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "name": "fields[appPricePoints]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "description": "the fields to include for returned resources of type appPricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "appStoreVersionExperimentTreatment", - "appScreenshotSets", - "appPreviewSets", - "placements" + "customerPrice", + "proceeds", + "app", + "equalizations", + "territory" ] } }, @@ -97142,26 +95731,15 @@ "explode": false }, { - "name": "fields[appPreviews]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type appPreviews", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "previewFrameTimeCode", - "mimeType", - "videoUrl", - "previewFrameImage", - "previewImage", - "uploadOperations", - "assetDeliveryState", - "videoDeliveryState", - "appPreviewSet" + "currency" ] } }, @@ -97187,25 +95765,13 @@ "items": { "type": "string", "enum": [ - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appPreviews" + "appPricePoint", + "territory" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[appPreviews]", - "in": "query", - "description": "maximum number of related appPreviews returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -97250,11 +95816,11 @@ } }, "200": { - "description": "List of AppPreviewSets", + "description": "List of AppPrices", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPreviewSetsResponse" + "$ref": "#/components/schemas/AppPricesV2Response" } } } @@ -97284,12 +95850,12 @@ } ] }, - "/v1/appStoreVersionLocalizations/{id}/relationships/appScreenshotSets": { + "/v1/appScreenshotSets/{id}/relationships/appScreenshots": { "get": { "tags": [ - "AppStoreVersionLocalizations" + "AppScreenshotSets" ], - "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelationship", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelationship", "parameters": [ { "name": "limit", @@ -97348,11 +95914,103 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionLocalizationAppScreenshotSetsLinkagesResponse" + "$ref": "#/components/schemas/AppScreenshotSetAppScreenshotsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "patch": { + "tags": [ + "AppScreenshotSets" + ], + "operationId": "appScreenshotSets_appScreenshots_replaceToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppScreenshotSetAppScreenshotsLinkagesRequest" + } + } + }, + "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": { @@ -97378,51 +96036,939 @@ } ] }, - "/v1/appStoreVersionLocalizations/{id}/appScreenshotSets": { + "/v1/appScreenshotSets/{id}/appScreenshots": { "get": { "tags": [ - "AppStoreVersionLocalizations" + "AppScreenshotSets" ], - "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", + "operationId": "appScreenshotSets_appScreenshots_getToManyRelated", "parameters": [ { - "name": "filter[screenshotDisplayType]", + "name": "fields[appScreenshots]", "in": "query", - "description": "filter by attribute 'screenshotDisplayType'", + "description": "the fields to include for returned resources of type appScreenshots", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "APP_IPHONE_67", - "APP_IPHONE_61", - "APP_IPHONE_65", - "APP_IPHONE_58", - "APP_IPHONE_55", - "APP_IPHONE_47", - "APP_IPHONE_40", - "APP_IPHONE_35", - "APP_IPAD_PRO_3GEN_129", - "APP_IPAD_PRO_3GEN_11", - "APP_IPAD_PRO_129", - "APP_IPAD_105", - "APP_IPAD_97", - "APP_DESKTOP", - "APP_WATCH_ULTRA", - "APP_WATCH_SERIES_10", - "APP_WATCH_SERIES_7", - "APP_WATCH_SERIES_4", - "APP_WATCH_SERIES_3", - "APP_APPLE_TV", - "APP_APPLE_VISION_PRO", - "IMESSAGE_APP_IPHONE_67", - "IMESSAGE_APP_IPHONE_61", - "IMESSAGE_APP_IPHONE_65", - "IMESSAGE_APP_IPHONE_58", - "IMESSAGE_APP_IPHONE_55", - "IMESSAGE_APP_IPHONE_47", - "IMESSAGE_APP_IPHONE_40", - "IMESSAGE_APP_IPAD_PRO_3GEN_129", + "fileSize", + "fileName", + "sourceFileChecksum", + "imageAsset", + "assetToken", + "assetType", + "uploadOperations", + "assetDeliveryState", + "appScreenshotSet" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appScreenshotSets]", + "in": "query", + "description": "the fields to include for returned resources of type appScreenshotSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "screenshotDisplayType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appScreenshots" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appScreenshotSet" + ] + } + }, + "style": "form", + "explode": false + } + ], + "responses": { + "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 AppScreenshots", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppScreenshotsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appStoreReviewDetails/{id}/relationships/appStoreReviewAttachments": { + "get": { + "tags": [ + "AppStoreReviewDetails" + ], + "operationId": "appStoreReviewDetails_appStoreReviewAttachments_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/AppStoreReviewDetailAppStoreReviewAttachmentsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appStoreReviewDetails/{id}/appStoreReviewAttachments": { + "get": { + "tags": [ + "AppStoreReviewDetails" + ], + "operationId": "appStoreReviewDetails_appStoreReviewAttachments_getToManyRelated", + "parameters": [ + { + "name": "fields[appStoreReviewAttachments]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreReviewAttachments", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "uploadOperations", + "assetDeliveryState", + "appStoreReviewDetail" + ] + } + }, + "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": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appStoreReviewDetail" + ] + } + }, + "style": "form", + "explode": false + } + ], + "responses": { + "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 AppStoreReviewAttachments", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppStoreReviewAttachmentsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/relationships/appPreviewSets": { + "get": { + "tags": [ + "AppStoreVersionExperimentTreatmentLocalizations" + ], + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_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/AppStoreVersionExperimentTreatmentLocalizationAppPreviewSetsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/appPreviewSets": { + "get": { + "tags": [ + "AppStoreVersionExperimentTreatmentLocalizations" + ], + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appPreviewSets_getToManyRelated", + "parameters": [ + { + "name": "filter[previewType]", + "in": "query", + "description": "filter by attribute 'previewType'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "IPHONE_67", + "IPHONE_61", + "IPHONE_65", + "IPHONE_58", + "IPHONE_55", + "IPHONE_47", + "IPHONE_40", + "IPHONE_35", + "IPAD_PRO_3GEN_129", + "IPAD_PRO_3GEN_11", + "IPAD_PRO_129", + "IPAD_105", + "IPAD_97", + "DESKTOP", + "APPLE_TV", + "APPLE_VISION_PRO" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appCustomProductPageLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appPreviewSets]", + "in": "query", + "description": "the fields to include for returned resources of type appPreviewSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "previewType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appPreviews" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appPreviews]", + "in": "query", + "description": "the fields to include for returned resources of type appPreviews", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "previewFrameTimeCode", + "mimeType", + "videoUrl", + "previewFrameImage", + "previewImage", + "uploadOperations", + "assetDeliveryState", + "videoDeliveryState", + "appPreviewSet" + ] + } + }, + "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": [ + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appPreviews" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[appPreviews]", + "in": "query", + "description": "maximum number of related appPreviews 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 AppPreviewSets", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPreviewSetsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/relationships/appScreenshotSets": { + "get": { + "tags": [ + "AppStoreVersionExperimentTreatmentLocalizations" + ], + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_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/AppStoreVersionExperimentTreatmentLocalizationAppScreenshotSetsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/appScreenshotSets": { + "get": { + "tags": [ + "AppStoreVersionExperimentTreatmentLocalizations" + ], + "operationId": "appStoreVersionExperimentTreatmentLocalizations_appScreenshotSets_getToManyRelated", + "parameters": [ + { + "name": "filter[screenshotDisplayType]", + "in": "query", + "description": "filter by attribute 'screenshotDisplayType'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "APP_IPHONE_67", + "APP_IPHONE_61", + "APP_IPHONE_65", + "APP_IPHONE_58", + "APP_IPHONE_55", + "APP_IPHONE_47", + "APP_IPHONE_40", + "APP_IPHONE_35", + "APP_IPAD_PRO_3GEN_129", + "APP_IPAD_PRO_3GEN_11", + "APP_IPAD_PRO_129", + "APP_IPAD_105", + "APP_IPAD_97", + "APP_DESKTOP", + "APP_WATCH_ULTRA", + "APP_WATCH_SERIES_10", + "APP_WATCH_SERIES_7", + "APP_WATCH_SERIES_4", + "APP_WATCH_SERIES_3", + "APP_APPLE_TV", + "APP_APPLE_VISION_PRO", + "IMESSAGE_APP_IPHONE_67", + "IMESSAGE_APP_IPHONE_61", + "IMESSAGE_APP_IPHONE_65", + "IMESSAGE_APP_IPHONE_58", + "IMESSAGE_APP_IPHONE_55", + "IMESSAGE_APP_IPHONE_47", + "IMESSAGE_APP_IPHONE_40", + "IMESSAGE_APP_IPAD_PRO_3GEN_129", "IMESSAGE_APP_IPAD_PRO_3GEN_11", "IMESSAGE_APP_IPAD_PRO_129", "IMESSAGE_APP_IPAD_105", @@ -97434,9 +96980,9 @@ "explode": false }, { - "name": "filter[appCustomProductPageLocalization]", + "name": "filter[appStoreVersionLocalization]", "in": "query", - "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", "schema": { "type": "array", "items": { @@ -97447,9 +96993,9 @@ "explode": false }, { - "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "name": "filter[appCustomProductPageLocalization]", "in": "query", - "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", "schema": { "type": "array", "items": { @@ -97688,12 +97234,12 @@ } ] }, - "/v1/appStoreVersionLocalizations/{id}/relationships/placements": { + "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/relationships/placements": { "get": { "tags": [ - "AppStoreVersionLocalizations" + "AppStoreVersionExperimentTreatmentLocalizations" ], - "operationId": "appStoreVersionLocalizations_placements_getToManyRelationship", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelationship", "parameters": [ { "name": "limit", @@ -97752,7 +97298,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionLocalizationPlacementsLinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalizationPlacementsLinkagesResponse" } } } @@ -97782,12 +97328,12 @@ } ] }, - "/v1/appStoreVersionLocalizations/{id}/placements": { + "/v1/appStoreVersionExperimentTreatmentLocalizations/{id}/placements": { "get": { "tags": [ - "AppStoreVersionLocalizations" + "AppStoreVersionExperimentTreatmentLocalizations" ], - "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", + "operationId": "appStoreVersionExperimentTreatmentLocalizations_placements_getToManyRelated", "parameters": [ { "name": "filter[placementType]", @@ -97889,9 +97435,9 @@ "explode": false }, { - "name": "filter[appCustomProductPageLocalization]", + "name": "filter[appStoreVersionLocalization]", "in": "query", - "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "description": "filter by id(s) of related 'appStoreVersionLocalization'", "schema": { "type": "array", "items": { @@ -97902,9 +97448,9 @@ "explode": false }, { - "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "name": "filter[appCustomProductPageLocalization]", "in": "query", - "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", "schema": { "type": "array", "items": { @@ -97969,7 +97515,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -98124,6 +97671,25 @@ "style": "form", "explode": false }, + { + "name": "fields[retentionMessageVersions]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessageVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "state", + "retentionMessage", + "localizations", + "placement" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "limit", "in": "query", @@ -98148,7 +97714,8 @@ "appEventLocalization", "appStoreVersionLocalization", "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -98232,12 +97799,12 @@ } ] }, - "/v1/appStoreVersionLocalizations/{id}/relationships/searchKeywords": { + "/v1/appStoreVersionExperimentTreatments/{id}/relationships/appStoreVersionExperimentTreatmentLocalizations": { "get": { "tags": [ - "AppStoreVersionLocalizations" + "AppStoreVersionExperimentTreatments" ], - "operationId": "appStoreVersionLocalizations_searchKeywords_getToManyRelationship", + "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -98296,7 +97863,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionLocalizationSearchKeywordsLinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentAppStoreVersionExperimentTreatmentLocalizationsLinkagesResponse" } } } @@ -98313,35 +97880,213 @@ } } }, - "post": { - "tags": [ - "AppStoreVersionLocalizations" - ], - "operationId": "appStoreVersionLocalizations_searchKeywords_createToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppStoreVersionLocalizationSearchKeywordsLinkagesRequest" - } - } + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", "required": true - }, - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + } + ] + }, + "/v1/appStoreVersionExperimentTreatments/{id}/appStoreVersionExperimentTreatmentLocalizations": { + "get": { + "tags": [ + "AppStoreVersionExperimentTreatments" + ], + "operationId": "appStoreVersionExperimentTreatments_appStoreVersionExperimentTreatmentLocalizations_getToManyRelated", + "parameters": [ + { + "name": "filter[locale]", + "in": "query", + "description": "filter by attribute 'locale'", + "schema": { + "type": "array", + "items": { + "type": "string" } - } + }, + "style": "form", + "explode": false }, - "401": { - "description": "Unauthorized error(s)", + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "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": "fields[appScreenshotSets]", + "in": "query", + "description": "the fields to include for returned resources of type appScreenshotSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "screenshotDisplayType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appScreenshots" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appPreviewSets]", + "in": "query", + "description": "the fields to include for returned resources of type appPreviewSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "previewType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appPreviews" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ] + } + }, + "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": [ + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[appScreenshotSets]", + "in": "query", + "description": "maximum number of related appScreenshotSets returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[appPreviewSets]", + "in": "query", + "description": "maximum number of related appPreviewSets returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", "content": { "application/json": { "schema": { @@ -98350,8 +98095,8 @@ } } }, - "403": { - "description": "Forbidden error", + "401": { + "description": "Unauthorized error(s)", "content": { "application/json": { "schema": { @@ -98360,8 +98105,8 @@ } } }, - "404": { - "description": "Not found error", + "403": { + "description": "Forbidden error", "content": { "application/json": { "schema": { @@ -98370,8 +98115,8 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", + "404": { + "description": "Not found error", "content": { "application/json": { "schema": { @@ -98380,19 +98125,16 @@ } } }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of AppStoreVersionExperimentTreatmentLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalizationsResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -98405,22 +98147,37 @@ } } }, - "delete": { - "tags": [ - "AppStoreVersionLocalizations" - ], - "operationId": "appStoreVersionLocalizations_searchKeywords_deleteToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppStoreVersionLocalizationSearchKeywordsLinkagesRequest" - } - } + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", "required": true - }, + } + ] + }, + "/v2/appStoreVersionExperiments/{id}/relationships/appStoreVersionExperimentTreatments": { + "get": { + "tags": [ + "AppStoreVersionExperiments" + ], + "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -98462,29 +98219,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/AppStoreVersionExperimentV2AppStoreVersionExperimentTreatmentsLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -98510,48 +98254,77 @@ } ] }, - "/v1/appStoreVersionLocalizations/{id}/searchKeywords": { + "/v2/appStoreVersionExperiments/{id}/appStoreVersionExperimentTreatments": { "get": { "tags": [ - "AppStoreVersionLocalizations" + "AppStoreVersionExperiments" ], - "operationId": "appStoreVersionLocalizations_searchKeywords_getToManyRelated", + "operationId": "appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated", "parameters": [ { - "name": "filter[platform]", + "name": "fields[appStoreVersionExperimentTreatments]", "in": "query", - "description": "filter by platform", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatments", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "name", + "appIcon", + "appIconName", + "promotedDate", + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appStoreVersionExperimentTreatmentLocalizations" + ] } }, "style": "form", "explode": false }, { - "name": "filter[locale]", + "name": "fields[appStoreVersionExperiments]", "in": "query", - "description": "filter by locale", + "description": "the fields to include for returned resources of type appStoreVersionExperiments", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "name", + "trafficProportion", + "state", + "reviewRequired", + "startDate", + "endDate", + "appStoreVersion", + "appStoreVersionExperimentTreatments", + "platform", + "app", + "latestControlVersion", + "controlVersions" + ] } }, "style": "form", "explode": false }, { - "name": "fields[appKeywords]", + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appKeywords", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", "schema": { "type": "array", "items": { "type": "string", - "enum": [] + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] } }, "style": "form", @@ -98566,6 +98339,34 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appStoreVersionExperimentTreatmentLocalizations" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "maximum number of related appStoreVersionExperimentTreatmentLocalizations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -98610,11 +98411,11 @@ } }, "200": { - "description": "List of AppKeywords", + "description": "List of AppStoreVersionExperimentTreatments", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppKeywordsResponse" + "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentsResponse" } } } @@ -98644,13 +98445,25 @@ } ] }, - "/v1/appStoreVersions/{id}/relationships/alternativeDistributionPackage": { + "/v1/appStoreVersionExperiments/{id}/relationships/appStoreVersionExperimentTreatments": { "get": { "tags": [ - "AppStoreVersions" + "AppStoreVersionExperiments" + ], + "operationId": "appStoreVersionExperiments_appStoreVersionExperimentTreatments_getToManyRelationship", + "deprecated": true, + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "appStoreVersions_alternativeDistributionPackage_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -98693,11 +98506,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionAlternativeDistributionPackageLinkageResponse" + "$ref": "#/components/schemas/AppStoreVersionExperimentAppStoreVersionExperimentTreatmentsLinkagesResponse" } } } @@ -98727,24 +98540,30 @@ } ] }, - "/v1/appStoreVersions/{id}/alternativeDistributionPackage": { + "/v1/appStoreVersionExperiments/{id}/appStoreVersionExperimentTreatments": { "get": { "tags": [ - "AppStoreVersions" + "AppStoreVersionExperiments" ], - "operationId": "appStoreVersions_alternativeDistributionPackage_getToOneRelated", + "operationId": "appStoreVersionExperiments_appStoreVersionExperimentTreatments_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[alternativeDistributionPackages]", + "name": "fields[appStoreVersionExperimentTreatments]", "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionPackages", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatments", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "sourceFileChecksum", - "versions" + "name", + "appIcon", + "appIconName", + "promotedDate", + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appStoreVersionExperimentTreatmentLocalizations" ] } }, @@ -98752,28 +98571,62 @@ "explode": false }, { - "name": "fields[alternativeDistributionPackageVersions]", + "name": "fields[appStoreVersionExperiments]", "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionPackageVersions", + "description": "the fields to include for returned resources of type appStoreVersionExperiments", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "url", - "urlExpirationDate", - "version", - "fileChecksum", + "name", + "trafficProportion", "state", - "variants", - "deltas", - "alternativeDistributionPackage" + "reviewRequired", + "startDate", + "endDate", + "appStoreVersion", + "appStoreVersionExperimentTreatments", + "platform", + "app", + "latestControlVersion", + "controlVersions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" ] } }, "style": "form", "explode": false }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, { "name": "include", "in": "query", @@ -98783,7 +98636,9 @@ "items": { "type": "string", "enum": [ - "versions" + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appStoreVersionExperimentTreatmentLocalizations" ] } }, @@ -98791,9 +98646,9 @@ "explode": false }, { - "name": "limit[versions]", + "name": "limit[appStoreVersionExperimentTreatmentLocalizations]", "in": "query", - "description": "maximum number of related versions returned (when they are included)", + "description": "maximum number of related appStoreVersionExperimentTreatmentLocalizations returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -98843,11 +98698,11 @@ } }, "200": { - "description": "Single AlternativeDistributionPackage", + "description": "List of AppStoreVersionExperimentTreatments", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AlternativeDistributionPackageResponse" + "$ref": "#/components/schemas/AppStoreVersionExperimentTreatmentsResponse" } } } @@ -98877,92 +98732,24 @@ } ] }, - "/v1/appStoreVersions/{id}/relationships/appClipDefaultExperience": { + "/v1/appStoreVersionLocalizations/{id}/relationships/appPreviewSets": { "get": { "tags": [ - "AppStoreVersions" + "AppStoreVersionLocalizations" ], - "operationId": "appStoreVersions_appClipDefaultExperience_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/AppStoreVersionAppClipDefaultExperienceLinkageResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" } - } - }, - "patch": { - "tags": [ - "AppStoreVersions" ], - "operationId": "appStoreVersions_appClipDefaultExperience_updateToOneRelationship", - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppStoreVersionAppClipDefaultExperienceLinkageRequest" - } - } - }, - "required": true - }, "responses": { "400": { "description": "Parameter error(s)", @@ -99004,29 +98791,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/AppStoreVersionLocalizationAppPreviewSetsLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -99052,27 +98826,38 @@ } ] }, - "/v1/appStoreVersions/{id}/appClipDefaultExperience": { + "/v1/appStoreVersionLocalizations/{id}/appPreviewSets": { "get": { "tags": [ - "AppStoreVersions" + "AppStoreVersionLocalizations" ], - "operationId": "appStoreVersions_appClipDefaultExperience_getToOneRelated", + "operationId": "appStoreVersionLocalizations_appPreviewSets_getToManyRelated", "parameters": [ { - "name": "fields[appClipDefaultExperiences]", + "name": "filter[previewType]", "in": "query", - "description": "the fields to include for returned resources of type appClipDefaultExperiences", + "description": "filter by attribute 'previewType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "action", - "appClip", - "releaseWithAppStoreVersion", - "appClipDefaultExperienceLocalizations", - "appClipAppStoreReviewDetail" + "IPHONE_67", + "IPHONE_61", + "IPHONE_65", + "IPHONE_58", + "IPHONE_55", + "IPHONE_47", + "IPHONE_40", + "IPHONE_35", + "IPAD_PRO_3GEN_129", + "IPAD_PRO_3GEN_11", + "IPAD_PRO_129", + "IPAD_105", + "IPAD_97", + "DESKTOP", + "APPLE_TV", + "APPLE_VISION_PRO" ] } }, @@ -99080,18 +98865,45 @@ "explode": false }, { - "name": "fields[appClips]", + "name": "filter[appCustomProductPageLocalization]", "in": "query", - "description": "the fields to include for returned resources of type appClips", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appPreviewSets]", + "in": "query", + "description": "the fields to include for returned resources of type appPreviewSets", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "bundleId", - "app", - "appClipDefaultExperiences", - "appClipAdvancedExperiences" + "previewType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appPreviews" ] } }, @@ -99099,38 +98911,26 @@ "explode": false }, { - "name": "fields[appStoreVersions]", + "name": "fields[appStoreVersionLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", "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" + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, @@ -99138,18 +98938,21 @@ "explode": false }, { - "name": "fields[appClipDefaultExperienceLocalizations]", + "name": "fields[appCustomProductPageLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appClipDefaultExperienceLocalizations", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ "locale", - "subtitle", - "appClipDefaultExperience", - "appClipHeaderImage" + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, @@ -99157,22 +98960,62 @@ "explode": false }, { - "name": "fields[appClipAppStoreReviewDetails]", + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appClipAppStoreReviewDetails", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "invocationUrls", - "appClipDefaultExperience" + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appPreviews]", + "in": "query", + "description": "the fields to include for returned resources of type appPreviews", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "previewFrameTimeCode", + "mimeType", + "videoUrl", + "previewFrameImage", + "previewImage", + "uploadOperations", + "assetDeliveryState", + "videoDeliveryState", + "appPreviewSet" ] } }, "style": "form", "explode": false }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, { "name": "include", "in": "query", @@ -99182,10 +99025,10 @@ "items": { "type": "string", "enum": [ - "appClip", - "releaseWithAppStoreVersion", - "appClipDefaultExperienceLocalizations", - "appClipAppStoreReviewDetail" + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appPreviews" ] } }, @@ -99193,9 +99036,9 @@ "explode": false }, { - "name": "limit[appClipDefaultExperienceLocalizations]", + "name": "limit[appPreviews]", "in": "query", - "description": "maximum number of related appClipDefaultExperienceLocalizations returned (when they are included)", + "description": "maximum number of related appPreviews returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -99245,11 +99088,11 @@ } }, "200": { - "description": "Single AppClipDefaultExperience", + "description": "List of AppPreviewSets", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppClipDefaultExperienceResponse" + "$ref": "#/components/schemas/AppPreviewSetsResponse" } } } @@ -99279,13 +99122,24 @@ } ] }, - "/v1/appStoreVersions/{id}/relationships/appStoreReviewDetail": { + "/v1/appStoreVersionLocalizations/{id}/relationships/appScreenshotSets": { "get": { "tags": [ - "AppStoreVersions" + "AppStoreVersionLocalizations" + ], + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "appStoreVersions_appStoreReviewDetail_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -99328,11 +99182,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionAppStoreReviewDetailLinkageResponse" + "$ref": "#/components/schemas/AppStoreVersionLocalizationAppScreenshotSetsLinkagesResponse" } } } @@ -99362,32 +99216,128 @@ } ] }, - "/v1/appStoreVersions/{id}/appStoreReviewDetail": { + "/v1/appStoreVersionLocalizations/{id}/appScreenshotSets": { "get": { "tags": [ - "AppStoreVersions" + "AppStoreVersionLocalizations" ], - "operationId": "appStoreVersions_appStoreReviewDetail_getToOneRelated", + "operationId": "appStoreVersionLocalizations_appScreenshotSets_getToManyRelated", "parameters": [ { - "name": "fields[appStoreReviewDetails]", + "name": "filter[screenshotDisplayType]", "in": "query", - "description": "the fields to include for returned resources of type appStoreReviewDetails", + "description": "filter by attribute 'screenshotDisplayType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "contactFirstName", - "contactLastName", - "contactPhone", - "contactEmail", - "demoAccountName", - "demoAccountPassword", - "demoAccountRequired", - "notes", + "APP_IPHONE_67", + "APP_IPHONE_61", + "APP_IPHONE_65", + "APP_IPHONE_58", + "APP_IPHONE_55", + "APP_IPHONE_47", + "APP_IPHONE_40", + "APP_IPHONE_35", + "APP_IPAD_PRO_3GEN_129", + "APP_IPAD_PRO_3GEN_11", + "APP_IPAD_PRO_129", + "APP_IPAD_105", + "APP_IPAD_97", + "APP_DESKTOP", + "APP_WATCH_ULTRA", + "APP_WATCH_SERIES_10", + "APP_WATCH_SERIES_7", + "APP_WATCH_SERIES_4", + "APP_WATCH_SERIES_3", + "APP_APPLE_TV", + "APP_APPLE_VISION_PRO", + "IMESSAGE_APP_IPHONE_67", + "IMESSAGE_APP_IPHONE_61", + "IMESSAGE_APP_IPHONE_65", + "IMESSAGE_APP_IPHONE_58", + "IMESSAGE_APP_IPHONE_55", + "IMESSAGE_APP_IPHONE_47", + "IMESSAGE_APP_IPHONE_40", + "IMESSAGE_APP_IPAD_PRO_3GEN_129", + "IMESSAGE_APP_IPAD_PRO_3GEN_11", + "IMESSAGE_APP_IPAD_PRO_129", + "IMESSAGE_APP_IPAD_105", + "IMESSAGE_APP_IPAD_97" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appCustomProductPageLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appScreenshotSets]", + "in": "query", + "description": "the fields to include for returned resources of type appScreenshotSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "screenshotDisplayType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appScreenshots" + ] + } + }, + "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", - "appStoreReviewAttachments" + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, @@ -99395,38 +99345,21 @@ "explode": false }, { - "name": "fields[appStoreVersions]", + "name": "fields[appCustomProductPageLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", "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" + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, @@ -99434,9 +99367,29 @@ "explode": false }, { - "name": "fields[appStoreReviewAttachments]", + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appStoreReviewAttachments", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appScreenshots]", + "in": "query", + "description": "the fields to include for returned resources of type appScreenshots", "schema": { "type": "array", "items": { @@ -99445,15 +99398,28 @@ "fileSize", "fileName", "sourceFileChecksum", + "imageAsset", + "assetToken", + "assetType", "uploadOperations", "assetDeliveryState", - "appStoreReviewDetail" + "appScreenshotSet" ] } }, "style": "form", "explode": false }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, { "name": "include", "in": "query", @@ -99463,8 +99429,10 @@ "items": { "type": "string", "enum": [ - "appStoreVersion", - "appStoreReviewAttachments" + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appScreenshots" ] } }, @@ -99472,9 +99440,9 @@ "explode": false }, { - "name": "limit[appStoreReviewAttachments]", + "name": "limit[appScreenshots]", "in": "query", - "description": "maximum number of related appStoreReviewAttachments returned (when they are included)", + "description": "maximum number of related appScreenshots returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -99524,11 +99492,11 @@ } }, "200": { - "description": "Single AppStoreReviewDetail", + "description": "List of AppScreenshotSets", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreReviewDetailResponse" + "$ref": "#/components/schemas/AppScreenshotSetsResponse" } } } @@ -99558,13 +99526,12 @@ } ] }, - "/v1/appStoreVersions/{id}/relationships/appStoreVersionExperiments": { + "/v1/appStoreVersionLocalizations/{id}/relationships/placements": { "get": { "tags": [ - "AppStoreVersions" + "AppStoreVersionLocalizations" ], - "operationId": "appStoreVersions_appStoreVersionExperiments_getToManyRelationship", - "deprecated": true, + "operationId": "appStoreVersionLocalizations_placements_getToManyRelationship", "parameters": [ { "name": "limit", @@ -99623,7 +99590,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionAppStoreVersionExperimentsLinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionLocalizationPlacementsLinkagesResponse" } } } @@ -99653,55 +99620,195 @@ } ] }, - "/v1/appStoreVersions/{id}/appStoreVersionExperiments": { + "/v1/appStoreVersionLocalizations/{id}/placements": { "get": { "tags": [ - "AppStoreVersions" + "AppStoreVersionLocalizations" ], - "operationId": "appStoreVersions_appStoreVersionExperiments_getToManyRelated", - "deprecated": true, + "operationId": "appStoreVersionLocalizations_placements_getToManyRelated", "parameters": [ { - "name": "filter[state]", + "name": "filter[placementType]", "in": "query", - "description": "filter by attribute 'state'", + "description": "filter by attribute 'placementType'", "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", + "APP_SCREENSHOT", + "IMESSAGE_APP_SCREENSHOT", + "APP_PREVIEW", + "PRODUCT_PAGE_HEADER_ASSET", + "APP_STORE_SEARCH_RESULTS_ASSET", + "SEARCH_RESULTS_ADS_ASSET", + "TODAY_TAB_ADS_ASSET", + "EVENT_CARD_ASSET", + "EVENT_DETAILS_PAGE_ASSET", + "RETENTION_MESSAGE_ASSET" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[placementGroup]", + "in": "query", + "description": "filter by attribute 'placementGroup'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[state]", + "in": "query", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "trafficProportion", + "ASSET_PROCESSING", + "FAILED", + "PARENT_PREPARE_FOR_SUBMISSION", + "PARENT_READY_FOR_REVIEW", + "PARENT_WAITING_FOR_REVIEW", + "PARENT_IN_REVIEW", + "PARENT_APPROVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[image]", + "in": "query", + "description": "filter by id(s) of related 'image'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[video]", + "in": "query", + "description": "filter by id(s) of related 'video'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appEventLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appEventLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appCustomProductPageLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appCustomProductPageLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersionExperimentTreatmentLocalization]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersionExperimentTreatmentLocalization'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "sort", + "in": "query", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "-createdDate", + "lastModifiedDate", + "-lastModifiedDate", + "placementGroupPosition", + "-placementGroupPosition" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", "state", - "reviewRequired", - "startDate", - "endDate", - "appStoreVersion", - "appStoreVersionExperimentTreatments" + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -99709,38 +99816,26 @@ "explode": false }, { - "name": "fields[appStoreVersions]", + "name": "fields[appAssetLibraryImages]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "the fields to include for returned resources of type appAssetLibraryImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platform", - "versionString", - "appStoreState", - "appVersionState", - "copyright", - "reviewType", - "releaseType", - "earliestReleaseDate", - "usesIdfa", - "downloadable", + "category", "createdDate", - "app", - "appStoreVersionLocalizations", - "build", - "appStoreVersionPhasedRelease", - "gameCenterAppVersion", - "routingAppCoverage", - "appStoreReviewDetail", - "appStoreVersionSubmission", - "appClipDefaultExperience", - "appStoreVersionExperiments", - "appStoreVersionExperimentsV2", - "customerReviews", - "alternativeDistributionPackage" + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" ] } }, @@ -99748,21 +99843,28 @@ "explode": false }, { - "name": "fields[appStoreVersionExperimentTreatments]", + "name": "fields[appAssetLibraryVideos]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatments", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "appIcon", - "appIconName", - "promotedDate", - "appStoreVersionExperiment", - "appStoreVersionExperimentV2", - "appStoreVersionExperimentTreatmentLocalizations" + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" ] } }, @@ -99770,26 +99872,49 @@ "explode": false }, { - "name": "limit", + "name": "fields[appEventLocalizations]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type appEventLocalizations", "schema": { - "type": "integer", - "maximum": 200 + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } }, - "style": "form" + "style": "form", + "explode": false }, { - "name": "include", + "name": "fields[appStoreVersionLocalizations]", "in": "query", - "description": "comma-separated list of relationships to include", + "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", - "appStoreVersionExperimentTreatments" + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, @@ -99797,14 +99922,97 @@ "explode": false }, { - "name": "limit[appStoreVersionExperimentTreatments]", + "name": "fields[appCustomProductPageLocalizations]", "in": "query", - "description": "maximum number of related appStoreVersionExperimentTreatments returned (when they are included)", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[retentionMessageVersions]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessageVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "state", + "retentionMessage", + "localizations", + "placement" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 50 + "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -99849,11 +100057,11 @@ } }, "200": { - "description": "List of AppStoreVersionExperiments", + "description": "List of AppAssetLibraryPlacements", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentsResponse" + "$ref": "#/components/schemas/AppAssetLibraryPlacementsResponse" } } } @@ -99883,12 +100091,12 @@ } ] }, - "/v1/appStoreVersions/{id}/relationships/appStoreVersionExperimentsV2": { + "/v1/appStoreVersionLocalizations/{id}/relationships/searchKeywords": { "get": { "tags": [ - "AppStoreVersions" + "AppStoreVersionLocalizations" ], - "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelationship", + "operationId": "appStoreVersionLocalizations_searchKeywords_getToManyRelationship", "parameters": [ { "name": "limit", @@ -99947,7 +100155,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionAppStoreVersionExperimentsV2LinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionLocalizationSearchKeywordsLinkagesResponse" } } } @@ -99964,259 +100172,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appStoreVersions/{id}/appStoreVersionExperimentsV2": { - "get": { + "post": { "tags": [ - "AppStoreVersions" + "AppStoreVersionLocalizations" ], - "operationId": "appStoreVersions_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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "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" - ] + "operationId": "appStoreVersionLocalizations_searchKeywords_createToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppStoreVersionLocalizationSearchKeywordsLinkagesRequest" } - }, - "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" - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -100258,16 +100229,29 @@ } } }, - "200": { - "description": "List of AppStoreVersionExperiments", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentsV2Response" + "$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": { @@ -100280,37 +100264,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appStoreVersions/{id}/relationships/appStoreVersionLocalizations": { - "get": { + "delete": { "tags": [ - "AppStoreVersions" - ], - "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppStoreVersionLocalizations" ], + "operationId": "appStoreVersionLocalizations_searchKeywords_deleteToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppStoreVersionLocalizationSearchKeywordsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -100352,16 +100321,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionAppStoreVersionLocalizationsLinkagesResponse" + "$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": { @@ -100387,17 +100369,17 @@ } ] }, - "/v1/appStoreVersions/{id}/appStoreVersionLocalizations": { + "/v1/appStoreVersionLocalizations/{id}/searchKeywords": { "get": { "tags": [ - "AppStoreVersions" + "AppStoreVersionLocalizations" ], - "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", + "operationId": "appStoreVersionLocalizations_searchKeywords_getToManyRelated", "parameters": [ { - "name": "filter[locale]", + "name": "filter[platform]", "in": "query", - "description": "filter by attribute 'locale'", + "description": "filter by platform", "schema": { "type": "array", "items": { @@ -100408,106 +100390,13 @@ "explode": false }, { - "name": "fields[appStoreVersionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[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[appScreenshotSets]", - "in": "query", - "description": "the fields to include for returned resources of type appScreenshotSets", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "screenshotDisplayType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appScreenshots" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appPreviewSets]", + "name": "filter[locale]", "in": "query", - "description": "the fields to include for returned resources of type appPreviewSets", + "description": "filter by locale", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "previewType", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization", - "appPreviews" - ] + "type": "string" } }, "style": "form", @@ -100527,34 +100416,6 @@ "style": "form", "explode": false }, - { - "name": "fields[appAssetLibraryPlacements]", - "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryPlacements", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "mediaType", - "placementType", - "placementGroup", - "createdDate", - "lastModifiedDate", - "state", - "stateDetails", - "image", - "video", - "appEventLocalization", - "appStoreVersionLocalization", - "appCustomProductPageLocalization", - "appStoreVersionExperimentTreatmentLocalization" - ] - } - }, - "style": "form", - "explode": false - }, { "name": "limit", "in": "query", @@ -100564,66 +100425,6 @@ "maximum": 200 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit[appScreenshotSets]", - "in": "query", - "description": "maximum number of related appScreenshotSets returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[appPreviewSets]", - "in": "query", - "description": "maximum number of related appPreviewSets returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[searchKeywords]", - "in": "query", - "description": "maximum number of related searchKeywords returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[placements]", - "in": "query", - "description": "maximum number of related placements returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -100668,11 +100469,11 @@ } }, "200": { - "description": "List of AppStoreVersionLocalizations", + "description": "List of AppKeywords", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionLocalizationsResponse" + "$ref": "#/components/schemas/AppKeywordsResponse" } } } @@ -100702,12 +100503,12 @@ } ] }, - "/v1/appStoreVersions/{id}/relationships/appStoreVersionPhasedRelease": { + "/v1/appStoreVersions/{id}/relationships/alternativeDistributionPackage": { "get": { "tags": [ "AppStoreVersions" ], - "operationId": "appStoreVersions_appStoreVersionPhasedRelease_getToOneRelationship", + "operationId": "appStoreVersions_alternativeDistributionPackage_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -100755,7 +100556,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionAppStoreVersionPhasedReleaseLinkageResponse" + "$ref": "#/components/schemas/AppStoreVersionAlternativeDistributionPackageLinkageResponse" } } } @@ -100785,31 +100586,78 @@ } ] }, - "/v1/appStoreVersions/{id}/appStoreVersionPhasedRelease": { + "/v1/appStoreVersions/{id}/alternativeDistributionPackage": { "get": { "tags": [ "AppStoreVersions" ], - "operationId": "appStoreVersions_appStoreVersionPhasedRelease_getToOneRelated", + "operationId": "appStoreVersions_alternativeDistributionPackage_getToOneRelated", "parameters": [ { - "name": "fields[appStoreVersionPhasedReleases]", + "name": "fields[alternativeDistributionPackages]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionPhasedReleases", + "description": "the fields to include for returned resources of type alternativeDistributionPackages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "phasedReleaseState", - "startDate", - "totalPauseDuration", - "currentDayNumber" + "sourceFileChecksum", + "versions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[alternativeDistributionPackageVersions]", + "in": "query", + "description": "the fields to include for returned resources of type alternativeDistributionPackageVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "url", + "urlExpirationDate", + "version", + "fileChecksum", + "state", + "variants", + "deltas", + "alternativeDistributionPackage" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "versions" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -100854,11 +100702,11 @@ } }, "200": { - "description": "Single AppStoreVersionPhasedRelease with get", + "description": "Single AlternativeDistributionPackage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionPhasedReleaseWithoutIncludesResponse" + "$ref": "#/components/schemas/AlternativeDistributionPackageResponse" } } } @@ -100888,13 +100736,12 @@ } ] }, - "/v1/appStoreVersions/{id}/relationships/appStoreVersionSubmission": { + "/v1/appStoreVersions/{id}/relationships/appClipDefaultExperience": { "get": { "tags": [ "AppStoreVersions" ], - "operationId": "appStoreVersions_appStoreVersionSubmission_getToOneRelationship", - "deprecated": true, + "operationId": "appStoreVersions_appClipDefaultExperience_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -100942,7 +100789,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionAppStoreVersionSubmissionLinkageResponse" + "$ref": "#/components/schemas/AppStoreVersionAppClipDefaultExperienceLinkageResponse" } } } @@ -100959,256 +100806,17 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appStoreVersions/{id}/appStoreVersionSubmission": { - "get": { + "patch": { "tags": [ "AppStoreVersions" ], - "operationId": "appStoreVersions_appStoreVersionSubmission_getToOneRelated", - "deprecated": true, - "parameters": [ - { - "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[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": [ - "appStoreVersion" - ] - } - }, - "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 AppStoreVersionSubmission", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppStoreVersionSubmissionResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appStoreVersions/{id}/relationships/build": { - "get": { - "tags": [ - "AppStoreVersions" - ], - "operationId": "appStoreVersions_build_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/AppStoreVersionBuildLinkageResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "patch": { - "tags": [ - "AppStoreVersions" - ], - "operationId": "appStoreVersions_build_updateToOneRelationship", + "operationId": "appStoreVersions_appClipDefaultExperience_updateToOneRelationship", "requestBody": { "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionBuildLinkageRequest" + "$ref": "#/components/schemas/AppStoreVersionAppClipDefaultExperienceLinkageRequest" } } }, @@ -101303,474 +100911,46 @@ } ] }, - "/v1/appStoreVersions/{id}/build": { + "/v1/appStoreVersions/{id}/appClipDefaultExperience": { "get": { "tags": [ "AppStoreVersions" ], - "operationId": "appStoreVersions_build_getToOneRelated", + "operationId": "appStoreVersions_appClipDefaultExperience_getToOneRelated", "parameters": [ { - "name": "fields[builds]", + "name": "fields[appClipDefaultExperiences]", "in": "query", - "description": "the fields to include for returned resources of type builds", + "description": "the fields to include for returned resources of type appClipDefaultExperiences", "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" + "action", + "appClip", + "releaseWithAppStoreVersion", + "appClipDefaultExperienceLocalizations", + "appClipAppStoreReviewDetail" ] } }, "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 Build with get", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BuildWithoutIncludesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appStoreVersions/{id}/relationships/customerReviews": { - "get": { - "tags": [ - "AppStoreVersions" - ], - "operationId": "appStoreVersions_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/AppStoreVersionCustomerReviewsLinkagesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" }, - "style": "simple", - "required": true - } - ] - }, - "/v1/appStoreVersions/{id}/customerReviews": { - "get": { - "tags": [ - "AppStoreVersions" - ], - "operationId": "appStoreVersions_customerReviews_getToManyRelated", - "parameters": [ { - "name": "filter[territory]", + "name": "fields[appClips]", "in": "query", - "description": "filter by attribute 'territory'", + "description": "the fields to include for returned resources of type appClips", "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" + "bundleId", + "app", + "appClipDefaultExperiences", + "appClipAdvancedExperiences" ] } }, @@ -101778,54 +100958,38 @@ "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", + "name": "fields[appStoreVersions]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "rating", - "-rating", + "platform", + "versionString", + "appStoreState", + "appVersionState", + "copyright", + "reviewType", + "releaseType", + "earliestReleaseDate", + "usesIdfa", + "downloadable", "createdDate", - "-createdDate" + "app", + "appStoreVersionLocalizations", + "build", + "appStoreVersionPhasedRelease", + "gameCenterAppVersion", + "routingAppCoverage", + "appStoreReviewDetail", + "appStoreVersionSubmission", + "appClipDefaultExperience", + "appStoreVersionExperiments", + "appStoreVersionExperimentsV2", + "customerReviews", + "alternativeDistributionPackage" ] } }, @@ -101833,22 +100997,18 @@ "explode": false }, { - "name": "fields[customerReviews]", + "name": "fields[appClipDefaultExperienceLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type customerReviews", + "description": "the fields to include for returned resources of type appClipDefaultExperienceLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "rating", - "title", - "body", - "reviewerNickname", - "createdDate", - "territory", - "response", - "reviewTerritory" + "locale", + "subtitle", + "appClipDefaultExperience", + "appClipHeaderImage" ] } }, @@ -101856,18 +101016,16 @@ "explode": false }, { - "name": "fields[customerReviewResponses]", + "name": "fields[appClipAppStoreReviewDetails]", "in": "query", - "description": "the fields to include for returned resources of type customerReviewResponses", + "description": "the fields to include for returned resources of type appClipAppStoreReviewDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "responseBody", - "lastModifiedDate", - "state", - "review" + "invocationUrls", + "appClipDefaultExperience" ] } }, @@ -101875,15 +101033,18 @@ "explode": false }, { - "name": "fields[territories]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "appClip", + "releaseWithAppStoreVersion", + "appClipDefaultExperienceLocalizations", + "appClipAppStoreReviewDetail" ] } }, @@ -101891,31 +101052,14 @@ "explode": false }, { - "name": "limit", + "name": "limit[appClipDefaultExperienceLocalizations]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related appClipDefaultExperienceLocalizations returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "maximum": 50 }, "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": { @@ -101960,11 +101104,11 @@ } }, "200": { - "description": "List of CustomerReviews", + "description": "Single AppClipDefaultExperience", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerReviewsResponse" + "$ref": "#/components/schemas/AppClipDefaultExperienceResponse" } } } @@ -101994,12 +101138,12 @@ } ] }, - "/v1/appStoreVersions/{id}/relationships/gameCenterAppVersion": { + "/v1/appStoreVersions/{id}/relationships/appStoreReviewDetail": { "get": { "tags": [ "AppStoreVersions" ], - "operationId": "appStoreVersions_gameCenterAppVersion_getToOneRelationship", + "operationId": "appStoreVersions_appStoreReviewDetail_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -102047,7 +101191,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionGameCenterAppVersionLinkageResponse" + "$ref": "#/components/schemas/AppStoreVersionAppStoreReviewDetailLinkageResponse" } } } @@ -102077,25 +101221,32 @@ } ] }, - "/v1/appStoreVersions/{id}/gameCenterAppVersion": { + "/v1/appStoreVersions/{id}/appStoreReviewDetail": { "get": { "tags": [ "AppStoreVersions" ], - "operationId": "appStoreVersions_gameCenterAppVersion_getToOneRelated", + "operationId": "appStoreVersions_appStoreReviewDetail_getToOneRelated", "parameters": [ { - "name": "fields[gameCenterAppVersions]", + "name": "fields[appStoreReviewDetails]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAppVersions", + "description": "the fields to include for returned resources of type appStoreReviewDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "enabled", - "compatibilityVersions", - "appStoreVersion" + "contactFirstName", + "contactLastName", + "contactPhone", + "contactEmail", + "demoAccountName", + "demoAccountPassword", + "demoAccountRequired", + "notes", + "appStoreVersion", + "appStoreReviewAttachments" ] } }, @@ -102141,6 +101292,27 @@ "style": "form", "explode": false }, + { + "name": "fields[appStoreReviewAttachments]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreReviewAttachments", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "uploadOperations", + "assetDeliveryState", + "appStoreReviewDetail" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "include", "in": "query", @@ -102150,8 +101322,8 @@ "items": { "type": "string", "enum": [ - "compatibilityVersions", - "appStoreVersion" + "appStoreVersion", + "appStoreReviewAttachments" ] } }, @@ -102159,9 +101331,9 @@ "explode": false }, { - "name": "limit[compatibilityVersions]", + "name": "limit[appStoreReviewAttachments]", "in": "query", - "description": "maximum number of related compatibilityVersions returned (when they are included)", + "description": "maximum number of related appStoreReviewAttachments returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -102211,11 +101383,11 @@ } }, "200": { - "description": "Single GameCenterAppVersion", + "description": "Single AppStoreReviewDetail", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAppVersionResponse" + "$ref": "#/components/schemas/AppStoreReviewDetailResponse" } } } @@ -102245,13 +101417,25 @@ } ] }, - "/v1/appStoreVersions/{id}/relationships/routingAppCoverage": { + "/v1/appStoreVersions/{id}/relationships/appStoreVersionExperiments": { "get": { "tags": [ "AppStoreVersions" ], - "operationId": "appStoreVersions_routingAppCoverage_getToOneRelationship", - "parameters": [], + "operationId": "appStoreVersions_appStoreVersionExperiments_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)", @@ -102294,11 +101478,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionRoutingAppCoverageLinkageResponse" + "$ref": "#/components/schemas/AppStoreVersionAppStoreVersionExperimentsLinkagesResponse" } } } @@ -102328,28 +101512,55 @@ } ] }, - "/v1/appStoreVersions/{id}/routingAppCoverage": { + "/v1/appStoreVersions/{id}/appStoreVersionExperiments": { "get": { "tags": [ "AppStoreVersions" ], - "operationId": "appStoreVersions_routingAppCoverage_getToOneRelated", + "operationId": "appStoreVersions_appStoreVersionExperiments_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[routingAppCoverages]", + "name": "filter[state]", "in": "query", - "description": "the fields to include for returned resources of type routingAppCoverages", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "uploadOperations", - "assetDeliveryState", - "appStoreVersion" + "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", + "trafficProportion", + "state", + "reviewRequired", + "startDate", + "endDate", + "appStoreVersion", + "appStoreVersionExperimentTreatments" ] } }, @@ -102395,6 +101606,38 @@ "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", @@ -102404,12 +101647,23 @@ "items": { "type": "string", "enum": [ - "appStoreVersion" + "appStoreVersion", + "appStoreVersionExperimentTreatments" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[appStoreVersionExperimentTreatments]", + "in": "query", + "description": "maximum number of related appStoreVersionExperimentTreatments returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -102454,11 +101708,11 @@ } }, "200": { - "description": "Single RoutingAppCoverage", + "description": "List of AppStoreVersionExperiments", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RoutingAppCoverageResponse" + "$ref": "#/components/schemas/AppStoreVersionExperimentsResponse" } } } @@ -102488,12 +101742,12 @@ } ] }, - "/v1/appTags/{id}/relationships/territories": { + "/v1/appStoreVersions/{id}/relationships/appStoreVersionExperimentsV2": { "get": { "tags": [ - "AppTags" + "AppStoreVersions" ], - "operationId": "appTags_territories_getToManyRelationship", + "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelationship", "parameters": [ { "name": "limit", @@ -102552,7 +101806,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppTagTerritoriesLinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionAppStoreVersionExperimentsV2LinkagesResponse" } } } @@ -102582,23 +101836,31 @@ } ] }, - "/v1/appTags/{id}/territories": { + "/v1/appStoreVersions/{id}/appStoreVersionExperimentsV2": { "get": { "tags": [ - "AppTags" + "AppStoreVersions" ], - "operationId": "appTags_territories_getToManyRelated", + "operationId": "appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated", "parameters": [ { - "name": "fields[territories]", + "name": "filter[state]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "ACCEPTED", + "APPROVED", + "REJECTED", + "COMPLETED", + "STOPPED" ] } }, @@ -102606,23 +101868,222 @@ "explode": false }, { - "name": "limit", + "name": "fields[appStoreVersionExperiments]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type appStoreVersionExperiments", "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "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" } } } @@ -102658,11 +102119,11 @@ } }, "200": { - "description": "List of Territories", + "description": "List of AppStoreVersionExperiments", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoriesResponse" + "$ref": "#/components/schemas/AppStoreVersionExperimentsV2Response" } } } @@ -102692,12 +102153,12 @@ } ] }, - "/v1/apps/{id}/relationships/accessibilityDeclarations": { + "/v1/appStoreVersions/{id}/relationships/appStoreVersionLocalizations": { "get": { "tags": [ - "Apps" + "AppStoreVersions" ], - "operationId": "apps_accessibilityDeclarations_getToManyRelationship", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -102756,7 +102217,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAccessibilityDeclarationsLinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionAppStoreVersionLocalizationsLinkagesResponse" } } } @@ -102786,28 +102247,47 @@ } ] }, - "/v1/apps/{id}/accessibilityDeclarations": { + "/v1/appStoreVersions/{id}/appStoreVersionLocalizations": { "get": { "tags": [ - "Apps" + "AppStoreVersions" ], - "operationId": "apps_accessibilityDeclarations_getToManyRelated", + "operationId": "appStoreVersions_appStoreVersionLocalizations_getToManyRelated", "parameters": [ { - "name": "filter[deviceFamily]", + "name": "filter[locale]", "in": "query", - "description": "filter by attribute 'deviceFamily'", + "description": "filter by attribute 'locale'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "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": [ - "IPHONE", - "IPAD", - "APPLE_TV", - "APPLE_WATCH", - "MAC", - "VISION" + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, @@ -102815,17 +102295,38 @@ "explode": false }, { - "name": "filter[state]", + "name": "fields[appStoreVersions]", "in": "query", - "description": "filter by attribute 'state'", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "DRAFT", - "PUBLISHED", - "REPLACED" + "platform", + "versionString", + "appStoreState", + "appVersionState", + "copyright", + "reviewType", + "releaseType", + "earliestReleaseDate", + "usesIdfa", + "downloadable", + "createdDate", + "app", + "appStoreVersionLocalizations", + "build", + "appStoreVersionPhasedRelease", + "gameCenterAppVersion", + "routingAppCoverage", + "appStoreReviewDetail", + "appStoreVersionSubmission", + "appClipDefaultExperience", + "appStoreVersionExperiments", + "appStoreVersionExperimentsV2", + "customerReviews", + "alternativeDistributionPackage" ] } }, @@ -102833,25 +102334,82 @@ "explode": false }, { - "name": "fields[accessibilityDeclarations]", + "name": "fields[appScreenshotSets]", "in": "query", - "description": "the fields to include for returned resources of type accessibilityDeclarations", + "description": "the fields to include for returned resources of type appScreenshotSets", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "deviceFamily", + "screenshotDisplayType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appScreenshots" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appPreviewSets]", + "in": "query", + "description": "the fields to include for returned resources of type appPreviewSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "previewType", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "appPreviews" + ] + } + }, + "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": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", "state", - "supportsAudioDescriptions", - "supportsCaptions", - "supportsDarkInterface", - "supportsDifferentiateWithoutColorAlone", - "supportsLargerText", - "supportsReducedMotion", - "supportsSufficientContrast", - "supportsVoiceControl", - "supportsVoiceover" + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -102867,6 +102425,66 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[appScreenshotSets]", + "in": "query", + "description": "maximum number of related appScreenshotSets returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[appPreviewSets]", + "in": "query", + "description": "maximum number of related appPreviewSets returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[searchKeywords]", + "in": "query", + "description": "maximum number of related searchKeywords returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[placements]", + "in": "query", + "description": "maximum number of related placements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -102911,11 +102529,11 @@ } }, "200": { - "description": "List of AccessibilityDeclarations", + "description": "List of AppStoreVersionLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AccessibilityDeclarationsResponse" + "$ref": "#/components/schemas/AppStoreVersionLocalizationsResponse" } } } @@ -102945,12 +102563,12 @@ } ] }, - "/v1/apps/{id}/relationships/alternativeDistributionKey": { + "/v1/appStoreVersions/{id}/relationships/appStoreVersionPhasedRelease": { "get": { "tags": [ - "Apps" + "AppStoreVersions" ], - "operationId": "apps_alternativeDistributionKey_getToOneRelationship", + "operationId": "appStoreVersions_appStoreVersionPhasedRelease_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -102998,7 +102616,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAlternativeDistributionKeyLinkageResponse" + "$ref": "#/components/schemas/AppStoreVersionAppStoreVersionPhasedReleaseLinkageResponse" } } } @@ -103028,23 +102646,26 @@ } ] }, - "/v1/apps/{id}/alternativeDistributionKey": { + "/v1/appStoreVersions/{id}/appStoreVersionPhasedRelease": { "get": { "tags": [ - "Apps" + "AppStoreVersions" ], - "operationId": "apps_alternativeDistributionKey_getToOneRelated", + "operationId": "appStoreVersions_appStoreVersionPhasedRelease_getToOneRelated", "parameters": [ { - "name": "fields[alternativeDistributionKeys]", + "name": "fields[appStoreVersionPhasedReleases]", "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionKeys", + "description": "the fields to include for returned resources of type appStoreVersionPhasedReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "publicKey" + "phasedReleaseState", + "startDate", + "totalPauseDuration", + "currentDayNumber" ] } }, @@ -103094,11 +102715,11 @@ } }, "200": { - "description": "Single AlternativeDistributionKey", + "description": "Single AppStoreVersionPhasedRelease with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AlternativeDistributionKeyResponse" + "$ref": "#/components/schemas/AppStoreVersionPhasedReleaseWithoutIncludesResponse" } } } @@ -103128,24 +102749,14 @@ } ] }, - "/v1/apps/{id}/relationships/analyticsReportRequests": { + "/v1/appStoreVersions/{id}/relationships/appStoreVersionSubmission": { "get": { "tags": [ - "Apps" - ], - "operationId": "apps_analyticsReportRequests_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppStoreVersions" ], + "operationId": "appStoreVersions_appStoreVersionSubmission_getToOneRelationship", + "deprecated": true, + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -103188,11 +102799,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAnalyticsReportRequestsLinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionAppStoreVersionSubmissionLinkageResponse" } } } @@ -103222,42 +102833,24 @@ } ] }, - "/v1/apps/{id}/analyticsReportRequests": { + "/v1/appStoreVersions/{id}/appStoreVersionSubmission": { "get": { "tags": [ - "Apps" + "AppStoreVersions" ], - "operationId": "apps_analyticsReportRequests_getToManyRelated", + "operationId": "appStoreVersions_appStoreVersionSubmission_getToOneRelated", + "deprecated": true, "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]", + "name": "fields[appStoreVersionSubmissions]", "in": "query", - "description": "the fields to include for returned resources of type analyticsReportRequests", + "description": "the fields to include for returned resources of type appStoreVersionSubmissions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "accessType", - "stoppedDueToInactivity", - "reports" + "appStoreVersion" ] } }, @@ -103265,33 +102858,44 @@ "explode": false }, { - "name": "fields[analyticsReports]", + "name": "fields[appStoreVersions]", "in": "query", - "description": "the fields to include for returned resources of type analyticsReports", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "category", - "instances" + "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": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, { "name": "include", "in": "query", @@ -103301,22 +102905,12 @@ "items": { "type": "string", "enum": [ - "reports" + "appStoreVersion" ] } }, "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": { @@ -103361,11 +102955,11 @@ } }, "200": { - "description": "List of AnalyticsReportRequests", + "description": "Single AppStoreVersionSubmission", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnalyticsReportRequestsResponse" + "$ref": "#/components/schemas/AppStoreVersionSubmissionResponse" } } } @@ -103395,24 +102989,13 @@ } ] }, - "/v1/apps/{id}/relationships/androidToIosAppMappingDetails": { + "/v1/appStoreVersions/{id}/relationships/build": { "get": { "tags": [ - "Apps" - ], - "operationId": "apps_androidToIosAppMappingDetails_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppStoreVersions" ], + "operationId": "appStoreVersions_build_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -103455,11 +103038,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAndroidToIosAppMappingDetailsLinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionBuildLinkageResponse" } } } @@ -103476,54 +103059,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/apps/{id}/androidToIosAppMappingDetails": { - "get": { + "patch": { "tags": [ - "Apps" + "AppStoreVersions" ], - "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" - ] + "operationId": "appStoreVersions_build_updateToOneRelationship", + "requestBody": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppStoreVersionBuildLinkageRequest" } - }, - "style": "form", - "explode": false + } }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -103565,71 +103116,8 @@ } } }, - "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" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/apps/{id}/relationships/appAvailabilityV2": { - "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", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { @@ -103638,8 +103126,8 @@ } } }, - "404": { - "description": "Not found error", + "409": { + "description": "Request entity error(s)", "content": { "application/json": { "schema": { @@ -103648,15 +103136,8 @@ } } }, - "200": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppAppAvailabilityV2LinkageResponse" - } - } - } + "204": { + "description": "Success (no content)" }, "429": { "description": "Rate limit exceeded error", @@ -103683,76 +103164,53 @@ } ] }, - "/v1/apps/{id}/appAvailabilityV2": { + "/v1/appStoreVersions/{id}/build": { "get": { "tags": [ - "Apps" + "AppStoreVersions" ], - "operationId": "apps_appAvailabilityV2_getToOneRelated", + "operationId": "appStoreVersions_build_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", + "name": "fields[builds]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type builds", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "territoryAvailabilities" + "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[territoryAvailabilities]", - "in": "query", - "description": "maximum number of related territoryAvailabilities returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -103797,11 +103255,11 @@ } }, "200": { - "description": "Single AppAvailability", + "description": "Single Build with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAvailabilityV2Response" + "$ref": "#/components/schemas/BuildWithoutIncludesResponse" } } } @@ -103831,12 +103289,12 @@ } ] }, - "/v1/apps/{id}/relationships/appClips": { + "/v1/appStoreVersions/{id}/relationships/customerReviews": { "get": { "tags": [ - "Apps" + "AppStoreVersions" ], - "operationId": "apps_appClips_getToManyRelationship", + "operationId": "appStoreVersions_customerReviews_getToManyRelationship", "parameters": [ { "name": "limit", @@ -103895,7 +103353,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAppClipsLinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionCustomerReviewsLinkagesResponse" } } } @@ -103925,199 +103383,426 @@ } ] }, - "/v1/apps/{id}/appClips": { + "/v1/appStoreVersions/{id}/customerReviews": { "get": { "tags": [ - "Apps" + "AppStoreVersions" ], - "operationId": "apps_appClips_getToManyRelated", + "operationId": "appStoreVersions_customerReviews_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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "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", + "name": "filter[territory]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "filter by attribute 'territory'", "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": { + "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" @@ -104136,11 +103821,11 @@ } }, "200": { - "description": "List of AppClips", + "description": "List of CustomerReviews", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppClipsResponse" + "$ref": "#/components/schemas/CustomerReviewsResponse" } } } @@ -104170,24 +103855,13 @@ } ] }, - "/v1/apps/{id}/relationships/appCustomProductPages": { + "/v1/appStoreVersions/{id}/relationships/gameCenterAppVersion": { "get": { "tags": [ - "Apps" - ], - "operationId": "apps_appCustomProductPages_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppStoreVersions" ], + "operationId": "appStoreVersions_gameCenterAppVersion_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -104230,11 +103904,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAppCustomProductPagesLinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionGameCenterAppVersionLinkageResponse" } } } @@ -104264,40 +103938,25 @@ } ] }, - "/v1/apps/{id}/appCustomProductPages": { + "/v1/appStoreVersions/{id}/gameCenterAppVersion": { "get": { "tags": [ - "Apps" + "AppStoreVersions" ], - "operationId": "apps_appCustomProductPages_getToManyRelated", + "operationId": "appStoreVersions_gameCenterAppVersion_getToOneRelated", "parameters": [ { - "name": "filter[visible]", - "in": "query", - "description": "filter by attribute 'visible'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appCustomProductPages]", + "name": "fields[gameCenterAppVersions]", "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPages", + "description": "the fields to include for returned resources of type gameCenterAppVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "url", - "visible", - "app", - "appCustomProductPageVersions" + "enabled", + "compatibilityVersions", + "appStoreVersion" ] } }, @@ -104305,107 +103964,44 @@ "explode": false }, { - "name": "fields[apps]", + "name": "fields[appStoreVersions]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "the fields to include for returned resources of type appStoreVersions", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", + "platform", + "versionString", + "appStoreState", + "appVersionState", + "copyright", + "reviewType", + "releaseType", + "earliestReleaseDate", + "usesIdfa", + "downloadable", + "createdDate", + "app", + "appStoreVersionLocalizations", + "build", + "appStoreVersionPhasedRelease", + "gameCenterAppVersion", + "routingAppCoverage", + "appStoreReviewDetail", + "appStoreVersionSubmission", + "appClipDefaultExperience", + "appStoreVersionExperiments", "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "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" + "customerReviews", + "alternativeDistributionPackage" ] } }, "style": "form", "explode": false }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, { "name": "include", "in": "query", @@ -104415,8 +104011,8 @@ "items": { "type": "string", "enum": [ - "app", - "appCustomProductPageVersions" + "compatibilityVersions", + "appStoreVersion" ] } }, @@ -104424,9 +104020,9 @@ "explode": false }, { - "name": "limit[appCustomProductPageVersions]", + "name": "limit[compatibilityVersions]", "in": "query", - "description": "maximum number of related appCustomProductPageVersions returned (when they are included)", + "description": "maximum number of related compatibilityVersions returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -104476,11 +104072,11 @@ } }, "200": { - "description": "List of AppCustomProductPages", + "description": "Single GameCenterAppVersion", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCustomProductPagesResponse" + "$ref": "#/components/schemas/GameCenterAppVersionResponse" } } } @@ -104510,24 +104106,13 @@ } ] }, - "/v1/apps/{id}/relationships/appEncryptionDeclarations": { + "/v1/appStoreVersions/{id}/relationships/routingAppCoverage": { "get": { "tags": [ - "Apps" - ], - "operationId": "apps_appEncryptionDeclarations_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "AppStoreVersions" ], + "operationId": "appStoreVersions_routingAppCoverage_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -104570,11 +104155,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAppEncryptionDeclarationsLinkagesResponse" + "$ref": "#/components/schemas/AppStoreVersionRoutingAppCoverageLinkageResponse" } } } @@ -104604,223 +104189,73 @@ } ] }, - "/v1/apps/{id}/appEncryptionDeclarations": { + "/v1/appStoreVersions/{id}/routingAppCoverage": { "get": { "tags": [ - "Apps" + "AppStoreVersions" ], - "operationId": "apps_appEncryptionDeclarations_getToManyRelated", + "operationId": "appStoreVersions_routingAppCoverage_getToOneRelated", "parameters": [ { - "name": "filter[platform]", + "name": "fields[routingAppCoverages]", "in": "query", - "description": "filter by attribute 'platform'", + "description": "the fields to include for returned resources of type routingAppCoverages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" + "fileSize", + "fileName", + "sourceFileChecksum", + "uploadOperations", + "assetDeliveryState", + "appStoreVersion" ] } }, "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]", + "name": "fields[appStoreVersions]", "in": "query", - "description": "the fields to include for returned resources of type appEncryptionDeclarations", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "appDescription", - "createdDate", - "usesEncryption", - "exempt", - "containsProprietaryCryptography", - "containsThirdPartyCryptography", - "availableOnFrenchStore", "platform", - "uploadedDate", - "documentUrl", - "documentName", - "documentType", - "appEncryptionDeclarationState", - "codeValue", + "versionString", + "appStoreState", + "appVersionState", + "copyright", + "reviewType", + "releaseType", + "earliestReleaseDate", + "usesIdfa", + "downloadable", + "createdDate", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", + "appStoreVersionLocalizations", + "build", + "appStoreVersionPhasedRelease", + "gameCenterAppVersion", + "routingAppCoverage", + "appStoreReviewDetail", + "appStoreVersionSubmission", + "appClipDefaultExperience", + "appStoreVersionExperiments", "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "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" + "customerReviews", + "alternativeDistributionPackage" ] } }, "style": "form", "explode": false }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, { "name": "include", "in": "query", @@ -104830,24 +104265,12 @@ "items": { "type": "string", "enum": [ - "app", - "builds", - "appEncryptionDeclarationDocument" + "appStoreVersion" ] } }, "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": { @@ -104892,11 +104315,11 @@ } }, "200": { - "description": "List of AppEncryptionDeclarations", + "description": "Single RoutingAppCoverage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEncryptionDeclarationsResponse" + "$ref": "#/components/schemas/RoutingAppCoverageResponse" } } } @@ -104926,12 +104349,12 @@ } ] }, - "/v1/apps/{id}/relationships/appEvents": { + "/v1/appTags/{id}/relationships/territories": { "get": { "tags": [ - "Apps" + "AppTags" ], - "operationId": "apps_appEvents_getToManyRelationship", + "operationId": "appTags_territories_getToManyRelationship", "parameters": [ { "name": "limit", @@ -104990,7 +104413,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAppEventsLinkagesResponse" + "$ref": "#/components/schemas/AppTagTerritoriesLinkagesResponse" } } } @@ -105020,94 +104443,23 @@ } ] }, - "/v1/apps/{id}/appEvents": { + "/v1/appTags/{id}/territories": { "get": { "tags": [ - "Apps" + "AppTags" ], - "operationId": "apps_appEvents_getToManyRelated", + "operationId": "appTags_territories_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]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type appEventLocalizations", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "name", - "shortDescription", - "longDescription", - "appEvent", - "appEventScreenshots", - "appEventVideoClips", - "placements" + "currency" ] } }, @@ -105123,32 +104475,6 @@ "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": { @@ -105193,11 +104519,11 @@ } }, "200": { - "description": "List of AppEvents", + "description": "List of Territories", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEventsResponse" + "$ref": "#/components/schemas/TerritoriesResponse" } } } @@ -105227,12 +104553,12 @@ } ] }, - "/v1/apps/{id}/relationships/appInfos": { + "/v1/apps/{id}/relationships/accessibilityDeclarations": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appInfos_getToManyRelationship", + "operationId": "apps_accessibilityDeclarations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -105291,7 +104617,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAppInfosLinkagesResponse" + "$ref": "#/components/schemas/AppAccessibilityDeclarationsLinkagesResponse" } } } @@ -105321,40 +104647,28 @@ } ] }, - "/v1/apps/{id}/appInfos": { + "/v1/apps/{id}/accessibilityDeclarations": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appInfos_getToManyRelated", + "operationId": "apps_accessibilityDeclarations_getToManyRelated", "parameters": [ { - "name": "fields[appInfos]", + "name": "filter[deviceFamily]", "in": "query", - "description": "the fields to include for returned resources of type appInfos", + "description": "filter by attribute 'deviceFamily'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "appStoreState", - "state", - "appStoreAgeRating", - "australiaAgeRating", - "brazilAgeRating", - "brazilAgeRatingV2", - "franceAgeRating", - "koreaAgeRating", - "app", - "ageRatingDeclaration", - "appInfoLocalizations", - "primaryCategory", - "primarySubcategoryOne", - "primarySubcategoryTwo", - "secondaryCategory", - "secondarySubcategoryOne", - "secondarySubcategoryTwo", - "territoryAgeRatings" + "IPHONE", + "IPAD", + "APPLE_TV", + "APPLE_WATCH", + "MAC", + "VISION" ] } }, @@ -105362,138 +104676,17 @@ "explode": false }, { - "name": "fields[apps]", + "name": "filter[state]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "filter by attribute 'state'", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "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", - "socialMedia", - "socialMediaAgeRestricted", - "horrorOrFearThemes", - "matureOrSuggestiveThemes", - "unrestrictedWebAccess", - "userGeneratedContent", - "violenceCartoonOrFantasy", - "violenceRealisticProlongedGraphicOrSadistic", - "violenceRealistic", - "ageRatingOverride", - "ageRatingOverrideV2", - "koreaAgeRatingOverride", - "gracRatingClassificationNumber", - "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" + "DRAFT", + "PUBLISHED", + "REPLACED" ] } }, @@ -105501,17 +104694,25 @@ "explode": false }, { - "name": "fields[appCategories]", + "name": "fields[accessibilityDeclarations]", "in": "query", - "description": "the fields to include for returned resources of type appCategories", + "description": "the fields to include for returned resources of type accessibilityDeclarations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platforms", - "subcategories", - "parent" + "deviceFamily", + "state", + "supportsAudioDescriptions", + "supportsCaptions", + "supportsDarkInterface", + "supportsDifferentiateWithoutColorAlone", + "supportsLargerText", + "supportsReducedMotion", + "supportsSufficientContrast", + "supportsVoiceControl", + "supportsVoiceover" ] } }, @@ -105527,40 +104728,189 @@ "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/relationships/alternativeDistributionKey": { + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/alternativeDistributionKey": { + "get": { + "tags": [ + "Apps" + ], + "operationId": "apps_alternativeDistributionKey_getToOneRelated", + "parameters": [ { - "name": "include", + "name": "fields[alternativeDistributionKeys]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type alternativeDistributionKeys", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "app", - "ageRatingDeclaration", - "appInfoLocalizations", - "primaryCategory", - "primarySubcategoryOne", - "primarySubcategoryTwo", - "secondaryCategory", - "secondarySubcategoryOne", - "secondarySubcategoryTwo" + "publicKey" ] } }, "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": { @@ -105605,11 +104955,11 @@ } }, "200": { - "description": "List of AppInfos", + "description": "Single AlternativeDistributionKey", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInfosResponse" + "$ref": "#/components/schemas/AlternativeDistributionKeyResponse" } } } @@ -105639,12 +104989,12 @@ } ] }, - "/v1/apps/{id}/relationships/appPricePoints": { + "/v1/apps/{id}/relationships/analyticsReportRequests": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appPricePoints_getToManyRelationship", + "operationId": "apps_analyticsReportRequests_getToManyRelationship", "parameters": [ { "name": "limit", @@ -105703,7 +105053,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAppPricePointsLinkagesResponse" + "$ref": "#/components/schemas/AppAnalyticsReportRequestsLinkagesResponse" } } } @@ -105733,40 +105083,24 @@ } ] }, - "/v1/apps/{id}/appPricePoints": { + "/v1/apps/{id}/analyticsReportRequests": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appPricePoints_getToManyRelated", + "operationId": "apps_analyticsReportRequests_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]", + "name": "filter[accessType]", "in": "query", - "description": "the fields to include for returned resources of type appPricePoints", + "description": "filter by attribute 'accessType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", - "app", - "equalizations", - "territory" + "ONE_TIME_SNAPSHOT", + "ONGOING" ] } }, @@ -105774,71 +105108,17 @@ "explode": false }, { - "name": "fields[apps]", + "name": "fields[analyticsReportRequests]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "the fields to include for returned resources of type analyticsReportRequests", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" + "accessType", + "stoppedDueToInactivity", + "reports" ] } }, @@ -105846,15 +105126,17 @@ "explode": false }, { - "name": "fields[territories]", + "name": "fields[analyticsReports]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type analyticsReports", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "name", + "category", + "instances" ] } }, @@ -105880,13 +105162,22 @@ "items": { "type": "string", "enum": [ - "app", - "territory" + "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": { @@ -105931,16 +105222,11 @@ } }, "200": { - "description": "List of AppPricePoints", + "description": "List of AnalyticsReportRequests", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPricePointsV3Response" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/csv" + "$ref": "#/components/schemas/AnalyticsReportRequestsResponse" } } } @@ -105970,13 +105256,24 @@ } ] }, - "/v1/apps/{id}/relationships/appPriceSchedule": { + "/v1/apps/{id}/relationships/androidToIosAppMappingDetails": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appPriceSchedule_getToOneRelationship", - "parameters": [], + "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)", @@ -106019,11 +105316,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAppPriceScheduleLinkageResponse" + "$ref": "#/components/schemas/AppAndroidToIosAppMappingDetailsLinkagesResponse" } } } @@ -106053,26 +105350,24 @@ } ] }, - "/v1/apps/{id}/appPriceSchedule": { + "/v1/apps/{id}/androidToIosAppMappingDetails": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appPriceSchedule_getToOneRelated", + "operationId": "apps_androidToIosAppMappingDetails_getToManyRelated", "parameters": [ { - "name": "fields[appPriceSchedules]", + "name": "fields[androidToIosAppMappingDetails]", "in": "query", - "description": "the fields to include for returned resources of type appPriceSchedules", + "description": "the fields to include for returned resources of type androidToIosAppMappingDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "app", - "baseTerritory", - "manualPrices", - "automaticPrices" + "packageName", + "appSigningKeyPublicCertificateSha256Fingerprints" ] } }, @@ -106080,87 +105375,193 @@ "explode": false }, { - "name": "fields[apps]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "maximum resources per page", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/relationships/appAvailabilityV2": { + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/appAvailabilityV2": { + "get": { + "tags": [ + "Apps" + ], + "operationId": "apps_appAvailabilityV2_getToOneRelated", + "parameters": [ { - "name": "fields[territories]", + "name": "fields[appAvailabilities]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type appAvailabilities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "availableInNewTerritories", + "territoryAvailabilities" ] } }, @@ -106168,18 +105569,19 @@ "explode": false }, { - "name": "fields[appPrices]", + "name": "fields[territoryAvailabilities]", "in": "query", - "description": "the fields to include for returned resources of type appPrices", + "description": "the fields to include for returned resources of type territoryAvailabilities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "manual", - "startDate", - "endDate", - "appPricePoint", + "available", + "releaseDate", + "preOrderEnabled", + "preOrderPublishDate", + "contentStatuses", "territory" ] } @@ -106196,10 +105598,7 @@ "items": { "type": "string", "enum": [ - "app", - "baseTerritory", - "manualPrices", - "automaticPrices" + "territoryAvailabilities" ] } }, @@ -106207,19 +105606,9 @@ "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]", + "name": "limit[territoryAvailabilities]", "in": "query", - "description": "maximum number of related automaticPrices returned (when they are included)", + "description": "maximum number of related territoryAvailabilities returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -106269,11 +105658,11 @@ } }, "200": { - "description": "Single AppPriceSchedule", + "description": "Single AppAvailability", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPriceScheduleResponse" + "$ref": "#/components/schemas/AppAvailabilityV2Response" } } } @@ -106303,12 +105692,12 @@ } ] }, - "/v1/apps/{id}/relationships/appStoreVersionExperimentsV2": { + "/v1/apps/{id}/relationships/appClips": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelationship", + "operationId": "apps_appClips_getToManyRelationship", "parameters": [ { "name": "limit", @@ -106367,7 +105756,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAppStoreVersionExperimentsV2LinkagesResponse" + "$ref": "#/components/schemas/AppAppClipsLinkagesResponse" } } } @@ -106397,57 +105786,39 @@ } ] }, - "/v1/apps/{id}/appStoreVersionExperimentsV2": { + "/v1/apps/{id}/appClips": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", + "operationId": "apps_appClips_getToManyRelated", "parameters": [ { - "name": "filter[state]", + "name": "filter[bundleId]", "in": "query", - "description": "filter by attribute 'state'", + "description": "filter by attribute 'bundleId'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "PREPARE_FOR_SUBMISSION", - "READY_FOR_REVIEW", - "WAITING_FOR_REVIEW", - "IN_REVIEW", - "ACCEPTED", - "APPROVED", - "REJECTED", - "COMPLETED", - "STOPPED" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appStoreVersionExperiments]", + "name": "fields[appClips]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperiments", + "description": "the fields to include for returned resources of type appClips", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "platform", - "trafficProportion", - "state", - "reviewRequired", - "startDate", - "endDate", + "bundleId", "app", - "latestControlVersion", - "controlVersions", - "appStoreVersionExperimentTreatments" + "appClipDefaultExperiences", + "appClipAdvancedExperiences" ] } }, @@ -106496,6 +105867,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -106527,60 +105899,19 @@ "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]", + "name": "fields[appClipDefaultExperiences]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatments", + "description": "the fields to include for returned resources of type appClipDefaultExperiences", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "appIcon", - "appIconName", - "promotedDate", - "appStoreVersionExperiment", - "appStoreVersionExperimentV2", - "appStoreVersionExperimentTreatmentLocalizations" + "action", + "appClip", + "releaseWithAppStoreVersion", + "appClipDefaultExperienceLocalizations", + "appClipAppStoreReviewDetail" ] } }, @@ -106607,9 +105938,7 @@ "type": "string", "enum": [ "app", - "latestControlVersion", - "controlVersions", - "appStoreVersionExperimentTreatments" + "appClipDefaultExperiences" ] } }, @@ -106617,19 +105946,9 @@ "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]", + "name": "limit[appClipDefaultExperiences]", "in": "query", - "description": "maximum number of related appStoreVersionExperimentTreatments returned (when they are included)", + "description": "maximum number of related appClipDefaultExperiences returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -106679,11 +105998,11 @@ } }, "200": { - "description": "List of AppStoreVersionExperiments", + "description": "List of AppClips", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionExperimentsV2Response" + "$ref": "#/components/schemas/AppClipsResponse" } } } @@ -106713,12 +106032,12 @@ } ] }, - "/v1/apps/{id}/relationships/appStoreVersions": { + "/v1/apps/{id}/relationships/appCustomProductPages": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appStoreVersions_getToManyRelationship", + "operationId": "apps_appCustomProductPages_getToManyRelationship", "parameters": [ { "name": "limit", @@ -106777,7 +106096,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAppStoreVersionsLinkagesResponse" + "$ref": "#/components/schemas/AppAppCustomProductPagesLinkagesResponse" } } } @@ -106807,105 +106126,133 @@ } ] }, - "/v1/apps/{id}/appStoreVersions": { + "/v1/apps/{id}/appCustomProductPages": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appStoreVersions_getToManyRelated", + "operationId": "apps_appCustomProductPages_getToManyRelated", "parameters": [ { - "name": "filter[platform]", + "name": "filter[visible]", "in": "query", - "description": "filter by attribute 'platform'", + "description": "filter by attribute 'visible'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "filter[versionString]", + "name": "fields[appCustomProductPages]", "in": "query", - "description": "filter by attribute 'versionString'", + "description": "the fields to include for returned resources of type appCustomProductPages", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "name", + "url", + "visible", + "app", + "appCustomProductPageVersions" + ] } }, "style": "form", "explode": false }, { - "name": "filter[appStoreState]", + "name": "fields[apps]", "in": "query", - "description": "filter by attribute 'appStoreState'", + "description": "the fields to include for returned resources of type apps", "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" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, "style": "form", - "explode": false, - "deprecated": true + "explode": false }, { - "name": "filter[appVersionState]", + "name": "fields[appCustomProductPageVersions]", "in": "query", - "description": "filter by attribute 'appVersionState'", + "description": "the fields to include for returned resources of type appCustomProductPageVersions", "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" + "version", + "state", + "deepLink", + "appCustomProductPage", + "appCustomProductPageLocalizations" ] } }, @@ -106913,9 +106260,244 @@ "explode": false }, { - "name": "filter[id]", + "name": "limit", "in": "query", - "description": "filter by id(s)", + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/relationships/appEncryptionDeclarations": { + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/appEncryptionDeclarations": { + "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": { @@ -106926,38 +106508,31 @@ "explode": false }, { - "name": "fields[appStoreVersions]", + "name": "fields[appEncryptionDeclarations]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "the fields to include for returned resources of type appEncryptionDeclarations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platform", - "versionString", - "appStoreState", - "appVersionState", - "copyright", - "reviewType", - "releaseType", - "earliestReleaseDate", - "usesIdfa", - "downloadable", + "appDescription", "createdDate", + "usesEncryption", + "exempt", + "containsProprietaryCryptography", + "containsThirdPartyCryptography", + "availableOnFrenchStore", + "platform", + "uploadedDate", + "documentUrl", + "documentName", + "documentType", + "appEncryptionDeclarationState", + "codeValue", "app", - "appStoreVersionLocalizations", - "build", - "appStoreVersionPhasedRelease", - "gameCenterAppVersion", - "routingAppCoverage", - "appStoreReviewDetail", - "appStoreVersionSubmission", - "appClipDefaultExperience", - "appStoreVersionExperiments", - "appStoreVersionExperimentsV2", - "customerReviews", - "alternativeDistributionPackage" + "builds", + "appEncryptionDeclarationDocument" ] } }, @@ -107006,6 +106581,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -107036,33 +106612,6 @@ "style": "form", "explode": false }, - { - "name": "fields[appStoreVersionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" - ] - } - }, - "style": "form", - "explode": false - }, { "name": "fields[builds]", "in": "query", @@ -107105,46 +106654,9 @@ "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]", + "name": "fields[appEncryptionDeclarationDocuments]", "in": "query", - "description": "the fields to include for returned resources of type routingAppCoverages", + "description": "the fields to include for returned resources of type appEncryptionDeclarationDocuments", "schema": { "type": "array", "items": { @@ -107152,115 +106664,11 @@ "enum": [ "fileSize", "fileName", + "assetToken", + "downloadUrl", "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" + "assetDeliveryState" ] } }, @@ -107287,17 +106695,8 @@ "type": "string", "enum": [ "app", - "appStoreVersionLocalizations", - "build", - "appStoreVersionPhasedRelease", - "gameCenterAppVersion", - "routingAppCoverage", - "appStoreReviewDetail", - "appStoreVersionSubmission", - "appClipDefaultExperience", - "appStoreVersionExperiments", - "appStoreVersionExperimentsV2", - "alternativeDistributionPackage" + "builds", + "appEncryptionDeclarationDocument" ] } }, @@ -107305,30 +106704,9 @@ "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]", + "name": "limit[builds]", "in": "query", - "description": "maximum number of related appStoreVersionExperimentsV2 returned (when they are included)", + "description": "maximum number of related builds returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -107378,11 +106756,11 @@ } }, "200": { - "description": "List of AppStoreVersions", + "description": "List of AppEncryptionDeclarations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionsResponse" + "$ref": "#/components/schemas/AppEncryptionDeclarationsResponse" } } } @@ -107412,12 +106790,12 @@ } ] }, - "/v1/apps/{id}/relationships/appTags": { + "/v1/apps/{id}/relationships/appEvents": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appTags_getToManyRelationship", + "operationId": "apps_appEvents_getToManyRelationship", "parameters": [ { "name": "limit", @@ -107476,7 +106854,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAppTagsLinkagesResponse" + "$ref": "#/components/schemas/AppAppEventsLinkagesResponse" } } } @@ -107506,55 +106884,71 @@ } ] }, - "/v1/apps/{id}/appTags": { + "/v1/apps/{id}/appEvents": { "get": { "tags": [ "Apps" ], - "operationId": "apps_appTags_getToManyRelated", + "operationId": "apps_appEvents_getToManyRelated", "parameters": [ { - "name": "filter[visibleInAppStore]", + "name": "filter[eventState]", "in": "query", - "description": "filter by attribute 'visibleInAppStore'", + "description": "filter by attribute 'eventState'", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "DRAFT", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "REJECTED", + "ACCEPTED", + "APPROVED", + "PUBLISHED", + "PAST", + "ARCHIVED" + ] } }, "style": "form", "explode": false }, { - "name": "sort", + "name": "filter[id]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "filter by id(s)", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "name", - "-name" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appTags]", + "name": "fields[appEvents]", "in": "query", - "description": "the fields to include for returned resources of type appTags", + "description": "the fields to include for returned resources of type appEvents", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "visibleInAppStore", - "territories" + "referenceName", + "badge", + "eventState", + "deepLink", + "purchaseRequirement", + "primaryLocale", + "priority", + "purpose", + "territorySchedules", + "archivedTerritorySchedules", + "localizations" ] } }, @@ -107562,15 +106956,22 @@ "explode": false }, { - "name": "fields[territories]", + "name": "fields[appEventLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type appEventLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" ] } }, @@ -107596,7 +106997,7 @@ "items": { "type": "string", "enum": [ - "territories" + "localizations" ] } }, @@ -107604,9 +107005,9 @@ "explode": false }, { - "name": "limit[territories]", + "name": "limit[localizations]", "in": "query", - "description": "maximum number of related territories returned (when they are included)", + "description": "maximum number of related localizations returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -107656,11 +107057,11 @@ } }, "200": { - "description": "List of AppTags", + "description": "List of AppEvents", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppTagsResponse" + "$ref": "#/components/schemas/AppEventsResponse" } } } @@ -107690,13 +107091,24 @@ } ] }, - "/v1/apps/{id}/relationships/assetLibrary": { + "/v1/apps/{id}/relationships/appInfos": { "get": { "tags": [ "Apps" ], - "operationId": "apps_assetLibrary_getToOneRelationship", - "parameters": [], + "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)", @@ -107739,11 +107151,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryLinkageResponse" + "$ref": "#/components/schemas/AppAppInfosLinkagesResponse" } } } @@ -107773,29 +107185,247 @@ } ] }, - "/v1/apps/{id}/assetLibrary": { + "/v1/apps/{id}/appInfos": { "get": { "tags": [ "Apps" ], - "operationId": "apps_assetLibrary_getToOneRelated", + "operationId": "apps_appInfos_getToManyRelated", "parameters": [ { - "name": "fields[appAssetLibraries]", + "name": "fields[appInfos]", "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraries", + "description": "the fields to include for returned resources of type appInfos", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "images", - "videos" + "appStoreState", + "state", + "appStoreAgeRating", + "australiaAgeRating", + "brazilAgeRating", + "brazilAgeRatingV2", + "franceAgeRating", + "koreaAgeRating", + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "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", + "socialMedia", + "socialMediaAgeRestricted", + "horrorOrFearThemes", + "matureOrSuggestiveThemes", + "unrestrictedWebAccess", + "userGeneratedContent", + "violenceCartoonOrFantasy", + "violenceRealisticProlongedGraphicOrSadistic", + "violenceRealistic", + "ageRatingOverride", + "ageRatingOverrideV2", + "koreaAgeRatingOverride", + "gracRatingClassificationNumber", + "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": { @@ -107840,11 +107470,11 @@ } }, "200": { - "description": "Single AppAssetLibrary", + "description": "List of AppInfos", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppAssetLibraryResponse" + "$ref": "#/components/schemas/AppInfosResponse" } } } @@ -107874,12 +107504,12 @@ } ] }, - "/v1/apps/{id}/relationships/backgroundAssets": { + "/v1/apps/{id}/relationships/appPricePoints": { "get": { "tags": [ "Apps" ], - "operationId": "apps_backgroundAssets_getToManyRelationship", + "operationId": "apps_appPricePoints_getToManyRelationship", "parameters": [ { "name": "limit", @@ -107938,7 +107568,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppBackgroundAssetsLinkagesResponse" + "$ref": "#/components/schemas/AppAppPricePointsLinkagesResponse" } } } @@ -107968,43 +107598,17 @@ } ] }, - "/v1/apps/{id}/backgroundAssets": { + "/v1/apps/{id}/appPricePoints": { "get": { "tags": [ "Apps" ], - "operationId": "apps_backgroundAssets_getToManyRelated", + "operationId": "apps_appPricePoints_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.locale]", + "name": "filter[territory]", "in": "query", - "description": "filter by attribute 'versions.locale'", + "description": "filter by id(s) of related 'territory'", "schema": { "type": "array", "items": { @@ -108015,61 +107619,19 @@ "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]", + "name": "fields[appPricePoints]", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssets", + "description": "the fields to include for returned resources of type appPricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "archived", - "assetPackIdentifier", - "createdDate", - "usedBytes", + "customerPrice", + "proceeds", "app", - "versions", - "appStoreVersion", - "internalBetaVersion", - "externalBetaVersion" + "equalizations", + "territory" ] } }, @@ -108118,6 +107680,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -108149,27 +107712,15 @@ "explode": false }, { - "name": "fields[backgroundAssetVersions]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssetVersions", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "createdDate", - "platforms", - "state", - "stateDetails", - "version", - "locale", - "backgroundAsset", - "internalBetaRelease", - "externalBetaRelease", - "appStoreRelease", - "assetFile", - "manifestFile", - "backgroundAssetUploadFiles" + "currency" ] } }, @@ -108196,9 +107747,7 @@ "type": "string", "enum": [ "app", - "appStoreVersion", - "internalBetaVersion", - "externalBetaVersion" + "territory" ] } }, @@ -108248,11 +107797,16 @@ } }, "200": { - "description": "List of BackgroundAssets", + "description": "List of AppPricePoints", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BackgroundAssetsResponse" + "$ref": "#/components/schemas/AppPricePointsV3Response" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/csv" } } } @@ -108282,24 +107836,13 @@ } ] }, - "/v1/apps/{id}/relationships/betaAppLocalizations": { + "/v1/apps/{id}/relationships/appPriceSchedule": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaAppLocalizations_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "operationId": "apps_appPriceSchedule_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -108342,11 +107885,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppBetaAppLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/AppAppPriceScheduleLinkageResponse" } } } @@ -108376,29 +107919,26 @@ } ] }, - "/v1/apps/{id}/betaAppLocalizations": { + "/v1/apps/{id}/appPriceSchedule": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaAppLocalizations_getToManyRelated", + "operationId": "apps_appPriceSchedule_getToOneRelated", "parameters": [ { - "name": "fields[betaAppLocalizations]", + "name": "fields[appPriceSchedules]", "in": "query", - "description": "the fields to include for returned resources of type betaAppLocalizations", + "description": "the fields to include for returned resources of type appPriceSchedules", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "feedbackEmail", - "marketingUrl", - "privacyPolicyUrl", - "tvOsPrivacyPolicy", - "description", - "locale", - "app" + "app", + "baseTerritory", + "manualPrices", + "automaticPrices" ] } }, @@ -108406,22 +107946,160 @@ "explode": false }, { - "name": "limit", + "name": "fields[apps]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type apps", "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "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" } } @@ -108458,11 +108136,11 @@ } }, "200": { - "description": "List of BetaAppLocalizations with get", + "description": "Single AppPriceSchedule", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BetaAppLocalizationsWithoutIncludesResponse" + "$ref": "#/components/schemas/AppPriceScheduleResponse" } } } @@ -108492,13 +108170,24 @@ } ] }, - "/v1/apps/{id}/relationships/betaAppReviewDetail": { + "/v1/apps/{id}/relationships/appStoreVersionExperimentsV2": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaAppReviewDetail_getToOneRelationship", - "parameters": [], + "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)", @@ -108541,11 +108230,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppBetaAppReviewDetailLinkageResponse" + "$ref": "#/components/schemas/AppAppStoreVersionExperimentsV2LinkagesResponse" } } } @@ -108575,36 +108264,245 @@ } ] }, - "/v1/apps/{id}/betaAppReviewDetail": { + "/v1/apps/{id}/appStoreVersionExperimentsV2": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaAppReviewDetail_getToOneRelated", + "operationId": "apps_appStoreVersionExperimentsV2_getToManyRelated", "parameters": [ { - "name": "fields[betaAppReviewDetails]", + "name": "filter[state]", "in": "query", - "description": "the fields to include for returned resources of type betaAppReviewDetails", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "contactFirstName", - "contactLastName", - "contactPhone", - "contactEmail", - "demoAccountName", - "demoAccountPassword", - "demoAccountRequired", - "notes", - "app" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "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": { @@ -108649,11 +108547,11 @@ } }, "200": { - "description": "Single BetaAppReviewDetail with get", + "description": "List of AppStoreVersionExperiments", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BetaAppReviewDetailWithoutIncludesResponse" + "$ref": "#/components/schemas/AppStoreVersionExperimentsV2Response" } } } @@ -108683,12 +108581,12 @@ } ] }, - "/v1/apps/{id}/relationships/betaFeedbackCrashSubmissions": { + "/v1/apps/{id}/relationships/appStoreVersions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaFeedbackCrashSubmissions_getToManyRelationship", + "operationId": "apps_appStoreVersions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -108747,7 +108645,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppBetaFeedbackCrashSubmissionsLinkagesResponse" + "$ref": "#/components/schemas/AppAppStoreVersionsLinkagesResponse" } } } @@ -108777,30 +108675,36 @@ } ] }, - "/v1/apps/{id}/betaFeedbackCrashSubmissions": { + "/v1/apps/{id}/appStoreVersions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaFeedbackCrashSubmissions_getToManyRelated", + "operationId": "apps_appStoreVersions_getToManyRelated", "parameters": [ { - "name": "filter[deviceModel]", + "name": "filter[platform]", "in": "query", - "description": "filter by attribute 'deviceModel'", + "description": "filter by attribute 'platform'", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "IOS", + "MAC_OS", + "TV_OS", + "VISION_OS" + ] } }, "style": "form", "explode": false }, { - "name": "filter[osVersion]", + "name": "filter[versionString]", "in": "query", - "description": "filter by attribute 'osVersion'", + "description": "filter by attribute 'versionString'", "schema": { "type": "array", "items": { @@ -108811,37 +108715,65 @@ "explode": false }, { - "name": "filter[appPlatform]", + "name": "filter[appStoreState]", "in": "query", - "description": "filter by attribute 'appPlatform'", + "description": "filter by attribute 'appStoreState'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" + "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 + "explode": false, + "deprecated": true }, { - "name": "filter[devicePlatform]", + "name": "filter[appVersionState]", "in": "query", - "description": "filter by attribute 'devicePlatform'", + "description": "filter by attribute 'appVersionState'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" + "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" ] } }, @@ -108849,22 +108781,9 @@ "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]", + "name": "filter[id]", "in": "query", - "description": "filter by id(s) of related 'build.preReleaseVersion'", + "description": "filter by id(s)", "schema": { "type": "array", "items": { @@ -108875,29 +108794,111 @@ "explode": false }, { - "name": "filter[tester]", + "name": "fields[appStoreVersions]", "in": "query", - "description": "filter by id(s) of related 'tester'", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { "type": "array", "items": { - "type": "string" + "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": "sort", + "name": "fields[apps]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "createdDate", - "-createdDate" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, @@ -108905,37 +108906,26 @@ "explode": false }, { - "name": "fields[betaFeedbackCrashSubmissions]", + "name": "fields[appStoreVersionLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type betaFeedbackCrashSubmissions", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "createdDate", - "comment", - "email", - "deviceModel", - "osVersion", + "description", "locale", - "timeZone", - "architecture", - "connectionType", - "pairedAppleWatch", - "appUptimeInMilliseconds", - "diskBytesAvailable", - "diskBytesTotal", - "batteryPercentage", - "screenWidthInPoints", - "screenHeightInPoints", - "appPlatform", - "devicePlatform", - "deviceFamily", - "buildBundleId", - "crashLog", - "build", - "tester" + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" ] } }, @@ -108984,23 +108974,162 @@ "explode": false }, { - "name": "fields[betaTesters]", + "name": "fields[appStoreVersionPhasedReleases]", "in": "query", - "description": "the fields to include for returned resources of type betaTesters", + "description": "the fields to include for returned resources of type appStoreVersionPhasedReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "firstName", - "lastName", - "email", - "inviteType", + "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", - "appDevices", - "apps", - "betaGroups", - "builds" + "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" ] } }, @@ -109026,13 +109155,54 @@ "items": { "type": "string", "enum": [ + "app", + "appStoreVersionLocalizations", "build", - "tester" + "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": { @@ -109077,11 +109247,11 @@ } }, "200": { - "description": "List of BetaFeedbackCrashSubmissions", + "description": "List of AppStoreVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BetaFeedbackCrashSubmissionsResponse" + "$ref": "#/components/schemas/AppStoreVersionsResponse" } } } @@ -109111,12 +109281,12 @@ } ] }, - "/v1/apps/{id}/relationships/betaFeedbackScreenshotSubmissions": { + "/v1/apps/{id}/relationships/appTags": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaFeedbackScreenshotSubmissions_getToManyRelationship", + "operationId": "apps_appTags_getToManyRelationship", "parameters": [ { "name": "limit", @@ -109175,7 +109345,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppBetaFeedbackScreenshotSubmissionsLinkagesResponse" + "$ref": "#/components/schemas/AppAppTagsLinkagesResponse" } } } @@ -109205,30 +109375,17 @@ } ] }, - "/v1/apps/{id}/betaFeedbackScreenshotSubmissions": { + "/v1/apps/{id}/appTags": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaFeedbackScreenshotSubmissions_getToManyRelated", + "operationId": "apps_appTags_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]", + "name": "filter[visibleInAppStore]", "in": "query", - "description": "filter by attribute 'osVersion'", + "description": "filter by attribute 'visibleInAppStore'", "schema": { "type": "array", "items": { @@ -109239,18 +109396,16 @@ "explode": false }, { - "name": "filter[appPlatform]", + "name": "sort", "in": "query", - "description": "filter by attribute 'appPlatform'", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" + "name", + "-name" ] } }, @@ -109258,18 +109413,17 @@ "explode": false }, { - "name": "filter[devicePlatform]", + "name": "fields[appTags]", "in": "query", - "description": "filter by attribute 'devicePlatform'", + "description": "the fields to include for returned resources of type appTags", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" + "name", + "visibleInAppStore", + "territories" ] } }, @@ -109277,55 +109431,15 @@ "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", + "name": "fields[territories]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "createdDate", - "-createdDate" + "currency" ] } }, @@ -109333,78 +109447,25 @@ "explode": false }, { - "name": "fields[betaFeedbackScreenshotSubmissions]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type betaFeedbackScreenshotSubmissions", + "description": "maximum resources per page", "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" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { - "name": "fields[builds]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type builds", + "description": "comma-separated list of relationships to include", "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" + "territories" ] } }, @@ -109412,50 +109473,193 @@ "explode": false }, { - "name": "fields[betaTesters]", + "name": "limit[territories]", "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", + "description": "maximum number of related territories returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/relationships/assetLibrary": { + "get": { + "tags": [ + "Apps" + ], + "operationId": "apps_assetLibrary_getToOneRelationship", + "parameters": [], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAssetLibraryLinkageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/assetLibrary": { + "get": { + "tags": [ + "Apps" + ], + "operationId": "apps_assetLibrary_getToOneRelated", + "parameters": [ { - "name": "include", + "name": "fields[appAssetLibraries]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type appAssetLibraries", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "build", - "tester" + "images", + "videos" ] } }, @@ -109505,11 +109709,11 @@ } }, "200": { - "description": "List of BetaFeedbackScreenshotSubmissions", + "description": "Single AppAssetLibrary", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BetaFeedbackScreenshotSubmissionsResponse" + "$ref": "#/components/schemas/AppAssetLibraryResponse" } } } @@ -109539,12 +109743,12 @@ } ] }, - "/v1/apps/{id}/relationships/betaGroups": { + "/v1/apps/{id}/relationships/backgroundAssets": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaGroups_getToManyRelationship", + "operationId": "apps_backgroundAssets_getToManyRelationship", "parameters": [ { "name": "limit", @@ -109603,7 +109807,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppBetaGroupsLinkagesResponse" + "$ref": "#/components/schemas/AppBackgroundAssetsLinkagesResponse" } } } @@ -109633,39 +109837,209 @@ } ] }, - "/v1/apps/{id}/betaGroups": { + "/v1/apps/{id}/backgroundAssets": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaGroups_getToManyRelated", + "operationId": "apps_backgroundAssets_getToManyRelated", "parameters": [ { - "name": "fields[betaGroups]", + "name": "filter[archived]", "in": "query", - "description": "the fields to include for returned resources of type betaGroups", + "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.locale]", + "in": "query", + "description": "filter by attribute 'versions.locale'", + "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": [ - "name", + "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", - "isInternalGroup", - "hasAccessToAllBuilds", - "publicLinkEnabled", - "publicLinkId", - "publicLinkLimitEnabled", - "publicLinkLimit", - "publicLink", - "feedbackEnabled", - "iosBuildsAvailableForAppleSiliconMac", - "iosBuildsAvailableForAppleVision", + "-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", - "builds", + "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", - "betaRecruitmentCriteria", - "betaRecruitmentCriterionCompatibleBuildCheck" + "betaGroups", + "appStoreVersions", + "appTags", + "preReleaseVersions", + "betaAppLocalizations", + "builds", + "betaLicenseAgreement", + "betaAppReviewDetail", + "appInfos", + "appClips", + "appPricePoints", + "endUserLicenseAgreement", + "appPriceSchedule", + "appAvailabilityV2", + "inAppPurchases", + "subscriptionGroups", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "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", + "locale", + "backgroundAsset", + "internalBetaRelease", + "externalBetaRelease", + "appStoreRelease", + "assetFile", + "manifestFile", + "backgroundAssetUploadFiles" ] } }, @@ -109681,6 +110055,25 @@ "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": { @@ -109725,11 +110118,11 @@ } }, "200": { - "description": "List of BetaGroups with get", + "description": "List of BackgroundAssets", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BetaGroupsWithoutIncludesResponse" + "$ref": "#/components/schemas/BackgroundAssetsResponse" } } } @@ -109759,13 +110152,24 @@ } ] }, - "/v1/apps/{id}/relationships/betaLicenseAgreement": { + "/v1/apps/{id}/relationships/betaAppLocalizations": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaLicenseAgreement_getToOneRelationship", - "parameters": [], + "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)", @@ -109808,11 +110212,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppBetaLicenseAgreementLinkageResponse" + "$ref": "#/components/schemas/AppBetaAppLocalizationsLinkagesResponse" } } } @@ -109842,29 +110246,44 @@ } ] }, - "/v1/apps/{id}/betaLicenseAgreement": { + "/v1/apps/{id}/betaAppLocalizations": { "get": { "tags": [ "Apps" ], - "operationId": "apps_betaLicenseAgreement_getToOneRelated", + "operationId": "apps_betaAppLocalizations_getToManyRelated", "parameters": [ { - "name": "fields[betaLicenseAgreements]", + "name": "fields[betaAppLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type betaLicenseAgreements", + "description": "the fields to include for returned resources of type betaAppLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "agreementText", + "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": { @@ -109909,11 +110328,11 @@ } }, "200": { - "description": "Single BetaLicenseAgreement with get", + "description": "List of BetaAppLocalizations with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BetaLicenseAgreementWithoutIncludesResponse" + "$ref": "#/components/schemas/BetaAppLocalizationsWithoutIncludesResponse" } } } @@ -109943,23 +110362,13 @@ } ] }, - "/v1/apps/{id}/relationships/betaTesters": { - "delete": { + "/v1/apps/{id}/relationships/betaAppReviewDetail": { + "get": { "tags": [ "Apps" ], - "operationId": "apps_betaTesters_deleteToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppBetaTestersLinkagesRequest" - } - } - }, - "required": true - }, + "operationId": "apps_betaAppReviewDetail_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -110001,8 +110410,76 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/betaAppReviewDetail": { + "get": { + "tags": [ + "Apps" + ], + "operationId": "apps_betaAppReviewDetail_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": { @@ -110011,8 +110488,8 @@ } } }, - "409": { - "description": "Request entity error(s)", + "401": { + "description": "Unauthorized error(s)", "content": { "application/json": { "schema": { @@ -110021,11 +110498,35 @@ } } }, - "202": { - "description": "Accepted for future completion" + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "204": { - "description": "Success (no content)" + "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", @@ -110052,12 +110553,12 @@ } ] }, - "/v1/apps/{id}/relationships/buildUploads": { + "/v1/apps/{id}/relationships/betaFeedbackCrashSubmissions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_buildUploads_getToManyRelationship", + "operationId": "apps_betaFeedbackCrashSubmissions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -110116,7 +110617,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppBuildUploadsLinkagesResponse" + "$ref": "#/components/schemas/AppBetaFeedbackCrashSubmissionsLinkagesResponse" } } } @@ -110146,17 +110647,17 @@ } ] }, - "/v1/apps/{id}/buildUploads": { + "/v1/apps/{id}/betaFeedbackCrashSubmissions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_buildUploads_getToManyRelated", + "operationId": "apps_betaFeedbackCrashSubmissions_getToManyRelated", "parameters": [ { - "name": "filter[cfBundleShortVersionString]", + "name": "filter[deviceModel]", "in": "query", - "description": "filter by attribute 'cfBundleShortVersionString'", + "description": "filter by attribute 'deviceModel'", "schema": { "type": "array", "items": { @@ -110167,9 +110668,9 @@ "explode": false }, { - "name": "filter[cfBundleVersion]", + "name": "filter[osVersion]", "in": "query", - "description": "filter by attribute 'cfBundleVersion'", + "description": "filter by attribute 'osVersion'", "schema": { "type": "array", "items": { @@ -110180,9 +110681,9 @@ "explode": false }, { - "name": "filter[platform]", + "name": "filter[appPlatform]", "in": "query", - "description": "filter by attribute 'platform'", + "description": "filter by attribute 'appPlatform'", "schema": { "type": "array", "items": { @@ -110199,9 +110700,54 @@ "explode": false }, { - "name": "filter[state]", + "name": "filter[devicePlatform]", "in": "query", - "description": "filter by state", + "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": { @@ -110220,10 +110766,8 @@ "items": { "type": "string", "enum": [ - "cfBundleVersion", - "-cfBundleVersion", - "uploadedDate", - "-uploadedDate" + "createdDate", + "-createdDate" ] } }, @@ -110231,25 +110775,37 @@ "explode": false }, { - "name": "fields[buildUploads]", + "name": "fields[betaFeedbackCrashSubmissions]", "in": "query", - "description": "the fields to include for returned resources of type buildUploads", + "description": "the fields to include for returned resources of type betaFeedbackCrashSubmissions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "cfBundleShortVersionString", - "cfBundleVersion", "createdDate", - "state", - "platform", - "uploadedDate", + "comment", + "email", + "deviceModel", + "osVersion", + "locale", + "timeZone", + "architecture", + "connectionType", + "pairedAppleWatch", + "appUptimeInMilliseconds", + "diskBytesAvailable", + "diskBytesTotal", + "batteryPercentage", + "screenWidthInPoints", + "screenHeightInPoints", + "appPlatform", + "devicePlatform", + "deviceFamily", + "buildBundleId", + "crashLog", "build", - "assetFile", - "assetDescriptionFile", - "assetSpiFile", - "buildUploadFiles" + "tester" ] } }, @@ -110298,22 +110854,23 @@ "explode": false }, { - "name": "fields[buildUploadFiles]", + "name": "fields[betaTesters]", "in": "query", - "description": "the fields to include for returned resources of type buildUploadFiles", + "description": "the fields to include for returned resources of type betaTesters", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "assetDeliveryState", - "assetToken", - "assetType", - "fileName", - "fileSize", - "sourceFileChecksums", - "uploadOperations", - "uti" + "firstName", + "lastName", + "email", + "inviteType", + "state", + "appDevices", + "apps", + "betaGroups", + "builds" ] } }, @@ -110340,9 +110897,7 @@ "type": "string", "enum": [ "build", - "assetFile", - "assetDescriptionFile", - "assetSpiFile" + "tester" ] } }, @@ -110392,11 +110947,11 @@ } }, "200": { - "description": "List of BuildUploads", + "description": "List of BetaFeedbackCrashSubmissions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BuildUploadsResponse" + "$ref": "#/components/schemas/BetaFeedbackCrashSubmissionsResponse" } } } @@ -110426,12 +110981,12 @@ } ] }, - "/v1/apps/{id}/relationships/builds": { + "/v1/apps/{id}/relationships/betaFeedbackScreenshotSubmissions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_builds_getToManyRelationship", + "operationId": "apps_betaFeedbackScreenshotSubmissions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -110490,7 +111045,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppBuildsLinkagesResponse" + "$ref": "#/components/schemas/AppBetaFeedbackScreenshotSubmissionsLinkagesResponse" } } } @@ -110520,13 +111075,171 @@ } ] }, - "/v1/apps/{id}/builds": { + "/v1/apps/{id}/betaFeedbackScreenshotSubmissions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_builds_getToManyRelated", + "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", @@ -110568,6 +111281,30 @@ "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", @@ -110577,6 +111314,23 @@ "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": { @@ -110621,11 +111375,11 @@ } }, "200": { - "description": "List of Builds with get", + "description": "List of BetaFeedbackScreenshotSubmissions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BuildsWithoutIncludesResponse" + "$ref": "#/components/schemas/BetaFeedbackScreenshotSubmissionsResponse" } } } @@ -110655,13 +111409,24 @@ } ] }, - "/v1/apps/{id}/relationships/ciProduct": { + "/v1/apps/{id}/relationships/betaGroups": { "get": { "tags": [ "Apps" ], - "operationId": "apps_ciProduct_getToOneRelationship", - "parameters": [], + "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)", @@ -110704,11 +111469,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCiProductLinkageResponse" + "$ref": "#/components/schemas/AppBetaGroupsLinkagesResponse" } } } @@ -110738,17 +111503,17 @@ } ] }, - "/v1/apps/{id}/ciProduct": { + "/v1/apps/{id}/betaGroups": { "get": { "tags": [ "Apps" ], - "operationId": "apps_ciProduct_getToOneRelated", + "operationId": "apps_betaGroups_getToManyRelated", "parameters": [ { - "name": "fields[ciProducts]", + "name": "fields[betaGroups]", "in": "query", - "description": "the fields to include for returned resources of type ciProducts", + "description": "the fields to include for returned resources of type betaGroups", "schema": { "type": "array", "items": { @@ -110756,13 +111521,21 @@ "enum": [ "name", "createdDate", - "productType", + "isInternalGroup", + "hasAccessToAllBuilds", + "publicLinkEnabled", + "publicLinkId", + "publicLinkLimitEnabled", + "publicLinkLimit", + "publicLink", + "feedbackEnabled", + "iosBuildsAvailableForAppleSiliconMac", + "iosBuildsAvailableForAppleVision", "app", - "bundleId", - "workflows", - "primaryRepositories", - "additionalRepositories", - "buildRuns" + "builds", + "betaTesters", + "betaRecruitmentCriteria", + "betaRecruitmentCriterionCompatibleBuildCheck" ] } }, @@ -110770,152 +111543,99 @@ "explode": false }, { - "name": "fields[apps]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "maximum resources per page", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "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" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" + "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" + } + } + } } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/relationships/betaLicenseAgreement": { + "get": { + "tags": [ + "Apps" ], + "operationId": "apps_betaLicenseAgreement_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -110958,11 +111678,11 @@ } }, "200": { - "description": "Single CiProduct", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiProductResponse" + "$ref": "#/components/schemas/AppBetaLicenseAgreementLinkageResponse" } } } @@ -110992,109 +111712,124 @@ } ] }, - "/v1/apps/{id}/customerReviewSummarizations": { + "/v1/apps/{id}/betaLicenseAgreement": { "get": { "tags": [ "Apps" ], - "operationId": "apps_customerReviewSummarizations_getToManyRelated", + "operationId": "apps_betaLicenseAgreement_getToOneRelated", "parameters": [ { - "name": "filter[platform]", + "name": "fields[betaLicenseAgreements]", "in": "query", - "description": "filter by attribute 'platform'", + "description": "the fields to include for returned resources of type betaLicenseAgreements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" + "agreementText", + "app" ] } }, "style": "form", - "explode": false, - "required": true + "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "name": "filter[territory]", - "in": "query", - "description": "filter by id(s) of related 'territory'", - "schema": { - "type": "array", - "items": { - "type": "string" + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" + "200": { + "description": "Single BetaLicenseAgreement with get", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BetaLicenseAgreementWithoutIncludesResponse" + } + } + } }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "territory" - ] + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/relationships/betaTesters": { + "delete": { + "tags": [ + "Apps" ], + "operationId": "apps_betaTesters_deleteToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppBetaTestersLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -111136,16 +111871,32 @@ } } }, - "200": { - "description": "List of CustomerReviewSummarizations", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerReviewSummarizationsResponse" + "$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": { @@ -111171,12 +111922,12 @@ } ] }, - "/v1/apps/{id}/relationships/customerReviews": { + "/v1/apps/{id}/relationships/buildUploads": { "get": { "tags": [ "Apps" ], - "operationId": "apps_customerReviews_getToManyRelationship", + "operationId": "apps_buildUploads_getToManyRelationship", "parameters": [ { "name": "limit", @@ -111235,7 +111986,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCustomerReviewsLinkagesResponse" + "$ref": "#/components/schemas/AppBuildUploadsLinkagesResponse" } } } @@ -111265,265 +112016,30 @@ } ] }, - "/v1/apps/{id}/customerReviews": { + "/v1/apps/{id}/buildUploads": { "get": { "tags": [ "Apps" ], - "operationId": "apps_customerReviews_getToManyRelated", + "operationId": "apps_buildUploads_getToManyRelated", "parameters": [ { - "name": "filter[territory]", + "name": "filter[cfBundleShortVersionString]", "in": "query", - "description": "filter by attribute 'territory'", + "description": "filter by attribute 'cfBundleShortVersionString'", "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" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "filter[rating]", + "name": "filter[cfBundleVersion]", "in": "query", - "description": "filter by attribute 'rating'", + "description": "filter by attribute 'cfBundleVersion'", "schema": { "type": "array", "items": { @@ -111534,24 +112050,33 @@ "explode": false }, { - "name": "filter[reviewTerritory]", + "name": "filter[platform]", "in": "query", - "description": "filter by id(s) of related 'reviewTerritory'", + "description": "filter by attribute 'platform'", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "IOS", + "MAC_OS", + "TV_OS", + "VISION_OS" + ] } }, "style": "form", "explode": false }, { - "name": "exists[publishedResponse]", + "name": "filter[state]", "in": "query", - "description": "filter by publishedResponse", + "description": "filter by state", "schema": { - "type": "boolean" + "type": "array", + "items": { + "type": "string" + } }, "style": "form", "explode": false @@ -111565,10 +112090,10 @@ "items": { "type": "string", "enum": [ - "rating", - "-rating", - "createdDate", - "-createdDate" + "cfBundleVersion", + "-cfBundleVersion", + "uploadedDate", + "-uploadedDate" ] } }, @@ -111576,22 +112101,25 @@ "explode": false }, { - "name": "fields[customerReviews]", + "name": "fields[buildUploads]", "in": "query", - "description": "the fields to include for returned resources of type customerReviews", + "description": "the fields to include for returned resources of type buildUploads", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "rating", - "title", - "body", - "reviewerNickname", + "cfBundleShortVersionString", + "cfBundleVersion", "createdDate", - "territory", - "response", - "reviewTerritory" + "state", + "platform", + "uploadedDate", + "build", + "assetFile", + "assetDescriptionFile", + "assetSpiFile", + "buildUploadFiles" ] } }, @@ -111599,18 +112127,40 @@ "explode": false }, { - "name": "fields[customerReviewResponses]", + "name": "fields[builds]", "in": "query", - "description": "the fields to include for returned resources of type customerReviewResponses", + "description": "the fields to include for returned resources of type builds", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "responseBody", - "lastModifiedDate", - "state", - "review" + "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" ] } }, @@ -111618,15 +112168,22 @@ "explode": false }, { - "name": "fields[territories]", + "name": "fields[buildUploadFiles]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type buildUploadFiles", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "assetDeliveryState", + "assetToken", + "assetType", + "fileName", + "fileSize", + "sourceFileChecksums", + "uploadOperations", + "uti" ] } }, @@ -111652,8 +112209,10 @@ "items": { "type": "string", "enum": [ - "response", - "reviewTerritory" + "build", + "assetFile", + "assetDescriptionFile", + "assetSpiFile" ] } }, @@ -111703,11 +112262,11 @@ } }, "200": { - "description": "List of CustomerReviews", + "description": "List of BuildUploads", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerReviewsResponse" + "$ref": "#/components/schemas/BuildUploadsResponse" } } } @@ -111737,13 +112296,24 @@ } ] }, - "/v1/apps/{id}/relationships/endUserLicenseAgreement": { + "/v1/apps/{id}/relationships/builds": { "get": { "tags": [ "Apps" ], - "operationId": "apps_endUserLicenseAgreement_getToOneRelationship", - "parameters": [], + "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)", @@ -111786,11 +112356,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppEndUserLicenseAgreementLinkageResponse" + "$ref": "#/components/schemas/AppBuildsLinkagesResponse" } } } @@ -111820,30 +112390,63 @@ } ] }, - "/v1/apps/{id}/endUserLicenseAgreement": { + "/v1/apps/{id}/builds": { "get": { "tags": [ "Apps" ], - "operationId": "apps_endUserLicenseAgreement_getToOneRelated", + "operationId": "apps_builds_getToManyRelated", "parameters": [ { - "name": "fields[endUserLicenseAgreements]", + "name": "fields[builds]", "in": "query", - "description": "the fields to include for returned resources of type endUserLicenseAgreements", + "description": "the fields to include for returned resources of type builds", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "agreementText", + "version", + "uploadedDate", + "expirationDate", + "expired", + "minOsVersion", + "lsMinimumSystemVersion", + "computedMinMacOsVersion", + "computedMinVisionOsVersion", + "iconAssetToken", + "processingState", + "buildAudienceType", + "usesNonExemptEncryption", + "preReleaseVersion", + "individualTesters", + "betaGroups", + "betaBuildLocalizations", + "appEncryptionDeclaration", + "betaAppReviewSubmission", "app", - "territories" + "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": { @@ -111888,11 +112491,11 @@ } }, "200": { - "description": "Single EndUserLicenseAgreement with get", + "description": "List of Builds with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EndUserLicenseAgreementWithoutIncludesResponse" + "$ref": "#/components/schemas/BuildsWithoutIncludesResponse" } } } @@ -111922,12 +112525,12 @@ } ] }, - "/v1/apps/{id}/relationships/gameCenterDetail": { + "/v1/apps/{id}/relationships/ciProduct": { "get": { "tags": [ "Apps" ], - "operationId": "apps_gameCenterDetail_getToOneRelationship", + "operationId": "apps_ciProduct_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -111975,7 +112578,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppGameCenterDetailLinkageResponse" + "$ref": "#/components/schemas/AppCiProductLinkageResponse" } } } @@ -112005,46 +112608,31 @@ } ] }, - "/v1/apps/{id}/gameCenterDetail": { + "/v1/apps/{id}/ciProduct": { "get": { "tags": [ "Apps" ], - "operationId": "apps_gameCenterDetail_getToOneRelated", + "operationId": "apps_ciProduct_getToOneRelated", "parameters": [ { - "name": "fields[gameCenterDetails]", + "name": "fields[ciProducts]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterDetails", + "description": "the fields to include for returned resources of type ciProducts", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "arcadeEnabled", - "challengeEnabled", + "name", + "createdDate", + "productType", "app", - "gameCenterAppVersions", - "gameCenterGroup", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges", - "defaultLeaderboard", - "defaultLeaderboardV2", - "defaultGroupLeaderboard", - "defaultGroupLeaderboardV2", - "achievementReleases", - "activityReleases", - "challengeReleases", - "leaderboardReleases", - "leaderboardSetReleases", - "blockedPlayers", - "challengesMinimumPlatformVersions" + "bundleId", + "workflows", + "primaryRepositories", + "additionalRepositories", + "buildRuns" ] } }, @@ -112093,6 +112681,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -112124,17 +112713,21 @@ "explode": false }, { - "name": "fields[gameCenterAppVersions]", + "name": "fields[bundleIds]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAppVersions", + "description": "the fields to include for returned resources of type bundleIds", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "enabled", - "compatibilityVersions", - "appStoreVersion" + "name", + "platform", + "identifier", + "seedId", + "profiles", + "bundleIdCapabilities", + "app" ] } }, @@ -112142,24 +112735,23 @@ "explode": false }, { - "name": "fields[gameCenterGroups]", + "name": "fields[scmRepositories]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterGroups", + "description": "the fields to include for returned resources of type scmRepositories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "gameCenterDetails", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges" + "lastAccessedDate", + "httpCloneUrl", + "sshCloneUrl", + "ownerName", + "repositoryName", + "scmProvider", + "defaultBranch", + "gitReferences", + "pullRequests" ] } }, @@ -112167,37 +112759,17 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboards]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "comma-separated list of relationships to include", "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", - "gameCenterScoreModerations", - "versions" + "app", + "bundleId", + "primaryRepositories" ] } }, @@ -112205,175 +112777,146 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSets]", + "name": "limit[primaryRepositories]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "maximum number of related primaryRepositories returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "referenceName", - "vendorIdentifier", - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboardSet", - "localizations", - "gameCenterLeaderboards", - "releases", - "versions" - ] - } + "type": "integer", + "maximum": 50 }, - "style": "form", - "explode": false + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "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" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "200": { + "description": "Single CiProduct", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CiProductResponse" + } } - }, - "style": "form", - "explode": false + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/customerReviewSummarizations": { + "get": { + "tags": [ + "Apps" + ], + "operationId": "apps_customerReviewSummarizations_getToManyRelated", + "parameters": [ { - "name": "fields[gameCenterActivityVersionReleases]", + "name": "filter[platform]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityVersionReleases", + "description": "filter by attribute 'platform'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version" + "IOS", + "MAC_OS", + "TV_OS", + "VISION_OS" ] } }, "style": "form", - "explode": false + "explode": false, + "required": true }, { - "name": "fields[gameCenterChallengeVersionReleases]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeVersionReleases", + "description": "filter by id(s) of related 'territory'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "version" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[gameCenterLeaderboardReleases]", + "name": "fields[customerReviewSummarizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardReleases", + "description": "the fields to include for returned resources of type customerReviewSummarizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", - "gameCenterDetail", - "gameCenterLeaderboard" + "createdDate", + "locale", + "platform", + "text", + "territory" ] } }, @@ -112381,17 +112924,15 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetReleases]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetReleases", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", - "gameCenterDetail", - "gameCenterLeaderboardSet" + "currency" ] } }, @@ -112399,43 +112940,14 @@ "explode": false }, { - "name": "fields[appStoreVersions]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "maximum resources per page", "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" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { "name": "include", @@ -112446,190 +112958,12 @@ "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" + "territory" ] } }, "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": { @@ -112674,11 +113008,11 @@ } }, "200": { - "description": "Single GameCenterDetail", + "description": "List of CustomerReviewSummarizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailResponse" + "$ref": "#/components/schemas/CustomerReviewSummarizationsResponse" } } } @@ -112708,13 +113042,12 @@ } ] }, - "/v1/apps/{id}/relationships/gameCenterEnabledVersions": { + "/v1/apps/{id}/relationships/customerReviews": { "get": { "tags": [ "Apps" ], - "operationId": "apps_gameCenterEnabledVersions_getToManyRelationship", - "deprecated": true, + "operationId": "apps_customerReviews_getToManyRelationship", "parameters": [ { "name": "limit", @@ -112773,7 +113106,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppGameCenterEnabledVersionsLinkagesResponse" + "$ref": "#/components/schemas/AppCustomerReviewsLinkagesResponse" } } } @@ -112803,27 +113136,255 @@ } ] }, - "/v1/apps/{id}/gameCenterEnabledVersions": { + "/v1/apps/{id}/customerReviews": { "get": { "tags": [ "Apps" ], - "operationId": "apps_gameCenterEnabledVersions_getToManyRelated", - "deprecated": true, + "operationId": "apps_customerReviews_getToManyRelated", "parameters": [ { - "name": "filter[platform]", + "name": "filter[territory]", "in": "query", - "description": "filter by attribute 'platform'", + "description": "filter by attribute 'territory'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" + "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" ] } }, @@ -112831,9 +113392,9 @@ "explode": false }, { - "name": "filter[versionString]", + "name": "filter[rating]", "in": "query", - "description": "filter by attribute 'versionString'", + "description": "filter by attribute 'rating'", "schema": { "type": "array", "items": { @@ -112844,9 +113405,9 @@ "explode": false }, { - "name": "filter[id]", + "name": "filter[reviewTerritory]", "in": "query", - "description": "filter by id(s)", + "description": "filter by id(s) of related 'reviewTerritory'", "schema": { "type": "array", "items": { @@ -112856,6 +113417,16 @@ "style": "form", "explode": false }, + { + "name": "exists[publishedResponse]", + "in": "query", + "description": "filter by publishedResponse", + "schema": { + "type": "boolean" + }, + "style": "form", + "explode": false + }, { "name": "sort", "in": "query", @@ -112865,8 +113436,10 @@ "items": { "type": "string", "enum": [ - "versionString", - "-versionString" + "rating", + "-rating", + "createdDate", + "-createdDate" ] } }, @@ -112874,19 +113447,22 @@ "explode": false }, { - "name": "fields[gameCenterEnabledVersions]", + "name": "fields[customerReviews]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterEnabledVersions", + "description": "the fields to include for returned resources of type customerReviews", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platform", - "versionString", - "iconAsset", - "compatibleVersions", - "app" + "rating", + "title", + "body", + "reviewerNickname", + "createdDate", + "territory", + "response", + "reviewTerritory" ] } }, @@ -112894,71 +113470,34 @@ "explode": false }, { - "name": "fields[apps]", + "name": "fields[customerReviewResponses]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "the fields to include for returned resources of type customerReviewResponses", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" + "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" ] } }, @@ -112984,24 +113523,13 @@ "items": { "type": "string", "enum": [ - "compatibleVersions", - "app" + "response", + "reviewTerritory" ] } }, "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": { @@ -113046,11 +113574,11 @@ } }, "200": { - "description": "List of GameCenterEnabledVersions", + "description": "List of CustomerReviews", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterEnabledVersionsResponse" + "$ref": "#/components/schemas/CustomerReviewsResponse" } } } @@ -113080,25 +113608,13 @@ } ] }, - "/v1/apps/{id}/relationships/inAppPurchases": { + "/v1/apps/{id}/relationships/endUserLicenseAgreement": { "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" - } - ], + "operationId": "apps_endUserLicenseAgreement_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -113141,11 +113657,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInAppPurchasesLinkagesResponse" + "$ref": "#/components/schemas/AppEndUserLicenseAgreementLinkageResponse" } } } @@ -113175,195 +113691,30 @@ } ] }, - "/v1/apps/{id}/inAppPurchases": { + "/v1/apps/{id}/endUserLicenseAgreement": { "get": { "tags": [ "Apps" ], - "operationId": "apps_inAppPurchases_getToManyRelated", - "deprecated": true, + "operationId": "apps_endUserLicenseAgreement_getToOneRelated", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "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", + "name": "fields[endUserLicenseAgreements]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type endUserLicenseAgreements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "apps" + "agreementText", + "app", + "territories" ] } }, "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": { @@ -113408,11 +113759,11 @@ } }, "200": { - "description": "List of InAppPurchases", + "description": "Single EndUserLicenseAgreement with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasesResponse" + "$ref": "#/components/schemas/EndUserLicenseAgreementWithoutIncludesResponse" } } } @@ -113442,24 +113793,13 @@ } ] }, - "/v1/apps/{id}/relationships/inAppPurchasesV2": { + "/v1/apps/{id}/relationships/gameCenterDetail": { "get": { "tags": [ "Apps" ], - "operationId": "apps_inAppPurchasesV2_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "operationId": "apps_gameCenterDetail_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -113502,11 +113842,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppInAppPurchasesV2LinkagesResponse" + "$ref": "#/components/schemas/AppGameCenterDetailLinkageResponse" } } } @@ -113536,60 +113876,46 @@ } ] }, - "/v1/apps/{id}/inAppPurchasesV2": { + "/v1/apps/{id}/gameCenterDetail": { "get": { "tags": [ "Apps" ], - "operationId": "apps_inAppPurchasesV2_getToManyRelated", + "operationId": "apps_gameCenterDetail_getToOneRelated", "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]", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "filter by attribute 'state'", + "description": "the fields to include for returned resources of type gameCenterDetails", "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" + "arcadeEnabled", + "challengeEnabled", + "app", + "gameCenterAppVersions", + "gameCenterGroup", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges", + "defaultLeaderboard", + "defaultLeaderboardV2", + "defaultGroupLeaderboard", + "defaultGroupLeaderboardV2", + "achievementReleases", + "activityReleases", + "challengeReleases", + "leaderboardReleases", + "leaderboardSetReleases", + "blockedPlayers", + "challengesMinimumPlatformVersions" ] } }, @@ -113597,17 +113923,72 @@ "explode": false }, { - "name": "filter[inAppPurchaseType]", + "name": "fields[apps]", "in": "query", - "description": "filter by attribute 'inAppPurchaseType'", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "CONSUMABLE", - "NON_CONSUMABLE", - "NON_RENEWING_SUBSCRIPTION" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, @@ -113615,18 +113996,17 @@ "explode": false }, { - "name": "sort", + "name": "fields[gameCenterAppVersions]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type gameCenterAppVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "-name", - "inAppPurchaseType", - "-inAppPurchaseType" + "enabled", + "compatibilityVersions", + "appStoreVersion" ] } }, @@ -113634,30 +114014,61 @@ "explode": false }, { - "name": "fields[inAppPurchases]", + "name": "fields[gameCenterGroups]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchases", + "description": "the fields to include for returned resources of type gameCenterGroups", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "inAppPurchaseType", - "state", - "reviewNote", - "familySharable", - "contentHosting", - "inAppPurchaseLocalizations", - "pricePoints", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", + "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", + "gameCenterScoreModerations", "versions" ] } @@ -113666,19 +114077,23 @@ "explode": false }, { - "name": "fields[inAppPurchaseLocalizations]", + "name": "fields[gameCenterLeaderboardSets]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseLocalizations", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "locale", - "description", - "state", - "inAppPurchaseV2" + "referenceName", + "vendorIdentifier", + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboardSet", + "localizations", + "gameCenterLeaderboards", + "releases", + "versions" ] } }, @@ -113686,19 +114101,28 @@ "explode": false }, { - "name": "fields[inAppPurchaseContents]", + "name": "fields[gameCenterAchievements]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseContents", + "description": "the fields to include for returned resources of type gameCenterAchievements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileName", - "fileSize", - "url", - "lastModifiedDate", - "inAppPurchaseV2" + "referenceName", + "vendorIdentifier", + "points", + "showBeforeEarned", + "repeatable", + "archived", + "activityProperties", + "gameCenterDetail", + "gameCenterGroup", + "groupAchievement", + "localizations", + "releases", + "activity", + "versions" ] } }, @@ -113706,23 +114130,29 @@ "explode": false }, { - "name": "fields[inAppPurchaseAppStoreReviewScreenshots]", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseAppStoreReviewScreenshots", + "description": "the fields to include for returned resources of type gameCenterActivities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "imageAsset", - "assetToken", - "assetType", - "uploadOperations", - "assetDeliveryState", - "inAppPurchaseV2" + "referenceName", + "vendorIdentifier", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", + "archived", + "properties", + "gameCenterDetail", + "gameCenterGroup", + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" ] } }, @@ -113730,19 +114160,24 @@ "explode": false }, { - "name": "fields[promotedPurchases]", + "name": "fields[gameCenterChallenges]", "in": "query", - "description": "the fields to include for returned resources of type promotedPurchases", + "description": "the fields to include for returned resources of type gameCenterChallenges", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "visibleForAllUsers", - "enabled", - "state", - "inAppPurchaseV2", - "subscription" + "referenceName", + "vendorIdentifier", + "archived", + "challengeType", + "repeatable", + "gameCenterDetail", + "gameCenterGroup", + "versions", + "leaderboard", + "leaderboardV2" ] } }, @@ -113750,17 +114185,17 @@ "explode": false }, { - "name": "fields[inAppPurchasePriceSchedules]", + "name": "fields[gameCenterAchievementReleases]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchasePriceSchedules", + "description": "the fields to include for returned resources of type gameCenterAchievementReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "baseTerritory", - "manualPrices", - "automaticPrices" + "live", + "gameCenterDetail", + "gameCenterAchievement" ] } }, @@ -113768,16 +114203,15 @@ "explode": false }, { - "name": "fields[inAppPurchaseAvailabilities]", + "name": "fields[gameCenterActivityVersionReleases]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseAvailabilities", + "description": "the fields to include for returned resources of type gameCenterActivityVersionReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "availableInNewTerritories", - "availableTerritories" + "version" ] } }, @@ -113785,22 +114219,15 @@ "explode": false }, { - "name": "fields[inAppPurchaseImages]", + "name": "fields[gameCenterChallengeVersionReleases]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseImages", + "description": "the fields to include for returned resources of type gameCenterChallengeVersionReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "assetToken", - "imageAsset", - "uploadOperations", - "state", - "inAppPurchase" + "version" ] } }, @@ -113808,22 +114235,17 @@ "explode": false }, { - "name": "fields[inAppPurchaseOfferCodes]", + "name": "fields[gameCenterLeaderboardReleases]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseOfferCodes", + "description": "the fields to include for returned resources of type gameCenterLeaderboardReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "customerEligibilities", - "productionCodeCount", - "sandboxCodeCount", - "active", - "oneTimeUseCodes", - "customCodes", - "prices" + "live", + "gameCenterDetail", + "gameCenterLeaderboard" ] } }, @@ -113831,20 +114253,17 @@ "explode": false }, { - "name": "fields[inAppPurchaseVersions]", + "name": "fields[gameCenterLeaderboardSetReleases]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseVersions", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "inAppPurchase", - "image", - "images", - "localizations" + "live", + "gameCenterDetail", + "gameCenterLeaderboardSet" ] } }, @@ -113852,14 +114271,43 @@ "explode": false }, { - "name": "limit", + "name": "fields[appStoreVersions]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { - "type": "integer", - "maximum": 200 + "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" + "style": "form", + "explode": false }, { "name": "include", @@ -113870,15 +114318,27 @@ "items": { "type": "string", "enum": [ - "inAppPurchaseLocalizations", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", - "versions" + "app", + "gameCenterAppVersions", + "gameCenterGroup", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges", + "defaultLeaderboard", + "defaultLeaderboardV2", + "defaultGroupLeaderboard", + "defaultGroupLeaderboardV2", + "achievementReleases", + "activityReleases", + "challengeReleases", + "leaderboardReleases", + "leaderboardSetReleases", + "challengesMinimumPlatformVersions" ] } }, @@ -113886,9 +114346,9 @@ "explode": false }, { - "name": "limit[inAppPurchaseLocalizations]", + "name": "limit[gameCenterAppVersions]", "in": "query", - "description": "maximum number of related inAppPurchaseLocalizations returned (when they are included)", + "description": "maximum number of related gameCenterAppVersions returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -113896,9 +114356,20 @@ "style": "form" }, { - "name": "limit[images]", + "name": "limit[gameCenterLeaderboards]", "in": "query", - "description": "maximum number of related images returned (when they are included)", + "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 @@ -113906,9 +114377,20 @@ "style": "form" }, { - "name": "limit[offerCodes]", + "name": "limit[gameCenterLeaderboardSets]", "in": "query", - "description": "maximum number of related offerCodes returned (when they are included)", + "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 @@ -113916,9 +114398,105 @@ "style": "form" }, { - "name": "limit[versions]", + "name": "limit[gameCenterAchievements]", "in": "query", - "description": "maximum number of related versions returned (when they are included)", + "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 @@ -113968,11 +114546,11 @@ } }, "200": { - "description": "List of InAppPurchases", + "description": "Single GameCenterDetail", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasesV2Response" + "$ref": "#/components/schemas/GameCenterDetailResponse" } } } @@ -114002,13 +114580,25 @@ } ] }, - "/v1/apps/{id}/relationships/marketplaceSearchDetail": { + "/v1/apps/{id}/relationships/gameCenterEnabledVersions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_marketplaceSearchDetail_getToOneRelationship", - "parameters": [], + "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)", @@ -114051,11 +114641,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMarketplaceSearchDetailLinkageResponse" + "$ref": "#/components/schemas/AppGameCenterEnabledVersionsLinkagesResponse" } } } @@ -114085,28 +114675,206 @@ } ] }, - "/v1/apps/{id}/marketplaceSearchDetail": { + "/v1/apps/{id}/gameCenterEnabledVersions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_marketplaceSearchDetail_getToOneRelated", + "operationId": "apps_gameCenterEnabledVersions_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[marketplaceSearchDetails]", + "name": "filter[platform]", "in": "query", - "description": "the fields to include for returned resources of type marketplaceSearchDetails", + "description": "filter by attribute 'platform'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "catalogUrl" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "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": { @@ -114151,11 +114919,11 @@ } }, "200": { - "description": "Single MarketplaceSearchDetail", + "description": "List of GameCenterEnabledVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MarketplaceSearchDetailResponse" + "$ref": "#/components/schemas/GameCenterEnabledVersionsResponse" } } } @@ -114185,64 +114953,23 @@ } ] }, - "/v1/apps/{id}/perfPowerMetrics": { + "/v1/apps/{id}/relationships/inAppPurchases": { "get": { "tags": [ "Apps" ], - "operationId": "apps_perfPowerMetrics_getToManyRelated", + "operationId": "apps_inAppPurchases_getToManyRelationship", + "deprecated": true, "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", - "STORAGE" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[deviceType]", + "name": "limit", "in": "query", - "description": "filter by attribute 'deviceType'", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string" - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" } ], "responses": { @@ -114287,11 +115014,11 @@ } }, "200": { - "description": "List of PerfPowerMetrics", + "description": "List of related linkages", "content": { - "application/vnd.apple.xcode-metrics+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/xcodeMetrics" + "$ref": "#/components/schemas/AppInAppPurchasesLinkagesResponse" } } } @@ -114321,17 +115048,38 @@ } ] }, - "/v1/apps/{id}/performanceOverviews": { + "/v1/apps/{id}/inAppPurchases": { "get": { "tags": [ "Apps" ], - "operationId": "apps_performanceOverviews_getToManyRelated", + "operationId": "apps_inAppPurchases_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "filter[deviceType]", + "name": "filter[inAppPurchaseType]", "in": "query", - "description": "filter by attribute 'deviceType'", + "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": { @@ -114340,6 +115088,156 @@ }, "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "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": { @@ -114384,11 +115282,11 @@ } }, "200": { - "description": "List of PerformanceOverviews", + "description": "List of InAppPurchases", "content": { - "application/vnd.apple.xcode-overview+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/xcodeOverview" + "$ref": "#/components/schemas/InAppPurchasesResponse" } } } @@ -114418,12 +115316,12 @@ } ] }, - "/v1/apps/{id}/relationships/preReleaseVersions": { + "/v1/apps/{id}/relationships/inAppPurchasesV2": { "get": { "tags": [ "Apps" ], - "operationId": "apps_preReleaseVersions_getToManyRelationship", + "operationId": "apps_inAppPurchasesV2_getToManyRelationship", "parameters": [ { "name": "limit", @@ -114482,7 +115380,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPreReleaseVersionsLinkagesResponse" + "$ref": "#/components/schemas/AppInAppPurchasesV2LinkagesResponse" } } } @@ -114512,42 +115410,395 @@ } ] }, - "/v1/apps/{id}/preReleaseVersions": { + "/v1/apps/{id}/inAppPurchasesV2": { "get": { "tags": [ "Apps" ], - "operationId": "apps_preReleaseVersions_getToManyRelated", + "operationId": "apps_inAppPurchasesV2_getToManyRelated", "parameters": [ { - "name": "fields[preReleaseVersions]", + "name": "filter[productId]", "in": "query", - "description": "the fields to include for returned resources of type preReleaseVersions", + "description": "filter by attribute 'productId'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "version", - "platform", - "builds", - "app" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "limit", + "name": "filter[name]", "in": "query", - "description": "maximum resources per page", + "description": "filter by attribute 'name'", "schema": { - "type": "integer", - "maximum": 200 + "type": "array", + "items": { + "type": "string" + } }, - "style": "form" - } + "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", + "versions" + ] + } + }, + "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": "fields[inAppPurchaseVersions]", + "in": "query", + "description": "the fields to include for returned resources of type inAppPurchaseVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "inAppPurchase", + "image", + "images", + "localizations" + ] + } + }, + "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", + "versions" + ] + } + }, + "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" + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + } ], "responses": { "400": { @@ -114591,11 +115842,11 @@ } }, "200": { - "description": "List of PreReleaseVersions with get", + "description": "List of InAppPurchases", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PreReleaseVersionsWithoutIncludesResponse" + "$ref": "#/components/schemas/InAppPurchasesV2Response" } } } @@ -114625,24 +115876,13 @@ } ] }, - "/v1/apps/{id}/relationships/promotedPurchases": { + "/v1/apps/{id}/relationships/marketplaceSearchDetail": { "get": { "tags": [ "Apps" ], - "operationId": "apps_promotedPurchases_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "operationId": "apps_marketplaceSearchDetail_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -114685,11 +115925,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppPromotedPurchasesLinkagesResponse" + "$ref": "#/components/schemas/AppMarketplaceSearchDetailLinkageResponse" } } } @@ -114706,22 +115946,43 @@ } } }, - "patch": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/marketplaceSearchDetail": { + "get": { "tags": [ "Apps" ], - "operationId": "apps_promotedPurchases_replaceToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppPromotedPurchasesLinkagesRequest" + "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" + ] } - } - }, - "required": true - }, + }, + "style": "form", + "explode": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -114763,29 +116024,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Single MarketplaceSearchDetail", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/MarketplaceSearchDetailResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -114811,59 +116059,23 @@ } ] }, - "/v1/apps/{id}/promotedPurchases": { + "/v1/apps/{id}/perfPowerMetrics": { "get": { "tags": [ "Apps" ], - "operationId": "apps_promotedPurchases_getToManyRelated", + "operationId": "apps_perfPowerMetrics_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]", + "name": "filter[platform]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchases", + "description": "filter by attribute 'platform'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "inAppPurchaseType", - "state", - "reviewNote", - "familySharable", - "contentHosting", - "inAppPurchaseLocalizations", - "pricePoints", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", - "versions" + "IOS" ] } }, @@ -114871,37 +116083,22 @@ "explode": false }, { - "name": "fields[subscriptions]", + "name": "filter[metricType]", "in": "query", - "description": "the fields to include for returned resources of type subscriptions", + "description": "filter by attribute 'metricType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "familySharable", - "state", - "subscriptionPeriod", - "reviewNote", - "groupLevel", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" + "DISK", + "HANG", + "BATTERY", + "LAUNCH", + "MEMORY", + "ANIMATION", + "TERMINATION", + "STORAGE" ] } }, @@ -114909,27 +116106,13 @@ "explode": false }, { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, - { - "name": "include", + "name": "filter[deviceType]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "filter by attribute 'deviceType'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "inAppPurchaseV2", - "subscription" - ] + "type": "string" } }, "style": "form", @@ -114978,11 +116161,11 @@ } }, "200": { - "description": "List of PromotedPurchases", + "description": "List of PerfPowerMetrics", "content": { - "application/json": { + "application/vnd.apple.xcode-metrics+json": { "schema": { - "$ref": "#/components/schemas/PromotedPurchasesResponse" + "$ref": "#/components/schemas/xcodeMetrics" } } } @@ -115012,22 +116195,25 @@ } ] }, - "/v1/apps/{id}/relationships/reviewSubmissions": { + "/v1/apps/{id}/performanceOverviews": { "get": { "tags": [ "Apps" ], - "operationId": "apps_reviewSubmissions_getToManyRelationship", + "operationId": "apps_performanceOverviews_getToManyRelated", "parameters": [ { - "name": "limit", + "name": "filter[deviceType]", "in": "query", - "description": "maximum resources per page", + "description": "filter by attribute 'deviceType'", "schema": { - "type": "integer", - "maximum": 200 + "type": "array", + "items": { + "type": "string" + } }, - "style": "form" + "style": "form", + "explode": false } ], "responses": { @@ -115072,11 +116258,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "List of PerformanceOverviews", "content": { - "application/json": { + "application/vnd.apple.xcode-overview+json": { "schema": { - "$ref": "#/components/schemas/AppReviewSubmissionsLinkagesResponse" + "$ref": "#/components/schemas/xcodeOverview" } } } @@ -115106,240 +116292,13 @@ } ] }, - "/v1/apps/{id}/reviewSubmissions": { + "/v1/apps/{id}/relationships/preReleaseVersions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_reviewSubmissions_getToManyRelated", + "operationId": "apps_preReleaseVersions_getToManyRelationship", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "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", - "appAssetLibraryImage", - "appAssetLibraryVideo", - "backgroundAssetVersion", - "gameCenterAchievementVersion", - "gameCenterActivityVersion", - "gameCenterChallengeVersion", - "gameCenterLeaderboardSetVersion", - "gameCenterLeaderboardVersion", - "inAppPurchaseVersion", - "subscriptionVersion", - "subscriptionGroupVersion" - ] - } - }, - "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", @@ -115349,36 +116308,6 @@ "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": { @@ -115423,11 +116352,11 @@ } }, "200": { - "description": "List of ReviewSubmissions", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReviewSubmissionsResponse" + "$ref": "#/components/schemas/AppPreReleaseVersionsLinkagesResponse" } } } @@ -115457,13 +116386,32 @@ } ] }, - "/v1/apps/{id}/relationships/searchKeywords": { + "/v1/apps/{id}/preReleaseVersions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_searchKeywords_getToManyRelationship", + "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", @@ -115517,11 +116465,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "List of PreReleaseVersions with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppSearchKeywordsLinkagesResponse" + "$ref": "#/components/schemas/PreReleaseVersionsWithoutIncludesResponse" } } } @@ -115551,53 +116499,13 @@ } ] }, - "/v1/apps/{id}/searchKeywords": { + "/v1/apps/{id}/relationships/promotedPurchases": { "get": { "tags": [ "Apps" ], - "operationId": "apps_searchKeywords_getToManyRelated", + "operationId": "apps_promotedPurchases_getToManyRelationship", "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", @@ -115651,11 +116559,11 @@ } }, "200": { - "description": "List of AppKeywords", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppKeywordsResponse" + "$ref": "#/components/schemas/AppPromotedPurchasesLinkagesResponse" } } } @@ -115672,26 +116580,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/apps/{id}/relationships/subscriptionGracePeriod": { - "get": { + "patch": { "tags": [ "Apps" ], - "operationId": "apps_subscriptionGracePeriod_getToOneRelationship", - "parameters": [], + "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)", @@ -115733,16 +116637,29 @@ } } }, - "200": { - "description": "Related linkage", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppSubscriptionGracePeriodLinkageResponse" + "$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": { @@ -115768,80 +116685,181 @@ } ] }, - "/v1/apps/{id}/subscriptionGracePeriod": { + "/v1/apps/{id}/promotedPurchases": { "get": { "tags": [ "Apps" ], - "operationId": "apps_subscriptionGracePeriod_getToOneRelated", + "operationId": "apps_promotedPurchases_getToManyRelated", "parameters": [ { - "name": "fields[subscriptionGracePeriods]", + "name": "fields[promotedPurchases]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGracePeriods", + "description": "the fields to include for returned resources of type promotedPurchases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "optIn", - "sandboxOptIn", - "duration", - "renewalType" + "visibleForAllUsers", + "enabled", + "state", + "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" - } - } - } + { + "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", + "versions" + ] + } + }, + "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", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] + } + }, + "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": "Single SubscriptionGracePeriod", + "description": "List of PromotedPurchases", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGracePeriodResponse" + "$ref": "#/components/schemas/PromotedPurchasesResponse" } } } @@ -115871,12 +116889,12 @@ } ] }, - "/v1/apps/{id}/relationships/subscriptionGroups": { + "/v1/apps/{id}/relationships/retentionMessages": { "get": { "tags": [ "Apps" ], - "operationId": "apps_subscriptionGroups_getToManyRelationship", + "operationId": "apps_retentionMessages_getToManyRelationship", "parameters": [ { "name": "limit", @@ -115935,7 +116953,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppSubscriptionGroupsLinkagesResponse" + "$ref": "#/components/schemas/AppRetentionMessagesLinkagesResponse" } } } @@ -115965,62 +116983,25 @@ } ] }, - "/v1/apps/{id}/subscriptionGroups": { + "/v1/apps/{id}/retentionMessages": { "get": { "tags": [ "Apps" ], - "operationId": "apps_subscriptionGroups_getToManyRelated", + "operationId": "apps_retentionMessages_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", + "name": "fields[retentionMessages]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type retentionMessages", "schema": { "type": "array", "items": { "type": "string", "enum": [ "referenceName", - "-referenceName" + "versions", + "subscriptions" ] } }, @@ -116028,18 +117009,18 @@ "explode": false }, { - "name": "fields[subscriptionGroups]", + "name": "fields[retentionMessageVersions]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroups", + "description": "the fields to include for returned resources of type retentionMessageVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "subscriptions", - "subscriptionGroupLocalizations", - "versions" + "state", + "retentionMessage", + "localizations", + "placement" ] } }, @@ -116077,46 +117058,10 @@ "winBackOffers", "images", "planAvailabilities", - "versions" - ] - } - }, - "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": "fields[subscriptionGroupVersions]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "subscriptionGroup", - "localizations" + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -116142,9 +117087,8 @@ "items": { "type": "string", "enum": [ - "subscriptions", - "subscriptionGroupLocalizations", - "versions" + "versions", + "subscriptions" ] } }, @@ -116152,19 +117096,9 @@ "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]", + "name": "limit[versions]", "in": "query", - "description": "maximum number of related subscriptionGroupLocalizations returned (when they are included)", + "description": "maximum number of related versions returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -116172,9 +117106,9 @@ "style": "form" }, { - "name": "limit[versions]", + "name": "limit[subscriptions]", "in": "query", - "description": "maximum number of related versions returned (when they are included)", + "description": "maximum number of related subscriptions returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -116224,11 +117158,11 @@ } }, "200": { - "description": "List of SubscriptionGroups", + "description": "List of RetentionMessages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupsResponse" + "$ref": "#/components/schemas/RetentionMessagesResponse" } } } @@ -116258,12 +117192,12 @@ } ] }, - "/v1/apps/{id}/relationships/webhooks": { + "/v1/apps/{id}/relationships/reviewSubmissions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_webhooks_getToManyRelationship", + "operationId": "apps_reviewSubmissions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -116322,7 +117256,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppWebhooksLinkagesResponse" + "$ref": "#/components/schemas/AppReviewSubmissionsLinkagesResponse" } } } @@ -116352,28 +117286,71 @@ } ] }, - "/v1/apps/{id}/webhooks": { + "/v1/apps/{id}/reviewSubmissions": { "get": { "tags": [ "Apps" ], - "operationId": "apps_webhooks_getToManyRelated", + "operationId": "apps_reviewSubmissions_getToManyRelated", "parameters": [ { - "name": "fields[webhooks]", + "name": "filter[platform]", "in": "query", - "description": "the fields to include for returned resources of type webhooks", + "description": "filter by attribute 'platform'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "enabled", - "eventTypes", - "name", - "url", + "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", - "deliveries" + "items", + "appStoreVersionForReview", + "submittedByActor", + "lastUpdatedByActor" ] } }, @@ -116422,6 +117399,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -116452,6 +117430,98 @@ "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", + "appAssetLibraryImage", + "appAssetLibraryVideo", + "backgroundAssetVersion", + "gameCenterAchievementVersion", + "gameCenterActivityVersion", + "gameCenterChallengeVersion", + "gameCenterLeaderboardSetVersion", + "gameCenterLeaderboardVersion", + "inAppPurchaseVersion", + "subscriptionVersion", + "subscriptionGroupVersion", + "retentionMessageVersion" + ] + } + }, + "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", @@ -116471,12 +117541,26 @@ "items": { "type": "string", "enum": [ - "app" + "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": { @@ -116521,11 +117605,11 @@ } }, "200": { - "description": "List of Webhooks", + "description": "List of ReviewSubmissions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhooksResponse" + "$ref": "#/components/schemas/ReviewSubmissionsResponse" } } } @@ -116555,12 +117639,12 @@ } ] }, - "/v1/backgroundAssetVersions/{id}/relationships/backgroundAssetUploadFiles": { + "/v1/apps/{id}/relationships/searchKeywords": { "get": { "tags": [ - "BackgroundAssetVersions" + "Apps" ], - "operationId": "backgroundAssetVersions_backgroundAssetUploadFiles_getToManyRelationship", + "operationId": "apps_searchKeywords_getToManyRelationship", "parameters": [ { "name": "limit", @@ -116619,7 +117703,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BackgroundAssetVersionBackgroundAssetUploadFilesLinkagesResponse" + "$ref": "#/components/schemas/AppSearchKeywordsLinkagesResponse" } } } @@ -116649,31 +117733,48 @@ } ] }, - "/v1/backgroundAssetVersions/{id}/backgroundAssetUploadFiles": { + "/v1/apps/{id}/searchKeywords": { "get": { "tags": [ - "BackgroundAssetVersions" + "Apps" ], - "operationId": "backgroundAssetVersions_backgroundAssetUploadFiles_getToManyRelated", + "operationId": "apps_searchKeywords_getToManyRelated", "parameters": [ { - "name": "fields[backgroundAssetUploadFiles]", + "name": "filter[platform]", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssetUploadFiles", + "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": [ - "assetDeliveryState", - "assetToken", - "assetType", - "fileName", - "fileSize", - "sourceFileChecksum", - "sourceFileChecksums", - "uploadOperations" - ] + "enum": [] } }, "style": "form", @@ -116732,11 +117833,11 @@ } }, "200": { - "description": "List of BackgroundAssetUploadFiles", + "description": "List of AppKeywords", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BackgroundAssetUploadFilesResponse" + "$ref": "#/components/schemas/AppKeywordsResponse" } } } @@ -116766,24 +117867,13 @@ } ] }, - "/v1/backgroundAssets/{id}/relationships/versions": { + "/v1/apps/{id}/relationships/subscriptionGracePeriod": { "get": { "tags": [ - "BackgroundAssets" - ], - "operationId": "backgroundAssets_versions_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "Apps" ], + "operationId": "apps_subscriptionGracePeriod_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -116826,11 +117916,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BackgroundAssetVersionsLinkagesResponse" + "$ref": "#/components/schemas/AppSubscriptionGracePeriodLinkageResponse" } } } @@ -116860,134 +117950,242 @@ } ] }, - "/v1/backgroundAssets/{id}/versions": { + "/v1/apps/{id}/subscriptionGracePeriod": { "get": { "tags": [ - "BackgroundAssets" + "Apps" ], - "operationId": "backgroundAssets_versions_getToManyRelated", + "operationId": "apps_subscriptionGracePeriod_getToOneRelated", "parameters": [ { - "name": "filter[locale]", - "in": "query", - "description": "filter by attribute 'locale'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[platforms]", + "name": "fields[subscriptionGracePeriods]", "in": "query", - "description": "filter by attribute 'platforms'", + "description": "the fields to include for returned resources of type subscriptionGracePeriods", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" + "optIn", + "sandboxOptIn", + "duration", + "renewalType" ] } }, "style": "form", "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "name": "filter[state]", - "in": "query", - "description": "filter by attribute 'state'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "AWAITING_UPLOAD", - "PROCESSING", - "FAILED", - "COMPLETE" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "filter[version]", - "in": "query", - "description": "filter by attribute 'version'", - "schema": { - "type": "array", - "items": { - "type": "string" + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } + }, + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/relationships/subscriptionGroups": { + "get": { + "tags": [ + "Apps" + ], + "operationId": "apps_subscriptionGroups_getToManyRelationship", + "parameters": [ { - "name": "filter[internalBetaRelease.state]", + "name": "limit", "in": "query", - "description": "filter by attribute 'internalBetaRelease.state'", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "READY_FOR_TESTING", - "SUPERSEDED" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/apps/{id}/subscriptionGroups": { + "get": { + "tags": [ + "Apps" + ], + "operationId": "apps_subscriptionGroups_getToManyRelated", + "parameters": [ { - "name": "filter[externalBetaRelease.state]", + "name": "filter[referenceName]", "in": "query", - "description": "filter by attribute 'externalBetaRelease.state'", + "description": "filter by attribute 'referenceName'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "READY_FOR_BETA_SUBMISSION", - "WAITING_FOR_REVIEW", - "IN_REVIEW", - "REJECTED", - "PROCESSING_FOR_TESTING", - "READY_FOR_TESTING", - "SUPERSEDED" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "filter[appStoreRelease.state]", + "name": "filter[subscriptions.state]", "in": "query", - "description": "filter by attribute 'appStoreRelease.state'", + "description": "filter by attribute 'subscriptions.state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "PREPARE_FOR_SUBMISSION", - "READY_FOR_REVIEW", + "MISSING_METADATA", + "READY_TO_SUBMIT", "WAITING_FOR_REVIEW", "IN_REVIEW", - "ACCEPTED", - "REJECTED", - "PROCESSING_FOR_DISTRIBUTION", - "READY_FOR_DISTRIBUTION", - "SUPERSEDED" + "DEVELOPER_ACTION_NEEDED", + "PENDING_BINARY_APPROVAL", + "APPROVED", + "DEVELOPER_REMOVED_FROM_SALE", + "REMOVED_FROM_SALE", + "REJECTED" ] } }, @@ -117003,8 +118201,8 @@ "items": { "type": "string", "enum": [ - "version", - "-version" + "referenceName", + "-referenceName" ] } }, @@ -117012,27 +118210,18 @@ "explode": false }, { - "name": "fields[backgroundAssetVersions]", + "name": "fields[subscriptionGroups]", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssetVersions", + "description": "the fields to include for returned resources of type subscriptionGroups", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "createdDate", - "platforms", - "state", - "stateDetails", - "version", - "locale", - "backgroundAsset", - "internalBetaRelease", - "externalBetaRelease", - "appStoreRelease", - "assetFile", - "manifestFile", - "backgroundAssetUploadFiles" + "referenceName", + "subscriptions", + "subscriptionGroupLocalizations", + "versions" ] } }, @@ -117040,23 +118229,40 @@ "explode": false }, { - "name": "fields[backgroundAssets]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssets", + "description": "the fields to include for returned resources of type subscriptions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "archived", - "assetPackIdentifier", - "createdDate", - "usedBytes", - "app", + "name", + "productId", + "familySharable", + "state", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", "versions", - "appStoreVersion", - "internalBetaVersion", - "externalBetaVersion" + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -117064,16 +118270,19 @@ "explode": false }, { - "name": "fields[backgroundAssetVersionInternalBetaReleases]", + "name": "fields[subscriptionGroupLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssetVersionInternalBetaReleases", + "description": "the fields to include for returned resources of type subscriptionGroupLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "name", + "customAppName", + "locale", "state", - "backgroundAssetVersion" + "subscriptionGroup" ] } }, @@ -117081,16 +118290,18 @@ "explode": false }, { - "name": "fields[backgroundAssetVersionExternalBetaReleases]", + "name": "fields[subscriptionGroupVersions]", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssetVersionExternalBetaReleases", + "description": "the fields to include for returned resources of type subscriptionGroupVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "version", "state", - "backgroundAssetVersion" + "subscriptionGroup", + "localizations" ] } }, @@ -117098,39 +118309,27 @@ "explode": false }, { - "name": "fields[backgroundAssetVersionAppStoreReleases]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssetVersionAppStoreReleases", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "state", - "backgroundAssetVersion" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { - "name": "fields[backgroundAssetUploadFiles]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssetUploadFiles", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "assetDeliveryState", - "assetToken", - "assetType", - "fileName", - "fileSize", - "sourceFileChecksum", - "sourceFileChecksums", - "uploadOperations" + "subscriptions", + "subscriptionGroupLocalizations", + "versions" ] } }, @@ -117138,35 +118337,34 @@ "explode": false }, { - "name": "limit", + "name": "limit[subscriptions]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related subscriptions returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "maximum": 50 }, "style": "form" }, { - "name": "include", + "name": "limit[subscriptionGroupLocalizations]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "maximum number of related subscriptionGroupLocalizations returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "backgroundAsset", - "internalBetaRelease", - "externalBetaRelease", - "appStoreRelease", - "assetFile", - "manifestFile" - ] - } + "type": "integer", + "maximum": 50 }, - "style": "form", - "explode": false + "style": "form" + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -117211,11 +118409,11 @@ } }, "200": { - "description": "List of BackgroundAssetVersions", + "description": "List of SubscriptionGroups", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BackgroundAssetVersionsResponse" + "$ref": "#/components/schemas/SubscriptionGroupsResponse" } } } @@ -117245,13 +118443,24 @@ } ] }, - "/v1/betaAppLocalizations/{id}/relationships/app": { + "/v1/apps/{id}/relationships/webhooks": { "get": { "tags": [ - "BetaAppLocalizations" + "Apps" + ], + "operationId": "apps_webhooks_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "betaAppLocalizations_app_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -117294,11 +118503,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BetaAppLocalizationAppLinkageResponse" + "$ref": "#/components/schemas/AppWebhooksLinkagesResponse" } } } @@ -117328,13 +118537,34 @@ } ] }, - "/v1/betaAppLocalizations/{id}/app": { + "/v1/apps/{id}/webhooks": { "get": { "tags": [ - "BetaAppLocalizations" + "Apps" ], - "operationId": "betaAppLocalizations_app_getToOneRelated", + "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", @@ -117377,6 +118607,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -117406,6 +118637,32 @@ }, "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": { @@ -117450,7 +118707,937 @@ } }, "200": { - "description": "Single App with get", + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/backgroundAssetVersions/{id}/relationships/backgroundAssetUploadFiles": { + "get": { + "tags": [ + "BackgroundAssetVersions" + ], + "operationId": "backgroundAssetVersions_backgroundAssetUploadFiles_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/BackgroundAssetVersionBackgroundAssetUploadFilesLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/backgroundAssetVersions/{id}/backgroundAssetUploadFiles": { + "get": { + "tags": [ + "BackgroundAssetVersions" + ], + "operationId": "backgroundAssetVersions_backgroundAssetUploadFiles_getToManyRelated", + "parameters": [ + { + "name": "fields[backgroundAssetUploadFiles]", + "in": "query", + "description": "the fields to include for returned resources of type backgroundAssetUploadFiles", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "assetDeliveryState", + "assetToken", + "assetType", + "fileName", + "fileSize", + "sourceFileChecksum", + "sourceFileChecksums", + "uploadOperations" + ] + } + }, + "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 BackgroundAssetUploadFiles", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BackgroundAssetUploadFilesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/backgroundAssets/{id}/relationships/versions": { + "get": { + "tags": [ + "BackgroundAssets" + ], + "operationId": "backgroundAssets_versions_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/BackgroundAssetVersionsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/backgroundAssets/{id}/versions": { + "get": { + "tags": [ + "BackgroundAssets" + ], + "operationId": "backgroundAssets_versions_getToManyRelated", + "parameters": [ + { + "name": "filter[locale]", + "in": "query", + "description": "filter by attribute 'locale'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[platforms]", + "in": "query", + "description": "filter by attribute 'platforms'", + "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": [ + "AWAITING_UPLOAD", + "PROCESSING", + "FAILED", + "COMPLETE" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[version]", + "in": "query", + "description": "filter by attribute 'version'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[internalBetaRelease.state]", + "in": "query", + "description": "filter by attribute 'internalBetaRelease.state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "READY_FOR_TESTING", + "SUPERSEDED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[externalBetaRelease.state]", + "in": "query", + "description": "filter by attribute 'externalBetaRelease.state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "READY_FOR_BETA_SUBMISSION", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "REJECTED", + "PROCESSING_FOR_TESTING", + "READY_FOR_TESTING", + "SUPERSEDED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreRelease.state]", + "in": "query", + "description": "filter by attribute 'appStoreRelease.state'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "ACCEPTED", + "REJECTED", + "PROCESSING_FOR_DISTRIBUTION", + "READY_FOR_DISTRIBUTION", + "SUPERSEDED" + ] + } + }, + "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": [ + "version", + "-version" + ] + } + }, + "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", + "locale", + "backgroundAsset", + "internalBetaRelease", + "externalBetaRelease", + "appStoreRelease", + "assetFile", + "manifestFile", + "backgroundAssetUploadFiles" + ] + } + }, + "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[backgroundAssetVersionInternalBetaReleases]", + "in": "query", + "description": "the fields to include for returned resources of type backgroundAssetVersionInternalBetaReleases", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "state", + "backgroundAssetVersion" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[backgroundAssetVersionExternalBetaReleases]", + "in": "query", + "description": "the fields to include for returned resources of type backgroundAssetVersionExternalBetaReleases", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "state", + "backgroundAssetVersion" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[backgroundAssetVersionAppStoreReleases]", + "in": "query", + "description": "the fields to include for returned resources of type backgroundAssetVersionAppStoreReleases", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "state", + "backgroundAssetVersion" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[backgroundAssetUploadFiles]", + "in": "query", + "description": "the fields to include for returned resources of type backgroundAssetUploadFiles", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "assetDeliveryState", + "assetToken", + "assetType", + "fileName", + "fileSize", + "sourceFileChecksum", + "sourceFileChecksums", + "uploadOperations" + ] + } + }, + "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": [ + "backgroundAsset", + "internalBetaRelease", + "externalBetaRelease", + "appStoreRelease", + "assetFile", + "manifestFile" + ] + } + }, + "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 BackgroundAssetVersions", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BackgroundAssetVersionsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/betaAppLocalizations/{id}/relationships/app": { + "get": { + "tags": [ + "BetaAppLocalizations" + ], + "operationId": "betaAppLocalizations_app_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/BetaAppLocalizationAppLinkageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/betaAppLocalizations/{id}/app": { + "get": { + "tags": [ + "BetaAppLocalizations" + ], + "operationId": "betaAppLocalizations_app_getToOneRelated", + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" + ] + } + }, + "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 App with get", "content": { "application/json": { "schema": { @@ -117616,6 +119803,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -118454,6 +120642,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -119869,6 +122058,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -120214,6 +122404,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -121464,6 +123655,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -122956,6 +125148,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -123525,6 +125718,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -126036,6 +128230,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -127556,11 +129751,3425 @@ } }, "200": { - "description": "List of CiIssues", + "description": "List of CiIssues", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CiIssuesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciBuildActions/{id}/relationships/testResults": { + "get": { + "tags": [ + "CiBuildActions" + ], + "operationId": "ciBuildActions_testResults_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/CiBuildActionTestResultsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciBuildActions/{id}/testResults": { + "get": { + "tags": [ + "CiBuildActions" + ], + "operationId": "ciBuildActions_testResults_getToManyRelated", + "parameters": [ + { + "name": "fields[ciTestResults]", + "in": "query", + "description": "the fields to include for returned resources of type ciTestResults", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "className", + "name", + "status", + "fileSource", + "message", + "destinationTestResults" + ] + } + }, + "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 CiTestResults", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CiTestResultsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciBuildRuns/{id}/relationships/actions": { + "get": { + "tags": [ + "CiBuildRuns" + ], + "operationId": "ciBuildRuns_actions_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/CiBuildRunActionsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciBuildRuns/{id}/actions": { + "get": { + "tags": [ + "CiBuildRuns" + ], + "operationId": "ciBuildRuns_actions_getToManyRelated", + "parameters": [ + { + "name": "fields[ciBuildActions]", + "in": "query", + "description": "the fields to include for returned resources of type ciBuildActions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "actionType", + "startedDate", + "finishedDate", + "issueCounts", + "executionProgress", + "completionStatus", + "isRequiredToPass", + "buildRun", + "artifacts", + "issues", + "testResults" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[ciBuildRuns]", + "in": "query", + "description": "the fields to include for returned resources of type ciBuildRuns", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "number", + "createdDate", + "startedDate", + "finishedDate", + "sourceCommit", + "destinationCommit", + "isPullRequestBuild", + "issueCounts", + "executionProgress", + "completionStatus", + "startReason", + "cancelReason", + "builds", + "workflow", + "product", + "sourceBranchOrTag", + "destinationBranch", + "actions", + "pullRequest" + ] + } + }, + "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": [ + "buildRun" + ] + } + }, + "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 CiBuildActions", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CiBuildActionsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciBuildRuns/{id}/relationships/builds": { + "get": { + "tags": [ + "CiBuildRuns" + ], + "operationId": "ciBuildRuns_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/CiBuildRunBuildsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciBuildRuns/{id}/builds": { + "get": { + "tags": [ + "CiBuildRuns" + ], + "operationId": "ciBuildRuns_builds_getToManyRelated", + "parameters": [ + { + "name": "filter[version]", + "in": "query", + "description": "filter by attribute 'version'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[expired]", + "in": "query", + "description": "filter by attribute 'expired'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[processingState]", + "in": "query", + "description": "filter by attribute 'processingState'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "PROCESSING", + "FAILED", + "INVALID", + "VALID" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[betaAppReviewSubmission.betaReviewState]", + "in": "query", + "description": "filter by attribute 'betaAppReviewSubmission.betaReviewState'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "REJECTED", + "APPROVED" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[usesNonExemptEncryption]", + "in": "query", + "description": "filter by attribute 'usesNonExemptEncryption'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[preReleaseVersion.version]", + "in": "query", + "description": "filter by attribute 'preReleaseVersion.version'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[preReleaseVersion.platform]", + "in": "query", + "description": "filter by attribute 'preReleaseVersion.platform'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "IOS", + "MAC_OS", + "TV_OS", + "VISION_OS" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[buildAudienceType]", + "in": "query", + "description": "filter by attribute 'buildAudienceType'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "INTERNAL_ONLY", + "APP_STORE_ELIGIBLE" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[preReleaseVersion]", + "in": "query", + "description": "filter by id(s) of related 'preReleaseVersion'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[app]", + "in": "query", + "description": "filter by id(s) of related 'app'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[betaGroups]", + "in": "query", + "description": "filter by id(s) of related 'betaGroups'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[appStoreVersion]", + "in": "query", + "description": "filter by id(s) of related 'appStoreVersion'", + "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": "exists[usesNonExemptEncryption]", + "in": "query", + "description": "filter by attribute 'usesNonExemptEncryption'", + "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": [ + "version", + "-version", + "uploadedDate", + "-uploadedDate", + "preReleaseVersion", + "-preReleaseVersion" + ] + } + }, + "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[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": "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": "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": "fields[betaBuildLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type betaBuildLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "whatsNew", + "locale", + "build" + ] + } + }, + "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[betaAppReviewSubmissions]", + "in": "query", + "description": "the fields to include for returned resources of type betaAppReviewSubmissions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "betaReviewState", + "submittedDate", + "build" + ] + } + }, + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[buildBetaDetails]", + "in": "query", + "description": "the fields to include for returned resources of type buildBetaDetails", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "autoNotifyEnabled", + "internalBuildState", + "externalBuildState", + "build" + ] + } + }, + "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[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 + }, + { + "name": "fields[buildBundles]", + "in": "query", + "description": "the fields to include for returned resources of type buildBundles", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "bundleId", + "bundleType", + "sdkBuild", + "platformBuild", + "fileName", + "hasSirikit", + "hasOnDemandResources", + "hasPrerenderedIcon", + "usesLocationServices", + "isIosBuildMacAppStoreCompatible", + "includesSymbols", + "dSYMUrl", + "supportedArchitectures", + "requiredCapabilities", + "deviceProtocols", + "locales", + "entitlements", + "baDownloadAllowance", + "baMaxInstallSize", + "minimumOsVersion", + "appClipDomainCacheStatus", + "appClipDomainDebugStatus", + "betaAppClipInvocations", + "buildBundleFileSizes" + ] + } + }, + "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": "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": [ + "preReleaseVersion", + "individualTesters", + "betaGroups", + "betaBuildLocalizations", + "appEncryptionDeclaration", + "betaAppReviewSubmission", + "app", + "buildBetaDetail", + "appStoreVersion", + "icons", + "buildBundles", + "buildUpload" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[individualTesters]", + "in": "query", + "description": "maximum number of related individualTesters returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[betaGroups]", + "in": "query", + "description": "maximum number of related betaGroups returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[betaBuildLocalizations]", + "in": "query", + "description": "maximum number of related betaBuildLocalizations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[icons]", + "in": "query", + "description": "maximum number of related icons returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[buildBundles]", + "in": "query", + "description": "maximum number of related buildBundles 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 Builds", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BuildsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciMacOsVersions/{id}/relationships/xcodeVersions": { + "get": { + "tags": [ + "CiMacOsVersions" + ], + "operationId": "ciMacOsVersions_xcodeVersions_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/CiMacOsVersionXcodeVersionsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciMacOsVersions/{id}/xcodeVersions": { + "get": { + "tags": [ + "CiMacOsVersions" + ], + "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "parameters": [ + { + "name": "fields[ciXcodeVersions]", + "in": "query", + "description": "the fields to include for returned resources of type ciXcodeVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "name", + "testDestinations", + "macOsVersions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[ciMacOsVersions]", + "in": "query", + "description": "the fields to include for returned resources of type ciMacOsVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "name", + "xcodeVersions" + ] + } + }, + "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": [ + "macOsVersions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[macOsVersions]", + "in": "query", + "description": "maximum number of related macOsVersions 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 CiXcodeVersions", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CiXcodeVersionsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciProducts/{id}/relationships/additionalRepositories": { + "get": { + "tags": [ + "CiProducts" + ], + "operationId": "ciProducts_additionalRepositories_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/CiProductAdditionalRepositoriesLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciProducts/{id}/additionalRepositories": { + "get": { + "tags": [ + "CiProducts" + ], + "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "parameters": [ + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "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": "fields[scmProviders]", + "in": "query", + "description": "the fields to include for returned resources of type scmProviders", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "scmProviderType", + "url", + "repositories" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[scmGitReferences]", + "in": "query", + "description": "the fields to include for returned resources of type scmGitReferences", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "canonicalName", + "isDeleted", + "kind", + "repository" + ] + } + }, + "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": [ + "scmProvider", + "defaultBranch" + ] + } + }, + "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 ScmRepositories", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScmRepositoriesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciProducts/{id}/relationships/app": { + "get": { + "tags": [ + "CiProducts" + ], + "operationId": "ciProducts_app_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/CiProductAppLinkageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciProducts/{id}/app": { + "get": { + "tags": [ + "CiProducts" + ], + "operationId": "ciProducts_app_getToOneRelated", + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" + ] + } + }, + "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[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 + }, + { + "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[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": "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[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": "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": "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[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 + }, + { + "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 + }, + { + "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", + "app", + "ageRatingDeclaration", + "appInfoLocalizations", + "primaryCategory", + "primarySubcategoryOne", + "primarySubcategoryTwo", + "secondaryCategory", + "secondarySubcategoryOne", + "secondarySubcategoryTwo", + "territoryAgeRatings" + ] + } + }, + "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[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 + }, + { + "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", + "versions" + ] + } + }, + "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", + "versions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[retentionMessages]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "referenceName", + "versions", + "subscriptions" + ] + } + }, + "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[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[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[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[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[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 + }, + { + "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", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] + } + }, + "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[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": "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", + "retentionMessages", + "gameCenterEnabledVersions", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "androidToIosAppMappingDetails" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[appEncryptionDeclarations]", + "in": "query", + "description": "maximum number of related appEncryptionDeclarations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[betaGroups]", + "in": "query", + "description": "maximum number of related betaGroups returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[appStoreVersions]", + "in": "query", + "description": "maximum number of related appStoreVersions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[preReleaseVersions]", + "in": "query", + "description": "maximum number of related preReleaseVersions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[betaAppLocalizations]", + "in": "query", + "description": "maximum number of related betaAppLocalizations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[builds]", + "in": "query", + "description": "maximum number of related builds returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[appInfos]", + "in": "query", + "description": "maximum number of related appInfos returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[appClips]", + "in": "query", + "description": "maximum number of related appClips returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[inAppPurchases]", + "in": "query", + "description": "maximum number of related inAppPurchases returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "deprecated": true + }, + { + "name": "limit[subscriptionGroups]", + "in": "query", + "description": "maximum number of related subscriptionGroups returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[retentionMessages]", + "in": "query", + "description": "maximum number of related retentionMessages returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[gameCenterEnabledVersions]", + "in": "query", + "description": "maximum number of related gameCenterEnabledVersions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "deprecated": true + }, + { + "name": "limit[appCustomProductPages]", + "in": "query", + "description": "maximum number of related appCustomProductPages returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[inAppPurchasesV2]", + "in": "query", + "description": "maximum number of related inAppPurchasesV2 returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[promotedPurchases]", + "in": "query", + "description": "maximum number of related promotedPurchases returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[appEvents]", + "in": "query", + "description": "maximum number of related appEvents returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[reviewSubmissions]", + "in": "query", + "description": "maximum number of related reviewSubmissions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[appStoreVersionExperimentsV2]", + "in": "query", + "description": "maximum number of related appStoreVersionExperimentsV2 returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[androidToIosAppMappingDetails]", + "in": "query", + "description": "maximum number of related androidToIosAppMappingDetails 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 App", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciProducts/{id}/relationships/buildRuns": { + "get": { + "tags": [ + "CiProducts" + ], + "operationId": "ciProducts_buildRuns_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/CiProductBuildRunsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciProducts/{id}/buildRuns": { + "get": { + "tags": [ + "CiProducts" + ], + "operationId": "ciProducts_buildRuns_getToManyRelated", + "parameters": [ + { + "name": "filter[builds]", + "in": "query", + "description": "filter by id(s) of related 'builds'", + "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": [ + "number", + "-number" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[ciBuildRuns]", + "in": "query", + "description": "the fields to include for returned resources of type ciBuildRuns", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "number", + "createdDate", + "startedDate", + "finishedDate", + "sourceCommit", + "destinationCommit", + "isPullRequestBuild", + "issueCounts", + "executionProgress", + "completionStatus", + "startReason", + "cancelReason", + "builds", + "workflow", + "product", + "sourceBranchOrTag", + "destinationBranch", + "actions", + "pullRequest" + ] + } + }, + "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[ciWorkflows]", + "in": "query", + "description": "the fields to include for returned resources of type ciWorkflows", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "description", + "branchStartCondition", + "tagStartCondition", + "pullRequestStartCondition", + "scheduledStartCondition", + "manualBranchStartCondition", + "manualTagStartCondition", + "manualPullRequestStartCondition", + "actions", + "isEnabled", + "isLockedForEditing", + "clean", + "containerFilePath", + "lastModifiedDate", + "product", + "repository", + "xcodeVersion", + "macOsVersion", + "buildRuns" + ] + } + }, + "style": "form", + "explode": 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 + }, + { + "name": "fields[scmGitReferences]", + "in": "query", + "description": "the fields to include for returned resources of type scmGitReferences", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "canonicalName", + "isDeleted", + "kind", + "repository" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[scmPullRequests]", + "in": "query", + "description": "the fields to include for returned resources of type scmPullRequests", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "title", + "number", + "webUrl", + "sourceRepositoryOwner", + "sourceRepositoryName", + "sourceBranchName", + "destinationRepositoryOwner", + "destinationRepositoryName", + "destinationBranchName", + "isClosed", + "isCrossRepository", + "repository" + ] + } + }, + "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": [ + "builds", + "workflow", + "product", + "sourceBranchOrTag", + "destinationBranch", + "pullRequest" + ] + } + }, + "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 CiBuildRuns", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiIssuesResponse" + "$ref": "#/components/schemas/CiBuildRunsResponse" } } } @@ -127590,12 +133199,12 @@ } ] }, - "/v1/ciBuildActions/{id}/relationships/testResults": { + "/v1/ciProducts/{id}/relationships/primaryRepositories": { "get": { "tags": [ - "CiBuildActions" + "CiProducts" ], - "operationId": "ciBuildActions_testResults_getToManyRelationship", + "operationId": "ciProducts_primaryRepositories_getToManyRelationship", "parameters": [ { "name": "limit", @@ -127654,7 +133263,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiBuildActionTestResultsLinkagesResponse" + "$ref": "#/components/schemas/CiProductPrimaryRepositoriesLinkagesResponse" } } } @@ -127684,28 +133293,82 @@ } ] }, - "/v1/ciBuildActions/{id}/testResults": { + "/v1/ciProducts/{id}/primaryRepositories": { "get": { "tags": [ - "CiBuildActions" + "CiProducts" ], - "operationId": "ciBuildActions_testResults_getToManyRelated", + "operationId": "ciProducts_primaryRepositories_getToManyRelated", "parameters": [ { - "name": "fields[ciTestResults]", + "name": "filter[id]", "in": "query", - "description": "the fields to include for returned resources of type ciTestResults", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "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": "fields[scmProviders]", + "in": "query", + "description": "the fields to include for returned resources of type scmProviders", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "scmProviderType", + "url", + "repositories" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[scmGitReferences]", + "in": "query", + "description": "the fields to include for returned resources of type scmGitReferences", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "className", "name", - "status", - "fileSource", - "message", - "destinationTestResults" + "canonicalName", + "isDeleted", + "kind", + "repository" ] } }, @@ -127721,6 +133384,23 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "scmProvider", + "defaultBranch" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -127765,11 +133445,11 @@ } }, "200": { - "description": "List of CiTestResults", + "description": "List of ScmRepositories", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiTestResultsResponse" + "$ref": "#/components/schemas/ScmRepositoriesResponse" } } } @@ -127799,12 +133479,12 @@ } ] }, - "/v1/ciBuildRuns/{id}/relationships/actions": { + "/v1/ciProducts/{id}/relationships/workflows": { "get": { "tags": [ - "CiBuildRuns" + "CiProducts" ], - "operationId": "ciBuildRuns_actions_getToManyRelationship", + "operationId": "ciProducts_workflows_getToManyRelationship", "parameters": [ { "name": "limit", @@ -127863,7 +133543,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiBuildRunActionsLinkagesResponse" + "$ref": "#/components/schemas/CiProductWorkflowsLinkagesResponse" } } } @@ -127893,34 +133573,42 @@ } ] }, - "/v1/ciBuildRuns/{id}/actions": { + "/v1/ciProducts/{id}/workflows": { "get": { "tags": [ - "CiBuildRuns" + "CiProducts" ], - "operationId": "ciBuildRuns_actions_getToManyRelated", + "operationId": "ciProducts_workflows_getToManyRelated", "parameters": [ { - "name": "fields[ciBuildActions]", + "name": "fields[ciWorkflows]", "in": "query", - "description": "the fields to include for returned resources of type ciBuildActions", + "description": "the fields to include for returned resources of type ciWorkflows", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "actionType", - "startedDate", - "finishedDate", - "issueCounts", - "executionProgress", - "completionStatus", - "isRequiredToPass", - "buildRun", - "artifacts", - "issues", - "testResults" + "description", + "branchStartCondition", + "tagStartCondition", + "pullRequestStartCondition", + "scheduledStartCondition", + "manualBranchStartCondition", + "manualTagStartCondition", + "manualPullRequestStartCondition", + "actions", + "isEnabled", + "isLockedForEditing", + "clean", + "containerFilePath", + "lastModifiedDate", + "product", + "repository", + "xcodeVersion", + "macOsVersion", + "buildRuns" ] } }, @@ -127928,33 +133616,84 @@ "explode": false }, { - "name": "fields[ciBuildRuns]", + "name": "fields[ciProducts]", "in": "query", - "description": "the fields to include for returned resources of type ciBuildRuns", + "description": "the fields to include for returned resources of type ciProducts", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "number", + "name", "createdDate", - "startedDate", - "finishedDate", - "sourceCommit", - "destinationCommit", - "isPullRequestBuild", - "issueCounts", - "executionProgress", - "completionStatus", - "startReason", - "cancelReason", - "builds", - "workflow", - "product", - "sourceBranchOrTag", - "destinationBranch", - "actions", - "pullRequest" + "productType", + "app", + "bundleId", + "workflows", + "primaryRepositories", + "additionalRepositories", + "buildRuns" + ] + } + }, + "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": "fields[ciXcodeVersions]", + "in": "query", + "description": "the fields to include for returned resources of type ciXcodeVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "name", + "testDestinations", + "macOsVersions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[ciMacOsVersions]", + "in": "query", + "description": "the fields to include for returned resources of type ciMacOsVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "name", + "xcodeVersions" ] } }, @@ -127980,7 +133719,10 @@ "items": { "type": "string", "enum": [ - "buildRun" + "product", + "repository", + "xcodeVersion", + "macOsVersion" ] } }, @@ -128030,11 +133772,11 @@ } }, "200": { - "description": "List of CiBuildActions", + "description": "List of CiWorkflows", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiBuildActionsResponse" + "$ref": "#/components/schemas/CiWorkflowsResponse" } } } @@ -128064,12 +133806,12 @@ } ] }, - "/v1/ciBuildRuns/{id}/relationships/builds": { + "/v1/ciWorkflows/{id}/relationships/buildRuns": { "get": { "tags": [ - "CiBuildRuns" + "CiWorkflows" ], - "operationId": "ciBuildRuns_builds_getToManyRelationship", + "operationId": "ciWorkflows_buildRuns_getToManyRelationship", "parameters": [ { "name": "limit", @@ -128128,7 +133870,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiBuildRunBuildsLinkagesResponse" + "$ref": "#/components/schemas/CiWorkflowBuildRunsLinkagesResponse" } } } @@ -128158,94 +133900,17 @@ } ] }, - "/v1/ciBuildRuns/{id}/builds": { + "/v1/ciWorkflows/{id}/buildRuns": { "get": { "tags": [ - "CiBuildRuns" + "CiWorkflows" ], - "operationId": "ciBuildRuns_builds_getToManyRelated", + "operationId": "ciWorkflows_buildRuns_getToManyRelated", "parameters": [ { - "name": "filter[version]", - "in": "query", - "description": "filter by attribute 'version'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[expired]", - "in": "query", - "description": "filter by attribute 'expired'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[processingState]", - "in": "query", - "description": "filter by attribute 'processingState'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "PROCESSING", - "FAILED", - "INVALID", - "VALID" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[betaAppReviewSubmission.betaReviewState]", - "in": "query", - "description": "filter by attribute 'betaAppReviewSubmission.betaReviewState'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "WAITING_FOR_REVIEW", - "IN_REVIEW", - "REJECTED", - "APPROVED" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[usesNonExemptEncryption]", - "in": "query", - "description": "filter by attribute 'usesNonExemptEncryption'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[preReleaseVersion.version]", + "name": "filter[builds]", "in": "query", - "description": "filter by attribute 'preReleaseVersion.version'", + "description": "filter by id(s) of related 'builds'", "schema": { "type": "array", "items": { @@ -128256,35 +133921,16 @@ "explode": false }, { - "name": "filter[preReleaseVersion.platform]", - "in": "query", - "description": "filter by attribute 'preReleaseVersion.platform'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[buildAudienceType]", + "name": "sort", "in": "query", - "description": "filter by attribute 'buildAudienceType'", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "INTERNAL_ONLY", - "APP_STORE_ELIGIBLE" + "number", + "-number" ] } }, @@ -128292,95 +133938,33 @@ "explode": false }, { - "name": "filter[preReleaseVersion]", - "in": "query", - "description": "filter by id(s) of related 'preReleaseVersion'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[app]", - "in": "query", - "description": "filter by id(s) of related 'app'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[betaGroups]", - "in": "query", - "description": "filter by id(s) of related 'betaGroups'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[appStoreVersion]", - "in": "query", - "description": "filter by id(s) of related 'appStoreVersion'", - "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": "exists[usesNonExemptEncryption]", - "in": "query", - "description": "filter by attribute 'usesNonExemptEncryption'", - "schema": { - "type": "boolean" - }, - "style": "form", - "explode": false - }, - { - "name": "sort", + "name": "fields[ciBuildRuns]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type ciBuildRuns", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "-version", - "uploadedDate", - "-uploadedDate", - "preReleaseVersion", - "-preReleaseVersion" + "number", + "createdDate", + "startedDate", + "finishedDate", + "sourceCommit", + "destinationCommit", + "isPullRequestBuild", + "issueCounts", + "executionProgress", + "completionStatus", + "startReason", + "cancelReason", + "builds", + "workflow", + "product", + "sourceBranchOrTag", + "destinationBranch", + "actions", + "pullRequest" ] } }, @@ -128429,42 +134013,34 @@ "explode": 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 - }, - { - "name": "fields[betaTesters]", + "name": "fields[ciWorkflows]", "in": "query", - "description": "the fields to include for returned resources of type betaTesters", + "description": "the fields to include for returned resources of type ciWorkflows", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "firstName", - "lastName", - "email", - "inviteType", - "state", - "appDevices", - "apps", - "betaGroups", - "builds" + "name", + "description", + "branchStartCondition", + "tagStartCondition", + "pullRequestStartCondition", + "scheduledStartCondition", + "manualBranchStartCondition", + "manualTagStartCondition", + "manualPullRequestStartCondition", + "actions", + "isEnabled", + "isLockedForEditing", + "clean", + "containerFilePath", + "lastModifiedDate", + "product", + "repository", + "xcodeVersion", + "macOsVersion", + "buildRuns" ] } }, @@ -128472,9 +134048,9 @@ "explode": false }, { - "name": "fields[betaGroups]", + "name": "fields[ciProducts]", "in": "query", - "description": "the fields to include for returned resources of type betaGroups", + "description": "the fields to include for returned resources of type ciProducts", "schema": { "type": "array", "items": { @@ -128482,21 +134058,13 @@ "enum": [ "name", "createdDate", - "isInternalGroup", - "hasAccessToAllBuilds", - "publicLinkEnabled", - "publicLinkId", - "publicLinkLimitEnabled", - "publicLinkLimit", - "publicLink", - "feedbackEnabled", - "iosBuildsAvailableForAppleSiliconMac", - "iosBuildsAvailableForAppleVision", + "productType", "app", - "builds", - "betaTesters", - "betaRecruitmentCriteria", - "betaRecruitmentCriterionCompatibleBuildCheck" + "bundleId", + "workflows", + "primaryRepositories", + "additionalRepositories", + "buildRuns" ] } }, @@ -128504,17 +134072,19 @@ "explode": false }, { - "name": "fields[betaBuildLocalizations]", + "name": "fields[scmGitReferences]", "in": "query", - "description": "the fields to include for returned resources of type betaBuildLocalizations", + "description": "the fields to include for returned resources of type scmGitReferences", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "whatsNew", - "locale", - "build" + "name", + "canonicalName", + "isDeleted", + "kind", + "repository" ] } }, @@ -128522,31 +134092,26 @@ "explode": false }, { - "name": "fields[appEncryptionDeclarations]", + "name": "fields[scmPullRequests]", "in": "query", - "description": "the fields to include for returned resources of type appEncryptionDeclarations", + "description": "the fields to include for returned resources of type scmPullRequests", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "appDescription", - "createdDate", - "usesEncryption", - "exempt", - "containsProprietaryCryptography", - "containsThirdPartyCryptography", - "availableOnFrenchStore", - "platform", - "uploadedDate", - "documentUrl", - "documentName", - "documentType", - "appEncryptionDeclarationState", - "codeValue", - "app", - "builds", - "appEncryptionDeclarationDocument" + "title", + "number", + "webUrl", + "sourceRepositoryOwner", + "sourceRepositoryName", + "sourceBranchName", + "destinationRepositoryOwner", + "destinationRepositoryName", + "destinationBranchName", + "isClosed", + "isCrossRepository", + "repository" ] } }, @@ -128554,89 +134119,30 @@ "explode": false }, { - "name": "fields[betaAppReviewSubmissions]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type betaAppReviewSubmissions", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "betaReviewState", - "submittedDate", - "build" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { - "name": "fields[apps]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "comma-separated list of relationships to include", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" + "workflow", + "product", + "sourceBranchOrTag", + "destinationBranch", + "pullRequest" ] } }, @@ -128644,233 +134150,260 @@ "explode": false }, { - "name": "fields[buildBetaDetails]", + "name": "limit[builds]", "in": "query", - "description": "the fields to include for returned resources of type buildBetaDetails", + "description": "maximum number of related builds returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "autoNotifyEnabled", - "internalBuildState", - "externalBuildState", - "build" - ] - } + "type": "integer", + "maximum": 50 }, - "style": "form", - "explode": false + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "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" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": 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" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "fields[buildBundles]", - "in": "query", - "description": "the fields to include for returned resources of type buildBundles", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "bundleId", - "bundleType", - "sdkBuild", - "platformBuild", - "fileName", - "hasSirikit", - "hasOnDemandResources", - "hasPrerenderedIcon", - "usesLocationServices", - "isIosBuildMacAppStoreCompatible", - "includesSymbols", - "dSYMUrl", - "supportedArchitectures", - "requiredCapabilities", - "deviceProtocols", - "locales", - "entitlements", - "baDownloadAllowance", - "baMaxInstallSize", - "minimumOsVersion", - "appClipDomainCacheStatus", - "appClipDomainDebugStatus", - "betaAppClipInvocations", - "buildBundleFileSizes" - ] + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "200": { + "description": "List of CiBuildRuns", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CiBuildRunsResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "preReleaseVersion", - "individualTesters", - "betaGroups", - "betaBuildLocalizations", - "appEncryptionDeclaration", - "betaAppReviewSubmission", - "app", - "buildBetaDetail", - "appStoreVersion", - "icons", - "buildBundles", - "buildUpload" - ] + "style": "simple", + "required": true + } + ] + }, + "/v1/ciWorkflows/{id}/relationships/repository": { + "get": { + "tags": [ + "CiWorkflows" + ], + "operationId": "ciWorkflows_repository_getToOneRelationship", + "parameters": [], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "limit[individualTesters]", - "in": "query", - "description": "maximum number of related individualTesters returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" + "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/CiWorkflowRepositoryLinkageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/ciWorkflows/{id}/repository": { + "get": { + "tags": [ + "CiWorkflows" + ], + "operationId": "ciWorkflows_repository_getToOneRelated", + "parameters": [ { - "name": "limit[betaGroups]", + "name": "fields[scmRepositories]", "in": "query", - "description": "maximum number of related betaGroups returned (when they are included)", + "description": "the fields to include for returned resources of type scmRepositories", "schema": { - "type": "integer", - "maximum": 50 + "type": "array", + "items": { + "type": "string", + "enum": [ + "lastAccessedDate", + "httpCloneUrl", + "sshCloneUrl", + "ownerName", + "repositoryName", + "scmProvider", + "defaultBranch", + "gitReferences", + "pullRequests" + ] + } }, - "style": "form" + "style": "form", + "explode": false }, { - "name": "limit[betaBuildLocalizations]", + "name": "fields[scmProviders]", "in": "query", - "description": "maximum number of related betaBuildLocalizations returned (when they are included)", + "description": "the fields to include for returned resources of type scmProviders", "schema": { - "type": "integer", - "maximum": 50 + "type": "array", + "items": { + "type": "string", + "enum": [ + "scmProviderType", + "url", + "repositories" + ] + } }, - "style": "form" + "style": "form", + "explode": false }, { - "name": "limit[icons]", + "name": "fields[scmGitReferences]", "in": "query", - "description": "maximum number of related icons returned (when they are included)", + "description": "the fields to include for returned resources of type scmGitReferences", "schema": { - "type": "integer", - "maximum": 50 + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "canonicalName", + "isDeleted", + "kind", + "repository" + ] + } }, - "style": "form" + "style": "form", + "explode": false }, { - "name": "limit[buildBundles]", + "name": "include", "in": "query", - "description": "maximum number of related buildBundles returned (when they are included)", + "description": "comma-separated list of relationships to include", "schema": { - "type": "integer", - "maximum": 50 + "type": "array", + "items": { + "type": "string", + "enum": [ + "scmProvider", + "defaultBranch" + ] + } }, - "style": "form" + "style": "form", + "explode": false } ], "responses": { @@ -128915,11 +134448,11 @@ } }, "200": { - "description": "List of Builds", + "description": "Single ScmRepository", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BuildsResponse" + "$ref": "#/components/schemas/ScmRepositoryResponse" } } } @@ -128949,12 +134482,12 @@ } ] }, - "/v1/ciMacOsVersions/{id}/relationships/xcodeVersions": { + "/v1/ciXcodeVersions/{id}/relationships/macOsVersions": { "get": { "tags": [ - "CiMacOsVersions" + "CiXcodeVersions" ], - "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelationship", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -129013,7 +134546,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiMacOsVersionXcodeVersionsLinkagesResponse" + "$ref": "#/components/schemas/CiXcodeVersionMacOsVersionsLinkagesResponse" } } } @@ -129043,17 +134576,17 @@ } ] }, - "/v1/ciMacOsVersions/{id}/xcodeVersions": { + "/v1/ciXcodeVersions/{id}/macOsVersions": { "get": { "tags": [ - "CiMacOsVersions" + "CiXcodeVersions" ], - "operationId": "ciMacOsVersions_xcodeVersions_getToManyRelated", + "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", "parameters": [ { - "name": "fields[ciXcodeVersions]", + "name": "fields[ciMacOsVersions]", "in": "query", - "description": "the fields to include for returned resources of type ciXcodeVersions", + "description": "the fields to include for returned resources of type ciMacOsVersions", "schema": { "type": "array", "items": { @@ -129061,8 +134594,7 @@ "enum": [ "version", "name", - "testDestinations", - "macOsVersions" + "xcodeVersions" ] } }, @@ -129070,9 +134602,9 @@ "explode": false }, { - "name": "fields[ciMacOsVersions]", + "name": "fields[ciXcodeVersions]", "in": "query", - "description": "the fields to include for returned resources of type ciMacOsVersions", + "description": "the fields to include for returned resources of type ciXcodeVersions", "schema": { "type": "array", "items": { @@ -129080,7 +134612,8 @@ "enum": [ "version", "name", - "xcodeVersions" + "testDestinations", + "macOsVersions" ] } }, @@ -129106,7 +134639,7 @@ "items": { "type": "string", "enum": [ - "macOsVersions" + "xcodeVersions" ] } }, @@ -129114,9 +134647,9 @@ "explode": false }, { - "name": "limit[macOsVersions]", + "name": "limit[xcodeVersions]", "in": "query", - "description": "maximum number of related macOsVersions returned (when they are included)", + "description": "maximum number of related xcodeVersions returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -129166,11 +134699,11 @@ } }, "200": { - "description": "List of CiXcodeVersions", + "description": "List of CiMacOsVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiXcodeVersionsResponse" + "$ref": "#/components/schemas/CiMacOsVersionsResponse" } } } @@ -129200,24 +134733,13 @@ } ] }, - "/v1/ciProducts/{id}/relationships/additionalRepositories": { + "/v1/customerReviews/{id}/relationships/response": { "get": { "tags": [ - "CiProducts" - ], - "operationId": "ciProducts_additionalRepositories_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "CustomerReviews" ], + "operationId": "customerReviews_response_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -129260,11 +134782,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiProductAdditionalRepositoriesLinkagesResponse" + "$ref": "#/components/schemas/CustomerReviewResponseLinkageResponse" } } } @@ -129294,44 +134816,26 @@ } ] }, - "/v1/ciProducts/{id}/additionalRepositories": { + "/v1/customerReviews/{id}/response": { "get": { "tags": [ - "CiProducts" + "CustomerReviews" ], - "operationId": "ciProducts_additionalRepositories_getToManyRelated", + "operationId": "customerReviews_response_getToOneRelated", "parameters": [ { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[scmRepositories]", + "name": "fields[customerReviewResponses]", "in": "query", - "description": "the fields to include for returned resources of type scmRepositories", + "description": "the fields to include for returned resources of type customerReviewResponses", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "lastAccessedDate", - "httpCloneUrl", - "sshCloneUrl", - "ownerName", - "repositoryName", - "scmProvider", - "defaultBranch", - "gitReferences", - "pullRequests" + "responseBody", + "lastModifiedDate", + "state", + "review" ] } }, @@ -129339,17 +134843,22 @@ "explode": false }, { - "name": "fields[scmProviders]", + "name": "fields[customerReviews]", "in": "query", - "description": "the fields to include for returned resources of type scmProviders", + "description": "the fields to include for returned resources of type customerReviews", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "scmProviderType", - "url", - "repositories" + "rating", + "title", + "body", + "reviewerNickname", + "createdDate", + "territory", + "response", + "reviewTerritory" ] } }, @@ -129357,25 +134866,105 @@ "explode": false }, { - "name": "fields[scmGitReferences]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type scmGitReferences", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "canonicalName", - "isDeleted", - "kind", - "repository" + "review" ] } }, "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 CustomerReviewResponse", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerReviewResponseV1Response" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/diagnosticSignatures/{id}/logs": { + "get": { + "tags": [ + "DiagnosticSignatures" + ], + "operationId": "diagnosticSignatures_logs_getToManyRelated", + "parameters": [ { "name": "limit", "in": "query", @@ -129385,23 +134974,6 @@ "maximum": 200 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "scmProvider", - "defaultBranch" - ] - } - }, - "style": "form", - "explode": false } ], "responses": { @@ -129446,11 +135018,11 @@ } }, "200": { - "description": "List of ScmRepositories", + "description": "List of DiagnosticLogs", "content": { - "application/json": { + "application/vnd.apple.diagnostic-logs+json": { "schema": { - "$ref": "#/components/schemas/ScmRepositoriesResponse" + "$ref": "#/components/schemas/diagnosticLogs" } } } @@ -129480,13 +135052,24 @@ } ] }, - "/v1/ciProducts/{id}/relationships/app": { + "/v1/endUserLicenseAgreements/{id}/relationships/territories": { "get": { "tags": [ - "CiProducts" + "EndUserLicenseAgreements" + ], + "operationId": "endUserLicenseAgreements_territories_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "ciProducts_app_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -129529,11 +135112,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiProductAppLinkageResponse" + "$ref": "#/components/schemas/EndUserLicenseAgreementTerritoriesLinkagesResponse" } } } @@ -129563,79 +135146,23 @@ } ] }, - "/v1/ciProducts/{id}/app": { + "/v1/endUserLicenseAgreements/{id}/territories": { "get": { "tags": [ - "CiProducts" + "EndUserLicenseAgreements" ], - "operationId": "ciProducts_app_getToOneRelated", + "operationId": "endUserLicenseAgreements_territories_getToManyRelated", "parameters": [ { - "name": "fields[apps]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "the fields to include for returned resources of type territories", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" + "currency" ] } }, @@ -129643,338 +135170,197 @@ "explode": false }, { - "name": "fields[appEncryptionDeclarations]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type appEncryptionDeclarations", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "appDescription", - "createdDate", - "usesEncryption", - "exempt", - "containsProprietaryCryptography", - "containsThirdPartyCryptography", - "availableOnFrenchStore", - "platform", - "uploadedDate", - "documentUrl", - "documentName", - "documentType", - "appEncryptionDeclarationState", - "codeValue", - "app", - "builds", - "appEncryptionDeclarationDocument" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "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" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": 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" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": 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" - ] + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "200": { + "description": "List of Territories with get", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TerritoriesWithoutIncludesResponse" + } } - }, - "style": "form", - "explode": 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" - ] + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, - { - "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": "simple", + "required": true + } + ] + }, + "/v2/gameCenterAchievementLocalizations/{id}/relationships/image": { + "get": { + "tags": [ + "GameCenterAchievementLocalizations" + ], + "operationId": "gameCenterAchievementLocalizationsV2_image_getToOneRelationship", + "parameters": [], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": 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" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": 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" - ] + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "fields[appInfos]", - "in": "query", - "description": "the fields to include for returned resources of type appInfos", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "appStoreState", - "state", - "appStoreAgeRating", - "australiaAgeRating", - "brazilAgeRating", - "brazilAgeRatingV2", - "franceAgeRating", - "koreaAgeRating", - "app", - "ageRatingDeclaration", - "appInfoLocalizations", - "primaryCategory", - "primarySubcategoryOne", - "primarySubcategoryTwo", - "secondaryCategory", - "secondarySubcategoryOne", - "secondarySubcategoryTwo", - "territoryAgeRatings" - ] + "200": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterAchievementLocalizationV2ImageLinkageResponse" + } } - }, - "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" - ] + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterAchievementLocalizations/{id}/image": { + "get": { + "tags": [ + "GameCenterAchievementLocalizations" + ], + "operationId": "gameCenterAchievementLocalizationsV2_image_getToOneRelated", + "parameters": [ { - "name": "fields[endUserLicenseAgreements]", + "name": "fields[gameCenterAchievementImages]", "in": "query", - "description": "the fields to include for returned resources of type endUserLicenseAgreements", + "description": "the fields to include for returned resources of type gameCenterAchievementImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "agreementText", - "app", - "territories" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "localization" ] } }, @@ -129982,33 +135368,20 @@ "explode": false }, { - "name": "fields[inAppPurchases]", + "name": "fields[gameCenterAchievementLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchases", + "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "productId", - "inAppPurchaseType", - "state", - "apps", + "locale", "name", - "reviewNote", - "familySharable", - "contentHosting", - "inAppPurchaseLocalizations", - "pricePoints", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", - "versions" + "beforeEarnedDescription", + "afterEarnedDescription", + "version", + "image" ] } }, @@ -130016,146 +135389,212 @@ "explode": false }, { - "name": "fields[subscriptionGroups]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroups", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "subscriptions", - "subscriptionGroupLocalizations", - "versions" + "localization" ] } }, "style": "form", "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "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" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "403": { + "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 GameCenterAchievementImage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterAchievementImageV2Response" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterAchievementLocalizations/{id}/relationships/gameCenterAchievement": { + "get": { + "tags": [ + "GameCenterAchievementLocalizations" + ], + "operationId": "gameCenterAchievementLocalizations_gameCenterAchievement_getToOneRelationship", + "deprecated": true, + "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" + } } - }, - "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" - ] + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "200": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterAchievementLocalizationGameCenterAchievementLinkageResponse" + } } - }, - "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" - ] + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterAchievementLocalizations/{id}/gameCenterAchievement": { + "get": { + "tags": [ + "GameCenterAchievementLocalizations" + ], + "operationId": "gameCenterAchievementLocalizations_gameCenterAchievement_getToOneRelated", + "deprecated": true, + "parameters": [ { - "name": "fields[subscriptionGracePeriods]", + "name": "fields[gameCenterAchievements]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGracePeriods", + "description": "the fields to include for returned resources of type gameCenterAchievements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "optIn", - "sandboxOptIn", - "duration", - "renewalType" + "referenceName", + "vendorIdentifier", + "points", + "showBeforeEarned", + "repeatable", + "archived", + "activityProperties", + "gameCenterDetail", + "gameCenterGroup", + "groupAchievement", + "localizations", + "releases", + "activity" ] } }, @@ -130202,25 +135641,24 @@ "explode": false }, { - "name": "fields[appStoreVersionExperiments]", + "name": "fields[gameCenterGroups]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperiments", + "description": "the fields to include for returned resources of type gameCenterGroups", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "platform", - "trafficProportion", - "state", - "reviewRequired", - "startDate", - "endDate", - "app", - "latestControlVersion", - "controlVersions", - "appStoreVersionExperimentTreatments" + "referenceName", + "gameCenterDetails", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges" ] } }, @@ -130228,16 +135666,20 @@ "explode": false }, { - "name": "fields[androidToIosAppMappingDetails]", + "name": "fields[gameCenterAchievementLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type androidToIosAppMappingDetails", + "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "packageName", - "appSigningKeyPublicCertificateSha256Fingerprints" + "locale", + "name", + "beforeEarnedDescription", + "afterEarnedDescription", + "gameCenterAchievement", + "gameCenterAchievementImage" ] } }, @@ -130245,39 +135687,17 @@ "explode": false }, { - "name": "include", + "name": "fields[gameCenterAchievementReleases]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type gameCenterAchievementReleases", "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", + "live", "gameCenterDetail", - "appStoreVersionExperimentsV2", - "androidToIosAppMappingDetails" + "gameCenterAchievement" ] } }, @@ -130285,89 +135705,60 @@ "explode": false }, { - "name": "limit[appEncryptionDeclarations]", - "in": "query", - "description": "maximum number of related appEncryptionDeclarations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[betaGroups]", - "in": "query", - "description": "maximum number of related betaGroups returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[appStoreVersions]", - "in": "query", - "description": "maximum number of related appStoreVersions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[preReleaseVersions]", - "in": "query", - "description": "maximum number of related preReleaseVersions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[betaAppLocalizations]", - "in": "query", - "description": "maximum number of related betaAppLocalizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[builds]", - "in": "query", - "description": "maximum number of related builds returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[appInfos]", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "maximum number of related appInfos returned (when they are included)", + "description": "the fields to include for returned resources of type gameCenterActivities", "schema": { - "type": "integer", - "maximum": 50 + "type": "array", + "items": { + "type": "string", + "enum": [ + "referenceName", + "vendorIdentifier", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", + "archived", + "properties", + "gameCenterDetail", + "gameCenterGroup", + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" + ] + } }, - "style": "form" + "style": "form", + "explode": false }, { - "name": "limit[appClips]", + "name": "include", "in": "query", - "description": "maximum number of related appClips returned (when they are included)", + "description": "comma-separated list of relationships to include", "schema": { - "type": "integer", - "maximum": 50 + "type": "array", + "items": { + "type": "string", + "enum": [ + "gameCenterDetail", + "gameCenterGroup", + "groupAchievement", + "localizations", + "releases", + "activity" + ] + } }, - "style": "form" + "style": "form", + "explode": false }, { - "name": "limit[inAppPurchases]", + "name": "limit[localizations]", "in": "query", - "description": "maximum number of related inAppPurchases returned (when they are included)", + "description": "maximum number of related localizations returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -130376,95 +135767,15 @@ "deprecated": true }, { - "name": "limit[subscriptionGroups]", - "in": "query", - "description": "maximum number of related subscriptionGroups returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[gameCenterEnabledVersions]", + "name": "limit[releases]", "in": "query", - "description": "maximum number of related gameCenterEnabledVersions returned (when they are included)", + "description": "maximum number of related releases returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, "style": "form", "deprecated": true - }, - { - "name": "limit[appCustomProductPages]", - "in": "query", - "description": "maximum number of related appCustomProductPages returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[inAppPurchasesV2]", - "in": "query", - "description": "maximum number of related inAppPurchasesV2 returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[promotedPurchases]", - "in": "query", - "description": "maximum number of related promotedPurchases returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[appEvents]", - "in": "query", - "description": "maximum number of related appEvents returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[reviewSubmissions]", - "in": "query", - "description": "maximum number of related reviewSubmissions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[appStoreVersionExperimentsV2]", - "in": "query", - "description": "maximum number of related appStoreVersionExperimentsV2 returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[androidToIosAppMappingDetails]", - "in": "query", - "description": "maximum number of related androidToIosAppMappingDetails returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -130509,11 +135820,11 @@ } }, "200": { - "description": "Single App", + "description": "Single GameCenterAchievement", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppResponse" + "$ref": "#/components/schemas/GameCenterAchievementResponse" } } } @@ -130543,24 +135854,14 @@ } ] }, - "/v1/ciProducts/{id}/relationships/buildRuns": { + "/v1/gameCenterAchievementLocalizations/{id}/relationships/gameCenterAchievementImage": { "get": { "tags": [ - "CiProducts" - ], - "operationId": "ciProducts_buildRuns_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterAchievementLocalizations" ], + "operationId": "gameCenterAchievementLocalizations_gameCenterAchievementImage_getToOneRelationship", + "deprecated": true, + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -130603,11 +135904,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiProductBuildRunsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterAchievementLocalizationGameCenterAchievementImageLinkageResponse" } } } @@ -130637,37 +135938,29 @@ } ] }, - "/v1/ciProducts/{id}/buildRuns": { + "/v1/gameCenterAchievementLocalizations/{id}/gameCenterAchievementImage": { "get": { "tags": [ - "CiProducts" + "GameCenterAchievementLocalizations" ], - "operationId": "ciProducts_buildRuns_getToManyRelated", + "operationId": "gameCenterAchievementLocalizations_gameCenterAchievementImage_getToOneRelated", + "deprecated": true, "parameters": [ { - "name": "filter[builds]", - "in": "query", - "description": "filter by id(s) of related 'builds'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "sort", + "name": "fields[gameCenterAchievementImages]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type gameCenterAchievementImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "number", - "-number" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "gameCenterAchievementLocalization" ] } }, @@ -130675,33 +135968,20 @@ "explode": false }, { - "name": "fields[ciBuildRuns]", + "name": "fields[gameCenterAchievementLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type ciBuildRuns", + "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "number", - "createdDate", - "startedDate", - "finishedDate", - "sourceCommit", - "destinationCommit", - "isPullRequestBuild", - "issueCounts", - "executionProgress", - "completionStatus", - "startReason", - "cancelReason", - "builds", - "workflow", - "product", - "sourceBranchOrTag", - "destinationBranch", - "actions", - "pullRequest" + "locale", + "name", + "beforeEarnedDescription", + "afterEarnedDescription", + "gameCenterAchievement", + "gameCenterAchievementImage" ] } }, @@ -130709,99 +135989,214 @@ "explode": false }, { - "name": "fields[builds]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type builds", + "description": "comma-separated list of relationships to include", "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" + "gameCenterAchievementLocalization" ] } }, "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 GameCenterAchievementImage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterAchievementImageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterAchievementVersions/{id}/relationships/localizations": { + "get": { + "tags": [ + "GameCenterAchievementVersions" + ], + "operationId": "gameCenterAchievementVersionsV2_localizations_getToManyRelationship", + "parameters": [ { - "name": "fields[ciWorkflows]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type ciWorkflows", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "description", - "branchStartCondition", - "tagStartCondition", - "pullRequestStartCondition", - "scheduledStartCondition", - "manualBranchStartCondition", - "manualTagStartCondition", - "manualPullRequestStartCondition", - "actions", - "isEnabled", - "isLockedForEditing", - "clean", - "containerFilePath", - "lastModifiedDate", - "product", - "repository", - "xcodeVersion", - "macOsVersion", - "buildRuns" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "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/GameCenterAchievementVersionV2LocalizationsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterAchievementVersions/{id}/localizations": { + "get": { + "tags": [ + "GameCenterAchievementVersions" + ], + "operationId": "gameCenterAchievementVersionsV2_localizations_getToManyRelated", + "parameters": [ { - "name": "fields[ciProducts]", + "name": "fields[gameCenterAchievementLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type ciProducts", + "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "locale", "name", - "createdDate", - "productType", - "app", - "bundleId", - "workflows", - "primaryRepositories", - "additionalRepositories", - "buildRuns" + "beforeEarnedDescription", + "afterEarnedDescription", + "version", + "image" ] } }, @@ -130809,19 +136204,18 @@ "explode": false }, { - "name": "fields[scmGitReferences]", + "name": "fields[gameCenterAchievementVersions]", "in": "query", - "description": "the fields to include for returned resources of type scmGitReferences", + "description": "the fields to include for returned resources of type gameCenterAchievementVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "canonicalName", - "isDeleted", - "kind", - "repository" + "version", + "state", + "achievement", + "localizations" ] } }, @@ -130829,26 +136223,20 @@ "explode": false }, { - "name": "fields[scmPullRequests]", + "name": "fields[gameCenterAchievementImages]", "in": "query", - "description": "the fields to include for returned resources of type scmPullRequests", + "description": "the fields to include for returned resources of type gameCenterAchievementImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "title", - "number", - "webUrl", - "sourceRepositoryOwner", - "sourceRepositoryName", - "sourceBranchName", - "destinationRepositoryOwner", - "destinationRepositoryName", - "destinationBranchName", - "isClosed", - "isCrossRepository", - "repository" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "localization" ] } }, @@ -130874,27 +136262,13 @@ "items": { "type": "string", "enum": [ - "builds", - "workflow", - "product", - "sourceBranchOrTag", - "destinationBranch", - "pullRequest" + "version", + "image" ] } }, "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": { @@ -130939,11 +136313,11 @@ } }, "200": { - "description": "List of CiBuildRuns", + "description": "List of GameCenterAchievementLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiBuildRunsResponse" + "$ref": "#/components/schemas/GameCenterAchievementLocalizationsV2Response" } } } @@ -130973,12 +136347,118 @@ } ] }, - "/v1/ciProducts/{id}/relationships/primaryRepositories": { + "/v2/gameCenterAchievements/{id}/relationships/activity": { + "patch": { + "tags": [ + "GameCenterAchievements" + ], + "operationId": "gameCenterAchievementsV2_activity_updateToOneRelationship", + "requestBody": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterAchievementV2ActivityLinkageRequest" + } + } + }, + "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" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterAchievements/{id}/relationships/versions": { "get": { "tags": [ - "CiProducts" + "GameCenterAchievements" ], - "operationId": "ciProducts_primaryRepositories_getToManyRelationship", + "operationId": "gameCenterAchievementsV2_versions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -131037,7 +136517,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiProductPrimaryRepositoriesLinkagesResponse" + "$ref": "#/components/schemas/GameCenterAchievementV2VersionsLinkagesResponse" } } } @@ -131067,44 +136547,26 @@ } ] }, - "/v1/ciProducts/{id}/primaryRepositories": { + "/v2/gameCenterAchievements/{id}/versions": { "get": { "tags": [ - "CiProducts" + "GameCenterAchievements" ], - "operationId": "ciProducts_primaryRepositories_getToManyRelated", + "operationId": "gameCenterAchievementsV2_versions_getToManyRelated", "parameters": [ { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[scmRepositories]", + "name": "fields[gameCenterAchievementVersions]", "in": "query", - "description": "the fields to include for returned resources of type scmRepositories", + "description": "the fields to include for returned resources of type gameCenterAchievementVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "lastAccessedDate", - "httpCloneUrl", - "sshCloneUrl", - "ownerName", - "repositoryName", - "scmProvider", - "defaultBranch", - "gitReferences", - "pullRequests" + "version", + "state", + "achievement", + "localizations" ] } }, @@ -131112,17 +136574,25 @@ "explode": false }, { - "name": "fields[scmProviders]", + "name": "fields[gameCenterAchievements]", "in": "query", - "description": "the fields to include for returned resources of type scmProviders", + "description": "the fields to include for returned resources of type gameCenterAchievements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "scmProviderType", - "url", - "repositories" + "referenceName", + "vendorIdentifier", + "points", + "showBeforeEarned", + "repeatable", + "archived", + "activityProperties", + "gameCenterDetail", + "gameCenterGroup", + "activity", + "versions" ] } }, @@ -131130,19 +136600,20 @@ "explode": false }, { - "name": "fields[scmGitReferences]", + "name": "fields[gameCenterAchievementLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type scmGitReferences", + "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "locale", "name", - "canonicalName", - "isDeleted", - "kind", - "repository" + "beforeEarnedDescription", + "afterEarnedDescription", + "version", + "image" ] } }, @@ -131168,13 +136639,23 @@ "items": { "type": "string", "enum": [ - "scmProvider", - "defaultBranch" + "achievement", + "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": { @@ -131219,11 +136700,11 @@ } }, "200": { - "description": "List of ScmRepositories", + "description": "List of GameCenterAchievementVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScmRepositoriesResponse" + "$ref": "#/components/schemas/GameCenterAchievementVersionsV2Response" } } } @@ -131252,25 +136733,25 @@ "required": true } ] - }, - "/v1/ciProducts/{id}/relationships/workflows": { - "get": { - "tags": [ - "CiProducts" - ], - "operationId": "ciProducts_workflows_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + }, + "/v1/gameCenterAchievements/{id}/relationships/activity": { + "patch": { + "tags": [ + "GameCenterAchievements" ], + "operationId": "gameCenterAchievements_activity_updateToOneRelationship", + "deprecated": true, + "requestBody": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterAchievementActivityLinkageRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -131312,16 +136793,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiProductWorkflowsLinkagesResponse" + "$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": { @@ -131347,163 +136841,14 @@ } ] }, - "/v1/ciProducts/{id}/workflows": { + "/v1/gameCenterAchievements/{id}/relationships/groupAchievement": { "get": { "tags": [ - "CiProducts" - ], - "operationId": "ciProducts_workflows_getToManyRelated", - "parameters": [ - { - "name": "fields[ciWorkflows]", - "in": "query", - "description": "the fields to include for returned resources of type ciWorkflows", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "description", - "branchStartCondition", - "tagStartCondition", - "pullRequestStartCondition", - "scheduledStartCondition", - "manualBranchStartCondition", - "manualTagStartCondition", - "manualPullRequestStartCondition", - "actions", - "isEnabled", - "isLockedForEditing", - "clean", - "containerFilePath", - "lastModifiedDate", - "product", - "repository", - "xcodeVersion", - "macOsVersion", - "buildRuns" - ] - } - }, - "style": "form", - "explode": 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 - }, - { - "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": "fields[ciXcodeVersions]", - "in": "query", - "description": "the fields to include for returned resources of type ciXcodeVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "name", - "testDestinations", - "macOsVersions" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[ciMacOsVersions]", - "in": "query", - "description": "the fields to include for returned resources of type ciMacOsVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "name", - "xcodeVersions" - ] - } - }, - "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": [ - "product", - "repository", - "xcodeVersion", - "macOsVersion" - ] - } - }, - "style": "form", - "explode": false - } + "GameCenterAchievements" ], + "operationId": "gameCenterAchievements_groupAchievement_getToOneRelationship", + "deprecated": true, + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -131546,11 +136891,11 @@ } }, "200": { - "description": "List of CiWorkflows", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiWorkflowsResponse" + "$ref": "#/components/schemas/GameCenterAchievementGroupAchievementLinkageResponse" } } } @@ -131567,37 +136912,23 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/ciWorkflows/{id}/relationships/buildRuns": { - "get": { + "patch": { "tags": [ - "CiWorkflows" - ], - "operationId": "ciWorkflows_buildRuns_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterAchievements" ], + "operationId": "gameCenterAchievements_groupAchievement_updateToOneRelationship", + "deprecated": true, + "requestBody": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterAchievementGroupAchievementLinkageRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -131639,16 +136970,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiWorkflowBuildRunsLinkagesResponse" + "$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": { @@ -131674,37 +137018,36 @@ } ] }, - "/v1/ciWorkflows/{id}/buildRuns": { + "/v1/gameCenterAchievements/{id}/groupAchievement": { "get": { "tags": [ - "CiWorkflows" + "GameCenterAchievements" ], - "operationId": "ciWorkflows_buildRuns_getToManyRelated", + "operationId": "gameCenterAchievements_groupAchievement_getToOneRelated", + "deprecated": true, "parameters": [ { - "name": "filter[builds]", - "in": "query", - "description": "filter by id(s) of related 'builds'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "sort", + "name": "fields[gameCenterAchievements]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type gameCenterAchievements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "number", - "-number" + "referenceName", + "vendorIdentifier", + "points", + "showBeforeEarned", + "repeatable", + "archived", + "activityProperties", + "gameCenterDetail", + "gameCenterGroup", + "groupAchievement", + "localizations", + "releases", + "activity" ] } }, @@ -131712,33 +137055,38 @@ "explode": false }, { - "name": "fields[ciBuildRuns]", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "the fields to include for returned resources of type ciBuildRuns", + "description": "the fields to include for returned resources of type gameCenterDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "number", - "createdDate", - "startedDate", - "finishedDate", - "sourceCommit", - "destinationCommit", - "isPullRequestBuild", - "issueCounts", - "executionProgress", - "completionStatus", - "startReason", - "cancelReason", - "builds", - "workflow", - "product", - "sourceBranchOrTag", - "destinationBranch", - "actions", - "pullRequest" + "arcadeEnabled", + "challengeEnabled", + "app", + "gameCenterAppVersions", + "gameCenterGroup", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges", + "defaultLeaderboard", + "defaultLeaderboardV2", + "defaultGroupLeaderboard", + "defaultGroupLeaderboardV2", + "achievementReleases", + "activityReleases", + "challengeReleases", + "leaderboardReleases", + "leaderboardSetReleases", + "blockedPlayers", + "challengesMinimumPlatformVersions" ] } }, @@ -131746,40 +137094,24 @@ "explode": false }, { - "name": "fields[builds]", + "name": "fields[gameCenterGroups]", "in": "query", - "description": "the fields to include for returned resources of type builds", + "description": "the fields to include for returned resources of type gameCenterGroups", "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" + "referenceName", + "gameCenterDetails", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges" ] } }, @@ -131787,34 +137119,20 @@ "explode": false }, { - "name": "fields[ciWorkflows]", + "name": "fields[gameCenterAchievementLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type ciWorkflows", + "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "locale", "name", - "description", - "branchStartCondition", - "tagStartCondition", - "pullRequestStartCondition", - "scheduledStartCondition", - "manualBranchStartCondition", - "manualTagStartCondition", - "manualPullRequestStartCondition", - "actions", - "isEnabled", - "isLockedForEditing", - "clean", - "containerFilePath", - "lastModifiedDate", - "product", - "repository", - "xcodeVersion", - "macOsVersion", - "buildRuns" + "beforeEarnedDescription", + "afterEarnedDescription", + "gameCenterAchievement", + "gameCenterAchievementImage" ] } }, @@ -131822,23 +137140,17 @@ "explode": false }, { - "name": "fields[ciProducts]", + "name": "fields[gameCenterAchievementReleases]", "in": "query", - "description": "the fields to include for returned resources of type ciProducts", + "description": "the fields to include for returned resources of type gameCenterAchievementReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "createdDate", - "productType", - "app", - "bundleId", - "workflows", - "primaryRepositories", - "additionalRepositories", - "buildRuns" + "live", + "gameCenterDetail", + "gameCenterAchievement" ] } }, @@ -131846,19 +137158,29 @@ "explode": false }, { - "name": "fields[scmGitReferences]", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "the fields to include for returned resources of type scmGitReferences", + "description": "the fields to include for returned resources of type gameCenterActivities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "canonicalName", - "isDeleted", - "kind", - "repository" + "referenceName", + "vendorIdentifier", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", + "archived", + "properties", + "gameCenterDetail", + "gameCenterGroup", + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" ] } }, @@ -131866,26 +137188,20 @@ "explode": false }, { - "name": "fields[scmPullRequests]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type scmPullRequests", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "title", - "number", - "webUrl", - "sourceRepositoryOwner", - "sourceRepositoryName", - "sourceBranchName", - "destinationRepositoryOwner", - "destinationRepositoryName", - "destinationBranchName", - "isClosed", - "isCrossRepository", - "repository" + "gameCenterDetail", + "gameCenterGroup", + "groupAchievement", + "localizations", + "releases", + "activity" ] } }, @@ -131893,45 +137209,26 @@ "explode": false }, { - "name": "limit", + "name": "limit[localizations]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related localizations returned (when they are included)", "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": [ - "builds", - "workflow", - "product", - "sourceBranchOrTag", - "destinationBranch", - "pullRequest" - ] - } + "maximum": 50 }, "style": "form", - "explode": false + "deprecated": true }, { - "name": "limit[builds]", + "name": "limit[releases]", "in": "query", - "description": "maximum number of related builds returned (when they are included)", + "description": "maximum number of related releases returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, - "style": "form" + "style": "form", + "deprecated": true } ], "responses": { @@ -131976,11 +137273,11 @@ } }, "200": { - "description": "List of CiBuildRuns", + "description": "Single GameCenterAchievement", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiBuildRunsResponse" + "$ref": "#/components/schemas/GameCenterAchievementResponse" } } } @@ -132010,13 +137307,25 @@ } ] }, - "/v1/ciWorkflows/{id}/relationships/repository": { + "/v1/gameCenterAchievements/{id}/relationships/localizations": { "get": { "tags": [ - "CiWorkflows" + "GameCenterAchievements" + ], + "operationId": "gameCenterAchievements_localizations_getToManyRelationship", + "deprecated": true, + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "ciWorkflows_repository_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -132059,11 +137368,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiWorkflowRepositoryLinkageResponse" + "$ref": "#/components/schemas/GameCenterAchievementLocalizationsLinkagesResponse" } } } @@ -132093,31 +137402,29 @@ } ] }, - "/v1/ciWorkflows/{id}/repository": { + "/v1/gameCenterAchievements/{id}/localizations": { "get": { "tags": [ - "CiWorkflows" + "GameCenterAchievements" ], - "operationId": "ciWorkflows_repository_getToOneRelated", + "operationId": "gameCenterAchievements_localizations_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[scmRepositories]", + "name": "fields[gameCenterAchievementLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type scmRepositories", + "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "lastAccessedDate", - "httpCloneUrl", - "sshCloneUrl", - "ownerName", - "repositoryName", - "scmProvider", - "defaultBranch", - "gitReferences", - "pullRequests" + "locale", + "name", + "beforeEarnedDescription", + "afterEarnedDescription", + "gameCenterAchievement", + "gameCenterAchievementImage" ] } }, @@ -132125,17 +137432,27 @@ "explode": false }, { - "name": "fields[scmProviders]", + "name": "fields[gameCenterAchievements]", "in": "query", - "description": "the fields to include for returned resources of type scmProviders", + "description": "the fields to include for returned resources of type gameCenterAchievements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "scmProviderType", - "url", - "repositories" + "referenceName", + "vendorIdentifier", + "points", + "showBeforeEarned", + "repeatable", + "archived", + "activityProperties", + "gameCenterDetail", + "gameCenterGroup", + "groupAchievement", + "localizations", + "releases", + "activity" ] } }, @@ -132143,25 +137460,36 @@ "explode": false }, { - "name": "fields[scmGitReferences]", + "name": "fields[gameCenterAchievementImages]", "in": "query", - "description": "the fields to include for returned resources of type scmGitReferences", + "description": "the fields to include for returned resources of type gameCenterAchievementImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "canonicalName", - "isDeleted", - "kind", - "repository" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "gameCenterAchievementLocalization" ] } }, "style": "form", "explode": false }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, { "name": "include", "in": "query", @@ -132171,8 +137499,8 @@ "items": { "type": "string", "enum": [ - "scmProvider", - "defaultBranch" + "gameCenterAchievement", + "gameCenterAchievementImage" ] } }, @@ -132222,11 +137550,11 @@ } }, "200": { - "description": "Single ScmRepository", + "description": "List of GameCenterAchievementLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScmRepositoryResponse" + "$ref": "#/components/schemas/GameCenterAchievementLocalizationsResponse" } } } @@ -132256,12 +137584,13 @@ } ] }, - "/v1/ciXcodeVersions/{id}/relationships/macOsVersions": { + "/v1/gameCenterAchievements/{id}/relationships/releases": { "get": { "tags": [ - "CiXcodeVersions" + "GameCenterAchievements" ], - "operationId": "ciXcodeVersions_macOsVersions_getToManyRelationship", + "operationId": "gameCenterAchievements_releases_getToManyRelationship", + "deprecated": true, "parameters": [ { "name": "limit", @@ -132320,7 +137649,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiXcodeVersionMacOsVersionsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterAchievementReleasesLinkagesResponse" } } } @@ -132350,25 +137679,52 @@ } ] }, - "/v1/ciXcodeVersions/{id}/macOsVersions": { + "/v1/gameCenterAchievements/{id}/releases": { "get": { "tags": [ - "CiXcodeVersions" + "GameCenterAchievements" ], - "operationId": "ciXcodeVersions_macOsVersions_getToManyRelated", + "operationId": "gameCenterAchievements_releases_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[ciMacOsVersions]", + "name": "filter[live]", "in": "query", - "description": "the fields to include for returned resources of type ciMacOsVersions", + "description": "filter by attribute 'live'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[gameCenterDetail]", + "in": "query", + "description": "filter by id(s) of related 'gameCenterDetail'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "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": [ - "version", - "name", - "xcodeVersions" + "live", + "gameCenterDetail", + "gameCenterAchievement" ] } }, @@ -132376,18 +137732,66 @@ "explode": false }, { - "name": "fields[ciXcodeVersions]", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "the fields to include for returned resources of type ciXcodeVersions", + "description": "the fields to include for returned resources of type gameCenterDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "name", - "testDestinations", - "macOsVersions" + "arcadeEnabled", + "challengeEnabled", + "app", + "gameCenterAppVersions", + "gameCenterGroup", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges", + "defaultLeaderboard", + "defaultLeaderboardV2", + "defaultGroupLeaderboard", + "defaultGroupLeaderboardV2", + "achievementReleases", + "activityReleases", + "challengeReleases", + "leaderboardReleases", + "leaderboardSetReleases", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] + } + }, + "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" ] } }, @@ -132413,22 +137817,13 @@ "items": { "type": "string", "enum": [ - "xcodeVersions" + "gameCenterDetail", + "gameCenterAchievement" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[xcodeVersions]", - "in": "query", - "description": "maximum number of related xcodeVersions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -132473,11 +137868,11 @@ } }, "200": { - "description": "List of CiMacOsVersions", + "description": "List of GameCenterAchievementReleases", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CiMacOsVersionsResponse" + "$ref": "#/components/schemas/GameCenterAchievementReleasesResponse" } } } @@ -132507,13 +137902,24 @@ } ] }, - "/v1/customerReviews/{id}/relationships/response": { - "get": { + "/v1/gameCenterActivities/{id}/relationships/achievements": { + "post": { "tags": [ - "CustomerReviews" + "GameCenterActivities" ], - "operationId": "customerReviews_response_getToOneRelationship", - "parameters": [], + "operationId": "gameCenterActivities_achievements_createToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterActivityAchievementsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -132555,16 +137961,29 @@ } } }, - "200": { - "description": "Related linkage", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerReviewResponseLinkageResponse" + "$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": { @@ -132577,85 +137996,23 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/customerReviews/{id}/response": { - "get": { + "delete": { "tags": [ - "CustomerReviews" + "GameCenterActivities" ], - "operationId": "customerReviews_response_getToOneRelated", - "parameters": [ - { - "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[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" - ] + "operationId": "gameCenterActivities_achievements_deleteToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterActivityAchievementsLinkagesRequest" } - }, - "style": "form", - "explode": false + } }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "review" - ] - } - }, - "style": "form", - "explode": false - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -132697,16 +138054,29 @@ } } }, - "200": { - "description": "Single CustomerReviewResponse", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerReviewResponseV1Response" + "$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": { @@ -132732,24 +138102,115 @@ } ] }, - "/v1/diagnosticSignatures/{id}/logs": { - "get": { + "/v1/gameCenterActivities/{id}/relationships/achievementsV2": { + "post": { "tags": [ - "DiagnosticSignatures" + "GameCenterActivities" ], - "operationId": "diagnosticSignatures_logs_getToManyRelated", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" + "operationId": "gameCenterActivities_achievementsV2_createToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterActivityAchievementsV2LinkagesRequest" + } + } + }, + "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" + } + } + } } + } + }, + "delete": { + "tags": [ + "GameCenterActivities" ], + "operationId": "gameCenterActivities_achievementsV2_deleteToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterActivityAchievementsV2LinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -132781,8 +138242,18 @@ } } }, - "404": { - "description": "Not found error", + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { @@ -132791,16 +138262,19 @@ } } }, - "200": { - "description": "List of DiagnosticLogs", + "409": { + "description": "Request entity error(s)", "content": { - "application/vnd.apple.diagnostic-logs+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/diagnosticLogs" + "$ref": "#/components/schemas/ErrorResponse" } } } }, + "204": { + "description": "Success (no content)" + }, "429": { "description": "Rate limit exceeded error", "content": { @@ -132826,24 +138300,24 @@ } ] }, - "/v1/endUserLicenseAgreements/{id}/relationships/territories": { - "get": { + "/v1/gameCenterActivities/{id}/relationships/leaderboards": { + "post": { "tags": [ - "EndUserLicenseAgreements" - ], - "operationId": "endUserLicenseAgreements_territories_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterActivities" ], + "operationId": "gameCenterActivities_leaderboards_createToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterActivityLeaderboardsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -132885,16 +138359,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EndUserLicenseAgreementTerritoriesLinkagesResponse" + "$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": { @@ -132907,53 +138394,23 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/endUserLicenseAgreements/{id}/territories": { - "get": { + "delete": { "tags": [ - "EndUserLicenseAgreements" + "GameCenterActivities" ], - "operationId": "endUserLicenseAgreements_territories_getToManyRelated", - "parameters": [ - { - "name": "fields[territories]", - "in": "query", - "description": "the fields to include for returned resources of type territories", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "currency" - ] + "operationId": "gameCenterActivities_leaderboards_deleteToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterActivityLeaderboardsLinkagesRequest" } - }, - "style": "form", - "explode": false + } }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -132995,16 +138452,29 @@ } } }, - "200": { - "description": "List of Territories with get", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoriesWithoutIncludesResponse" + "$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": { @@ -133030,13 +138500,23 @@ } ] }, - "/v2/gameCenterAchievementLocalizations/{id}/relationships/image": { - "get": { + "/v1/gameCenterActivities/{id}/relationships/leaderboardsV2": { + "post": { "tags": [ - "GameCenterAchievementLocalizations" + "GameCenterActivities" ], - "operationId": "gameCenterAchievementLocalizationsV2_image_getToOneRelationship", - "parameters": [], + "operationId": "gameCenterActivities_leaderboardsV2_createToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterActivityLeaderboardsV2LinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -133078,16 +138558,29 @@ } } }, - "200": { - "description": "Related linkage", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementLocalizationV2ImageLinkageResponse" + "$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": { @@ -133100,85 +138593,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v2/gameCenterAchievementLocalizations/{id}/image": { - "get": { + "delete": { "tags": [ - "GameCenterAchievementLocalizations" + "GameCenterActivities" ], - "operationId": "gameCenterAchievementLocalizationsV2_image_getToOneRelated", - "parameters": [ - { - "name": "fields[gameCenterAchievementImages]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState", - "localization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterAchievementLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "beforeEarnedDescription", - "afterEarnedDescription", - "version", - "image" - ] + "operationId": "gameCenterActivities_leaderboardsV2_deleteToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterActivityLeaderboardsV2LinkagesRequest" } - }, - "style": "form", - "explode": false + } }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "localization" - ] - } - }, - "style": "form", - "explode": false - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -133220,16 +138650,29 @@ } } }, - "200": { - "description": "Single GameCenterAchievementImage", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementImageV2Response" + "$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": { @@ -133255,14 +138698,24 @@ } ] }, - "/v1/gameCenterAchievementLocalizations/{id}/relationships/gameCenterAchievement": { + "/v1/gameCenterActivities/{id}/relationships/versions": { "get": { "tags": [ - "GameCenterAchievementLocalizations" + "GameCenterActivities" + ], + "operationId": "gameCenterActivities_versions_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "gameCenterAchievementLocalizations_gameCenterAchievement_getToOneRelationship", - "deprecated": true, - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -133305,11 +138758,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementLocalizationGameCenterAchievementLinkageResponse" + "$ref": "#/components/schemas/GameCenterActivityVersionsLinkagesResponse" } } } @@ -133339,36 +138792,29 @@ } ] }, - "/v1/gameCenterAchievementLocalizations/{id}/gameCenterAchievement": { + "/v1/gameCenterActivities/{id}/versions": { "get": { "tags": [ - "GameCenterAchievementLocalizations" + "GameCenterActivities" ], - "operationId": "gameCenterAchievementLocalizations_gameCenterAchievement_getToOneRelated", - "deprecated": true, + "operationId": "gameCenterActivities_versions_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterAchievements]", + "name": "fields[gameCenterActivityVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievements", + "description": "the fields to include for returned resources of type gameCenterActivityVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "points", - "showBeforeEarned", - "repeatable", - "archived", - "activityProperties", - "gameCenterDetail", - "gameCenterGroup", - "groupAchievement", + "version", + "state", + "fallbackUrl", + "activity", "localizations", - "releases", - "activity" + "defaultImage", + "releases" ] } }, @@ -133376,38 +138822,29 @@ "explode": false }, { - "name": "fields[gameCenterDetails]", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterDetails", + "description": "the fields to include for returned resources of type gameCenterActivities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "arcadeEnabled", - "challengeEnabled", - "app", - "gameCenterAppVersions", + "referenceName", + "vendorIdentifier", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", + "archived", + "properties", + "gameCenterDetail", "gameCenterGroup", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges", - "defaultLeaderboard", - "defaultLeaderboardV2", - "defaultGroupLeaderboard", - "defaultGroupLeaderboardV2", - "achievementReleases", - "activityReleases", - "challengeReleases", - "leaderboardReleases", - "leaderboardSetReleases", - "blockedPlayers", - "challengesMinimumPlatformVersions" + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" ] } }, @@ -133415,24 +138852,19 @@ "explode": false }, { - "name": "fields[gameCenterGroups]", + "name": "fields[gameCenterActivityLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterGroups", + "description": "the fields to include for returned resources of type gameCenterActivityLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "gameCenterDetails", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges" + "locale", + "name", + "description", + "version", + "image" ] } }, @@ -133440,20 +138872,19 @@ "explode": false }, { - "name": "fields[gameCenterAchievementLocalizations]", + "name": "fields[gameCenterActivityImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", + "description": "the fields to include for returned resources of type gameCenterActivityImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "name", - "beforeEarnedDescription", - "afterEarnedDescription", - "gameCenterAchievement", - "gameCenterAchievementImage" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState" ] } }, @@ -133461,17 +138892,15 @@ "explode": false }, { - "name": "fields[gameCenterAchievementReleases]", + "name": "fields[gameCenterActivityVersionReleases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementReleases", + "description": "the fields to include for returned resources of type gameCenterActivityVersionReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", - "gameCenterDetail", - "gameCenterAchievement" + "version" ] } }, @@ -133479,34 +138908,14 @@ "explode": false }, { - "name": "fields[gameCenterActivities]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivities", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "referenceName", - "vendorIdentifier", - "playStyle", - "minimumPlayersCount", - "maximumPlayersCount", - "supportsPartyCode", - "archived", - "properties", - "gameCenterDetail", - "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", - "versions" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { "name": "include", @@ -133517,12 +138926,10 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterGroup", - "groupAchievement", + "activity", "localizations", - "releases", - "activity" + "defaultImage", + "releases" ] } }, @@ -133537,8 +138944,7 @@ "type": "integer", "maximum": 50 }, - "style": "form", - "deprecated": true + "style": "form" }, { "name": "limit[releases]", @@ -133594,11 +139000,11 @@ } }, "200": { - "description": "Single GameCenterAchievement", + "description": "List of GameCenterActivityVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementResponse" + "$ref": "#/components/schemas/GameCenterActivityVersionsResponse" } } } @@ -133628,13 +139034,12 @@ } ] }, - "/v1/gameCenterAchievementLocalizations/{id}/relationships/gameCenterAchievementImage": { + "/v1/gameCenterActivityLocalizations/{id}/relationships/image": { "get": { "tags": [ - "GameCenterAchievementLocalizations" + "GameCenterActivityLocalizations" ], - "operationId": "gameCenterAchievementLocalizations_gameCenterAchievementImage_getToOneRelationship", - "deprecated": true, + "operationId": "gameCenterActivityLocalizations_image_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -133682,7 +139087,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementLocalizationGameCenterAchievementImageLinkageResponse" + "$ref": "#/components/schemas/GameCenterActivityLocalizationImageLinkageResponse" } } } @@ -133712,18 +139117,17 @@ } ] }, - "/v1/gameCenterAchievementLocalizations/{id}/gameCenterAchievementImage": { + "/v1/gameCenterActivityLocalizations/{id}/image": { "get": { "tags": [ - "GameCenterAchievementLocalizations" + "GameCenterActivityLocalizations" ], - "operationId": "gameCenterAchievementLocalizations_gameCenterAchievementImage_getToOneRelated", - "deprecated": true, + "operationId": "gameCenterActivityLocalizations_image_getToOneRelated", "parameters": [ { - "name": "fields[gameCenterAchievementImages]", + "name": "fields[gameCenterActivityImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementImages", + "description": "the fields to include for returned resources of type gameCenterActivityImages", "schema": { "type": "array", "items": { @@ -133733,45 +139137,7 @@ "fileName", "imageAsset", "uploadOperations", - "assetDeliveryState", - "gameCenterAchievementLocalization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterAchievementLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "beforeEarnedDescription", - "afterEarnedDescription", - "gameCenterAchievement", - "gameCenterAchievementImage" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "gameCenterAchievementLocalization" + "assetDeliveryState" ] } }, @@ -133821,11 +139187,11 @@ } }, "200": { - "description": "Single GameCenterAchievementImage", + "description": "Single GameCenterActivityImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementImageResponse" + "$ref": "#/components/schemas/GameCenterActivityImageResponse" } } } @@ -133855,24 +139221,13 @@ } ] }, - "/v2/gameCenterAchievementVersions/{id}/relationships/localizations": { + "/v1/gameCenterActivityVersions/{id}/relationships/defaultImage": { "get": { "tags": [ - "GameCenterAchievementVersions" - ], - "operationId": "gameCenterAchievementVersionsV2_localizations_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterActivityVersions" ], + "operationId": "gameCenterActivityVersions_defaultImage_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -133915,11 +139270,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementVersionV2LocalizationsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterActivityVersionDefaultImageLinkageResponse" } } } @@ -133949,57 +139304,17 @@ } ] }, - "/v2/gameCenterAchievementVersions/{id}/localizations": { + "/v1/gameCenterActivityVersions/{id}/defaultImage": { "get": { "tags": [ - "GameCenterAchievementVersions" + "GameCenterActivityVersions" ], - "operationId": "gameCenterAchievementVersionsV2_localizations_getToManyRelated", + "operationId": "gameCenterActivityVersions_defaultImage_getToOneRelated", "parameters": [ { - "name": "fields[gameCenterAchievementLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "beforeEarnedDescription", - "afterEarnedDescription", - "version", - "image" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterAchievementVersions]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "achievement", - "localizations" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterAchievementImages]", + "name": "fields[gameCenterActivityImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementImages", + "description": "the fields to include for returned resources of type gameCenterActivityImages", "schema": { "type": "array", "items": { @@ -134009,35 +139324,7 @@ "fileName", "imageAsset", "uploadOperations", - "assetDeliveryState", - "localization" - ] - } - }, - "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": [ - "version", - "image" + "assetDeliveryState" ] } }, @@ -134087,121 +139374,15 @@ } }, "200": { - "description": "List of GameCenterAchievementLocalizations", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterAchievementLocalizationsV2Response" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v2/gameCenterAchievements/{id}/relationships/activity": { - "patch": { - "tags": [ - "GameCenterAchievements" - ], - "operationId": "gameCenterAchievementsV2_activity_updateToOneRelationship", - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterAchievementV2ActivityLinkageRequest" - } - } - }, - "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)", + "description": "Single GameCenterActivityImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterActivityImageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -134227,12 +139408,12 @@ } ] }, - "/v2/gameCenterAchievements/{id}/relationships/versions": { + "/v1/gameCenterActivityVersions/{id}/relationships/localizations": { "get": { "tags": [ - "GameCenterAchievements" + "GameCenterActivityVersions" ], - "operationId": "gameCenterAchievementsV2_versions_getToManyRelationship", + "operationId": "gameCenterActivityVersions_localizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -134291,7 +139472,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementV2VersionsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterActivityVersionLocalizationsLinkagesResponse" } } } @@ -134321,26 +139502,27 @@ } ] }, - "/v2/gameCenterAchievements/{id}/versions": { + "/v1/gameCenterActivityVersions/{id}/localizations": { "get": { "tags": [ - "GameCenterAchievements" + "GameCenterActivityVersions" ], - "operationId": "gameCenterAchievementsV2_versions_getToManyRelated", + "operationId": "gameCenterActivityVersions_localizations_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterAchievementVersions]", + "name": "fields[gameCenterActivityLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementVersions", + "description": "the fields to include for returned resources of type gameCenterActivityLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "locale", + "name", + "description", "version", - "state", - "achievement", - "localizations" + "image" ] } }, @@ -134348,25 +139530,21 @@ "explode": false }, { - "name": "fields[gameCenterAchievements]", + "name": "fields[gameCenterActivityVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievements", + "description": "the fields to include for returned resources of type gameCenterActivityVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "points", - "showBeforeEarned", - "repeatable", - "archived", - "activityProperties", - "gameCenterDetail", - "gameCenterGroup", + "version", + "state", + "fallbackUrl", "activity", - "versions" + "localizations", + "defaultImage", + "releases" ] } }, @@ -134374,20 +139552,19 @@ "explode": false }, { - "name": "fields[gameCenterAchievementLocalizations]", + "name": "fields[gameCenterActivityImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", + "description": "the fields to include for returned resources of type gameCenterActivityImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "name", - "beforeEarnedDescription", - "afterEarnedDescription", - "version", - "image" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState" ] } }, @@ -134413,23 +139590,13 @@ "items": { "type": "string", "enum": [ - "achievement", - "localizations" + "version", + "image" ] } }, "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": { @@ -134474,122 +139641,15 @@ } }, "200": { - "description": "List of GameCenterAchievementVersions", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterAchievementVersionsV2Response" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterAchievements/{id}/relationships/activity": { - "patch": { - "tags": [ - "GameCenterAchievements" - ], - "operationId": "gameCenterAchievements_activity_updateToOneRelationship", - "deprecated": true, - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterAchievementActivityLinkageRequest" - } - } - }, - "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)", + "description": "List of GameCenterActivityLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterActivityLocalizationsResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -134607,102 +139667,21 @@ "name": "id", "in": "path", "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterAchievements/{id}/relationships/groupAchievement": { - "get": { - "tags": [ - "GameCenterAchievements" - ], - "operationId": "gameCenterAchievements_groupAchievement_getToOneRelationship", - "deprecated": true, - "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/GameCenterAchievementGroupAchievementLinkageResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "patch": { - "tags": [ - "GameCenterAchievements" - ], - "operationId": "gameCenterAchievements_groupAchievement_updateToOneRelationship", - "deprecated": true, - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterAchievementGroupAchievementLinkageRequest" - } - } + "schema": { + "type": "string" }, + "style": "simple", "required": true - }, + } + ] + }, + "/v1/gameCenterAppVersions/{id}/relationships/appStoreVersion": { + "get": { + "tags": [ + "GameCenterAppVersions" + ], + "operationId": "gameCenterAppVersions_appStoreVersion_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -134744,29 +139723,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterAppVersionAppStoreVersionLinkageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -134792,36 +139758,119 @@ } ] }, - "/v1/gameCenterAchievements/{id}/groupAchievement": { + "/v1/gameCenterAppVersions/{id}/appStoreVersion": { "get": { "tags": [ - "GameCenterAchievements" + "GameCenterAppVersions" ], - "operationId": "gameCenterAchievements_groupAchievement_getToOneRelated", - "deprecated": true, + "operationId": "gameCenterAppVersions_appStoreVersion_getToOneRelated", "parameters": [ { - "name": "fields[gameCenterAchievements]", + "name": "fields[appStoreVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievements", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "points", - "showBeforeEarned", - "repeatable", - "archived", - "activityProperties", + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", "gameCenterDetail", - "gameCenterGroup", - "groupAchievement", - "localizations", - "releases", - "activity" + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, @@ -134829,38 +139878,67 @@ "explode": false }, { - "name": "fields[gameCenterDetails]", + "name": "fields[appStoreVersionLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterDetails", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "arcadeEnabled", - "challengeEnabled", + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "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", - "gameCenterAppVersions", - "gameCenterGroup", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges", - "defaultLeaderboard", - "defaultLeaderboardV2", - "defaultGroupLeaderboard", - "defaultGroupLeaderboardV2", - "achievementReleases", - "activityReleases", - "challengeReleases", - "leaderboardReleases", - "leaderboardSetReleases", - "blockedPlayers", - "challengesMinimumPlatformVersions" + "buildBetaDetail", + "appStoreVersion", + "icons", + "buildBundles", + "buildUpload", + "perfPowerMetrics", + "diagnosticSignatures" ] } }, @@ -134868,24 +139946,18 @@ "explode": false }, { - "name": "fields[gameCenterGroups]", + "name": "fields[appStoreVersionPhasedReleases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterGroups", + "description": "the fields to include for returned resources of type appStoreVersionPhasedReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "gameCenterDetails", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges" + "phasedReleaseState", + "startDate", + "totalPauseDuration", + "currentDayNumber" ] } }, @@ -134893,20 +139965,17 @@ "explode": false }, { - "name": "fields[gameCenterAchievementLocalizations]", + "name": "fields[gameCenterAppVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", + "description": "the fields to include for returned resources of type gameCenterAppVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "name", - "beforeEarnedDescription", - "afterEarnedDescription", - "gameCenterAchievement", - "gameCenterAchievementImage" + "enabled", + "compatibilityVersions", + "appStoreVersion" ] } }, @@ -134914,17 +139983,20 @@ "explode": false }, { - "name": "fields[gameCenterAchievementReleases]", + "name": "fields[routingAppCoverages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementReleases", + "description": "the fields to include for returned resources of type routingAppCoverages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", - "gameCenterDetail", - "gameCenterAchievement" + "fileSize", + "fileName", + "sourceFileChecksum", + "uploadOperations", + "assetDeliveryState", + "appStoreVersion" ] } }, @@ -134932,28 +140004,103 @@ "explode": false }, { - "name": "fields[gameCenterActivities]", + "name": "fields[appStoreReviewDetails]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivities", + "description": "the fields to include for returned resources of type appStoreReviewDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "playStyle", - "minimumPlayersCount", - "maximumPlayersCount", - "supportsPartyCode", - "archived", - "properties", - "gameCenterDetail", - "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", + "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" ] } @@ -134970,12 +140117,18 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterGroup", - "groupAchievement", - "localizations", - "releases", - "activity" + "app", + "appStoreVersionLocalizations", + "build", + "appStoreVersionPhasedRelease", + "gameCenterAppVersion", + "routingAppCoverage", + "appStoreReviewDetail", + "appStoreVersionSubmission", + "appClipDefaultExperience", + "appStoreVersionExperiments", + "appStoreVersionExperimentsV2", + "alternativeDistributionPackage" ] } }, @@ -134983,26 +140136,35 @@ "explode": false }, { - "name": "limit[localizations]", + "name": "limit[appStoreVersionLocalizations]", "in": "query", - "description": "maximum number of related localizations returned (when they are included)", + "description": "maximum number of related appStoreVersionLocalizations returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, - "style": "form", - "deprecated": true + "style": "form" }, { - "name": "limit[releases]", + "name": "limit[appStoreVersionExperiments]", "in": "query", - "description": "maximum number of related releases returned (when they are included)", + "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": { @@ -135047,11 +140209,11 @@ } }, "200": { - "description": "Single GameCenterAchievement", + "description": "Single AppStoreVersion", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementResponse" + "$ref": "#/components/schemas/AppStoreVersionResponse" } } } @@ -135081,13 +140243,12 @@ } ] }, - "/v1/gameCenterAchievements/{id}/relationships/localizations": { + "/v1/gameCenterAppVersions/{id}/relationships/compatibilityVersions": { "get": { "tags": [ - "GameCenterAchievements" + "GameCenterAppVersions" ], - "operationId": "gameCenterAchievements_localizations_getToManyRelationship", - "deprecated": true, + "operationId": "gameCenterAppVersions_compatibilityVersions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -135146,7 +140307,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterAppVersionCompatibilityVersionsLinkagesResponse" } } } @@ -135163,125 +140324,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterAchievements/{id}/localizations": { - "get": { + "post": { "tags": [ - "GameCenterAchievements" + "GameCenterAppVersions" ], - "operationId": "gameCenterAchievements_localizations_getToManyRelated", - "deprecated": true, - "parameters": [ - { - "name": "fields[gameCenterAchievementLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "beforeEarnedDescription", - "afterEarnedDescription", - "gameCenterAchievement", - "gameCenterAchievementImage" - ] - } - }, - "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" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterAchievementImages]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState", - "gameCenterAchievementLocalization" - ] + "operationId": "gameCenterAppVersions_compatibilityVersions_createToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterAppVersionCompatibilityVersionsLinkagesRequest" } - }, - "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": [ - "gameCenterAchievement", - "gameCenterAchievementImage" - ] - } - }, - "style": "form", - "explode": false - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -135323,16 +140381,29 @@ } } }, - "200": { - "description": "List of GameCenterAchievementLocalizations", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementLocalizationsResponse" + "$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": { @@ -135345,38 +140416,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterAchievements/{id}/relationships/releases": { - "get": { + "delete": { "tags": [ - "GameCenterAchievements" - ], - "operationId": "gameCenterAchievements_releases_getToManyRelationship", - "deprecated": true, - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterAppVersions" ], + "operationId": "gameCenterAppVersions_compatibilityVersions_deleteToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterAppVersionCompatibilityVersionsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -135418,16 +140473,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementReleasesLinkagesResponse" + "$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": { @@ -135453,31 +140521,17 @@ } ] }, - "/v1/gameCenterAchievements/{id}/releases": { + "/v1/gameCenterAppVersions/{id}/compatibilityVersions": { "get": { "tags": [ - "GameCenterAchievements" + "GameCenterAppVersions" ], - "operationId": "gameCenterAchievements_releases_getToManyRelated", - "deprecated": true, + "operationId": "gameCenterAppVersions_compatibilityVersions_getToManyRelated", "parameters": [ { - "name": "filter[live]", - "in": "query", - "description": "filter by attribute 'live'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[gameCenterDetail]", + "name": "filter[enabled]", "in": "query", - "description": "filter by id(s) of related 'gameCenterDetail'", + "description": "filter by attribute 'enabled'", "schema": { "type": "array", "items": { @@ -135488,17 +140542,17 @@ "explode": false }, { - "name": "fields[gameCenterAchievementReleases]", + "name": "fields[gameCenterAppVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementReleases", + "description": "the fields to include for returned resources of type gameCenterAppVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", - "gameCenterDetail", - "gameCenterAchievement" + "enabled", + "compatibilityVersions", + "appStoreVersion" ] } }, @@ -135506,66 +140560,38 @@ "explode": false }, { - "name": "fields[gameCenterDetails]", + "name": "fields[appStoreVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterDetails", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "arcadeEnabled", - "challengeEnabled", + "platform", + "versionString", + "appStoreState", + "appVersionState", + "copyright", + "reviewType", + "releaseType", + "earliestReleaseDate", + "usesIdfa", + "downloadable", + "createdDate", "app", - "gameCenterAppVersions", - "gameCenterGroup", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges", - "defaultLeaderboard", - "defaultLeaderboardV2", - "defaultGroupLeaderboard", - "defaultGroupLeaderboardV2", - "achievementReleases", - "activityReleases", - "challengeReleases", - "leaderboardReleases", - "leaderboardSetReleases", - "blockedPlayers", - "challengesMinimumPlatformVersions" - ] - } - }, - "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" + "appStoreVersionLocalizations", + "build", + "appStoreVersionPhasedRelease", + "gameCenterAppVersion", + "routingAppCoverage", + "appStoreReviewDetail", + "appStoreVersionSubmission", + "appClipDefaultExperience", + "appStoreVersionExperiments", + "appStoreVersionExperimentsV2", + "customerReviews", + "alternativeDistributionPackage" ] } }, @@ -135591,13 +140617,23 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterAchievement" + "compatibilityVersions", + "appStoreVersion" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[compatibilityVersions]", + "in": "query", + "description": "maximum number of related compatibilityVersions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -135642,11 +140678,11 @@ } }, "200": { - "description": "List of GameCenterAchievementReleases", + "description": "List of GameCenterAppVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementReleasesResponse" + "$ref": "#/components/schemas/GameCenterAppVersionsResponse" } } } @@ -135676,24 +140712,13 @@ } ] }, - "/v1/gameCenterActivities/{id}/relationships/achievements": { - "post": { + "/v1/gameCenterChallengeLocalizations/{id}/relationships/image": { + "get": { "tags": [ - "GameCenterActivities" + "GameCenterChallengeLocalizations" ], - "operationId": "gameCenterActivities_achievements_createToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterActivityAchievementsLinkagesRequest" - } - } - }, - "required": true - }, + "operationId": "gameCenterChallengeLocalizations_image_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -135735,29 +140760,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterChallengeLocalizationImageLinkageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -135770,23 +140782,47 @@ } } }, - "delete": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterChallengeLocalizations/{id}/image": { + "get": { "tags": [ - "GameCenterActivities" + "GameCenterChallengeLocalizations" ], - "operationId": "gameCenterActivities_achievements_deleteToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterActivityAchievementsLinkagesRequest" + "operationId": "gameCenterChallengeLocalizations_image_getToOneRelated", + "parameters": [ + { + "name": "fields[gameCenterChallengeImages]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterChallengeImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState" + ] } - } - }, - "required": true - }, + }, + "style": "form", + "explode": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -135828,29 +140864,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Single GameCenterChallengeImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterChallengeImageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -135876,23 +140899,13 @@ } ] }, - "/v1/gameCenterActivities/{id}/relationships/achievementsV2": { - "post": { + "/v1/gameCenterChallengeVersions/{id}/relationships/defaultImage": { + "get": { "tags": [ - "GameCenterActivities" + "GameCenterChallengeVersions" ], - "operationId": "gameCenterActivities_achievementsV2_createToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterActivityAchievementsV2LinkagesRequest" - } - } - }, - "required": true - }, + "operationId": "gameCenterChallengeVersions_defaultImage_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -135934,29 +140947,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterChallengeVersionDefaultImageLinkageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -135969,22 +140969,47 @@ } } }, - "delete": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterChallengeVersions/{id}/defaultImage": { + "get": { "tags": [ - "GameCenterActivities" + "GameCenterChallengeVersions" ], - "operationId": "gameCenterActivities_achievementsV2_deleteToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterActivityAchievementsV2LinkagesRequest" + "operationId": "gameCenterChallengeVersions_defaultImage_getToOneRelated", + "parameters": [ + { + "name": "fields[gameCenterChallengeImages]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterChallengeImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState" + ] } - } - }, - "required": true - }, + }, + "style": "form", + "explode": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -136026,29 +141051,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Single GameCenterChallengeImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterChallengeImageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -136074,24 +141086,24 @@ } ] }, - "/v1/gameCenterActivities/{id}/relationships/leaderboards": { - "post": { + "/v1/gameCenterChallengeVersions/{id}/relationships/localizations": { + "get": { "tags": [ - "GameCenterActivities" + "GameCenterChallengeVersions" + ], + "operationId": "gameCenterChallengeVersions_localizations_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "gameCenterActivities_leaderboards_createToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterActivityLeaderboardsLinkagesRequest" - } - } - }, - "required": true - }, "responses": { "400": { "description": "Parameter error(s)", @@ -136133,29 +141145,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterChallengeVersionLocalizationsLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -136168,23 +141167,115 @@ } } }, - "delete": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterChallengeVersions/{id}/localizations": { + "get": { "tags": [ - "GameCenterActivities" + "GameCenterChallengeVersions" ], - "operationId": "gameCenterActivities_leaderboards_deleteToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterActivityLeaderboardsLinkagesRequest" + "operationId": "gameCenterChallengeVersions_localizations_getToManyRelated", + "parameters": [ + { + "name": "fields[gameCenterChallengeLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterChallengeLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "description", + "version", + "image" + ] } - } + }, + "style": "form", + "explode": false }, - "required": true - }, + { + "name": "fields[gameCenterChallengeVersions]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterChallengeVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "challenge", + "localizations", + "releases", + "defaultImage" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterChallengeImages]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterChallengeImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "imageAsset", + "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": [ + "version", + "image" + ] + } + }, + "style": "form", + "explode": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -136226,29 +141317,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of GameCenterChallengeLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterChallengeLocalizationsResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -136274,18 +141352,19 @@ } ] }, - "/v1/gameCenterActivities/{id}/relationships/leaderboardsV2": { - "post": { + "/v1/gameCenterChallenges/{id}/relationships/leaderboard": { + "patch": { "tags": [ - "GameCenterActivities" + "GameCenterChallenges" ], - "operationId": "gameCenterActivities_leaderboardsV2_createToManyRelationship", + "operationId": "gameCenterChallenges_leaderboard_updateToOneRelationship", + "deprecated": true, "requestBody": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityLeaderboardsV2LinkagesRequest" + "$ref": "#/components/schemas/GameCenterChallengeLeaderboardLinkageRequest" } } }, @@ -136367,17 +141446,31 @@ } } }, - "delete": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterChallenges/{id}/relationships/leaderboardV2": { + "patch": { "tags": [ - "GameCenterActivities" + "GameCenterChallenges" ], - "operationId": "gameCenterActivities_leaderboardsV2_deleteToManyRelationship", + "operationId": "gameCenterChallenges_leaderboardV2_updateToOneRelationship", "requestBody": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityLeaderboardsV2LinkagesRequest" + "$ref": "#/components/schemas/GameCenterChallengeLeaderboardV2LinkageRequest" } } }, @@ -136472,12 +141565,12 @@ } ] }, - "/v1/gameCenterActivities/{id}/relationships/versions": { + "/v1/gameCenterChallenges/{id}/relationships/versions": { "get": { "tags": [ - "GameCenterActivities" + "GameCenterChallenges" ], - "operationId": "gameCenterActivities_versions_getToManyRelationship", + "operationId": "gameCenterChallenges_versions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -136536,7 +141629,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityVersionsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterChallengeVersionsLinkagesResponse" } } } @@ -136566,17 +141659,17 @@ } ] }, - "/v1/gameCenterActivities/{id}/versions": { + "/v1/gameCenterChallenges/{id}/versions": { "get": { "tags": [ - "GameCenterActivities" + "GameCenterChallenges" ], - "operationId": "gameCenterActivities_versions_getToManyRelated", + "operationId": "gameCenterChallenges_versions_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterActivityVersions]", + "name": "fields[gameCenterChallengeVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityVersions", + "description": "the fields to include for returned resources of type gameCenterChallengeVersions", "schema": { "type": "array", "items": { @@ -136584,11 +141677,10 @@ "enum": [ "version", "state", - "fallbackUrl", - "activity", + "challenge", "localizations", - "defaultImage", - "releases" + "releases", + "defaultImage" ] } }, @@ -136596,9 +141688,9 @@ "explode": false }, { - "name": "fields[gameCenterActivities]", + "name": "fields[gameCenterChallenges]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivities", + "description": "the fields to include for returned resources of type gameCenterChallenges", "schema": { "type": "array", "items": { @@ -136606,19 +141698,14 @@ "enum": [ "referenceName", "vendorIdentifier", - "playStyle", - "minimumPlayersCount", - "maximumPlayersCount", - "supportsPartyCode", "archived", - "properties", + "challengeType", + "repeatable", "gameCenterDetail", "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", - "versions" + "versions", + "leaderboard", + "leaderboardV2" ] } }, @@ -136626,9 +141713,9 @@ "explode": false }, { - "name": "fields[gameCenterActivityLocalizations]", + "name": "fields[gameCenterChallengeLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityLocalizations", + "description": "the fields to include for returned resources of type gameCenterChallengeLocalizations", "schema": { "type": "array", "items": { @@ -136646,19 +141733,15 @@ "explode": false }, { - "name": "fields[gameCenterActivityImages]", + "name": "fields[gameCenterChallengeVersionReleases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityImages", + "description": "the fields to include for returned resources of type gameCenterChallengeVersionReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "version" ] } }, @@ -136666,15 +141749,19 @@ "explode": false }, { - "name": "fields[gameCenterActivityVersionReleases]", + "name": "fields[gameCenterChallengeImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityVersionReleases", + "description": "the fields to include for returned resources of type gameCenterChallengeImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState" ] } }, @@ -136700,10 +141787,10 @@ "items": { "type": "string", "enum": [ - "activity", + "challenge", "localizations", - "defaultImage", - "releases" + "releases", + "defaultImage" ] } }, @@ -136774,11 +141861,11 @@ } }, "200": { - "description": "List of GameCenterActivityVersions", + "description": "List of GameCenterChallengeVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityVersionsResponse" + "$ref": "#/components/schemas/GameCenterChallengeVersionsResponse" } } } @@ -136808,13 +141895,25 @@ } ] }, - "/v1/gameCenterActivityLocalizations/{id}/relationships/image": { + "/v1/gameCenterDetails/{id}/relationships/achievementReleases": { "get": { "tags": [ - "GameCenterActivityLocalizations" + "GameCenterDetails" + ], + "operationId": "gameCenterDetails_achievementReleases_getToManyRelationship", + "deprecated": true, + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "gameCenterActivityLocalizations_image_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -136857,11 +141956,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityLocalizationImageLinkageResponse" + "$ref": "#/components/schemas/GameCenterDetailAchievementReleasesLinkagesResponse" } } } @@ -136891,27 +141990,147 @@ } ] }, - "/v1/gameCenterActivityLocalizations/{id}/image": { + "/v1/gameCenterDetails/{id}/achievementReleases": { "get": { "tags": [ - "GameCenterActivityLocalizations" + "GameCenterDetails" ], - "operationId": "gameCenterActivityLocalizations_image_getToOneRelated", + "operationId": "gameCenterDetails_achievementReleases_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[gameCenterActivityImages]", + "name": "filter[live]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityImages", + "description": "filter by attribute 'live'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[gameCenterAchievement]", + "in": "query", + "description": "filter by id(s) of related 'gameCenterAchievement'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "deprecated": true + }, + { + "name": "fields[gameCenterAchievementReleases]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterAchievementReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "live", + "gameCenterDetail", + "gameCenterAchievement" + ] + } + }, + "style": "form", + "explode": 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", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] + } + }, + "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" + ] + } + }, + "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": [ + "gameCenterDetail", + "gameCenterAchievement" ] } }, @@ -136961,11 +142180,11 @@ } }, "200": { - "description": "Single GameCenterActivityImage", + "description": "List of GameCenterAchievementReleases", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityImageResponse" + "$ref": "#/components/schemas/GameCenterAchievementReleasesResponse" } } } @@ -136995,13 +142214,25 @@ } ] }, - "/v1/gameCenterActivityVersions/{id}/relationships/defaultImage": { + "/v1/gameCenterDetails/{id}/relationships/activityReleases": { "get": { "tags": [ - "GameCenterActivityVersions" + "GameCenterDetails" + ], + "operationId": "gameCenterDetails_activityReleases_getToManyRelationship", + "deprecated": true, + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "gameCenterActivityVersions_defaultImage_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -137044,11 +142275,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityVersionDefaultImageLinkageResponse" + "$ref": "#/components/schemas/GameCenterDetailActivityReleasesLinkagesResponse" } } } @@ -137078,27 +142309,72 @@ } ] }, - "/v1/gameCenterActivityVersions/{id}/defaultImage": { + "/v1/gameCenterDetails/{id}/activityReleases": { "get": { "tags": [ - "GameCenterActivityVersions" + "GameCenterDetails" ], - "operationId": "gameCenterActivityVersions_defaultImage_getToOneRelated", + "operationId": "gameCenterDetails_activityReleases_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[gameCenterActivityImages]", + "name": "fields[gameCenterActivityVersionReleases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityImages", + "description": "the fields to include for returned resources of type gameCenterActivityVersionReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "version" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterActivityVersions]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterActivityVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "fallbackUrl", + "activity", + "localizations", + "defaultImage", + "releases" + ] + } + }, + "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": [ + "version" ] } }, @@ -137148,11 +142424,11 @@ } }, "200": { - "description": "Single GameCenterActivityImage", + "description": "List of GameCenterActivityVersionReleases", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityImageResponse" + "$ref": "#/components/schemas/GameCenterActivityVersionReleasesResponse" } } } @@ -137182,12 +142458,12 @@ } ] }, - "/v1/gameCenterActivityVersions/{id}/relationships/localizations": { + "/v1/gameCenterDetails/{id}/relationships/blockedPlayers": { "get": { "tags": [ - "GameCenterActivityVersions" + "GameCenterDetails" ], - "operationId": "gameCenterActivityVersions_localizations_getToManyRelationship", + "operationId": "gameCenterDetails_blockedPlayers_getToManyRelationship", "parameters": [ { "name": "limit", @@ -137246,7 +142522,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityVersionLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterDetailBlockedPlayersLinkagesResponse" } } } @@ -137276,69 +142552,25 @@ } ] }, - "/v1/gameCenterActivityVersions/{id}/localizations": { + "/v1/gameCenterDetails/{id}/blockedPlayers": { "get": { "tags": [ - "GameCenterActivityVersions" + "GameCenterDetails" ], - "operationId": "gameCenterActivityVersions_localizations_getToManyRelated", + "operationId": "gameCenterDetails_blockedPlayers_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterActivityLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "description", - "version", - "image" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterActivityVersions]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "fallbackUrl", - "activity", - "localizations", - "defaultImage", - "releases" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterActivityImages]", + "name": "fields[gameCenterDetailPlayers]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityImages", + "description": "the fields to include for returned resources of type gameCenterDetailPlayers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "nickname", + "blocked", + "bundleId" ] } }, @@ -137354,23 +142586,6 @@ "maximum": 200 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "image" - ] - } - }, - "style": "form", - "explode": false } ], "responses": { @@ -137415,11 +142630,11 @@ } }, "200": { - "description": "List of GameCenterActivityLocalizations", + "description": "List of GameCenterDetailPlayers", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityLocalizationsResponse" + "$ref": "#/components/schemas/GameCenterDetailPlayersResponse" } } } @@ -137449,13 +142664,25 @@ } ] }, - "/v1/gameCenterAppVersions/{id}/relationships/appStoreVersion": { + "/v1/gameCenterDetails/{id}/relationships/challengeReleases": { "get": { "tags": [ - "GameCenterAppVersions" + "GameCenterDetails" + ], + "operationId": "gameCenterDetails_challengeReleases_getToManyRelationship", + "deprecated": true, + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "gameCenterAppVersions_appStoreVersion_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -137498,11 +142725,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAppVersionAppStoreVersionLinkageResponse" + "$ref": "#/components/schemas/GameCenterDetailChallengeReleasesLinkagesResponse" } } } @@ -137532,145 +142759,24 @@ } ] }, - "/v1/gameCenterAppVersions/{id}/appStoreVersion": { + "/v1/gameCenterDetails/{id}/challengeReleases": { "get": { "tags": [ - "GameCenterAppVersions" + "GameCenterDetails" ], - "operationId": "gameCenterAppVersions_appStoreVersion_getToOneRelated", + "operationId": "gameCenterDetails_challengeReleases_getToManyRelated", + "deprecated": true, "parameters": [ { - "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[appStoreVersionLocalizations]", + "name": "fields[gameCenterChallengeVersionReleases]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "description": "the fields to include for returned resources of type gameCenterChallengeVersionReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "description", - "locale", - "keywords", - "marketingUrl", - "promotionalText", - "supportUrl", - "whatsNew", - "appStoreVersion", - "appScreenshotSets", - "appPreviewSets", - "searchKeywords", - "placements" + "version" ] } }, @@ -137678,186 +142784,20 @@ "explode": false }, { - "name": "fields[builds]", + "name": "fields[gameCenterChallengeVersions]", "in": "query", - "description": "the fields to include for returned resources of type builds", + "description": "the fields to include for returned resources of type gameCenterChallengeVersions", "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" + "challenge", + "localizations", + "releases", + "defaultImage" ] } }, @@ -137865,21 +142805,14 @@ "explode": false }, { - "name": "fields[alternativeDistributionPackages]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type alternativeDistributionPackages", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "sourceFileChecksum", - "versions" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { "name": "include", @@ -137890,54 +142823,12 @@ "items": { "type": "string", "enum": [ - "app", - "appStoreVersionLocalizations", - "build", - "appStoreVersionPhasedRelease", - "gameCenterAppVersion", - "routingAppCoverage", - "appStoreReviewDetail", - "appStoreVersionSubmission", - "appClipDefaultExperience", - "appStoreVersionExperiments", - "appStoreVersionExperimentsV2", - "alternativeDistributionPackage" + "version" ] } }, "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": { @@ -137982,11 +142873,11 @@ } }, "200": { - "description": "Single AppStoreVersion", + "description": "List of GameCenterChallengeVersionReleases", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppStoreVersionResponse" + "$ref": "#/components/schemas/GameCenterChallengeVersionReleasesResponse" } } } @@ -138016,24 +142907,23 @@ } ] }, - "/v1/gameCenterAppVersions/{id}/relationships/compatibilityVersions": { - "get": { + "/v1/gameCenterDetails/{id}/relationships/challengesMinimumPlatformVersions": { + "patch": { "tags": [ - "GameCenterAppVersions" - ], - "operationId": "gameCenterAppVersions_compatibilityVersions_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterDetails" ], + "operationId": "gameCenterDetails_challengesMinimumPlatformVersions_replaceToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterDetailChallengesMinimumPlatformVersionsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -138075,16 +142965,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAppVersionCompatibilityVersionsLinkagesResponse" + "$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": { @@ -138097,22 +143000,38 @@ } } }, - "post": { - "tags": [ - "GameCenterAppVersions" - ], - "operationId": "gameCenterAppVersions_compatibilityVersions_createToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterAppVersionCompatibilityVersionsLinkagesRequest" - } - } + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", "required": true - }, + } + ] + }, + "/v1/gameCenterDetails/{id}/relationships/gameCenterAchievements": { + "get": { + "tags": [ + "GameCenterDetails" + ], + "operationId": "gameCenterDetails_gameCenterAchievements_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)", @@ -138154,29 +143073,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterDetailGameCenterAchievementsLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -138189,17 +143095,18 @@ } } }, - "delete": { + "patch": { "tags": [ - "GameCenterAppVersions" + "GameCenterDetails" ], - "operationId": "gameCenterAppVersions_compatibilityVersions_deleteToManyRelationship", + "operationId": "gameCenterDetails_gameCenterAchievements_replaceToManyRelationship", + "deprecated": true, "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAppVersionCompatibilityVersionsLinkagesRequest" + "$ref": "#/components/schemas/GameCenterDetailGameCenterAchievementsLinkagesRequest" } } }, @@ -138277,55 +143184,195 @@ "$ref": "#/components/schemas/ErrorResponse" } } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterDetails/{id}/gameCenterAchievements": { + "get": { + "tags": [ + "GameCenterDetails" + ], + "operationId": "gameCenterDetails_gameCenterAchievements_getToManyRelated", + "deprecated": true, + "parameters": [ + { + "name": "filter[referenceName]", + "in": "query", + "description": "filter by attribute 'referenceName'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[archived]", + "in": "query", + "description": "filter by attribute 'archived'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[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" + ] + } + }, + "style": "form", + "explode": 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", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] + } + }, + "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 }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterAppVersions/{id}/compatibilityVersions": { - "get": { - "tags": [ - "GameCenterAppVersions" - ], - "operationId": "gameCenterAppVersions_compatibilityVersions_getToManyRelated", - "parameters": [ { - "name": "filter[enabled]", + "name": "fields[gameCenterAchievementLocalizations]", "in": "query", - "description": "filter by attribute 'enabled'", + "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "locale", + "name", + "beforeEarnedDescription", + "afterEarnedDescription", + "gameCenterAchievement", + "gameCenterAchievementImage" + ] } }, "style": "form", "explode": false }, { - "name": "fields[gameCenterAppVersions]", + "name": "fields[gameCenterAchievementReleases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAppVersions", + "description": "the fields to include for returned resources of type gameCenterAchievementReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "enabled", - "compatibilityVersions", - "appStoreVersion" + "live", + "gameCenterDetail", + "gameCenterAchievement" ] } }, @@ -138333,38 +143380,29 @@ "explode": false }, { - "name": "fields[appStoreVersions]", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "the fields to include for returned resources of type gameCenterActivities", "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" + "referenceName", + "vendorIdentifier", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", + "archived", + "properties", + "gameCenterDetail", + "gameCenterGroup", + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" ] } }, @@ -138390,8 +143428,12 @@ "items": { "type": "string", "enum": [ - "compatibilityVersions", - "appStoreVersion" + "gameCenterDetail", + "gameCenterGroup", + "groupAchievement", + "localizations", + "releases", + "activity" ] } }, @@ -138399,14 +143441,26 @@ "explode": false }, { - "name": "limit[compatibilityVersions]", + "name": "limit[localizations]", "in": "query", - "description": "maximum number of related compatibilityVersions returned (when they are included)", + "description": "maximum number of related localizations returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, - "style": "form" + "style": "form", + "deprecated": true + }, + { + "name": "limit[releases]", + "in": "query", + "description": "maximum number of related releases returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "deprecated": true } ], "responses": { @@ -138451,11 +143505,11 @@ } }, "200": { - "description": "List of GameCenterAppVersions", + "description": "List of GameCenterAchievements", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAppVersionsResponse" + "$ref": "#/components/schemas/GameCenterAchievementsResponse" } } } @@ -138485,13 +143539,24 @@ } ] }, - "/v1/gameCenterChallengeLocalizations/{id}/relationships/image": { + "/v1/gameCenterDetails/{id}/relationships/gameCenterAchievementsV2": { "get": { "tags": [ - "GameCenterChallengeLocalizations" + "GameCenterDetails" + ], + "operationId": "gameCenterDetails_gameCenterAchievementsV2_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "gameCenterChallengeLocalizations_image_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -138534,11 +143599,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterChallengeLocalizationImageLinkageResponse" + "$ref": "#/components/schemas/GameCenterDetailGameCenterAchievementsV2LinkagesResponse" } } } @@ -138555,47 +143620,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterChallengeLocalizations/{id}/image": { - "get": { + "patch": { "tags": [ - "GameCenterChallengeLocalizations" + "GameCenterDetails" ], - "operationId": "gameCenterChallengeLocalizations_image_getToOneRelated", - "parameters": [ - { - "name": "fields[gameCenterChallengeImages]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState" - ] + "operationId": "gameCenterDetails_gameCenterAchievementsV2_replaceToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterDetailGameCenterAchievementsV2LinkagesRequest" } - }, - "style": "form", - "explode": false - } - ], + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -138637,16 +143677,29 @@ } } }, - "200": { - "description": "Single GameCenterChallengeImage", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterChallengeImageResponse" + "$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": { @@ -138672,115 +143725,229 @@ } ] }, - "/v1/gameCenterChallengeVersions/{id}/relationships/defaultImage": { + "/v1/gameCenterDetails/{id}/gameCenterAchievementsV2": { "get": { "tags": [ - "GameCenterChallengeVersions" + "GameCenterDetails" ], - "operationId": "gameCenterChallengeVersions_defaultImage_getToOneRelationship", - "parameters": [], - "responses": { - "400": { - "description": "Parameter error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + "operationId": "gameCenterDetails_gameCenterAchievementsV2_getToManyRelated", + "parameters": [ + { + "name": "filter[referenceName]", + "in": "query", + "description": "filter by attribute 'referenceName'", + "schema": { + "type": "array", + "items": { + "type": "string" } - } + }, + "style": "form", + "explode": false }, - "401": { - "description": "Unauthorized error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "filter[archived]", + "in": "query", + "description": "filter by attribute 'archived'", + "schema": { + "type": "array", + "items": { + "type": "string" } - } + }, + "style": "form", + "explode": false }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" } - } + }, + "style": "form", + "explode": false }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "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", + "activity", + "versions" + ] } - } + }, + "style": "form", + "explode": false }, - "200": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterChallengeVersionDefaultImageLinkageResponse" - } + { + "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", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] } - } + }, + "style": "form", + "explode": false }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "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" + ] } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + }, + "style": "form", + "explode": false }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterChallengeVersions/{id}/defaultImage": { - "get": { - "tags": [ - "GameCenterChallengeVersions" - ], - "operationId": "gameCenterChallengeVersions_defaultImage_getToOneRelated", - "parameters": [ { - "name": "fields[gameCenterChallengeImages]", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeImages", + "description": "the fields to include for returned resources of type gameCenterActivities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "referenceName", + "vendorIdentifier", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", + "archived", + "properties", + "gameCenterDetail", + "gameCenterGroup", + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterAchievementVersions]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterAchievementVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "achievement", + "localizations" + ] + } + }, + "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": [ + "gameCenterDetail", + "gameCenterGroup", + "activity", + "versions" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -138825,11 +143992,11 @@ } }, "200": { - "description": "Single GameCenterChallengeImage", + "description": "List of GameCenterAchievements", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterChallengeImageResponse" + "$ref": "#/components/schemas/GameCenterAchievementsV2Response" } } } @@ -138859,12 +144026,12 @@ } ] }, - "/v1/gameCenterChallengeVersions/{id}/relationships/localizations": { + "/v1/gameCenterDetails/{id}/relationships/gameCenterActivities": { "get": { "tags": [ - "GameCenterChallengeVersions" + "GameCenterDetails" ], - "operationId": "gameCenterChallengeVersions_localizations_getToManyRelationship", + "operationId": "gameCenterDetails_gameCenterActivities_getToManyRelationship", "parameters": [ { "name": "limit", @@ -138923,7 +144090,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterChallengeVersionLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterDetailGameCenterActivitiesLinkagesResponse" } } } @@ -138953,27 +144120,37 @@ } ] }, - "/v1/gameCenterChallengeVersions/{id}/localizations": { + "/v1/gameCenterDetails/{id}/gameCenterActivities": { "get": { "tags": [ - "GameCenterChallengeVersions" + "GameCenterDetails" ], - "operationId": "gameCenterChallengeVersions_localizations_getToManyRelated", + "operationId": "gameCenterDetails_gameCenterActivities_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterChallengeLocalizations]", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeLocalizations", + "description": "the fields to include for returned resources of type gameCenterActivities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "name", - "description", - "version", - "image" + "referenceName", + "vendorIdentifier", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", + "archived", + "properties", + "gameCenterDetail", + "gameCenterGroup", + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" ] } }, @@ -138981,20 +144158,92 @@ "explode": false }, { - "name": "fields[gameCenterChallengeVersions]", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeVersions", + "description": "the fields to include for returned resources of type gameCenterDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "challenge", + "arcadeEnabled", + "challengeEnabled", + "app", + "gameCenterAppVersions", + "gameCenterGroup", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges", + "defaultLeaderboard", + "defaultLeaderboardV2", + "defaultGroupLeaderboard", + "defaultGroupLeaderboardV2", + "achievementReleases", + "activityReleases", + "challengeReleases", + "leaderboardReleases", + "leaderboardSetReleases", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] + } + }, + "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[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", - "defaultImage" + "activity", + "versions" ] } }, @@ -139002,19 +144251,59 @@ "explode": false }, { - "name": "fields[gameCenterChallengeImages]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeImages", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "defaultFormatter", + "referenceName", + "vendorIdentifier", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", + "archived", + "activityProperties", + "visibility", + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboard", + "gameCenterLeaderboardSets", + "localizations", + "releases", + "activity", + "challenge", + "gameCenterScoreModerations", + "versions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterActivityVersions]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterActivityVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "fallbackUrl", + "activity", + "localizations", + "defaultImage", + "releases" ] } }, @@ -139040,13 +144329,70 @@ "items": { "type": "string", "enum": [ - "version", - "image" + "gameCenterDetail", + "gameCenterGroup", + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[achievements]", + "in": "query", + "description": "maximum number of related achievements returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "deprecated": true + }, + { + "name": "limit[achievementsV2]", + "in": "query", + "description": "maximum number of related achievementsV2 returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[leaderboards]", + "in": "query", + "description": "maximum number of related leaderboards returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "deprecated": true + }, + { + "name": "limit[leaderboardsV2]", + "in": "query", + "description": "maximum number of related leaderboardsV2 returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -139091,11 +144437,11 @@ } }, "200": { - "description": "List of GameCenterChallengeLocalizations", + "description": "List of GameCenterActivities", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterChallengeLocalizationsResponse" + "$ref": "#/components/schemas/GameCenterActivitiesResponse" } } } @@ -139125,24 +144471,24 @@ } ] }, - "/v1/gameCenterChallenges/{id}/relationships/leaderboard": { - "patch": { + "/v1/gameCenterDetails/{id}/relationships/gameCenterAppVersions": { + "get": { "tags": [ - "GameCenterChallenges" + "GameCenterDetails" + ], + "operationId": "gameCenterDetails_gameCenterAppVersions_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "gameCenterChallenges_leaderboard_updateToOneRelationship", - "deprecated": true, - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterChallengeLeaderboardLinkageRequest" - } - } - }, - "required": true - }, "responses": { "400": { "description": "Parameter error(s)", @@ -139184,29 +144530,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterDetailGameCenterAppVersionsLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -139232,23 +144565,121 @@ } ] }, - "/v1/gameCenterChallenges/{id}/relationships/leaderboardV2": { - "patch": { + "/v1/gameCenterDetails/{id}/gameCenterAppVersions": { + "get": { "tags": [ - "GameCenterChallenges" + "GameCenterDetails" ], - "operationId": "gameCenterChallenges_leaderboardV2_updateToOneRelationship", - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterChallengeLeaderboardV2LinkageRequest" + "operationId": "gameCenterDetails_gameCenterAppVersions_getToManyRelated", + "parameters": [ + { + "name": "filter[enabled]", + "in": "query", + "description": "filter by attribute 'enabled'", + "schema": { + "type": "array", + "items": { + "type": "string" } - } + }, + "style": "form", + "explode": false }, - "required": true - }, + { + "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[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": "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": [ + "compatibilityVersions", + "appStoreVersion" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "limit[compatibilityVersions]", + "in": "query", + "description": "maximum number of related compatibilityVersions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -139290,29 +144721,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of GameCenterAppVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterAppVersionsResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -139338,12 +144756,12 @@ } ] }, - "/v1/gameCenterChallenges/{id}/relationships/versions": { + "/v1/gameCenterDetails/{id}/relationships/gameCenterChallenges": { "get": { "tags": [ - "GameCenterChallenges" + "GameCenterDetails" ], - "operationId": "gameCenterChallenges_versions_getToManyRelationship", + "operationId": "gameCenterDetails_gameCenterChallenges_getToManyRelationship", "parameters": [ { "name": "limit", @@ -139402,7 +144820,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterChallengeVersionsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterDetailGameCenterChallengesLinkagesResponse" } } } @@ -139432,28 +144850,71 @@ } ] }, - "/v1/gameCenterChallenges/{id}/versions": { + "/v1/gameCenterDetails/{id}/gameCenterChallenges": { "get": { "tags": [ - "GameCenterChallenges" + "GameCenterDetails" ], - "operationId": "gameCenterChallenges_versions_getToManyRelated", + "operationId": "gameCenterDetails_gameCenterChallenges_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterChallengeVersions]", + "name": "filter[referenceName]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeVersions", + "description": "filter by attribute 'referenceName'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[archived]", + "in": "query", + "description": "filter by attribute 'archived'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterChallenges]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterChallenges", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "challenge", - "localizations", - "releases", - "defaultImage" + "referenceName", + "vendorIdentifier", + "archived", + "challengeType", + "repeatable", + "gameCenterDetail", + "gameCenterGroup", + "versions", + "leaderboard", + "leaderboardV2" ] } }, @@ -139461,24 +144922,38 @@ "explode": false }, { - "name": "fields[gameCenterChallenges]", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallenges", + "description": "the fields to include for returned resources of type gameCenterDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "archived", - "challengeType", - "repeatable", - "gameCenterDetail", + "arcadeEnabled", + "challengeEnabled", + "app", + "gameCenterAppVersions", "gameCenterGroup", - "versions", - "leaderboard", - "leaderboardV2" + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges", + "defaultLeaderboard", + "defaultLeaderboardV2", + "defaultGroupLeaderboard", + "defaultGroupLeaderboardV2", + "achievementReleases", + "activityReleases", + "challengeReleases", + "leaderboardReleases", + "leaderboardSetReleases", + "blockedPlayers", + "challengesMinimumPlatformVersions" ] } }, @@ -139486,19 +144961,24 @@ "explode": false }, { - "name": "fields[gameCenterChallengeLocalizations]", + "name": "fields[gameCenterGroups]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeLocalizations", + "description": "the fields to include for returned resources of type gameCenterGroups", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "name", - "description", - "version", - "image" + "referenceName", + "gameCenterDetails", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges" ] } }, @@ -139506,15 +144986,20 @@ "explode": false }, { - "name": "fields[gameCenterChallengeVersionReleases]", + "name": "fields[gameCenterChallengeVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeVersionReleases", + "description": "the fields to include for returned resources of type gameCenterChallengeVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version" + "version", + "state", + "challenge", + "localizations", + "releases", + "defaultImage" ] } }, @@ -139522,19 +145007,37 @@ "explode": false }, { - "name": "fields[gameCenterChallengeImages]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeImages", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "defaultFormatter", + "referenceName", + "vendorIdentifier", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", + "archived", + "activityProperties", + "visibility", + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboard", + "gameCenterLeaderboardSets", + "localizations", + "releases", + "activity", + "challenge", + "gameCenterScoreModerations", + "versions" ] } }, @@ -139560,10 +145063,11 @@ "items": { "type": "string", "enum": [ - "challenge", - "localizations", - "releases", - "defaultImage" + "gameCenterDetail", + "gameCenterGroup", + "versions", + "leaderboard", + "leaderboardV2" ] } }, @@ -139571,25 +145075,14 @@ "explode": false }, { - "name": "limit[localizations]", + "name": "limit[versions]", "in": "query", - "description": "maximum number of related localizations returned (when they are included)", + "description": "maximum number of related versions returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, "style": "form" - }, - { - "name": "limit[releases]", - "in": "query", - "description": "maximum number of related releases returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "deprecated": true } ], "responses": { @@ -139634,11 +145127,11 @@ } }, "200": { - "description": "List of GameCenterChallengeVersions", + "description": "List of GameCenterChallenges", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterChallengeVersionsResponse" + "$ref": "#/components/schemas/GameCenterChallengesResponse" } } } @@ -139668,25 +145161,13 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/achievementReleases": { + "/v1/gameCenterDetails/{id}/relationships/gameCenterGroup": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_achievementReleases_getToManyRelationship", - "deprecated": true, - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "operationId": "gameCenterDetails_gameCenterGroup_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -139729,11 +145210,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailAchievementReleasesLinkagesResponse" + "$ref": "#/components/schemas/GameCenterDetailGameCenterGroupLinkageResponse" } } } @@ -139763,53 +145244,32 @@ } ] }, - "/v1/gameCenterDetails/{id}/achievementReleases": { + "/v1/gameCenterDetails/{id}/gameCenterGroup": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_achievementReleases_getToManyRelated", - "deprecated": true, + "operationId": "gameCenterDetails_gameCenterGroup_getToOneRelated", "parameters": [ { - "name": "filter[live]", - "in": "query", - "description": "filter by attribute 'live'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[gameCenterAchievement]", - "in": "query", - "description": "filter by id(s) of related 'gameCenterAchievement'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "deprecated": true - }, - { - "name": "fields[gameCenterAchievementReleases]", + "name": "fields[gameCenterGroups]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementReleases", + "description": "the fields to include for returned resources of type gameCenterGroups", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", - "gameCenterDetail", - "gameCenterAchievement" + "referenceName", + "gameCenterDetails", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges" ] } }, @@ -139855,6 +145315,68 @@ "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", + "gameCenterScoreModerations", + "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", @@ -139876,7 +145398,8 @@ "groupAchievement", "localizations", "releases", - "activity" + "activity", + "versions" ] } }, @@ -139884,14 +145407,59 @@ "explode": false }, { - "name": "limit", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type gameCenterActivities", "schema": { - "type": "integer", - "maximum": 200 + "type": "array", + "items": { + "type": "string", + "enum": [ + "referenceName", + "vendorIdentifier", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", + "archived", + "properties", + "gameCenterDetail", + "gameCenterGroup", + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" + ] + } }, - "style": "form" + "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": "include", @@ -139902,13 +145470,113 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterAchievement" + "gameCenterDetails", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[gameCenterDetails]", + "in": "query", + "description": "maximum number of related gameCenterDetails 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" } ], "responses": { @@ -139953,11 +145621,11 @@ } }, "200": { - "description": "List of GameCenterAchievementReleases", + "description": "Single GameCenterGroup", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementReleasesResponse" + "$ref": "#/components/schemas/GameCenterGroupResponse" } } } @@ -139987,12 +145655,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/activityReleases": { + "/v1/gameCenterDetails/{id}/relationships/gameCenterLeaderboardSets": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_activityReleases_getToManyRelationship", + "operationId": "gameCenterDetails_gameCenterLeaderboardSets_getToManyRelationship", "deprecated": true, "parameters": [ { @@ -140052,7 +145720,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailActivityReleasesLinkagesResponse" + "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardSetsLinkagesResponse" } } } @@ -140069,92 +145737,23 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterDetails/{id}/activityReleases": { - "get": { + "patch": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_activityReleases_getToManyRelated", + "operationId": "gameCenterDetails_gameCenterLeaderboardSets_replaceToManyRelationship", "deprecated": true, - "parameters": [ - { - "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[gameCenterActivityVersions]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "fallbackUrl", - "activity", - "localizations", - "defaultImage", - "releases" - ] + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardSetsLinkagesRequest" } - }, - "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": [ - "version" - ] - } - }, - "style": "form", - "explode": false - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -140196,16 +145795,29 @@ } } }, - "200": { - "description": "List of GameCenterActivityVersionReleases", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivityVersionReleasesResponse" + "$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": { @@ -140231,13 +145843,200 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/blockedPlayers": { + "/v1/gameCenterDetails/{id}/gameCenterLeaderboardSets": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_blockedPlayers_getToManyRelationship", + "operationId": "gameCenterDetails_gameCenterLeaderboardSets_getToManyRelated", + "deprecated": true, "parameters": [ + { + "name": "filter[referenceName]", + "in": "query", + "description": "filter by attribute 'referenceName'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[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" + ] + } + }, + "style": "form", + "explode": 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", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] + } + }, + "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[gameCenterLeaderboardSetLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "gameCenterLeaderboardSet", + "gameCenterLeaderboardSetImage" + ] + } + }, + "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" + ] + } + }, + "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": "limit", "in": "query", @@ -140247,6 +146046,60 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboardSet", + "localizations", + "gameCenterLeaderboards", + "releases" + ] + } + }, + "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", + "deprecated": true + }, + { + "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[releases]", + "in": "query", + "description": "maximum number of related releases returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "deprecated": true } ], "responses": { @@ -140291,11 +146144,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "List of GameCenterLeaderboardSets", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailBlockedPlayersLinkagesResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetsResponse" } } } @@ -140325,31 +146178,13 @@ } ] }, - "/v1/gameCenterDetails/{id}/blockedPlayers": { + "/v1/gameCenterDetails/{id}/relationships/gameCenterLeaderboardSetsV2": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_blockedPlayers_getToManyRelated", + "operationId": "gameCenterDetails_gameCenterLeaderboardSetsV2_getToManyRelationship", "parameters": [ - { - "name": "fields[gameCenterDetailPlayers]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterDetailPlayers", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "nickname", - "blocked", - "bundleId" - ] - } - }, - "style": "form", - "explode": false - }, { "name": "limit", "in": "query", @@ -140403,11 +146238,11 @@ } }, "200": { - "description": "List of GameCenterDetailPlayers", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailPlayersResponse" + "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardSetsV2LinkagesResponse" } } } @@ -140424,38 +146259,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterDetails/{id}/relationships/challengeReleases": { - "get": { + "patch": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_challengeReleases_getToManyRelationship", - "deprecated": true, - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "operationId": "gameCenterDetails_gameCenterLeaderboardSetsV2_replaceToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardSetsV2LinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -140497,16 +146316,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailChallengeReleasesLinkagesResponse" + "$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": { @@ -140532,24 +146364,54 @@ } ] }, - "/v1/gameCenterDetails/{id}/challengeReleases": { + "/v1/gameCenterDetails/{id}/gameCenterLeaderboardSetsV2": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_challengeReleases_getToManyRelated", - "deprecated": true, + "operationId": "gameCenterDetails_gameCenterLeaderboardSetsV2_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterChallengeVersionReleases]", + "name": "filter[referenceName]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeVersionReleases", + "description": "filter by attribute 'referenceName'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[id]", + "in": "query", + "description": "filter by id(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterLeaderboardSets]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version" + "referenceName", + "vendorIdentifier", + "gameCenterDetail", + "gameCenterGroup", + "gameCenterLeaderboards", + "versions" ] } }, @@ -140557,9 +146419,108 @@ "explode": false }, { - "name": "fields[gameCenterChallengeVersions]", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeVersions", + "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", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] + } + }, + "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", + "gameCenterLeaderboardSets", + "gameCenterScoreModerations", + "activity", + "challenge", + "versions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterLeaderboardSetVersions]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetVersions", "schema": { "type": "array", "items": { @@ -140567,10 +146528,8 @@ "enum": [ "version", "state", - "challenge", - "localizations", - "releases", - "defaultImage" + "leaderboardSet", + "localizations" ] } }, @@ -140596,107 +146555,37 @@ "items": { "type": "string", "enum": [ - "version" + "gameCenterDetail", + "gameCenterGroup", + "gameCenterLeaderboards", + "versions" ] } }, "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 GameCenterChallengeVersionReleases", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterChallengeVersionReleasesResponse" - } - } - } + { + "name": "limit[gameCenterLeaderboards]", + "in": "query", + "description": "maximum number of related gameCenterLeaderboards returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterDetails/{id}/relationships/challengesMinimumPlatformVersions": { - "patch": { - "tags": [ - "GameCenterDetails" ], - "operationId": "gameCenterDetails_challengesMinimumPlatformVersions_replaceToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterDetailChallengesMinimumPlatformVersionsLinkagesRequest" - } - } - }, - "required": true - }, "responses": { "400": { "description": "Parameter error(s)", @@ -140738,29 +146627,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of GameCenterLeaderboardSets", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetsV2Response" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -140786,12 +146662,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/gameCenterAchievements": { + "/v1/gameCenterDetails/{id}/relationships/gameCenterLeaderboards": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_gameCenterAchievements_getToManyRelationship", + "operationId": "gameCenterDetails_gameCenterLeaderboards_getToManyRelationship", "deprecated": true, "parameters": [ { @@ -140851,7 +146727,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterAchievementsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardsLinkagesResponse" } } } @@ -140872,14 +146748,14 @@ "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_gameCenterAchievements_replaceToManyRelationship", + "operationId": "gameCenterDetails_gameCenterLeaderboards_replaceToManyRelationship", "deprecated": true, "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterAchievementsLinkagesRequest" + "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardsLinkagesRequest" } } }, @@ -140974,12 +146850,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/gameCenterAchievements": { + "/v1/gameCenterDetails/{id}/gameCenterLeaderboards": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_gameCenterAchievements_getToManyRelated", + "operationId": "gameCenterDetails_gameCenterLeaderboards_getToManyRelated", "deprecated": true, "parameters": [ { @@ -141022,27 +146898,35 @@ "explode": false }, { - "name": "fields[gameCenterAchievements]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievements", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "defaultFormatter", "referenceName", "vendorIdentifier", - "points", - "showBeforeEarned", - "repeatable", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", "archived", "activityProperties", + "visibility", "gameCenterDetail", "gameCenterGroup", - "groupAchievement", + "groupLeaderboard", + "gameCenterLeaderboardSets", "localizations", "releases", - "activity" + "activity", + "challenge" ] } }, @@ -141114,9 +146998,32 @@ "explode": false }, { - "name": "fields[gameCenterAchievementLocalizations]", + "name": "fields[gameCenterLeaderboardSets]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", + "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" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterLeaderboardLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", "schema": { "type": "array", "items": { @@ -141124,10 +147031,12 @@ "enum": [ "locale", "name", - "beforeEarnedDescription", - "afterEarnedDescription", - "gameCenterAchievement", - "gameCenterAchievementImage" + "formatterOverride", + "formatterSuffix", + "formatterSuffixSingular", + "description", + "gameCenterLeaderboard", + "gameCenterLeaderboardImage" ] } }, @@ -141135,9 +147044,9 @@ "explode": false }, { - "name": "fields[gameCenterAchievementReleases]", + "name": "fields[gameCenterLeaderboardReleases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementReleases", + "description": "the fields to include for returned resources of type gameCenterLeaderboardReleases", "schema": { "type": "array", "items": { @@ -141145,7 +147054,7 @@ "enum": [ "live", "gameCenterDetail", - "gameCenterAchievement" + "gameCenterLeaderboard" ] } }, @@ -141182,6 +147091,31 @@ "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": "limit", "in": "query", @@ -141203,16 +147137,29 @@ "enum": [ "gameCenterDetail", "gameCenterGroup", - "groupAchievement", + "groupLeaderboard", + "gameCenterLeaderboardSets", "localizations", "releases", - "activity" + "activity", + "challenge" ] } }, "style": "form", "explode": false }, + { + "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[localizations]", "in": "query", @@ -141278,11 +147225,11 @@ } }, "200": { - "description": "List of GameCenterAchievements", + "description": "List of GameCenterLeaderboards", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementsResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardsResponse" } } } @@ -141312,12 +147259,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/gameCenterAchievementsV2": { + "/v1/gameCenterDetails/{id}/relationships/gameCenterLeaderboardsV2": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_gameCenterAchievementsV2_getToManyRelationship", + "operationId": "gameCenterDetails_gameCenterLeaderboardsV2_getToManyRelationship", "parameters": [ { "name": "limit", @@ -141376,7 +147323,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterAchievementsV2LinkagesResponse" + "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardsV2LinkagesResponse" } } } @@ -141397,13 +147344,13 @@ "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_gameCenterAchievementsV2_replaceToManyRelationship", + "operationId": "gameCenterDetails_gameCenterLeaderboardsV2_replaceToManyRelationship", "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterAchievementsV2LinkagesRequest" + "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardsV2LinkagesRequest" } } }, @@ -141498,12 +147445,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/gameCenterAchievementsV2": { + "/v1/gameCenterDetails/{id}/gameCenterLeaderboardsV2": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_gameCenterAchievementsV2_getToManyRelated", + "operationId": "gameCenterDetails_gameCenterLeaderboardsV2_getToManyRelated", "parameters": [ { "name": "filter[referenceName]", @@ -141545,24 +147492,33 @@ "explode": false }, { - "name": "fields[gameCenterAchievements]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievements", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "defaultFormatter", "referenceName", "vendorIdentifier", - "points", - "showBeforeEarned", - "repeatable", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", "archived", "activityProperties", + "visibility", "gameCenterDetail", "gameCenterGroup", + "gameCenterLeaderboardSets", + "gameCenterScoreModerations", "activity", + "challenge", "versions" ] } @@ -141634,6 +147590,27 @@ "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", + "gameCenterLeaderboards", + "versions" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "fields[gameCenterActivities]", "in": "query", @@ -141665,9 +147642,34 @@ "explode": false }, { - "name": "fields[gameCenterAchievementVersions]", + "name": "fields[gameCenterChallenges]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementVersions", + "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[gameCenterLeaderboardVersions]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", "schema": { "type": "array", "items": { @@ -141675,7 +147677,7 @@ "enum": [ "version", "state", - "achievement", + "leaderboard", "localizations" ] } @@ -141704,7 +147706,9 @@ "enum": [ "gameCenterDetail", "gameCenterGroup", + "gameCenterLeaderboardSets", "activity", + "challenge", "versions" ] } @@ -141712,6 +147716,16 @@ "style": "form", "explode": false }, + { + "name": "limit[gameCenterLeaderboardSets]", + "in": "query", + "description": "maximum number of related gameCenterLeaderboardSets returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, { "name": "limit[versions]", "in": "query", @@ -141765,11 +147779,11 @@ } }, "200": { - "description": "List of GameCenterAchievements", + "description": "List of GameCenterLeaderboards", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementsV2Response" + "$ref": "#/components/schemas/GameCenterLeaderboardsV2Response" } } } @@ -141799,12 +147813,13 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/gameCenterActivities": { + "/v1/gameCenterDetails/{id}/relationships/leaderboardReleases": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_gameCenterActivities_getToManyRelationship", + "operationId": "gameCenterDetails_leaderboardReleases_getToManyRelationship", + "deprecated": true, "parameters": [ { "name": "limit", @@ -141863,7 +147878,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterActivitiesLinkagesResponse" + "$ref": "#/components/schemas/GameCenterDetailLeaderboardReleasesLinkagesResponse" } } } @@ -141893,37 +147908,53 @@ } ] }, - "/v1/gameCenterDetails/{id}/gameCenterActivities": { + "/v1/gameCenterDetails/{id}/leaderboardReleases": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_gameCenterActivities_getToManyRelated", + "operationId": "gameCenterDetails_leaderboardReleases_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[gameCenterActivities]", + "name": "filter[live]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivities", + "description": "filter by attribute 'live'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[gameCenterLeaderboard]", + "in": "query", + "description": "filter by id(s) of related 'gameCenterLeaderboard'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "deprecated": true + }, + { + "name": "fields[gameCenterLeaderboardReleases]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "playStyle", - "minimumPlayersCount", - "maximumPlayersCount", - "supportsPartyCode", - "archived", - "properties", + "live", "gameCenterDetail", - "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", - "versions" + "gameCenterLeaderboard" ] } }, @@ -141969,60 +148000,6 @@ "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[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[gameCenterLeaderboards]", "in": "query", @@ -142039,133 +148016,52 @@ "scoreSortType", "scoreRangeStart", "scoreRangeEnd", - "recurrenceStartDate", - "recurrenceDuration", - "recurrenceRule", - "archived", - "activityProperties", - "visibility", - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboard", - "gameCenterLeaderboardSets", - "localizations", - "releases", - "activity", - "challenge", - "gameCenterScoreModerations", - "versions" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterActivityVersions]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "fallbackUrl", - "activity", - "localizations", - "defaultImage", - "releases" - ] - } - }, - "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": [ - "gameCenterDetail", - "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", - "versions" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit[achievements]", - "in": "query", - "description": "maximum number of related achievements returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "deprecated": true - }, - { - "name": "limit[achievementsV2]", - "in": "query", - "description": "maximum number of related achievementsV2 returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[leaderboards]", - "in": "query", - "description": "maximum number of related leaderboards returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", + "archived", + "activityProperties", + "visibility", + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboard", + "gameCenterLeaderboardSets", + "localizations", + "releases", + "activity", + "challenge" + ] + } }, "style": "form", - "deprecated": true + "explode": false }, { - "name": "limit[leaderboardsV2]", + "name": "limit", "in": "query", - "description": "maximum number of related leaderboardsV2 returned (when they are included)", + "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 50 + "maximum": 200 }, "style": "form" }, { - "name": "limit[versions]", + "name": "include", "in": "query", - "description": "maximum number of related versions returned (when they are included)", + "description": "comma-separated list of relationships to include", "schema": { - "type": "integer", - "maximum": 50 + "type": "array", + "items": { + "type": "string", + "enum": [ + "gameCenterDetail", + "gameCenterLeaderboard" + ] + } }, - "style": "form" + "style": "form", + "explode": false } ], "responses": { @@ -142210,11 +148106,11 @@ } }, "200": { - "description": "List of GameCenterActivities", + "description": "List of GameCenterLeaderboardReleases", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivitiesResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardReleasesResponse" } } } @@ -142244,12 +148140,13 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/gameCenterAppVersions": { + "/v1/gameCenterDetails/{id}/relationships/leaderboardSetReleases": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_gameCenterAppVersions_getToManyRelationship", + "operationId": "gameCenterDetails_leaderboardSetReleases_getToManyRelationship", + "deprecated": true, "parameters": [ { "name": "limit", @@ -142308,7 +148205,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterAppVersionsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterDetailLeaderboardSetReleasesLinkagesResponse" } } } @@ -142338,17 +148235,18 @@ } ] }, - "/v1/gameCenterDetails/{id}/gameCenterAppVersions": { + "/v1/gameCenterDetails/{id}/leaderboardSetReleases": { "get": { "tags": [ "GameCenterDetails" ], - "operationId": "gameCenterDetails_gameCenterAppVersions_getToManyRelated", + "operationId": "gameCenterDetails_leaderboardSetReleases_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "filter[enabled]", + "name": "filter[live]", "in": "query", - "description": "filter by attribute 'enabled'", + "description": "filter by attribute 'live'", "schema": { "type": "array", "items": { @@ -142359,17 +148257,31 @@ "explode": false }, { - "name": "fields[gameCenterAppVersions]", + "name": "filter[gameCenterLeaderboardSet]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAppVersions", + "description": "filter by id(s) of related 'gameCenterLeaderboardSet'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "deprecated": true + }, + { + "name": "fields[gameCenterLeaderboardSetReleases]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "enabled", - "compatibilityVersions", - "appStoreVersion" + "live", + "gameCenterDetail", + "gameCenterLeaderboardSet" ] } }, @@ -142377,38 +148289,61 @@ "explode": false }, { - "name": "fields[appStoreVersions]", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "the fields to include for returned resources of type gameCenterDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platform", - "versionString", - "appStoreState", - "appVersionState", - "copyright", - "reviewType", - "releaseType", - "earliestReleaseDate", - "usesIdfa", - "downloadable", - "createdDate", + "arcadeEnabled", + "challengeEnabled", "app", - "appStoreVersionLocalizations", - "build", - "appStoreVersionPhasedRelease", - "gameCenterAppVersion", - "routingAppCoverage", - "appStoreReviewDetail", - "appStoreVersionSubmission", - "appClipDefaultExperience", - "appStoreVersionExperiments", - "appStoreVersionExperimentsV2", - "customerReviews", - "alternativeDistributionPackage" + "gameCenterAppVersions", + "gameCenterGroup", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges", + "defaultLeaderboard", + "defaultLeaderboardV2", + "defaultGroupLeaderboard", + "defaultGroupLeaderboardV2", + "achievementReleases", + "activityReleases", + "challengeReleases", + "leaderboardReleases", + "leaderboardSetReleases", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] + } + }, + "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" ] } }, @@ -142434,23 +148369,13 @@ "items": { "type": "string", "enum": [ - "compatibilityVersions", - "appStoreVersion" + "gameCenterDetail", + "gameCenterLeaderboardSet" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[compatibilityVersions]", - "in": "query", - "description": "maximum number of related compatibilityVersions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -142495,11 +148420,11 @@ } }, "200": { - "description": "List of GameCenterAppVersions", + "description": "List of GameCenterLeaderboardSetReleases", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAppVersionsResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetReleasesResponse" } } } @@ -142529,12 +148454,13 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/gameCenterChallenges": { + "/v1/gameCenterEnabledVersions/{id}/relationships/compatibleVersions": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterEnabledVersions" ], - "operationId": "gameCenterDetails_gameCenterChallenges_getToManyRelationship", + "operationId": "gameCenterEnabledVersions_compatibleVersions_getToManyRelationship", + "deprecated": true, "parameters": [ { "name": "limit", @@ -142593,7 +148519,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterChallengesLinkagesResponse" + "$ref": "#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesResponse" } } } @@ -142610,254 +148536,116 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterDetails/{id}/gameCenterChallenges": { - "get": { + "post": { "tags": [ - "GameCenterDetails" + "GameCenterEnabledVersions" ], - "operationId": "gameCenterDetails_gameCenterChallenges_getToManyRelated", - "parameters": [ - { - "name": "filter[referenceName]", - "in": "query", - "description": "filter by attribute 'referenceName'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[archived]", - "in": "query", - "description": "filter by attribute 'archived'", - "schema": { - "type": "array", - "items": { - "type": "string" + "operationId": "gameCenterEnabledVersions_compatibleVersions_createToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest" } - }, - "style": "form", - "explode": false + } }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" + "required": true + }, + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": 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", - "blockedPlayers", - "challengesMinimumPlatformVersions" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "fields[gameCenterChallengeVersions]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "challenge", - "localizations", - "releases", - "defaultImage" - ] + "422": { + "description": "Unprocessable request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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", - "gameCenterScoreModerations", - "versions" - ] + "409": { + "description": "Request entity error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" + "204": { + "description": "Success (no content)" }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "gameCenterDetail", - "gameCenterGroup", - "versions", - "leaderboard", - "leaderboardV2" - ] + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false - }, - { - "name": "limit[versions]", - "in": "query", - "description": "maximum number of related versions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" + } } + } + }, + "patch": { + "tags": [ + "GameCenterEnabledVersions" ], + "operationId": "gameCenterEnabledVersions_compatibleVersions_replaceToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -142899,16 +148687,29 @@ } } }, - "200": { - "description": "List of GameCenterChallenges", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterChallengesResponse" + "$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": { @@ -142921,26 +148722,23 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterDetails/{id}/relationships/gameCenterGroup": { - "get": { + "delete": { "tags": [ - "GameCenterDetails" + "GameCenterEnabledVersions" ], - "operationId": "gameCenterDetails_gameCenterGroup_getToOneRelationship", - "parameters": [], + "operationId": "gameCenterEnabledVersions_compatibleVersions_deleteToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -142982,16 +148780,29 @@ } } }, - "200": { - "description": "Related linkage", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterGroupLinkageResponse" + "$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": { @@ -143017,32 +148828,27 @@ } ] }, - "/v1/gameCenterDetails/{id}/gameCenterGroup": { + "/v1/gameCenterEnabledVersions/{id}/compatibleVersions": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterEnabledVersions" ], - "operationId": "gameCenterDetails_gameCenterGroup_getToOneRelated", + "operationId": "gameCenterEnabledVersions_compatibleVersions_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[gameCenterGroups]", + "name": "filter[platform]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterGroups", + "description": "filter by attribute 'platform'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "gameCenterDetails", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges" + "IOS", + "MAC_OS", + "TV_OS", + "VISION_OS" ] } }, @@ -143050,129 +148856,55 @@ "explode": false }, { - "name": "fields[gameCenterDetails]", + "name": "filter[versionString]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterDetails", + "description": "filter by attribute 'versionString'", "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", - "blockedPlayers", - "challengesMinimumPlatformVersions" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[gameCenterLeaderboards]", + "name": "filter[app]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "filter by id(s) of related 'app'", "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", - "gameCenterScoreModerations", - "versions" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[gameCenterLeaderboardSets]", + "name": "filter[id]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "filter by id(s)", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "referenceName", - "vendorIdentifier", - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboardSet", - "localizations", - "gameCenterLeaderboards", - "releases", - "versions" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[gameCenterAchievements]", + "name": "sort", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievements", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "points", - "showBeforeEarned", - "repeatable", - "archived", - "activityProperties", - "gameCenterDetail", - "gameCenterGroup", - "groupAchievement", - "localizations", - "releases", - "activity", - "versions" + "versionString", + "-versionString" ] } }, @@ -143180,29 +148912,19 @@ "explode": false }, { - "name": "fields[gameCenterActivities]", + "name": "fields[gameCenterEnabledVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivities", + "description": "the fields to include for returned resources of type gameCenterEnabledVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "playStyle", - "minimumPlayersCount", - "maximumPlayersCount", - "supportsPartyCode", - "archived", - "properties", - "gameCenterDetail", - "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", - "versions" + "platform", + "versionString", + "iconAsset", + "compatibleVersions", + "app" ] } }, @@ -143210,30 +148932,88 @@ "explode": false }, { - "name": "fields[gameCenterChallenges]", + "name": "fields[apps]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallenges", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "archived", - "challengeType", - "repeatable", + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", "gameCenterDetail", - "gameCenterGroup", - "versions", - "leaderboard", - "leaderboardV2" + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "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", @@ -143243,15 +149023,8 @@ "items": { "type": "string", "enum": [ - "gameCenterDetails", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges" + "compatibleVersions", + "app" ] } }, @@ -143259,97 +149032,15 @@ "explode": false }, { - "name": "limit[gameCenterDetails]", - "in": "query", - "description": "maximum number of related gameCenterDetails 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]", + "name": "limit[compatibleVersions]", "in": "query", - "description": "maximum number of related gameCenterAchievements returned (when they are included)", + "description": "maximum number of related compatibleVersions 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" } ], "responses": { @@ -143394,11 +149085,11 @@ } }, "200": { - "description": "Single GameCenterGroup", + "description": "List of GameCenterEnabledVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupResponse" + "$ref": "#/components/schemas/GameCenterEnabledVersionsResponse" } } } @@ -143428,12 +149119,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/gameCenterLeaderboardSets": { + "/v1/gameCenterGroups/{id}/relationships/gameCenterAchievements": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_gameCenterLeaderboardSets_getToManyRelationship", + "operationId": "gameCenterGroups_gameCenterAchievements_getToManyRelationship", "deprecated": true, "parameters": [ { @@ -143493,7 +149184,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardSetsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterGroupGameCenterAchievementsLinkagesResponse" } } } @@ -143512,16 +149203,16 @@ }, "patch": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_gameCenterLeaderboardSets_replaceToManyRelationship", + "operationId": "gameCenterGroups_gameCenterAchievements_replaceToManyRelationship", "deprecated": true, "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardSetsLinkagesRequest" + "$ref": "#/components/schemas/GameCenterGroupGameCenterAchievementsLinkagesRequest" } } }, @@ -143616,12 +149307,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/gameCenterLeaderboardSets": { + "/v1/gameCenterGroups/{id}/gameCenterAchievements": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_gameCenterLeaderboardSets_getToManyRelated", + "operationId": "gameCenterGroups_gameCenterAchievements_getToManyRelated", "deprecated": true, "parameters": [ { @@ -143637,6 +149328,19 @@ "style": "form", "explode": false }, + { + "name": "filter[archived]", + "in": "query", + "description": "filter by attribute 'archived'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, { "name": "filter[id]", "in": "query", @@ -143651,9 +149355,9 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSets]", + "name": "fields[gameCenterAchievements]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "the fields to include for returned resources of type gameCenterAchievements", "schema": { "type": "array", "items": { @@ -143661,12 +149365,17 @@ "enum": [ "referenceName", "vendorIdentifier", + "points", + "showBeforeEarned", + "repeatable", + "archived", + "activityProperties", "gameCenterDetail", "gameCenterGroup", - "groupLeaderboardSet", + "groupAchievement", "localizations", - "gameCenterLeaderboards", - "releases" + "releases", + "activity" ] } }, @@ -143738,9 +149447,9 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetLocalizations]", + "name": "fields[gameCenterAchievementLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", + "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", "schema": { "type": "array", "items": { @@ -143748,8 +149457,10 @@ "enum": [ "locale", "name", - "gameCenterLeaderboardSet", - "gameCenterLeaderboardSetImage" + "beforeEarnedDescription", + "afterEarnedDescription", + "gameCenterAchievement", + "gameCenterAchievementImage" ] } }, @@ -143757,35 +149468,17 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboards]", + "name": "fields[gameCenterAchievementReleases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "the fields to include for returned resources of type gameCenterAchievementReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "defaultFormatter", - "referenceName", - "vendorIdentifier", - "submissionType", - "scoreSortType", - "scoreRangeStart", - "scoreRangeEnd", - "recurrenceStartDate", - "recurrenceDuration", - "recurrenceRule", - "archived", - "activityProperties", - "visibility", + "live", "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboard", - "gameCenterLeaderboardSets", - "localizations", - "releases", - "activity", - "challenge" + "gameCenterAchievement" ] } }, @@ -143793,17 +149486,29 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetReleases]", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetReleases", + "description": "the fields to include for returned resources of type gameCenterActivities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", + "referenceName", + "vendorIdentifier", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", + "archived", + "properties", "gameCenterDetail", - "gameCenterLeaderboardSet" + "gameCenterGroup", + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" ] } }, @@ -143831,10 +149536,10 @@ "enum": [ "gameCenterDetail", "gameCenterGroup", - "groupLeaderboardSet", + "groupAchievement", "localizations", - "gameCenterLeaderboards", - "releases" + "releases", + "activity" ] } }, @@ -143852,17 +149557,6 @@ "style": "form", "deprecated": true }, - { - "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[releases]", "in": "query", @@ -143917,11 +149611,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardSets", + "description": "List of GameCenterAchievements", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetsResponse" + "$ref": "#/components/schemas/GameCenterAchievementsResponse" } } } @@ -143951,12 +149645,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/gameCenterLeaderboardSetsV2": { + "/v1/gameCenterGroups/{id}/relationships/gameCenterAchievementsV2": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_gameCenterLeaderboardSetsV2_getToManyRelationship", + "operationId": "gameCenterGroups_gameCenterAchievementsV2_getToManyRelationship", "parameters": [ { "name": "limit", @@ -144015,7 +149709,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardSetsV2LinkagesResponse" + "$ref": "#/components/schemas/GameCenterGroupGameCenterAchievementsV2LinkagesResponse" } } } @@ -144034,15 +149728,15 @@ }, "patch": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_gameCenterLeaderboardSetsV2_replaceToManyRelationship", + "operationId": "gameCenterGroups_gameCenterAchievementsV2_replaceToManyRelationship", "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardSetsV2LinkagesRequest" + "$ref": "#/components/schemas/GameCenterGroupGameCenterAchievementsV2LinkagesRequest" } } }, @@ -144137,12 +149831,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/gameCenterLeaderboardSetsV2": { + "/v1/gameCenterGroups/{id}/gameCenterAchievementsV2": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_gameCenterLeaderboardSetsV2_getToManyRelated", + "operationId": "gameCenterGroups_gameCenterAchievementsV2_getToManyRelated", "parameters": [ { "name": "filter[referenceName]", @@ -144157,6 +149851,19 @@ "style": "form", "explode": false }, + { + "name": "filter[archived]", + "in": "query", + "description": "filter by attribute 'archived'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, { "name": "filter[id]", "in": "query", @@ -144171,9 +149878,9 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSets]", + "name": "fields[gameCenterAchievements]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "the fields to include for returned resources of type gameCenterAchievements", "schema": { "type": "array", "items": { @@ -144181,9 +149888,14 @@ "enum": [ "referenceName", "vendorIdentifier", + "points", + "showBeforeEarned", + "repeatable", + "archived", + "activityProperties", "gameCenterDetail", "gameCenterGroup", - "gameCenterLeaderboards", + "activity", "versions" ] } @@ -144256,33 +149968,28 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboards]", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "the fields to include for returned resources of type gameCenterActivities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "defaultFormatter", "referenceName", "vendorIdentifier", - "submissionType", - "scoreSortType", - "scoreRangeStart", - "scoreRangeEnd", - "recurrenceStartDate", - "recurrenceDuration", - "recurrenceRule", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", "archived", - "activityProperties", - "visibility", + "properties", "gameCenterDetail", "gameCenterGroup", - "gameCenterLeaderboardSets", - "gameCenterScoreModerations", - "activity", - "challenge", + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", "versions" ] } @@ -144291,9 +149998,9 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetVersions]", + "name": "fields[gameCenterAchievementVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetVersions", + "description": "the fields to include for returned resources of type gameCenterAchievementVersions", "schema": { "type": "array", "items": { @@ -144301,7 +150008,7 @@ "enum": [ "version", "state", - "leaderboardSet", + "achievement", "localizations" ] } @@ -144330,7 +150037,7 @@ "enum": [ "gameCenterDetail", "gameCenterGroup", - "gameCenterLeaderboards", + "activity", "versions" ] } @@ -144338,16 +150045,6 @@ "style": "form", "explode": false }, - { - "name": "limit[gameCenterLeaderboards]", - "in": "query", - "description": "maximum number of related gameCenterLeaderboards returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, { "name": "limit[versions]", "in": "query", @@ -144401,11 +150098,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardSets", + "description": "List of GameCenterAchievements", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetsV2Response" + "$ref": "#/components/schemas/GameCenterAchievementsV2Response" } } } @@ -144435,13 +150132,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/gameCenterLeaderboards": { + "/v1/gameCenterGroups/{id}/relationships/gameCenterActivities": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_gameCenterLeaderboards_getToManyRelationship", - "deprecated": true, + "operationId": "gameCenterGroups_gameCenterActivities_getToManyRelationship", "parameters": [ { "name": "limit", @@ -144500,104 +150196,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardsLinkagesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "patch": { - "tags": [ - "GameCenterDetails" - ], - "operationId": "gameCenterDetails_gameCenterLeaderboards_replaceToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardsLinkagesRequest" - } - } - }, - "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" + "$ref": "#/components/schemas/GameCenterGroupGameCenterActivitiesLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -144623,83 +150226,37 @@ } ] }, - "/v1/gameCenterDetails/{id}/gameCenterLeaderboards": { + "/v1/gameCenterGroups/{id}/gameCenterActivities": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_gameCenterLeaderboards_getToManyRelated", - "deprecated": true, + "operationId": "gameCenterGroups_gameCenterActivities_getToManyRelated", "parameters": [ { - "name": "filter[referenceName]", - "in": "query", - "description": "filter by attribute 'referenceName'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[archived]", - "in": "query", - "description": "filter by attribute 'archived'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboards]", + "name": "fields[gameCenterActivities]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "the fields to include for returned resources of type gameCenterActivities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "defaultFormatter", "referenceName", "vendorIdentifier", - "submissionType", - "scoreSortType", - "scoreRangeStart", - "scoreRangeEnd", - "recurrenceStartDate", - "recurrenceDuration", - "recurrenceRule", + "playStyle", + "minimumPlayersCount", + "maximumPlayersCount", + "supportsPartyCode", "archived", - "activityProperties", - "visibility", + "properties", "gameCenterDetail", "gameCenterGroup", - "groupLeaderboard", - "gameCenterLeaderboardSets", - "localizations", - "releases", - "activity", - "challenge" + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" ] } }, @@ -144771,9 +150328,9 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSets]", + "name": "fields[gameCenterAchievements]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "the fields to include for returned resources of type gameCenterAchievements", "schema": { "type": "array", "items": { @@ -144781,53 +150338,18 @@ "enum": [ "referenceName", "vendorIdentifier", + "points", + "showBeforeEarned", + "repeatable", + "archived", + "activityProperties", "gameCenterDetail", "gameCenterGroup", - "groupLeaderboardSet", + "groupAchievement", "localizations", - "gameCenterLeaderboards", - "releases" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboardLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "formatterOverride", - "formatterSuffix", - "formatterSuffixSingular", - "description", - "gameCenterLeaderboard", - "gameCenterLeaderboardImage" - ] - } - }, - "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" + "releases", + "activity", + "versions" ] } }, @@ -144835,28 +150357,36 @@ "explode": false }, { - "name": "fields[gameCenterActivities]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivities", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "defaultFormatter", "referenceName", "vendorIdentifier", - "playStyle", - "minimumPlayersCount", - "maximumPlayersCount", - "supportsPartyCode", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", "archived", - "properties", + "activityProperties", + "visibility", "gameCenterDetail", "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", + "groupLeaderboard", + "gameCenterLeaderboardSets", + "localizations", + "releases", + "activity", + "challenge", + "gameCenterScoreModerations", "versions" ] } @@ -144865,24 +150395,21 @@ "explode": false }, { - "name": "fields[gameCenterChallenges]", + "name": "fields[gameCenterActivityVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallenges", + "description": "the fields to include for returned resources of type gameCenterActivityVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "archived", - "challengeType", - "repeatable", - "gameCenterDetail", - "gameCenterGroup", - "versions", - "leaderboard", - "leaderboardV2" + "version", + "state", + "fallbackUrl", + "activity", + "localizations", + "defaultImage", + "releases" ] } }, @@ -144910,12 +150437,11 @@ "enum": [ "gameCenterDetail", "gameCenterGroup", - "groupLeaderboard", - "gameCenterLeaderboardSets", - "localizations", - "releases", - "activity", - "challenge" + "achievements", + "achievementsV2", + "leaderboards", + "leaderboardsV2", + "versions" ] } }, @@ -144923,9 +150449,9 @@ "explode": false }, { - "name": "limit[gameCenterLeaderboardSets]", + "name": "limit[achievements]", "in": "query", - "description": "maximum number of related gameCenterLeaderboardSets returned (when they are included)", + "description": "maximum number of related achievements returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -144934,26 +150460,45 @@ "deprecated": true }, { - "name": "limit[localizations]", + "name": "limit[achievementsV2]", "in": "query", - "description": "maximum number of related localizations returned (when they are included)", + "description": "maximum number of related achievementsV2 returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, - "style": "form", - "deprecated": true + "style": "form" }, { - "name": "limit[releases]", + "name": "limit[leaderboards]", "in": "query", - "description": "maximum number of related releases returned (when they are included)", + "description": "maximum number of related leaderboards returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, "style": "form", "deprecated": true + }, + { + "name": "limit[leaderboardsV2]", + "in": "query", + "description": "maximum number of related leaderboardsV2 returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -144998,11 +150543,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboards", + "description": "List of GameCenterActivities", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardsResponse" + "$ref": "#/components/schemas/GameCenterActivitiesResponse" } } } @@ -145032,12 +150577,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/gameCenterLeaderboardsV2": { + "/v1/gameCenterGroups/{id}/relationships/gameCenterChallenges": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_gameCenterLeaderboardsV2_getToManyRelationship", + "operationId": "gameCenterGroups_gameCenterChallenges_getToManyRelationship", "parameters": [ { "name": "limit", @@ -145096,103 +150641,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardsV2LinkagesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "patch": { - "tags": [ - "GameCenterDetails" - ], - "operationId": "gameCenterDetails_gameCenterLeaderboardsV2_replaceToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterDetailGameCenterLeaderboardsV2LinkagesRequest" - } - } - }, - "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" + "$ref": "#/components/schemas/GameCenterGroupGameCenterChallengesLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -145218,12 +150671,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/gameCenterLeaderboardsV2": { + "/v1/gameCenterGroups/{id}/gameCenterChallenges": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_gameCenterLeaderboardsV2_getToManyRelated", + "operationId": "gameCenterGroups_gameCenterChallenges_getToManyRelated", "parameters": [ { "name": "filter[referenceName]", @@ -145265,34 +150718,24 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboards]", + "name": "fields[gameCenterChallenges]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "the fields to include for returned resources of type gameCenterChallenges", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "defaultFormatter", "referenceName", "vendorIdentifier", - "submissionType", - "scoreSortType", - "scoreRangeStart", - "scoreRangeEnd", - "recurrenceStartDate", - "recurrenceDuration", - "recurrenceRule", "archived", - "activityProperties", - "visibility", + "challengeType", + "repeatable", "gameCenterDetail", "gameCenterGroup", - "gameCenterLeaderboardSets", - "gameCenterScoreModerations", - "activity", - "challenge", - "versions" + "versions", + "leaderboard", + "leaderboardV2" ] } }, @@ -145364,50 +150807,20 @@ "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", - "gameCenterLeaderboards", - "versions" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterActivities]", + "name": "fields[gameCenterChallengeVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivities", + "description": "the fields to include for returned resources of type gameCenterChallengeVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "playStyle", - "minimumPlayersCount", - "maximumPlayersCount", - "supportsPartyCode", - "archived", - "properties", - "gameCenterDetail", - "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", - "versions" + "version", + "state", + "challenge", + "localizations", + "releases", + "defaultImage" ] } }, @@ -145415,43 +150828,37 @@ "explode": false }, { - "name": "fields[gameCenterChallenges]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallenges", + "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", - "challengeType", - "repeatable", + "activityProperties", + "visibility", "gameCenterDetail", - "gameCenterGroup", - "versions", - "leaderboard", - "leaderboardV2" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboardVersions]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "leaderboard", - "localizations" + "gameCenterGroup", + "groupLeaderboard", + "gameCenterLeaderboardSets", + "localizations", + "releases", + "activity", + "challenge", + "gameCenterScoreModerations", + "versions" ] } }, @@ -145479,26 +150886,15 @@ "enum": [ "gameCenterDetail", "gameCenterGroup", - "gameCenterLeaderboardSets", - "activity", - "challenge", - "versions" + "versions", + "leaderboard", + "leaderboardV2" ] } }, "style": "form", "explode": false }, - { - "name": "limit[gameCenterLeaderboardSets]", - "in": "query", - "description": "maximum number of related gameCenterLeaderboardSets returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, { "name": "limit[versions]", "in": "query", @@ -145552,11 +150948,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboards", + "description": "List of GameCenterChallenges", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardsV2Response" + "$ref": "#/components/schemas/GameCenterChallengesResponse" } } } @@ -145586,13 +150982,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/leaderboardReleases": { + "/v1/gameCenterGroups/{id}/relationships/gameCenterDetails": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_leaderboardReleases_getToManyRelationship", - "deprecated": true, + "operationId": "gameCenterGroups_gameCenterDetails_getToManyRelationship", "parameters": [ { "name": "limit", @@ -145651,7 +151046,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailLeaderboardReleasesLinkagesResponse" + "$ref": "#/components/schemas/GameCenterGroupGameCenterDetailsLinkagesResponse" } } } @@ -145681,18 +151076,17 @@ } ] }, - "/v1/gameCenterDetails/{id}/leaderboardReleases": { + "/v1/gameCenterGroups/{id}/gameCenterDetails": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_leaderboardReleases_getToManyRelated", - "deprecated": true, + "operationId": "gameCenterGroups_gameCenterDetails_getToManyRelated", "parameters": [ { - "name": "filter[live]", + "name": "filter[gameCenterAppVersions.enabled]", "in": "query", - "description": "filter by attribute 'live'", + "description": "filter by attribute 'gameCenterAppVersions.enabled'", "schema": { "type": "array", "items": { @@ -145703,31 +151097,111 @@ "explode": false }, { - "name": "filter[gameCenterLeaderboard]", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "filter by id(s) of related 'gameCenterLeaderboard'", + "description": "the fields to include for returned resources of type gameCenterDetails", "schema": { "type": "array", "items": { - "type": "string" + "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", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] } }, "style": "form", - "explode": false, - "deprecated": true + "explode": false }, { - "name": "fields[gameCenterLeaderboardReleases]", + "name": "fields[apps]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardReleases", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", "gameCenterDetail", - "gameCenterLeaderboard" + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, @@ -145735,19 +151209,34 @@ "explode": false }, { - "name": "fields[gameCenterDetails]", + "name": "fields[gameCenterAppVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterDetails", + "description": "the fields to include for returned resources of type gameCenterAppVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "arcadeEnabled", - "challengeEnabled", - "app", - "gameCenterAppVersions", - "gameCenterGroup", + "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", @@ -145755,18 +151244,7 @@ "gameCenterAchievements", "gameCenterAchievementsV2", "gameCenterActivities", - "gameCenterChallenges", - "defaultLeaderboard", - "defaultLeaderboardV2", - "defaultGroupLeaderboard", - "defaultGroupLeaderboardV2", - "achievementReleases", - "activityReleases", - "challengeReleases", - "leaderboardReleases", - "leaderboardSetReleases", - "blockedPlayers", - "challengesMinimumPlatformVersions" + "gameCenterChallenges" ] } }, @@ -145802,7 +151280,242 @@ "localizations", "releases", "activity", - "challenge" + "challenge", + "gameCenterScoreModerations", + "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" ] } }, @@ -145828,13 +151541,190 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterLeaderboard" + "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": { @@ -145879,11 +151769,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardReleases", + "description": "List of GameCenterDetails", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardReleasesResponse" + "$ref": "#/components/schemas/GameCenterDetailsResponse" } } } @@ -145913,12 +151803,12 @@ } ] }, - "/v1/gameCenterDetails/{id}/relationships/leaderboardSetReleases": { + "/v1/gameCenterGroups/{id}/relationships/gameCenterLeaderboardSets": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_leaderboardSetReleases_getToManyRelationship", + "operationId": "gameCenterGroups_gameCenterLeaderboardSets_getToManyRelationship", "deprecated": true, "parameters": [ { @@ -145978,11 +151868,104 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailLeaderboardSetReleasesLinkagesResponse" + "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardSetsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "patch": { + "tags": [ + "GameCenterGroups" + ], + "operationId": "gameCenterGroups_gameCenterLeaderboardSets_replaceToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardSetsLinkagesRequest" + } + } + }, + "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": { @@ -146008,18 +151991,18 @@ } ] }, - "/v1/gameCenterDetails/{id}/leaderboardSetReleases": { + "/v1/gameCenterGroups/{id}/gameCenterLeaderboardSets": { "get": { "tags": [ - "GameCenterDetails" + "GameCenterGroups" ], - "operationId": "gameCenterDetails_leaderboardSetReleases_getToManyRelated", + "operationId": "gameCenterGroups_gameCenterLeaderboardSets_getToManyRelated", "deprecated": true, "parameters": [ { - "name": "filter[live]", + "name": "filter[referenceName]", "in": "query", - "description": "filter by attribute 'live'", + "description": "filter by attribute 'referenceName'", "schema": { "type": "array", "items": { @@ -146030,9 +152013,9 @@ "explode": false }, { - "name": "filter[gameCenterLeaderboardSet]", + "name": "filter[id]", "in": "query", - "description": "filter by id(s) of related 'gameCenterLeaderboardSet'", + "description": "filter by id(s)", "schema": { "type": "array", "items": { @@ -146040,21 +152023,25 @@ } }, "style": "form", - "explode": false, - "deprecated": true + "explode": false }, { - "name": "fields[gameCenterLeaderboardSetReleases]", + "name": "fields[gameCenterLeaderboardSets]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetReleases", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", + "referenceName", + "vendorIdentifier", "gameCenterDetail", - "gameCenterLeaderboardSet" + "gameCenterGroup", + "groupLeaderboardSet", + "localizations", + "gameCenterLeaderboards", + "releases" ] } }, @@ -146101,22 +152088,97 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSets]", + "name": "fields[gameCenterGroups]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "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[gameCenterLeaderboardSetLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "gameCenterLeaderboardSet", + "gameCenterLeaderboardSetImage" + ] + } + }, + "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", - "groupLeaderboardSet", + "groupLeaderboard", + "gameCenterLeaderboardSets", "localizations", - "gameCenterLeaderboards", - "releases" + "releases", + "activity", + "challenge" + ] + } + }, + "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" ] } }, @@ -146143,189 +152205,51 @@ "type": "string", "enum": [ "gameCenterDetail", - "gameCenterLeaderboardSet" + "gameCenterGroup", + "groupLeaderboardSet", + "localizations", + "gameCenterLeaderboards", + "releases" ] } }, "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 GameCenterLeaderboardSetReleases", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetReleasesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterEnabledVersions/{id}/relationships/compatibleVersions": { - "get": { - "tags": [ - "GameCenterEnabledVersions" - ], - "operationId": "gameCenterEnabledVersions_compatibleVersions_getToManyRelationship", - "deprecated": true, - "parameters": [ { - "name": "limit", + "name": "limit[localizations]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related localizations returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "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 related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesResponse" - } - } - } + "style": "form", + "deprecated": true }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "GameCenterEnabledVersions" - ], - "operationId": "gameCenterEnabledVersions_compatibleVersions_createToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest" - } - } + { + "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 }, - "required": true - }, + { + "name": "limit[releases]", + "in": "query", + "description": "maximum number of related releases returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "deprecated": true + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -146367,29 +152291,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of GameCenterLeaderboardSets", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetsResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -146402,23 +152313,37 @@ } } }, - "patch": { - "tags": [ - "GameCenterEnabledVersions" - ], - "operationId": "gameCenterEnabledVersions_compatibleVersions_replaceToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest" - } - } + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", "required": true - }, + } + ] + }, + "/v1/gameCenterGroups/{id}/relationships/gameCenterLeaderboardSetsV2": { + "get": { + "tags": [ + "GameCenterGroups" + ], + "operationId": "gameCenterGroups_gameCenterLeaderboardSetsV2_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -146460,29 +152385,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardSetsV2LinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -146495,18 +152407,17 @@ } } }, - "delete": { + "patch": { "tags": [ - "GameCenterEnabledVersions" + "GameCenterGroups" ], - "operationId": "gameCenterEnabledVersions_compatibleVersions_deleteToManyRelationship", - "deprecated": true, + "operationId": "gameCenterGroups_gameCenterLeaderboardSetsV2_replaceToManyRelationship", "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest" + "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardSetsV2LinkagesRequest" } } }, @@ -146601,37 +152512,30 @@ } ] }, - "/v1/gameCenterEnabledVersions/{id}/compatibleVersions": { + "/v1/gameCenterGroups/{id}/gameCenterLeaderboardSetsV2": { "get": { "tags": [ - "GameCenterEnabledVersions" + "GameCenterGroups" ], - "operationId": "gameCenterEnabledVersions_compatibleVersions_getToManyRelated", - "deprecated": true, + "operationId": "gameCenterGroups_gameCenterLeaderboardSetsV2_getToManyRelated", "parameters": [ { - "name": "filter[platform]", + "name": "filter[referenceName]", "in": "query", - "description": "filter by attribute 'platform'", + "description": "filter by attribute 'referenceName'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "IOS", - "MAC_OS", - "TV_OS", - "VISION_OS" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "filter[versionString]", + "name": "filter[id]", "in": "query", - "description": "filter by attribute 'versionString'", + "description": "filter by id(s)", "schema": { "type": "array", "items": { @@ -146642,42 +152546,84 @@ "explode": false }, { - "name": "filter[app]", + "name": "fields[gameCenterLeaderboardSets]", "in": "query", - "description": "filter by id(s) of related 'app'", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "referenceName", + "vendorIdentifier", + "gameCenterDetail", + "gameCenterGroup", + "gameCenterLeaderboards", + "versions" + ] } }, "style": "form", "explode": false }, { - "name": "filter[id]", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "filter by id(s)", + "description": "the fields to include for returned resources of type gameCenterDetails", "schema": { "type": "array", "items": { - "type": "string" + "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", + "blockedPlayers", + "challengesMinimumPlatformVersions" + ] } }, "style": "form", "explode": false }, { - "name": "sort", + "name": "fields[gameCenterGroups]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type gameCenterGroups", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "versionString", - "-versionString" + "referenceName", + "gameCenterDetails", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges" ] } }, @@ -146685,19 +152631,34 @@ "explode": false }, { - "name": "fields[gameCenterEnabledVersions]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterEnabledVersions", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "platform", - "versionString", - "iconAsset", - "compatibleVersions", - "app" + "defaultFormatter", + "referenceName", + "vendorIdentifier", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", + "archived", + "activityProperties", + "visibility", + "gameCenterDetail", + "gameCenterGroup", + "gameCenterLeaderboardSets", + "gameCenterScoreModerations", + "activity", + "challenge", + "versions" ] } }, @@ -146705,71 +152666,18 @@ "explode": false }, { - "name": "fields[apps]", + "name": "fields[gameCenterLeaderboardSetVersions]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetVersions", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" + "version", + "state", + "leaderboardSet", + "localizations" ] } }, @@ -146795,8 +152703,10 @@ "items": { "type": "string", "enum": [ - "compatibleVersions", - "app" + "gameCenterDetail", + "gameCenterGroup", + "gameCenterLeaderboards", + "versions" ] } }, @@ -146804,15 +152714,24 @@ "explode": false }, { - "name": "limit[compatibleVersions]", + "name": "limit[gameCenterLeaderboards]", "in": "query", - "description": "maximum number of related compatibleVersions returned (when they are included)", + "description": "maximum number of related gameCenterLeaderboards returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, - "style": "form", - "deprecated": true + "style": "form" + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -146857,11 +152776,11 @@ } }, "200": { - "description": "List of GameCenterEnabledVersions", + "description": "List of GameCenterLeaderboardSets", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterEnabledVersionsResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetsV2Response" } } } @@ -146891,12 +152810,12 @@ } ] }, - "/v1/gameCenterGroups/{id}/relationships/gameCenterAchievements": { + "/v1/gameCenterGroups/{id}/relationships/gameCenterLeaderboards": { "get": { "tags": [ "GameCenterGroups" ], - "operationId": "gameCenterGroups_gameCenterAchievements_getToManyRelationship", + "operationId": "gameCenterGroups_gameCenterLeaderboards_getToManyRelationship", "deprecated": true, "parameters": [ { @@ -146956,7 +152875,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterAchievementsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardsLinkagesResponse" } } } @@ -146977,14 +152896,14 @@ "tags": [ "GameCenterGroups" ], - "operationId": "gameCenterGroups_gameCenterAchievements_replaceToManyRelationship", + "operationId": "gameCenterGroups_gameCenterLeaderboards_replaceToManyRelationship", "deprecated": true, "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterAchievementsLinkagesRequest" + "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardsLinkagesRequest" } } }, @@ -147079,12 +152998,12 @@ } ] }, - "/v1/gameCenterGroups/{id}/gameCenterAchievements": { + "/v1/gameCenterGroups/{id}/gameCenterLeaderboards": { "get": { "tags": [ "GameCenterGroups" ], - "operationId": "gameCenterGroups_gameCenterAchievements_getToManyRelated", + "operationId": "gameCenterGroups_gameCenterLeaderboards_getToManyRelated", "deprecated": true, "parameters": [ { @@ -147127,27 +153046,35 @@ "explode": false }, { - "name": "fields[gameCenterAchievements]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievements", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "defaultFormatter", "referenceName", "vendorIdentifier", - "points", - "showBeforeEarned", - "repeatable", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", "archived", "activityProperties", + "visibility", "gameCenterDetail", "gameCenterGroup", - "groupAchievement", + "groupLeaderboard", + "gameCenterLeaderboardSets", "localizations", "releases", - "activity" + "activity", + "challenge" ] } }, @@ -147219,9 +153146,32 @@ "explode": false }, { - "name": "fields[gameCenterAchievementLocalizations]", + "name": "fields[gameCenterLeaderboardSets]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementLocalizations", + "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" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterLeaderboardLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", "schema": { "type": "array", "items": { @@ -147229,10 +153179,12 @@ "enum": [ "locale", "name", - "beforeEarnedDescription", - "afterEarnedDescription", - "gameCenterAchievement", - "gameCenterAchievementImage" + "formatterOverride", + "formatterSuffix", + "formatterSuffixSingular", + "description", + "gameCenterLeaderboard", + "gameCenterLeaderboardImage" ] } }, @@ -147240,9 +153192,9 @@ "explode": false }, { - "name": "fields[gameCenterAchievementReleases]", + "name": "fields[gameCenterLeaderboardReleases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementReleases", + "description": "the fields to include for returned resources of type gameCenterLeaderboardReleases", "schema": { "type": "array", "items": { @@ -147250,7 +153202,7 @@ "enum": [ "live", "gameCenterDetail", - "gameCenterAchievement" + "gameCenterLeaderboard" ] } }, @@ -147287,6 +153239,31 @@ "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": "limit", "in": "query", @@ -147308,16 +153285,29 @@ "enum": [ "gameCenterDetail", "gameCenterGroup", - "groupAchievement", + "groupLeaderboard", + "gameCenterLeaderboardSets", "localizations", "releases", - "activity" + "activity", + "challenge" ] } }, "style": "form", "explode": false }, + { + "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[localizations]", "in": "query", @@ -147383,11 +153373,11 @@ } }, "200": { - "description": "List of GameCenterAchievements", + "description": "List of GameCenterLeaderboards", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementsResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardsResponse" } } } @@ -147417,12 +153407,12 @@ } ] }, - "/v1/gameCenterGroups/{id}/relationships/gameCenterAchievementsV2": { + "/v1/gameCenterGroups/{id}/relationships/gameCenterLeaderboardsV2": { "get": { "tags": [ "GameCenterGroups" ], - "operationId": "gameCenterGroups_gameCenterAchievementsV2_getToManyRelationship", + "operationId": "gameCenterGroups_gameCenterLeaderboardsV2_getToManyRelationship", "parameters": [ { "name": "limit", @@ -147481,7 +153471,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterAchievementsV2LinkagesResponse" + "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardsV2LinkagesResponse" } } } @@ -147502,13 +153492,13 @@ "tags": [ "GameCenterGroups" ], - "operationId": "gameCenterGroups_gameCenterAchievementsV2_replaceToManyRelationship", + "operationId": "gameCenterGroups_gameCenterLeaderboardsV2_replaceToManyRelationship", "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterAchievementsV2LinkagesRequest" + "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardsV2LinkagesRequest" } } }, @@ -147603,12 +153593,12 @@ } ] }, - "/v1/gameCenterGroups/{id}/gameCenterAchievementsV2": { + "/v1/gameCenterGroups/{id}/gameCenterLeaderboardsV2": { "get": { "tags": [ "GameCenterGroups" ], - "operationId": "gameCenterGroups_gameCenterAchievementsV2_getToManyRelated", + "operationId": "gameCenterGroups_gameCenterLeaderboardsV2_getToManyRelated", "parameters": [ { "name": "filter[referenceName]", @@ -147650,24 +153640,33 @@ "explode": false }, { - "name": "fields[gameCenterAchievements]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievements", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "defaultFormatter", "referenceName", "vendorIdentifier", - "points", - "showBeforeEarned", - "repeatable", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", "archived", "activityProperties", + "visibility", "gameCenterDetail", "gameCenterGroup", + "gameCenterLeaderboardSets", + "gameCenterScoreModerations", "activity", + "challenge", "versions" ] } @@ -147739,6 +153738,27 @@ "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", + "gameCenterLeaderboards", + "versions" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "fields[gameCenterActivities]", "in": "query", @@ -147770,9 +153790,34 @@ "explode": false }, { - "name": "fields[gameCenterAchievementVersions]", + "name": "fields[gameCenterChallenges]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementVersions", + "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[gameCenterLeaderboardVersions]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", "schema": { "type": "array", "items": { @@ -147780,7 +153825,7 @@ "enum": [ "version", "state", - "achievement", + "leaderboard", "localizations" ] } @@ -147809,7 +153854,9 @@ "enum": [ "gameCenterDetail", "gameCenterGroup", + "gameCenterLeaderboardSets", "activity", + "challenge", "versions" ] } @@ -147817,6 +153864,16 @@ "style": "form", "explode": false }, + { + "name": "limit[gameCenterLeaderboardSets]", + "in": "query", + "description": "maximum number of related gameCenterLeaderboardSets returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, { "name": "limit[versions]", "in": "query", @@ -147870,11 +153927,11 @@ } }, "200": { - "description": "List of GameCenterAchievements", + "description": "List of GameCenterLeaderboards", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterAchievementsV2Response" + "$ref": "#/components/schemas/GameCenterLeaderboardsV2Response" } } } @@ -147904,24 +153961,14 @@ } ] }, - "/v1/gameCenterGroups/{id}/relationships/gameCenterActivities": { + "/v1/gameCenterLeaderboardLocalizations/{id}/relationships/gameCenterLeaderboardImage": { "get": { "tags": [ - "GameCenterGroups" - ], - "operationId": "gameCenterGroups_gameCenterActivities_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterLeaderboardLocalizations" ], + "operationId": "gameCenterLeaderboardLocalizations_gameCenterLeaderboardImage_getToOneRelationship", + "deprecated": true, + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -147964,11 +154011,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterActivitiesLinkagesResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardLocalizationGameCenterLeaderboardImageLinkageResponse" } } } @@ -147998,37 +154045,29 @@ } ] }, - "/v1/gameCenterGroups/{id}/gameCenterActivities": { + "/v1/gameCenterLeaderboardLocalizations/{id}/gameCenterLeaderboardImage": { "get": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardLocalizations" ], - "operationId": "gameCenterGroups_gameCenterActivities_getToManyRelated", + "operationId": "gameCenterLeaderboardLocalizations_gameCenterLeaderboardImage_getToOneRelated", + "deprecated": true, "parameters": [ { - "name": "fields[gameCenterActivities]", + "name": "fields[gameCenterLeaderboardImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivities", + "description": "the fields to include for returned resources of type gameCenterLeaderboardImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "playStyle", - "minimumPlayersCount", - "maximumPlayersCount", - "supportsPartyCode", - "archived", - "properties", - "gameCenterDetail", - "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", - "versions" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "gameCenterLeaderboardLocalization" ] } }, @@ -148036,38 +154075,22 @@ "explode": false }, { - "name": "fields[gameCenterDetails]", + "name": "fields[gameCenterLeaderboardLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterDetails", + "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", "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", - "blockedPlayers", - "challengesMinimumPlatformVersions" + "locale", + "name", + "formatterOverride", + "formatterSuffix", + "formatterSuffixSingular", + "description", + "gameCenterLeaderboard", + "gameCenterLeaderboardImage" ] } }, @@ -148075,24 +154098,203 @@ "explode": false }, { - "name": "fields[gameCenterGroups]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type gameCenterGroups", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "gameCenterDetails", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges" + "gameCenterLeaderboardLocalization" + ] + } + }, + "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 GameCenterLeaderboardImage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardImageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterLeaderboardLocalizations/{id}/relationships/image": { + "get": { + "tags": [ + "GameCenterLeaderboardLocalizations" + ], + "operationId": "gameCenterLeaderboardLocalizationsV2_image_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/GameCenterLeaderboardLocalizationV2ImageLinkageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterLeaderboardLocalizations/{id}/image": { + "get": { + "tags": [ + "GameCenterLeaderboardLocalizations" + ], + "operationId": "gameCenterLeaderboardLocalizationsV2_image_getToOneRelated", + "parameters": [ + { + "name": "fields[gameCenterLeaderboardImages]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "localization" ] } }, @@ -148100,66 +154302,228 @@ "explode": false }, { - "name": "fields[gameCenterAchievements]", + "name": "fields[gameCenterLeaderboardLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievements", + "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "points", - "showBeforeEarned", - "repeatable", - "archived", - "activityProperties", - "gameCenterDetail", - "gameCenterGroup", - "groupAchievement", - "localizations", - "releases", - "activity", - "versions" + "locale", + "name", + "formatterOverride", + "formatterSuffix", + "formatterSuffixSingular", + "description", + "version", + "image" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "localization" ] } }, "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 GameCenterLeaderboardImage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardImageV2Response" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterLeaderboardSetLocalizations/{id}/relationships/gameCenterLeaderboardSetImage": { + "get": { + "tags": [ + "GameCenterLeaderboardSetLocalizations" + ], + "operationId": "gameCenterLeaderboardSetLocalizations_gameCenterLeaderboardSetImage_getToOneRelationship", + "deprecated": true, + "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/GameCenterLeaderboardSetLocalizationGameCenterLeaderboardSetImageLinkageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterLeaderboardSetLocalizations/{id}/gameCenterLeaderboardSetImage": { + "get": { + "tags": [ + "GameCenterLeaderboardSetLocalizations" + ], + "operationId": "gameCenterLeaderboardSetLocalizations_gameCenterLeaderboardSetImage_getToOneRelated", + "deprecated": true, + "parameters": [ { - "name": "fields[gameCenterLeaderboards]", + "name": "fields[gameCenterLeaderboardSetImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetImages", "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", - "gameCenterScoreModerations", - "versions" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "gameCenterLeaderboardSetLocalization" ] } }, @@ -148167,37 +154531,24 @@ "explode": false }, { - "name": "fields[gameCenterActivityVersions]", + "name": "fields[gameCenterLeaderboardSetLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityVersions", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "fallbackUrl", - "activity", - "localizations", - "defaultImage", - "releases" + "locale", + "name", + "gameCenterLeaderboardSet", + "gameCenterLeaderboardSetImage" ] } }, "style": "form", "explode": false }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, { "name": "include", "in": "query", @@ -148207,70 +154558,12 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", - "versions" + "gameCenterLeaderboardSetLocalization" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[achievements]", - "in": "query", - "description": "maximum number of related achievements returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "deprecated": true - }, - { - "name": "limit[achievementsV2]", - "in": "query", - "description": "maximum number of related achievementsV2 returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[leaderboards]", - "in": "query", - "description": "maximum number of related leaderboards returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "deprecated": true - }, - { - "name": "limit[leaderboardsV2]", - "in": "query", - "description": "maximum number of related leaderboardsV2 returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[versions]", - "in": "query", - "description": "maximum number of related versions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -148315,11 +154608,11 @@ } }, "200": { - "description": "List of GameCenterActivities", + "description": "Single GameCenterLeaderboardSetImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterActivitiesResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetImageResponse" } } } @@ -148349,24 +154642,13 @@ } ] }, - "/v1/gameCenterGroups/{id}/relationships/gameCenterChallenges": { + "/v2/gameCenterLeaderboardSetLocalizations/{id}/relationships/image": { "get": { "tags": [ - "GameCenterGroups" - ], - "operationId": "gameCenterGroups_gameCenterChallenges_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterLeaderboardSetLocalizations" ], + "operationId": "gameCenterLeaderboardSetLocalizationsV2_image_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -148409,11 +154691,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterChallengesLinkagesResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetLocalizationV2ImageLinkageResponse" } } } @@ -148443,135 +154725,28 @@ } ] }, - "/v1/gameCenterGroups/{id}/gameCenterChallenges": { + "/v2/gameCenterLeaderboardSetLocalizations/{id}/image": { "get": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSetLocalizations" ], - "operationId": "gameCenterGroups_gameCenterChallenges_getToManyRelated", + "operationId": "gameCenterLeaderboardSetLocalizationsV2_image_getToOneRelated", "parameters": [ { - "name": "filter[referenceName]", - "in": "query", - "description": "filter by attribute 'referenceName'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[archived]", - "in": "query", - "description": "filter by attribute 'archived'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[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[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", - "blockedPlayers", - "challengesMinimumPlatformVersions" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterGroups]", + "name": "fields[gameCenterLeaderboardSetImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterGroups", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "gameCenterDetails", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "localization" ] } }, @@ -148579,74 +154754,24 @@ "explode": false }, { - "name": "fields[gameCenterChallengeVersions]", + "name": "fields[gameCenterLeaderboardSetLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeVersions", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "locale", + "name", "version", - "state", - "challenge", - "localizations", - "releases", - "defaultImage" - ] - } - }, - "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", - "gameCenterScoreModerations", - "versions" + "image" ] } }, "style": "form", "explode": false }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, { "name": "include", "in": "query", @@ -148656,26 +154781,12 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterGroup", - "versions", - "leaderboard", - "leaderboardV2" + "localization" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[versions]", - "in": "query", - "description": "maximum number of related versions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -148720,11 +154831,11 @@ } }, "200": { - "description": "List of GameCenterChallenges", + "description": "Single GameCenterLeaderboardSetImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterChallengesResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetImageV2Response" } } } @@ -148754,24 +154865,14 @@ } ] }, - "/v1/gameCenterGroups/{id}/relationships/gameCenterDetails": { + "/v1/gameCenterLeaderboardSetMemberLocalizations/{id}/relationships/gameCenterLeaderboard": { "get": { "tags": [ - "GameCenterGroups" - ], - "operationId": "gameCenterGroups_gameCenterDetails_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterLeaderboardSetMemberLocalizations" ], + "operationId": "gameCenterLeaderboardSetMemberLocalizations_gameCenterLeaderboard_getToOneRelationship", + "deprecated": true, + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -148814,11 +154915,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterDetailsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetMemberLocalizationGameCenterLeaderboardLinkageResponse" } } } @@ -148848,21 +154949,45 @@ } ] }, - "/v1/gameCenterGroups/{id}/gameCenterDetails": { + "/v1/gameCenterLeaderboardSetMemberLocalizations/{id}/gameCenterLeaderboard": { "get": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSetMemberLocalizations" ], - "operationId": "gameCenterGroups_gameCenterDetails_getToManyRelated", + "operationId": "gameCenterLeaderboardSetMemberLocalizations_gameCenterLeaderboard_getToOneRelated", + "deprecated": true, "parameters": [ { - "name": "filter[gameCenterAppVersions.enabled]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "filter by attribute 'gameCenterAppVersions.enabled'", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "defaultFormatter", + "referenceName", + "vendorIdentifier", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", + "archived", + "activityProperties", + "visibility", + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboard", + "gameCenterLeaderboardSets", + "localizations", + "releases", + "activity", + "challenge" + ] } }, "style": "form", @@ -148907,96 +155032,6 @@ "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "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", @@ -149023,37 +155058,22 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboards]", + "name": "fields[gameCenterLeaderboardSets]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "defaultFormatter", "referenceName", "vendorIdentifier", - "submissionType", - "scoreSortType", - "scoreRangeStart", - "scoreRangeEnd", - "recurrenceStartDate", - "recurrenceDuration", - "recurrenceRule", - "archived", - "activityProperties", - "visibility", "gameCenterDetail", "gameCenterGroup", - "groupLeaderboard", - "gameCenterLeaderboardSets", + "groupLeaderboardSet", "localizations", - "releases", - "activity", - "challenge", - "gameCenterScoreModerations", - "versions" + "gameCenterLeaderboards", + "releases" ] } }, @@ -149061,23 +155081,22 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSets]", + "name": "fields[gameCenterLeaderboardLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboardSet", - "localizations", - "gameCenterLeaderboards", - "releases", - "versions" + "locale", + "name", + "formatterOverride", + "formatterSuffix", + "formatterSuffixSingular", + "description", + "gameCenterLeaderboard", + "gameCenterLeaderboardImage" ] } }, @@ -149085,28 +155104,17 @@ "explode": false }, { - "name": "fields[gameCenterAchievements]", + "name": "fields[gameCenterLeaderboardReleases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievements", + "description": "the fields to include for returned resources of type gameCenterLeaderboardReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "points", - "showBeforeEarned", - "repeatable", - "archived", - "activityProperties", + "live", "gameCenterDetail", - "gameCenterGroup", - "groupAchievement", - "localizations", - "releases", - "activity", - "versions" + "gameCenterLeaderboard" ] } }, @@ -149168,141 +155176,6 @@ "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": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, { "name": "include", "in": "query", @@ -149312,64 +155185,20 @@ "items": { "type": "string", "enum": [ - "app", - "gameCenterAppVersions", + "gameCenterDetail", "gameCenterGroup", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", + "groupLeaderboard", "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges", - "defaultLeaderboard", - "defaultLeaderboardV2", - "defaultGroupLeaderboard", - "defaultGroupLeaderboardV2", - "achievementReleases", - "activityReleases", - "challengeReleases", - "leaderboardReleases", - "leaderboardSetReleases", - "challengesMinimumPlatformVersions" + "localizations", + "releases", + "activity", + "challenge" ] } }, "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", @@ -149382,93 +155211,9 @@ "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]", + "name": "limit[localizations]", "in": "query", - "description": "maximum number of related leaderboardReleases returned (when they are included)", + "description": "maximum number of related localizations returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -149477,25 +155222,15 @@ "deprecated": true }, { - "name": "limit[leaderboardSetReleases]", + "name": "limit[releases]", "in": "query", - "description": "maximum number of related leaderboardSetReleases returned (when they are included)", + "description": "maximum number of related releases 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": { @@ -149540,11 +155275,11 @@ } }, "200": { - "description": "List of GameCenterDetails", + "description": "Single GameCenterLeaderboard", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterDetailsResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardResponse" } } } @@ -149574,25 +155309,14 @@ } ] }, - "/v1/gameCenterGroups/{id}/relationships/gameCenterLeaderboardSets": { + "/v1/gameCenterLeaderboardSetMemberLocalizations/{id}/relationships/gameCenterLeaderboardSet": { "get": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSetMemberLocalizations" ], - "operationId": "gameCenterGroups_gameCenterLeaderboardSets_getToManyRelationship", + "operationId": "gameCenterLeaderboardSetMemberLocalizations_gameCenterLeaderboardSet_getToOneRelationship", "deprecated": true, - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -149635,108 +155359,15 @@ } }, "200": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardSetsLinkagesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "patch": { - "tags": [ - "GameCenterGroups" - ], - "operationId": "gameCenterGroups_gameCenterLeaderboardSets_replaceToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardSetsLinkagesRequest" - } - } - }, - "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)", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetMemberLocalizationGameCenterLeaderboardSetLinkageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -149762,40 +155393,14 @@ } ] }, - "/v1/gameCenterGroups/{id}/gameCenterLeaderboardSets": { + "/v1/gameCenterLeaderboardSetMemberLocalizations/{id}/gameCenterLeaderboardSet": { "get": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSetMemberLocalizations" ], - "operationId": "gameCenterGroups_gameCenterLeaderboardSets_getToManyRelated", + "operationId": "gameCenterLeaderboardSetMemberLocalizations_gameCenterLeaderboardSet_getToOneRelated", "deprecated": true, "parameters": [ - { - "name": "filter[referenceName]", - "in": "query", - "description": "filter by attribute 'referenceName'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, { "name": "fields[gameCenterLeaderboardSets]", "in": "query", @@ -149956,16 +155561,6 @@ "style": "form", "explode": false }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, { "name": "include", "in": "query", @@ -150063,11 +155658,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardSets", + "description": "Single GameCenterLeaderboardSet", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetsResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetResponse" } } } @@ -150097,12 +155692,12 @@ } ] }, - "/v1/gameCenterGroups/{id}/relationships/gameCenterLeaderboardSetsV2": { + "/v2/gameCenterLeaderboardSetVersions/{id}/relationships/localizations": { "get": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSetVersions" ], - "operationId": "gameCenterGroups_gameCenterLeaderboardSetsV2_getToManyRelationship", + "operationId": "gameCenterLeaderboardSetVersionsV2_localizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -150161,103 +155756,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardSetsV2LinkagesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "patch": { - "tags": [ - "GameCenterGroups" - ], - "operationId": "gameCenterGroups_gameCenterLeaderboardSetsV2_replaceToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardSetsV2LinkagesRequest" - } - } - }, - "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" + "$ref": "#/components/schemas/GameCenterLeaderboardSetVersionV2LocalizationsLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -150283,118 +155786,26 @@ } ] }, - "/v1/gameCenterGroups/{id}/gameCenterLeaderboardSetsV2": { + "/v2/gameCenterLeaderboardSetVersions/{id}/localizations": { "get": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSetVersions" ], - "operationId": "gameCenterGroups_gameCenterLeaderboardSetsV2_getToManyRelated", + "operationId": "gameCenterLeaderboardSetVersionsV2_localizations_getToManyRelated", "parameters": [ { - "name": "filter[referenceName]", - "in": "query", - "description": "filter by attribute 'referenceName'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[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", - "gameCenterLeaderboards", - "versions" - ] - } - }, - "style": "form", - "explode": 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", - "blockedPlayers", - "challengesMinimumPlatformVersions" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterGroups]", + "name": "fields[gameCenterLeaderboardSetLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterGroups", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "gameCenterDetails", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges" + "locale", + "name", + "version", + "image" ] } }, @@ -150402,34 +155813,18 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboards]", + "name": "fields[gameCenterLeaderboardSetVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "defaultFormatter", - "referenceName", - "vendorIdentifier", - "submissionType", - "scoreSortType", - "scoreRangeStart", - "scoreRangeEnd", - "recurrenceStartDate", - "recurrenceDuration", - "recurrenceRule", - "archived", - "activityProperties", - "visibility", - "gameCenterDetail", - "gameCenterGroup", - "gameCenterLeaderboardSets", - "gameCenterScoreModerations", - "activity", - "challenge", - "versions" + "version", + "state", + "leaderboardSet", + "localizations" ] } }, @@ -150437,18 +155832,20 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetVersions]", + "name": "fields[gameCenterLeaderboardSetImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetVersions", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "leaderboardSet", - "localizations" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "localization" ] } }, @@ -150474,35 +155871,13 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterGroup", - "gameCenterLeaderboards", - "versions" + "version", + "image" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[gameCenterLeaderboards]", - "in": "query", - "description": "maximum number of related gameCenterLeaderboards returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[versions]", - "in": "query", - "description": "maximum number of related versions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -150547,11 +155922,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardSets", + "description": "List of GameCenterLeaderboardSetLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetsV2Response" + "$ref": "#/components/schemas/GameCenterLeaderboardSetLocalizationsV2Response" } } } @@ -150581,13 +155956,12 @@ } ] }, - "/v1/gameCenterGroups/{id}/relationships/gameCenterLeaderboards": { + "/v2/gameCenterLeaderboardSets/{id}/relationships/gameCenterLeaderboards": { "get": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterGroups_gameCenterLeaderboards_getToManyRelationship", - "deprecated": true, + "operationId": "gameCenterLeaderboardSetsV2_gameCenterLeaderboards_getToManyRelationship", "parameters": [ { "name": "limit", @@ -150646,11 +156020,103 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetV2GameCenterLeaderboardsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "GameCenterLeaderboardSets" + ], + "operationId": "gameCenterLeaderboardSetsV2_gameCenterLeaderboards_createToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardSetV2GameCenterLeaderboardsLinkagesRequest" + } + } + }, + "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": { @@ -150665,16 +156131,107 @@ }, "patch": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterGroups_gameCenterLeaderboards_replaceToManyRelationship", - "deprecated": true, + "operationId": "gameCenterLeaderboardSetsV2_gameCenterLeaderboards_replaceToManyRelationship", "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardsLinkagesRequest" + "$ref": "#/components/schemas/GameCenterLeaderboardSetV2GameCenterLeaderboardsLinkagesRequest" + } + } + }, + "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" + } + } + } + } + } + }, + "delete": { + "tags": [ + "GameCenterLeaderboardSets" + ], + "operationId": "gameCenterLeaderboardSetsV2_gameCenterLeaderboards_deleteToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardSetV2GameCenterLeaderboardsLinkagesRequest" } } }, @@ -150769,13 +156326,12 @@ } ] }, - "/v1/gameCenterGroups/{id}/gameCenterLeaderboards": { + "/v2/gameCenterLeaderboardSets/{id}/gameCenterLeaderboards": { "get": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterGroups_gameCenterLeaderboards_getToManyRelated", - "deprecated": true, + "operationId": "gameCenterLeaderboardSetsV2_gameCenterLeaderboards_getToManyRelated", "parameters": [ { "name": "filter[referenceName]", @@ -150840,12 +156396,11 @@ "visibility", "gameCenterDetail", "gameCenterGroup", - "groupLeaderboard", "gameCenterLeaderboardSets", - "localizations", - "releases", + "gameCenterScoreModerations", "activity", - "challenge" + "challenge", + "versions" ] } }, @@ -150929,51 +156484,8 @@ "vendorIdentifier", "gameCenterDetail", "gameCenterGroup", - "groupLeaderboardSet", - "localizations", "gameCenterLeaderboards", - "releases" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboardLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "formatterOverride", - "formatterSuffix", - "formatterSuffixSingular", - "description", - "gameCenterLeaderboard", - "gameCenterLeaderboardImage" - ] - } - }, - "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" + "versions" ] } }, @@ -151035,6 +156547,25 @@ "style": "form", "explode": false }, + { + "name": "fields[gameCenterLeaderboardVersions]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "leaderboard", + "localizations" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "limit", "in": "query", @@ -151056,12 +156587,10 @@ "enum": [ "gameCenterDetail", "gameCenterGroup", - "groupLeaderboard", "gameCenterLeaderboardSets", - "localizations", - "releases", "activity", - "challenge" + "challenge", + "versions" ] } }, @@ -151076,8 +156605,281 @@ "type": "integer", "maximum": 50 }, + "style": "form" + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions 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 GameCenterLeaderboards", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardsV2Response" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterLeaderboardSets/{id}/relationships/versions": { + "get": { + "tags": [ + "GameCenterLeaderboardSets" + ], + "operationId": "gameCenterLeaderboardSetsV2_versions_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/GameCenterLeaderboardSetV2VersionsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterLeaderboardSets/{id}/versions": { + "get": { + "tags": [ + "GameCenterLeaderboardSets" + ], + "operationId": "gameCenterLeaderboardSetsV2_versions_getToManyRelated", + "parameters": [ + { + "name": "fields[gameCenterLeaderboardSetVersions]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "leaderboardSet", + "localizations" + ] + } + }, "style": "form", - "deprecated": true + "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", + "gameCenterLeaderboards", + "versions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterLeaderboardSetLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "version", + "image" + ] + } + }, + "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": [ + "leaderboardSet", + "localizations" + ] + } + }, + "style": "form", + "explode": false }, { "name": "limit[localizations]", @@ -151087,21 +156889,184 @@ "type": "integer", "maximum": 50 }, - "style": "form", - "deprecated": true + "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 GameCenterLeaderboardSetVersions", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardSetVersionsV2Response" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterLeaderboardSets/{id}/relationships/gameCenterLeaderboards": { + "get": { + "tags": [ + "GameCenterLeaderboardSets" + ], + "operationId": "gameCenterLeaderboardSets_gameCenterLeaderboards_getToManyRelationship", + "deprecated": true, + "parameters": [ { - "name": "limit[releases]", + "name": "limit", "in": "query", - "description": "maximum number of related releases returned (when they are included)", + "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 50 + "maximum": 200 }, - "style": "form", - "deprecated": true + "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/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } + } + }, + "post": { + "tags": [ + "GameCenterLeaderboardSets" ], + "operationId": "gameCenterLeaderboardSets_gameCenterLeaderboards_createToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -151143,16 +157108,29 @@ } } }, - "200": { - "description": "List of GameCenterLeaderboards", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardsResponse" + "$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": { @@ -151165,37 +157143,23 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterGroups/{id}/relationships/gameCenterLeaderboardsV2": { - "get": { + "patch": { "tags": [ - "GameCenterGroups" - ], - "operationId": "gameCenterGroups_gameCenterLeaderboardsV2_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterLeaderboardSets" ], + "operationId": "gameCenterLeaderboardSets_gameCenterLeaderboards_replaceToManyRelationship", + "deprecated": true, + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -151237,16 +157201,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardsV2LinkagesResponse" + "$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": { @@ -151259,17 +157236,18 @@ } } }, - "patch": { + "delete": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterGroups_gameCenterLeaderboardsV2_replaceToManyRelationship", + "operationId": "gameCenterLeaderboardSets_gameCenterLeaderboards_deleteToManyRelationship", + "deprecated": true, "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterGroupGameCenterLeaderboardsV2LinkagesRequest" + "$ref": "#/components/schemas/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest" } } }, @@ -151364,12 +157342,13 @@ } ] }, - "/v1/gameCenterGroups/{id}/gameCenterLeaderboardsV2": { + "/v1/gameCenterLeaderboardSets/{id}/gameCenterLeaderboards": { "get": { "tags": [ - "GameCenterGroups" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterGroups_gameCenterLeaderboardsV2_getToManyRelated", + "operationId": "gameCenterLeaderboardSets_gameCenterLeaderboards_getToManyRelated", + "deprecated": true, "parameters": [ { "name": "filter[referenceName]", @@ -151434,11 +157413,12 @@ "visibility", "gameCenterDetail", "gameCenterGroup", + "groupLeaderboard", "gameCenterLeaderboardSets", - "gameCenterScoreModerations", + "localizations", + "releases", "activity", - "challenge", - "versions" + "challenge" ] } }, @@ -151522,8 +157502,51 @@ "vendorIdentifier", "gameCenterDetail", "gameCenterGroup", + "groupLeaderboardSet", + "localizations", "gameCenterLeaderboards", - "versions" + "releases" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterLeaderboardLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "formatterOverride", + "formatterSuffix", + "formatterSuffixSingular", + "description", + "gameCenterLeaderboard", + "gameCenterLeaderboardImage" + ] + } + }, + "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" ] } }, @@ -151585,25 +157608,6 @@ "style": "form", "explode": false }, - { - "name": "fields[gameCenterLeaderboardVersions]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "leaderboard", - "localizations" - ] - } - }, - "style": "form", - "explode": false - }, { "name": "limit", "in": "query", @@ -151625,10 +157629,12 @@ "enum": [ "gameCenterDetail", "gameCenterGroup", + "groupLeaderboard", "gameCenterLeaderboardSets", + "localizations", + "releases", "activity", - "challenge", - "versions" + "challenge" ] } }, @@ -151643,17 +157649,30 @@ "type": "integer", "maximum": 50 }, - "style": "form" + "style": "form", + "deprecated": true }, { - "name": "limit[versions]", + "name": "limit[localizations]", "in": "query", - "description": "maximum number of related versions returned (when they are included)", + "description": "maximum number of related localizations returned (when they are included)", "schema": { "type": "integer", "maximum": 50 }, - "style": "form" + "style": "form", + "deprecated": true + }, + { + "name": "limit[releases]", + "in": "query", + "description": "maximum number of related releases returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "deprecated": true } ], "responses": { @@ -151702,7 +157721,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardsV2Response" + "$ref": "#/components/schemas/GameCenterLeaderboardsResponse" } } } @@ -151732,12 +157751,12 @@ } ] }, - "/v1/gameCenterLeaderboardLocalizations/{id}/relationships/gameCenterLeaderboardImage": { + "/v1/gameCenterLeaderboardSets/{id}/relationships/groupLeaderboardSet": { "get": { "tags": [ - "GameCenterLeaderboardLocalizations" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterLeaderboardLocalizations_gameCenterLeaderboardImage_getToOneRelationship", + "operationId": "gameCenterLeaderboardSets_groupLeaderboardSet_getToOneRelationship", "deprecated": true, "parameters": [], "responses": { @@ -151786,7 +157805,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardLocalizationGameCenterLeaderboardImageLinkageResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetGroupLeaderboardSetLinkageResponse" } } } @@ -151803,88 +157822,23 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterLeaderboardLocalizations/{id}/gameCenterLeaderboardImage": { - "get": { + "patch": { "tags": [ - "GameCenterLeaderboardLocalizations" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterLeaderboardLocalizations_gameCenterLeaderboardImage_getToOneRelated", + "operationId": "gameCenterLeaderboardSets_groupLeaderboardSet_updateToOneRelationship", "deprecated": true, - "parameters": [ - { - "name": "fields[gameCenterLeaderboardImages]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState", - "gameCenterLeaderboardLocalization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboardLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "formatterOverride", - "formatterSuffix", - "formatterSuffixSingular", - "description", - "gameCenterLeaderboard", - "gameCenterLeaderboardImage" - ] + "requestBody": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardSetGroupLeaderboardSetLinkageRequest" } - }, - "style": "form", - "explode": false + } }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "gameCenterLeaderboardLocalization" - ] - } - }, - "style": "form", - "explode": false - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -151926,71 +157880,8 @@ } } }, - "200": { - "description": "Single GameCenterLeaderboardImage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardImageResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v2/gameCenterLeaderboardLocalizations/{id}/relationships/image": { - "get": { - "tags": [ - "GameCenterLeaderboardLocalizations" - ], - "operationId": "gameCenterLeaderboardLocalizationsV2_image_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", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { @@ -151999,8 +157890,8 @@ } } }, - "404": { - "description": "Not found error", + "409": { + "description": "Request entity error(s)", "content": { "application/json": { "schema": { @@ -152009,15 +157900,8 @@ } } }, - "200": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardLocalizationV2ImageLinkageResponse" - } - } - } + "204": { + "description": "Success (no content)" }, "429": { "description": "Rate limit exceeded error", @@ -152044,51 +157928,31 @@ } ] }, - "/v2/gameCenterLeaderboardLocalizations/{id}/image": { + "/v1/gameCenterLeaderboardSets/{id}/groupLeaderboardSet": { "get": { "tags": [ - "GameCenterLeaderboardLocalizations" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterLeaderboardLocalizationsV2_image_getToOneRelated", + "operationId": "gameCenterLeaderboardSets_groupLeaderboardSet_getToOneRelated", + "deprecated": true, "parameters": [ { - "name": "fields[gameCenterLeaderboardImages]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState", - "localization" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboardLocalizations]", + "name": "fields[gameCenterLeaderboardSets]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "name", - "formatterOverride", - "formatterSuffix", - "formatterSuffixSingular", - "description", - "version", - "image" + "referenceName", + "vendorIdentifier", + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboardSet", + "localizations", + "gameCenterLeaderboards", + "releases" ] } }, @@ -152096,205 +157960,63 @@ "explode": false }, { - "name": "include", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type gameCenterDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "localization" + "arcadeEnabled", + "challengeEnabled", + "app", + "gameCenterAppVersions", + "gameCenterGroup", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges", + "defaultLeaderboard", + "defaultLeaderboardV2", + "defaultGroupLeaderboard", + "defaultGroupLeaderboardV2", + "achievementReleases", + "activityReleases", + "challengeReleases", + "leaderboardReleases", + "leaderboardSetReleases", + "blockedPlayers", + "challengesMinimumPlatformVersions" ] } }, "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 GameCenterLeaderboardImage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardImageV2Response" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterLeaderboardSetLocalizations/{id}/relationships/gameCenterLeaderboardSetImage": { - "get": { - "tags": [ - "GameCenterLeaderboardSetLocalizations" - ], - "operationId": "gameCenterLeaderboardSetLocalizations_gameCenterLeaderboardSetImage_getToOneRelationship", - "deprecated": true, - "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/GameCenterLeaderboardSetLocalizationGameCenterLeaderboardSetImageLinkageResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterLeaderboardSetLocalizations/{id}/gameCenterLeaderboardSetImage": { - "get": { - "tags": [ - "GameCenterLeaderboardSetLocalizations" - ], - "operationId": "gameCenterLeaderboardSetLocalizations_gameCenterLeaderboardSetImage_getToOneRelated", - "deprecated": true, - "parameters": [ { - "name": "fields[gameCenterLeaderboardSetImages]", + "name": "fields[gameCenterGroups]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetImages", + "description": "the fields to include for returned resources of type gameCenterGroups", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState", - "gameCenterLeaderboardSetLocalization" + "referenceName", + "gameCenterDetails", + "gameCenterLeaderboards", + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges" ] } }, @@ -152321,203 +158043,53 @@ "explode": false }, { - "name": "include", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "gameCenterLeaderboardSetLocalization" + "defaultFormatter", + "referenceName", + "vendorIdentifier", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", + "archived", + "activityProperties", + "visibility", + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboard", + "gameCenterLeaderboardSets", + "localizations", + "releases", + "activity", + "challenge" ] } }, "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 GameCenterLeaderboardSetImage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetImageResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v2/gameCenterLeaderboardSetLocalizations/{id}/relationships/image": { - "get": { - "tags": [ - "GameCenterLeaderboardSetLocalizations" - ], - "operationId": "gameCenterLeaderboardSetLocalizationsV2_image_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/GameCenterLeaderboardSetLocalizationV2ImageLinkageResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" }, - "style": "simple", - "required": true - } - ] - }, - "/v2/gameCenterLeaderboardSetLocalizations/{id}/image": { - "get": { - "tags": [ - "GameCenterLeaderboardSetLocalizations" - ], - "operationId": "gameCenterLeaderboardSetLocalizationsV2_image_getToOneRelated", - "parameters": [ { - "name": "fields[gameCenterLeaderboardSetImages]", + "name": "fields[gameCenterLeaderboardSetReleases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetImages", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetReleases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState", - "localization" + "live", + "gameCenterDetail", + "gameCenterLeaderboardSet" ] } }, @@ -152525,18 +158097,20 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetLocalizations]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "name", - "version", - "image" + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboardSet", + "localizations", + "gameCenterLeaderboards", + "releases" ] } }, @@ -152544,20 +158118,37 @@ "explode": false }, { - "name": "include", + "name": "limit[localizations]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "maximum number of related localizations returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "localization" - ] - } + "type": "integer", + "maximum": 50 }, "style": "form", - "explode": false + "deprecated": true + }, + { + "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[releases]", + "in": "query", + "description": "maximum number of related releases returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "deprecated": true } ], "responses": { @@ -152602,11 +158193,11 @@ } }, "200": { - "description": "Single GameCenterLeaderboardSetImage", + "description": "Single GameCenterLeaderboardSet", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetImageV2Response" + "$ref": "#/components/schemas/GameCenterLeaderboardSetResponse" } } } @@ -152636,14 +158227,25 @@ } ] }, - "/v1/gameCenterLeaderboardSetMemberLocalizations/{id}/relationships/gameCenterLeaderboard": { + "/v1/gameCenterLeaderboardSets/{id}/relationships/localizations": { "get": { "tags": [ - "GameCenterLeaderboardSetMemberLocalizations" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterLeaderboardSetMemberLocalizations_gameCenterLeaderboard_getToOneRelationship", + "operationId": "gameCenterLeaderboardSets_localizations_getToManyRelationship", "deprecated": true, - "parameters": [], + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -152686,11 +158288,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetMemberLocalizationGameCenterLeaderboardLinkageResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetLocalizationsLinkagesResponse" } } } @@ -152713,115 +158315,34 @@ "in": "path", "description": "the id of the requested resource", "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/gameCenterLeaderboardSetMemberLocalizations/{id}/gameCenterLeaderboard": { - "get": { - "tags": [ - "GameCenterLeaderboardSetMemberLocalizations" - ], - "operationId": "gameCenterLeaderboardSetMemberLocalizations_gameCenterLeaderboard_getToOneRelated", - "deprecated": true, - "parameters": [ - { - "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" - ] - } - }, - "style": "form", - "explode": 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", - "blockedPlayers", - "challengesMinimumPlatformVersions" - ] - } - }, - "style": "form", - "explode": false + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterLeaderboardSets/{id}/localizations": { + "get": { + "tags": [ + "GameCenterLeaderboardSets" + ], + "operationId": "gameCenterLeaderboardSets_localizations_getToManyRelated", + "deprecated": true, + "parameters": [ { - "name": "fields[gameCenterGroups]", + "name": "fields[gameCenterLeaderboardSetLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterGroups", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "gameCenterDetails", - "gameCenterLeaderboards", - "gameCenterLeaderboardsV2", - "gameCenterLeaderboardSets", - "gameCenterLeaderboardSetsV2", - "gameCenterAchievements", - "gameCenterAchievementsV2", - "gameCenterActivities", - "gameCenterChallenges" + "locale", + "name", + "gameCenterLeaderboardSet", + "gameCenterLeaderboardSetImage" ] } }, @@ -152852,70 +158373,20 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "formatterOverride", - "formatterSuffix", - "formatterSuffixSingular", - "description", - "gameCenterLeaderboard", - "gameCenterLeaderboardImage" - ] - } - }, - "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[gameCenterActivities]", + "name": "fields[gameCenterLeaderboardSetImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivities", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "playStyle", - "minimumPlayersCount", - "maximumPlayersCount", - "supportsPartyCode", - "archived", - "properties", - "gameCenterDetail", - "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", - "versions" + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "gameCenterLeaderboardSetLocalization" ] } }, @@ -152923,29 +158394,14 @@ "explode": false }, { - "name": "fields[gameCenterChallenges]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallenges", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "referenceName", - "vendorIdentifier", - "archived", - "challengeType", - "repeatable", - "gameCenterDetail", - "gameCenterGroup", - "versions", - "leaderboard", - "leaderboardV2" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { "name": "include", @@ -152956,52 +158412,13 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboard", - "gameCenterLeaderboardSets", - "localizations", - "releases", - "activity", - "challenge" + "gameCenterLeaderboardSet", + "gameCenterLeaderboardSetImage" ] } }, "style": "form", "explode": false - }, - { - "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[localizations]", - "in": "query", - "description": "maximum number of related localizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "deprecated": true - }, - { - "name": "limit[releases]", - "in": "query", - "description": "maximum number of related releases returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "deprecated": true } ], "responses": { @@ -153046,11 +158463,11 @@ } }, "200": { - "description": "Single GameCenterLeaderboard", + "description": "List of GameCenterLeaderboardSetLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetLocalizationsResponse" } } } @@ -153080,14 +158497,25 @@ } ] }, - "/v1/gameCenterLeaderboardSetMemberLocalizations/{id}/relationships/gameCenterLeaderboardSet": { + "/v1/gameCenterLeaderboardSets/{id}/relationships/releases": { "get": { "tags": [ - "GameCenterLeaderboardSetMemberLocalizations" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterLeaderboardSetMemberLocalizations_gameCenterLeaderboardSet_getToOneRelationship", + "operationId": "gameCenterLeaderboardSets_releases_getToManyRelationship", "deprecated": true, - "parameters": [], + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -153130,11 +158558,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetMemberLocalizationGameCenterLeaderboardSetLinkageResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetReleasesLinkagesResponse" } } } @@ -153164,31 +158592,52 @@ } ] }, - "/v1/gameCenterLeaderboardSetMemberLocalizations/{id}/gameCenterLeaderboardSet": { + "/v1/gameCenterLeaderboardSets/{id}/releases": { "get": { "tags": [ - "GameCenterLeaderboardSetMemberLocalizations" + "GameCenterLeaderboardSets" ], - "operationId": "gameCenterLeaderboardSetMemberLocalizations_gameCenterLeaderboardSet_getToOneRelated", + "operationId": "gameCenterLeaderboardSets_releases_getToManyRelated", "deprecated": true, "parameters": [ { - "name": "fields[gameCenterLeaderboardSets]", + "name": "filter[live]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "filter by attribute 'live'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[gameCenterDetail]", + "in": "query", + "description": "filter by id(s) of related 'gameCenterDetail'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "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": [ - "referenceName", - "vendorIdentifier", + "live", "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboardSet", - "localizations", - "gameCenterLeaderboards", - "releases" + "gameCenterLeaderboardSet" ] } }, @@ -153235,79 +158684,22 @@ "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[gameCenterLeaderboardSetLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "gameCenterLeaderboardSet", - "gameCenterLeaderboardSetImage" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboards]", + "name": "fields[gameCenterLeaderboardSets]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "defaultFormatter", "referenceName", "vendorIdentifier", - "submissionType", - "scoreSortType", - "scoreRangeStart", - "scoreRangeEnd", - "recurrenceStartDate", - "recurrenceDuration", - "recurrenceRule", - "archived", - "activityProperties", - "visibility", "gameCenterDetail", "gameCenterGroup", - "groupLeaderboard", - "gameCenterLeaderboardSets", + "groupLeaderboardSet", "localizations", - "releases", - "activity", - "challenge" + "gameCenterLeaderboards", + "releases" ] } }, @@ -153315,22 +158707,14 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetReleases]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetReleases", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "live", - "gameCenterDetail", - "gameCenterLeaderboardSet" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { "name": "include", @@ -153342,49 +158726,12 @@ "type": "string", "enum": [ "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboardSet", - "localizations", - "gameCenterLeaderboards", - "releases" + "gameCenterLeaderboardSet" ] } }, "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", - "deprecated": true - }, - { - "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[releases]", - "in": "query", - "description": "maximum number of related releases returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "deprecated": true } ], "responses": { @@ -153429,11 +158776,11 @@ } }, "200": { - "description": "Single GameCenterLeaderboardSet", + "description": "List of GameCenterLeaderboardSetReleases", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardSetReleasesResponse" } } } @@ -153463,12 +158810,12 @@ } ] }, - "/v2/gameCenterLeaderboardSetVersions/{id}/relationships/localizations": { + "/v2/gameCenterLeaderboardVersions/{id}/relationships/localizations": { "get": { "tags": [ - "GameCenterLeaderboardSetVersions" + "GameCenterLeaderboardVersions" ], - "operationId": "gameCenterLeaderboardSetVersionsV2_localizations_getToManyRelationship", + "operationId": "gameCenterLeaderboardVersionsV2_localizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -153527,7 +158874,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetVersionV2LocalizationsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardVersionV2LocalizationsLinkagesResponse" } } } @@ -153557,17 +158904,17 @@ } ] }, - "/v2/gameCenterLeaderboardSetVersions/{id}/localizations": { + "/v2/gameCenterLeaderboardVersions/{id}/localizations": { "get": { "tags": [ - "GameCenterLeaderboardSetVersions" + "GameCenterLeaderboardVersions" ], - "operationId": "gameCenterLeaderboardSetVersionsV2_localizations_getToManyRelated", + "operationId": "gameCenterLeaderboardVersionsV2_localizations_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterLeaderboardSetLocalizations]", + "name": "fields[gameCenterLeaderboardLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", + "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", "schema": { "type": "array", "items": { @@ -153575,6 +158922,10 @@ "enum": [ "locale", "name", + "formatterOverride", + "formatterSuffix", + "formatterSuffixSingular", + "description", "version", "image" ] @@ -153584,9 +158935,9 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetVersions]", + "name": "fields[gameCenterLeaderboardVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetVersions", + "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", "schema": { "type": "array", "items": { @@ -153594,7 +158945,7 @@ "enum": [ "version", "state", - "leaderboardSet", + "leaderboard", "localizations" ] } @@ -153603,9 +158954,9 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetImages]", + "name": "fields[gameCenterLeaderboardImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetImages", + "description": "the fields to include for returned resources of type gameCenterLeaderboardImages", "schema": { "type": "array", "items": { @@ -153693,11 +159044,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardSetLocalizations", + "description": "List of GameCenterLeaderboardLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetLocalizationsV2Response" + "$ref": "#/components/schemas/GameCenterLeaderboardLocalizationsV2Response" } } } @@ -153727,24 +159078,24 @@ } ] }, - "/v2/gameCenterLeaderboardSets/{id}/relationships/gameCenterLeaderboards": { - "get": { + "/v1/gameCenterLeaderboards/{id}/relationships/activity": { + "patch": { "tags": [ - "GameCenterLeaderboardSets" - ], - "operationId": "gameCenterLeaderboardSetsV2_gameCenterLeaderboards_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterLeaderboards" ], + "operationId": "gameCenterLeaderboards_activity_updateToOneRelationship", + "deprecated": true, + "requestBody": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardActivityLinkageRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -153786,16 +159137,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetV2GameCenterLeaderboardsLinkagesResponse" + "$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": { @@ -153808,17 +159172,32 @@ } } }, - "post": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterLeaderboards/{id}/relationships/challenge": { + "patch": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterLeaderboards" ], - "operationId": "gameCenterLeaderboardSetsV2_gameCenterLeaderboards_createToManyRelationship", + "operationId": "gameCenterLeaderboards_challenge_updateToOneRelationship", + "deprecated": true, "requestBody": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetV2GameCenterLeaderboardsLinkagesRequest" + "$ref": "#/components/schemas/GameCenterLeaderboardChallengeLinkageRequest" } } }, @@ -153900,22 +159279,27 @@ } } }, - "patch": { - "tags": [ - "GameCenterLeaderboardSets" - ], - "operationId": "gameCenterLeaderboardSetsV2_gameCenterLeaderboards_replaceToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetV2GameCenterLeaderboardsLinkagesRequest" - } - } + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", "required": true - }, + } + ] + }, + "/v1/gameCenterLeaderboards/{id}/relationships/groupLeaderboard": { + "get": { + "tags": [ + "GameCenterLeaderboards" + ], + "operationId": "gameCenterLeaderboards_groupLeaderboard_getToOneRelationship", + "deprecated": true, + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -153957,29 +159341,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardGroupLeaderboardLinkageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -153992,17 +159363,18 @@ } } }, - "delete": { + "patch": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterLeaderboards" ], - "operationId": "gameCenterLeaderboardSetsV2_gameCenterLeaderboards_deleteToManyRelationship", + "operationId": "gameCenterLeaderboards_groupLeaderboard_updateToOneRelationship", + "deprecated": true, "requestBody": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetV2GameCenterLeaderboardsLinkagesRequest" + "$ref": "#/components/schemas/GameCenterLeaderboardGroupLeaderboardLinkageRequest" } } }, @@ -154097,52 +159469,14 @@ } ] }, - "/v2/gameCenterLeaderboardSets/{id}/gameCenterLeaderboards": { + "/v1/gameCenterLeaderboards/{id}/groupLeaderboard": { "get": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterLeaderboards" ], - "operationId": "gameCenterLeaderboardSetsV2_gameCenterLeaderboards_getToManyRelated", + "operationId": "gameCenterLeaderboards_groupLeaderboard_getToOneRelated", + "deprecated": true, "parameters": [ - { - "name": "filter[referenceName]", - "in": "query", - "description": "filter by attribute 'referenceName'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[archived]", - "in": "query", - "description": "filter by attribute 'archived'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, { "name": "fields[gameCenterLeaderboards]", "in": "query", @@ -154167,11 +159501,12 @@ "visibility", "gameCenterDetail", "gameCenterGroup", + "groupLeaderboard", "gameCenterLeaderboardSets", - "gameCenterScoreModerations", + "localizations", + "releases", "activity", - "challenge", - "versions" + "challenge" ] } }, @@ -154255,8 +159590,51 @@ "vendorIdentifier", "gameCenterDetail", "gameCenterGroup", + "groupLeaderboardSet", + "localizations", "gameCenterLeaderboards", - "versions" + "releases" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterLeaderboardLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "formatterOverride", + "formatterSuffix", + "formatterSuffixSingular", + "description", + "gameCenterLeaderboard", + "gameCenterLeaderboardImage" + ] + } + }, + "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" ] } }, @@ -154319,24 +159697,146 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardVersions]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "leaderboard", - "localizations" + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboard", + "gameCenterLeaderboardSets", + "localizations", + "releases", + "activity", + "challenge" ] } }, "style": "form", "explode": false }, + { + "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[localizations]", + "in": "query", + "description": "maximum number of related localizations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form", + "deprecated": true + }, + { + "name": "limit[releases]", + "in": "query", + "description": "maximum number of related releases 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": "Single GameCenterLeaderboard", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterLeaderboards/{id}/relationships/localizations": { + "get": { + "tags": [ + "GameCenterLeaderboards" + ], + "operationId": "gameCenterLeaderboards_localizations_getToManyRelationship", + "deprecated": true, + "parameters": [ { "name": "limit", "in": "query", @@ -154346,22 +159846,145 @@ "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/GameCenterLeaderboardLocalizationsLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterLeaderboards/{id}/localizations": { + "get": { + "tags": [ + "GameCenterLeaderboards" + ], + "operationId": "gameCenterLeaderboards_localizations_getToManyRelated", + "deprecated": true, + "parameters": [ { - "name": "include", + "name": "fields[gameCenterLeaderboardLocalizations]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "formatterOverride", + "formatterSuffix", + "formatterSuffixSingular", + "description", + "gameCenterLeaderboard", + "gameCenterLeaderboardImage" + ] + } + }, + "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" + "challenge" ] } }, @@ -154369,24 +159992,52 @@ "explode": false }, { - "name": "limit[gameCenterLeaderboardSets]", + "name": "fields[gameCenterLeaderboardImages]", "in": "query", - "description": "maximum number of related gameCenterLeaderboardSets returned (when they are included)", + "description": "the fields to include for returned resources of type gameCenterLeaderboardImages", "schema": { - "type": "integer", - "maximum": 50 + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "imageAsset", + "uploadOperations", + "assetDeliveryState", + "gameCenterLeaderboardLocalization" + ] + } }, - "style": "form" + "style": "form", + "explode": false }, { - "name": "limit[versions]", + "name": "limit", "in": "query", - "description": "maximum number of related versions returned (when they are included)", + "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 50 + "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "gameCenterLeaderboard", + "gameCenterLeaderboardImage" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -154431,11 +160082,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboards", + "description": "List of GameCenterLeaderboardLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardsV2Response" + "$ref": "#/components/schemas/GameCenterLeaderboardLocalizationsResponse" } } } @@ -154465,12 +160116,13 @@ } ] }, - "/v2/gameCenterLeaderboardSets/{id}/relationships/versions": { + "/v1/gameCenterLeaderboards/{id}/relationships/releases": { "get": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterLeaderboards" ], - "operationId": "gameCenterLeaderboardSetsV2_versions_getToManyRelationship", + "operationId": "gameCenterLeaderboards_releases_getToManyRelationship", + "deprecated": true, "parameters": [ { "name": "limit", @@ -154529,7 +160181,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetV2VersionsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardReleasesLinkagesResponse" } } } @@ -154559,26 +160211,52 @@ } ] }, - "/v2/gameCenterLeaderboardSets/{id}/versions": { + "/v1/gameCenterLeaderboards/{id}/releases": { "get": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterLeaderboards" ], - "operationId": "gameCenterLeaderboardSetsV2_versions_getToManyRelated", + "operationId": "gameCenterLeaderboards_releases_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[gameCenterLeaderboardSetVersions]", + "name": "filter[live]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetVersions", + "description": "filter by attribute 'live'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[gameCenterDetail]", + "in": "query", + "description": "filter by id(s) of related 'gameCenterDetail'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "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": [ - "version", - "state", - "leaderboardSet", - "localizations" + "live", + "gameCenterDetail", + "gameCenterLeaderboard" ] } }, @@ -154586,20 +160264,38 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSets]", + "name": "fields[gameCenterDetails]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "the fields to include for returned resources of type gameCenterDetails", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "gameCenterDetail", + "arcadeEnabled", + "challengeEnabled", + "app", + "gameCenterAppVersions", "gameCenterGroup", "gameCenterLeaderboards", - "versions" + "gameCenterLeaderboardsV2", + "gameCenterLeaderboardSets", + "gameCenterLeaderboardSetsV2", + "gameCenterAchievements", + "gameCenterAchievementsV2", + "gameCenterActivities", + "gameCenterChallenges", + "defaultLeaderboard", + "defaultLeaderboardV2", + "defaultGroupLeaderboard", + "defaultGroupLeaderboardV2", + "achievementReleases", + "activityReleases", + "challengeReleases", + "leaderboardReleases", + "leaderboardSetReleases", + "blockedPlayers", + "challengesMinimumPlatformVersions" ] } }, @@ -154607,18 +160303,35 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetLocalizations]", + "name": "fields[gameCenterLeaderboards]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", + "description": "the fields to include for returned resources of type gameCenterLeaderboards", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "name", - "version", - "image" + "defaultFormatter", + "referenceName", + "vendorIdentifier", + "submissionType", + "scoreSortType", + "scoreRangeStart", + "scoreRangeEnd", + "recurrenceStartDate", + "recurrenceDuration", + "recurrenceRule", + "archived", + "activityProperties", + "visibility", + "gameCenterDetail", + "gameCenterGroup", + "groupLeaderboard", + "gameCenterLeaderboardSets", + "localizations", + "releases", + "activity", + "challenge" ] } }, @@ -154644,23 +160357,13 @@ "items": { "type": "string", "enum": [ - "leaderboardSet", - "localizations" + "gameCenterDetail", + "gameCenterLeaderboard" ] } }, "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": { @@ -154705,11 +160408,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardSetVersions", + "description": "List of GameCenterLeaderboardReleases", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetVersionsV2Response" + "$ref": "#/components/schemas/GameCenterLeaderboardReleasesResponse" } } } @@ -154739,25 +160442,23 @@ } ] }, - "/v1/gameCenterLeaderboardSets/{id}/relationships/gameCenterLeaderboards": { - "get": { + "/v2/gameCenterLeaderboards/{id}/relationships/activity": { + "patch": { "tags": [ - "GameCenterLeaderboardSets" - ], - "operationId": "gameCenterLeaderboardSets_gameCenterLeaderboards_getToManyRelationship", - "deprecated": true, - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "GameCenterLeaderboards" ], + "operationId": "gameCenterLeaderboardsV2_activity_updateToOneRelationship", + "requestBody": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardV2ActivityLinkageRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -154799,16 +160500,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesResponse" + "$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": { @@ -154821,18 +160535,31 @@ } } }, - "post": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterLeaderboards/{id}/relationships/challenge": { + "patch": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterLeaderboards" ], - "operationId": "gameCenterLeaderboardSets_gameCenterLeaderboards_createToManyRelationship", - "deprecated": true, + "operationId": "gameCenterLeaderboardsV2_challenge_updateToOneRelationship", "requestBody": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest" + "$ref": "#/components/schemas/GameCenterLeaderboardV2ChallengeLinkageRequest" } } }, @@ -154914,23 +160641,37 @@ } } }, - "patch": { - "tags": [ - "GameCenterLeaderboardSets" - ], - "operationId": "gameCenterLeaderboardSets_gameCenterLeaderboards_replaceToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest" - } - } + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", "required": true - }, + } + ] + }, + "/v2/gameCenterLeaderboards/{id}/relationships/gameCenterScoreModerations": { + "get": { + "tags": [ + "GameCenterLeaderboards" + ], + "operationId": "gameCenterLeaderboardsV2_gameCenterScoreModerations_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -154972,29 +160713,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardV2GameCenterScoreModerationsLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -155007,23 +160735,104 @@ } } }, - "delete": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterLeaderboards/{id}/gameCenterScoreModerations": { + "get": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterLeaderboards" ], - "operationId": "gameCenterLeaderboardSets_gameCenterLeaderboards_deleteToManyRelationship", - "deprecated": true, - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest" + "operationId": "gameCenterLeaderboardsV2_gameCenterScoreModerations_getToManyRelated", + "parameters": [ + { + "name": "exists[blocked]", + "in": "query", + "description": "filter by attribute 'blocked'", + "schema": { + "type": "boolean" + }, + "style": "form", + "explode": false + }, + { + "name": "fields[gameCenterScoreModerations]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterScoreModerations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "rank", + "score", + "submittedDate", + "blocked", + "preReleased", + "context", + "challengeIds", + "player" + ] } - } + }, + "style": "form", + "explode": false }, - "required": true - }, + { + "name": "fields[gameCenterDetailPlayers]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterDetailPlayers", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "nickname", + "blocked", + "bundleId" + ] + } + }, + "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": [ + "player" + ] + } + }, + "style": "form", + "explode": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -155065,8 +160874,62 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", + "200": { + "description": "List of GameCenterScoreModerations", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterScoreModerationsResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v2/gameCenterLeaderboards/{id}/relationships/versions": { + "get": { + "tags": [ + "GameCenterLeaderboards" + ], + "operationId": "gameCenterLeaderboardsV2_versions_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": { @@ -155075,8 +160938,8 @@ } } }, - "409": { - "description": "Request entity error(s)", + "401": { + "description": "Unauthorized error(s)", "content": { "application/json": { "schema": { @@ -155085,8 +160948,35 @@ } } }, - "204": { - "description": "Success (no content)" + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterLeaderboardV2VersionsLinkagesResponse" + } + } + } }, "429": { "description": "Rate limit exceeded error", @@ -155113,48 +161003,27 @@ } ] }, - "/v1/gameCenterLeaderboardSets/{id}/gameCenterLeaderboards": { + "/v2/gameCenterLeaderboards/{id}/versions": { "get": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterLeaderboards" ], - "operationId": "gameCenterLeaderboardSets_gameCenterLeaderboards_getToManyRelated", - "deprecated": true, + "operationId": "gameCenterLeaderboardsV2_versions_getToManyRelated", "parameters": [ { - "name": "filter[referenceName]", - "in": "query", - "description": "filter by attribute 'referenceName'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[archived]", - "in": "query", - "description": "filter by attribute 'archived'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[id]", + "name": "fields[gameCenterLeaderboardVersions]", "in": "query", - "description": "filter by id(s)", + "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "version", + "state", + "leaderboard", + "localizations" + ] } }, "style": "form", @@ -155184,99 +161053,11 @@ "visibility", "gameCenterDetail", "gameCenterGroup", - "groupLeaderboard", "gameCenterLeaderboardSets", - "localizations", - "releases", + "gameCenterScoreModerations", "activity", - "challenge" - ] - } - }, - "style": "form", - "explode": 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", - "blockedPlayers", - "challengesMinimumPlatformVersions" - ] - } - }, - "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[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" + "challenge", + "versions" ] } }, @@ -155298,81 +161079,8 @@ "formatterSuffix", "formatterSuffixSingular", "description", - "gameCenterLeaderboard", - "gameCenterLeaderboardImage" - ] - } - }, - "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[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" + "version", + "image" ] } }, @@ -155398,31 +161106,14 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboard", - "gameCenterLeaderboardSets", - "localizations", - "releases", - "activity", - "challenge" + "leaderboard", + "localizations" ] } }, "style": "form", "explode": false }, - { - "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[localizations]", "in": "query", @@ -155431,19 +161122,7 @@ "type": "integer", "maximum": 50 }, - "style": "form", - "deprecated": true - }, - { - "name": "limit[releases]", - "in": "query", - "description": "maximum number of related releases returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "deprecated": true + "style": "form" } ], "responses": { @@ -155488,11 +161167,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboards", + "description": "List of GameCenterLeaderboardVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardsResponse" + "$ref": "#/components/schemas/GameCenterLeaderboardVersionsV2Response" } } } @@ -155522,14 +161201,24 @@ } ] }, - "/v1/gameCenterLeaderboardSets/{id}/relationships/groupLeaderboardSet": { + "/v1/gameCenterMatchmakingRuleSets/{id}/relationships/matchmakingQueues": { "get": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterMatchmakingRuleSets" + ], + "operationId": "gameCenterMatchmakingRuleSets_matchmakingQueues_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "gameCenterLeaderboardSets_groupLeaderboardSet_getToOneRelationship", - "deprecated": true, - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -155572,11 +161261,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetGroupLeaderboardSetLinkageResponse" + "$ref": "#/components/schemas/GameCenterMatchmakingRuleSetMatchmakingQueuesLinkagesResponse" } } } @@ -155593,23 +161282,95 @@ } } }, - "patch": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterMatchmakingRuleSets/{id}/matchmakingQueues": { + "get": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterMatchmakingRuleSets" ], - "operationId": "gameCenterLeaderboardSets_groupLeaderboardSet_updateToOneRelationship", - "deprecated": true, - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetGroupLeaderboardSetLinkageRequest" + "operationId": "gameCenterMatchmakingRuleSets_matchmakingQueues_getToManyRelated", + "parameters": [ + { + "name": "fields[gameCenterMatchmakingQueues]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterMatchmakingQueues", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "referenceName", + "classicMatchmakingBundleIds", + "ruleSet", + "experimentRuleSet" + ] } - } + }, + "style": "form", + "explode": false }, - "required": true - }, + { + "name": "fields[gameCenterMatchmakingRuleSets]", + "in": "query", + "description": "the fields to include for returned resources of type gameCenterMatchmakingRuleSets", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "referenceName", + "ruleLanguageVersion", + "minPlayers", + "maxPlayers", + "teams", + "rules", + "matchmakingQueues" + ] + } + }, + "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": [ + "ruleSet", + "experimentRuleSet" + ] + } + }, + "style": "form", + "explode": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -155651,29 +161412,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of GameCenterMatchmakingQueues", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GameCenterMatchmakingQueuesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -155699,189 +161447,121 @@ } ] }, - "/v1/gameCenterLeaderboardSets/{id}/groupLeaderboardSet": { + "/v1/gameCenterMatchmakingRuleSets/{id}/relationships/rules": { "get": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterMatchmakingRuleSets" ], - "operationId": "gameCenterLeaderboardSets_groupLeaderboardSet_getToOneRelated", - "deprecated": true, + "operationId": "gameCenterMatchmakingRuleSets_rules_getToManyRelationship", "parameters": [ { - "name": "fields[gameCenterLeaderboardSets]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "referenceName", - "vendorIdentifier", - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboardSet", - "localizations", - "gameCenterLeaderboards", - "releases" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "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", - "blockedPlayers", - "challengesMinimumPlatformVersions" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "fields[gameCenterLeaderboardSetLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "gameCenterLeaderboardSet", - "gameCenterLeaderboardSetImage" - ] + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "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" - ] + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameCenterMatchmakingRuleSetRulesLinkagesResponse" + } } - }, - "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" - ] + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/gameCenterMatchmakingRuleSets/{id}/rules": { + "get": { + "tags": [ + "GameCenterMatchmakingRuleSets" + ], + "operationId": "gameCenterMatchmakingRuleSets_rules_getToManyRelated", + "parameters": [ { - "name": "include", + "name": "fields[gameCenterMatchmakingRules]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type gameCenterMatchmakingRules", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboardSet", - "localizations", - "gameCenterLeaderboards", - "releases" + "referenceName", + "description", + "type", + "expression", + "weight" ] } }, @@ -155889,37 +161569,14 @@ "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", - "deprecated": true - }, - { - "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[releases]", + "name": "limit", "in": "query", - "description": "maximum number of related releases returned (when they are included)", + "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 50 + "maximum": 200 }, - "style": "form", - "deprecated": true + "style": "form" } ], "responses": { @@ -155964,11 +161621,11 @@ } }, "200": { - "description": "Single GameCenterLeaderboardSet", + "description": "List of GameCenterMatchmakingRules", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetResponse" + "$ref": "#/components/schemas/GameCenterMatchmakingRulesResponse" } } } @@ -155998,13 +161655,12 @@ } ] }, - "/v1/gameCenterLeaderboardSets/{id}/relationships/localizations": { + "/v1/gameCenterMatchmakingRuleSets/{id}/relationships/teams": { "get": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterMatchmakingRuleSets" ], - "operationId": "gameCenterLeaderboardSets_localizations_getToManyRelationship", - "deprecated": true, + "operationId": "gameCenterMatchmakingRuleSets_teams_getToManyRelationship", "parameters": [ { "name": "limit", @@ -156063,7 +161719,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/GameCenterMatchmakingRuleSetTeamsLinkagesResponse" } } } @@ -156093,71 +161749,25 @@ } ] }, - "/v1/gameCenterLeaderboardSets/{id}/localizations": { + "/v1/gameCenterMatchmakingRuleSets/{id}/teams": { "get": { "tags": [ - "GameCenterLeaderboardSets" + "GameCenterMatchmakingRuleSets" ], - "operationId": "gameCenterLeaderboardSets_localizations_getToManyRelated", - "deprecated": true, + "operationId": "gameCenterMatchmakingRuleSets_teams_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterLeaderboardSetLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "gameCenterLeaderboardSet", - "gameCenterLeaderboardSetImage" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboardSets]", + "name": "fields[gameCenterMatchmakingTeams]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "the fields to include for returned resources of type gameCenterMatchmakingTeams", "schema": { "type": "array", "items": { "type": "string", "enum": [ "referenceName", - "vendorIdentifier", - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboardSet", - "localizations", - "gameCenterLeaderboards", - "releases" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboardSetImages]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState", - "gameCenterLeaderboardSetLocalization" + "minPlayers", + "maxPlayers" ] } }, @@ -156173,23 +161783,6 @@ "maximum": 200 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "gameCenterLeaderboardSet", - "gameCenterLeaderboardSetImage" - ] - } - }, - "style": "form", - "explode": false } ], "responses": { @@ -156234,11 +161827,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardSetLocalizations", + "description": "List of GameCenterMatchmakingTeams", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetLocalizationsResponse" + "$ref": "#/components/schemas/GameCenterMatchmakingTeamsResponse" } } } @@ -156268,13 +161861,12 @@ } ] }, - "/v1/gameCenterLeaderboardSets/{id}/relationships/releases": { + "/v1/inAppPurchaseAvailabilities/{id}/relationships/availableTerritories": { "get": { "tags": [ - "GameCenterLeaderboardSets" + "InAppPurchaseAvailabilities" ], - "operationId": "gameCenterLeaderboardSets_releases_getToManyRelationship", - "deprecated": true, + "operationId": "inAppPurchaseAvailabilities_availableTerritories_getToManyRelationship", "parameters": [ { "name": "limit", @@ -156333,7 +161925,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetReleasesLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseAvailabilityAvailableTerritoriesLinkagesResponse" } } } @@ -156363,114 +161955,23 @@ } ] }, - "/v1/gameCenterLeaderboardSets/{id}/releases": { + "/v1/inAppPurchaseAvailabilities/{id}/availableTerritories": { "get": { "tags": [ - "GameCenterLeaderboardSets" + "InAppPurchaseAvailabilities" ], - "operationId": "gameCenterLeaderboardSets_releases_getToManyRelated", - "deprecated": true, + "operationId": "inAppPurchaseAvailabilities_availableTerritories_getToManyRelated", "parameters": [ { - "name": "filter[live]", - "in": "query", - "description": "filter by attribute 'live'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[gameCenterDetail]", - "in": "query", - "description": "filter by id(s) of related 'gameCenterDetail'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "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[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", - "blockedPlayers", - "challengesMinimumPlatformVersions" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboardSets]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboardSet", - "localizations", - "gameCenterLeaderboards", - "releases" + "currency" ] } }, @@ -156486,23 +161987,6 @@ "maximum": 200 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "gameCenterDetail", - "gameCenterLeaderboardSet" - ] - } - }, - "style": "form", - "explode": false } ], "responses": { @@ -156547,11 +162031,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardSetReleases", + "description": "List of Territories", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardSetReleasesResponse" + "$ref": "#/components/schemas/TerritoriesResponse" } } } @@ -156581,24 +162065,13 @@ } ] }, - "/v2/gameCenterLeaderboardVersions/{id}/relationships/localizations": { + "/v1/inAppPurchaseOfferCodeOneTimeUseCodes/{id}/values": { "get": { "tags": [ - "GameCenterLeaderboardVersions" - ], - "operationId": "gameCenterLeaderboardVersionsV2_localizations_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "InAppPurchaseOfferCodeOneTimeUseCodes" ], + "operationId": "inAppPurchaseOfferCodeOneTimeUseCodes_values_getToOneRelated", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -156641,11 +162114,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Single InAppPurchaseOfferCodeOneTimeUseCodeValue", "content": { - "application/json": { + "text/csv": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardVersionV2LocalizationsLinkagesResponse" + "$ref": "#/components/schemas/csv" } } } @@ -156675,76 +162148,13 @@ } ] }, - "/v2/gameCenterLeaderboardVersions/{id}/localizations": { + "/v1/inAppPurchaseOfferCodes/{id}/relationships/customCodes": { "get": { "tags": [ - "GameCenterLeaderboardVersions" + "InAppPurchaseOfferCodes" ], - "operationId": "gameCenterLeaderboardVersionsV2_localizations_getToManyRelated", + "operationId": "inAppPurchaseOfferCodes_customCodes_getToManyRelationship", "parameters": [ - { - "name": "fields[gameCenterLeaderboardLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "formatterOverride", - "formatterSuffix", - "formatterSuffixSingular", - "description", - "version", - "image" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboardVersions]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "leaderboard", - "localizations" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[gameCenterLeaderboardImages]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState", - "localization" - ] - } - }, - "style": "form", - "explode": false - }, { "name": "limit", "in": "query", @@ -156754,23 +162164,6 @@ "maximum": 200 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "image" - ] - } - }, - "style": "form", - "explode": false } ], "responses": { @@ -156815,11 +162208,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardLocalizations", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardLocalizationsV2Response" + "$ref": "#/components/schemas/InAppPurchaseOfferCodeCustomCodesLinkagesResponse" } } } @@ -156849,24 +162242,83 @@ } ] }, - "/v1/gameCenterLeaderboards/{id}/relationships/activity": { - "patch": { + "/v1/inAppPurchaseOfferCodes/{id}/customCodes": { + "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchaseOfferCodes" ], - "operationId": "gameCenterLeaderboards_activity_updateToOneRelationship", - "deprecated": true, - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardActivityLinkageRequest" + "operationId": "inAppPurchaseOfferCodes_customCodes_getToManyRelated", + "parameters": [ + { + "name": "fields[inAppPurchaseOfferCodeCustomCodes]", + "in": "query", + "description": "the fields to include for returned resources of type inAppPurchaseOfferCodeCustomCodes", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "customCode", + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "createdByActor", + "deactivatedByActor" + ] } - } + }, + "style": "form", + "explode": false }, - "required": true - }, + { + "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": [ + "createdByActor", + "deactivatedByActor" + ] + } + }, + "style": "form", + "explode": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -156908,29 +162360,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of InAppPurchaseOfferCodeCustomCodes", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/InAppPurchaseOfferCodeCustomCodesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -156956,24 +162395,24 @@ } ] }, - "/v1/gameCenterLeaderboards/{id}/relationships/challenge": { - "patch": { + "/v1/inAppPurchaseOfferCodes/{id}/relationships/oneTimeUseCodes": { + "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchaseOfferCodes" + ], + "operationId": "inAppPurchaseOfferCodes_oneTimeUseCodes_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "gameCenterLeaderboards_challenge_updateToOneRelationship", - "deprecated": true, - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardChallengeLinkageRequest" - } - } - }, - "required": true - }, "responses": { "400": { "description": "Parameter error(s)", @@ -157015,29 +162454,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/InAppPurchaseOfferCodeOneTimeUseCodesLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -157063,14 +162489,84 @@ } ] }, - "/v1/gameCenterLeaderboards/{id}/relationships/groupLeaderboard": { + "/v1/inAppPurchaseOfferCodes/{id}/oneTimeUseCodes": { "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchaseOfferCodes" + ], + "operationId": "inAppPurchaseOfferCodes_oneTimeUseCodes_getToManyRelated", + "parameters": [ + { + "name": "fields[inAppPurchaseOfferCodeOneTimeUseCodes]", + "in": "query", + "description": "the fields to include for returned resources of type inAppPurchaseOfferCodeOneTimeUseCodes", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "environment", + "values", + "createdByActor", + "deactivatedByActor" + ] + } + }, + "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": [ + "createdByActor", + "deactivatedByActor" + ] + } + }, + "style": "form", + "explode": false + } ], - "operationId": "gameCenterLeaderboards_groupLeaderboard_getToOneRelationship", - "deprecated": true, - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -157113,11 +162609,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of InAppPurchaseOfferCodeOneTimeUseCodes", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardGroupLeaderboardLinkageResponse" + "$ref": "#/components/schemas/InAppPurchaseOfferCodeOneTimeUseCodesResponse" } } } @@ -157134,23 +162630,37 @@ } } }, - "patch": { - "tags": [ - "GameCenterLeaderboards" - ], - "operationId": "gameCenterLeaderboards_groupLeaderboard_updateToOneRelationship", - "deprecated": true, - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardGroupLeaderboardLinkageRequest" - } - } + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", "required": true - }, + } + ] + }, + "/v1/inAppPurchaseOfferCodes/{id}/relationships/prices": { + "get": { + "tags": [ + "InAppPurchaseOfferCodes" + ], + "operationId": "inAppPurchaseOfferCodes_prices_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -157192,29 +162702,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/InAppPurchaseOfferCodePricesLinkagesResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -157240,154 +162737,37 @@ } ] }, - "/v1/gameCenterLeaderboards/{id}/groupLeaderboard": { + "/v1/inAppPurchaseOfferCodes/{id}/prices": { "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchaseOfferCodes" ], - "operationId": "gameCenterLeaderboards_groupLeaderboard_getToOneRelated", - "deprecated": true, + "operationId": "inAppPurchaseOfferCodes_prices_getToManyRelated", "parameters": [ { - "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" - ] - } - }, - "style": "form", - "explode": 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", - "blockedPlayers", - "challengesMinimumPlatformVersions" - ] - } - }, - "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[gameCenterLeaderboardSets]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSets", + "description": "filter by id(s) of related 'territory'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "referenceName", - "vendorIdentifier", - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboardSet", - "localizations", - "gameCenterLeaderboards", - "releases" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[gameCenterLeaderboardLocalizations]", + "name": "fields[inAppPurchaseOfferPrices]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", + "description": "the fields to include for returned resources of type inAppPurchaseOfferPrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "locale", - "name", - "formatterOverride", - "formatterSuffix", - "formatterSuffixSingular", - "description", - "gameCenterLeaderboard", - "gameCenterLeaderboardImage" + "territory", + "pricePoint" ] } }, @@ -157395,17 +162775,15 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardReleases]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardReleases", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", - "gameCenterDetail", - "gameCenterLeaderboard" + "currency" ] } }, @@ -157413,29 +162791,18 @@ "explode": false }, { - "name": "fields[gameCenterActivities]", + "name": "fields[inAppPurchasePricePoints]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivities", + "description": "the fields to include for returned resources of type inAppPurchasePricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "vendorIdentifier", - "playStyle", - "minimumPlayersCount", - "maximumPlayersCount", - "supportsPartyCode", - "archived", - "properties", - "gameCenterDetail", - "gameCenterGroup", - "achievements", - "achievementsV2", - "leaderboards", - "leaderboardsV2", - "versions" + "customerPrice", + "proceeds", + "territory", + "equalizations" ] } }, @@ -157443,29 +162810,14 @@ "explode": false }, { - "name": "fields[gameCenterChallenges]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallenges", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "referenceName", - "vendorIdentifier", - "archived", - "challengeType", - "repeatable", - "gameCenterDetail", - "gameCenterGroup", - "versions", - "leaderboard", - "leaderboardV2" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { "name": "include", @@ -157476,52 +162828,13 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterGroup", - "groupLeaderboard", - "gameCenterLeaderboardSets", - "localizations", - "releases", - "activity", - "challenge" + "territory", + "pricePoint" ] } }, "style": "form", "explode": false - }, - { - "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[localizations]", - "in": "query", - "description": "maximum number of related localizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "deprecated": true - }, - { - "name": "limit[releases]", - "in": "query", - "description": "maximum number of related releases returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form", - "deprecated": true } ], "responses": { @@ -157566,11 +162879,11 @@ } }, "200": { - "description": "Single GameCenterLeaderboard", + "description": "List of InAppPurchaseOfferPrices", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardResponse" + "$ref": "#/components/schemas/InAppPurchaseOfferPricesResponse" } } } @@ -157600,13 +162913,12 @@ } ] }, - "/v1/gameCenterLeaderboards/{id}/relationships/localizations": { + "/v1/inAppPurchasePricePoints/{id}/relationships/equalizations": { "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchasePricePoints" ], - "operationId": "gameCenterLeaderboards_localizations_getToManyRelationship", - "deprecated": true, + "operationId": "inAppPurchasePricePoints_equalizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -157614,7 +162926,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 200 + "maximum": 8000 }, "style": "form" } @@ -157665,7 +162977,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchasePricePointEqualizationsLinkagesResponse" } } } @@ -157695,67 +163007,52 @@ } ] }, - "/v1/gameCenterLeaderboards/{id}/localizations": { + "/v1/inAppPurchasePricePoints/{id}/equalizations": { "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchasePricePoints" ], - "operationId": "gameCenterLeaderboards_localizations_getToManyRelated", - "deprecated": true, + "operationId": "inAppPurchasePricePoints_equalizations_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterLeaderboardLocalizations]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", + "description": "filter by id(s) of related 'territory'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "locale", - "name", - "formatterOverride", - "formatterSuffix", - "formatterSuffixSingular", - "description", - "gameCenterLeaderboard", - "gameCenterLeaderboardImage" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[gameCenterLeaderboards]", + "name": "filter[inAppPurchaseV2]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "filter by id(s) of related 'inAppPurchaseV2'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[inAppPurchasePricePoints]", + "in": "query", + "description": "the fields to include for returned resources of type inAppPurchasePricePoints", "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" + "customerPrice", + "proceeds", + "territory", + "equalizations" ] } }, @@ -157763,20 +163060,15 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardImages]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardImages", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "imageAsset", - "uploadOperations", - "assetDeliveryState", - "gameCenterLeaderboardLocalization" + "currency" ] } }, @@ -157789,7 +163081,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 200 + "maximum": 8000 }, "style": "form" }, @@ -157802,8 +163094,7 @@ "items": { "type": "string", "enum": [ - "gameCenterLeaderboard", - "gameCenterLeaderboardImage" + "territory" ] } }, @@ -157853,11 +163144,16 @@ } }, "200": { - "description": "List of GameCenterLeaderboardLocalizations", + "description": "List of InAppPurchasePricePoints", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardLocalizationsResponse" + "$ref": "#/components/schemas/InAppPurchasePricePointsResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/csv" } } } @@ -157887,13 +163183,12 @@ } ] }, - "/v1/gameCenterLeaderboards/{id}/relationships/releases": { + "/v1/inAppPurchasePriceSchedules/{id}/relationships/automaticPrices": { "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchasePriceSchedules" ], - "operationId": "gameCenterLeaderboards_releases_getToManyRelationship", - "deprecated": true, + "operationId": "inAppPurchasePriceSchedules_automaticPrices_getToManyRelationship", "parameters": [ { "name": "limit", @@ -157952,7 +163247,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardReleasesLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchasePriceScheduleAutomaticPricesLinkagesResponse" } } } @@ -157982,31 +163277,17 @@ } ] }, - "/v1/gameCenterLeaderboards/{id}/releases": { + "/v1/inAppPurchasePriceSchedules/{id}/automaticPrices": { "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchasePriceSchedules" ], - "operationId": "gameCenterLeaderboards_releases_getToManyRelated", - "deprecated": true, + "operationId": "inAppPurchasePriceSchedules_automaticPrices_getToManyRelated", "parameters": [ { - "name": "filter[live]", - "in": "query", - "description": "filter by attribute 'live'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[gameCenterDetail]", + "name": "filter[territory]", "in": "query", - "description": "filter by id(s) of related 'gameCenterDetail'", + "description": "filter by id(s) of related 'territory'", "schema": { "type": "array", "items": { @@ -158017,17 +163298,19 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardReleases]", + "name": "fields[inAppPurchasePrices]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardReleases", + "description": "the fields to include for returned resources of type inAppPurchasePrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "live", - "gameCenterDetail", - "gameCenterLeaderboard" + "startDate", + "endDate", + "manual", + "inAppPurchasePricePoint", + "territory" ] } }, @@ -158035,38 +163318,18 @@ "explode": false }, { - "name": "fields[gameCenterDetails]", + "name": "fields[inAppPurchasePricePoints]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterDetails", + "description": "the fields to include for returned resources of type inAppPurchasePricePoints", "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", - "blockedPlayers", - "challengesMinimumPlatformVersions" + "customerPrice", + "proceeds", + "territory", + "equalizations" ] } }, @@ -158074,35 +163337,15 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboards]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboards", + "description": "the fields to include for returned resources of type territories", "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" + "currency" ] } }, @@ -158128,8 +163371,8 @@ "items": { "type": "string", "enum": [ - "gameCenterDetail", - "gameCenterLeaderboard" + "inAppPurchasePricePoint", + "territory" ] } }, @@ -158179,11 +163422,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardReleases", + "description": "List of InAppPurchasePrices", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardReleasesResponse" + "$ref": "#/components/schemas/InAppPurchasePricesResponse" } } } @@ -158213,23 +163456,13 @@ } ] }, - "/v2/gameCenterLeaderboards/{id}/relationships/activity": { - "patch": { + "/v1/inAppPurchasePriceSchedules/{id}/relationships/baseTerritory": { + "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchasePriceSchedules" ], - "operationId": "gameCenterLeaderboardsV2_activity_updateToOneRelationship", - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardV2ActivityLinkageRequest" - } - } - }, - "required": true - }, + "operationId": "inAppPurchasePriceSchedules_baseTerritory_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -158271,29 +163504,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/InAppPurchasePriceScheduleBaseTerritoryLinkageResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -158319,23 +163539,30 @@ } ] }, - "/v2/gameCenterLeaderboards/{id}/relationships/challenge": { - "patch": { + "/v1/inAppPurchasePriceSchedules/{id}/baseTerritory": { + "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchasePriceSchedules" ], - "operationId": "gameCenterLeaderboardsV2_challenge_updateToOneRelationship", - "requestBody": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardV2ChallengeLinkageRequest" + "operationId": "inAppPurchasePriceSchedules_baseTerritory_getToOneRelated", + "parameters": [ + { + "name": "fields[territories]", + "in": "query", + "description": "the fields to include for returned resources of type territories", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "currency" + ] } - } - }, - "required": true - }, + }, + "style": "form", + "explode": false + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -158377,29 +163604,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "Single Territory", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/TerritoryResponse" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -158425,12 +163639,12 @@ } ] }, - "/v2/gameCenterLeaderboards/{id}/relationships/gameCenterScoreModerations": { + "/v1/inAppPurchasePriceSchedules/{id}/relationships/manualPrices": { "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchasePriceSchedules" ], - "operationId": "gameCenterLeaderboardsV2_gameCenterScoreModerations_getToManyRelationship", + "operationId": "inAppPurchasePriceSchedules_manualPrices_getToManyRelationship", "parameters": [ { "name": "limit", @@ -158489,7 +163703,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardV2GameCenterScoreModerationsLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchasePriceScheduleManualPricesLinkagesResponse" } } } @@ -158519,40 +163733,40 @@ } ] }, - "/v2/gameCenterLeaderboards/{id}/gameCenterScoreModerations": { + "/v1/inAppPurchasePriceSchedules/{id}/manualPrices": { "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchasePriceSchedules" ], - "operationId": "gameCenterLeaderboardsV2_gameCenterScoreModerations_getToManyRelated", + "operationId": "inAppPurchasePriceSchedules_manualPrices_getToManyRelated", "parameters": [ { - "name": "exists[blocked]", + "name": "filter[territory]", "in": "query", - "description": "filter by attribute 'blocked'", + "description": "filter by id(s) of related 'territory'", "schema": { - "type": "boolean" + "type": "array", + "items": { + "type": "string" + } }, "style": "form", "explode": false }, { - "name": "fields[gameCenterScoreModerations]", + "name": "fields[inAppPurchasePrices]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterScoreModerations", + "description": "the fields to include for returned resources of type inAppPurchasePrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "rank", - "score", - "submittedDate", - "blocked", - "preReleased", - "context", - "challengeIds", - "player" + "startDate", + "endDate", + "manual", + "inAppPurchasePricePoint", + "territory" ] } }, @@ -158560,17 +163774,34 @@ "explode": false }, { - "name": "fields[gameCenterDetailPlayers]", + "name": "fields[inAppPurchasePricePoints]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterDetailPlayers", + "description": "the fields to include for returned resources of type inAppPurchasePricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "nickname", - "blocked", - "bundleId" + "customerPrice", + "proceeds", + "territory", + "equalizations" + ] + } + }, + "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" ] } }, @@ -158596,7 +163827,8 @@ "items": { "type": "string", "enum": [ - "player" + "inAppPurchasePricePoint", + "territory" ] } }, @@ -158646,11 +163878,11 @@ } }, "200": { - "description": "List of GameCenterScoreModerations", + "description": "List of InAppPurchasePrices", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterScoreModerationsResponse" + "$ref": "#/components/schemas/InAppPurchasePricesResponse" } } } @@ -158680,24 +163912,13 @@ } ] }, - "/v2/gameCenterLeaderboards/{id}/relationships/versions": { + "/v1/inAppPurchaseVersions/{id}/relationships/image": { "get": { "tags": [ - "GameCenterLeaderboards" - ], - "operationId": "gameCenterLeaderboardsV2_versions_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "InAppPurchaseVersions" ], + "operationId": "inAppPurchaseVersions_image_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -158740,11 +163961,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardV2VersionsLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseVersionImageLinkageResponse" } } } @@ -158774,90 +163995,118 @@ } ] }, - "/v2/gameCenterLeaderboards/{id}/versions": { + "/v1/inAppPurchaseVersions/{id}/image": { "get": { "tags": [ - "GameCenterLeaderboards" + "InAppPurchaseVersions" ], - "operationId": "gameCenterLeaderboardsV2_versions_getToManyRelated", + "operationId": "inAppPurchaseVersions_image_getToOneRelated", "parameters": [ { - "name": "fields[gameCenterLeaderboardVersions]", + "name": "fields[inAppPurchaseImages]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", + "description": "the fields to include for returned resources of type inAppPurchaseImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "leaderboard", - "localizations" + "fileSize", + "fileName", + "assetToken", + "imageAsset", + "uploadOperations", + "assetDeliveryState" ] } }, "style": "form", "explode": false + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "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", - "gameCenterLeaderboardSets", - "gameCenterScoreModerations", - "activity", - "challenge", - "versions" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "fields[gameCenterLeaderboardLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "locale", - "name", - "formatterOverride", - "formatterSuffix", - "formatterSuffixSingular", - "description", - "version", - "image" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } + }, + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Single InAppPurchaseImage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InAppPurchaseImageV2Response" + } + } + } }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/inAppPurchaseVersions/{id}/relationships/images": { + "get": { + "tags": [ + "InAppPurchaseVersions" + ], + "operationId": "inAppPurchaseVersions_images_getToManyRelationship", + "parameters": [ { "name": "limit", "in": "query", @@ -158867,18 +164116,106 @@ "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/InAppPurchaseVersionImagesLinkagesResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/inAppPurchaseVersions/{id}/images": { + "get": { + "tags": [ + "InAppPurchaseVersions" + ], + "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "parameters": [ { - "name": "include", + "name": "fields[inAppPurchaseImages]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type inAppPurchaseImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "leaderboard", - "localizations" + "fileSize", + "fileName", + "assetToken", + "imageAsset", + "uploadOperations", + "assetDeliveryState" ] } }, @@ -158886,12 +164223,12 @@ "explode": false }, { - "name": "limit[localizations]", + "name": "limit", "in": "query", - "description": "maximum number of related localizations returned (when they are included)", + "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 50 + "maximum": 200 }, "style": "form" } @@ -158938,11 +164275,11 @@ } }, "200": { - "description": "List of GameCenterLeaderboardVersions", + "description": "List of InAppPurchaseImages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterLeaderboardVersionsV2Response" + "$ref": "#/components/schemas/InAppPurchaseImagesV2Response" } } } @@ -158972,12 +164309,12 @@ } ] }, - "/v1/gameCenterMatchmakingRuleSets/{id}/relationships/matchmakingQueues": { + "/v1/inAppPurchaseVersions/{id}/relationships/localizations": { "get": { "tags": [ - "GameCenterMatchmakingRuleSets" + "InAppPurchaseVersions" ], - "operationId": "gameCenterMatchmakingRuleSets_matchmakingQueues_getToManyRelationship", + "operationId": "inAppPurchaseVersions_localizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -159036,7 +164373,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterMatchmakingRuleSetMatchmakingQueuesLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseVersionLocalizationsLinkagesResponse" } } } @@ -159066,26 +164403,26 @@ } ] }, - "/v1/gameCenterMatchmakingRuleSets/{id}/matchmakingQueues": { + "/v1/inAppPurchaseVersions/{id}/localizations": { "get": { "tags": [ - "GameCenterMatchmakingRuleSets" + "InAppPurchaseVersions" ], - "operationId": "gameCenterMatchmakingRuleSets_matchmakingQueues_getToManyRelated", + "operationId": "inAppPurchaseVersions_localizations_getToManyRelated", "parameters": [ { - "name": "fields[gameCenterMatchmakingQueues]", + "name": "fields[inAppPurchaseLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterMatchmakingQueues", + "description": "the fields to include for returned resources of type inAppPurchaseLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "classicMatchmakingBundleIds", - "ruleSet", - "experimentRuleSet" + "name", + "locale", + "description", + "version" ] } }, @@ -159093,21 +164430,20 @@ "explode": false }, { - "name": "fields[gameCenterMatchmakingRuleSets]", + "name": "fields[inAppPurchaseVersions]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterMatchmakingRuleSets", + "description": "the fields to include for returned resources of type inAppPurchaseVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "ruleLanguageVersion", - "minPlayers", - "maxPlayers", - "teams", - "rules", - "matchmakingQueues" + "version", + "state", + "inAppPurchase", + "image", + "images", + "localizations" ] } }, @@ -159133,8 +164469,7 @@ "items": { "type": "string", "enum": [ - "ruleSet", - "experimentRuleSet" + "version" ] } }, @@ -159184,11 +164519,11 @@ } }, "200": { - "description": "List of GameCenterMatchmakingQueues", + "description": "List of InAppPurchaseLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterMatchmakingQueuesResponse" + "$ref": "#/components/schemas/InAppPurchaseLocalizationsV2Response" } } } @@ -159218,24 +164553,13 @@ } ] }, - "/v1/gameCenterMatchmakingRuleSets/{id}/relationships/rules": { + "/v2/inAppPurchases/{id}/relationships/appStoreReviewScreenshot": { "get": { "tags": [ - "GameCenterMatchmakingRuleSets" - ], - "operationId": "gameCenterMatchmakingRuleSets_rules_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "InAppPurchases" ], + "operationId": "inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -159278,11 +164602,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterMatchmakingRuleSetRulesLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseV2AppStoreReviewScreenshotLinkageResponse" } } } @@ -159312,27 +164636,31 @@ } ] }, - "/v1/gameCenterMatchmakingRuleSets/{id}/rules": { + "/v2/inAppPurchases/{id}/appStoreReviewScreenshot": { "get": { "tags": [ - "GameCenterMatchmakingRuleSets" + "InAppPurchases" ], - "operationId": "gameCenterMatchmakingRuleSets_rules_getToManyRelated", + "operationId": "inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelated", "parameters": [ { - "name": "fields[gameCenterMatchmakingRules]", + "name": "fields[inAppPurchaseAppStoreReviewScreenshots]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterMatchmakingRules", + "description": "the fields to include for returned resources of type inAppPurchaseAppStoreReviewScreenshots", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "description", - "type", - "expression", - "weight" + "fileSize", + "fileName", + "sourceFileChecksum", + "imageAsset", + "assetToken", + "assetType", + "uploadOperations", + "assetDeliveryState", + "inAppPurchaseV2" ] } }, @@ -159340,14 +164668,52 @@ "explode": false }, { - "name": "limit", + "name": "fields[inAppPurchases]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type inAppPurchases", "schema": { - "type": "integer", - "maximum": 200 + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "productId", + "inAppPurchaseType", + "state", + "reviewNote", + "familySharable", + "contentHosting", + "inAppPurchaseLocalizations", + "pricePoints", + "content", + "appStoreReviewScreenshot", + "promotedPurchase", + "iapPriceSchedule", + "inAppPurchaseAvailability", + "images", + "offerCodes", + "versions" + ] + } }, - "style": "form" + "style": "form", + "explode": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "inAppPurchaseV2" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -159392,11 +164758,11 @@ } }, "200": { - "description": "List of GameCenterMatchmakingRules", + "description": "Single InAppPurchaseAppStoreReviewScreenshot", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterMatchmakingRulesResponse" + "$ref": "#/components/schemas/InAppPurchaseAppStoreReviewScreenshotResponse" } } } @@ -159426,24 +164792,13 @@ } ] }, - "/v1/gameCenterMatchmakingRuleSets/{id}/relationships/teams": { + "/v2/inAppPurchases/{id}/relationships/content": { "get": { "tags": [ - "GameCenterMatchmakingRuleSets" - ], - "operationId": "gameCenterMatchmakingRuleSets_teams_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "InAppPurchases" ], + "operationId": "inAppPurchasesV2_content_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -159486,11 +164841,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GameCenterMatchmakingRuleSetTeamsLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseV2ContentLinkageResponse" } } } @@ -159520,25 +164875,27 @@ } ] }, - "/v1/gameCenterMatchmakingRuleSets/{id}/teams": { + "/v2/inAppPurchases/{id}/content": { "get": { "tags": [ - "GameCenterMatchmakingRuleSets" + "InAppPurchases" ], - "operationId": "gameCenterMatchmakingRuleSets_teams_getToManyRelated", + "operationId": "inAppPurchasesV2_content_getToOneRelated", "parameters": [ { - "name": "fields[gameCenterMatchmakingTeams]", + "name": "fields[inAppPurchaseContents]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterMatchmakingTeams", + "description": "the fields to include for returned resources of type inAppPurchaseContents", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "minPlayers", - "maxPlayers" + "fileName", + "fileSize", + "url", + "lastModifiedDate", + "inAppPurchaseV2" ] } }, @@ -159546,108 +164903,52 @@ "explode": false }, { - "name": "limit", + "name": "fields[inAppPurchases]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type inAppPurchases", "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 GameCenterMatchmakingTeams", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GameCenterMatchmakingTeamsResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "productId", + "inAppPurchaseType", + "state", + "reviewNote", + "familySharable", + "contentHosting", + "inAppPurchaseLocalizations", + "pricePoints", + "content", + "appStoreReviewScreenshot", + "promotedPurchase", + "iapPriceSchedule", + "inAppPurchaseAvailability", + "images", + "offerCodes", + "versions" + ] } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + }, + "style": "form", + "explode": false }, - "style": "simple", - "required": true - } - ] - }, - "/v1/inAppPurchaseAvailabilities/{id}/relationships/availableTerritories": { - "get": { - "tags": [ - "InAppPurchaseAvailabilities" - ], - "operationId": "inAppPurchaseAvailabilities_availableTerritories_getToManyRelationship", - "parameters": [ { - "name": "limit", + "name": "include", "in": "query", - "description": "maximum resources per page", + "description": "comma-separated list of relationships to include", "schema": { - "type": "integer", - "maximum": 200 + "type": "array", + "items": { + "type": "string", + "enum": [ + "inAppPurchaseV2" + ] + } }, - "style": "form" + "style": "form", + "explode": false } ], "responses": { @@ -159692,11 +164993,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Single InAppPurchaseContent", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseAvailabilityAvailableTerritoriesLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseContentResponse" } } } @@ -159726,40 +165027,13 @@ } ] }, - "/v1/inAppPurchaseAvailabilities/{id}/availableTerritories": { + "/v2/inAppPurchases/{id}/relationships/iapPriceSchedule": { "get": { "tags": [ - "InAppPurchaseAvailabilities" - ], - "operationId": "inAppPurchaseAvailabilities_availableTerritories_getToManyRelated", - "parameters": [ - { - "name": "fields[territories]", - "in": "query", - "description": "the fields to include for returned resources of type territories", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "currency" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "InAppPurchases" ], + "operationId": "inAppPurchasesV2_iapPriceSchedule_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -159802,11 +165076,11 @@ } }, "200": { - "description": "List of Territories", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoriesResponse" + "$ref": "#/components/schemas/InAppPurchaseV2IapPriceScheduleLinkageResponse" } } } @@ -159836,13 +165110,106 @@ } ] }, - "/v1/inAppPurchaseOfferCodeOneTimeUseCodes/{id}/values": { + "/v2/inAppPurchases/{id}/iapPriceSchedule": { "get": { "tags": [ - "InAppPurchaseOfferCodeOneTimeUseCodes" + "InAppPurchases" + ], + "operationId": "inAppPurchasesV2_iapPriceSchedule_getToOneRelated", + "parameters": [ + { + "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[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[inAppPurchasePrices]", + "in": "query", + "description": "the fields to include for returned resources of type inAppPurchasePrices", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "startDate", + "endDate", + "manual", + "inAppPurchasePricePoint", + "territory" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "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" + } ], - "operationId": "inAppPurchaseOfferCodeOneTimeUseCodes_values_getToOneRelated", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -159885,11 +165252,11 @@ } }, "200": { - "description": "Single InAppPurchaseOfferCodeOneTimeUseCodeValue", + "description": "Single InAppPurchasePriceSchedule", "content": { - "text/csv": { + "application/json": { "schema": { - "$ref": "#/components/schemas/csv" + "$ref": "#/components/schemas/InAppPurchasePriceScheduleResponse" } } } @@ -159919,12 +165286,12 @@ } ] }, - "/v1/inAppPurchaseOfferCodes/{id}/relationships/customCodes": { + "/v2/inAppPurchases/{id}/relationships/images": { "get": { "tags": [ - "InAppPurchaseOfferCodes" + "InAppPurchases" ], - "operationId": "inAppPurchaseOfferCodes_customCodes_getToManyRelationship", + "operationId": "inAppPurchasesV2_images_getToManyRelationship", "parameters": [ { "name": "limit", @@ -159983,7 +165350,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseOfferCodeCustomCodesLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseV2ImagesLinkagesResponse" } } } @@ -160013,29 +165380,30 @@ } ] }, - "/v1/inAppPurchaseOfferCodes/{id}/customCodes": { + "/v2/inAppPurchases/{id}/images": { "get": { "tags": [ - "InAppPurchaseOfferCodes" + "InAppPurchases" ], - "operationId": "inAppPurchaseOfferCodes_customCodes_getToManyRelated", + "operationId": "inAppPurchasesV2_images_getToManyRelated", "parameters": [ { - "name": "fields[inAppPurchaseOfferCodeCustomCodes]", + "name": "fields[inAppPurchaseImages]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseOfferCodeCustomCodes", + "description": "the fields to include for returned resources of type inAppPurchaseImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customCode", - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "createdByActor", - "deactivatedByActor" + "fileSize", + "fileName", + "sourceFileChecksum", + "assetToken", + "imageAsset", + "uploadOperations", + "state", + "inAppPurchase" ] } }, @@ -160043,19 +165411,31 @@ "explode": false }, { - "name": "fields[actors]", + "name": "fields[inAppPurchases]", "in": "query", - "description": "the fields to include for returned resources of type actors", + "description": "the fields to include for returned resources of type inAppPurchases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "actorType", - "userFirstName", - "userLastName", - "userEmail", - "apiKeyId" + "name", + "productId", + "inAppPurchaseType", + "state", + "reviewNote", + "familySharable", + "contentHosting", + "inAppPurchaseLocalizations", + "pricePoints", + "content", + "appStoreReviewScreenshot", + "promotedPurchase", + "iapPriceSchedule", + "inAppPurchaseAvailability", + "images", + "offerCodes", + "versions" ] } }, @@ -160081,8 +165461,7 @@ "items": { "type": "string", "enum": [ - "createdByActor", - "deactivatedByActor" + "inAppPurchase" ] } }, @@ -160132,11 +165511,11 @@ } }, "200": { - "description": "List of InAppPurchaseOfferCodeCustomCodes", + "description": "List of InAppPurchaseImages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseOfferCodeCustomCodesResponse" + "$ref": "#/components/schemas/InAppPurchaseImagesResponse" } } } @@ -160166,24 +165545,13 @@ } ] }, - "/v1/inAppPurchaseOfferCodes/{id}/relationships/oneTimeUseCodes": { + "/v2/inAppPurchases/{id}/relationships/inAppPurchaseAvailability": { "get": { "tags": [ - "InAppPurchaseOfferCodes" - ], - "operationId": "inAppPurchaseOfferCodes_oneTimeUseCodes_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "InAppPurchases" ], + "operationId": "inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -160226,11 +165594,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseOfferCodeOneTimeUseCodesLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseV2InAppPurchaseAvailabilityLinkageResponse" } } } @@ -160260,30 +165628,24 @@ } ] }, - "/v1/inAppPurchaseOfferCodes/{id}/oneTimeUseCodes": { + "/v2/inAppPurchases/{id}/inAppPurchaseAvailability": { "get": { "tags": [ - "InAppPurchaseOfferCodes" + "InAppPurchases" ], - "operationId": "inAppPurchaseOfferCodes_oneTimeUseCodes_getToManyRelated", + "operationId": "inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelated", "parameters": [ { - "name": "fields[inAppPurchaseOfferCodeOneTimeUseCodes]", + "name": "fields[inAppPurchaseAvailabilities]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseOfferCodeOneTimeUseCodes", + "description": "the fields to include for returned resources of type inAppPurchaseAvailabilities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "environment", - "values", - "createdByActor", - "deactivatedByActor" + "availableInNewTerritories", + "availableTerritories" ] } }, @@ -160291,35 +165653,21 @@ "explode": false }, { - "name": "fields[actors]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type actors", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "actorType", - "userFirstName", - "userLastName", - "userEmail", - "apiKeyId" + "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", @@ -160329,13 +165677,22 @@ "items": { "type": "string", "enum": [ - "createdByActor", - "deactivatedByActor" + "availableTerritories" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[availableTerritories]", + "in": "query", + "description": "maximum number of related availableTerritories returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -160380,11 +165737,11 @@ } }, "200": { - "description": "List of InAppPurchaseOfferCodeOneTimeUseCodes", + "description": "Single InAppPurchaseAvailability", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseOfferCodeOneTimeUseCodesResponse" + "$ref": "#/components/schemas/InAppPurchaseAvailabilityResponse" } } } @@ -160414,12 +165771,12 @@ } ] }, - "/v1/inAppPurchaseOfferCodes/{id}/relationships/prices": { + "/v2/inAppPurchases/{id}/relationships/inAppPurchaseLocalizations": { "get": { "tags": [ - "InAppPurchaseOfferCodes" + "InAppPurchases" ], - "operationId": "inAppPurchaseOfferCodes_prices_getToManyRelationship", + "operationId": "inAppPurchasesV2_inAppPurchaseLocalizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -160478,7 +165835,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseOfferCodePricesLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseV2InAppPurchaseLocalizationsLinkagesResponse" } } } @@ -160508,53 +165865,27 @@ } ] }, - "/v1/inAppPurchaseOfferCodes/{id}/prices": { + "/v2/inAppPurchases/{id}/inAppPurchaseLocalizations": { "get": { "tags": [ - "InAppPurchaseOfferCodes" + "InAppPurchases" ], - "operationId": "inAppPurchaseOfferCodes_prices_getToManyRelated", + "operationId": "inAppPurchasesV2_inAppPurchaseLocalizations_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[inAppPurchaseOfferPrices]", - "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseOfferPrices", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "territory", - "pricePoint" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[territories]", + "name": "fields[inAppPurchaseLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type inAppPurchaseLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "name", + "locale", + "description", + "state", + "inAppPurchaseV2" ] } }, @@ -160562,18 +165893,31 @@ "explode": false }, { - "name": "fields[inAppPurchasePricePoints]", + "name": "fields[inAppPurchases]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchasePricePoints", + "description": "the fields to include for returned resources of type inAppPurchases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", - "territory", - "equalizations" + "name", + "productId", + "inAppPurchaseType", + "state", + "reviewNote", + "familySharable", + "contentHosting", + "inAppPurchaseLocalizations", + "pricePoints", + "content", + "appStoreReviewScreenshot", + "promotedPurchase", + "iapPriceSchedule", + "inAppPurchaseAvailability", + "images", + "offerCodes", + "versions" ] } }, @@ -160599,8 +165943,7 @@ "items": { "type": "string", "enum": [ - "territory", - "pricePoint" + "inAppPurchaseV2" ] } }, @@ -160650,11 +165993,11 @@ } }, "200": { - "description": "List of InAppPurchaseOfferPrices", + "description": "List of InAppPurchaseLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseOfferPricesResponse" + "$ref": "#/components/schemas/InAppPurchaseLocalizationsResponse" } } } @@ -160684,12 +166027,12 @@ } ] }, - "/v1/inAppPurchasePricePoints/{id}/relationships/equalizations": { + "/v2/inAppPurchases/{id}/relationships/offerCodes": { "get": { "tags": [ - "InAppPurchasePricePoints" + "InAppPurchases" ], - "operationId": "inAppPurchasePricePoints_equalizations_getToManyRelationship", + "operationId": "inAppPurchasesV2_offerCodes_getToManyRelationship", "parameters": [ { "name": "limit", @@ -160697,7 +166040,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 8000 + "maximum": 200 }, "style": "form" } @@ -160748,7 +166091,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasePricePointEqualizationsLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseV2OfferCodesLinkagesResponse" } } } @@ -160778,17 +166121,17 @@ } ] }, - "/v1/inAppPurchasePricePoints/{id}/equalizations": { + "/v2/inAppPurchases/{id}/offerCodes": { "get": { "tags": [ - "InAppPurchasePricePoints" + "InAppPurchases" ], - "operationId": "inAppPurchasePricePoints_equalizations_getToManyRelated", + "operationId": "inAppPurchasesV2_offerCodes_getToManyRelated", "parameters": [ { "name": "filter[territory]", "in": "query", - "description": "filter by id(s) of related 'territory'", + "description": "filter by territory", "schema": { "type": "array", "items": { @@ -160799,31 +166142,45 @@ "explode": false }, { - "name": "filter[inAppPurchaseV2]", + "name": "fields[inAppPurchaseOfferCodes]", "in": "query", - "description": "filter by id(s) of related 'inAppPurchaseV2'", + "description": "the fields to include for returned resources of type inAppPurchaseOfferCodes", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "name", + "customerEligibilities", + "productionCodeCount", + "sandboxCodeCount", + "active", + "oneTimeUseCodes", + "customCodes", + "prices" + ] } }, "style": "form", "explode": false }, { - "name": "fields[inAppPurchasePricePoints]", + "name": "fields[inAppPurchaseOfferCodeOneTimeUseCodes]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchasePricePoints", + "description": "the fields to include for returned resources of type inAppPurchaseOfferCodeOneTimeUseCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", - "territory", - "equalizations" + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "environment", + "values", + "createdByActor", + "deactivatedByActor" ] } }, @@ -160831,15 +166188,38 @@ "explode": false }, { - "name": "fields[territories]", + "name": "fields[inAppPurchaseOfferCodeCustomCodes]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type inAppPurchaseOfferCodeCustomCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "customCode", + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "createdByActor", + "deactivatedByActor" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[inAppPurchaseOfferPrices]", + "in": "query", + "description": "the fields to include for returned resources of type inAppPurchaseOfferPrices", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "territory", + "pricePoint" ] } }, @@ -160852,7 +166232,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 8000 + "maximum": 200 }, "style": "form" }, @@ -160865,12 +166245,44 @@ "items": { "type": "string", "enum": [ - "territory" + "oneTimeUseCodes", + "customCodes", + "prices" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[oneTimeUseCodes]", + "in": "query", + "description": "maximum number of related oneTimeUseCodes returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[customCodes]", + "in": "query", + "description": "maximum number of related customCodes returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[prices]", + "in": "query", + "description": "maximum number of related prices returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -160915,16 +166327,11 @@ } }, "200": { - "description": "List of InAppPurchasePricePoints", + "description": "List of InAppPurchaseOfferCodes", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasePricePointsResponse" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/csv" + "$ref": "#/components/schemas/InAppPurchaseOfferCodesResponse" } } } @@ -160954,12 +166361,12 @@ } ] }, - "/v1/inAppPurchasePriceSchedules/{id}/relationships/automaticPrices": { + "/v2/inAppPurchases/{id}/relationships/pricePoints": { "get": { "tags": [ - "InAppPurchasePriceSchedules" + "InAppPurchases" ], - "operationId": "inAppPurchasePriceSchedules_automaticPrices_getToManyRelationship", + "operationId": "inAppPurchasesV2_pricePoints_getToManyRelationship", "parameters": [ { "name": "limit", @@ -160967,7 +166374,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 200 + "maximum": 8000 }, "style": "form" } @@ -161018,7 +166425,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasePriceScheduleAutomaticPricesLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseV2PricePointsLinkagesResponse" } } } @@ -161048,12 +166455,12 @@ } ] }, - "/v1/inAppPurchasePriceSchedules/{id}/automaticPrices": { + "/v2/inAppPurchases/{id}/pricePoints": { "get": { "tags": [ - "InAppPurchasePriceSchedules" + "InAppPurchases" ], - "operationId": "inAppPurchasePriceSchedules_automaticPrices_getToManyRelated", + "operationId": "inAppPurchasesV2_pricePoints_getToManyRelated", "parameters": [ { "name": "filter[territory]", @@ -161068,26 +166475,6 @@ "style": "form", "explode": false }, - { - "name": "fields[inAppPurchasePrices]", - "in": "query", - "description": "the fields to include for returned resources of type inAppPurchasePrices", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "startDate", - "endDate", - "manual", - "inAppPurchasePricePoint", - "territory" - ] - } - }, - "style": "form", - "explode": false - }, { "name": "fields[inAppPurchasePricePoints]", "in": "query", @@ -161129,7 +166516,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 200 + "maximum": 8000 }, "style": "form" }, @@ -161142,7 +166529,6 @@ "items": { "type": "string", "enum": [ - "inAppPurchasePricePoint", "territory" ] } @@ -161193,11 +166579,16 @@ } }, "200": { - "description": "List of InAppPurchasePrices", + "description": "List of InAppPurchasePricePoints", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasePricesResponse" + "$ref": "#/components/schemas/InAppPurchasePricePointsResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/csv" } } } @@ -161227,12 +166618,12 @@ } ] }, - "/v1/inAppPurchasePriceSchedules/{id}/relationships/baseTerritory": { + "/v2/inAppPurchases/{id}/relationships/promotedPurchase": { "get": { "tags": [ - "InAppPurchasePriceSchedules" + "InAppPurchases" ], - "operationId": "inAppPurchasePriceSchedules_baseTerritory_getToOneRelationship", + "operationId": "inAppPurchasesV2_promotedPurchase_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -161280,7 +166671,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasePriceScheduleBaseTerritoryLinkageResponse" + "$ref": "#/components/schemas/InAppPurchaseV2PromotedPurchaseLinkageResponse" } } } @@ -161310,23 +166701,117 @@ } ] }, - "/v1/inAppPurchasePriceSchedules/{id}/baseTerritory": { + "/v2/inAppPurchases/{id}/promotedPurchase": { "get": { "tags": [ - "InAppPurchasePriceSchedules" + "InAppPurchases" ], - "operationId": "inAppPurchasePriceSchedules_baseTerritory_getToOneRelated", + "operationId": "inAppPurchasesV2_promotedPurchase_getToOneRelated", "parameters": [ { - "name": "fields[territories]", + "name": "fields[promotedPurchases]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type promotedPurchases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "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", + "versions" + ] + } + }, + "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", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "inAppPurchaseV2", + "subscription" ] } }, @@ -161376,11 +166861,11 @@ } }, "200": { - "description": "Single Territory", + "description": "Single PromotedPurchase", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoryResponse" + "$ref": "#/components/schemas/PromotedPurchaseResponse" } } } @@ -161410,12 +166895,12 @@ } ] }, - "/v1/inAppPurchasePriceSchedules/{id}/relationships/manualPrices": { + "/v2/inAppPurchases/{id}/relationships/versions": { "get": { "tags": [ - "InAppPurchasePriceSchedules" + "InAppPurchases" ], - "operationId": "inAppPurchasePriceSchedules_manualPrices_getToManyRelationship", + "operationId": "inAppPurchasesV2_versions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -161474,7 +166959,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasePriceScheduleManualPricesLinkagesResponse" + "$ref": "#/components/schemas/InAppPurchaseV2VersionsLinkagesResponse" } } } @@ -161504,40 +166989,52 @@ } ] }, - "/v1/inAppPurchasePriceSchedules/{id}/manualPrices": { + "/v2/inAppPurchases/{id}/versions": { "get": { "tags": [ - "InAppPurchasePriceSchedules" + "InAppPurchases" ], - "operationId": "inAppPurchasePriceSchedules_manualPrices_getToManyRelated", + "operationId": "inAppPurchasesV2_versions_getToManyRelated", "parameters": [ { - "name": "filter[territory]", + "name": "filter[state]", "in": "query", - "description": "filter by id(s) of related 'territory'", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "ACCEPTED", + "APPROVED", + "REPLACED_WITH_NEW_VERSION", + "REJECTED", + "DEVELOPER_REJECTED" + ] } }, "style": "form", "explode": false }, { - "name": "fields[inAppPurchasePrices]", + "name": "fields[inAppPurchaseVersions]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchasePrices", + "description": "the fields to include for returned resources of type inAppPurchaseVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "startDate", - "endDate", - "manual", - "inAppPurchasePricePoint", - "territory" + "version", + "state", + "inAppPurchase", + "image", + "images", + "localizations" ] } }, @@ -161545,18 +167042,31 @@ "explode": false }, { - "name": "fields[inAppPurchasePricePoints]", + "name": "fields[inAppPurchases]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchasePricePoints", + "description": "the fields to include for returned resources of type inAppPurchases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", - "territory", - "equalizations" + "name", + "productId", + "inAppPurchaseType", + "state", + "reviewNote", + "familySharable", + "contentHosting", + "inAppPurchaseLocalizations", + "pricePoints", + "content", + "appStoreReviewScreenshot", + "promotedPurchase", + "iapPriceSchedule", + "inAppPurchaseAvailability", + "images", + "offerCodes", + "versions" ] } }, @@ -161564,15 +167074,39 @@ "explode": false }, { - "name": "fields[territories]", + "name": "fields[inAppPurchaseImages]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type inAppPurchaseImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "fileSize", + "fileName", + "assetToken", + "imageAsset", + "uploadOperations", + "assetDeliveryState" + ] + } + }, + "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", + "version" ] } }, @@ -161598,13 +167132,35 @@ "items": { "type": "string", "enum": [ - "inAppPurchasePricePoint", - "territory" + "inAppPurchase", + "image", + "images", + "localizations" ] } }, "style": "form", "explode": false + }, + { + "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[localizations]", + "in": "query", + "description": "maximum number of related localizations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -161649,11 +167205,11 @@ } }, "200": { - "description": "List of InAppPurchasePrices", + "description": "List of InAppPurchaseVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasePricesResponse" + "$ref": "#/components/schemas/InAppPurchaseVersionsResponse" } } } @@ -161683,13 +167239,24 @@ } ] }, - "/v1/inAppPurchaseVersions/{id}/relationships/image": { + "/v1/merchantIds/{id}/relationships/certificates": { "get": { "tags": [ - "InAppPurchaseVersions" + "MerchantIds" + ], + "operationId": "merchantIds_certificates_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "inAppPurchaseVersions_image_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -161732,11 +167299,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseVersionImageLinkageResponse" + "$ref": "#/components/schemas/MerchantIdCertificatesLinkagesResponse" } } } @@ -161766,28 +167333,170 @@ } ] }, - "/v1/inAppPurchaseVersions/{id}/image": { + "/v1/merchantIds/{id}/certificates": { "get": { "tags": [ - "InAppPurchaseVersions" + "MerchantIds" ], - "operationId": "inAppPurchaseVersions_image_getToOneRelated", + "operationId": "merchantIds_certificates_getToManyRelated", "parameters": [ { - "name": "fields[inAppPurchaseImages]", + "name": "filter[displayName]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseImages", + "description": "filter by attribute 'displayName'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[certificateType]", + "in": "query", + "description": "filter by attribute 'certificateType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "assetToken", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "APPLE_PAY", + "APPLE_PAY_MERCHANT_IDENTITY", + "APPLE_PAY_PSP_IDENTITY", + "APPLE_PAY_RSA", + "DEVELOPER_ID_KEXT", + "DEVELOPER_ID_KEXT_G2", + "DEVELOPER_ID_APPLICATION", + "DEVELOPER_ID_APPLICATION_G2", + "DEVELOPMENT", + "DISTRIBUTION", + "IDENTITY_ACCESS", + "IOS_DEVELOPMENT", + "IOS_DISTRIBUTION", + "MAC_APP_DISTRIBUTION", + "MAC_INSTALLER_DISTRIBUTION", + "MAC_APP_DEVELOPMENT", + "PASS_TYPE_ID", + "PASS_TYPE_ID_WITH_NFC" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[serialNumber]", + "in": "query", + "description": "filter by attribute 'serialNumber'", + "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": [ + "displayName", + "-displayName", + "certificateType", + "-certificateType", + "serialNumber", + "-serialNumber", + "id", + "-id" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[certificates]", + "in": "query", + "description": "the fields to include for returned resources of type certificates", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "certificateType", + "displayName", + "serialNumber", + "platform", + "expirationDate", + "certificateContent", + "activated", + "passTypeId" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[passTypeIds]", + "in": "query", + "description": "the fields to include for returned resources of type passTypeIds", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "identifier", + "certificates" + ] + } + }, + "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": [ + "passTypeId" ] } }, @@ -161837,11 +167546,11 @@ } }, "200": { - "description": "Single InAppPurchaseImage", + "description": "List of Certificates", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseImageV2Response" + "$ref": "#/components/schemas/CertificatesResponse" } } } @@ -161871,12 +167580,12 @@ } ] }, - "/v1/inAppPurchaseVersions/{id}/relationships/images": { + "/v1/passTypeIds/{id}/relationships/certificates": { "get": { "tags": [ - "InAppPurchaseVersions" + "PassTypeIds" ], - "operationId": "inAppPurchaseVersions_images_getToManyRelationship", + "operationId": "passTypeIds_certificates_getToManyRelationship", "parameters": [ { "name": "limit", @@ -161935,7 +167644,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseVersionImagesLinkagesResponse" + "$ref": "#/components/schemas/PassTypeIdCertificatesLinkagesResponse" } } } @@ -161965,28 +167674,144 @@ } ] }, - "/v1/inAppPurchaseVersions/{id}/images": { + "/v1/passTypeIds/{id}/certificates": { "get": { "tags": [ - "InAppPurchaseVersions" + "PassTypeIds" ], - "operationId": "inAppPurchaseVersions_images_getToManyRelated", + "operationId": "passTypeIds_certificates_getToManyRelated", "parameters": [ { - "name": "fields[inAppPurchaseImages]", + "name": "filter[displayName]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseImages", + "description": "filter by attribute 'displayName'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[certificateType]", + "in": "query", + "description": "filter by attribute 'certificateType'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "assetToken", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "APPLE_PAY", + "APPLE_PAY_MERCHANT_IDENTITY", + "APPLE_PAY_PSP_IDENTITY", + "APPLE_PAY_RSA", + "DEVELOPER_ID_KEXT", + "DEVELOPER_ID_KEXT_G2", + "DEVELOPER_ID_APPLICATION", + "DEVELOPER_ID_APPLICATION_G2", + "DEVELOPMENT", + "DISTRIBUTION", + "IDENTITY_ACCESS", + "IOS_DEVELOPMENT", + "IOS_DISTRIBUTION", + "MAC_APP_DISTRIBUTION", + "MAC_INSTALLER_DISTRIBUTION", + "MAC_APP_DEVELOPMENT", + "PASS_TYPE_ID", + "PASS_TYPE_ID_WITH_NFC" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[serialNumber]", + "in": "query", + "description": "filter by attribute 'serialNumber'", + "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": [ + "displayName", + "-displayName", + "certificateType", + "-certificateType", + "serialNumber", + "-serialNumber", + "id", + "-id" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[certificates]", + "in": "query", + "description": "the fields to include for returned resources of type certificates", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "certificateType", + "displayName", + "serialNumber", + "platform", + "expirationDate", + "certificateContent", + "activated", + "passTypeId" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[passTypeIds]", + "in": "query", + "description": "the fields to include for returned resources of type passTypeIds", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "identifier", + "certificates" ] } }, @@ -162002,6 +167827,22 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "passTypeId" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -162046,11 +167887,11 @@ } }, "200": { - "description": "List of InAppPurchaseImages", + "description": "List of Certificates", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseImagesV2Response" + "$ref": "#/components/schemas/CertificatesResponse" } } } @@ -162080,24 +167921,13 @@ } ] }, - "/v1/inAppPurchaseVersions/{id}/relationships/localizations": { + "/v1/preReleaseVersions/{id}/relationships/app": { "get": { "tags": [ - "InAppPurchaseVersions" - ], - "operationId": "inAppPurchaseVersions_localizations_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "PreReleaseVersions" ], + "operationId": "preReleaseVersions_app_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -162140,11 +167970,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseVersionLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/PrereleaseVersionAppLinkageResponse" } } } @@ -162174,73 +168004,80 @@ } ] }, - "/v1/inAppPurchaseVersions/{id}/localizations": { + "/v1/preReleaseVersions/{id}/app": { "get": { "tags": [ - "InAppPurchaseVersions" + "PreReleaseVersions" ], - "operationId": "inAppPurchaseVersions_localizations_getToManyRelated", + "operationId": "preReleaseVersions_app_getToOneRelated", "parameters": [ { - "name": "fields[inAppPurchaseLocalizations]", + "name": "fields[apps]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseLocalizations", + "description": "the fields to include for returned resources of type apps", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "accessibilityUrl", "name", - "locale", - "description", - "version" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[inAppPurchaseVersions]", - "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "inAppPurchase", - "image", - "images", - "localizations" - ] - } - }, - "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": [ - "version" + "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", + "retentionMessages", + "gameCenterEnabledVersions", + "performanceOverviews", + "perfPowerMetrics", + "appCustomProductPages", + "inAppPurchasesV2", + "promotedPurchases", + "appEvents", + "reviewSubmissions", + "subscriptionGracePeriod", + "customerReviews", + "customerReviewSummarizations", + "gameCenterDetail", + "appStoreVersionExperimentsV2", + "alternativeDistributionKey", + "analyticsReportRequests", + "marketplaceSearchDetail", + "buildUploads", + "backgroundAssets", + "assetLibrary", + "betaFeedbackScreenshotSubmissions", + "betaFeedbackCrashSubmissions", + "searchKeywords", + "webhooks", + "androidToIosAppMappingDetails" ] } }, @@ -162290,11 +168127,11 @@ } }, "200": { - "description": "List of InAppPurchaseLocalizations", + "description": "Single App with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseLocalizationsV2Response" + "$ref": "#/components/schemas/AppWithoutIncludesResponse" } } } @@ -162324,13 +168161,24 @@ } ] }, - "/v2/inAppPurchases/{id}/relationships/appStoreReviewScreenshot": { + "/v1/preReleaseVersions/{id}/relationships/builds": { "get": { "tags": [ - "InAppPurchases" + "PreReleaseVersions" + ], + "operationId": "preReleaseVersions_builds_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -162373,11 +168221,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseV2AppStoreReviewScreenshotLinkageResponse" + "$ref": "#/components/schemas/PrereleaseVersionBuildsLinkagesResponse" } } } @@ -162407,63 +168255,48 @@ } ] }, - "/v2/inAppPurchases/{id}/appStoreReviewScreenshot": { + "/v1/preReleaseVersions/{id}/builds": { "get": { "tags": [ - "InAppPurchases" + "PreReleaseVersions" ], - "operationId": "inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelated", + "operationId": "preReleaseVersions_builds_getToManyRelated", "parameters": [ { - "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[inAppPurchases]", + "name": "fields[builds]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchases", + "description": "the fields to include for returned resources of type builds", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "inAppPurchaseType", - "state", - "reviewNote", - "familySharable", - "contentHosting", - "inAppPurchaseLocalizations", - "pricePoints", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", - "versions" + "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" ] } }, @@ -162471,20 +168304,14 @@ "explode": false }, { - "name": "include", + "name": "limit", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "inAppPurchaseV2" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" } ], "responses": { @@ -162529,11 +168356,11 @@ } }, "200": { - "description": "Single InAppPurchaseAppStoreReviewScreenshot", + "description": "List of Builds with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseAppStoreReviewScreenshotResponse" + "$ref": "#/components/schemas/BuildsWithoutIncludesResponse" } } } @@ -162563,12 +168390,12 @@ } ] }, - "/v2/inAppPurchases/{id}/relationships/content": { + "/v1/profiles/{id}/relationships/bundleId": { "get": { "tags": [ - "InAppPurchases" + "Profiles" ], - "operationId": "inAppPurchasesV2_content_getToOneRelationship", + "operationId": "profiles_bundleId_getToOneRelationship", "parameters": [], "responses": { "400": { @@ -162616,7 +168443,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseV2ContentLinkageResponse" + "$ref": "#/components/schemas/ProfileBundleIdLinkageResponse" } } } @@ -162646,75 +168473,29 @@ } ] }, - "/v2/inAppPurchases/{id}/content": { + "/v1/profiles/{id}/bundleId": { "get": { "tags": [ - "InAppPurchases" + "Profiles" ], - "operationId": "inAppPurchasesV2_content_getToOneRelated", + "operationId": "profiles_bundleId_getToOneRelated", "parameters": [ { - "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[inAppPurchases]", + "name": "fields[bundleIds]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchases", + "description": "the fields to include for returned resources of type bundleIds", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "productId", - "inAppPurchaseType", - "state", - "reviewNote", - "familySharable", - "contentHosting", - "inAppPurchaseLocalizations", - "pricePoints", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", - "versions" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "inAppPurchaseV2" + "platform", + "identifier", + "seedId", + "profiles", + "bundleIdCapabilities", + "app" ] } }, @@ -162764,11 +168545,11 @@ } }, "200": { - "description": "Single InAppPurchaseContent", + "description": "Single BundleId with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseContentResponse" + "$ref": "#/components/schemas/BundleIdWithoutIncludesResponse" } } } @@ -162798,13 +168579,24 @@ } ] }, - "/v2/inAppPurchases/{id}/relationships/iapPriceSchedule": { + "/v1/profiles/{id}/relationships/certificates": { "get": { "tags": [ - "InAppPurchases" + "Profiles" + ], + "operationId": "profiles_certificates_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "inAppPurchasesV2_iapPriceSchedule_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -162847,11 +168639,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseV2IapPriceScheduleLinkageResponse" + "$ref": "#/components/schemas/ProfileCertificatesLinkagesResponse" } } } @@ -162881,79 +168673,31 @@ } ] }, - "/v2/inAppPurchases/{id}/iapPriceSchedule": { + "/v1/profiles/{id}/certificates": { "get": { "tags": [ - "InAppPurchases" + "Profiles" ], - "operationId": "inAppPurchasesV2_iapPriceSchedule_getToOneRelated", + "operationId": "profiles_certificates_getToManyRelated", "parameters": [ { - "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[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[inAppPurchasePrices]", - "in": "query", - "description": "the fields to include for returned resources of type inAppPurchasePrices", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "startDate", - "endDate", - "manual", - "inAppPurchasePricePoint", - "territory" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "include", + "name": "fields[certificates]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type certificates", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "baseTerritory", - "manualPrices", - "automaticPrices" + "name", + "certificateType", + "displayName", + "serialNumber", + "platform", + "expirationDate", + "certificateContent", + "activated", + "passTypeId" ] } }, @@ -162961,22 +168705,12 @@ "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]", + "name": "limit", "in": "query", - "description": "maximum number of related automaticPrices returned (when they are included)", + "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 50 + "maximum": 200 }, "style": "form" } @@ -163023,11 +168757,11 @@ } }, "200": { - "description": "Single InAppPurchasePriceSchedule", + "description": "List of Certificates with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasePriceScheduleResponse" + "$ref": "#/components/schemas/CertificatesWithoutIncludesResponse" } } } @@ -163057,12 +168791,12 @@ } ] }, - "/v2/inAppPurchases/{id}/relationships/images": { + "/v1/profiles/{id}/relationships/devices": { "get": { "tags": [ - "InAppPurchases" + "Profiles" ], - "operationId": "inAppPurchasesV2_images_getToManyRelationship", + "operationId": "profiles_devices_getToManyRelationship", "parameters": [ { "name": "limit", @@ -163121,7 +168855,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseV2ImagesLinkagesResponse" + "$ref": "#/components/schemas/ProfileDevicesLinkagesResponse" } } } @@ -163151,62 +168885,29 @@ } ] }, - "/v2/inAppPurchases/{id}/images": { + "/v1/profiles/{id}/devices": { "get": { "tags": [ - "InAppPurchases" + "Profiles" ], - "operationId": "inAppPurchasesV2_images_getToManyRelated", + "operationId": "profiles_devices_getToManyRelated", "parameters": [ { - "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[inAppPurchases]", + "name": "fields[devices]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchases", + "description": "the fields to include for returned resources of type devices", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "productId", - "inAppPurchaseType", - "state", - "reviewNote", - "familySharable", - "contentHosting", - "inAppPurchaseLocalizations", - "pricePoints", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", - "versions" + "platform", + "udid", + "deviceClass", + "status", + "model", + "addedDate" ] } }, @@ -163222,22 +168923,6 @@ "maximum": 200 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "inAppPurchase" - ] - } - }, - "style": "form", - "explode": false } ], "responses": { @@ -163282,11 +168967,11 @@ } }, "200": { - "description": "List of InAppPurchaseImages", + "description": "List of Devices with get", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseImagesResponse" + "$ref": "#/components/schemas/DevicesWithoutIncludesResponse" } } } @@ -163316,13 +169001,24 @@ } ] }, - "/v2/inAppPurchases/{id}/relationships/inAppPurchaseAvailability": { + "/v1/retentionMessageVersions/{id}/relationships/localizations": { "get": { "tags": [ - "InAppPurchases" + "RetentionMessageVersions" + ], + "operationId": "retentionMessageVersions_localizations_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -163365,11 +169061,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseV2InAppPurchaseAvailabilityLinkageResponse" + "$ref": "#/components/schemas/RetentionMessageVersionLocalizationsLinkagesResponse" } } } @@ -163399,24 +169095,26 @@ } ] }, - "/v2/inAppPurchases/{id}/inAppPurchaseAvailability": { + "/v1/retentionMessageVersions/{id}/localizations": { "get": { "tags": [ - "InAppPurchases" + "RetentionMessageVersions" ], - "operationId": "inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelated", + "operationId": "retentionMessageVersions_localizations_getToManyRelated", "parameters": [ { - "name": "fields[inAppPurchaseAvailabilities]", + "name": "fields[retentionMessageLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseAvailabilities", + "description": "the fields to include for returned resources of type retentionMessageLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "availableInNewTerritories", - "availableTerritories" + "locale", + "header", + "body", + "retentionMessageVersion" ] } }, @@ -163424,21 +169122,34 @@ "explode": false }, { - "name": "fields[territories]", + "name": "fields[retentionMessageVersions]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type retentionMessageVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "state", + "retentionMessage", + "localizations", + "placement" ] } }, "style": "form", "explode": false }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, { "name": "include", "in": "query", @@ -163448,22 +169159,12 @@ "items": { "type": "string", "enum": [ - "availableTerritories" + "retentionMessageVersion" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[availableTerritories]", - "in": "query", - "description": "maximum number of related availableTerritories returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -163508,11 +169209,11 @@ } }, "200": { - "description": "Single InAppPurchaseAvailability", + "description": "List of RetentionMessageLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseAvailabilityResponse" + "$ref": "#/components/schemas/RetentionMessageLocalizationsResponse" } } } @@ -163542,24 +169243,13 @@ } ] }, - "/v2/inAppPurchases/{id}/relationships/inAppPurchaseLocalizations": { + "/v1/retentionMessageVersions/{id}/relationships/placement": { "get": { "tags": [ - "InAppPurchases" - ], - "operationId": "inAppPurchasesV2_inAppPurchaseLocalizations_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "RetentionMessageVersions" ], + "operationId": "retentionMessageVersions_placement_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -163602,11 +169292,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseV2InAppPurchaseLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/RetentionMessageVersionPlacementLinkageResponse" } } } @@ -163636,27 +169326,36 @@ } ] }, - "/v2/inAppPurchases/{id}/inAppPurchaseLocalizations": { + "/v1/retentionMessageVersions/{id}/placement": { "get": { "tags": [ - "InAppPurchases" + "RetentionMessageVersions" ], - "operationId": "inAppPurchasesV2_inAppPurchaseLocalizations_getToManyRelated", + "operationId": "retentionMessageVersions_placement_getToOneRelated", "parameters": [ { - "name": "fields[inAppPurchaseLocalizations]", + "name": "fields[appAssetLibraryPlacements]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseLocalizations", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "locale", - "description", + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", "state", - "inAppPurchaseV2" + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -163664,31 +169363,26 @@ "explode": false }, { - "name": "fields[inAppPurchases]", + "name": "fields[appAssetLibraryImages]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchases", + "description": "the fields to include for returned resources of type appAssetLibraryImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "inAppPurchaseType", + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", "state", - "reviewNote", - "familySharable", - "contentHosting", - "inAppPurchaseLocalizations", - "pricePoints", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", - "versions" + "stateDetails", + "uploadOperations", + "placements" ] } }, @@ -163696,14 +169390,144 @@ "explode": false }, { - "name": "limit", + "name": "fields[appAssetLibraryVideos]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", "schema": { - "type": "integer", - "maximum": 200 + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" + ] + } }, - "style": "form" + "style": "form", + "explode": false + }, + { + "name": "fields[appEventLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appEventLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "name", + "shortDescription", + "longDescription", + "appEvent", + "appEventScreenshots", + "appEventVideoClips", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "description", + "locale", + "keywords", + "marketingUrl", + "promotionalText", + "supportUrl", + "whatsNew", + "appStoreVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appCustomProductPageLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appCustomProductPageLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "promotionalText", + "appCustomProductPageVersion", + "appScreenshotSets", + "appPreviewSets", + "searchKeywords", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appStoreVersionExperimentTreatmentLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "locale", + "appStoreVersionExperimentTreatment", + "appScreenshotSets", + "appPreviewSets", + "placements" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[retentionMessageVersions]", + "in": "query", + "description": "the fields to include for returned resources of type retentionMessageVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "state", + "retentionMessage", + "localizations", + "placement" + ] + } + }, + "style": "form", + "explode": false }, { "name": "include", @@ -163714,7 +169538,13 @@ "items": { "type": "string", "enum": [ - "inAppPurchaseV2" + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -163764,11 +169594,11 @@ } }, "200": { - "description": "List of InAppPurchaseLocalizations", + "description": "Single AppAssetLibraryPlacement", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseLocalizationsResponse" + "$ref": "#/components/schemas/AppAssetLibraryPlacementResponse" } } } @@ -163798,12 +169628,12 @@ } ] }, - "/v2/inAppPurchases/{id}/relationships/offerCodes": { + "/v1/retentionMessages/{id}/relationships/subscriptions": { "get": { "tags": [ - "InAppPurchases" + "RetentionMessages" ], - "operationId": "inAppPurchasesV2_offerCodes_getToManyRelationship", + "operationId": "retentionMessages_subscriptions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -163862,7 +169692,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseV2OfferCodesLinkagesResponse" + "$ref": "#/components/schemas/RetentionMessageSubscriptionsLinkagesResponse" } } } @@ -163892,17 +169722,17 @@ } ] }, - "/v2/inAppPurchases/{id}/offerCodes": { + "/v1/retentionMessages/{id}/subscriptions": { "get": { "tags": [ - "InAppPurchases" + "RetentionMessages" ], - "operationId": "inAppPurchasesV2_offerCodes_getToManyRelated", + "operationId": "retentionMessages_subscriptions_getToManyRelated", "parameters": [ { - "name": "filter[territory]", + "name": "filter[productId]", "in": "query", - "description": "filter by territory", + "description": "filter by attribute 'productId'", "schema": { "type": "array", "items": { @@ -163913,9 +169743,215 @@ "explode": false }, { - "name": "fields[inAppPurchaseOfferCodes]", + "name": "filter[name]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseOfferCodes", + "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", + "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": [ + "name", + "-name" + ] + } + }, + "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", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionLocalizations]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionLocalizations", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "locale", + "description", + "state", + "subscription" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionAppStoreReviewScreenshots]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "imageAsset", + "assetToken", + "assetType", + "uploadOperations", + "assetDeliveryState", + "subscription" + ] + } + }, + "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", + "versions" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionIntroductoryOffers]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionIntroductoryOffers", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "startDate", + "endDate", + "duration", + "offerMode", + "numberOfPeriods", + "targetSubscriptionPlanType", + "subscription", + "territory", + "subscriptionPricePoint" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionPromotionalOffers]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPromotionalOffers", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "duration", + "name", + "numberOfPeriods", + "offerCode", + "offerMode", + "targetSubscriptionPlanType", + "subscription", + "prices" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionOfferCodes]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionOfferCodes", "schema": { "type": "array", "items": { @@ -163923,9 +169959,17 @@ "enum": [ "name", "customerEligibilities", + "offerEligibility", + "duration", + "offerMode", + "numberOfPeriods", + "totalNumberOfCodes", "productionCodeCount", "sandboxCodeCount", "active", + "autoRenewEnabled", + "targetSubscriptionPlanType", + "subscription", "oneTimeUseCodes", "customCodes", "prices" @@ -163936,22 +169980,147 @@ "explode": false }, { - "name": "fields[inAppPurchaseOfferCodeOneTimeUseCodes]", + "name": "fields[subscriptionPrices]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPrices", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "startDate", + "preserved", + "planType", + "territory", + "subscriptionPricePoint" + ] + } + }, + "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[subscriptionAvailabilities]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionAvailabilities", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "availableInNewTerritories", + "availableTerritories" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[winBackOffers]", + "in": "query", + "description": "the fields to include for returned resources of type winBackOffers", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "referenceName", + "offerId", + "duration", + "offerMode", + "periodCount", + "customerEligibilityPaidSubscriptionDurationInMonths", + "customerEligibilityTimeSinceLastSubscribedInMonths", + "customerEligibilityWaitBetweenOffersInMonths", + "startDate", + "endDate", + "priority", + "promotionIntent", + "targetSubscriptionPlanType", + "prices" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionImages]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "sourceFileChecksum", + "assetToken", + "imageAsset", + "uploadOperations", + "state", + "subscription" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionPlanAvailabilities]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPlanAvailabilities", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "availableInNewTerritories", + "planType", + "availableTerritories" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionVersions]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseOfferCodeOneTimeUseCodes", + "description": "the fields to include for returned resources of type subscriptionVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "environment", - "values", - "createdByActor", - "deactivatedByActor" + "version", + "state", + "subscription", + "image", + "images", + "localizations" ] } }, @@ -163959,21 +170128,24 @@ "explode": false }, { - "name": "fields[inAppPurchaseOfferCodeCustomCodes]", + "name": "fields[retentionOffers]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseOfferCodeCustomCodes", + "description": "the fields to include for returned resources of type retentionOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customCode", - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "createdByActor", - "deactivatedByActor" + "referenceName", + "offerId", + "duration", + "offerMode", + "periodCount", + "customerEligibilityPaidSubscriptionDurationInMonths", + "customerEligibilityWaitBetweenOffersInMonths", + "targetSubscriptionPlanType", + "subscription", + "prices" ] } }, @@ -163981,16 +170153,17 @@ "explode": false }, { - "name": "fields[inAppPurchaseOfferPrices]", + "name": "fields[retentionMessages]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseOfferPrices", + "description": "the fields to include for returned resources of type retentionMessages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "territory", - "pricePoint" + "referenceName", + "versions", + "subscriptions" ] } }, @@ -164016,9 +170189,22 @@ "items": { "type": "string", "enum": [ - "oneTimeUseCodes", - "customCodes", - "prices" + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -164026,9 +170212,9 @@ "explode": false }, { - "name": "limit[oneTimeUseCodes]", + "name": "limit[subscriptionLocalizations]", "in": "query", - "description": "maximum number of related oneTimeUseCodes returned (when they are included)", + "description": "maximum number of related subscriptionLocalizations returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -164036,9 +170222,29 @@ "style": "form" }, { - "name": "limit[customCodes]", + "name": "limit[introductoryOffers]", "in": "query", - "description": "maximum number of related customCodes returned (when they are included)", + "description": "maximum number of related introductoryOffers returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[promotionalOffers]", + "in": "query", + "description": "maximum number of related promotionalOffers 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 @@ -164054,6 +170260,66 @@ "maximum": 50 }, "style": "form" + }, + { + "name": "limit[winBackOffers]", + "in": "query", + "description": "maximum number of related winBackOffers 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[planAvailabilities]", + "in": "query", + "description": "maximum number of related planAvailabilities returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[versions]", + "in": "query", + "description": "maximum number of related versions returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[retentionOffers]", + "in": "query", + "description": "maximum number of related retentionOffers returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[retentionMessageOffers]", + "in": "query", + "description": "maximum number of related retentionMessageOffers returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -164098,11 +170364,11 @@ } }, "200": { - "description": "List of InAppPurchaseOfferCodes", + "description": "List of Subscriptions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseOfferCodesResponse" + "$ref": "#/components/schemas/SubscriptionsResponse" } } } @@ -164132,12 +170398,12 @@ } ] }, - "/v2/inAppPurchases/{id}/relationships/pricePoints": { + "/v1/retentionMessages/{id}/relationships/versions": { "get": { "tags": [ - "InAppPurchases" + "RetentionMessages" ], - "operationId": "inAppPurchasesV2_pricePoints_getToManyRelationship", + "operationId": "retentionMessages_versions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -164145,7 +170411,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 8000 + "maximum": 200 }, "style": "form" } @@ -164196,7 +170462,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseV2PricePointsLinkagesResponse" + "$ref": "#/components/schemas/RetentionMessageVersionsLinkagesResponse" } } } @@ -164226,39 +170492,44 @@ } ] }, - "/v2/inAppPurchases/{id}/pricePoints": { + "/v1/retentionMessages/{id}/versions": { "get": { "tags": [ - "InAppPurchases" + "RetentionMessages" ], - "operationId": "inAppPurchasesV2_pricePoints_getToManyRelated", + "operationId": "retentionMessages_versions_getToManyRelated", "parameters": [ { - "name": "filter[territory]", + "name": "fields[retentionMessageVersions]", "in": "query", - "description": "filter by id(s) of related 'territory'", + "description": "the fields to include for returned resources of type retentionMessageVersions", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "state", + "retentionMessage", + "localizations", + "placement" + ] } }, "style": "form", "explode": false }, { - "name": "fields[inAppPurchasePricePoints]", + "name": "fields[retentionMessages]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchasePricePoints", + "description": "the fields to include for returned resources of type retentionMessages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", - "territory", - "equalizations" + "referenceName", + "versions", + "subscriptions" ] } }, @@ -164266,15 +170537,47 @@ "explode": false }, { - "name": "fields[territories]", + "name": "fields[retentionMessageLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type retentionMessageLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "locale", + "header", + "body", + "retentionMessageVersion" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[appAssetLibraryPlacements]", + "in": "query", + "description": "the fields to include for returned resources of type appAssetLibraryPlacements", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mediaType", + "placementType", + "placementGroup", + "createdDate", + "lastModifiedDate", + "state", + "stateDetails", + "image", + "video", + "appEventLocalization", + "appStoreVersionLocalization", + "appCustomProductPageLocalization", + "appStoreVersionExperimentTreatmentLocalization", + "retentionMessageVersion" ] } }, @@ -164287,7 +170590,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 8000 + "maximum": 200 }, "style": "form" }, @@ -164300,12 +170603,24 @@ "items": { "type": "string", "enum": [ - "territory" + "retentionMessage", + "localizations", + "placement" ] } }, "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": { @@ -164350,16 +170665,11 @@ } }, "200": { - "description": "List of InAppPurchasePricePoints", + "description": "List of RetentionMessageVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchasePricePointsResponse" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/csv" + "$ref": "#/components/schemas/RetentionMessageVersionsResponse" } } } @@ -164389,13 +170699,24 @@ } ] }, - "/v2/inAppPurchases/{id}/relationships/promotedPurchase": { + "/v1/retentionOffers/{id}/relationships/prices": { "get": { "tags": [ - "InAppPurchases" + "RetentionOffers" + ], + "operationId": "retentionOffers_prices_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "inAppPurchasesV2_promotedPurchase_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -164438,11 +170759,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseV2PromotedPurchaseLinkageResponse" + "$ref": "#/components/schemas/RetentionOfferPricesLinkagesResponse" } } } @@ -164472,27 +170793,37 @@ } ] }, - "/v2/inAppPurchases/{id}/promotedPurchase": { + "/v1/retentionOffers/{id}/prices": { "get": { "tags": [ - "InAppPurchases" + "RetentionOffers" ], - "operationId": "inAppPurchasesV2_promotedPurchase_getToOneRelated", + "operationId": "retentionOffers_prices_getToManyRelated", "parameters": [ { - "name": "fields[promotedPurchases]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type promotedPurchases", + "description": "filter by id(s) of related 'territory'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[retentionOfferPrices]", + "in": "query", + "description": "the fields to include for returned resources of type retentionOfferPrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "visibleForAllUsers", - "enabled", - "state", - "inAppPurchaseV2", - "subscription" + "territory", + "subscriptionPricePoint" ] } }, @@ -164500,31 +170831,15 @@ "explode": false }, { - "name": "fields[inAppPurchases]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchases", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "inAppPurchaseType", - "state", - "reviewNote", - "familySharable", - "contentHosting", - "inAppPurchaseLocalizations", - "pricePoints", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", - "versions" + "currency" ] } }, @@ -164532,43 +170847,36 @@ "explode": false }, { - "name": "fields[subscriptions]", + "name": "fields[subscriptionPricePoints]", "in": "query", - "description": "the fields to include for returned resources of type subscriptions", + "description": "the fields to include for returned resources of type subscriptionPricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "familySharable", - "state", - "subscriptionPeriod", - "reviewNote", - "groupLevel", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" + "customerPrice", + "proceeds", + "proceedsYear2", + "territory", + "equalizations", + "adjustedEqualizations" ] } }, "style": "form", "explode": false }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, { "name": "include", "in": "query", @@ -164578,8 +170886,8 @@ "items": { "type": "string", "enum": [ - "inAppPurchaseV2", - "subscription" + "territory", + "subscriptionPricePoint" ] } }, @@ -164629,11 +170937,11 @@ } }, "200": { - "description": "Single PromotedPurchase", + "description": "List of RetentionOfferPrices", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotedPurchaseResponse" + "$ref": "#/components/schemas/RetentionOfferPricesResponse" } } } @@ -164663,12 +170971,12 @@ } ] }, - "/v2/inAppPurchases/{id}/relationships/versions": { + "/v1/reviewSubmissions/{id}/relationships/items": { "get": { "tags": [ - "InAppPurchases" + "ReviewSubmissions" ], - "operationId": "inAppPurchasesV2_versions_getToManyRelationship", + "operationId": "reviewSubmissions_items_getToManyRelationship", "parameters": [ { "name": "limit", @@ -164727,7 +171035,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InAppPurchaseV2VersionsLinkagesResponse" + "$ref": "#/components/schemas/ReviewSubmissionItemsLinkagesResponse" } } } @@ -164757,31 +171065,40 @@ } ] }, - "/v2/inAppPurchases/{id}/versions": { + "/v1/reviewSubmissions/{id}/items": { "get": { "tags": [ - "InAppPurchases" + "ReviewSubmissions" ], - "operationId": "inAppPurchasesV2_versions_getToManyRelated", + "operationId": "reviewSubmissions_items_getToManyRelated", "parameters": [ { - "name": "filter[state]", + "name": "fields[reviewSubmissionItems]", "in": "query", - "description": "filter by attribute 'state'", + "description": "the fields to include for returned resources of type reviewSubmissionItems", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "PREPARE_FOR_SUBMISSION", - "READY_FOR_REVIEW", - "WAITING_FOR_REVIEW", - "IN_REVIEW", - "ACCEPTED", - "APPROVED", - "REPLACED_WITH_NEW_VERSION", - "REJECTED", - "DEVELOPER_REJECTED" + "state", + "appStoreVersion", + "appCustomProductPageVersion", + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", + "backgroundAssetVersion", + "gameCenterAchievementVersion", + "gameCenterActivityVersion", + "gameCenterChallengeVersion", + "gameCenterLeaderboardSetVersion", + "gameCenterLeaderboardVersion", + "inAppPurchaseVersion", + "subscriptionVersion", + "subscriptionGroupVersion", + "retentionMessageVersion" ] } }, @@ -164789,20 +171106,38 @@ "explode": false }, { - "name": "fields[inAppPurchaseVersions]", + "name": "fields[appStoreVersions]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseVersions", + "description": "the fields to include for returned resources of type appStoreVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "inAppPurchase", - "image", - "images", - "localizations" + "platform", + "versionString", + "appStoreState", + "appVersionState", + "copyright", + "reviewType", + "releaseType", + "earliestReleaseDate", + "usesIdfa", + "downloadable", + "createdDate", + "app", + "appStoreVersionLocalizations", + "build", + "appStoreVersionPhasedRelease", + "gameCenterAppVersion", + "routingAppCoverage", + "appStoreReviewDetail", + "appStoreVersionSubmission", + "appClipDefaultExperience", + "appStoreVersionExperiments", + "appStoreVersionExperimentsV2", + "customerReviews", + "alternativeDistributionPackage" ] } }, @@ -164810,31 +171145,19 @@ "explode": false }, { - "name": "fields[inAppPurchases]", + "name": "fields[appCustomProductPageVersions]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchases", + "description": "the fields to include for returned resources of type appCustomProductPageVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "inAppPurchaseType", + "version", "state", - "reviewNote", - "familySharable", - "contentHosting", - "inAppPurchaseLocalizations", - "pricePoints", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", - "versions" + "deepLink", + "appCustomProductPage", + "appCustomProductPageLocalizations" ] } }, @@ -164842,20 +171165,26 @@ "explode": false }, { - "name": "fields[inAppPurchaseImages]", + "name": "fields[appStoreVersionExperiments]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseImages", + "description": "the fields to include for returned resources of type appStoreVersionExperiments", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "assetToken", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "name", + "trafficProportion", + "state", + "reviewRequired", + "startDate", + "endDate", + "appStoreVersion", + "appStoreVersionExperimentTreatments", + "platform", + "app", + "latestControlVersion", + "controlVersions" ] } }, @@ -164863,18 +171192,25 @@ "explode": false }, { - "name": "fields[inAppPurchaseLocalizations]", + "name": "fields[appEvents]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseLocalizations", + "description": "the fields to include for returned resources of type appEvents", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "locale", - "description", - "version" + "referenceName", + "badge", + "eventState", + "deepLink", + "purchaseRequirement", + "primaryLocale", + "priority", + "purpose", + "territorySchedules", + "archivedTerritorySchedules", + "localizations" ] } }, @@ -164882,28 +171218,55 @@ "explode": false }, { - "name": "limit", + "name": "fields[appAssetLibraryImages]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type appAssetLibraryImages", "schema": { - "type": "integer", - "maximum": 200 + "type": "array", + "items": { + "type": "string", + "enum": [ + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "imageAsset", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "placements" + ] + } }, - "style": "form" + "style": "form", + "explode": false }, { - "name": "include", + "name": "fields[appAssetLibraryVideos]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type appAssetLibraryVideos", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "inAppPurchase", - "image", - "images", - "localizations" + "category", + "createdDate", + "lastModifiedDate", + "fileName", + "fileSize", + "previewFrameImage", + "previewFrameTimeCode", + "referenceName", + "specId", + "state", + "stateDetails", + "uploadOperations", + "videoAsset", + "placements" ] } }, @@ -164911,243 +171274,108 @@ "explode": false }, { - "name": "limit[images]", + "name": "fields[backgroundAssetVersions]", "in": "query", - "description": "maximum number of related images returned (when they are included)", + "description": "the fields to include for returned resources of type backgroundAssetVersions", "schema": { - "type": "integer", - "maximum": 50 + "type": "array", + "items": { + "type": "string", + "enum": [ + "createdDate", + "platforms", + "state", + "stateDetails", + "version", + "locale", + "backgroundAsset", + "internalBetaRelease", + "externalBetaRelease", + "appStoreRelease", + "assetFile", + "manifestFile", + "backgroundAssetUploadFiles" + ] + } }, - "style": "form" + "style": "form", + "explode": false }, { - "name": "limit[localizations]", + "name": "fields[gameCenterAchievementVersions]", "in": "query", - "description": "maximum number of related localizations returned (when they are included)", + "description": "the fields to include for returned resources of type gameCenterAchievementVersions", "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 InAppPurchaseVersions", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InAppPurchaseVersionsResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "achievement", + "localizations" + ] } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + }, + "style": "form", + "explode": false }, - "style": "simple", - "required": true - } - ] - }, - "/v1/merchantIds/{id}/relationships/certificates": { - "get": { - "tags": [ - "MerchantIds" - ], - "operationId": "merchantIds_certificates_getToManyRelationship", - "parameters": [ { - "name": "limit", + "name": "fields[gameCenterActivityVersions]", "in": "query", - "description": "maximum resources per page", + "description": "the fields to include for returned resources of type gameCenterActivityVersions", "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/MerchantIdCertificatesLinkagesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "fallbackUrl", + "activity", + "localizations", + "defaultImage", + "releases" + ] } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + }, + "style": "form", + "explode": false }, - "style": "simple", - "required": true - } - ] - }, - "/v1/merchantIds/{id}/certificates": { - "get": { - "tags": [ - "MerchantIds" - ], - "operationId": "merchantIds_certificates_getToManyRelated", - "parameters": [ { - "name": "filter[displayName]", + "name": "fields[gameCenterChallengeVersions]", "in": "query", - "description": "filter by attribute 'displayName'", + "description": "the fields to include for returned resources of type gameCenterChallengeVersions", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "version", + "state", + "challenge", + "localizations", + "releases", + "defaultImage" + ] } }, "style": "form", "explode": false }, { - "name": "filter[certificateType]", + "name": "fields[gameCenterLeaderboardSetVersions]", "in": "query", - "description": "filter by attribute 'certificateType'", + "description": "the fields to include for returned resources of type gameCenterLeaderboardSetVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "APPLE_PAY", - "APPLE_PAY_MERCHANT_IDENTITY", - "APPLE_PAY_PSP_IDENTITY", - "APPLE_PAY_RSA", - "DEVELOPER_ID_KEXT", - "DEVELOPER_ID_KEXT_G2", - "DEVELOPER_ID_APPLICATION", - "DEVELOPER_ID_APPLICATION_G2", - "DEVELOPMENT", - "DISTRIBUTION", - "IDENTITY_ACCESS", - "IOS_DEVELOPMENT", - "IOS_DISTRIBUTION", - "MAC_APP_DISTRIBUTION", - "MAC_INSTALLER_DISTRIBUTION", - "MAC_APP_DEVELOPMENT", - "PASS_TYPE_ID", - "PASS_TYPE_ID_WITH_NFC" + "version", + "state", + "leaderboardSet", + "localizations" ] } }, @@ -165155,48 +171383,60 @@ "explode": false }, { - "name": "filter[serialNumber]", + "name": "fields[gameCenterLeaderboardVersions]", "in": "query", - "description": "filter by attribute 'serialNumber'", + "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "version", + "state", + "leaderboard", + "localizations" + ] } }, "style": "form", "explode": false }, { - "name": "filter[id]", + "name": "fields[inAppPurchaseVersions]", "in": "query", - "description": "filter by id(s)", + "description": "the fields to include for returned resources of type inAppPurchaseVersions", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "version", + "state", + "inAppPurchase", + "image", + "images", + "localizations" + ] } }, "style": "form", "explode": false }, { - "name": "sort", + "name": "fields[subscriptionVersions]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type subscriptionVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "displayName", - "-displayName", - "certificateType", - "-certificateType", - "serialNumber", - "-serialNumber", - "id", - "-id" + "version", + "state", + "subscription", + "image", + "images", + "localizations" ] } }, @@ -165204,23 +171444,18 @@ "explode": false }, { - "name": "fields[certificates]", + "name": "fields[subscriptionGroupVersions]", "in": "query", - "description": "the fields to include for returned resources of type certificates", + "description": "the fields to include for returned resources of type subscriptionGroupVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "certificateType", - "displayName", - "serialNumber", - "platform", - "expirationDate", - "certificateContent", - "activated", - "passTypeId" + "version", + "state", + "subscriptionGroup", + "localizations" ] } }, @@ -165228,17 +171463,18 @@ "explode": false }, { - "name": "fields[passTypeIds]", + "name": "fields[retentionMessageVersions]", "in": "query", - "description": "the fields to include for returned resources of type passTypeIds", + "description": "the fields to include for returned resources of type retentionMessageVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "identifier", - "certificates" + "state", + "retentionMessage", + "localizations", + "placement" ] } }, @@ -165264,7 +171500,23 @@ "items": { "type": "string", "enum": [ - "passTypeId" + "appStoreVersion", + "appCustomProductPageVersion", + "appStoreVersionExperiment", + "appStoreVersionExperimentV2", + "appEvent", + "appAssetLibraryImage", + "appAssetLibraryVideo", + "backgroundAssetVersion", + "gameCenterAchievementVersion", + "gameCenterActivityVersion", + "gameCenterChallengeVersion", + "gameCenterLeaderboardSetVersion", + "gameCenterLeaderboardVersion", + "inAppPurchaseVersion", + "subscriptionVersion", + "subscriptionGroupVersion", + "retentionMessageVersion" ] } }, @@ -165314,11 +171566,11 @@ } }, "200": { - "description": "List of Certificates", + "description": "List of ReviewSubmissionItems", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CertificatesResponse" + "$ref": "#/components/schemas/ReviewSubmissionItemsResponse" } } } @@ -165348,12 +171600,12 @@ } ] }, - "/v1/passTypeIds/{id}/relationships/certificates": { + "/v1/scmProviders/{id}/relationships/repositories": { "get": { "tags": [ - "PassTypeIds" + "ScmProviders" ], - "operationId": "passTypeIds_certificates_getToManyRelationship", + "operationId": "scmProviders_repositories_getToManyRelationship", "parameters": [ { "name": "limit", @@ -165412,7 +171664,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PassTypeIdCertificatesLinkagesResponse" + "$ref": "#/components/schemas/ScmProviderRepositoriesLinkagesResponse" } } } @@ -165442,72 +171694,13 @@ } ] }, - "/v1/passTypeIds/{id}/certificates": { + "/v1/scmProviders/{id}/repositories": { "get": { "tags": [ - "PassTypeIds" + "ScmProviders" ], - "operationId": "passTypeIds_certificates_getToManyRelated", + "operationId": "scmProviders_repositories_getToManyRelated", "parameters": [ - { - "name": "filter[displayName]", - "in": "query", - "description": "filter by attribute 'displayName'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[certificateType]", - "in": "query", - "description": "filter by attribute 'certificateType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "APPLE_PAY", - "APPLE_PAY_MERCHANT_IDENTITY", - "APPLE_PAY_PSP_IDENTITY", - "APPLE_PAY_RSA", - "DEVELOPER_ID_KEXT", - "DEVELOPER_ID_KEXT_G2", - "DEVELOPER_ID_APPLICATION", - "DEVELOPER_ID_APPLICATION_G2", - "DEVELOPMENT", - "DISTRIBUTION", - "IDENTITY_ACCESS", - "IOS_DEVELOPMENT", - "IOS_DISTRIBUTION", - "MAC_APP_DISTRIBUTION", - "MAC_INSTALLER_DISTRIBUTION", - "MAC_APP_DEVELOPMENT", - "PASS_TYPE_ID", - "PASS_TYPE_ID_WITH_NFC" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[serialNumber]", - "in": "query", - "description": "filter by attribute 'serialNumber'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, { "name": "filter[id]", "in": "query", @@ -165522,22 +171715,23 @@ "explode": false }, { - "name": "sort", + "name": "fields[scmRepositories]", "in": "query", - "description": "comma-separated list of sort expressions; resources will be sorted as specified", + "description": "the fields to include for returned resources of type scmRepositories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "displayName", - "-displayName", - "certificateType", - "-certificateType", - "serialNumber", - "-serialNumber", - "id", - "-id" + "lastAccessedDate", + "httpCloneUrl", + "sshCloneUrl", + "ownerName", + "repositoryName", + "scmProvider", + "defaultBranch", + "gitReferences", + "pullRequests" ] } }, @@ -165545,23 +171739,17 @@ "explode": false }, { - "name": "fields[certificates]", + "name": "fields[scmProviders]", "in": "query", - "description": "the fields to include for returned resources of type certificates", + "description": "the fields to include for returned resources of type scmProviders", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "certificateType", - "displayName", - "serialNumber", - "platform", - "expirationDate", - "certificateContent", - "activated", - "passTypeId" + "scmProviderType", + "url", + "repositories" ] } }, @@ -165569,17 +171757,19 @@ "explode": false }, { - "name": "fields[passTypeIds]", + "name": "fields[scmGitReferences]", "in": "query", - "description": "the fields to include for returned resources of type passTypeIds", + "description": "the fields to include for returned resources of type scmGitReferences", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "identifier", - "certificates" + "canonicalName", + "isDeleted", + "kind", + "repository" ] } }, @@ -165605,7 +171795,8 @@ "items": { "type": "string", "enum": [ - "passTypeId" + "scmProvider", + "defaultBranch" ] } }, @@ -165655,11 +171846,11 @@ } }, "200": { - "description": "List of Certificates", + "description": "List of ScmRepositories", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CertificatesResponse" + "$ref": "#/components/schemas/ScmRepositoriesResponse" } } } @@ -165689,13 +171880,24 @@ } ] }, - "/v1/preReleaseVersions/{id}/relationships/app": { + "/v1/scmRepositories/{id}/relationships/gitReferences": { "get": { "tags": [ - "PreReleaseVersions" + "ScmRepositories" + ], + "operationId": "scmRepositories_gitReferences_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "preReleaseVersions_app_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -165738,11 +171940,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PrereleaseVersionAppLinkageResponse" + "$ref": "#/components/schemas/ScmRepositoryGitReferencesLinkagesResponse" } } } @@ -165772,79 +171974,77 @@ } ] }, - "/v1/preReleaseVersions/{id}/app": { + "/v1/scmRepositories/{id}/gitReferences": { "get": { "tags": [ - "PreReleaseVersions" + "ScmRepositories" ], - "operationId": "preReleaseVersions_app_getToOneRelated", + "operationId": "scmRepositories_gitReferences_getToManyRelated", "parameters": [ { - "name": "fields[apps]", + "name": "fields[scmGitReferences]", "in": "query", - "description": "the fields to include for returned resources of type apps", + "description": "the fields to include for returned resources of type scmGitReferences", "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", - "performanceOverviews", - "perfPowerMetrics", - "appCustomProductPages", - "inAppPurchasesV2", - "promotedPurchases", - "appEvents", - "reviewSubmissions", - "subscriptionGracePeriod", - "customerReviews", - "customerReviewSummarizations", - "gameCenterDetail", - "appStoreVersionExperimentsV2", - "alternativeDistributionKey", - "analyticsReportRequests", - "marketplaceSearchDetail", - "buildUploads", - "backgroundAssets", - "assetLibrary", - "betaFeedbackScreenshotSubmissions", - "betaFeedbackCrashSubmissions", - "searchKeywords", - "webhooks", - "androidToIosAppMappingDetails" + "canonicalName", + "isDeleted", + "kind", + "repository" + ] + } + }, + "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": "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": [ + "repository" ] } }, @@ -165894,11 +172094,11 @@ } }, "200": { - "description": "Single App with get", + "description": "List of ScmGitReferences", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppWithoutIncludesResponse" + "$ref": "#/components/schemas/ScmGitReferencesResponse" } } } @@ -165928,12 +172128,12 @@ } ] }, - "/v1/preReleaseVersions/{id}/relationships/builds": { + "/v1/scmRepositories/{id}/relationships/pullRequests": { "get": { "tags": [ - "PreReleaseVersions" + "ScmRepositories" ], - "operationId": "preReleaseVersions_builds_getToManyRelationship", + "operationId": "scmRepositories_pullRequests_getToManyRelationship", "parameters": [ { "name": "limit", @@ -165992,7 +172192,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PrereleaseVersionBuildsLinkagesResponse" + "$ref": "#/components/schemas/ScmRepositoryPullRequestsLinkagesResponse" } } } @@ -166022,48 +172222,58 @@ } ] }, - "/v1/preReleaseVersions/{id}/builds": { + "/v1/scmRepositories/{id}/pullRequests": { "get": { "tags": [ - "PreReleaseVersions" + "ScmRepositories" ], - "operationId": "preReleaseVersions_builds_getToManyRelated", + "operationId": "scmRepositories_pullRequests_getToManyRelated", "parameters": [ { - "name": "fields[builds]", + "name": "fields[scmPullRequests]", "in": "query", - "description": "the fields to include for returned resources of type builds", + "description": "the fields to include for returned resources of type scmPullRequests", "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" + "title", + "number", + "webUrl", + "sourceRepositoryOwner", + "sourceRepositoryName", + "sourceBranchName", + "destinationRepositoryOwner", + "destinationRepositoryName", + "destinationBranchName", + "isClosed", + "isCrossRepository", + "repository" + ] + } + }, + "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" ] } }, @@ -166079,6 +172289,22 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "repository" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -166123,11 +172349,11 @@ } }, "200": { - "description": "List of Builds with get", + "description": "List of ScmPullRequests", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BuildsWithoutIncludesResponse" + "$ref": "#/components/schemas/ScmPullRequestsResponse" } } } @@ -166157,13 +172383,25 @@ } ] }, - "/v1/profiles/{id}/relationships/bundleId": { + "/v1/subscriptionAvailabilities/{id}/relationships/availableTerritories": { "get": { "tags": [ - "Profiles" + "SubscriptionAvailabilities" + ], + "operationId": "subscriptionAvailabilities_availableTerritories_getToManyRelationship", + "deprecated": true, + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "profiles_bundleId_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -166206,11 +172444,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProfileBundleIdLinkageResponse" + "$ref": "#/components/schemas/SubscriptionAvailabilityAvailableTerritoriesLinkagesResponse" } } } @@ -166240,34 +172478,39 @@ } ] }, - "/v1/profiles/{id}/bundleId": { + "/v1/subscriptionAvailabilities/{id}/availableTerritories": { "get": { "tags": [ - "Profiles" + "SubscriptionAvailabilities" ], - "operationId": "profiles_bundleId_getToOneRelated", + "operationId": "subscriptionAvailabilities_availableTerritories_getToManyRelated", + "deprecated": true, "parameters": [ { - "name": "fields[bundleIds]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type bundleIds", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "platform", - "identifier", - "seedId", - "profiles", - "bundleIdCapabilities", - "app" + "currency" ] } }, "style": "form", "explode": false + }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" } ], "responses": { @@ -166312,11 +172555,11 @@ } }, "200": { - "description": "Single BundleId with get", + "description": "List of Territories", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BundleIdWithoutIncludesResponse" + "$ref": "#/components/schemas/TerritoriesResponse" } } } @@ -166346,12 +172589,12 @@ } ] }, - "/v1/profiles/{id}/relationships/certificates": { + "/v1/subscriptionGroupVersions/{id}/relationships/localizations": { "get": { "tags": [ - "Profiles" + "SubscriptionGroupVersions" ], - "operationId": "profiles_certificates_getToManyRelationship", + "operationId": "subscriptionGroupVersions_localizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -166410,7 +172653,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProfileCertificatesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionGroupVersionLocalizationsLinkagesResponse" } } } @@ -166440,31 +172683,45 @@ } ] }, - "/v1/profiles/{id}/certificates": { + "/v1/subscriptionGroupVersions/{id}/localizations": { "get": { "tags": [ - "Profiles" + "SubscriptionGroupVersions" ], - "operationId": "profiles_certificates_getToManyRelated", + "operationId": "subscriptionGroupVersions_localizations_getToManyRelated", "parameters": [ { - "name": "fields[certificates]", + "name": "fields[subscriptionGroupLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type certificates", + "description": "the fields to include for returned resources of type subscriptionGroupLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "certificateType", - "displayName", - "serialNumber", - "platform", - "expirationDate", - "certificateContent", - "activated", - "passTypeId" + "customAppName", + "locale", + "version" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionGroupVersions]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionGroupVersions", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version", + "state", + "subscriptionGroup", + "localizations" ] } }, @@ -166480,6 +172737,22 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "version" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -166524,11 +172797,11 @@ } }, "200": { - "description": "List of Certificates with get", + "description": "List of SubscriptionGroupLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CertificatesWithoutIncludesResponse" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationsV2Response" } } } @@ -166558,12 +172831,12 @@ } ] }, - "/v1/profiles/{id}/relationships/devices": { + "/v1/subscriptionGroups/{id}/relationships/subscriptionGroupLocalizations": { "get": { "tags": [ - "Profiles" + "SubscriptionGroups" ], - "operationId": "profiles_devices_getToManyRelationship", + "operationId": "subscriptionGroups_subscriptionGroupLocalizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -166622,7 +172895,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProfileDevicesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionGroupSubscriptionGroupLocalizationsLinkagesResponse" } } } @@ -166652,29 +172925,46 @@ } ] }, - "/v1/profiles/{id}/devices": { + "/v1/subscriptionGroups/{id}/subscriptionGroupLocalizations": { "get": { "tags": [ - "Profiles" + "SubscriptionGroups" ], - "operationId": "profiles_devices_getToManyRelated", + "operationId": "subscriptionGroups_subscriptionGroupLocalizations_getToManyRelated", "parameters": [ { - "name": "fields[devices]", + "name": "fields[subscriptionGroupLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type devices", + "description": "the fields to include for returned resources of type subscriptionGroupLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "platform", - "udid", - "deviceClass", - "status", - "model", - "addedDate" + "customAppName", + "locale", + "state", + "subscriptionGroup" + ] + } + }, + "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", + "versions" ] } }, @@ -166690,6 +172980,22 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "subscriptionGroup" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -166734,11 +173040,11 @@ } }, "200": { - "description": "List of Devices with get", + "description": "List of SubscriptionGroupLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DevicesWithoutIncludesResponse" + "$ref": "#/components/schemas/SubscriptionGroupLocalizationsResponse" } } } @@ -166768,12 +173074,12 @@ } ] }, - "/v1/reviewSubmissions/{id}/relationships/items": { + "/v1/subscriptionGroups/{id}/relationships/subscriptions": { "get": { "tags": [ - "ReviewSubmissions" + "SubscriptionGroups" ], - "operationId": "reviewSubmissions_items_getToManyRelationship", + "operationId": "subscriptionGroups_subscriptions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -166832,7 +173138,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReviewSubmissionItemsLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionGroupSubscriptionsLinkagesResponse" } } } @@ -166862,98 +173168,58 @@ } ] }, - "/v1/reviewSubmissions/{id}/items": { + "/v1/subscriptionGroups/{id}/subscriptions": { "get": { "tags": [ - "ReviewSubmissions" + "SubscriptionGroups" ], - "operationId": "reviewSubmissions_items_getToManyRelated", + "operationId": "subscriptionGroups_subscriptions_getToManyRelated", "parameters": [ { - "name": "fields[reviewSubmissionItems]", + "name": "filter[productId]", "in": "query", - "description": "the fields to include for returned resources of type reviewSubmissionItems", + "description": "filter by attribute 'productId'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "state", - "appStoreVersion", - "appCustomProductPageVersion", - "appStoreVersionExperiment", - "appStoreVersionExperimentV2", - "appEvent", - "appAssetLibraryImage", - "appAssetLibraryVideo", - "backgroundAssetVersion", - "gameCenterAchievementVersion", - "gameCenterActivityVersion", - "gameCenterChallengeVersion", - "gameCenterLeaderboardSetVersion", - "gameCenterLeaderboardVersion", - "inAppPurchaseVersion", - "subscriptionVersion", - "subscriptionGroupVersion" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appStoreVersions]", + "name": "filter[name]", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersions", + "description": "filter by attribute 'name'", "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" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[appCustomProductPageVersions]", + "name": "filter[state]", "in": "query", - "description": "the fields to include for returned resources of type appCustomProductPageVersions", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "deepLink", - "appCustomProductPage", - "appCustomProductPageLocalizations" + "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" ] } }, @@ -166961,26 +173227,16 @@ "explode": false }, { - "name": "fields[appStoreVersionExperiments]", + "name": "sort", "in": "query", - "description": "the fields to include for returned resources of type appStoreVersionExperiments", + "description": "comma-separated list of sort expressions; resources will be sorted as specified", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "trafficProportion", - "state", - "reviewRequired", - "startDate", - "endDate", - "appStoreVersion", - "appStoreVersionExperimentTreatments", - "platform", - "app", - "latestControlVersion", - "controlVersions" + "-name" ] } }, @@ -166988,25 +173244,40 @@ "explode": false }, { - "name": "fields[appEvents]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type appEvents", + "description": "the fields to include for returned resources of type subscriptions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "badge", - "eventState", - "deepLink", - "purchaseRequirement", - "primaryLocale", - "priority", - "purpose", - "territorySchedules", - "archivedTerritorySchedules", - "localizations" + "name", + "productId", + "familySharable", + "state", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -167014,26 +173285,19 @@ "explode": false }, { - "name": "fields[appAssetLibraryImages]", + "name": "fields[subscriptionLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryImages", + "description": "the fields to include for returned resources of type subscriptionLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", - "fileSize", - "imageAsset", - "referenceName", - "specId", + "name", + "locale", + "description", "state", - "stateDetails", - "uploadOperations", - "placements" + "subscription" ] } }, @@ -167041,28 +173305,23 @@ "explode": false }, { - "name": "fields[appAssetLibraryVideos]", + "name": "fields[subscriptionAppStoreReviewScreenshots]", "in": "query", - "description": "the fields to include for returned resources of type appAssetLibraryVideos", + "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "category", - "createdDate", - "lastModifiedDate", - "fileName", "fileSize", - "previewFrameImage", - "previewFrameTimeCode", - "referenceName", - "specId", - "state", - "stateDetails", + "fileName", + "sourceFileChecksum", + "imageAsset", + "assetToken", + "assetType", "uploadOperations", - "videoAsset", - "placements" + "assetDeliveryState", + "subscription" ] } }, @@ -167070,27 +173329,18 @@ "explode": false }, { - "name": "fields[backgroundAssetVersions]", + "name": "fields[subscriptionGroups]", "in": "query", - "description": "the fields to include for returned resources of type backgroundAssetVersions", + "description": "the fields to include for returned resources of type subscriptionGroups", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "createdDate", - "platforms", - "state", - "stateDetails", - "version", - "locale", - "backgroundAsset", - "internalBetaRelease", - "externalBetaRelease", - "appStoreRelease", - "assetFile", - "manifestFile", - "backgroundAssetUploadFiles" + "referenceName", + "subscriptions", + "subscriptionGroupLocalizations", + "versions" ] } }, @@ -167098,18 +173348,23 @@ "explode": false }, { - "name": "fields[gameCenterAchievementVersions]", + "name": "fields[subscriptionIntroductoryOffers]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterAchievementVersions", + "description": "the fields to include for returned resources of type subscriptionIntroductoryOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "achievement", - "localizations" + "startDate", + "endDate", + "duration", + "offerMode", + "numberOfPeriods", + "targetSubscriptionPlanType", + "subscription", + "territory", + "subscriptionPricePoint" ] } }, @@ -167117,21 +173372,22 @@ "explode": false }, { - "name": "fields[gameCenterActivityVersions]", + "name": "fields[subscriptionPromotionalOffers]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterActivityVersions", + "description": "the fields to include for returned resources of type subscriptionPromotionalOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "fallbackUrl", - "activity", - "localizations", - "defaultImage", - "releases" + "duration", + "name", + "numberOfPeriods", + "offerCode", + "offerMode", + "targetSubscriptionPlanType", + "subscription", + "prices" ] } }, @@ -167139,20 +173395,30 @@ "explode": false }, { - "name": "fields[gameCenterChallengeVersions]", + "name": "fields[subscriptionOfferCodes]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterChallengeVersions", + "description": "the fields to include for returned resources of type subscriptionOfferCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "challenge", - "localizations", - "releases", - "defaultImage" + "name", + "customerEligibilities", + "offerEligibility", + "duration", + "offerMode", + "numberOfPeriods", + "totalNumberOfCodes", + "productionCodeCount", + "sandboxCodeCount", + "active", + "autoRenewEnabled", + "targetSubscriptionPlanType", + "subscription", + "oneTimeUseCodes", + "customCodes", + "prices" ] } }, @@ -167160,18 +173426,19 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardSetVersions]", + "name": "fields[subscriptionPrices]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardSetVersions", + "description": "the fields to include for returned resources of type subscriptionPrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "leaderboardSet", - "localizations" + "startDate", + "preserved", + "planType", + "territory", + "subscriptionPricePoint" ] } }, @@ -167179,18 +173446,19 @@ "explode": false }, { - "name": "fields[gameCenterLeaderboardVersions]", + "name": "fields[promotedPurchases]", "in": "query", - "description": "the fields to include for returned resources of type gameCenterLeaderboardVersions", + "description": "the fields to include for returned resources of type promotedPurchases", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", + "visibleForAllUsers", + "enabled", "state", - "leaderboard", - "localizations" + "inAppPurchaseV2", + "subscription" ] } }, @@ -167198,20 +173466,16 @@ "explode": false }, { - "name": "fields[inAppPurchaseVersions]", + "name": "fields[subscriptionAvailabilities]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchaseVersions", + "description": "the fields to include for returned resources of type subscriptionAvailabilities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "inAppPurchase", - "image", - "images", - "localizations" + "availableInNewTerritories", + "availableTerritories" ] } }, @@ -167219,20 +173483,28 @@ "explode": false }, { - "name": "fields[subscriptionVersions]", + "name": "fields[winBackOffers]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionVersions", + "description": "the fields to include for returned resources of type winBackOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "subscription", - "image", - "images", - "localizations" + "referenceName", + "offerId", + "duration", + "offerMode", + "periodCount", + "customerEligibilityPaidSubscriptionDurationInMonths", + "customerEligibilityTimeSinceLastSubscribedInMonths", + "customerEligibilityWaitBetweenOffersInMonths", + "startDate", + "endDate", + "priority", + "promotionIntent", + "targetSubscriptionPlanType", + "prices" ] } }, @@ -167240,18 +173512,22 @@ "explode": false }, { - "name": "fields[subscriptionGroupVersions]", + "name": "fields[subscriptionImages]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupVersions", + "description": "the fields to include for returned resources of type subscriptionImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", + "fileSize", + "fileName", + "sourceFileChecksum", + "assetToken", + "imageAsset", + "uploadOperations", "state", - "subscriptionGroup", - "localizations" + "subscription" ] } }, @@ -167259,255 +173535,38 @@ "explode": false }, { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, - { - "name": "include", + "name": "fields[subscriptionPlanAvailabilities]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type subscriptionPlanAvailabilities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "appStoreVersion", - "appCustomProductPageVersion", - "appStoreVersionExperiment", - "appStoreVersionExperimentV2", - "appEvent", - "appAssetLibraryImage", - "appAssetLibraryVideo", - "backgroundAssetVersion", - "gameCenterAchievementVersion", - "gameCenterActivityVersion", - "gameCenterChallengeVersion", - "gameCenterLeaderboardSetVersion", - "gameCenterLeaderboardVersion", - "inAppPurchaseVersion", - "subscriptionVersion", - "subscriptionGroupVersion" + "availableInNewTerritories", + "planType", + "availableTerritories" ] } }, "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 ReviewSubmissionItems", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReviewSubmissionItemsResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/scmProviders/{id}/relationships/repositories": { - "get": { - "tags": [ - "ScmProviders" - ], - "operationId": "scmProviders_repositories_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/ScmProviderRepositoriesLinkagesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/scmProviders/{id}/repositories": { - "get": { - "tags": [ - "ScmProviders" - ], - "operationId": "scmProviders_repositories_getToManyRelated", - "parameters": [ - { - "name": "filter[id]", - "in": "query", - "description": "filter by id(s)", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false }, { - "name": "fields[scmRepositories]", + "name": "fields[subscriptionVersions]", "in": "query", - "description": "the fields to include for returned resources of type scmRepositories", + "description": "the fields to include for returned resources of type subscriptionVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "lastAccessedDate", - "httpCloneUrl", - "sshCloneUrl", - "ownerName", - "repositoryName", - "scmProvider", - "defaultBranch", - "gitReferences", - "pullRequests" + "version", + "state", + "subscription", + "image", + "images", + "localizations" ] } }, @@ -167515,17 +173574,24 @@ "explode": false }, { - "name": "fields[scmProviders]", + "name": "fields[retentionOffers]", "in": "query", - "description": "the fields to include for returned resources of type scmProviders", + "description": "the fields to include for returned resources of type retentionOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "scmProviderType", - "url", - "repositories" + "referenceName", + "offerId", + "duration", + "offerMode", + "periodCount", + "customerEligibilityPaidSubscriptionDurationInMonths", + "customerEligibilityWaitBetweenOffersInMonths", + "targetSubscriptionPlanType", + "subscription", + "prices" ] } }, @@ -167533,19 +173599,17 @@ "explode": false }, { - "name": "fields[scmGitReferences]", + "name": "fields[retentionMessages]", "in": "query", - "description": "the fields to include for returned resources of type scmGitReferences", + "description": "the fields to include for returned resources of type retentionMessages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "canonicalName", - "isDeleted", - "kind", - "repository" + "referenceName", + "versions", + "subscriptions" ] } }, @@ -167571,261 +173635,137 @@ "items": { "type": "string", "enum": [ - "scmProvider", - "defaultBranch" + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, "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 ScmRepositories", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScmRepositoriesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + { + "name": "limit[subscriptionLocalizations]", + "in": "query", + "description": "maximum number of related subscriptionLocalizations returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" }, - "style": "simple", - "required": true - } - ] - }, - "/v1/scmRepositories/{id}/relationships/gitReferences": { - "get": { - "tags": [ - "ScmRepositories" - ], - "operationId": "scmRepositories_gitReferences_getToManyRelationship", - "parameters": [ { - "name": "limit", + "name": "limit[introductoryOffers]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related introductoryOffers returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "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" - } - } - } + { + "name": "limit[promotionalOffers]", + "in": "query", + "description": "maximum number of related promotionalOffers returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } + { + "name": "limit[offerCodes]", + "in": "query", + "description": "maximum number of related offerCodes returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } + { + "name": "limit[prices]", + "in": "query", + "description": "maximum number of related prices returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" }, - "200": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScmRepositoryGitReferencesLinkagesResponse" - } - } - } + { + "name": "limit[winBackOffers]", + "in": "query", + "description": "maximum number of related winBackOffers returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + { + "name": "limit[images]", + "in": "query", + "description": "maximum number of related images returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" }, - "style": "simple", - "required": true - } - ] - }, - "/v1/scmRepositories/{id}/gitReferences": { - "get": { - "tags": [ - "ScmRepositories" - ], - "operationId": "scmRepositories_gitReferences_getToManyRelated", - "parameters": [ { - "name": "fields[scmGitReferences]", + "name": "limit[planAvailabilities]", "in": "query", - "description": "the fields to include for returned resources of type scmGitReferences", + "description": "maximum number of related planAvailabilities returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "canonicalName", - "isDeleted", - "kind", - "repository" - ] - } + "type": "integer", + "maximum": 50 }, - "style": "form", - "explode": false + "style": "form" }, { - "name": "fields[scmRepositories]", + "name": "limit[versions]", "in": "query", - "description": "the fields to include for returned resources of type scmRepositories", + "description": "maximum number of related versions returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "lastAccessedDate", - "httpCloneUrl", - "sshCloneUrl", - "ownerName", - "repositoryName", - "scmProvider", - "defaultBranch", - "gitReferences", - "pullRequests" - ] - } + "type": "integer", + "maximum": 50 }, - "style": "form", - "explode": false + "style": "form" }, { - "name": "limit", + "name": "limit[retentionOffers]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related retentionOffers returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "maximum": 50 }, "style": "form" }, { - "name": "include", + "name": "limit[retentionMessageOffers]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "maximum number of related retentionMessageOffers returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "repository" - ] - } + "type": "integer", + "maximum": 50 }, - "style": "form", - "explode": false + "style": "form" } ], "responses": { @@ -167870,11 +173810,11 @@ } }, "200": { - "description": "List of ScmGitReferences", + "description": "List of Subscriptions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScmGitReferencesResponse" + "$ref": "#/components/schemas/SubscriptionsResponse" } } } @@ -167904,12 +173844,12 @@ } ] }, - "/v1/scmRepositories/{id}/relationships/pullRequests": { + "/v1/subscriptionGroups/{id}/relationships/versions": { "get": { "tags": [ - "ScmRepositories" + "SubscriptionGroups" ], - "operationId": "scmRepositories_pullRequests_getToManyRelationship", + "operationId": "subscriptionGroups_versions_getToManyRelationship", "parameters": [ { "name": "limit", @@ -167968,7 +173908,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScmRepositoryPullRequestsLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionGroupVersionsLinkagesResponse" } } } @@ -167998,34 +173938,31 @@ } ] }, - "/v1/scmRepositories/{id}/pullRequests": { + "/v1/subscriptionGroups/{id}/versions": { "get": { "tags": [ - "ScmRepositories" + "SubscriptionGroups" ], - "operationId": "scmRepositories_pullRequests_getToManyRelated", + "operationId": "subscriptionGroups_versions_getToManyRelated", "parameters": [ { - "name": "fields[scmPullRequests]", + "name": "filter[state]", "in": "query", - "description": "the fields to include for returned resources of type scmPullRequests", + "description": "filter by attribute 'state'", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "title", - "number", - "webUrl", - "sourceRepositoryOwner", - "sourceRepositoryName", - "sourceBranchName", - "destinationRepositoryOwner", - "destinationRepositoryName", - "destinationBranchName", - "isClosed", - "isCrossRepository", - "repository" + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "ACCEPTED", + "APPROVED", + "REPLACED_WITH_NEW_VERSION", + "REJECTED", + "DEVELOPER_REJECTED" ] } }, @@ -168033,23 +173970,56 @@ "explode": false }, { - "name": "fields[scmRepositories]", + "name": "fields[subscriptionGroupVersions]", "in": "query", - "description": "the fields to include for returned resources of type scmRepositories", + "description": "the fields to include for returned resources of type subscriptionGroupVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "lastAccessedDate", - "httpCloneUrl", - "sshCloneUrl", - "ownerName", - "repositoryName", - "scmProvider", - "defaultBranch", - "gitReferences", - "pullRequests" + "version", + "state", + "subscriptionGroup", + "localizations" + ] + } + }, + "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", + "versions" + ] + } + }, + "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", + "version" ] } }, @@ -168075,105 +174045,21 @@ "items": { "type": "string", "enum": [ - "repository" + "subscriptionGroup", + "localizations" ] } }, "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 ScmPullRequests", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScmPullRequestsResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" }, - "style": "simple", - "required": true - } - ] - }, - "/v1/subscriptionAvailabilities/{id}/relationships/availableTerritories": { - "get": { - "tags": [ - "SubscriptionAvailabilities" - ], - "operationId": "subscriptionAvailabilities_availableTerritories_getToManyRelationship", - "deprecated": true, - "parameters": [ { - "name": "limit", + "name": "limit[localizations]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related localizations returned (when they are included)", "schema": { "type": "integer", - "maximum": 200 + "maximum": 50 }, "style": "form" } @@ -168220,11 +174106,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "List of SubscriptionGroupVersions", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAvailabilityAvailableTerritoriesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionGroupVersionsResponse" } } } @@ -168254,41 +174140,13 @@ } ] }, - "/v1/subscriptionAvailabilities/{id}/availableTerritories": { + "/v1/subscriptionOfferCodeOneTimeUseCodes/{id}/values": { "get": { "tags": [ - "SubscriptionAvailabilities" - ], - "operationId": "subscriptionAvailabilities_availableTerritories_getToManyRelated", - "deprecated": true, - "parameters": [ - { - "name": "fields[territories]", - "in": "query", - "description": "the fields to include for returned resources of type territories", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "currency" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "SubscriptionOfferCodeOneTimeUseCodes" ], + "operationId": "subscriptionOfferCodeOneTimeUseCodes_values_getToOneRelated", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -168331,11 +174189,11 @@ } }, "200": { - "description": "List of Territories", + "description": "Single SubscriptionOfferCodeOneTimeUseCodeValue", "content": { - "application/json": { + "text/csv": { "schema": { - "$ref": "#/components/schemas/TerritoriesResponse" + "$ref": "#/components/schemas/csv" } } } @@ -168365,12 +174223,12 @@ } ] }, - "/v1/subscriptionGroupVersions/{id}/relationships/localizations": { + "/v1/subscriptionOfferCodes/{id}/relationships/customCodes": { "get": { "tags": [ - "SubscriptionGroupVersions" + "SubscriptionOfferCodes" ], - "operationId": "subscriptionGroupVersions_localizations_getToManyRelationship", + "operationId": "subscriptionOfferCodes_customCodes_getToManyRelationship", "parameters": [ { "name": "limit", @@ -168429,7 +174287,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupVersionLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodesLinkagesResponse" } } } @@ -168459,26 +174317,28 @@ } ] }, - "/v1/subscriptionGroupVersions/{id}/localizations": { + "/v1/subscriptionOfferCodes/{id}/customCodes": { "get": { "tags": [ - "SubscriptionGroupVersions" + "SubscriptionOfferCodes" ], - "operationId": "subscriptionGroupVersions_localizations_getToManyRelated", + "operationId": "subscriptionOfferCodes_customCodes_getToManyRelated", "parameters": [ { - "name": "fields[subscriptionGroupLocalizations]", + "name": "fields[subscriptionOfferCodeCustomCodes]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupLocalizations", + "description": "the fields to include for returned resources of type subscriptionOfferCodeCustomCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "customAppName", - "locale", - "version" + "customCode", + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "offerCode" ] } }, @@ -168486,18 +174346,30 @@ "explode": false }, { - "name": "fields[subscriptionGroupVersions]", + "name": "fields[subscriptionOfferCodes]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupVersions", + "description": "the fields to include for returned resources of type subscriptionOfferCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", - "state", - "subscriptionGroup", - "localizations" + "name", + "customerEligibilities", + "offerEligibility", + "duration", + "offerMode", + "numberOfPeriods", + "totalNumberOfCodes", + "productionCodeCount", + "sandboxCodeCount", + "active", + "autoRenewEnabled", + "targetSubscriptionPlanType", + "subscription", + "oneTimeUseCodes", + "customCodes", + "prices" ] } }, @@ -168523,7 +174395,7 @@ "items": { "type": "string", "enum": [ - "version" + "offerCode" ] } }, @@ -168573,11 +174445,11 @@ } }, "200": { - "description": "List of SubscriptionGroupLocalizations", + "description": "List of SubscriptionOfferCodeCustomCodes", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationsV2Response" + "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodesResponse" } } } @@ -168607,12 +174479,12 @@ } ] }, - "/v1/subscriptionGroups/{id}/relationships/subscriptionGroupLocalizations": { + "/v1/subscriptionOfferCodes/{id}/relationships/oneTimeUseCodes": { "get": { "tags": [ - "SubscriptionGroups" + "SubscriptionOfferCodes" ], - "operationId": "subscriptionGroups_subscriptionGroupLocalizations_getToManyRelationship", + "operationId": "subscriptionOfferCodes_oneTimeUseCodes_getToManyRelationship", "parameters": [ { "name": "limit", @@ -168671,7 +174543,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupSubscriptionGroupLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodesLinkagesResponse" } } } @@ -168701,27 +174573,29 @@ } ] }, - "/v1/subscriptionGroups/{id}/subscriptionGroupLocalizations": { + "/v1/subscriptionOfferCodes/{id}/oneTimeUseCodes": { "get": { "tags": [ - "SubscriptionGroups" + "SubscriptionOfferCodes" ], - "operationId": "subscriptionGroups_subscriptionGroupLocalizations_getToManyRelated", + "operationId": "subscriptionOfferCodes_oneTimeUseCodes_getToManyRelated", "parameters": [ { - "name": "fields[subscriptionGroupLocalizations]", + "name": "fields[subscriptionOfferCodeOneTimeUseCodes]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupLocalizations", + "description": "the fields to include for returned resources of type subscriptionOfferCodeOneTimeUseCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "customAppName", - "locale", - "state", - "subscriptionGroup" + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "environment", + "offerCode", + "values" ] } }, @@ -168729,18 +174603,30 @@ "explode": false }, { - "name": "fields[subscriptionGroups]", + "name": "fields[subscriptionOfferCodes]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroups", + "description": "the fields to include for returned resources of type subscriptionOfferCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "subscriptions", - "subscriptionGroupLocalizations", - "versions" + "name", + "customerEligibilities", + "offerEligibility", + "duration", + "offerMode", + "numberOfPeriods", + "totalNumberOfCodes", + "productionCodeCount", + "sandboxCodeCount", + "active", + "autoRenewEnabled", + "targetSubscriptionPlanType", + "subscription", + "oneTimeUseCodes", + "customCodes", + "prices" ] } }, @@ -168766,7 +174652,7 @@ "items": { "type": "string", "enum": [ - "subscriptionGroup" + "offerCode" ] } }, @@ -168816,11 +174702,11 @@ } }, "200": { - "description": "List of SubscriptionGroupLocalizations", + "description": "List of SubscriptionOfferCodeOneTimeUseCodes", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupLocalizationsResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodesResponse" } } } @@ -168850,12 +174736,12 @@ } ] }, - "/v1/subscriptionGroups/{id}/relationships/subscriptions": { + "/v1/subscriptionOfferCodes/{id}/relationships/prices": { "get": { "tags": [ - "SubscriptionGroups" + "SubscriptionOfferCodes" ], - "operationId": "subscriptionGroups_subscriptions_getToManyRelationship", + "operationId": "subscriptionOfferCodes_prices_getToManyRelationship", "parameters": [ { "name": "limit", @@ -168914,7 +174800,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupSubscriptionsLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodePricesLinkagesResponse" } } } @@ -168944,30 +174830,17 @@ } ] }, - "/v1/subscriptionGroups/{id}/subscriptions": { + "/v1/subscriptionOfferCodes/{id}/prices": { "get": { "tags": [ - "SubscriptionGroups" + "SubscriptionOfferCodes" ], - "operationId": "subscriptionGroups_subscriptions_getToManyRelated", + "operationId": "subscriptionOfferCodes_prices_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]", + "name": "filter[territory]", "in": "query", - "description": "filter by attribute 'name'", + "description": "filter by id(s) of related 'territory'", "schema": { "type": "array", "items": { @@ -168978,123 +174851,16 @@ "explode": false }, { - "name": "filter[state]", - "in": "query", - "description": "filter by attribute '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": [ - "name", - "-name" - ] - } - }, - "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", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[subscriptionLocalizations]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionLocalizations", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "locale", - "description", - "state", - "subscription" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[subscriptionAppStoreReviewScreenshots]", + "name": "fields[subscriptionOfferCodePrices]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots", + "description": "the fields to include for returned resources of type subscriptionOfferCodePrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "imageAsset", - "assetToken", - "assetType", - "uploadOperations", - "assetDeliveryState", - "subscription" + "territory", + "subscriptionPricePoint" ] } }, @@ -169102,18 +174868,15 @@ "explode": false }, { - "name": "fields[subscriptionGroups]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroups", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "subscriptions", - "subscriptionGroupLocalizations", - "versions" + "currency" ] } }, @@ -169121,46 +174884,20 @@ "explode": false }, { - "name": "fields[subscriptionIntroductoryOffers]", + "name": "fields[subscriptionPricePoints]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionIntroductoryOffers", + "description": "the fields to include for returned resources of type subscriptionPricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "startDate", - "endDate", - "duration", - "offerMode", - "numberOfPeriods", - "targetSubscriptionPlanType", - "subscription", + "customerPrice", + "proceeds", + "proceedsYear2", "territory", - "subscriptionPricePoint" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[subscriptionPromotionalOffers]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPromotionalOffers", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "duration", - "name", - "numberOfPeriods", - "offerCode", - "offerMode", - "targetSubscriptionPlanType", - "subscription", - "prices" + "equalizations", + "adjustedEqualizations" ] } }, @@ -169168,48 +174905,24 @@ "explode": false }, { - "name": "fields[subscriptionOfferCodes]", + "name": "limit", "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodes", + "description": "maximum resources per page", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "customerEligibilities", - "offerEligibility", - "duration", - "offerMode", - "numberOfPeriods", - "totalNumberOfCodes", - "productionCodeCount", - "sandboxCodeCount", - "active", - "autoRenewEnabled", - "targetSubscriptionPlanType", - "subscription", - "oneTimeUseCodes", - "customCodes", - "prices" - ] - } + "type": "integer", + "maximum": 200 }, - "style": "form", - "explode": false + "style": "form" }, { - "name": "fields[subscriptionPrices]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type subscriptionPrices", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "startDate", - "preserved", - "planType", "territory", "subscriptionPricePoint" ] @@ -169217,135 +174930,91 @@ }, "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" - ] + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "fields[subscriptionAvailabilities]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionAvailabilities", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "availableInNewTerritories", - "availableTerritories" - ] + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "fields[winBackOffers]", - "in": "query", - "description": "the fields to include for returned resources of type winBackOffers", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "referenceName", - "offerId", - "duration", - "offerMode", - "periodCount", - "customerEligibilityPaidSubscriptionDurationInMonths", - "customerEligibilityTimeSinceLastSubscribedInMonths", - "customerEligibilityWaitBetweenOffersInMonths", - "startDate", - "endDate", - "priority", - "promotionIntent", - "targetSubscriptionPlanType", - "prices" - ] + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "fields[subscriptionImages]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "assetToken", - "imageAsset", - "uploadOperations", - "state", - "subscription" - ] + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "fields[subscriptionPlanAvailabilities]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPlanAvailabilities", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "availableInNewTerritories", - "planType", - "availableTerritories" - ] + "200": { + "description": "List of SubscriptionOfferCodePrices", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionOfferCodePricesResponse" + } } - }, - "style": "form", - "explode": false + } }, - { - "name": "fields[subscriptionVersions]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionVersions", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "version", - "state", - "subscription", - "image", - "images", - "localizations" - ] + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" }, + "style": "simple", + "required": true + } + ] + }, + "/v1/subscriptionPlanAvailabilities/{id}/relationships/availableTerritories": { + "get": { + "tags": [ + "SubscriptionPlanAvailabilities" + ], + "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelationship", + "parameters": [ { "name": "limit", "in": "query", @@ -169355,126 +175024,87 @@ "maximum": 200 }, "style": "form" - }, - { - "name": "include", - "in": "query", - "description": "comma-separated list of relationships to include", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" - ] + } + ], + "responses": { + "400": { + "description": "Parameter error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - }, - "style": "form", - "explode": false - }, - { - "name": "limit[subscriptionLocalizations]", - "in": "query", - "description": "maximum number of related subscriptionLocalizations returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[introductoryOffers]", - "in": "query", - "description": "maximum number of related introductoryOffers returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[promotionalOffers]", - "in": "query", - "description": "maximum number of related promotionalOffers 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" + } }, - { - "name": "limit[prices]", - "in": "query", - "description": "maximum number of related prices returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" + "401": { + "description": "Unauthorized error(s)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "name": "limit[winBackOffers]", - "in": "query", - "description": "maximum number of related winBackOffers returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "name": "limit[images]", - "in": "query", - "description": "maximum number of related images returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" + "404": { + "description": "Not found error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - { - "name": "limit[planAvailabilities]", - "in": "query", - "description": "maximum number of related planAvailabilities returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" + "200": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionPlanAvailabilityAvailableTerritoriesLinkagesResponse" + } + } + } }, - { - "name": "limit[versions]", - "in": "query", - "description": "maximum number of related versions returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } + } + }, + "patch": { + "tags": [ + "SubscriptionPlanAvailabilities" ], + "operationId": "subscriptionPlanAvailabilities_availableTerritories_replaceToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionPlanAvailabilityAvailableTerritoriesLinkagesRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -169516,16 +175146,29 @@ } } }, - "200": { - "description": "List of Subscriptions", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionsResponse" + "$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": { @@ -169551,13 +175194,29 @@ } ] }, - "/v1/subscriptionGroups/{id}/relationships/versions": { + "/v1/subscriptionPlanAvailabilities/{id}/availableTerritories": { "get": { "tags": [ - "SubscriptionGroups" + "SubscriptionPlanAvailabilities" ], - "operationId": "subscriptionGroups_versions_getToManyRelationship", + "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", "parameters": [ + { + "name": "fields[territories]", + "in": "query", + "description": "the fields to include for returned resources of type territories", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "currency" + ] + } + }, + "style": "form", + "explode": false + }, { "name": "limit", "in": "query", @@ -169611,11 +175270,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "List of Territories", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionGroupVersionsLinkagesResponse" + "$ref": "#/components/schemas/TerritoriesResponse" } } } @@ -169645,69 +175304,81 @@ } ] }, - "/v1/subscriptionGroups/{id}/versions": { + "/v1/subscriptionPricePoints/{id}/adjustedEqualizations": { "get": { "tags": [ - "SubscriptionGroups" + "SubscriptionPricePoints" ], - "operationId": "subscriptionGroups_versions_getToManyRelated", + "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", "parameters": [ { - "name": "filter[state]", + "name": "filter[territory]", "in": "query", - "description": "filter by attribute 'state'", + "description": "filter by id(s) of related 'territory'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "PREPARE_FOR_SUBMISSION", - "READY_FOR_REVIEW", - "WAITING_FOR_REVIEW", - "IN_REVIEW", - "ACCEPTED", - "APPROVED", - "REPLACED_WITH_NEW_VERSION", - "REJECTED", - "DEVELOPER_REJECTED" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[subscriptionGroupVersions]", + "name": "filter[subscription]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupVersions", + "description": "filter by id(s) of related 'subscription'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "version", - "state", - "subscriptionGroup", - "localizations" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[subscriptionGroups]", + "name": "filter[upfrontPricePointId]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroups", + "description": "filter by upfrontPricePointId", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[planType]", + "in": "query", + "description": "filter by planType", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false, + "required": true + }, + { + "name": "fields[subscriptionPricePoints]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "referenceName", - "subscriptions", - "subscriptionGroupLocalizations", - "versions" + "customerPrice", + "proceeds", + "proceedsYear2", + "territory", + "equalizations", + "adjustedEqualizations" ] } }, @@ -169715,18 +175386,15 @@ "explode": false }, { - "name": "fields[subscriptionGroupLocalizations]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionGroupLocalizations", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "customAppName", - "locale", - "version" + "currency" ] } }, @@ -169739,7 +175407,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 200 + "maximum": 8000 }, "style": "form" }, @@ -169752,23 +175420,12 @@ "items": { "type": "string", "enum": [ - "subscriptionGroup", - "localizations" + "territory" ] } }, "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": { @@ -169813,91 +175470,13 @@ } }, "200": { - "description": "List of SubscriptionGroupVersions", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionGroupVersionsResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/subscriptionOfferCodeOneTimeUseCodes/{id}/values": { - "get": { - "tags": [ - "SubscriptionOfferCodeOneTimeUseCodes" - ], - "operationId": "subscriptionOfferCodeOneTimeUseCodes_values_getToOneRelated", - "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", + "description": "List of SubscriptionPricePoints", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/SubscriptionPricePointsResponse" } - } - } - }, - "200": { - "description": "Single SubscriptionOfferCodeOneTimeUseCodeValue", - "content": { + }, "text/csv": { "schema": { "$ref": "#/components/schemas/csv" @@ -169930,12 +175509,12 @@ } ] }, - "/v1/subscriptionOfferCodes/{id}/relationships/customCodes": { + "/v1/subscriptionPricePoints/{id}/relationships/equalizations": { "get": { "tags": [ - "SubscriptionOfferCodes" + "SubscriptionPricePoints" ], - "operationId": "subscriptionOfferCodes_customCodes_getToManyRelationship", + "operationId": "subscriptionPricePoints_equalizations_getToManyRelationship", "parameters": [ { "name": "limit", @@ -169943,7 +175522,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 200 + "maximum": 8000 }, "style": "form" } @@ -169994,7 +175573,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionPricePointEqualizationsLinkagesResponse" } } } @@ -170024,28 +175603,80 @@ } ] }, - "/v1/subscriptionOfferCodes/{id}/customCodes": { + "/v1/subscriptionPricePoints/{id}/equalizations": { "get": { "tags": [ - "SubscriptionOfferCodes" + "SubscriptionPricePoints" ], - "operationId": "subscriptionOfferCodes_customCodes_getToManyRelated", + "operationId": "subscriptionPricePoints_equalizations_getToManyRelated", "parameters": [ { - "name": "fields[subscriptionOfferCodeCustomCodes]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodeCustomCodes", + "description": "filter by id(s) of related 'territory'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[subscription]", + "in": "query", + "description": "filter by id(s) of related 'subscription'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[upfrontPricePointId]", + "in": "query", + "description": "filter by upfrontPricePointId", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[planType]", + "in": "query", + "description": "filter by planType", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionPricePoints]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customCode", - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "offerCode" + "customerPrice", + "proceeds", + "proceedsYear2", + "territory", + "equalizations", + "adjustedEqualizations" ] } }, @@ -170053,30 +175684,15 @@ "explode": false }, { - "name": "fields[subscriptionOfferCodes]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodes", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "customerEligibilities", - "offerEligibility", - "duration", - "offerMode", - "numberOfPeriods", - "totalNumberOfCodes", - "productionCodeCount", - "sandboxCodeCount", - "active", - "autoRenewEnabled", - "targetSubscriptionPlanType", - "subscription", - "oneTimeUseCodes", - "customCodes", - "prices" + "currency" ] } }, @@ -170089,7 +175705,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 200 + "maximum": 8000 }, "style": "form" }, @@ -170102,7 +175718,7 @@ "items": { "type": "string", "enum": [ - "offerCode" + "territory" ] } }, @@ -170152,11 +175768,16 @@ } }, "200": { - "description": "List of SubscriptionOfferCodeCustomCodes", + "description": "List of SubscriptionPricePoints", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeCustomCodesResponse" + "$ref": "#/components/schemas/SubscriptionPricePointsResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/csv" } } } @@ -170186,12 +175807,12 @@ } ] }, - "/v1/subscriptionOfferCodes/{id}/relationships/oneTimeUseCodes": { + "/v1/subscriptionPromotionalOffers/{id}/relationships/prices": { "get": { "tags": [ - "SubscriptionOfferCodes" + "SubscriptionPromotionalOffers" ], - "operationId": "subscriptionOfferCodes_oneTimeUseCodes_getToManyRelationship", + "operationId": "subscriptionPromotionalOffers_prices_getToManyRelationship", "parameters": [ { "name": "limit", @@ -170250,7 +175871,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionPromotionalOfferPricesLinkagesResponse" } } } @@ -170280,29 +175901,37 @@ } ] }, - "/v1/subscriptionOfferCodes/{id}/oneTimeUseCodes": { + "/v1/subscriptionPromotionalOffers/{id}/prices": { "get": { "tags": [ - "SubscriptionOfferCodes" + "SubscriptionPromotionalOffers" ], - "operationId": "subscriptionOfferCodes_oneTimeUseCodes_getToManyRelated", + "operationId": "subscriptionPromotionalOffers_prices_getToManyRelated", "parameters": [ { - "name": "fields[subscriptionOfferCodeOneTimeUseCodes]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodeOneTimeUseCodes", + "description": "filter by id(s) of related 'territory'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionPromotionalOfferPrices]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPromotionalOfferPrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "environment", - "offerCode", - "values" + "territory", + "subscriptionPricePoint" ] } }, @@ -170310,30 +175939,36 @@ "explode": false }, { - "name": "fields[subscriptionOfferCodes]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodes", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "customerEligibilities", - "offerEligibility", - "duration", - "offerMode", - "numberOfPeriods", - "totalNumberOfCodes", - "productionCodeCount", - "sandboxCodeCount", - "active", - "autoRenewEnabled", - "targetSubscriptionPlanType", - "subscription", - "oneTimeUseCodes", - "customCodes", - "prices" + "currency" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionPricePoints]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPricePoints", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "customerPrice", + "proceeds", + "proceedsYear2", + "territory", + "equalizations", + "adjustedEqualizations" ] } }, @@ -170359,7 +175994,8 @@ "items": { "type": "string", "enum": [ - "offerCode" + "territory", + "subscriptionPricePoint" ] } }, @@ -170409,11 +176045,11 @@ } }, "200": { - "description": "List of SubscriptionOfferCodeOneTimeUseCodes", + "description": "List of SubscriptionPromotionalOfferPrices", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodeOneTimeUseCodesResponse" + "$ref": "#/components/schemas/SubscriptionPromotionalOfferPricesResponse" } } } @@ -170443,24 +176079,13 @@ } ] }, - "/v1/subscriptionOfferCodes/{id}/relationships/prices": { + "/v1/subscriptionVersions/{id}/relationships/image": { "get": { "tags": [ - "SubscriptionOfferCodes" - ], - "operationId": "subscriptionOfferCodes_prices_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } + "SubscriptionVersions" ], + "operationId": "subscriptionVersions_image_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -170503,11 +176128,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodePricesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionVersionImageLinkageResponse" } } } @@ -170537,101 +176162,28 @@ } ] }, - "/v1/subscriptionOfferCodes/{id}/prices": { + "/v1/subscriptionVersions/{id}/image": { "get": { "tags": [ - "SubscriptionOfferCodes" + "SubscriptionVersions" ], - "operationId": "subscriptionOfferCodes_prices_getToManyRelated", + "operationId": "subscriptionVersions_image_getToOneRelated", "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[subscriptionOfferCodePrices]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodePrices", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "territory", - "subscriptionPricePoint" - ] - } - }, - "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[subscriptionPricePoints]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPricePoints", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "customerPrice", - "proceeds", - "proceedsYear2", - "territory", - "equalizations", - "adjustedEqualizations" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, - { - "name": "include", + "name": "fields[subscriptionImages]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "the fields to include for returned resources of type subscriptionImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "territory", - "subscriptionPricePoint" + "fileSize", + "fileName", + "assetToken", + "imageAsset", + "uploadOperations", + "assetDeliveryState" ] } }, @@ -170681,11 +176233,11 @@ } }, "200": { - "description": "List of SubscriptionOfferCodePrices", + "description": "Single SubscriptionImage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodePricesResponse" + "$ref": "#/components/schemas/SubscriptionImageV2Response" } } } @@ -170715,12 +176267,12 @@ } ] }, - "/v1/subscriptionPlanAvailabilities/{id}/relationships/availableTerritories": { + "/v1/subscriptionVersions/{id}/relationships/images": { "get": { "tags": [ - "SubscriptionPlanAvailabilities" + "SubscriptionVersions" ], - "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelationship", + "operationId": "subscriptionVersions_images_getToManyRelationship", "parameters": [ { "name": "limit", @@ -170779,7 +176331,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlanAvailabilityAvailableTerritoriesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionVersionImagesLinkagesResponse" } } } @@ -170796,22 +176348,58 @@ } } }, - "patch": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "the id of the requested resource", + "schema": { + "type": "string" + }, + "style": "simple", + "required": true + } + ] + }, + "/v1/subscriptionVersions/{id}/images": { + "get": { "tags": [ - "SubscriptionPlanAvailabilities" + "SubscriptionVersions" ], - "operationId": "subscriptionPlanAvailabilities_availableTerritories_replaceToManyRelationship", - "requestBody": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionPlanAvailabilityAvailableTerritoriesLinkagesRequest" + "operationId": "subscriptionVersions_images_getToManyRelated", + "parameters": [ + { + "name": "fields[subscriptionImages]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionImages", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "fileSize", + "fileName", + "assetToken", + "imageAsset", + "uploadOperations", + "assetDeliveryState" + ] } - } + }, + "style": "form", + "explode": false }, - "required": true - }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -170853,29 +176441,16 @@ } } }, - "422": { - "description": "Unprocessable request entity error(s)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Request entity error(s)", + "200": { + "description": "List of SubscriptionImages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/SubscriptionImagesV2Response" } } } }, - "204": { - "description": "Success (no content)" - }, "429": { "description": "Rate limit exceeded error", "content": { @@ -170901,29 +176476,13 @@ } ] }, - "/v1/subscriptionPlanAvailabilities/{id}/availableTerritories": { + "/v1/subscriptionVersions/{id}/relationships/localizations": { "get": { "tags": [ - "SubscriptionPlanAvailabilities" - ], - "operationId": "subscriptionPlanAvailabilities_availableTerritories_getToManyRelated", - "parameters": [ - { - "name": "fields[territories]", - "in": "query", - "description": "the fields to include for returned resources of type territories", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "currency" - ] - } - }, - "style": "form", - "explode": false - }, + "SubscriptionVersions" + ], + "operationId": "subscriptionVersions_localizations_getToManyRelationship", + "parameters": [ { "name": "limit", "in": "query", @@ -170977,11 +176536,11 @@ } }, "200": { - "description": "List of Territories", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TerritoriesResponse" + "$ref": "#/components/schemas/SubscriptionVersionLocalizationsLinkagesResponse" } } } @@ -171011,81 +176570,26 @@ } ] }, - "/v1/subscriptionPricePoints/{id}/adjustedEqualizations": { + "/v1/subscriptionVersions/{id}/localizations": { "get": { "tags": [ - "SubscriptionPricePoints" + "SubscriptionVersions" ], - "operationId": "subscriptionPricePoints_adjustedEqualizations_getToManyRelated", + "operationId": "subscriptionVersions_localizations_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": "filter[subscription]", - "in": "query", - "description": "filter by id(s) of related 'subscription'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[upfrontPricePointId]", - "in": "query", - "description": "filter by upfrontPricePointId", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[planType]", - "in": "query", - "description": "filter by planType", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false, - "required": true - }, - { - "name": "fields[subscriptionPricePoints]", + "name": "fields[subscriptionLocalizations]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionPricePoints", + "description": "the fields to include for returned resources of type subscriptionLocalizations", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", - "proceedsYear2", - "territory", - "equalizations", - "adjustedEqualizations" + "name", + "locale", + "description", + "version" ] } }, @@ -171093,15 +176597,20 @@ "explode": false }, { - "name": "fields[territories]", + "name": "fields[subscriptionVersions]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type subscriptionVersions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "version", + "state", + "subscription", + "image", + "images", + "localizations" ] } }, @@ -171114,7 +176623,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 8000 + "maximum": 200 }, "style": "form" }, @@ -171127,7 +176636,7 @@ "items": { "type": "string", "enum": [ - "territory" + "version" ] } }, @@ -171177,16 +176686,11 @@ } }, "200": { - "description": "List of SubscriptionPricePoints", + "description": "List of SubscriptionLocalizations", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPricePointsResponse" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/csv" + "$ref": "#/components/schemas/SubscriptionLocalizationsV2Response" } } } @@ -171216,24 +176720,13 @@ } ] }, - "/v1/subscriptionPricePoints/{id}/relationships/equalizations": { + "/v1/subscriptions/{id}/relationships/appStoreReviewScreenshot": { "get": { "tags": [ - "SubscriptionPricePoints" - ], - "operationId": "subscriptionPricePoints_equalizations_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 8000 - }, - "style": "form" - } + "Subscriptions" ], + "operationId": "subscriptions_appStoreReviewScreenshot_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -171276,11 +176769,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPricePointEqualizationsLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotLinkageResponse" } } } @@ -171310,80 +176803,31 @@ } ] }, - "/v1/subscriptionPricePoints/{id}/equalizations": { + "/v1/subscriptions/{id}/appStoreReviewScreenshot": { "get": { "tags": [ - "SubscriptionPricePoints" + "Subscriptions" ], - "operationId": "subscriptionPricePoints_equalizations_getToManyRelated", + "operationId": "subscriptions_appStoreReviewScreenshot_getToOneRelated", "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": "filter[subscription]", - "in": "query", - "description": "filter by id(s) of related 'subscription'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[upfrontPricePointId]", - "in": "query", - "description": "filter by upfrontPricePointId", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[planType]", - "in": "query", - "description": "filter by planType", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[subscriptionPricePoints]", + "name": "fields[subscriptionAppStoreReviewScreenshots]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionPricePoints", + "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", - "proceedsYear2", - "territory", - "equalizations", - "adjustedEqualizations" + "fileSize", + "fileName", + "sourceFileChecksum", + "imageAsset", + "assetToken", + "assetType", + "uploadOperations", + "assetDeliveryState", + "subscription" ] } }, @@ -171391,31 +176835,46 @@ "explode": false }, { - "name": "fields[territories]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type subscriptions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "name", + "productId", + "familySharable", + "state", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, "style": "form", "explode": false }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 8000 - }, - "style": "form" - }, { "name": "include", "in": "query", @@ -171425,7 +176884,7 @@ "items": { "type": "string", "enum": [ - "territory" + "subscription" ] } }, @@ -171475,16 +176934,11 @@ } }, "200": { - "description": "List of SubscriptionPricePoints", + "description": "Single SubscriptionAppStoreReviewScreenshot", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPricePointsResponse" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/csv" + "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotResponse" } } } @@ -171514,12 +176968,12 @@ } ] }, - "/v1/subscriptionPromotionalOffers/{id}/relationships/prices": { + "/v1/subscriptions/{id}/relationships/images": { "get": { "tags": [ - "SubscriptionPromotionalOffers" + "Subscriptions" ], - "operationId": "subscriptionPromotionalOffers_prices_getToManyRelationship", + "operationId": "subscriptions_images_getToManyRelationship", "parameters": [ { "name": "limit", @@ -171578,7 +177032,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPromotionalOfferPricesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionImagesLinkagesResponse" } } } @@ -171608,53 +177062,30 @@ } ] }, - "/v1/subscriptionPromotionalOffers/{id}/prices": { + "/v1/subscriptions/{id}/images": { "get": { "tags": [ - "SubscriptionPromotionalOffers" + "Subscriptions" ], - "operationId": "subscriptionPromotionalOffers_prices_getToManyRelated", + "operationId": "subscriptions_images_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[subscriptionPromotionalOfferPrices]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPromotionalOfferPrices", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "territory", - "subscriptionPricePoint" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[territories]", + "name": "fields[subscriptionImages]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type subscriptionImages", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "fileSize", + "fileName", + "sourceFileChecksum", + "assetToken", + "imageAsset", + "uploadOperations", + "state", + "subscription" ] } }, @@ -171662,20 +177093,40 @@ "explode": false }, { - "name": "fields[subscriptionPricePoints]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionPricePoints", + "description": "the fields to include for returned resources of type subscriptions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", - "proceedsYear2", - "territory", - "equalizations", - "adjustedEqualizations" + "name", + "productId", + "familySharable", + "state", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -171701,8 +177152,7 @@ "items": { "type": "string", "enum": [ - "territory", - "subscriptionPricePoint" + "subscription" ] } }, @@ -171752,11 +177202,11 @@ } }, "200": { - "description": "List of SubscriptionPromotionalOfferPrices", + "description": "List of SubscriptionImages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPromotionalOfferPricesResponse" + "$ref": "#/components/schemas/SubscriptionImagesResponse" } } } @@ -171786,13 +177236,24 @@ } ] }, - "/v1/subscriptionVersions/{id}/relationships/image": { + "/v1/subscriptions/{id}/relationships/introductoryOffers": { "get": { "tags": [ - "SubscriptionVersions" + "Subscriptions" + ], + "operationId": "subscriptions_introductoryOffers_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } ], - "operationId": "subscriptionVersions_image_getToOneRelationship", - "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -171835,11 +177296,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionVersionImageLinkageResponse" + "$ref": "#/components/schemas/SubscriptionIntroductoryOffersLinkagesResponse" } } } @@ -171856,48 +177317,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/subscriptionVersions/{id}/image": { - "get": { + "delete": { "tags": [ - "SubscriptionVersions" + "Subscriptions" ], - "operationId": "subscriptionVersions_image_getToOneRelated", - "parameters": [ - { - "name": "fields[subscriptionImages]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionImages", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "fileSize", - "fileName", - "assetToken", - "imageAsset", - "uploadOperations", - "assetDeliveryState" - ] + "operationId": "subscriptions_introductoryOffers_deleteToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionIntroductoryOffersLinkagesRequest" } - }, - "style": "form", - "explode": false - } - ], + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -171939,16 +177374,29 @@ } } }, - "200": { - "description": "Single SubscriptionImage", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImageV2Response" + "$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": { @@ -171974,122 +177422,122 @@ } ] }, - "/v1/subscriptionVersions/{id}/relationships/images": { + "/v1/subscriptions/{id}/introductoryOffers": { "get": { "tags": [ - "SubscriptionVersions" + "Subscriptions" ], - "operationId": "subscriptionVersions_images_getToManyRelationship", + "operationId": "subscriptions_introductoryOffers_getToManyRelated", "parameters": [ { - "name": "limit", + "name": "filter[territory]", "in": "query", - "description": "maximum resources per page", + "description": "filter by id(s) of related 'territory'", "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" - } + "type": "array", + "items": { + "type": "string" } - } + }, + "style": "form", + "explode": false }, - "404": { - "description": "Not found error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "fields[subscriptionIntroductoryOffers]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionIntroductoryOffers", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "startDate", + "endDate", + "duration", + "offerMode", + "numberOfPeriods", + "targetSubscriptionPlanType", + "subscription", + "territory", + "subscriptionPricePoint" + ] } - } + }, + "style": "form", + "explode": false }, - "200": { - "description": "List of related linkages", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionVersionImagesLinkagesResponse" - } + { + "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", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] } - } + }, + "style": "form", + "explode": false }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + { + "name": "fields[territories]", + "in": "query", + "description": "the fields to include for returned resources of type territories", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "currency" + ] } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" + }, + "style": "form", + "explode": false }, - "style": "simple", - "required": true - } - ] - }, - "/v1/subscriptionVersions/{id}/images": { - "get": { - "tags": [ - "SubscriptionVersions" - ], - "operationId": "subscriptionVersions_images_getToManyRelated", - "parameters": [ { - "name": "fields[subscriptionImages]", + "name": "fields[subscriptionPricePoints]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionImages", + "description": "the fields to include for returned resources of type subscriptionPricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "assetToken", - "imageAsset", - "uploadOperations", - "assetDeliveryState" + "customerPrice", + "proceeds", + "proceedsYear2", + "territory", + "equalizations", + "adjustedEqualizations" ] } }, @@ -172105,6 +177553,24 @@ "maximum": 200 }, "style": "form" + }, + { + "name": "include", + "in": "query", + "description": "comma-separated list of relationships to include", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "subscription", + "territory", + "subscriptionPricePoint" + ] + } + }, + "style": "form", + "explode": false } ], "responses": { @@ -172149,11 +177615,11 @@ } }, "200": { - "description": "List of SubscriptionImages", + "description": "List of SubscriptionIntroductoryOffers", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImagesV2Response" + "$ref": "#/components/schemas/SubscriptionIntroductoryOffersResponse" } } } @@ -172183,12 +177649,12 @@ } ] }, - "/v1/subscriptionVersions/{id}/relationships/localizations": { + "/v1/subscriptions/{id}/relationships/offerCodes": { "get": { "tags": [ - "SubscriptionVersions" + "Subscriptions" ], - "operationId": "subscriptionVersions_localizations_getToManyRelationship", + "operationId": "subscriptions_offerCodes_getToManyRelationship", "parameters": [ { "name": "limit", @@ -172247,7 +177713,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionVersionLocalizationsLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionOfferCodesLinkagesResponse" } } } @@ -172277,26 +177743,51 @@ } ] }, - "/v1/subscriptionVersions/{id}/localizations": { + "/v1/subscriptions/{id}/offerCodes": { "get": { "tags": [ - "SubscriptionVersions" + "Subscriptions" ], - "operationId": "subscriptionVersions_localizations_getToManyRelated", + "operationId": "subscriptions_offerCodes_getToManyRelated", "parameters": [ { - "name": "fields[subscriptionLocalizations]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionLocalizations", + "description": "filter by territory", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionOfferCodes]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionOfferCodes", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "locale", - "description", - "version" + "customerEligibilities", + "offerEligibility", + "duration", + "offerMode", + "numberOfPeriods", + "totalNumberOfCodes", + "productionCodeCount", + "sandboxCodeCount", + "active", + "autoRenewEnabled", + "targetSubscriptionPlanType", + "subscription", + "oneTimeUseCodes", + "customCodes", + "prices" ] } }, @@ -172304,20 +177795,100 @@ "explode": false }, { - "name": "fields[subscriptionVersions]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionVersions", + "description": "the fields to include for returned resources of type subscriptions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "version", + "name", + "productId", + "familySharable", "state", - "subscription", - "image", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", "images", - "localizations" + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionOfferCodeOneTimeUseCodes]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionOfferCodeOneTimeUseCodes", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "environment", + "offerCode", + "values" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionOfferCodeCustomCodes]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionOfferCodeCustomCodes", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "customCode", + "numberOfCodes", + "createdDate", + "expirationDate", + "active", + "offerCode" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionOfferCodePrices]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionOfferCodePrices", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "territory", + "subscriptionPricePoint" ] } }, @@ -172343,12 +177914,45 @@ "items": { "type": "string", "enum": [ - "version" + "subscription", + "oneTimeUseCodes", + "customCodes", + "prices" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[oneTimeUseCodes]", + "in": "query", + "description": "maximum number of related oneTimeUseCodes returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[customCodes]", + "in": "query", + "description": "maximum number of related customCodes returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" + }, + { + "name": "limit[prices]", + "in": "query", + "description": "maximum number of related prices returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -172393,11 +177997,11 @@ } }, "200": { - "description": "List of SubscriptionLocalizations", + "description": "List of SubscriptionOfferCodes", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionLocalizationsV2Response" + "$ref": "#/components/schemas/SubscriptionOfferCodesResponse" } } } @@ -172427,13 +178031,24 @@ } ] }, - "/v1/subscriptions/{id}/relationships/appStoreReviewScreenshot": { + "/v1/subscriptions/{id}/relationships/planAvailabilities": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_appStoreReviewScreenshot_getToOneRelationship", - "parameters": [], + "operationId": "subscriptions_planAvailabilities_getToManyRelationship", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + } + ], "responses": { "400": { "description": "Parameter error(s)", @@ -172476,11 +178091,11 @@ } }, "200": { - "description": "Related linkage", + "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotLinkageResponse" + "$ref": "#/components/schemas/SubscriptionPlanAvailabilitiesLinkagesResponse" } } } @@ -172510,31 +178125,25 @@ } ] }, - "/v1/subscriptions/{id}/appStoreReviewScreenshot": { + "/v1/subscriptions/{id}/planAvailabilities": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_appStoreReviewScreenshot_getToOneRelated", + "operationId": "subscriptions_planAvailabilities_getToManyRelated", "parameters": [ { - "name": "fields[subscriptionAppStoreReviewScreenshots]", + "name": "fields[subscriptionPlanAvailabilities]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots", + "description": "the fields to include for returned resources of type subscriptionPlanAvailabilities", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "imageAsset", - "assetToken", - "assetType", - "uploadOperations", - "assetDeliveryState", - "subscription" + "availableInNewTerritories", + "planType", + "availableTerritories" ] } }, @@ -172542,43 +178151,31 @@ "explode": false }, { - "name": "fields[subscriptions]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type subscriptions", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "familySharable", - "state", - "subscriptionPeriod", - "reviewNote", - "groupLevel", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" + "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", @@ -172588,12 +178185,22 @@ "items": { "type": "string", "enum": [ - "subscription" + "availableTerritories" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[availableTerritories]", + "in": "query", + "description": "maximum number of related availableTerritories returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -172638,11 +178245,11 @@ } }, "200": { - "description": "Single SubscriptionAppStoreReviewScreenshot", + "description": "List of SubscriptionPlanAvailabilities", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshotResponse" + "$ref": "#/components/schemas/SubscriptionPlanAvailabilitiesResponse" } } } @@ -172672,12 +178279,12 @@ } ] }, - "/v1/subscriptions/{id}/relationships/images": { + "/v1/subscriptions/{id}/relationships/pricePoints": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_images_getToManyRelationship", + "operationId": "subscriptions_pricePoints_getToManyRelationship", "parameters": [ { "name": "limit", @@ -172685,7 +178292,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 200 + "maximum": 8000 }, "style": "form" } @@ -172736,7 +178343,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImagesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionPricePointsLinkagesResponse" } } } @@ -172766,30 +178373,67 @@ } ] }, - "/v1/subscriptions/{id}/images": { + "/v1/subscriptions/{id}/pricePoints": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_images_getToManyRelated", + "operationId": "subscriptions_pricePoints_getToManyRelated", "parameters": [ { - "name": "fields[subscriptionImages]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionImages", + "description": "filter by id(s) of related 'territory'", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[upfrontPricePointId]", + "in": "query", + "description": "filter by upfrontPricePointId", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[planType]", + "in": "query", + "description": "filter by planType", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionPricePoints]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPricePoints", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "fileSize", - "fileName", - "sourceFileChecksum", - "assetToken", - "imageAsset", - "uploadOperations", - "state", - "subscription" + "customerPrice", + "proceeds", + "proceedsYear2", + "territory", + "equalizations", + "adjustedEqualizations" ] } }, @@ -172797,37 +178441,15 @@ "explode": false }, { - "name": "fields[subscriptions]", + "name": "fields[territories]", "in": "query", - "description": "the fields to include for returned resources of type subscriptions", + "description": "the fields to include for returned resources of type territories", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "familySharable", - "state", - "subscriptionPeriod", - "reviewNote", - "groupLevel", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" + "currency" ] } }, @@ -172840,7 +178462,7 @@ "description": "maximum resources per page", "schema": { "type": "integer", - "maximum": 200 + "maximum": 8000 }, "style": "form" }, @@ -172853,7 +178475,7 @@ "items": { "type": "string", "enum": [ - "subscription" + "territory" ] } }, @@ -172903,11 +178525,16 @@ } }, "200": { - "description": "List of SubscriptionImages", + "description": "List of SubscriptionPricePoints", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionImagesResponse" + "$ref": "#/components/schemas/SubscriptionPricePointsResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/csv" } } } @@ -172937,12 +178564,12 @@ } ] }, - "/v1/subscriptions/{id}/relationships/introductoryOffers": { + "/v1/subscriptions/{id}/relationships/prices": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_introductoryOffers_getToManyRelationship", + "operationId": "subscriptions_prices_getToManyRelationship", "parameters": [ { "name": "limit", @@ -173001,7 +178628,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionIntroductoryOffersLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionPricesLinkagesResponse" } } } @@ -173022,13 +178649,13 @@ "tags": [ "Subscriptions" ], - "operationId": "subscriptions_introductoryOffers_deleteToManyRelationship", + "operationId": "subscriptions_prices_deleteToManyRelationship", "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionIntroductoryOffersLinkagesRequest" + "$ref": "#/components/schemas/SubscriptionPricesLinkagesRequest" } } }, @@ -173123,17 +178750,34 @@ } ] }, - "/v1/subscriptions/{id}/introductoryOffers": { + "/v1/subscriptions/{id}/prices": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_introductoryOffers_getToManyRelated", + "operationId": "subscriptions_prices_getToManyRelated", "parameters": [ { - "name": "filter[territory]", + "name": "filter[planType]", "in": "query", - "description": "filter by id(s) of related 'territory'", + "description": "filter by attribute 'planType'", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "MONTHLY", + "UPFRONT" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "filter[subscriptionPricePoint]", + "in": "query", + "description": "filter by id(s) of related 'subscriptionPricePoint'", "schema": { "type": "array", "items": { @@ -173144,61 +178788,32 @@ "explode": false }, { - "name": "fields[subscriptionIntroductoryOffers]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionIntroductoryOffers", + "description": "filter by id(s) of related 'territory'", "schema": { "type": "array", "items": { - "type": "string", - "enum": [ - "startDate", - "endDate", - "duration", - "offerMode", - "numberOfPeriods", - "targetSubscriptionPlanType", - "subscription", - "territory", - "subscriptionPricePoint" - ] + "type": "string" } }, "style": "form", "explode": false }, { - "name": "fields[subscriptions]", + "name": "fields[subscriptionPrices]", "in": "query", - "description": "the fields to include for returned resources of type subscriptions", + "description": "the fields to include for returned resources of type subscriptionPrices", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "familySharable", - "state", - "subscriptionPeriod", - "reviewNote", - "groupLevel", - "multiSeatStatus", - "marketSettings", - "subscriptionLocalizations", - "appStoreReviewScreenshot", - "group", - "introductoryOffers", - "promotionalOffers", - "offerCodes", - "prices", - "pricePoints", - "promotedPurchase", - "subscriptionAvailability", - "winBackOffers", - "images", - "planAvailabilities", - "versions" + "startDate", + "preserved", + "planType", + "territory", + "subscriptionPricePoint" ] } }, @@ -173261,7 +178876,6 @@ "items": { "type": "string", "enum": [ - "subscription", "territory", "subscriptionPricePoint" ] @@ -173313,11 +178927,11 @@ } }, "200": { - "description": "List of SubscriptionIntroductoryOffers", + "description": "List of SubscriptionPrices", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionIntroductoryOffersResponse" + "$ref": "#/components/schemas/SubscriptionPricesResponse" } } } @@ -173347,24 +178961,13 @@ } ] }, - "/v1/subscriptions/{id}/relationships/offerCodes": { + "/v1/subscriptions/{id}/relationships/promotedPurchase": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_offerCodes_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - } - ], + "operationId": "subscriptions_promotedPurchase_getToOneRelationship", + "parameters": [], "responses": { "400": { "description": "Parameter error(s)", @@ -173407,11 +179010,11 @@ } }, "200": { - "description": "List of related linkages", + "description": "Related linkage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionPromotedPurchaseLinkageResponse" } } } @@ -173441,51 +179044,59 @@ } ] }, - "/v1/subscriptions/{id}/offerCodes": { + "/v1/subscriptions/{id}/promotedPurchase": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_offerCodes_getToManyRelated", + "operationId": "subscriptions_promotedPurchase_getToOneRelated", "parameters": [ { - "name": "filter[territory]", + "name": "fields[promotedPurchases]", "in": "query", - "description": "filter by territory", + "description": "the fields to include for returned resources of type promotedPurchases", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "visibleForAllUsers", + "enabled", + "state", + "inAppPurchaseV2", + "subscription" + ] } }, "style": "form", "explode": false }, { - "name": "fields[subscriptionOfferCodes]", + "name": "fields[inAppPurchases]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodes", + "description": "the fields to include for returned resources of type inAppPurchases", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", - "customerEligibilities", - "offerEligibility", - "duration", - "offerMode", - "numberOfPeriods", - "totalNumberOfCodes", - "productionCodeCount", - "sandboxCodeCount", - "active", - "autoRenewEnabled", - "targetSubscriptionPlanType", - "subscription", - "oneTimeUseCodes", - "customCodes", - "prices" + "productId", + "inAppPurchaseType", + "state", + "reviewNote", + "familySharable", + "contentHosting", + "inAppPurchaseLocalizations", + "pricePoints", + "content", + "appStoreReviewScreenshot", + "promotedPurchase", + "iapPriceSchedule", + "inAppPurchaseAvailability", + "images", + "offerCodes", + "versions" ] } }, @@ -173523,83 +179134,16 @@ "winBackOffers", "images", "planAvailabilities", - "versions" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[subscriptionOfferCodeOneTimeUseCodes]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodeOneTimeUseCodes", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "environment", - "offerCode", - "values" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[subscriptionOfferCodeCustomCodes]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodeCustomCodes", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "customCode", - "numberOfCodes", - "createdDate", - "expirationDate", - "active", - "offerCode" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[subscriptionOfferCodePrices]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionOfferCodePrices", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "territory", - "subscriptionPricePoint" + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, "style": "form", "explode": false }, - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 200 - }, - "style": "form" - }, { "name": "include", "in": "query", @@ -173609,45 +179153,13 @@ "items": { "type": "string", "enum": [ - "subscription", - "oneTimeUseCodes", - "customCodes", - "prices" + "inAppPurchaseV2", + "subscription" ] } }, "style": "form", "explode": false - }, - { - "name": "limit[oneTimeUseCodes]", - "in": "query", - "description": "maximum number of related oneTimeUseCodes returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[customCodes]", - "in": "query", - "description": "maximum number of related customCodes returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" - }, - { - "name": "limit[prices]", - "in": "query", - "description": "maximum number of related prices returned (when they are included)", - "schema": { - "type": "integer", - "maximum": 50 - }, - "style": "form" } ], "responses": { @@ -173692,11 +179204,11 @@ } }, "200": { - "description": "List of SubscriptionOfferCodes", + "description": "Single PromotedPurchase", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionOfferCodesResponse" + "$ref": "#/components/schemas/PromotedPurchaseResponse" } } } @@ -173726,12 +179238,12 @@ } ] }, - "/v1/subscriptions/{id}/relationships/planAvailabilities": { + "/v1/subscriptions/{id}/relationships/promotionalOffers": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_planAvailabilities_getToManyRelationship", + "operationId": "subscriptions_promotionalOffers_getToManyRelationship", "parameters": [ { "name": "limit", @@ -173790,7 +179302,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlanAvailabilitiesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionPromotionalOffersLinkagesResponse" } } } @@ -173820,25 +179332,43 @@ } ] }, - "/v1/subscriptions/{id}/planAvailabilities": { + "/v1/subscriptions/{id}/promotionalOffers": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_planAvailabilities_getToManyRelated", + "operationId": "subscriptions_promotionalOffers_getToManyRelated", "parameters": [ { - "name": "fields[subscriptionPlanAvailabilities]", + "name": "filter[territory]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionPlanAvailabilities", + "description": "filter by territory", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionPromotionalOffers]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPromotionalOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "availableInNewTerritories", - "planType", - "availableTerritories" + "duration", + "name", + "numberOfPeriods", + "offerCode", + "offerMode", + "targetSubscriptionPlanType", + "subscription", + "prices" ] } }, @@ -173846,15 +179376,57 @@ "explode": false }, { - "name": "fields[territories]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "the fields to include for returned resources of type subscriptions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "name", + "productId", + "familySharable", + "state", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[subscriptionPromotionalOfferPrices]", + "in": "query", + "description": "the fields to include for returned resources of type subscriptionPromotionalOfferPrices", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "territory", + "subscriptionPricePoint" ] } }, @@ -173880,7 +179452,8 @@ "items": { "type": "string", "enum": [ - "availableTerritories" + "subscription", + "prices" ] } }, @@ -173888,9 +179461,9 @@ "explode": false }, { - "name": "limit[availableTerritories]", + "name": "limit[prices]", "in": "query", - "description": "maximum number of related availableTerritories returned (when they are included)", + "description": "maximum number of related prices returned (when they are included)", "schema": { "type": "integer", "maximum": 50 @@ -173940,11 +179513,11 @@ } }, "200": { - "description": "List of SubscriptionPlanAvailabilities", + "description": "List of SubscriptionPromotionalOffers", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlanAvailabilitiesResponse" + "$ref": "#/components/schemas/SubscriptionPromotionalOffersResponse" } } } @@ -173974,24 +179547,92 @@ } ] }, - "/v1/subscriptions/{id}/relationships/pricePoints": { + "/v1/subscriptions/{id}/relationships/retentionMessage": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_pricePoints_getToManyRelationship", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "maximum resources per page", - "schema": { - "type": "integer", - "maximum": 8000 - }, - "style": "form" + "operationId": "subscriptions_retentionMessage_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/SubscriptionRetentionMessageLinkageResponse" + } + } + } + }, + "429": { + "description": "Rate limit exceeded error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } + } + }, + "patch": { + "tags": [ + "Subscriptions" ], + "operationId": "subscriptions_retentionMessage_updateToOneRelationship", + "requestBody": { + "description": "Related linkage", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionRetentionMessageLinkageRequest" + } + } + }, + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -174033,16 +179674,29 @@ } } }, - "200": { - "description": "List of related linkages", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPricePointsLinkagesResponse" + "$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": { @@ -174068,67 +179722,85 @@ } ] }, - "/v1/subscriptions/{id}/pricePoints": { + "/v1/subscriptions/{id}/retentionMessage": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_pricePoints_getToManyRelated", + "operationId": "subscriptions_retentionMessage_getToOneRelated", "parameters": [ { - "name": "filter[territory]", + "name": "fields[retentionMessages]", "in": "query", - "description": "filter by id(s) of related 'territory'", + "description": "the fields to include for returned resources of type retentionMessages", "schema": { "type": "array", "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[upfrontPricePointId]", - "in": "query", - "description": "filter by upfrontPricePointId", - "schema": { - "type": "array", - "items": { - "type": "string" + "type": "string", + "enum": [ + "referenceName", + "versions", + "subscriptions" + ] } }, "style": "form", "explode": false }, { - "name": "filter[planType]", + "name": "fields[retentionMessageVersions]", "in": "query", - "description": "filter by planType", + "description": "the fields to include for returned resources of type retentionMessageVersions", "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "state", + "retentionMessage", + "localizations", + "placement" + ] } }, "style": "form", "explode": false }, { - "name": "fields[subscriptionPricePoints]", + "name": "fields[subscriptions]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionPricePoints", + "description": "the fields to include for returned resources of type subscriptions", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "customerPrice", - "proceeds", - "proceedsYear2", - "territory", - "equalizations", - "adjustedEqualizations" + "name", + "productId", + "familySharable", + "state", + "subscriptionPeriod", + "reviewNote", + "groupLevel", + "multiSeatStatus", + "marketSettings", + "subscriptionLocalizations", + "appStoreReviewScreenshot", + "group", + "introductoryOffers", + "promotionalOffers", + "offerCodes", + "prices", + "pricePoints", + "promotedPurchase", + "subscriptionAvailability", + "winBackOffers", + "images", + "planAvailabilities", + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -174136,15 +179808,16 @@ "explode": false }, { - "name": "fields[territories]", + "name": "include", "in": "query", - "description": "the fields to include for returned resources of type territories", + "description": "comma-separated list of relationships to include", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "currency" + "versions", + "subscriptions" ] } }, @@ -174152,30 +179825,24 @@ "explode": false }, { - "name": "limit", + "name": "limit[versions]", "in": "query", - "description": "maximum resources per page", + "description": "maximum number of related versions returned (when they are included)", "schema": { "type": "integer", - "maximum": 8000 + "maximum": 50 }, "style": "form" }, { - "name": "include", + "name": "limit[subscriptions]", "in": "query", - "description": "comma-separated list of relationships to include", + "description": "maximum number of related subscriptions returned (when they are included)", "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "territory" - ] - } + "type": "integer", + "maximum": 50 }, - "style": "form", - "explode": false + "style": "form" } ], "responses": { @@ -174220,16 +179887,11 @@ } }, "200": { - "description": "List of SubscriptionPricePoints", + "description": "Single RetentionMessage", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPricePointsResponse" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/csv" + "$ref": "#/components/schemas/RetentionMessageResponse" } } } @@ -174259,12 +179921,12 @@ } ] }, - "/v1/subscriptions/{id}/relationships/prices": { + "/v1/subscriptions/{id}/relationships/retentionMessageOffers": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_prices_getToManyRelationship", + "operationId": "subscriptions_retentionMessageOffers_getToManyRelationship", "parameters": [ { "name": "limit", @@ -174323,7 +179985,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPricesLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionRetentionMessageOffersLinkagesResponse" } } } @@ -174340,17 +180002,17 @@ } } }, - "delete": { + "post": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_prices_deleteToManyRelationship", + "operationId": "subscriptions_retentionMessageOffers_createToManyRelationship", "requestBody": { "description": "List of related linkages", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPricesLinkagesRequest" + "$ref": "#/components/schemas/SubscriptionRetentionMessageOffersLinkagesRequest" } } }, @@ -174432,154 +180094,22 @@ } } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/subscriptions/{id}/prices": { - "get": { + "delete": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_prices_getToManyRelated", - "parameters": [ - { - "name": "filter[planType]", - "in": "query", - "description": "filter by attribute 'planType'", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "MONTHLY", - "UPFRONT" - ] - } - }, - "style": "form", - "explode": false - }, - { - "name": "filter[subscriptionPricePoint]", - "in": "query", - "description": "filter by id(s) of related 'subscriptionPricePoint'", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "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[subscriptionPrices]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPrices", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "startDate", - "preserved", - "planType", - "territory", - "subscriptionPricePoint" - ] - } - }, - "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[subscriptionPricePoints]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPricePoints", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "customerPrice", - "proceeds", - "proceedsYear2", - "territory", - "equalizations", - "adjustedEqualizations" - ] + "operationId": "subscriptions_retentionMessageOffers_deleteToManyRelationship", + "requestBody": { + "description": "List of related linkages", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionRetentionMessageOffersLinkagesRequest" } - }, - "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", - "subscriptionPricePoint" - ] - } - }, - "style": "form", - "explode": false - } - ], + "required": true + }, "responses": { "400": { "description": "Parameter error(s)", @@ -174621,71 +180151,8 @@ } } }, - "200": { - "description": "List of SubscriptionPrices", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionPricesResponse" - } - } - } - }, - "429": { - "description": "Rate limit exceeded error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "the id of the requested resource", - "schema": { - "type": "string" - }, - "style": "simple", - "required": true - } - ] - }, - "/v1/subscriptions/{id}/relationships/promotedPurchase": { - "get": { - "tags": [ - "Subscriptions" - ], - "operationId": "subscriptions_promotedPurchase_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", + "422": { + "description": "Unprocessable request entity error(s)", "content": { "application/json": { "schema": { @@ -174694,8 +180161,8 @@ } } }, - "404": { - "description": "Not found error", + "409": { + "description": "Request entity error(s)", "content": { "application/json": { "schema": { @@ -174704,15 +180171,8 @@ } } }, - "200": { - "description": "Related linkage", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionPromotedPurchaseLinkageResponse" - } - } - } + "204": { + "description": "Success (no content)" }, "429": { "description": "Rate limit exceeded error", @@ -174739,59 +180199,32 @@ } ] }, - "/v1/subscriptions/{id}/promotedPurchase": { + "/v1/subscriptions/{id}/retentionMessageOffers": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_promotedPurchase_getToOneRelated", + "operationId": "subscriptions_retentionMessageOffers_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]", + "name": "fields[retentionOffers]", "in": "query", - "description": "the fields to include for returned resources of type inAppPurchases", + "description": "the fields to include for returned resources of type retentionOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ - "name", - "productId", - "inAppPurchaseType", - "state", - "reviewNote", - "familySharable", - "contentHosting", - "inAppPurchaseLocalizations", - "pricePoints", - "content", - "appStoreReviewScreenshot", - "promotedPurchase", - "iapPriceSchedule", - "inAppPurchaseAvailability", - "images", - "offerCodes", - "versions" + "referenceName", + "offerId", + "duration", + "offerMode", + "periodCount", + "customerEligibilityPaidSubscriptionDurationInMonths", + "customerEligibilityWaitBetweenOffersInMonths", + "targetSubscriptionPlanType", + "subscription", + "prices" ] } }, @@ -174829,13 +180262,43 @@ "winBackOffers", "images", "planAvailabilities", - "versions" + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" + ] + } + }, + "style": "form", + "explode": false + }, + { + "name": "fields[retentionOfferPrices]", + "in": "query", + "description": "the fields to include for returned resources of type retentionOfferPrices", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "territory", + "subscriptionPricePoint" ] } }, "style": "form", "explode": false }, + { + "name": "limit", + "in": "query", + "description": "maximum resources per page", + "schema": { + "type": "integer", + "maximum": 200 + }, + "style": "form" + }, { "name": "include", "in": "query", @@ -174845,13 +180308,23 @@ "items": { "type": "string", "enum": [ - "inAppPurchaseV2", - "subscription" + "subscription", + "prices" ] } }, "style": "form", "explode": false + }, + { + "name": "limit[prices]", + "in": "query", + "description": "maximum number of related prices returned (when they are included)", + "schema": { + "type": "integer", + "maximum": 50 + }, + "style": "form" } ], "responses": { @@ -174896,11 +180369,11 @@ } }, "200": { - "description": "Single PromotedPurchase", + "description": "List of RetentionOffers", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotedPurchaseResponse" + "$ref": "#/components/schemas/RetentionOffersResponse" } } } @@ -174930,12 +180403,12 @@ } ] }, - "/v1/subscriptions/{id}/relationships/promotionalOffers": { + "/v1/subscriptions/{id}/relationships/retentionOffers": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_promotionalOffers_getToManyRelationship", + "operationId": "subscriptions_retentionOffers_getToManyRelationship", "parameters": [ { "name": "limit", @@ -174994,7 +180467,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPromotionalOffersLinkagesResponse" + "$ref": "#/components/schemas/SubscriptionRetentionOffersLinkagesResponse" } } } @@ -175024,40 +180497,29 @@ } ] }, - "/v1/subscriptions/{id}/promotionalOffers": { + "/v1/subscriptions/{id}/retentionOffers": { "get": { "tags": [ "Subscriptions" ], - "operationId": "subscriptions_promotionalOffers_getToManyRelated", + "operationId": "subscriptions_retentionOffers_getToManyRelated", "parameters": [ { - "name": "filter[territory]", + "name": "fields[retentionOffers]", "in": "query", - "description": "filter by territory", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form", - "explode": false - }, - { - "name": "fields[subscriptionPromotionalOffers]", - "in": "query", - "description": "the fields to include for returned resources of type subscriptionPromotionalOffers", + "description": "the fields to include for returned resources of type retentionOffers", "schema": { "type": "array", "items": { "type": "string", "enum": [ + "referenceName", + "offerId", "duration", - "name", - "numberOfPeriods", - "offerCode", "offerMode", + "periodCount", + "customerEligibilityPaidSubscriptionDurationInMonths", + "customerEligibilityWaitBetweenOffersInMonths", "targetSubscriptionPlanType", "subscription", "prices" @@ -175098,7 +180560,10 @@ "winBackOffers", "images", "planAvailabilities", - "versions" + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -175106,9 +180571,9 @@ "explode": false }, { - "name": "fields[subscriptionPromotionalOfferPrices]", + "name": "fields[retentionOfferPrices]", "in": "query", - "description": "the fields to include for returned resources of type subscriptionPromotionalOfferPrices", + "description": "the fields to include for returned resources of type retentionOfferPrices", "schema": { "type": "array", "items": { @@ -175202,11 +180667,11 @@ } }, "200": { - "description": "List of SubscriptionPromotionalOffers", + "description": "List of RetentionOffers", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPromotionalOffersResponse" + "$ref": "#/components/schemas/RetentionOffersResponse" } } } @@ -175616,7 +181081,10 @@ "winBackOffers", "images", "planAvailabilities", - "versions" + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -175903,7 +181371,10 @@ "winBackOffers", "images", "planAvailabilities", - "versions" + "versions", + "retentionOffers", + "retentionMessage", + "retentionMessageOffers" ] } }, @@ -176479,6 +181950,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -177015,6 +182487,7 @@ "appAvailabilityV2", "inAppPurchases", "subscriptionGroups", + "retentionMessages", "gameCenterEnabledVersions", "performanceOverviews", "perfPowerMetrics", @@ -183391,6 +188864,29 @@ ] } } + }, + "retentionMessageVersion": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessageVersions" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } } } }, @@ -183540,6 +189036,9 @@ }, { "$ref": "#/components/schemas/AppStoreVersionLocalization" + }, + { + "$ref": "#/components/schemas/RetentionMessageVersion" } ], "discriminator": { @@ -183548,6 +189047,7 @@ "appStoreVersionLocalizations": "#/components/schemas/AppStoreVersionLocalization", "appAssetLibraryImages": "#/components/schemas/AppAssetLibraryImage", "appCustomProductPageLocalizations": "#/components/schemas/AppCustomProductPageLocalization", + "retentionMessageVersions": "#/components/schemas/RetentionMessageVersion", "appStoreVersionExperimentTreatmentLocalizations": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalization", "appAssetLibraryVideos": "#/components/schemas/AppAssetLibraryVideo", "appEventLocalizations": "#/components/schemas/AppEventLocalization" @@ -183595,6 +189095,9 @@ }, { "$ref": "#/components/schemas/AppStoreVersionLocalization" + }, + { + "$ref": "#/components/schemas/RetentionMessageVersion" } ], "discriminator": { @@ -183603,6 +189106,7 @@ "appStoreVersionLocalizations": "#/components/schemas/AppStoreVersionLocalization", "appAssetLibraryImages": "#/components/schemas/AppAssetLibraryImage", "appCustomProductPageLocalizations": "#/components/schemas/AppCustomProductPageLocalization", + "retentionMessageVersions": "#/components/schemas/RetentionMessageVersion", "appStoreVersionExperimentTreatmentLocalizations": "#/components/schemas/AppStoreVersionExperimentTreatmentLocalization", "appAssetLibraryVideos": "#/components/schemas/AppAssetLibraryVideo", "appEventLocalizations": "#/components/schemas/AppEventLocalization" @@ -183785,6 +189289,29 @@ ] } } + }, + "retentionMessageVersion": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessageVersions" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } } } } @@ -183878,6 +189405,28 @@ "attributes" ] }, + { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "required": [ + "placementType" + ] + }, + "relationships": { + "type": "object", + "required": [ + "image", + "retentionMessageVersion" + ] + } + }, + "required": [ + "relationships", + "attributes" + ] + }, { "type": "object", "properties": { @@ -198197,6 +203746,38 @@ } } }, + "retentionMessages": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + }, "gameCenterEnabledVersions": { "type": "object", "properties": { @@ -198705,6 +204286,9 @@ { "$ref": "#/components/schemas/PromotedPurchase" }, + { + "$ref": "#/components/schemas/RetentionMessage" + }, { "$ref": "#/components/schemas/ReviewSubmission" }, @@ -198718,29 +204302,30 @@ "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", + "retentionMessages": "#/components/schemas/RetentionMessage", "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", + "betaGroups": "#/components/schemas/BetaGroup", + "reviewSubmissions": "#/components/schemas/ReviewSubmission", + "appStoreVersionExperiments": "#/components/schemas/AppStoreVersionExperimentV2", + "betaAppReviewDetails": "#/components/schemas/BetaAppReviewDetail", + "buildIcons": "#/components/schemas/BuildIcon", + "promotedPurchases": "#/components/schemas/PromotedPurchase", + "androidToIosAppMappingDetails": "#/components/schemas/AndroidToIosAppMappingDetail", + "gameCenterEnabledVersions": "#/components/schemas/GameCenterEnabledVersion", + "subscriptionGroups": "#/components/schemas/SubscriptionGroup", "endUserLicenseAgreements": "#/components/schemas/EndUserLicenseAgreement" } } @@ -198832,6 +204417,9 @@ { "$ref": "#/components/schemas/PromotedPurchase" }, + { + "$ref": "#/components/schemas/RetentionMessage" + }, { "$ref": "#/components/schemas/ReviewSubmission" }, @@ -198845,29 +204433,30 @@ "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", + "retentionMessages": "#/components/schemas/RetentionMessage", "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", + "betaGroups": "#/components/schemas/BetaGroup", + "reviewSubmissions": "#/components/schemas/ReviewSubmission", + "appStoreVersionExperiments": "#/components/schemas/AppStoreVersionExperimentV2", + "betaAppReviewDetails": "#/components/schemas/BetaAppReviewDetail", + "buildIcons": "#/components/schemas/BuildIcon", + "promotedPurchases": "#/components/schemas/PromotedPurchase", + "androidToIosAppMappingDetails": "#/components/schemas/AndroidToIosAppMappingDetail", + "gameCenterEnabledVersions": "#/components/schemas/GameCenterEnabledVersion", + "subscriptionGroups": "#/components/schemas/SubscriptionGroup", "endUserLicenseAgreements": "#/components/schemas/EndUserLicenseAgreement" } } @@ -229118,9 +234707,938 @@ "format": "uri", "nullable": true }, - "secret": { + "secret": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "data" + ], + "deprecated": true + }, + "MerchantId": { + "type": "object", + "title": "MerchantId", + "properties": { + "type": { + "type": "string", + "enum": [ + "merchantIds" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "identifier": { + "type": "string" + } + } + }, + "relationships": { + "type": "object", + "properties": { + "certificates": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "certificates" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + } + }, + "links": { + "$ref": "#/components/schemas/ResourceLinks" + } + }, + "required": [ + "id", + "type" + ] + }, + "MerchantIdsResponse": { + "type": "object", + "title": "MerchantIdsResponse", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MerchantId" + } + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Certificate" + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "MerchantIdResponse": { + "type": "object", + "title": "MerchantIdResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/MerchantId" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Certificate" + } + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "MerchantIdCreateRequest": { + "type": "object", + "title": "MerchantIdCreateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "merchantIds" + ] + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "identifier": { + "type": "string" + } + }, + "required": [ + "identifier", + "name" + ] + } + }, + "required": [ + "attributes", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "MerchantIdUpdateRequest": { + "type": "object", + "title": "MerchantIdUpdateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "merchantIds" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "Nomination": { + "type": "object", + "title": "Nomination", + "properties": { + "type": { + "type": "string", + "enum": [ + "nominations" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "APP_LAUNCH", + "APP_ENHANCEMENTS", + "NEW_CONTENT" + ] + }, + "description": { + "type": "string" + }, + "createdDate": { + "type": "string", + "format": "date-time" + }, + "lastModifiedDate": { + "type": "string", + "format": "date-time" + }, + "submittedDate": { + "type": "string", + "format": "date-time" + }, + "state": { + "type": "string", + "enum": [ + "DRAFT", + "SUBMITTED", + "ARCHIVED" + ] + }, + "publishStartDate": { + "type": "string", + "format": "date-time" + }, + "publishEndDate": { + "type": "string", + "format": "date-time" + }, + "deviceFamilies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceFamily" + } + }, + "locales": { + "type": "array", + "items": { + "type": "string" + } + }, + "supplementalMaterialsUris": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + } + }, + "hasInAppEvents": { + "type": "boolean" + }, + "launchInSelectMarketsFirst": { + "type": "boolean" + }, + "notes": { + "type": "string" + }, + "preOrderEnabled": { + "type": "boolean" + } + } + }, + "relationships": { + "type": "object", + "properties": { + "relatedApps": { + "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" + ] + } + } + } + }, + "createdByActor": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "actors" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "lastModifiedByActor": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "actors" + ] + }, + "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" + ] + } + } + }, + "inAppEvents": { + "type": "object", + "properties": { + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appEvents" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + }, + "supportedTerritories": { + "type": "object", + "properties": { + "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" + ] + }, + "NominationsResponse": { + "type": "object", + "title": "NominationsResponse", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Nomination" + } + }, + "included": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/Actor" + }, + { + "$ref": "#/components/schemas/AppEvent" + }, + { + "$ref": "#/components/schemas/App" + }, + { + "$ref": "#/components/schemas/Territory" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "actors": "#/components/schemas/Actor", + "appEvents": "#/components/schemas/AppEvent", + "territories": "#/components/schemas/Territory", + "apps": "#/components/schemas/App" + } + } + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "NominationResponse": { + "type": "object", + "title": "NominationResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/Nomination" + }, + "included": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/Actor" + }, + { + "$ref": "#/components/schemas/AppEvent" + }, + { + "$ref": "#/components/schemas/App" + }, + { + "$ref": "#/components/schemas/Territory" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "actors": "#/components/schemas/Actor", + "appEvents": "#/components/schemas/AppEvent", + "territories": "#/components/schemas/Territory", + "apps": "#/components/schemas/App" + } + } + } + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "NominationCreateRequest": { + "type": "object", + "title": "NominationCreateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "nominations" + ] + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "APP_LAUNCH", + "APP_ENHANCEMENTS", + "NEW_CONTENT" + ] + }, + "description": { + "type": "string" + }, + "submitted": { + "type": "boolean" + }, + "publishStartDate": { + "type": "string", + "format": "date-time" + }, + "publishEndDate": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deviceFamilies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceFamily" + }, + "nullable": true + }, + "locales": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "supplementalMaterialsUris": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "nullable": true + }, + "hasInAppEvents": { + "type": "boolean", + "nullable": true + }, + "launchInSelectMarketsFirst": { + "type": "boolean", + "nullable": true + }, + "notes": { + "type": "string", + "nullable": true + }, + "preOrderEnabled": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "submitted", + "publishStartDate", + "name", + "description", + "type" + ] + }, + "relationships": { + "type": "object", + "properties": { + "relatedApps": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apps" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "required": [ + "data" + ] + }, + "inAppEvents": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appEvents" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + }, + "supportedTerritories": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "territories" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + }, + "required": [ + "relatedApps" + ] + } + }, + "required": [ + "relationships", + "attributes", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "NominationUpdateRequest": { + "type": "object", + "title": "NominationUpdateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "nominations" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "nullable": true, + "enum": [ + "APP_LAUNCH", + "APP_ENHANCEMENTS", + "NEW_CONTENT" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "submitted": { + "type": "boolean", + "nullable": true + }, + "archived": { + "type": "boolean", + "nullable": true + }, + "publishStartDate": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "publishEndDate": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deviceFamilies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceFamily" + }, + "nullable": true + }, + "locales": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "supplementalMaterialsUris": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "nullable": true + }, + "hasInAppEvents": { + "type": "boolean", + "nullable": true + }, + "launchInSelectMarketsFirst": { + "type": "boolean", + "nullable": true + }, + "notes": { "type": "string", "nullable": true + }, + "preOrderEnabled": { + "type": "boolean", + "nullable": true + } + } + }, + "relationships": { + "type": "object", + "properties": { + "relatedApps": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apps" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + }, + "inAppEvents": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appEvents" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + }, + "supportedTerritories": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "territories" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } } } @@ -229133,17 +235651,16 @@ }, "required": [ "data" - ], - "deprecated": true + ] }, - "MerchantId": { + "PassTypeId": { "type": "object", - "title": "MerchantId", + "title": "PassTypeId", "properties": { "type": { "type": "string", "enum": [ - "merchantIds" + "passTypeIds" ] }, "id": { @@ -229206,14 +235723,14 @@ "type" ] }, - "MerchantIdsResponse": { + "PassTypeIdsResponse": { "type": "object", - "title": "MerchantIdsResponse", + "title": "PassTypeIdsResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MerchantId" + "$ref": "#/components/schemas/PassTypeId" } }, "included": { @@ -229234,12 +235751,12 @@ "links" ] }, - "MerchantIdResponse": { + "PassTypeIdResponse": { "type": "object", - "title": "MerchantIdResponse", + "title": "PassTypeIdResponse", "properties": { "data": { - "$ref": "#/components/schemas/MerchantId" + "$ref": "#/components/schemas/PassTypeId" }, "included": { "type": "array", @@ -229256,9 +235773,9 @@ "links" ] }, - "MerchantIdCreateRequest": { + "PassTypeIdCreateRequest": { "type": "object", - "title": "MerchantIdCreateRequest", + "title": "PassTypeIdCreateRequest", "properties": { "data": { "type": "object", @@ -229266,7 +235783,7 @@ "type": { "type": "string", "enum": [ - "merchantIds" + "passTypeIds" ] }, "attributes": { @@ -229295,9 +235812,9 @@ "data" ] }, - "MerchantIdUpdateRequest": { + "PassTypeIdUpdateRequest": { "type": "object", - "title": "MerchantIdUpdateRequest", + "title": "PassTypeIdUpdateRequest", "properties": { "data": { "type": "object", @@ -229305,7 +235822,7 @@ "type": { "type": "string", "enum": [ - "merchantIds" + "passTypeIds" ] }, "id": { @@ -229331,14 +235848,14 @@ "data" ] }, - "Nomination": { + "PerfPowerMetric": { "type": "object", - "title": "Nomination", + "title": "PerfPowerMetric", "properties": { "type": { "type": "string", "enum": [ - "nominations" + "perfPowerMetrics" ] }, "id": { @@ -229347,87 +235864,102 @@ "attributes": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { + "platform": { "type": "string", "enum": [ - "APP_LAUNCH", - "APP_ENHANCEMENTS", - "NEW_CONTENT" + "IOS" ] }, - "description": { - "type": "string" - }, - "createdDate": { - "type": "string", - "format": "date-time" - }, - "lastModifiedDate": { - "type": "string", - "format": "date-time" - }, - "submittedDate": { - "type": "string", - "format": "date-time" - }, - "state": { + "metricType": { "type": "string", "enum": [ - "DRAFT", - "SUBMITTED", - "ARCHIVED" + "DISK", + "HANG", + "BATTERY", + "LAUNCH", + "MEMORY", + "ANIMATION", + "TERMINATION", + "STORAGE" ] }, - "publishStartDate": { - "type": "string", - "format": "date-time" - }, - "publishEndDate": { - "type": "string", - "format": "date-time" - }, - "deviceFamilies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceFamily" - } - }, - "locales": { - "type": "array", - "items": { - "type": "string" - } - }, - "supplementalMaterialsUris": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - } - }, - "hasInAppEvents": { - "type": "boolean" - }, - "launchInSelectMarketsFirst": { - "type": "boolean" - }, - "notes": { + "deviceType": { + "type": "string" + } + } + }, + "links": { + "$ref": "#/components/schemas/ResourceLinks" + } + }, + "required": [ + "id", + "type" + ] + }, + "PerformanceOverview": { + "type": "object", + "title": "PerformanceOverview", + "properties": { + "type": { + "type": "string", + "enum": [ + "performanceOverviews" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "deviceType": { + "type": "string" + } + } + }, + "links": { + "$ref": "#/components/schemas/ResourceLinks" + } + }, + "required": [ + "id", + "type" + ] + }, + "PrereleaseVersion": { + "type": "object", + "title": "PrereleaseVersion", + "properties": { + "type": { + "type": "string", + "enum": [ + "preReleaseVersions" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "version": { "type": "string" }, - "preOrderEnabled": { - "type": "boolean" + "platform": { + "$ref": "#/components/schemas/Platform" } } }, "relationships": { "type": "object", "properties": { - "relatedApps": { + "builds": { "type": "object", "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, "meta": { "$ref": "#/components/schemas/PagingInformation" }, @@ -229439,7 +235971,7 @@ "type": { "type": "string", "enum": [ - "apps" + "builds" ] }, "id": { @@ -229454,16 +235986,19 @@ } } }, - "createdByActor": { + "app": { "type": "object", "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, "data": { "type": "object", "properties": { "type": { "type": "string", "enum": [ - "actors" + "apps" ] }, "id": { @@ -229476,40 +236011,176 @@ ] } } - }, - "lastModifiedByActor": { - "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" + ] + }, + "PreReleaseVersionsResponse": { + "type": "object", + "title": "PreReleaseVersionsResponse", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PrereleaseVersion" + } + }, + "included": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/App" + }, + { + "$ref": "#/components/schemas/Build" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "builds": "#/components/schemas/Build", + "apps": "#/components/schemas/App" + } + } + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "PrereleaseVersionResponse": { + "type": "object", + "title": "PrereleaseVersionResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/PrereleaseVersion" + }, + "included": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/App" + }, + { + "$ref": "#/components/schemas/Build" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "builds": "#/components/schemas/Build", + "apps": "#/components/schemas/App" } + } + } + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "Profile": { + "type": "object", + "title": "Profile", + "properties": { + "type": { + "type": "string", + "enum": [ + "profiles" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "submittedByActor": { + "platform": { + "$ref": "#/components/schemas/BundleIdPlatform" + }, + "profileType": { + "type": "string", + "enum": [ + "IOS_APP_DEVELOPMENT", + "IOS_APP_STORE", + "IOS_APP_ADHOC", + "IOS_APP_INHOUSE", + "MAC_APP_DEVELOPMENT", + "MAC_APP_STORE", + "MAC_APP_DIRECT", + "TVOS_APP_DEVELOPMENT", + "TVOS_APP_STORE", + "TVOS_APP_ADHOC", + "TVOS_APP_INHOUSE", + "MAC_CATALYST_APP_DEVELOPMENT", + "MAC_CATALYST_APP_STORE", + "MAC_CATALYST_APP_DIRECT" + ] + }, + "profileState": { + "type": "string", + "enum": [ + "ACTIVE", + "INVALID" + ] + }, + "profileContent": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "createdDate": { + "type": "string", + "format": "date-time" + }, + "expirationDate": { + "type": "string", + "format": "date-time" + } + } + }, + "relationships": { + "type": "object", + "properties": { + "bundleId": { "type": "object", "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, "data": { "type": "object", "properties": { "type": { "type": "string", "enum": [ - "actors" + "bundleIds" ] }, "id": { @@ -229523,9 +236194,12 @@ } } }, - "inAppEvents": { + "devices": { "type": "object", "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, "meta": { "$ref": "#/components/schemas/PagingInformation" }, @@ -229537,7 +236211,7 @@ "type": { "type": "string", "enum": [ - "appEvents" + "devices" ] }, "id": { @@ -229552,9 +236226,12 @@ } } }, - "supportedTerritories": { + "certificates": { "type": "object", "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, "meta": { "$ref": "#/components/schemas/PagingInformation" }, @@ -229566,7 +236243,7 @@ "type": { "type": "string", "enum": [ - "territories" + "certificates" ] }, "id": { @@ -229592,14 +236269,14 @@ "type" ] }, - "NominationsResponse": { + "ProfilesResponse": { "type": "object", - "title": "NominationsResponse", + "title": "ProfilesResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Nomination" + "$ref": "#/components/schemas/Profile" } }, "included": { @@ -229607,25 +236284,21 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/Actor" - }, - { - "$ref": "#/components/schemas/AppEvent" + "$ref": "#/components/schemas/BundleId" }, { - "$ref": "#/components/schemas/App" + "$ref": "#/components/schemas/Certificate" }, { - "$ref": "#/components/schemas/Territory" + "$ref": "#/components/schemas/Device" } ], "discriminator": { "propertyName": "type", "mapping": { - "actors": "#/components/schemas/Actor", - "appEvents": "#/components/schemas/AppEvent", - "territories": "#/components/schemas/Territory", - "apps": "#/components/schemas/App" + "certificates": "#/components/schemas/Certificate", + "devices": "#/components/schemas/Device", + "bundleIds": "#/components/schemas/BundleId" } } } @@ -229642,37 +236315,33 @@ "links" ] }, - "NominationResponse": { + "ProfileResponse": { "type": "object", - "title": "NominationResponse", + "title": "ProfileResponse", "properties": { "data": { - "$ref": "#/components/schemas/Nomination" + "$ref": "#/components/schemas/Profile" }, "included": { "type": "array", "items": { "oneOf": [ { - "$ref": "#/components/schemas/Actor" - }, - { - "$ref": "#/components/schemas/AppEvent" + "$ref": "#/components/schemas/BundleId" }, { - "$ref": "#/components/schemas/App" + "$ref": "#/components/schemas/Certificate" }, { - "$ref": "#/components/schemas/Territory" + "$ref": "#/components/schemas/Device" } ], "discriminator": { "propertyName": "type", "mapping": { - "actors": "#/components/schemas/Actor", - "appEvents": "#/components/schemas/AppEvent", - "territories": "#/components/schemas/Territory", - "apps": "#/components/schemas/App" + "certificates": "#/components/schemas/Certificate", + "devices": "#/components/schemas/Device", + "bundleIds": "#/components/schemas/BundleId" } } } @@ -229686,9 +236355,9 @@ "links" ] }, - "NominationCreateRequest": { + "ProfileCreateRequest": { "type": "object", - "title": "NominationCreateRequest", + "title": "ProfileCreateRequest", "properties": { "data": { "type": "object", @@ -229696,7 +236365,7 @@ "type": { "type": "string", "enum": [ - "nominations" + "profiles" ] }, "attributes": { @@ -229705,109 +236374,61 @@ "name": { "type": "string" }, - "type": { + "profileType": { "type": "string", "enum": [ - "APP_LAUNCH", - "APP_ENHANCEMENTS", - "NEW_CONTENT" + "IOS_APP_DEVELOPMENT", + "IOS_APP_STORE", + "IOS_APP_ADHOC", + "IOS_APP_INHOUSE", + "MAC_APP_DEVELOPMENT", + "MAC_APP_STORE", + "MAC_APP_DIRECT", + "TVOS_APP_DEVELOPMENT", + "TVOS_APP_STORE", + "TVOS_APP_ADHOC", + "TVOS_APP_INHOUSE", + "MAC_CATALYST_APP_DEVELOPMENT", + "MAC_CATALYST_APP_STORE", + "MAC_CATALYST_APP_DIRECT" ] - }, - "description": { - "type": "string" - }, - "submitted": { - "type": "boolean" - }, - "publishStartDate": { - "type": "string", - "format": "date-time" - }, - "publishEndDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "deviceFamilies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceFamily" - }, - "nullable": true - }, - "locales": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "supplementalMaterialsUris": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "nullable": true - }, - "hasInAppEvents": { - "type": "boolean", - "nullable": true - }, - "launchInSelectMarketsFirst": { - "type": "boolean", - "nullable": true - }, - "notes": { - "type": "string", - "nullable": true - }, - "preOrderEnabled": { - "type": "boolean", - "nullable": true } }, "required": [ - "submitted", - "publishStartDate", - "name", - "description", - "type" + "profileType", + "name" ] }, "relationships": { "type": "object", "properties": { - "relatedApps": { + "bundleId": { "type": "object", "properties": { "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "apps" - ] - }, - "id": { - "type": "string" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "bundleIds" + ] }, - "required": [ - "id", - "type" - ] - } + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] } }, "required": [ "data" ] }, - "inAppEvents": { + "devices": { "type": "object", "properties": { "data": { @@ -229818,7 +236439,7 @@ "type": { "type": "string", "enum": [ - "appEvents" + "devices" ] }, "id": { @@ -229833,7 +236454,7 @@ } } }, - "supportedTerritories": { + "certificates": { "type": "object", "properties": { "data": { @@ -229844,7 +236465,7 @@ "type": { "type": "string", "enum": [ - "territories" + "certificates" ] }, "id": { @@ -229857,11 +236478,15 @@ ] } } - } + }, + "required": [ + "data" + ] } }, "required": [ - "relatedApps" + "certificates", + "bundleId" ] } }, @@ -229876,9 +236501,180 @@ "data" ] }, - "NominationUpdateRequest": { + "PromotedPurchase": { "type": "object", - "title": "NominationUpdateRequest", + "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" + ] + }, + "PromotedPurchaseResponse": { + "type": "object", + "title": "PromotedPurchaseResponse", + "properties": { + "data": { + "$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/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "PromotedPurchaseCreateRequest": { + "type": "object", + "title": "PromotedPurchaseCreateRequest", "properties": { "data": { "type": "object", @@ -229886,171 +236682,143 @@ "type": { "type": "string", "enum": [ - "nominations" + "promotedPurchases" ] }, - "id": { - "type": "string" - }, "attributes": { "type": "object", "properties": { - "name": { - "type": "string", - "nullable": true - }, - "type": { - "type": "string", - "nullable": true, - "enum": [ - "APP_LAUNCH", - "APP_ENHANCEMENTS", - "NEW_CONTENT" - ] - }, - "description": { - "type": "string", - "nullable": true - }, - "submitted": { - "type": "boolean", - "nullable": true - }, - "archived": { - "type": "boolean", - "nullable": true - }, - "publishStartDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "publishEndDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "deviceFamilies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceFamily" - }, - "nullable": true - }, - "locales": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "supplementalMaterialsUris": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "nullable": true - }, - "hasInAppEvents": { - "type": "boolean", - "nullable": true - }, - "launchInSelectMarketsFirst": { - "type": "boolean", - "nullable": true - }, - "notes": { - "type": "string", - "nullable": true + "visibleForAllUsers": { + "type": "boolean" }, - "preOrderEnabled": { + "enabled": { "type": "boolean", "nullable": true } - } + }, + "required": [ + "visibleForAllUsers" + ] }, "relationships": { "type": "object", "properties": { - "relatedApps": { + "app": { "type": "object", "properties": { "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "apps" - ] - }, - "id": { - "type": "string" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apps" + ] }, - "required": [ - "id", - "type" - ] - } + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] } - } + }, + "required": [ + "data" + ] }, - "inAppEvents": { + "inAppPurchaseV2": { "type": "object", "properties": { "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "appEvents" - ] - }, - "id": { - "type": "string" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "inAppPurchases" + ] }, - "required": [ - "id", - "type" - ] - } + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] } } }, - "supportedTerritories": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "territories" - ] - }, - "id": { - "type": "string" - } + "subscription": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "subscriptions" + ] }, - "required": [ - "id", - "type" - ] - } + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] } } } + }, + "required": [ + "app" + ] + } + }, + "required": [ + "relationships", + "attributes", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "PromotedPurchaseUpdateRequest": { + "type": "object", + "title": "PromotedPurchaseUpdateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "promotedPurchases" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "visibleForAllUsers": { + "type": "boolean", + "nullable": true + }, + "enabled": { + "type": "boolean", + "nullable": true + } } } }, @@ -230064,14 +236832,14 @@ "data" ] }, - "PassTypeId": { + "RetentionMessageLocalization": { "type": "object", - "title": "PassTypeId", + "title": "RetentionMessageLocalization", "properties": { "type": { "type": "string", "enum": [ - "passTypeIds" + "retentionMessageLocalizations" ] }, "id": { @@ -230080,10 +236848,13 @@ "attributes": { "type": "object", "properties": { - "name": { + "locale": { "type": "string" }, - "identifier": { + "header": { + "type": "string" + }, + "body": { "type": "string" } } @@ -230091,35 +236862,26 @@ "relationships": { "type": "object", "properties": { - "certificates": { + "retentionMessageVersion": { "type": "object", "properties": { - "links": { - "$ref": "#/components/schemas/RelationshipLinks" - }, - "meta": { - "$ref": "#/components/schemas/PagingInformation" - }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "id": { - "type": "string" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessageVersions" + ] }, - "required": [ - "id", - "type" - ] - } + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] } } } @@ -230134,20 +236896,20 @@ "type" ] }, - "PassTypeIdsResponse": { + "RetentionMessageLocalizationsResponse": { "type": "object", - "title": "PassTypeIdsResponse", + "title": "RetentionMessageLocalizationsResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PassTypeId" + "$ref": "#/components/schemas/RetentionMessageLocalization" } }, "included": { "type": "array", "items": { - "$ref": "#/components/schemas/Certificate" + "$ref": "#/components/schemas/RetentionMessageVersion" } }, "links": { @@ -230162,17 +236924,17 @@ "links" ] }, - "PassTypeIdResponse": { + "RetentionMessageLocalizationResponse": { "type": "object", - "title": "PassTypeIdResponse", + "title": "RetentionMessageLocalizationResponse", "properties": { "data": { - "$ref": "#/components/schemas/PassTypeId" + "$ref": "#/components/schemas/RetentionMessageLocalization" }, "included": { "type": "array", "items": { - "$ref": "#/components/schemas/Certificate" + "$ref": "#/components/schemas/RetentionMessageVersion" } }, "links": { @@ -230184,9 +236946,9 @@ "links" ] }, - "PassTypeIdCreateRequest": { + "RetentionMessageLocalizationCreateRequest": { "type": "object", - "title": "PassTypeIdCreateRequest", + "title": "RetentionMessageLocalizationCreateRequest", "properties": { "data": { "type": "object", @@ -230194,26 +236956,65 @@ "type": { "type": "string", "enum": [ - "passTypeIds" + "retentionMessageLocalizations" ] }, "attributes": { "type": "object", "properties": { - "name": { + "locale": { "type": "string" }, - "identifier": { - "type": "string" + "header": { + "type": "string", + "nullable": true + }, + "body": { + "type": "string", + "nullable": true } }, "required": [ - "identifier", - "name" + "locale" + ] + }, + "relationships": { + "type": "object", + "properties": { + "retentionMessageVersion": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessageVersions" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "data" + ] + } + }, + "required": [ + "retentionMessageVersion" ] } }, "required": [ + "relationships", "attributes", "type" ] @@ -230223,9 +237024,9 @@ "data" ] }, - "PassTypeIdUpdateRequest": { + "RetentionMessageLocalizationUpdateRequest": { "type": "object", - "title": "PassTypeIdUpdateRequest", + "title": "RetentionMessageLocalizationUpdateRequest", "properties": { "data": { "type": "object", @@ -230233,7 +237034,7 @@ "type": { "type": "string", "enum": [ - "passTypeIds" + "retentionMessageLocalizations" ] }, "id": { @@ -230242,7 +237043,11 @@ "attributes": { "type": "object", "properties": { - "name": { + "header": { + "type": "string", + "nullable": true + }, + "body": { "type": "string", "nullable": true } @@ -230259,14 +237064,14 @@ "data" ] }, - "PerfPowerMetric": { + "RetentionMessageVersion": { "type": "object", - "title": "PerfPowerMetric", + "title": "RetentionMessageVersion", "properties": { "type": { "type": "string", "enum": [ - "perfPowerMetrics" + "retentionMessageVersions" ] }, "id": { @@ -230275,97 +237080,48 @@ "attributes": { "type": "object", "properties": { - "platform": { - "type": "string", - "enum": [ - "IOS" - ] - }, - "metricType": { + "state": { "type": "string", "enum": [ - "DISK", - "HANG", - "BATTERY", - "LAUNCH", - "MEMORY", - "ANIMATION", - "TERMINATION", - "STORAGE" + "PREPARE_FOR_SUBMISSION", + "READY_FOR_REVIEW", + "WAITING_FOR_REVIEW", + "IN_REVIEW", + "DEVELOPER_REJECTED", + "REJECTED", + "ACCEPTED", + "APPROVED" ] - }, - "deviceType": { - "type": "string" - } - } - }, - "links": { - "$ref": "#/components/schemas/ResourceLinks" - } - }, - "required": [ - "id", - "type" - ] - }, - "PerformanceOverview": { - "type": "object", - "title": "PerformanceOverview", - "properties": { - "type": { - "type": "string", - "enum": [ - "performanceOverviews" - ] - }, - "id": { - "type": "string" - }, - "attributes": { - "type": "object", - "properties": { - "deviceType": { - "type": "string" - } - } - }, - "links": { - "$ref": "#/components/schemas/ResourceLinks" - } - }, - "required": [ - "id", - "type" - ] - }, - "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": { + "retentionMessage": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "localizations": { "type": "object", "properties": { "links": { @@ -230382,7 +237138,7 @@ "type": { "type": "string", "enum": [ - "builds" + "retentionMessageLocalizations" ] }, "id": { @@ -230397,7 +237153,7 @@ } } }, - "app": { + "placement": { "type": "object", "properties": { "links": { @@ -230409,7 +237165,7 @@ "type": { "type": "string", "enum": [ - "apps" + "appAssetLibraryPlacements" ] }, "id": { @@ -230434,14 +237190,14 @@ "type" ] }, - "PreReleaseVersionsResponse": { + "RetentionMessageVersionsResponse": { "type": "object", - "title": "PreReleaseVersionsResponse", + "title": "RetentionMessageVersionsResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PrereleaseVersion" + "$ref": "#/components/schemas/RetentionMessageVersion" } }, "included": { @@ -230449,17 +237205,21 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/App" + "$ref": "#/components/schemas/AppAssetLibraryPlacement" }, { - "$ref": "#/components/schemas/Build" + "$ref": "#/components/schemas/RetentionMessageLocalization" + }, + { + "$ref": "#/components/schemas/RetentionMessage" } ], "discriminator": { "propertyName": "type", "mapping": { - "builds": "#/components/schemas/Build", - "apps": "#/components/schemas/App" + "retentionMessageLocalizations": "#/components/schemas/RetentionMessageLocalization", + "appAssetLibraryPlacements": "#/components/schemas/AppAssetLibraryPlacement", + "retentionMessages": "#/components/schemas/RetentionMessage" } } } @@ -230476,29 +237236,33 @@ "links" ] }, - "PrereleaseVersionResponse": { + "RetentionMessageVersionResponse": { "type": "object", - "title": "PrereleaseVersionResponse", + "title": "RetentionMessageVersionResponse", "properties": { "data": { - "$ref": "#/components/schemas/PrereleaseVersion" + "$ref": "#/components/schemas/RetentionMessageVersion" }, "included": { "type": "array", "items": { "oneOf": [ { - "$ref": "#/components/schemas/App" + "$ref": "#/components/schemas/AppAssetLibraryPlacement" }, { - "$ref": "#/components/schemas/Build" + "$ref": "#/components/schemas/RetentionMessageLocalization" + }, + { + "$ref": "#/components/schemas/RetentionMessage" } ], "discriminator": { "propertyName": "type", "mapping": { - "builds": "#/components/schemas/Build", - "apps": "#/components/schemas/App" + "retentionMessageLocalizations": "#/components/schemas/RetentionMessageLocalization", + "appAssetLibraryPlacements": "#/components/schemas/AppAssetLibraryPlacement", + "retentionMessages": "#/components/schemas/RetentionMessage" } } } @@ -230512,14 +237276,95 @@ "links" ] }, - "Profile": { + "RetentionMessageVersionCreateRequest": { "type": "object", - "title": "Profile", + "title": "RetentionMessageVersionCreateRequest", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessageVersions" + ] + }, + "relationships": { + "type": "object", + "properties": { + "retentionMessage": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "placement": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "appAssetLibraryPlacements" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + }, + "required": [ + "retentionMessage" + ] + } + }, + "required": [ + "relationships", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "RetentionMessage": { + "type": "object", + "title": "RetentionMessage", "properties": { "type": { "type": "string", "enum": [ - "profiles" + "retentionMessages" ] }, "id": { @@ -230528,84 +237373,15 @@ "attributes": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "platform": { - "$ref": "#/components/schemas/BundleIdPlatform" - }, - "profileType": { - "type": "string", - "enum": [ - "IOS_APP_DEVELOPMENT", - "IOS_APP_STORE", - "IOS_APP_ADHOC", - "IOS_APP_INHOUSE", - "MAC_APP_DEVELOPMENT", - "MAC_APP_STORE", - "MAC_APP_DIRECT", - "TVOS_APP_DEVELOPMENT", - "TVOS_APP_STORE", - "TVOS_APP_ADHOC", - "TVOS_APP_INHOUSE", - "MAC_CATALYST_APP_DEVELOPMENT", - "MAC_CATALYST_APP_STORE", - "MAC_CATALYST_APP_DIRECT" - ] - }, - "profileState": { - "type": "string", - "enum": [ - "ACTIVE", - "INVALID" - ] - }, - "profileContent": { - "type": "string" - }, - "uuid": { + "referenceName": { "type": "string" - }, - "createdDate": { - "type": "string", - "format": "date-time" - }, - "expirationDate": { - "type": "string", - "format": "date-time" } } }, "relationships": { "type": "object", "properties": { - "bundleId": { - "type": "object", - "properties": { - "links": { - "$ref": "#/components/schemas/RelationshipLinks" - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "bundleIds" - ] - }, - "id": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - } - } - }, - "devices": { + "versions": { "type": "object", "properties": { "links": { @@ -230622,7 +237398,7 @@ "type": { "type": "string", "enum": [ - "devices" + "retentionMessageVersions" ] }, "id": { @@ -230637,7 +237413,7 @@ } } }, - "certificates": { + "subscriptions": { "type": "object", "properties": { "links": { @@ -230654,7 +237430,7 @@ "type": { "type": "string", "enum": [ - "certificates" + "subscriptions" ] }, "id": { @@ -230680,14 +237456,14 @@ "type" ] }, - "ProfilesResponse": { + "RetentionMessagesResponse": { "type": "object", - "title": "ProfilesResponse", + "title": "RetentionMessagesResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Profile" + "$ref": "#/components/schemas/RetentionMessage" } }, "included": { @@ -230695,21 +237471,17 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/BundleId" - }, - { - "$ref": "#/components/schemas/Certificate" + "$ref": "#/components/schemas/RetentionMessageVersion" }, { - "$ref": "#/components/schemas/Device" + "$ref": "#/components/schemas/Subscription" } ], "discriminator": { "propertyName": "type", "mapping": { - "certificates": "#/components/schemas/Certificate", - "devices": "#/components/schemas/Device", - "bundleIds": "#/components/schemas/BundleId" + "subscriptions": "#/components/schemas/Subscription", + "retentionMessageVersions": "#/components/schemas/RetentionMessageVersion" } } } @@ -230726,33 +237498,29 @@ "links" ] }, - "ProfileResponse": { + "RetentionMessageResponse": { "type": "object", - "title": "ProfileResponse", + "title": "RetentionMessageResponse", "properties": { "data": { - "$ref": "#/components/schemas/Profile" + "$ref": "#/components/schemas/RetentionMessage" }, "included": { "type": "array", "items": { "oneOf": [ { - "$ref": "#/components/schemas/BundleId" - }, - { - "$ref": "#/components/schemas/Certificate" + "$ref": "#/components/schemas/RetentionMessageVersion" }, { - "$ref": "#/components/schemas/Device" + "$ref": "#/components/schemas/Subscription" } ], "discriminator": { "propertyName": "type", "mapping": { - "certificates": "#/components/schemas/Certificate", - "devices": "#/components/schemas/Device", - "bundleIds": "#/components/schemas/BundleId" + "subscriptions": "#/components/schemas/Subscription", + "retentionMessageVersions": "#/components/schemas/RetentionMessageVersion" } } } @@ -230766,9 +237534,9 @@ "links" ] }, - "ProfileCreateRequest": { + "RetentionMessageCreateRequest": { "type": "object", - "title": "ProfileCreateRequest", + "title": "RetentionMessageCreateRequest", "properties": { "data": { "type": "object", @@ -230776,44 +237544,24 @@ "type": { "type": "string", "enum": [ - "profiles" + "retentionMessages" ] }, "attributes": { "type": "object", "properties": { - "name": { + "referenceName": { "type": "string" - }, - "profileType": { - "type": "string", - "enum": [ - "IOS_APP_DEVELOPMENT", - "IOS_APP_STORE", - "IOS_APP_ADHOC", - "IOS_APP_INHOUSE", - "MAC_APP_DEVELOPMENT", - "MAC_APP_STORE", - "MAC_APP_DIRECT", - "TVOS_APP_DEVELOPMENT", - "TVOS_APP_STORE", - "TVOS_APP_ADHOC", - "TVOS_APP_INHOUSE", - "MAC_CATALYST_APP_DEVELOPMENT", - "MAC_CATALYST_APP_STORE", - "MAC_CATALYST_APP_DIRECT" - ] } }, "required": [ - "profileType", - "name" + "referenceName" ] }, "relationships": { "type": "object", "properties": { - "bundleId": { + "app": { "type": "object", "properties": { "data": { @@ -230822,7 +237570,7 @@ "type": { "type": "string", "enum": [ - "bundleIds" + "apps" ] }, "id": { @@ -230838,66 +237586,10 @@ "required": [ "data" ] - }, - "devices": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "devices" - ] - }, - "id": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - } - } - } - }, - "certificates": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "id": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - } - } - }, - "required": [ - "data" - ] } }, "required": [ - "certificates", - "bundleId" + "app" ] } }, @@ -230912,43 +237604,23 @@ "data" ] }, - "PromotedPurchase": { + "RetentionOfferPrice": { "type": "object", - "title": "PromotedPurchase", + "title": "RetentionOfferPrice", "properties": { "type": { "type": "string", "enum": [ - "promotedPurchases" + "retentionOfferPrices" ] }, "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": { + "territory": { "type": "object", "properties": { "data": { @@ -230957,7 +237629,30 @@ "type": { "type": "string", "enum": [ - "inAppPurchases" + "territories" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "subscriptionPricePoint": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "subscriptionPricePoints" ] }, "id": { @@ -230970,7 +237665,122 @@ ] } } + } + } + }, + "links": { + "$ref": "#/components/schemas/ResourceLinks" + } + }, + "required": [ + "id", + "type" + ] + }, + "RetentionOfferPriceInlineCreate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionOfferPrices" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "RetentionOfferPricesResponse": { + "type": "object", + "title": "RetentionOfferPricesResponse", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetentionOfferPrice" + } + }, + "included": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/SubscriptionPricePoint" + }, + { + "$ref": "#/components/schemas/Territory" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "territories": "#/components/schemas/Territory", + "subscriptionPricePoints": "#/components/schemas/SubscriptionPricePoint" + } + } + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "RetentionOffer": { + "type": "object", + "title": "RetentionOffer", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionOffers" + ] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "referenceName": { + "type": "string" + }, + "offerId": { + "type": "string" + }, + "duration": { + "$ref": "#/components/schemas/SubscriptionOfferDuration" + }, + "offerMode": { + "$ref": "#/components/schemas/SubscriptionOfferMode" + }, + "periodCount": { + "type": "integer" + }, + "customerEligibilityPaidSubscriptionDurationInMonths": { + "type": "integer" }, + "customerEligibilityWaitBetweenOffersInMonths": { + "type": "integer" + }, + "targetSubscriptionPlanType": { + "$ref": "#/components/schemas/SubscriptionPlanType" + } + } + }, + "relationships": { + "type": "object", + "properties": { "subscription": { "type": "object", "properties": { @@ -230993,6 +237803,38 @@ ] } } + }, + "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": [ + "retentionOfferPrices" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } } }, @@ -231005,14 +237847,14 @@ "type" ] }, - "PromotedPurchasesResponse": { + "RetentionOffersResponse": { "type": "object", - "title": "PromotedPurchasesResponse", + "title": "RetentionOffersResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotedPurchase" + "$ref": "#/components/schemas/RetentionOffer" } }, "included": { @@ -231020,7 +237862,7 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/InAppPurchaseV2" + "$ref": "#/components/schemas/RetentionOfferPrice" }, { "$ref": "#/components/schemas/Subscription" @@ -231030,7 +237872,7 @@ "propertyName": "type", "mapping": { "subscriptions": "#/components/schemas/Subscription", - "inAppPurchases": "#/components/schemas/InAppPurchaseV2" + "retentionOfferPrices": "#/components/schemas/RetentionOfferPrice" } } } @@ -231047,19 +237889,19 @@ "links" ] }, - "PromotedPurchaseResponse": { + "RetentionOfferResponse": { "type": "object", - "title": "PromotedPurchaseResponse", + "title": "RetentionOfferResponse", "properties": { "data": { - "$ref": "#/components/schemas/PromotedPurchase" + "$ref": "#/components/schemas/RetentionOffer" }, "included": { "type": "array", "items": { "oneOf": [ { - "$ref": "#/components/schemas/InAppPurchaseV2" + "$ref": "#/components/schemas/RetentionOfferPrice" }, { "$ref": "#/components/schemas/Subscription" @@ -231069,7 +237911,7 @@ "propertyName": "type", "mapping": { "subscriptions": "#/components/schemas/Subscription", - "inAppPurchases": "#/components/schemas/InAppPurchaseV2" + "retentionOfferPrices": "#/components/schemas/RetentionOfferPrice" } } } @@ -231083,9 +237925,9 @@ "links" ] }, - "PromotedPurchaseCreateRequest": { + "RetentionOfferCreateRequest": { "type": "object", - "title": "PromotedPurchaseCreateRequest", + "title": "RetentionOfferCreateRequest", "properties": { "data": { "type": "object", @@ -231093,28 +237935,52 @@ "type": { "type": "string", "enum": [ - "promotedPurchases" + "retentionOffers" ] }, "attributes": { "type": "object", "properties": { - "visibleForAllUsers": { - "type": "boolean" + "referenceName": { + "type": "string" }, - "enabled": { - "type": "boolean", + "offerId": { + "type": "string" + }, + "duration": { + "$ref": "#/components/schemas/SubscriptionOfferDuration" + }, + "offerMode": { + "$ref": "#/components/schemas/SubscriptionOfferMode" + }, + "periodCount": { + "type": "integer" + }, + "customerEligibilityPaidSubscriptionDurationInMonths": { + "type": "integer" + }, + "customerEligibilityWaitBetweenOffersInMonths": { + "type": "integer", "nullable": true + }, + "targetSubscriptionPlanType": { + "nullable": true, + "$ref": "#/components/schemas/SubscriptionPlanType" } }, "required": [ - "visibleForAllUsers" + "duration", + "periodCount", + "offerId", + "offerMode", + "customerEligibilityPaidSubscriptionDurationInMonths", + "referenceName" ] }, "relationships": { "type": "object", "properties": { - "app": { + "subscription": { "type": "object", "properties": { "data": { @@ -231123,7 +237989,7 @@ "type": { "type": "string", "enum": [ - "apps" + "subscriptions" ] }, "id": { @@ -231140,55 +238006,39 @@ "data" ] }, - "inAppPurchaseV2": { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "inAppPurchases" - ] - }, - "id": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - } - } - }, - "subscription": { + "prices": { "type": "object", "properties": { "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "subscriptions" - ] + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionOfferPrices" + ] + }, + "id": { + "type": "string" + } }, - "id": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] + "required": [ + "id", + "type" + ] + } } - } + }, + "required": [ + "data" + ] } }, "required": [ - "app" + "subscription", + "prices" ] } }, @@ -231197,15 +238047,21 @@ "attributes", "type" ] + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetentionOfferPriceInlineCreate" + } } }, "required": [ "data" ] }, - "PromotedPurchaseUpdateRequest": { + "RetentionOfferUpdateRequest": { "type": "object", - "title": "PromotedPurchaseUpdateRequest", + "title": "RetentionOfferUpdateRequest", "properties": { "data": { "type": "object", @@ -231213,7 +238069,7 @@ "type": { "type": "string", "enum": [ - "promotedPurchases" + "retentionOffers" ] }, "id": { @@ -231222,12 +238078,12 @@ "attributes": { "type": "object", "properties": { - "visibleForAllUsers": { - "type": "boolean", + "customerEligibilityPaidSubscriptionDurationInMonths": { + "type": "integer", "nullable": true }, - "enabled": { - "type": "boolean", + "customerEligibilityWaitBetweenOffersInMonths": { + "type": "integer", "nullable": true } } @@ -231641,6 +238497,29 @@ ] } } + }, + "retentionMessageVersion": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessageVersions" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } } } }, @@ -231707,95 +238586,102 @@ "$ref": "#/components/schemas/InAppPurchaseVersion" }, { - "$ref": "#/components/schemas/SubscriptionGroupVersion" - }, - { - "$ref": "#/components/schemas/SubscriptionVersion" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "appAssetLibraryImages": "#/components/schemas/AppAssetLibraryImage", - "appEvents": "#/components/schemas/AppEvent", - "gameCenterAchievementVersions": "#/components/schemas/GameCenterAchievementVersionV2", - "appStoreVersionExperiments": "#/components/schemas/AppStoreVersionExperiment", - "gameCenterActivityVersions": "#/components/schemas/GameCenterActivityVersion", - "inAppPurchaseVersions": "#/components/schemas/InAppPurchaseVersion", - "subscriptionVersions": "#/components/schemas/SubscriptionVersion", - "gameCenterChallengeVersions": "#/components/schemas/GameCenterChallengeVersion", - "subscriptionGroupVersions": "#/components/schemas/SubscriptionGroupVersion", - "appStoreVersions": "#/components/schemas/AppStoreVersion", - "appAssetLibraryVideos": "#/components/schemas/AppAssetLibraryVideo", - "backgroundAssetVersions": "#/components/schemas/BackgroundAssetVersion", - "gameCenterLeaderboardSetVersions": "#/components/schemas/GameCenterLeaderboardSetVersionV2", - "appCustomProductPageVersions": "#/components/schemas/AppCustomProductPageVersion", - "gameCenterLeaderboardVersions": "#/components/schemas/GameCenterLeaderboardVersionV2" - } - } - } - }, - "links": { - "$ref": "#/components/schemas/PagedDocumentLinks" - }, - "meta": { - "$ref": "#/components/schemas/PagingInformation" - } - }, - "required": [ - "data", - "links" - ] - }, - "ReviewSubmissionItemResponse": { - "type": "object", - "title": "ReviewSubmissionItemResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/ReviewSubmissionItem" - }, - "included": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AppAssetLibraryImage" - }, - { - "$ref": "#/components/schemas/AppAssetLibraryVideo" - }, - { - "$ref": "#/components/schemas/AppCustomProductPageVersion" - }, - { - "$ref": "#/components/schemas/AppEvent" - }, - { - "$ref": "#/components/schemas/AppStoreVersionExperiment" - }, - { - "$ref": "#/components/schemas/AppStoreVersion" - }, - { - "$ref": "#/components/schemas/BackgroundAssetVersion" - }, - { - "$ref": "#/components/schemas/GameCenterAchievementVersionV2" - }, - { - "$ref": "#/components/schemas/GameCenterActivityVersion" - }, - { - "$ref": "#/components/schemas/GameCenterChallengeVersion" - }, - { - "$ref": "#/components/schemas/GameCenterLeaderboardSetVersionV2" - }, - { - "$ref": "#/components/schemas/GameCenterLeaderboardVersionV2" - }, - { - "$ref": "#/components/schemas/InAppPurchaseVersion" + "$ref": "#/components/schemas/RetentionMessageVersion" + }, + { + "$ref": "#/components/schemas/SubscriptionGroupVersion" + }, + { + "$ref": "#/components/schemas/SubscriptionVersion" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "appAssetLibraryImages": "#/components/schemas/AppAssetLibraryImage", + "appEvents": "#/components/schemas/AppEvent", + "gameCenterAchievementVersions": "#/components/schemas/GameCenterAchievementVersionV2", + "retentionMessageVersions": "#/components/schemas/RetentionMessageVersion", + "appStoreVersionExperiments": "#/components/schemas/AppStoreVersionExperiment", + "gameCenterActivityVersions": "#/components/schemas/GameCenterActivityVersion", + "inAppPurchaseVersions": "#/components/schemas/InAppPurchaseVersion", + "subscriptionVersions": "#/components/schemas/SubscriptionVersion", + "gameCenterChallengeVersions": "#/components/schemas/GameCenterChallengeVersion", + "subscriptionGroupVersions": "#/components/schemas/SubscriptionGroupVersion", + "appStoreVersions": "#/components/schemas/AppStoreVersion", + "appAssetLibraryVideos": "#/components/schemas/AppAssetLibraryVideo", + "backgroundAssetVersions": "#/components/schemas/BackgroundAssetVersion", + "gameCenterLeaderboardSetVersions": "#/components/schemas/GameCenterLeaderboardSetVersionV2", + "appCustomProductPageVersions": "#/components/schemas/AppCustomProductPageVersion", + "gameCenterLeaderboardVersions": "#/components/schemas/GameCenterLeaderboardVersionV2" + } + } + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "ReviewSubmissionItemResponse": { + "type": "object", + "title": "ReviewSubmissionItemResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/ReviewSubmissionItem" + }, + "included": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppAssetLibraryImage" + }, + { + "$ref": "#/components/schemas/AppAssetLibraryVideo" + }, + { + "$ref": "#/components/schemas/AppCustomProductPageVersion" + }, + { + "$ref": "#/components/schemas/AppEvent" + }, + { + "$ref": "#/components/schemas/AppStoreVersionExperiment" + }, + { + "$ref": "#/components/schemas/AppStoreVersion" + }, + { + "$ref": "#/components/schemas/BackgroundAssetVersion" + }, + { + "$ref": "#/components/schemas/GameCenterAchievementVersionV2" + }, + { + "$ref": "#/components/schemas/GameCenterActivityVersion" + }, + { + "$ref": "#/components/schemas/GameCenterChallengeVersion" + }, + { + "$ref": "#/components/schemas/GameCenterLeaderboardSetVersionV2" + }, + { + "$ref": "#/components/schemas/GameCenterLeaderboardVersionV2" + }, + { + "$ref": "#/components/schemas/InAppPurchaseVersion" + }, + { + "$ref": "#/components/schemas/RetentionMessageVersion" }, { "$ref": "#/components/schemas/SubscriptionGroupVersion" @@ -231810,6 +238696,7 @@ "appAssetLibraryImages": "#/components/schemas/AppAssetLibraryImage", "appEvents": "#/components/schemas/AppEvent", "gameCenterAchievementVersions": "#/components/schemas/GameCenterAchievementVersionV2", + "retentionMessageVersions": "#/components/schemas/RetentionMessageVersion", "appStoreVersionExperiments": "#/components/schemas/AppStoreVersionExperiment", "gameCenterActivityVersions": "#/components/schemas/GameCenterActivityVersion", "inAppPurchaseVersions": "#/components/schemas/InAppPurchaseVersion", @@ -232244,6 +239131,29 @@ ] } } + }, + "retentionMessageVersion": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessageVersions" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } } }, "required": [ @@ -240306,6 +247216,96 @@ } } } + }, + "retentionOffers": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionOffers" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } + }, + "retentionMessage": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "retentionMessageOffers": { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/RelationshipLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionOffers" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } } }, @@ -240335,6 +247335,12 @@ { "$ref": "#/components/schemas/PromotedPurchase" }, + { + "$ref": "#/components/schemas/RetentionMessage" + }, + { + "$ref": "#/components/schemas/RetentionOffer" + }, { "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshot" }, @@ -240375,8 +247381,10 @@ "discriminator": { "propertyName": "type", "mapping": { + "retentionOffers": "#/components/schemas/RetentionOffer", "subscriptionAppStoreReviewScreenshots": "#/components/schemas/SubscriptionAppStoreReviewScreenshot", "winBackOffers": "#/components/schemas/WinBackOffer", + "retentionMessages": "#/components/schemas/RetentionMessage", "subscriptionOfferCodes": "#/components/schemas/SubscriptionOfferCode", "subscriptionPlanAvailabilities": "#/components/schemas/SubscriptionPlanAvailability", "subscriptionVersions": "#/components/schemas/SubscriptionVersion", @@ -240418,6 +247426,12 @@ { "$ref": "#/components/schemas/PromotedPurchase" }, + { + "$ref": "#/components/schemas/RetentionMessage" + }, + { + "$ref": "#/components/schemas/RetentionOffer" + }, { "$ref": "#/components/schemas/SubscriptionAppStoreReviewScreenshot" }, @@ -240458,8 +247472,10 @@ "discriminator": { "propertyName": "type", "mapping": { + "retentionOffers": "#/components/schemas/RetentionOffer", "subscriptionAppStoreReviewScreenshots": "#/components/schemas/SubscriptionAppStoreReviewScreenshot", "winBackOffers": "#/components/schemas/WinBackOffer", + "retentionMessages": "#/components/schemas/RetentionMessage", "subscriptionOfferCodes": "#/components/schemas/SubscriptionOfferCode", "subscriptionPlanAvailabilities": "#/components/schemas/SubscriptionPlanAvailability", "subscriptionVersions": "#/components/schemas/SubscriptionVersion", @@ -240731,6 +247747,55 @@ } } } + }, + "retentionMessage": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "retentionMessageOffers": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionOffers" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + } } } } @@ -246931,20 +253996,49 @@ "type" ] } - }, - "links": { - "$ref": "#/components/schemas/PagedDocumentLinks" - }, - "meta": { - "$ref": "#/components/schemas/PagingInformation" + }, + "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", - "links" + "data" ] }, - "AppPromotedPurchasesLinkagesRequest": { + "AppRetentionMessagesLinkagesResponse": { "type": "object", "properties": { "data": { @@ -246955,7 +254049,7 @@ "type": { "type": "string", "enum": [ - "promotedPurchases" + "retentionMessages" ] }, "id": { @@ -246967,10 +254061,17 @@ "type" ] } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" } }, "required": [ - "data" + "data", + "links" ] }, "AppReviewSubmissionsLinkagesResponse": { @@ -253366,28 +260467,256 @@ "links" ] }, - "MerchantIdCertificatesLinkagesResponse": { + "MerchantIdCertificatesLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "certificates" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "PassTypeIdCertificatesLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "certificates" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "PrereleaseVersionAppLinkageResponse": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apps" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "PrereleaseVersionBuildsLinkagesResponse": { + "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" + ] + }, + "BundleIdWithoutIncludesResponse": { + "type": "object", + "title": "BundleIdWithoutIncludesResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/BundleId" + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "ProfileBundleIdLinkageResponse": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "bundleIds" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "CertificatesWithoutIncludesResponse": { + "type": "object", + "title": "CertificatesWithoutIncludesResponse", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Certificate" + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "ProfileCertificatesLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "certificates" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "DevicesWithoutIncludesResponse": { "type": "object", + "title": "DevicesWithoutIncludesResponse", "properties": { "data": { "type": "array", "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "id": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] + "$ref": "#/components/schemas/Device" } }, "links": { @@ -253402,7 +260731,7 @@ "links" ] }, - "PassTypeIdCertificatesLinkagesResponse": { + "ProfileDevicesLinkagesResponse": { "type": "object", "properties": { "data": { @@ -253413,7 +260742,7 @@ "type": { "type": "string", "enum": [ - "certificates" + "devices" ] }, "id": { @@ -253438,37 +260767,7 @@ "links" ] }, - "PrereleaseVersionAppLinkageResponse": { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "apps" - ] - }, - "id": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "links": { - "$ref": "#/components/schemas/DocumentLinks" - } - }, - "required": [ - "data", - "links" - ] - }, - "PrereleaseVersionBuildsLinkagesResponse": { + "RetentionMessageVersionLocalizationsLinkagesResponse": { "type": "object", "properties": { "data": { @@ -253479,7 +260778,7 @@ "type": { "type": "string", "enum": [ - "builds" + "retentionMessageLocalizations" ] }, "id": { @@ -253504,23 +260803,7 @@ "links" ] }, - "BundleIdWithoutIncludesResponse": { - "type": "object", - "title": "BundleIdWithoutIncludesResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/BundleId" - }, - "links": { - "$ref": "#/components/schemas/DocumentLinks" - } - }, - "required": [ - "data", - "links" - ] - }, - "ProfileBundleIdLinkageResponse": { + "RetentionMessageVersionPlacementLinkageResponse": { "type": "object", "properties": { "data": { @@ -253529,7 +260812,7 @@ "type": { "type": "string", "enum": [ - "bundleIds" + "appAssetLibraryPlacements" ] }, "id": { @@ -253550,29 +260833,7 @@ "links" ] }, - "CertificatesWithoutIncludesResponse": { - "type": "object", - "title": "CertificatesWithoutIncludesResponse", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Certificate" - } - }, - "links": { - "$ref": "#/components/schemas/PagedDocumentLinks" - }, - "meta": { - "$ref": "#/components/schemas/PagingInformation" - } - }, - "required": [ - "data", - "links" - ] - }, - "ProfileCertificatesLinkagesResponse": { + "RetentionMessageSubscriptionsLinkagesResponse": { "type": "object", "properties": { "data": { @@ -253583,7 +260844,7 @@ "type": { "type": "string", "enum": [ - "certificates" + "subscriptions" ] }, "id": { @@ -253608,14 +260869,28 @@ "links" ] }, - "DevicesWithoutIncludesResponse": { + "RetentionMessageVersionsLinkagesResponse": { "type": "object", - "title": "DevicesWithoutIncludesResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Device" + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessageVersions" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] } }, "links": { @@ -253630,7 +260905,7 @@ "links" ] }, - "ProfileDevicesLinkagesResponse": { + "RetentionOfferPricesLinkagesResponse": { "type": "object", "properties": { "data": { @@ -253641,7 +260916,7 @@ "type": { "type": "string", "enum": [ - "devices" + "retentionOfferPrices" ] }, "id": { @@ -254738,6 +262013,163 @@ "links" ] }, + "SubscriptionRetentionMessageLinkageResponse": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "links": { + "$ref": "#/components/schemas/DocumentLinks" + } + }, + "required": [ + "data", + "links" + ] + }, + "SubscriptionRetentionMessageLinkageRequest": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionMessages" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "data" + ] + }, + "SubscriptionRetentionMessageOffersLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionOffers" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, + "SubscriptionRetentionMessageOffersLinkagesRequest": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionOffers" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + }, + "required": [ + "data" + ] + }, + "SubscriptionRetentionOffersLinkagesResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "retentionOffers" + ] + }, + "id": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "links": { + "$ref": "#/components/schemas/PagedDocumentLinks" + }, + "meta": { + "$ref": "#/components/schemas/PagingInformation" + } + }, + "required": [ + "data", + "links" + ] + }, "SubscriptionSubscriptionAvailabilityLinkageResponse": { "type": "object", "properties": { diff --git a/Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.6.provenance.json b/Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.6.provenance.json new file mode 100644 index 0000000..5f3e78c --- /dev/null +++ b/Tests/ASCMCPTests/Fixtures/OpenAPI/app-store-connect-4.6.provenance.json @@ -0,0 +1,11 @@ +{ + "version": "4.6", + "sourceURL": "https://developer.apple.com/sample-code/app-store-connect/app-store-connect-openapi-specification.zip", + "retrievedAt": "2026-11-07", + "sha256": "74732362a91236dcb66eb1620f8be18c2b6060771269b483eab578473bb32763", + "pathCount": 1027, + "operationCount": 1337, + "releaseNotes": [ + "https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-4-6-release-notes" + ] +} diff --git a/Tests/ASCMCPTests/Tooling/API451ContractTests.swift b/Tests/ASCMCPTests/Tooling/API451ContractTests.swift index 79d6102..7c0ea6f 100644 --- a/Tests/ASCMCPTests/Tooling/API451ContractTests.swift +++ b/Tests/ASCMCPTests/Tooling/API451ContractTests.swift @@ -7,7 +7,7 @@ import Testing struct API451ContractTests { @Test("pinned Apple snapshot is exact and agrees with the manifest") func pinnedSnapshotIsExact() throws { - let raw = try Data(contentsOf: fixtureURL("OpenAPI/app-store-connect-4.5.1.oas.json")) + let raw = try Data(contentsOf: fixtureURL("OpenAPI/app-store-connect-4.6.oas.json")) let sha256 = SHA256.hash(data: raw).map { String(format: "%02x", $0) }.joined() let object = try #require(JSONSerialization.jsonObject(with: raw) as? [String: Any]) let info = try #require(object["info"] as? [String: Any]) @@ -17,12 +17,12 @@ struct API451ContractTests { } let manifest = try ASCOperationManifestBundle.loadBundled() - #expect(sha256 == "7518d3a94a8bd701ac25c1c601b95b8f53aad92091affb15a2a9d331713dac1a") - #expect(info["version"] as? String == "4.5.1") - #expect(paths.count == 1001) - #expect(operationCount == 1303) + #expect(sha256 == "74732362a91236dcb66eb1620f8be18c2b6060771269b483eab578473bb32763") + #expect(info["version"] as? String == "4.6") + #expect(paths.count == 1027) + #expect(operationCount == 1337) #expect(manifest.index.specPin == ASCSpecPin( - version: "4.5.1", sha256: sha256, pathCount: paths.count, operationCount: operationCount + version: "4.6", sha256: sha256, pathCount: paths.count, operationCount: operationCount )) } @@ -65,12 +65,12 @@ struct API451ContractTests { case "unsupported": #expect(decision.path.contains("/relationships/")) #expect(manifest.index.waivers.contains { - $0.operationID == decision.operationId && $0.disposition == .unsupported && $0.reviewAtSpec == "4.5.1" + $0.operationID == decision.operationId && $0.disposition == .unsupported && $0.reviewAtSpec == "4.6" }) #expect(!implemented.contains(decision.operationId)) case "outOfScope": #expect(manifest.index.scopeRules.contains { - decision.path.hasPrefix($0.pathPrefix) && $0.disposition == .outOfScope && $0.reviewAtSpec == "4.5.1" + decision.path.hasPrefix($0.pathPrefix) && $0.disposition == .outOfScope && $0.reviewAtSpec == "4.6" }) default: Issue.record("Unrecognized operation decision: \(decision.decision)") @@ -78,6 +78,35 @@ struct API451ContractTests { } } + @Test("every new 4.6 operation has its approved implementation or scope decision") + func new46OperationsAreExplicitlyAccountedFor() throws { + let data = try Data(contentsOf: fixtureURL("OpenAPI/api-4.6-operation-decisions.json")) + let decisions = try JSONDecoder().decode(OperationDecisions.self, from: data).operations + let manifest = try ASCOperationManifestBundle.loadBundled() + let implemented = Set(manifest.tools.filter { + $0.implementationState == .asBuilt && $0.status != .unresolved + }.flatMap(\.operations).map(\.operationID)) + + #expect(decisions.count == 34) + #expect(decisions.filter { $0.decision == "requiredMapping" }.count == 25) + #expect(decisions.filter { $0.decision == "unsupported" }.count == 9) + for decision in decisions { + switch decision.decision { + case "requiredMapping": + #expect(implemented.contains(decision.operationId), "Missing implementation mapping: \(decision.operationId)") + #expect(!manifest.index.waivers.contains { $0.operationID == decision.operationId }) + case "unsupported": + #expect(decision.path.contains("/relationships/")) + #expect(manifest.index.waivers.contains { + $0.operationID == decision.operationId && $0.disposition == .unsupported && $0.reviewAtSpec == "4.6" + }) + #expect(!implemented.contains(decision.operationId)) + default: + Issue.record("Unrecognized operation decision: \(decision.decision)") + } + } + } + @Test("release-note deprecations remain visible when OpenAPI omits the flag") func semanticDeprecationWithoutOpenAPIFlag() throws { let spec = try ASCOpenAPISpec.parse(Data(contentsOf: fixtureURL("openapi_minimal.oas.json"))) diff --git a/Tests/ASCMCPTests/Tooling/AssetsManifestContractTests.swift b/Tests/ASCMCPTests/Tooling/AssetsManifestContractTests.swift index d10860e..7f2cf7a 100644 --- a/Tests/ASCMCPTests/Tooling/AssetsManifestContractTests.swift +++ b/Tests/ASCMCPTests/Tooling/AssetsManifestContractTests.swift @@ -28,7 +28,7 @@ struct AssetsManifestContractTests { $0 == "apps_assetLibrary_getToOneRelated" } #expect(assetOperationIDs.count == 24) - #expect(operationIDs.count == 40) + #expect(operationIDs.count == 43) #expect(operationIDs.contains("reviewSubmissionItems_createInstance")) #expect(!worker.tools.flatMap(\.operations).contains { $0.path.contains("/relationships/") }) #expect(manifest.index.waivers.allSatisfy { @@ -39,7 +39,7 @@ struct AssetsManifestContractTests { @Test("asset input and response mappings match the pinned Apple contract") func pinnedContract() throws { let fixture = try #require(Bundle.module.url(forResource: "Fixtures", withExtension: nil)) - .appendingPathComponent("OpenAPI/app-store-connect-4.5.1.oas.json") + .appendingPathComponent("OpenAPI/app-store-connect-4.6.oas.json") let spec = try ASCOpenAPISpec.parse(Data(contentsOf: fixture)) let manifest = try ASCOperationManifestBundle.loadBundled() let diagnostics = ASCOperationToolAnalyzer().analyze(spec: spec, manifest: manifest) @@ -52,7 +52,7 @@ struct AssetsManifestContractTests { let worker = try #require(manifest.workers.first { $0.workerKey == "assets" }) #expect(worker.tools.flatMap(\.operations).flatMap { $0.optionalParameterClassifications ?? [] - }.allSatisfy { $0.reviewAtSpec == "4.5.1" && !$0.reason.isEmpty }) + }.allSatisfy { $0.reviewAtSpec == "4.6" && !$0.reason.isEmpty }) } @Test("only preview application may call mutating Apple operations") diff --git a/Tests/ASCMCPTests/Tooling/BuildUploadsManifestContractTests.swift b/Tests/ASCMCPTests/Tooling/BuildUploadsManifestContractTests.swift index bc857a0..f09a400 100644 --- a/Tests/ASCMCPTests/Tooling/BuildUploadsManifestContractTests.swift +++ b/Tests/ASCMCPTests/Tooling/BuildUploadsManifestContractTests.swift @@ -57,10 +57,10 @@ struct BuildUploadsManifestContractTests { let uniqueBuildUploadOperations = Set(worker.tools.flatMap(\.operations).map(\.operationID)) #expect(uniqueBuildUploadOperations.count == 8) - #expect(Set(manifest.tools.flatMap(\.operations).map(\.operationID)).count == 503) - #expect(manifest.index.waivers.count == 431) - #expect(manifest.index.specPin.operationCount == 1_303) - #expect(503 + 431 + 369 == manifest.index.specPin.operationCount) + #expect(Set(manifest.tools.flatMap(\.operations).map(\.operationID)).count == 528) + #expect(manifest.index.waivers.count == 440) + #expect(manifest.index.specPin.operationCount == 1_337) + #expect(528 + 440 + 369 == manifest.index.specPin.operationCount) let buildUploadWaivers = Set( manifest.index.waivers.compactMap(\.operationID).filter { @@ -76,12 +76,12 @@ struct BuildUploadsManifestContractTests { }) let pin = try #require(manifest.index.optionalInputCoveragePin) - #expect(pin.total == 4_300) - #expect(pin.bound == 1_342) + #expect(pin.total == 4_562) + #expect(pin.bound == 1_377) #expect(pin.internalControl == 40) - #expect(pin.intentionallyOmitted == 2_918) + #expect(pin.intentionallyOmitted == 3_145) #expect(pin.unclassified == 0) - #expect(pin.identitySHA256 == "181f0398c6748772e8fc7e7ceac9b65b3a485c8ccfb3d0292bd2042f16e7d846") + #expect(pin.identitySHA256 == "1400d282aefe09f38931d0b51bd5edb7294657dbb0d8c54c3c9a0edc1c2a3ccd") } @Test("operation methods paths statuses and effects are exact") diff --git a/Tests/ASCMCPTests/Tooling/TestFlightManifestContractTests.swift b/Tests/ASCMCPTests/Tooling/TestFlightManifestContractTests.swift index b3ca16f..ced7dc8 100644 --- a/Tests/ASCMCPTests/Tooling/TestFlightManifestContractTests.swift +++ b/Tests/ASCMCPTests/Tooling/TestFlightManifestContractTests.swift @@ -51,9 +51,9 @@ struct TestFlightManifestContractTests { let testFlightOperations = Set(expected.values.flatMap { $0 }) #expect(testFlightOperations.count == 12) #expect(testFlightOperations.isSubset(of: mapped)) - #expect(mapped.count == 503) - #expect(manifest.index.waivers.count == 431) - #expect(503 + 431 + 369 == manifest.index.specPin.operationCount) + #expect(mapped.count == 528) + #expect(manifest.index.waivers.count == 440) + #expect(528 + 440 + 369 == manifest.index.specPin.operationCount) let recruitmentWaivers = Set( manifest.index.waivers.compactMap(\.operationID).filter { @@ -69,12 +69,12 @@ struct TestFlightManifestContractTests { }) let pin = try #require(manifest.index.optionalInputCoveragePin) - #expect(pin.total == 4_300) - #expect(pin.bound == 1_342) + #expect(pin.total == 4_562) + #expect(pin.bound == 1_377) #expect(pin.internalControl == 40) - #expect(pin.intentionallyOmitted == 2_918) + #expect(pin.intentionallyOmitted == 3_145) #expect(pin.unclassified == 0) - #expect(pin.identitySHA256 == "181f0398c6748772e8fc7e7ceac9b65b3a485c8ccfb3d0292bd2042f16e7d846") + #expect(pin.identitySHA256 == "1400d282aefe09f38931d0b51bd5edb7294657dbb0d8c54c3c9a0edc1c2a3ccd") } @Test("TestFlight operation methods paths and success statuses are exact") diff --git a/Tests/ASCMCPTests/Tooling/XcodeCloudManifestContractTests.swift b/Tests/ASCMCPTests/Tooling/XcodeCloudManifestContractTests.swift index a8549d4..f9fdb52 100644 --- a/Tests/ASCMCPTests/Tooling/XcodeCloudManifestContractTests.swift +++ b/Tests/ASCMCPTests/Tooling/XcodeCloudManifestContractTests.swift @@ -112,9 +112,9 @@ struct XcodeCloudManifestContractTests { } } - #expect(Set(manifest.tools.flatMap(\.operations).map(\.operationID)).count == 503) - #expect(manifest.index.waivers.count == 431) - #expect(503 + 431 + 369 == manifest.index.specPin.operationCount) + #expect(Set(manifest.tools.flatMap(\.operations).map(\.operationID)).count == 528) + #expect(manifest.index.waivers.count == 440) + #expect(528 + 440 + 369 == manifest.index.specPin.operationCount) } @Test("19 linkage-only waivers name their typed functional supersets") @@ -226,7 +226,7 @@ struct XcodeCloudManifestContractTests { productApp.operations.flatMap { $0.optionalParameterClassifications ?? [] } .map(\.appleName) ) - #expect(productAppOmissions.count == 19) + #expect(productAppOmissions.count == 20) #expect(productAppOmissions.contains("include")) #expect(productAppOmissions.contains("limit[androidToIosAppMappingDetails]")) #expect(productAppOmissions.allSatisfy { !$0.hasPrefix("fields[") }) @@ -315,12 +315,12 @@ struct XcodeCloudManifestContractTests { } let pin = try #require(manifest.index.optionalInputCoveragePin) - #expect(pin.total == 4_300) - #expect(pin.bound == 1_342) + #expect(pin.total == 4_562) + #expect(pin.bound == 1_377) #expect(pin.internalControl == 40) - #expect(pin.intentionallyOmitted == 2_918) + #expect(pin.intentionallyOmitted == 3_145) #expect(pin.unclassified == 0) - #expect(pin.identitySHA256 == "181f0398c6748772e8fc7e7ceac9b65b3a485c8ccfb3d0292bd2042f16e7d846") + #expect(pin.identitySHA256 == "1400d282aefe09f38931d0b51bd5edb7294657dbb0d8c54c3c9a0edc1c2a3ccd") } @Test("selected projections distinguish relationship self from related URLs") diff --git a/Tests/ASCMCPTests/Workers/AppSearchKeywordsV319Tests.swift b/Tests/ASCMCPTests/Workers/AppSearchKeywordsV319Tests.swift index 2ca90b9..0dc4335 100644 --- a/Tests/ASCMCPTests/Workers/AppSearchKeywordsV319Tests.swift +++ b/Tests/ASCMCPTests/Workers/AppSearchKeywordsV319Tests.swift @@ -40,7 +40,7 @@ struct AppSearchKeywordsV319Tests { #expect(manifest.index.optionalParameterFamilyRules?.contains { $0.family == .sparseFields && $0.disposition == .intentionallyOmitted && - $0.reviewAtSpec == "4.5.1" + $0.reviewAtSpec == "4.6" } == true) } diff --git a/Tests/ASCMCPTests/Workers/AppsSearchContractTests.swift b/Tests/ASCMCPTests/Workers/AppsSearchContractTests.swift index aed5f5c..6fb2874 100644 --- a/Tests/ASCMCPTests/Workers/AppsSearchContractTests.swift +++ b/Tests/ASCMCPTests/Workers/AppsSearchContractTests.swift @@ -159,8 +159,8 @@ struct AppsSearchContractTests { "limit[appStoreVersionExperimentsV2]", "limit[appStoreVersions]", "limit[betaAppLocalizations]", "limit[betaGroups]", "limit[builds]", "limit[gameCenterEnabledVersions]", "limit[inAppPurchases]", "limit[inAppPurchasesV2]", - "limit[preReleaseVersions]", "limit[promotedPurchases]", "limit[reviewSubmissions]", - "limit[subscriptionGroups]" + "limit[preReleaseVersions]", "limit[promotedPurchases]", "limit[retentionMessages]", + "limit[reviewSubmissions]", "limit[subscriptionGroups]" ] for (invocationID, boundFilter) in [ @@ -182,7 +182,7 @@ struct AppsSearchContractTests { #expect(Set(classifications.map(\.appleName)) == nonSparseOptionalInputs.subtracting(Set([boundFilter, "sort", "limit"]))) #expect(classifications.allSatisfy { classification in classification.disposition == .intentionallyOmitted && - classification.reviewAtSpec == "4.5.1" && + classification.reviewAtSpec == "4.6" && !classification.reason.isEmpty }) } diff --git a/Tests/ASCMCPTests/Workers/AppsVersionsOptionalInputContractTests.swift b/Tests/ASCMCPTests/Workers/AppsVersionsOptionalInputContractTests.swift index 3ff0e3b..10415b3 100644 --- a/Tests/ASCMCPTests/Workers/AppsVersionsOptionalInputContractTests.swift +++ b/Tests/ASCMCPTests/Workers/AppsVersionsOptionalInputContractTests.swift @@ -296,10 +296,10 @@ struct AppsVersionsOptionalInputContractTests { mapping.operations.flatMap { $0.optionalParameterClassifications ?? [] } } - #expect(classifications.count == 125) + #expect(classifications.count == 128) #expect(classifications.filter { $0.disposition == .internalControl }.count == 1) - #expect(classifications.filter { $0.disposition == .intentionallyOmitted }.count == 124) - #expect(classifications.allSatisfy { $0.reviewAtSpec == "4.5.1" && !$0.reason.isEmpty }) + #expect(classifications.filter { $0.disposition == .intentionallyOmitted }.count == 127) + #expect(classifications.allSatisfy { $0.reviewAtSpec == "4.6" && !$0.reason.isEmpty }) let expectedBindings: [(String, String, String?, String?)] = [ ("apps_list", "app_ids", "filter[id]", nil), diff --git a/Tests/ASCMCPTests/Workers/AssetsRegistrationTests.swift b/Tests/ASCMCPTests/Workers/AssetsRegistrationTests.swift index 737683f..755a61f 100644 --- a/Tests/ASCMCPTests/Workers/AssetsRegistrationTests.swift +++ b/Tests/ASCMCPTests/Workers/AssetsRegistrationTests.swift @@ -16,7 +16,7 @@ struct AssetsRegistrationTests { let snapshots = try await TestFactory.collectWorkerToolSnapshots() #expect(snapshots.count == 36) #expect(WorkerManager.validWorkerFilterKeys.count == 36) - #expect(snapshots.reduce(0) { $0 + $1.count } == 514) + #expect(snapshots.reduce(0) { $0 + $1.count } == 537) let assets = try #require(snapshots.first { $0.key == "assets" }) #expect(assets.readmeName == "App Asset Library") #expect(Set(assets.tools.map(\.name)) == Self.names) diff --git a/Tests/ASCMCPTests/Workers/BetaAppWorkerContractTests.swift b/Tests/ASCMCPTests/Workers/BetaAppWorkerContractTests.swift index b518569..0657cd7 100644 --- a/Tests/ASCMCPTests/Workers/BetaAppWorkerContractTests.swift +++ b/Tests/ASCMCPTests/Workers/BetaAppWorkerContractTests.swift @@ -1513,7 +1513,7 @@ struct BetaAppWorkerContractTests { $0.location == "query" && $0.appleName == "include" }) #expect(localizationInclude.disposition == .intentionallyOmitted) - #expect(localizationInclude.reviewAtSpec == "4.5.1") + #expect(localizationInclude.reviewAtSpec == "4.6") for mapping in [getSubmission, listSubmissions] { #expect(mapping.kind == .compound) @@ -1553,8 +1553,8 @@ struct BetaAppWorkerContractTests { "inspection.tool", "inspection.arguments.build_id" ])) - #expect(manifest.index.specPin.version == "4.5.1") - #expect(manifest.index.specPin.sha256 == "7518d3a94a8bd701ac25c1c601b95b8f53aad92091affb15a2a9d331713dac1a") + #expect(manifest.index.specPin.version == "4.6") + #expect(manifest.index.specPin.sha256 == "74732362a91236dcb66eb1620f8be18c2b6060771269b483eab578473bb32763") } } diff --git a/Tests/ASCMCPTests/Workers/BuildUploadsRegistrationTests.swift b/Tests/ASCMCPTests/Workers/BuildUploadsRegistrationTests.swift index c7e5b59..eb604fe 100644 --- a/Tests/ASCMCPTests/Workers/BuildUploadsRegistrationTests.swift +++ b/Tests/ASCMCPTests/Workers/BuildUploadsRegistrationTests.swift @@ -19,7 +19,7 @@ struct BuildUploadsRegistrationTests { let snapshots = try await TestFactory.collectWorkerToolSnapshots() #expect(snapshots.count == 36) #expect(Set(snapshots.map(\.key)) == WorkerManager.validWorkerFilterKeys) - #expect(snapshots.reduce(0) { $0 + $1.count } == 514) + #expect(snapshots.reduce(0) { $0 + $1.count } == 537) let uploads = try #require(snapshots.first { $0.key == "build_uploads" }) #expect(uploads.readmeName == "Build Uploads") diff --git a/Tests/ASCMCPTests/Workers/CommerceCatalogOptionalInputTests.swift b/Tests/ASCMCPTests/Workers/CommerceCatalogOptionalInputTests.swift index 20dbf6f..bd6831f 100644 --- a/Tests/ASCMCPTests/Workers/CommerceCatalogOptionalInputTests.swift +++ b/Tests/ASCMCPTests/Workers/CommerceCatalogOptionalInputTests.swift @@ -380,10 +380,10 @@ struct CommerceCatalogOptionalInputTests { .filter { $0.tool != "subscriptions_pricing_summary" } .flatMap(\.operations) .flatMap { $0.optionalParameterClassifications ?? [] } - #expect(classifications.count == 169) + #expect(classifications.count == 215) #expect(classifications.filter { $0.disposition == .internalControl }.count == 31) - #expect(classifications.filter { $0.disposition == .intentionallyOmitted }.count == 138) - #expect(classifications.allSatisfy { $0.reviewAtSpec == "4.5.1" && !$0.reason.isEmpty }) + #expect(classifications.filter { $0.disposition == .intentionallyOmitted }.count == 184) + #expect(classifications.allSatisfy { $0.reviewAtSpec == "4.6" && !$0.reason.isEmpty }) } } diff --git a/Tests/ASCMCPTests/Workers/CommercePaginationHardeningTests.swift b/Tests/ASCMCPTests/Workers/CommercePaginationHardeningTests.swift index 1168531..3c03f45 100644 --- a/Tests/ASCMCPTests/Workers/CommercePaginationHardeningTests.swift +++ b/Tests/ASCMCPTests/Workers/CommercePaginationHardeningTests.swift @@ -174,7 +174,7 @@ struct CommercePaginationHardeningTests { $0.disposition == .internalControl } #expect(!internalControls.isEmpty) - #expect(internalControls.allSatisfy { $0.reason == reason && $0.reviewAtSpec == "4.5.1" }) + #expect(internalControls.allSatisfy { $0.reason == reason && $0.reviewAtSpec == "4.6" }) let continuation = try #require(mapping.fields.first { $0.toolField == "next_url" }) #expect(continuation.sourceKind == .local) #expect(continuation.localRole == localRole) diff --git a/Tests/ASCMCPTests/Workers/CustomProductPagesWorkerContractTests.swift b/Tests/ASCMCPTests/Workers/CustomProductPagesWorkerContractTests.swift index 6b2e151..226da07 100644 --- a/Tests/ASCMCPTests/Workers/CustomProductPagesWorkerContractTests.swift +++ b/Tests/ASCMCPTests/Workers/CustomProductPagesWorkerContractTests.swift @@ -185,7 +185,7 @@ struct CustomProductPagesWorkerContractTests { ] #expect(classifications == expectedClassifications) #expect(mappings.flatMap(\.operations).flatMap { $0.optionalParameterClassifications ?? [] }.allSatisfy { - $0.reviewAtSpec == "4.5.1" && !$0.reason.isEmpty + $0.reviewAtSpec == "4.6" && !$0.reason.isEmpty }) let expectedBindings: Set = [ diff --git a/Tests/ASCMCPTests/Workers/MarketingOptionalInputContractTests.swift b/Tests/ASCMCPTests/Workers/MarketingOptionalInputContractTests.swift index 1b724f5..7df2a9d 100644 --- a/Tests/ASCMCPTests/Workers/MarketingOptionalInputContractTests.swift +++ b/Tests/ASCMCPTests/Workers/MarketingOptionalInputContractTests.swift @@ -256,7 +256,7 @@ struct MarketingOptionalInputContractTests { }) #expect(classifications == identities) #expect(allClassifications.allSatisfy { - $0.reviewAtSpec == "4.5.1" + $0.reviewAtSpec == "4.6" && !$0.reason.trimmingCharacters(in: .whitespacesAndNewlines).isEmpty }) } diff --git a/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift b/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift new file mode 100644 index 0000000..a365e7d --- /dev/null +++ b/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift @@ -0,0 +1,586 @@ +import Foundation +import MCP +import Testing +@testable import asc_mcp + +@Suite("Retention Messaging Contract Tests") +struct RetentionMessagingContractTests { + // MARK: - 1. Retention Messages, Versions, and Linked Subscriptions + + @Test("retention messages CRUD, versions CRUD, and linked subscriptions") + func retentionMessagesAndVersionsCRUD() async throws { + let transport = TestHTTPTransport(responses: [ + .init( + statusCode: 200, + body: #"{"data":[{"type":"retentionMessages","id":"msg-1","attributes":{"referenceName":"Stay With Us"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}},"versions":{"data":[{"type":"retentionMessageVersions","id":"ver-1"}]},"subscriptions":{"data":[{"type":"subscriptions","id":"sub-1"}]}}}],"included":[{"type":"retentionMessageVersions","id":"ver-1","attributes":{"version":1,"state":"READY_FOR_REVIEW"}},{"type":"subscriptions","id":"sub-1","attributes":{"name":"Pro Monthly","productId":"com.example.pro","state":"APPROVED","subscriptionPeriod":"ONE_MONTH"}}],"links":{"self":"https://api.example.test/v1/apps/app-1/retentionMessages"}}"# + ), + .init( + statusCode: 200, + body: #"{"data":{"type":"retentionMessages","id":"msg-1","attributes":{"referenceName":"Stay With Us"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}},"versions":{"data":[{"type":"retentionMessageVersions","id":"ver-1"}]}}}}"# + ), + .init( + statusCode: 201, + body: #"{"data":{"type":"retentionMessages","id":"msg-2","attributes":{"referenceName":"Win Back At Cancel"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}}}"# + ), + .init(statusCode: 204, body: ""), + .init( + statusCode: 200, + body: #"{"data":[{"type":"retentionMessageVersions","id":"ver-1","attributes":{"version":1,"state":"READY_FOR_REVIEW"},"relationships":{"retentionMessage":{"data":{"type":"retentionMessages","id":"msg-1"}},"localizations":{"data":[{"type":"retentionMessageLocalizations","id":"loc-1"}]}}}],"included":[{"type":"retentionMessageLocalizations","id":"loc-1","attributes":{"locale":"en-US","header":"Stay with Pro","body":"Keep all your features."}}],"links":{"self":"https://api.example.test/v1/retentionMessages/msg-1/versions"}}"# + ), + .init( + statusCode: 200, + body: #"{"data":{"type":"retentionMessageVersions","id":"ver-1","attributes":{"version":1,"state":"READY_FOR_REVIEW"},"relationships":{"retentionMessage":{"data":{"type":"retentionMessages","id":"msg-1"}}}}}"# + ), + .init( + statusCode: 201, + body: #"{"data":{"type":"retentionMessageVersions","id":"ver-2","attributes":{"version":2,"state":"PREPARE_FOR_SUBMISSION"},"relationships":{"retentionMessage":{"data":{"type":"retentionMessages","id":"msg-1"}}}}}"# + ), + .init( + statusCode: 200, + body: #"{"data":[{"type":"subscriptions","id":"sub-1","attributes":{"name":"Pro Monthly","productId":"com.example.pro","state":"APPROVED","subscriptionPeriod":"ONE_MONTH"}}],"links":{"self":"https://api.example.test/v1/retentionMessages/msg-1/subscriptions"}}"# + ) + ]) + let worker = try await makeSubscriptionsWorker(transport: transport) + + let listed = try await worker.handleTool(.init( + name: "subscriptions_list_retention_messages", + arguments: ["app_id": .string("app-1")] + )) + #expect(listed.isError != true) + let listedPayload = try object(listed.structuredContent) + #expect(listedPayload["count"] == .int(1)) + let firstMessage = try object(try #require(listedPayload["retention_messages"]?.arrayValue?.first)) + #expect(firstMessage["id"] == .string("msg-1")) + #expect(firstMessage["referenceName"] == .string("Stay With Us")) + + let fetched = try await worker.handleTool(.init( + name: "subscriptions_get_retention_message", + arguments: ["retention_message_id": .string("msg-1")] + )) + #expect(fetched.isError != true) + let fetchedMessage = try object(try object(fetched.structuredContent)["retention_message"]) + #expect(fetchedMessage["id"] == .string("msg-1")) + + let created = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message", + arguments: ["app_id": .string("app-1"), "reference_name": .string("Win Back At Cancel")] + )) + #expect(created.isError != true) + let createdMessage = try object(try object(created.structuredContent)["retention_message"]) + #expect(createdMessage["id"] == .string("msg-2")) + + let deleted = try await worker.handleTool(.init( + name: "subscriptions_delete_retention_message", + arguments: ["retention_message_id": .string("msg-2")] + )) + #expect(deleted.isError != true) + + let listedVersions = try await worker.handleTool(.init( + name: "subscriptions_list_retention_message_versions", + arguments: ["retention_message_id": .string("msg-1")] + )) + #expect(listedVersions.isError != true) + let versionsPayload = try object(listedVersions.structuredContent) + #expect(versionsPayload["count"] == .int(1)) + + let fetchedVersion = try await worker.handleTool(.init( + name: "subscriptions_get_retention_message_version", + arguments: ["version_id": .string("ver-1")] + )) + #expect(fetchedVersion.isError != true) + #expect(try object(try object(fetchedVersion.structuredContent)["version"])["id"] == .string("ver-1")) + + let createdVersion = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message_version", + arguments: ["retention_message_id": .string("msg-1")] + )) + #expect(createdVersion.isError != true) + #expect(try object(try object(createdVersion.structuredContent)["version"])["version"] == .int(2)) + + let linkedSubscriptions = try await worker.handleTool(.init( + name: "subscriptions_list_retention_message_subscriptions", + arguments: ["retention_message_id": .string("msg-1")] + )) + #expect(linkedSubscriptions.isError != true) + #expect(try object(linkedSubscriptions.structuredContent)["count"] == .int(1)) + + let requests = await transport.recordedRequests() + #expect(requests.map(\.httpMethod) == ["GET", "GET", "POST", "DELETE", "GET", "GET", "POST", "GET"]) + #expect(requests[0].url?.path == "/v1/apps/app-1/retentionMessages") + #expect(requests[2].url?.path == "/v1/retentionMessages") + #expect(requests[3].url?.path == "/v1/retentionMessages/msg-2") + #expect(requests[4].url?.path == "/v1/retentionMessages/msg-1/versions") + #expect(requests[6].url?.path == "/v1/retentionMessageVersions") + #expect(requests[7].url?.path == "/v1/retentionMessages/msg-1/subscriptions") + } + + // MARK: - 2. Retention Message Localizations & Validation + + @Test("retention message localizations enforce header, body, emoji, and price mention validation") + func retentionMessageLocalizationValidationAndCRUD() async throws { + let transport = TestHTTPTransport(responses: [ + .init( + statusCode: 201, + body: #"{"data":{"type":"retentionMessageLocalizations","id":"loc-1","attributes":{"locale":"en-US","header":"Special retention offer","body":"Save $4.99 when you stay subscribed."},"relationships":{"retentionMessageVersion":{"data":{"type":"retentionMessageVersions","id":"ver-1"}}}}}"# + ), + .init( + statusCode: 200, + body: #"{"data":[{"type":"retentionMessageLocalizations","id":"loc-1","attributes":{"locale":"en-US","header":"Special retention offer","body":"Save $4.99 when you stay subscribed."}}],"links":{"self":"https://api.example.test/v1/retentionMessageVersions/ver-1/localizations"}}"# + ), + .init( + statusCode: 200, + body: #"{"data":{"type":"retentionMessageLocalizations","id":"loc-1","attributes":{"locale":"en-US","header":"Special retention offer","body":"Save $4.99 when you stay subscribed."}}}"# + ), + .init( + statusCode: 200, + body: #"{"data":{"type":"retentionMessageLocalizations","id":"loc-1","attributes":{"locale":"en-US","header":"Stay with Pro","body":"Keep unlimited cloud sync."}}}"# + ), + .init(statusCode: 204, body: "") + ]) + let worker = try await makeSubscriptionsWorker(transport: transport) + + // Header > 66 characters rejected before network access + let longHeader = String(repeating: "A", count: 67) + let headerError = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message_localization", + arguments: [ + "version_id": .string("ver-1"), + "locale": .string("en-US"), + "header": .string(longHeader), + "body": .string("Keep unlimited cloud sync.") + ] + )) + #expect(headerError.isError == true) + + // Body > 144 characters rejected before network access + let longBody = String(repeating: "B", count: 145) + let bodyError = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message_localization", + arguments: [ + "version_id": .string("ver-1"), + "locale": .string("en-US"), + "header": .string("Stay with Pro"), + "body": .string(longBody) + ] + )) + #expect(bodyError.isError == true) + + // Emoji rejected before network access + let emojiError = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message_localization", + arguments: [ + "version_id": .string("ver-1"), + "locale": .string("en-US"), + "header": .string("Stay with Pro 🎉"), + "body": .string("Keep unlimited cloud sync.") + ] + )) + #expect(emojiError.isError == true) + + // Price/currency/discount mentions rejected by default before network access + for priceText in ["Save $4.99 today", "Get 50% off your next renewal", "Only €9,99 per month"] { + let priceError = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message_localization", + arguments: [ + "version_id": .string("ver-1"), + "locale": .string("en-US"), + "header": .string("Special retention offer"), + "body": .string(priceText) + ] + )) + #expect(priceError.isError == true, "Expected price string '\(priceText)' to be rejected by default") + } + #expect(await transport.requestCount() == 0) + + // Allowed when allow_price_mentions == true + let created = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message_localization", + arguments: [ + "version_id": .string("ver-1"), + "locale": .string("en-US"), + "header": .string("Special retention offer"), + "body": .string("Save $4.99 when you stay subscribed."), + "allow_price_mentions": .bool(true) + ] + )) + #expect(created.isError != true) + #expect(try object(try object(created.structuredContent)["localization"])["id"] == .string("loc-1")) + + let listed = try await worker.handleTool(.init( + name: "subscriptions_list_retention_message_localizations", + arguments: ["version_id": .string("ver-1")] + )) + #expect(listed.isError != true) + #expect(try object(listed.structuredContent)["count"] == .int(1)) + + let fetched = try await worker.handleTool(.init( + name: "subscriptions_get_retention_message_localization", + arguments: ["localization_id": .string("loc-1")] + )) + #expect(fetched.isError != true) + + let updated = try await worker.handleTool(.init( + name: "subscriptions_update_retention_message_localization", + arguments: [ + "localization_id": .string("loc-1"), + "header": .string("Stay with Pro"), + "body": .string("Keep unlimited cloud sync.") + ] + )) + #expect(updated.isError != true) + #expect(try object(try object(updated.structuredContent)["localization"])["header"] == .string("Stay with Pro")) + + let deleted = try await worker.handleTool(.init( + name: "subscriptions_delete_retention_message_localization", + arguments: ["localization_id": .string("loc-1")] + )) + #expect(deleted.isError != true) + #expect(await transport.requestCount() == 5) + } + + // MARK: - 3. Retention Offers & Inline Prices + + @Test("retention offers CRUD, inline price relationships, and eligibility rules") + func retentionOffersAndInlinePrices() async throws { + let transport = TestHTTPTransport(responses: [ + .init( + statusCode: 201, + body: #"{"data":{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"customerEligibilityPaidSubscriptionDurationInMonths":{"minimum":3,"maximum":12},"customerEligibilityWaitBetweenOffersInMonths":6,"startDate":"2026-11-01","endDate":"2027-11-01","targetSubscriptionPlanType":"MONTHLY"},"relationships":{"prices":{"data":[{"type":"retentionOfferPrices","id":"rop-1"}]}}}}"# + ), + .init( + statusCode: 200, + body: #"{"data":[{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"customerEligibilityPaidSubscriptionDurationInMonths":{"minimum":3,"maximum":12},"customerEligibilityWaitBetweenOffersInMonths":6}}],"links":{"self":"https://api.example.test/v1/subscriptions/sub-1/retentionOffers"}}"# + ), + .init( + statusCode: 200, + body: #"{"data":[{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3}}],"links":{"self":"https://api.example.test/v1/subscriptions/sub-1/retentionMessageOffers"}}"# + ), + .init( + statusCode: 200, + body: #"{"data":{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3}}}"# + ), + .init( + statusCode: 200, + body: #"{"data":{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"endDate":null}}}"# + ), + .init( + statusCode: 200, + body: #"{"data":[{"type":"retentionOfferPrices","id":"rop-1","relationships":{"territory":{"data":{"type":"territories","id":"USA"}},"subscriptionPricePoint":{"data":{"type":"subscriptionPricePoints","id":"pp-usa-1"}}}}],"included":[{"type":"subscriptionPricePoints","id":"pp-usa-1","attributes":{"customerPrice":"4.99","proceeds":"3.49","proceedsYear2":"4.24"}},{"type":"territories","id":"USA","attributes":{"currency":"USD"}}],"links":{"self":"https://api.example.test/v1/retentionOffers/ro-1/prices"}}"# + ), + .init(statusCode: 204, body: "") + ]) + let worker = try await makeSubscriptionsWorker(transport: transport) + + // Invalid wait_between_offers_months rejected before network access + let invalidWait = try await worker.handleTool(.init( + name: "subscriptions_create_retention_offer", + arguments: [ + "subscription_id": .string("sub-1"), + "reference_name": .string("Bad Wait"), + "offer_mode": .string("PAY_AS_YOU_GO"), + "duration": .string("ONE_MONTH"), + "periods": .int(1), + "eligibility_duration_type": .string("AT_LEAST"), + "eligibility_duration_min": .int(3), + "wait_between_offers_months": .int(5), + "price_point_ids": .array([.string("pp-usa-1")]), + "territory_ids": .array([.string("USA")]) + ] + )) + #expect(invalidWait.isError == true) + #expect(await transport.requestCount() == 0) + + let created = try await worker.handleTool(.init( + name: "subscriptions_create_retention_offer", + arguments: [ + "subscription_id": .string("sub-1"), + "reference_name": .string("Loyal 6M Offer"), + "offer_mode": .string("PAY_AS_YOU_GO"), + "duration": .string("THREE_MONTHS"), + "periods": .int(3), + "eligibility_duration_type": .string("RANGE"), + "eligibility_duration_min": .int(3), + "eligibility_duration_max": .int(12), + "wait_between_offers_months": .int(6), + "price_point_ids": .array([.string("pp-usa-1")]), + "territory_ids": .array([.string("USA")]) + ] + )) + #expect(created.isError != true) + + let createRequest = try #require(await transport.recordedRequests().first) + let createBody = try jsonObject(from: try #require(createRequest.httpBody)) + let included = try #require(createBody["included"] as? [[String: Any]]) + #expect(included.count == 1) + #expect(included[0]["type"] as? String == "retentionOfferPrices") + let relationships = try #require(included[0]["relationships"] as? [String: Any]) + let pricePointRel = try #require((relationships["subscriptionPricePoint"] as? [String: Any])?["data"] as? [String: Any]) + #expect(pricePointRel["type"] as? String == "subscriptionPricePoints") + #expect(pricePointRel["id"] as? String == "pp-usa-1") + let territoryRel = try #require((relationships["territory"] as? [String: Any])?["data"] as? [String: Any]) + #expect(territoryRel["type"] as? String == "territories") + #expect(territoryRel["id"] as? String == "USA") + + // List all retention offers vs message_offers_only: true + let listedAll = try await worker.handleTool(.init( + name: "subscriptions_list_retention_offers", + arguments: ["subscription_id": .string("sub-1")] + )) + #expect(listedAll.isError != true) + + let listedMessageOnly = try await worker.handleTool(.init( + name: "subscriptions_list_retention_offers", + arguments: ["subscription_id": .string("sub-1"), "message_offers_only": .bool(true)] + )) + #expect(listedMessageOnly.isError != true) + + let fetched = try await worker.handleTool(.init( + name: "subscriptions_get_retention_offer", + arguments: ["offer_id": .string("ro-1")] + )) + #expect(fetched.isError != true) + + let updated = try await worker.handleTool(.init( + name: "subscriptions_update_retention_offer", + arguments: ["offer_id": .string("ro-1"), "wait_between_offers_months": .int(12)] + )) + #expect(updated.isError != true) + + let prices = try await worker.handleTool(.init( + name: "subscriptions_list_retention_offer_prices", + arguments: ["offer_id": .string("ro-1"), "territory": .string("USA,GBR")] + )) + #expect(prices.isError != true) + #expect(try object(prices.structuredContent)["count"] == .int(1)) + + let deleted = try await worker.handleTool(.init( + name: "subscriptions_delete_retention_offer", + arguments: ["offer_id": .string("ro-1")] + )) + #expect(deleted.isError != true) + + let requests = await transport.recordedRequests() + #expect(requests[1].url?.path == "/v1/subscriptions/sub-1/retentionOffers") + #expect(requests[2].url?.path == "/v1/subscriptions/sub-1/retentionMessageOffers") + #expect(requests[5].url?.path == "/v1/retentionOffers/ro-1/prices") + } + + // MARK: - 4. Subscription Retention Relationships + + @Test("subscription retention message and offer relationships handle null data, clear, POST, and DELETE") + func subscriptionRetentionRelationships() async throws { + let transport = TestHTTPTransport(responses: [ + .init(statusCode: 200, body: #"{"data":null}"#), + .init( + statusCode: 200, + body: #"{"data":{"type":"retentionMessages","id":"msg-1","attributes":{"referenceName":"Stay With Us"}}}"# + ), + .init(statusCode: 204, body: ""), + .init(statusCode: 204, body: ""), + .init(statusCode: 204, body: ""), + .init(statusCode: 204, body: "") + ]) + let worker = try await makeSubscriptionsWorker(transport: transport) + + let emptyResult = try await worker.handleTool(.init( + name: "subscriptions_get_retention_message_for_subscription", + arguments: ["subscription_id": .string("sub-1")] + )) + #expect(emptyResult.isError != true) + let emptyPayload = try object(emptyResult.structuredContent) + #expect(emptyPayload["has_retention_message"] == .bool(false)) + + let populatedResult = try await worker.handleTool(.init( + name: "subscriptions_get_retention_message_for_subscription", + arguments: ["subscription_id": .string("sub-1")] + )) + #expect(populatedResult.isError != true) + let populatedPayload = try object(populatedResult.structuredContent) + #expect(populatedPayload["has_retention_message"] == .bool(true)) + #expect(try object(populatedPayload["retention_message"])["id"] == .string("msg-1")) + + let assigned = try await worker.handleTool(.init( + name: "subscriptions_set_retention_message", + arguments: ["subscription_id": .string("sub-1"), "retention_message_id": .string("msg-1")] + )) + #expect(assigned.isError != true) + + let cleared = try await worker.handleTool(.init( + name: "subscriptions_set_retention_message", + arguments: ["subscription_id": .string("sub-1"), "clear": .bool(true)] + )) + #expect(cleared.isError != true) + + let addedOffers = try await worker.handleTool(.init( + name: "subscriptions_add_retention_message_offers", + arguments: ["subscription_id": .string("sub-1"), "offer_ids": .array([.string("ro-1"), .string("ro-2")])] + )) + #expect(addedOffers.isError != true) + + let removedOffers = try await worker.handleTool(.init( + name: "subscriptions_remove_retention_message_offers", + arguments: ["subscription_id": .string("sub-1"), "offer_ids": .array([.string("ro-1")])] + )) + #expect(removedOffers.isError != true) + + let requests = await transport.recordedRequests() + #expect(requests[2].httpMethod == "PATCH") + #expect(requests[2].url?.path == "/v1/subscriptions/sub-1/relationships/retentionMessage") + let assignBody = try jsonObject(from: try #require(requests[2].httpBody)) + #expect((assignBody["data"] as? [String: Any])?["id"] as? String == "msg-1") + + let clearBody = try jsonObject(from: try #require(requests[3].httpBody)) + #expect(clearBody["data"] is NSNull) + + #expect(requests[4].httpMethod == "POST") + #expect(requests[4].url?.path == "/v1/subscriptions/sub-1/relationships/retentionMessageOffers") + #expect(requests[5].httpMethod == "DELETE") + #expect(requests[5].url?.path == "/v1/subscriptions/sub-1/relationships/retentionMessageOffers") + let removeBody = try #require(requests[5].httpBody) + let removeData = try #require(try jsonObject(from: removeBody)["data"] as? [[String: Any]]) + #expect(removeData.count == 1) + #expect(removeData[0]["id"] as? String == "ro-1") + } + + // MARK: - 5. AssetsWorker Retention Message Version Placement Support + + @Test("AssetsWorker reads to-one retentionMessageVersion placement and rejects video and reordering") + func assetsWorkerRetentionMessageVersionSupport() async throws { + let versionDoc = #"{"data":{"type":"retentionMessageVersions","id":"ver-1","attributes":{"version":1,"state":"PREPARE_FOR_SUBMISSION"},"relationships":{"retentionMessage":{"data":{"type":"retentionMessages","id":"msg-1"}}}}}"# + let appMessagesDoc = #"{"data":[{"type":"retentionMessages","id":"msg-1","attributes":{"referenceName":"Stay With Us"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}}]}"# + let placementDoc = #"{"data":{"type":"appAssetLibraryPlacements","id":"pl-1","attributes":{"placementType":"retentionImage","placementGroup":"retentionGroup"},"relationships":{"image":{"data":{"type":"appAssetLibraryImages","id":"img-1"}},"retentionMessageVersion":{"data":{"type":"retentionMessageVersions","id":"ver-1"}}}}}"# + + let transport = TestHTTPTransport(responses: [ + .init(statusCode: 200, body: versionDoc), + .init(statusCode: 200, body: appMessagesDoc), + .init(statusCode: 200, body: #"{"data":null}"#), + .init(statusCode: 200, body: versionDoc), + .init(statusCode: 200, body: appMessagesDoc), + .init(statusCode: 200, body: placementDoc) + ]) + let root = URL(fileURLWithPath: "\(FileManager.default.currentDirectoryPath)/.build/asset-retention-test-\(UUID().uuidString)") + defer { try? FileManager.default.removeItem(at: root) } + let client = await HTTPClient( + jwtService: try TestFactory.makeJWTService(), + baseURL: "https://api.appstoreconnect.apple.com", + transport: transport, + maxRetries: 1 + ) + let worker = AssetsWorker( + httpClient: client, + companiesManager: try TestFactory.makeCompaniesManager(), + uploadService: UploadService(), + store: AssetOperationStore(root: root) + ) + + // Empty to-one placement returns 0 items + let emptyList = try await worker.handleTool(.init( + name: "assets_list_placements", + arguments: [ + "app_id": .string("app-1"), + "target_type": .string("retentionMessageVersion"), + "target_id": .string("ver-1") + ] + )) + #expect(emptyList.isError != true) + #expect(try object(emptyList.structuredContent)["count"] == .int(0)) + + // Populated to-one placement returns 1 item + let populatedList = try await worker.handleTool(.init( + name: "assets_list_placements", + arguments: [ + "app_id": .string("app-1"), + "target_type": .string("retentionMessageVersion"), + "target_id": .string("ver-1") + ] + )) + #expect(populatedList.isError != true) + #expect(try object(populatedList.structuredContent)["count"] == .int(1)) + + // Rejects video placement on retentionMessageVersion before network access + let beforeCount = await transport.requestCount() + let videoError = try await worker.handleTool(.init( + name: "assets_prepare_change", + arguments: [ + "app_id": .string("app-1"), + "action": .string("create_placement"), + "asset_kind": .string("video"), + "asset_id": .string("vid-1"), + "target_type": .string("retentionMessageVersion"), + "target_id": .string("ver-1"), + "placement_type": .string("retentionImage"), + "placement_group": .string("retentionGroup") + ] + )) + #expect(videoError.isError == true) + + // Rejects reorder_placements on retentionMessageVersion before network access + let reorderError = try await worker.handleTool(.init( + name: "assets_prepare_change", + arguments: [ + "app_id": .string("app-1"), + "action": .string("reorder_placements"), + "target_type": .string("retentionMessageVersion"), + "target_id": .string("ver-1"), + "placement_group": .string("retentionGroup"), + "ordered_placement_ids": .array([.string("pl-1")]) + ] + )) + #expect(reorderError.isError == true) + #expect(await transport.requestCount() == beforeCount) + } + + // MARK: - 6. ReviewSubmissionsWorker Retention Message Version Support + + @Test("ReviewSubmissionsWorker adds and projects retentionMessageVersion items") + func reviewSubmissionsRetentionMessageVersionSupport() async throws { + let transport = TestHTTPTransport(responses: [ + .init( + statusCode: 201, + body: #"{"data":{"type":"reviewSubmissionItems","id":"item-ret-1","attributes":{"state":"READY_FOR_REVIEW"},"relationships":{"retentionMessageVersion":{"data":{"type":"retentionMessageVersions","id":"ver-1"}}}},"links":{"self":"https://api.example.test/v1/reviewSubmissionItems/item-ret-1"}}"# + ) + ]) + let client = await HTTPClient( + jwtService: try TestFactory.makeJWTService(), + baseURL: "https://api.example.test", + transport: transport, + maxRetries: 1 + ) + let worker = ReviewSubmissionsWorker(httpClient: client) + + let added = try await worker.handleTool(.init( + name: "review_submissions_add_item", + arguments: [ + "submission_id": .string("sub-1"), + "retention_message_version_id": .string("ver-1") + ] + )) + #expect(added.isError != true) + let item = try object(try object(added.structuredContent)["item"]) + #expect(item["id"] == .string("item-ret-1")) + #expect(item["resource_type"] == .string("retentionMessageVersion")) + #expect(item["resource_jsonapi_type"] == .string("retentionMessageVersions")) + #expect(item["resource_id"] == .string("ver-1")) + } +} + +private func makeSubscriptionsWorker(transport: TestHTTPTransport) async throws -> SubscriptionsWorker { + let client = await HTTPClient( + jwtService: try TestFactory.makeJWTService(), + baseURL: "https://api.example.test", + transport: transport, + maxRetries: 1 + ) + return SubscriptionsWorker(httpClient: client, uploadService: UploadService()) +} + +private func object(_ value: Value?) throws -> [String: Value] { + guard case .object(let dict) = value else { + throw NSError(domain: "RetentionMessagingContractTests", code: 1) + } + return dict +} + +private func jsonObject(from data: Data) throws -> [String: Any] { + try #require(JSONSerialization.jsonObject(with: data) as? [String: Any]) +} diff --git a/Tests/ASCMCPTests/Workers/ReviewSubmissionsWorkerContractTests.swift b/Tests/ASCMCPTests/Workers/ReviewSubmissionsWorkerContractTests.swift index 241f537..6d0dbd6 100644 --- a/Tests/ASCMCPTests/Workers/ReviewSubmissionsWorkerContractTests.swift +++ b/Tests/ASCMCPTests/Workers/ReviewSubmissionsWorkerContractTests.swift @@ -528,7 +528,7 @@ struct ReviewSubmissionsWorkerContractTests { } } - @Test("all eight supported item relations encode exact Apple JSON API keys and types") + @Test("all supported item relations encode exact Apple JSON API keys and types") func addItemRelationBodies() async throws { let cases: [(String, String, String)] = [ ("app_store_version_id", "appStoreVersion", "appStoreVersions"), @@ -538,7 +538,8 @@ struct ReviewSubmissionsWorkerContractTests { ("background_asset_version_id", "backgroundAssetVersion", "backgroundAssetVersions"), ("in_app_purchase_version_id", "inAppPurchaseVersion", "inAppPurchaseVersions"), ("subscription_version_id", "subscriptionVersion", "subscriptionVersions"), - ("subscription_group_version_id", "subscriptionGroupVersion", "subscriptionGroupVersions") + ("subscription_group_version_id", "subscriptionGroupVersion", "subscriptionGroupVersions"), + ("retention_message_version_id", "retentionMessageVersion", "retentionMessageVersions") ] for (toolField, relationshipName, resourceType) in cases { @@ -2212,18 +2213,19 @@ private let reviewSubmissionTypedIDFields: Set = [ "background_asset_version_id", "in_app_purchase_version_id", "subscription_version_id", - "subscription_group_version_id" + "subscription_group_version_id", + "retention_message_version_id" ] private let reviewSubmissionFields = "platform,submittedDate,state,app,items,appStoreVersionForReview,submittedByActor,lastUpdatedByActor" private let reviewSubmissionItemFields = - "state,appStoreVersion,appCustomProductPageVersion,appStoreVersionExperiment,appStoreVersionExperimentV2,appEvent,appAssetLibraryImage,appAssetLibraryVideo,backgroundAssetVersion,gameCenterAchievementVersion,gameCenterActivityVersion,gameCenterChallengeVersion,gameCenterLeaderboardSetVersion,gameCenterLeaderboardVersion,inAppPurchaseVersion,subscriptionVersion,subscriptionGroupVersion" + "state,appStoreVersion,appCustomProductPageVersion,appStoreVersionExperiment,appStoreVersionExperimentV2,appEvent,appAssetLibraryImage,appAssetLibraryVideo,backgroundAssetVersion,gameCenterAchievementVersion,gameCenterActivityVersion,gameCenterChallengeVersion,gameCenterLeaderboardSetVersion,gameCenterLeaderboardVersion,inAppPurchaseVersion,subscriptionVersion,subscriptionGroupVersion,retentionMessageVersion" private let reviewSubmissionAppVersionFields = "platform,versionString,appStoreState,appVersionState,reviewType,releaseType,createdDate" private let reviewSubmissionActorFields = "actorType,userFirstName,userLastName,userEmail,apiKeyId" private let reviewSubmissionSupportedIncludes = - "appAssetLibraryImage,appAssetLibraryVideo,appStoreVersion,appCustomProductPageVersion,appStoreVersionExperimentV2,appEvent,backgroundAssetVersion,inAppPurchaseVersion,subscriptionVersion,subscriptionGroupVersion" + "appAssetLibraryImage,appAssetLibraryVideo,appStoreVersion,appCustomProductPageVersion,appStoreVersionExperimentV2,appEvent,backgroundAssetVersion,inAppPurchaseVersion,subscriptionVersion,subscriptionGroupVersion,retentionMessageVersion" private func makeReviewSubmissionsWorker( transport: TestHTTPTransport @@ -2317,6 +2319,7 @@ private func reviewSubmissionItemListQuery(limit: Int) -> [String: String] { "fields[inAppPurchaseVersions]": "version,state", "fields[subscriptionVersions]": "version,state", "fields[subscriptionGroupVersions]": "version,state", + "fields[retentionMessageVersions]": "state", "include": reviewSubmissionSupportedIncludes, "limit": String(limit) ] diff --git a/Tests/ASCMCPTests/Workers/SubscriptionPricingSummaryContractTests.swift b/Tests/ASCMCPTests/Workers/SubscriptionPricingSummaryContractTests.swift index 3b2043c..8e2d460 100644 --- a/Tests/ASCMCPTests/Workers/SubscriptionPricingSummaryContractTests.swift +++ b/Tests/ASCMCPTests/Workers/SubscriptionPricingSummaryContractTests.swift @@ -29,7 +29,7 @@ struct SubscriptionPricingSummaryContractTests { }) #expect(classification.appleName == "filter[subscriptionPricePoint]") #expect(classification.disposition == .intentionallyOmitted) - #expect(classification.reviewAtSpec == "4.5.1") + #expect(classification.reviewAtSpec == "4.6") } @Test("schema exposes plan-aware bounded traversal controls") diff --git a/Tests/ASCMCPTests/Workers/SubscriptionWriteOptionalInputContractTests.swift b/Tests/ASCMCPTests/Workers/SubscriptionWriteOptionalInputContractTests.swift index c07e645..ce38dc1 100644 --- a/Tests/ASCMCPTests/Workers/SubscriptionWriteOptionalInputContractTests.swift +++ b/Tests/ASCMCPTests/Workers/SubscriptionWriteOptionalInputContractTests.swift @@ -502,6 +502,8 @@ struct SubscriptionWriteOptionalInputContractTests { "/data/relationships/introductoryOffers", "/data/relationships/prices", "/data/relationships/promotionalOffers", + "/data/relationships/retentionMessage", + "/data/relationships/retentionMessageOffers", "/included" ] ), @@ -534,7 +536,7 @@ struct SubscriptionWriteOptionalInputContractTests { } omittedNames.insert(classification.appleName) omittedReviewsAreCurrent = omittedReviewsAreCurrent - && classification.reviewAtSpec == "4.5.1" + && classification.reviewAtSpec == "4.6" && !classification.reason.isEmpty } } diff --git a/Tests/ASCMCPTests/Workers/ToolMetadataPolicyTests.swift b/Tests/ASCMCPTests/Workers/ToolMetadataPolicyTests.swift index 5fa0d83..70091b4 100644 --- a/Tests/ASCMCPTests/Workers/ToolMetadataPolicyTests.swift +++ b/Tests/ASCMCPTests/Workers/ToolMetadataPolicyTests.swift @@ -9,7 +9,7 @@ struct ToolMetadataPolicyTests { func allToolsReceiveAnnotationsAndMeta() async throws { let tools = try await TestFactory.collectAllWorkerTools().map(ToolMetadataPolicy.apply) - #expect(tools.count == 514) + #expect(tools.count == 537) for tool in tools { #expect(tool.annotations.isEmpty == false) #expect(tool.annotations.openWorldHint != nil) @@ -30,8 +30,8 @@ struct ToolMetadataPolicyTests { let catalog = try await TestFactory.collectAllWorkerTools() let tools = Dictionary(uniqueKeysWithValues: catalog.map { ($0.name, ToolMetadataPolicy.apply(to: $0)) }) - #expect(manifest.tools.count == 514) - #expect(tools.count == 514) + #expect(manifest.tools.count == 537) + #expect(tools.count == 537) for rawTool in catalog { let effectiveReadOnly = ToolMetadataPolicy.apply(to: rawTool).annotations.readOnlyHint #expect( diff --git a/Tests/ASCMCPTests/Workers/WorkerToolDefinitionsTests.swift b/Tests/ASCMCPTests/Workers/WorkerToolDefinitionsTests.swift index 1ceb7d4..f35d5c1 100644 --- a/Tests/ASCMCPTests/Workers/WorkerToolDefinitionsTests.swift +++ b/Tests/ASCMCPTests/Workers/WorkerToolDefinitionsTests.swift @@ -508,14 +508,14 @@ struct WorkerToolDefinitionsTests { #expect(names.contains("analytics_check_snapshot_status")) } - // MARK: - SubscriptionsWorker (99 tools) + // MARK: - SubscriptionsWorker (122 tools) - @Test("SubscriptionsWorker returns 99 tools with correct names") + @Test("SubscriptionsWorker returns 122 tools with correct names") func subscriptionsWorkerTools() async throws { let client = try await TestFactory.makeHTTPClient() let worker = SubscriptionsWorker(httpClient: client, uploadService: UploadService()) let tools = await worker.getTools() - #expect(tools.count == 99) + #expect(tools.count == 122) let names = Set(tools.map(\.name)) #expect(names.contains("subscriptions_list")) #expect(names.contains("subscriptions_get")) @@ -616,6 +616,29 @@ struct WorkerToolDefinitionsTests { #expect(names.contains("subscriptions_update_winback_offer")) #expect(names.contains("subscriptions_delete_winback_offer")) #expect(names.contains("subscriptions_list_winback_offer_prices")) + #expect(names.contains("subscriptions_list_retention_messages")) + #expect(names.contains("subscriptions_get_retention_message")) + #expect(names.contains("subscriptions_create_retention_message")) + #expect(names.contains("subscriptions_delete_retention_message")) + #expect(names.contains("subscriptions_list_retention_message_versions")) + #expect(names.contains("subscriptions_get_retention_message_version")) + #expect(names.contains("subscriptions_create_retention_message_version")) + #expect(names.contains("subscriptions_list_retention_message_subscriptions")) + #expect(names.contains("subscriptions_list_retention_message_localizations")) + #expect(names.contains("subscriptions_get_retention_message_localization")) + #expect(names.contains("subscriptions_create_retention_message_localization")) + #expect(names.contains("subscriptions_update_retention_message_localization")) + #expect(names.contains("subscriptions_delete_retention_message_localization")) + #expect(names.contains("subscriptions_list_retention_offers")) + #expect(names.contains("subscriptions_get_retention_offer")) + #expect(names.contains("subscriptions_create_retention_offer")) + #expect(names.contains("subscriptions_update_retention_offer")) + #expect(names.contains("subscriptions_delete_retention_offer")) + #expect(names.contains("subscriptions_list_retention_offer_prices")) + #expect(names.contains("subscriptions_get_retention_message_for_subscription")) + #expect(names.contains("subscriptions_set_retention_message")) + #expect(names.contains("subscriptions_add_retention_message_offers")) + #expect(names.contains("subscriptions_remove_retention_message_offers")) } // MARK: - OfferCodesWorker (10 tools) From 833cf32eb25f1e41e963d176a27593f062a50e29 Mon Sep 17 00:00:00 2001 From: Aleksei Zelentsov Date: Sat, 7 Nov 2026 15:07:51 +0300 Subject: [PATCH 3/7] Align RetentionOffer wire schema and AssetsWorker ownership check with OpenAPI 4.6 --- .../RetentionMessagingModels.swift | 94 ++--- .../Resources/OperationManifest/manifest.json | 6 +- .../tools/subscriptions.json | 85 +--- .../AssetsWorker/AssetsWorker+Reads.swift | 5 +- ...ubscriptionsWorker+RetentionHandlers.swift | 367 +++++++----------- ...tionsWorker+RetentionToolDefinitions.swift | 102 ++--- .../BuildUploadsManifestContractTests.swift | 6 +- .../TestFlightManifestContractTests.swift | 6 +- .../XcodeCloudManifestContractTests.swift | 6 +- .../CommerceCatalogOptionalInputTests.swift | 4 +- .../RetentionMessagingContractTests.swift | 78 +++- 11 files changed, 326 insertions(+), 433 deletions(-) diff --git a/Sources/asc-mcp/Models/Subscriptions/RetentionMessagingModels.swift b/Sources/asc-mcp/Models/Subscriptions/RetentionMessagingModels.swift index 841c6a9..e84467d 100644 --- a/Sources/asc-mcp/Models/Subscriptions/RetentionMessagingModels.swift +++ b/Sources/asc-mcp/Models/Subscriptions/RetentionMessagingModels.swift @@ -525,29 +525,32 @@ public struct RetentionOfferAttributes: Codable, Sendable { public typealias IntegerRange = RetentionIntegerRange public let referenceName: String? - public let offerMode: String? + public let offerId: String? public let duration: String? - public let periods: Int? - public let eligibilitySubscriberDurationType: String? - public let eligibilitySubscriberDurationInMonths: IntegerRange? - public let waitBetweenOffersInMonths: Int? + public let offerMode: String? + public let periodCount: Int? + public let customerEligibilityPaidSubscriptionDurationInMonths: Int? + public let customerEligibilityWaitBetweenOffersInMonths: Int? + public let targetSubscriptionPlanType: String? public init( referenceName: String? = nil, - offerMode: String? = nil, + offerId: String? = nil, duration: String? = nil, - periods: Int? = nil, - eligibilitySubscriberDurationType: String? = nil, - eligibilitySubscriberDurationInMonths: IntegerRange? = nil, - waitBetweenOffersInMonths: Int? = nil + offerMode: String? = nil, + periodCount: Int? = nil, + customerEligibilityPaidSubscriptionDurationInMonths: Int? = nil, + customerEligibilityWaitBetweenOffersInMonths: Int? = nil, + targetSubscriptionPlanType: String? = nil ) { self.referenceName = referenceName - self.offerMode = offerMode + self.offerId = offerId self.duration = duration - self.periods = periods - self.eligibilitySubscriberDurationType = eligibilitySubscriberDurationType - self.eligibilitySubscriberDurationInMonths = eligibilitySubscriberDurationInMonths - self.waitBetweenOffersInMonths = waitBetweenOffersInMonths + self.offerMode = offerMode + self.periodCount = periodCount + self.customerEligibilityPaidSubscriptionDurationInMonths = customerEligibilityPaidSubscriptionDurationInMonths + self.customerEligibilityWaitBetweenOffersInMonths = customerEligibilityWaitBetweenOffersInMonths + self.targetSubscriptionPlanType = targetSubscriptionPlanType } } @@ -959,29 +962,32 @@ public struct RetentionOfferCreateRequest: Codable, Sendable { public struct Attributes: Codable, Sendable { public let referenceName: String - public let offerMode: String + public let offerId: String public let duration: String - public let periods: Int - public let eligibilitySubscriberDurationType: String - public let eligibilitySubscriberDurationInMonths: RetentionIntegerRange? - public let waitBetweenOffersInMonths: Int + public let offerMode: String + public let periodCount: Int + public let customerEligibilityPaidSubscriptionDurationInMonths: Int + public let customerEligibilityWaitBetweenOffersInMonths: Int? + public let targetSubscriptionPlanType: String? public init( referenceName: String, - offerMode: String, + offerId: String, duration: String, - periods: Int, - eligibilitySubscriberDurationType: String, - eligibilitySubscriberDurationInMonths: RetentionIntegerRange? = nil, - waitBetweenOffersInMonths: Int + offerMode: String, + periodCount: Int, + customerEligibilityPaidSubscriptionDurationInMonths: Int, + customerEligibilityWaitBetweenOffersInMonths: Int? = nil, + targetSubscriptionPlanType: String? = nil ) { self.referenceName = referenceName - self.offerMode = offerMode + self.offerId = offerId self.duration = duration - self.periods = periods - self.eligibilitySubscriberDurationType = eligibilitySubscriberDurationType - self.eligibilitySubscriberDurationInMonths = eligibilitySubscriberDurationInMonths - self.waitBetweenOffersInMonths = waitBetweenOffersInMonths + self.offerMode = offerMode + self.periodCount = periodCount + self.customerEligibilityPaidSubscriptionDurationInMonths = customerEligibilityPaidSubscriptionDurationInMonths + self.customerEligibilityWaitBetweenOffersInMonths = customerEligibilityWaitBetweenOffersInMonths + self.targetSubscriptionPlanType = targetSubscriptionPlanType } } @@ -1070,16 +1076,14 @@ public struct RetentionOfferUpdateRequest: Codable, Sendable { public init( offerId: String, - eligibilitySubscriberDurationType: ASCNullable? = nil, - eligibilitySubscriberDurationInMonths: ASCNullable? = nil, - waitBetweenOffersInMonths: ASCNullable? = nil + customerEligibilityPaidSubscriptionDurationInMonths: ASCNullable? = nil, + customerEligibilityWaitBetweenOffersInMonths: ASCNullable? = nil ) { self.data = UpdateData( id: offerId, attributes: Attributes( - eligibilitySubscriberDurationType: eligibilitySubscriberDurationType, - eligibilitySubscriberDurationInMonths: eligibilitySubscriberDurationInMonths, - waitBetweenOffersInMonths: waitBetweenOffersInMonths + customerEligibilityPaidSubscriptionDurationInMonths: customerEligibilityPaidSubscriptionDurationInMonths, + customerEligibilityWaitBetweenOffersInMonths: customerEligibilityWaitBetweenOffersInMonths ) ) } @@ -1101,22 +1105,22 @@ public struct RetentionOfferUpdateRequest: Codable, Sendable { } public struct Attributes: Codable, Sendable { - public let eligibilitySubscriberDurationType: ASCNullable? - public let eligibilitySubscriberDurationInMonths: ASCNullable? - public let waitBetweenOffersInMonths: ASCNullable? + public let customerEligibilityPaidSubscriptionDurationInMonths: ASCNullable? + public let customerEligibilityWaitBetweenOffersInMonths: ASCNullable? public init( - eligibilitySubscriberDurationType: ASCNullable? = nil, - eligibilitySubscriberDurationInMonths: ASCNullable? = nil, - waitBetweenOffersInMonths: ASCNullable? = nil + customerEligibilityPaidSubscriptionDurationInMonths: ASCNullable? = nil, + customerEligibilityWaitBetweenOffersInMonths: ASCNullable? = nil ) { - self.eligibilitySubscriberDurationType = eligibilitySubscriberDurationType - self.eligibilitySubscriberDurationInMonths = eligibilitySubscriberDurationInMonths - self.waitBetweenOffersInMonths = waitBetweenOffersInMonths + self.customerEligibilityPaidSubscriptionDurationInMonths = customerEligibilityPaidSubscriptionDurationInMonths + self.customerEligibilityWaitBetweenOffersInMonths = customerEligibilityWaitBetweenOffersInMonths } } } +public typealias RetentionOfferCreateAttributes = RetentionOfferCreateRequest.Attributes +public typealias RetentionOfferUpdateAttributes = RetentionOfferUpdateRequest.Attributes + /// Request to set or clear a subscription's retention message (`PATCH /v1/subscriptions/{id}/relationships/retentionMessage`) /// Encodes `{"data": {"type": "retentionMessages", "id": id}}` when setting, and `{"data": null}` when clearing. public struct SubscriptionRetentionMessageLinkageRequest: Codable, Sendable { diff --git a/Sources/asc-mcp/Resources/OperationManifest/manifest.json b/Sources/asc-mcp/Resources/OperationManifest/manifest.json index 2bc6be7..630b42a 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/manifest.json +++ b/Sources/asc-mcp/Resources/OperationManifest/manifest.json @@ -7,9 +7,9 @@ "operationCount": 1337 }, "optionalInputCoveragePin": { - "bound": 1377, - "identitySHA256": "1400d282aefe09f38931d0b51bd5edb7294657dbb0d8c54c3c9a0edc1c2a3ccd", - "intentionallyOmitted": 3145, + "bound": 1378, + "identitySHA256": "680a0bd2f5ef10a5ce67de42ede8efaf3364433171fed2bb972ab0927f821d80", + "intentionallyOmitted": 3144, "internalControl": 40, "total": 4562, "unclassified": 0 diff --git a/Sources/asc-mcp/Resources/OperationManifest/tools/subscriptions.json b/Sources/asc-mcp/Resources/OperationManifest/tools/subscriptions.json index 24b4204..921f313 100644 --- a/Sources/asc-mcp/Resources/OperationManifest/tools/subscriptions.json +++ b/Sources/asc-mcp/Resources/OperationManifest/tools/subscriptions.json @@ -9283,33 +9283,6 @@ "price_point_ids" ], "localRole": "Generate the same ${price-index} linkage IDs used by inline retention offer price resources." - }, - { - "sourceKind": "derived", - "jsonPointer": "/data/attributes/offerId", - "derivedFrom": [ - "reference_name" - ], - "localRole": "Offer identifier validated alongside the retention offer creation payload." - }, - { - "sourceKind": "derived", - "jsonPointer": "/data/attributes/customerEligibilityPaidSubscriptionDurationInMonths", - "derivedFrom": [ - "eligibility_duration_type", - "eligibility_duration_min", - "eligibility_duration_max" - ], - "localRole": "Constructs the paid subscription duration eligibility range from eligibility_duration_type, eligibility_duration_min, and eligibility_duration_max." - } - ], - "optionalParameterClassifications": [ - { - "location": "body", - "appleName": "/data/attributes/targetSubscriptionPlanType", - "disposition": "intentionallyOmitted", - "reason": "The retention offer create tool targets the parent subscription's plan configuration without exposing a separate targetSubscriptionPlanType selector.", - "reviewAtSpec": "4.6" } ] } @@ -9327,6 +9300,12 @@ "operationId": "retentionOffers_createInstance", "jsonPointer": "/data/attributes/referenceName" }, + { + "toolField": "offer_id", + "sourceKind": "requestBody", + "operationId": "retentionOffers_createInstance", + "jsonPointer": "/data/attributes/offerId" + }, { "toolField": "duration", "sourceKind": "requestBody", @@ -9340,25 +9319,16 @@ "jsonPointer": "/data/attributes/offerMode" }, { - "toolField": "periods", + "toolField": "period_count", "sourceKind": "requestBody", "operationId": "retentionOffers_createInstance", "jsonPointer": "/data/attributes/periodCount" }, { - "toolField": "eligibility_duration_type", - "sourceKind": "local", - "localRole": "Validated locally alongside eligibility_duration_min and eligibility_duration_max before constructing the retention offer payload." - }, - { - "toolField": "eligibility_duration_min", - "sourceKind": "local", - "localRole": "Validated locally as the minimum paid subscription duration in months for AT_LEAST and RANGE rules." - }, - { - "toolField": "eligibility_duration_max", - "sourceKind": "local", - "localRole": "Validated locally as the maximum paid subscription duration in months for UP_TO and RANGE rules." + "toolField": "eligibility_duration_months", + "sourceKind": "requestBody", + "operationId": "retentionOffers_createInstance", + "jsonPointer": "/data/attributes/customerEligibilityPaidSubscriptionDurationInMonths" }, { "toolField": "wait_between_offers_months", @@ -9366,6 +9336,12 @@ "operationId": "retentionOffers_createInstance", "jsonPointer": "/data/attributes/customerEligibilityWaitBetweenOffersInMonths" }, + { + "toolField": "target_subscription_plan_type", + "sourceKind": "requestBody", + "operationId": "retentionOffers_createInstance", + "jsonPointer": "/data/attributes/targetSubscriptionPlanType" + }, { "toolField": "territory_ids", "sourceKind": "local", @@ -9418,16 +9394,6 @@ "offer_id" ], "localRole": "Reuse the public retention-offer ID as the JSON:API resource ID in the update body." - }, - { - "sourceKind": "derived", - "jsonPointer": "/data/attributes/customerEligibilityPaidSubscriptionDurationInMonths", - "derivedFrom": [ - "eligibility_duration_type", - "eligibility_duration_min", - "eligibility_duration_max" - ], - "localRole": "Updates or clears the paid subscription duration eligibility range from eligibility_duration_type, eligibility_duration_min, and eligibility_duration_max." } ] } @@ -9441,19 +9407,10 @@ "appleName": "id" }, { - "toolField": "eligibility_duration_type", - "sourceKind": "local", - "localRole": "Validated locally alongside eligibility_duration_min and eligibility_duration_max when provided." - }, - { - "toolField": "eligibility_duration_min", - "sourceKind": "local", - "localRole": "Validated locally as the minimum paid subscription duration in months when updating eligibility." - }, - { - "toolField": "eligibility_duration_max", - "sourceKind": "local", - "localRole": "Validated locally as the maximum paid subscription duration in months when updating eligibility." + "toolField": "eligibility_duration_months", + "sourceKind": "requestBody", + "operationId": "retentionOffers_updateInstance", + "jsonPointer": "/data/attributes/customerEligibilityPaidSubscriptionDurationInMonths" }, { "toolField": "wait_between_offers_months", diff --git a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Reads.swift b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Reads.swift index 3495321..319a984 100644 --- a/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Reads.swift +++ b/Sources/asc-mcp/Workers/AssetsWorker/AssetsWorker+Reads.swift @@ -165,8 +165,9 @@ extension AssetsWorker { owner = AssetLibraryResourceID(type: "apps", id: appID) state = event.attributes?["eventState"]?.stringValue case .retentionMessageVersion: - let members = try await all("/v1/apps/\(try ASCPathSegment.encode(appID))/retentionMessages", query: ["filter[id]": parentID.id], type: "retentionMessages") - guard let message = members.first(where: { $0.id == parentID.id }), members.count == 1 else { + let members = try await all("/v1/apps/\(try ASCPathSegment.encode(appID))/retentionMessages", type: "retentionMessages") + let matches = members.filter { $0.id == parentID.id } + guard matches.count == 1, let message = matches.first else { throw AssetLibraryError("Retention message does not belong to this app") } checked.append(message) diff --git a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift index 5950e39..a2d9812 100644 --- a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift +++ b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift @@ -26,15 +26,18 @@ extension SubscriptionsWorker { "ONE_YEAR" ] - private static let allowedRetentionEligibilityDurationTypes: Set = [ - "AT_LEAST", - "UP_TO", - "RANGE" + private static let allowedRetentionTargetSubscriptionPlanTypes: Set = [ + "MONTHLY", + "UPFRONT" ] - private static let allowedRetentionWaitBetweenOffersMonths: Set = [ - 0, 1, 2, 3, 6, 9, 12, 24 - ] + private func isAllowedRetentionEligibilityDuration(_ months: Int) -> Bool { + (1...24).contains(months) || [36, 48, 60].contains(months) + } + + private func isAllowedRetentionWaitBetweenOffers(_ months: Int) -> Bool { + (2...24).contains(months) + } // MARK: - 1. List Retention Messages @@ -694,15 +697,15 @@ extension SubscriptionsWorker { try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ "subscription_id", "reference_name", - "offer_mode", + "offer_id", "duration", - "periods", - "eligibility_duration_type", - "eligibility_duration_min", - "eligibility_duration_max", + "offer_mode", + "period_count", + "eligibility_duration_months", "wait_between_offers_months", - "price_point_ids", - "territory_ids" + "target_subscription_plan_type", + "territory_ids", + "price_point_ids" ]) let subscriptionId = try validateRetentionRequiredResourceID( @@ -713,55 +716,48 @@ extension SubscriptionsWorker { params.arguments, key: "reference_name" ) - let offerMode = try validateRequiredEnumString( + let offerId = try validateRetentionOfferIdentifier( params.arguments, - key: "offer_mode", - allowed: Self.allowedRetentionOfferModes + key: "offer_id" ) let duration = try validateRequiredEnumString( params.arguments, key: "duration", allowed: Self.allowedRetentionOfferDurations ) - let periods = try parseRequiredStrictPositiveInt( + let offerMode = try validateRequiredEnumString( params.arguments, - key: "periods" + key: "offer_mode", + allowed: Self.allowedRetentionOfferModes ) - let eligibilityDurationType = try validateRequiredEnumString( + let periodCount = try parseRequiredStrictPositiveInt( params.arguments, - key: "eligibility_duration_type", - allowed: Self.allowedRetentionEligibilityDurationTypes + key: "period_count" ) - let eligibilityMin = try parseOptionalStrictPositiveInt( + let eligibilityDurationMonths = try parseRequiredRetentionEligibilityDurationMonths( params.arguments, - key: "eligibility_duration_min" + key: "eligibility_duration_months" ) - let eligibilityMax = try parseOptionalStrictPositiveInt( + let waitBetweenOffersMonths = try parseOptionalRetentionWaitMonths( params.arguments, - key: "eligibility_duration_max" - ) - - let eligibilityRange = try validateRetentionEligibilityRange( - durationType: eligibilityDurationType, - minimum: eligibilityMin, - maximum: eligibilityMax + key: "wait_between_offers_months" ) - - let waitBetweenOffersMonths = try parseRequiredRetentionWaitMonths( + let targetSubscriptionPlanType = try validateOptionalEnumString( params.arguments, - key: "wait_between_offers_months" + key: "target_subscription_plan_type", + allowed: Self.allowedRetentionTargetSubscriptionPlanTypes ) - let pricePointIds = try parseRequiredUniqueCanonicalIDArray( + let territoryIds = try parseRequiredUniqueCanonicalIDArray( params.arguments, - key: "price_point_ids" + key: "territory_ids" ) - let territoryIds = try parseOptionalCanonicalIDArray( + let pricePointIds = try parseRequiredCanonicalIDArray( params.arguments, - key: "territory_ids" + key: "price_point_ids" ) - if let territoryIds, !territoryIds.isEmpty, territoryIds.count != pricePointIds.count { + if territoryIds.count != pricePointIds.count { return MCPResult.error( "'territory_ids' count (\(territoryIds.count)) must match 'price_point_ids' count (\(pricePointIds.count))" ) @@ -775,14 +771,9 @@ extension SubscriptionsWorker { priceIdentifiers.append( ASCResourceIdentifier(type: "retentionOfferPrices", id: inlineId) ) - let territoryRel: RetentionOfferPriceInlineCreate.TerritoryRelationship? - if let territoryIds, !territoryIds.isEmpty { - territoryRel = RetentionOfferPriceInlineCreate.TerritoryRelationship( - data: ASCResourceIdentifier(type: "territories", id: territoryIds[index]) - ) - } else { - territoryRel = nil - } + let territoryRel = RetentionOfferPriceInlineCreate.TerritoryRelationship( + data: ASCResourceIdentifier(type: "territories", id: territoryIds[index]) + ) inlinePrices.append( RetentionOfferPriceInlineCreate( @@ -801,12 +792,13 @@ extension SubscriptionsWorker { data: RetentionOfferCreateRequest.CreateData( attributes: RetentionOfferCreateRequest.Attributes( referenceName: referenceName, - offerMode: offerMode, + offerId: offerId, duration: duration, - periods: periods, - eligibilitySubscriberDurationType: eligibilityDurationType, - eligibilitySubscriberDurationInMonths: eligibilityRange, - waitBetweenOffersInMonths: waitBetweenOffersMonths + offerMode: offerMode, + periodCount: periodCount, + customerEligibilityPaidSubscriptionDurationInMonths: eligibilityDurationMonths, + customerEligibilityWaitBetweenOffersInMonths: waitBetweenOffersMonths, + targetSubscriptionPlanType: targetSubscriptionPlanType ), relationships: RetentionOfferCreateRequest.Relationships( subscription: RetentionOfferCreateRequest.SubscriptionRelationship( @@ -845,9 +837,7 @@ extension SubscriptionsWorker { do { try validateRetentionAllowedArguments(params.arguments, allowedKeys: [ "offer_id", - "eligibility_duration_type", - "eligibility_duration_min", - "eligibility_duration_max", + "eligibility_duration_months", "wait_between_offers_months" ]) @@ -856,41 +846,25 @@ extension SubscriptionsWorker { key: "offer_id" ) - let durationTypePatch = try parseNullableEnumString( + let eligibilityDurationPatch = try parseNullableRetentionEligibilityDurationMonths( params.arguments, - key: "eligibility_duration_type", - allowed: Self.allowedRetentionEligibilityDurationTypes - ) - let minPatch = try parseNullableStrictPositiveInt( - params.arguments, - key: "eligibility_duration_min" - ) - let maxPatch = try parseNullableStrictPositiveInt( - params.arguments, - key: "eligibility_duration_max" + key: "eligibility_duration_months" ) let waitPatch = try parseNullableRetentionWaitMonths( params.arguments, key: "wait_between_offers_months" ) - guard durationTypePatch != nil || minPatch != nil || maxPatch != nil || waitPatch != nil else { + guard eligibilityDurationPatch != nil || waitPatch != nil else { return MCPResult.error( - "At least one of 'eligibility_duration_type', 'eligibility_duration_min', 'eligibility_duration_max', or 'wait_between_offers_months' must be provided" + "At least one of 'eligibility_duration_months' or 'wait_between_offers_months' must be provided" ) } - let durationRangePatch = try buildRetentionEligibilityRangePatch( - durationTypePatch: durationTypePatch, - minPatch: minPatch, - maxPatch: maxPatch - ) - let request = RetentionOfferUpdateRequest( offerId: encodedOfferId, - eligibilitySubscriberDurationType: durationTypePatch, - eligibilitySubscriberDurationInMonths: durationRangePatch, - waitBetweenOffersInMonths: waitPatch + customerEligibilityPaidSubscriptionDurationInMonths: eligibilityDurationPatch, + customerEligibilityWaitBetweenOffersInMonths: waitPatch ) let response: ASCRetentionOfferResponse = try await httpClient.patch( @@ -1435,26 +1409,40 @@ extension SubscriptionsWorker { return value } - private func parseNullableEnumString( + private func validateRetentionOfferIdentifier( + _ arguments: [String: Value]?, + key: String + ) throws -> String { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") + } + guard case .string(let value) = rawValue else { + throw ASCError.parsing("Parameter '\(key)' must be a string") + } + let trimmed = value.trimmingCharacters(in: .whitespacesAndNewlines) + guard !trimmed.isEmpty, value == trimmed else { + throw ASCError.parsing("Parameter '\(key)' must be a non-empty identifier without surrounding whitespace") + } + try validateNoEmoji(in: value, field: key) + return value + } + + private func validateOptionalEnumString( _ arguments: [String: Value]?, key: String, allowed: Set - ) throws -> ASCNullable? { - guard let rawValue = arguments?[key] else { + ) throws -> String? { + guard let rawValue = arguments?[key], rawValue != .null else { return nil } - switch rawValue { - case .null: - return .null - case .string(let value): - guard allowed.contains(value) else { - let sorted = allowed.sorted().joined(separator: ", ") - throw ASCError.parsing("Invalid '\(key)' value '\(value)'. Allowed values: \(sorted)") - } - return .value(value) - default: - throw ASCError.parsing("Parameter '\(key)' must be a string or null") + guard case .string(let value) = rawValue else { + throw ASCError.parsing("Parameter '\(key)' must be a string") + } + guard allowed.contains(value) else { + let sorted = allowed.sorted().joined(separator: ", ") + throw ASCError.parsing("Invalid '\(key)' value '\(value)'. Allowed values: \(sorted)") } + return value } private func parseRequiredStrictPositiveInt( @@ -1470,20 +1458,23 @@ extension SubscriptionsWorker { return intValue } - private func parseOptionalStrictPositiveInt( + private func parseRequiredRetentionEligibilityDurationMonths( _ arguments: [String: Value]?, key: String - ) throws -> Int? { - guard let rawValue = arguments?[key], rawValue != .null else { - return nil + ) throws -> Int { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") } - guard case .int(let intValue) = rawValue, intValue >= 1 else { - throw ASCError.parsing("Parameter '\(key)' must be an integer >= 1") + guard case .int(let intValue) = rawValue, + isAllowedRetentionEligibilityDuration(intValue) else { + throw ASCError.parsing( + "Parameter '\(key)' must be 1 through 24, 36, 48, or 60" + ) } return intValue } - private func parseNullableStrictPositiveInt( + private func parseNullableRetentionEligibilityDurationMonths( _ arguments: [String: Value]?, key: String ) throws -> ASCNullable? { @@ -1493,25 +1484,26 @@ extension SubscriptionsWorker { switch rawValue { case .null: return .null - case .int(let intValue) where intValue >= 1: + case .int(let intValue) where isAllowedRetentionEligibilityDuration(intValue): return .value(intValue) default: - throw ASCError.parsing("Parameter '\(key)' must be an integer >= 1 or null") + throw ASCError.parsing( + "Parameter '\(key)' must be 1 through 24, 36, 48, 60, or null" + ) } } - private func parseRequiredRetentionWaitMonths( + private func parseOptionalRetentionWaitMonths( _ arguments: [String: Value]?, key: String - ) throws -> Int { - guard let rawValue = arguments?[key] else { - throw ASCError.parsing("Required parameter '\(key)' is missing") + ) throws -> Int? { + guard let rawValue = arguments?[key], rawValue != .null else { + return nil } guard case .int(let intValue) = rawValue, - Self.allowedRetentionWaitBetweenOffersMonths.contains(intValue) else { - let allowedList = Self.allowedRetentionWaitBetweenOffersMonths.sorted().map(String.init).joined(separator: ", ") + isAllowedRetentionWaitBetweenOffers(intValue) else { throw ASCError.parsing( - "Parameter '\(key)' must be one of [\(allowedList)]" + "Parameter '\(key)' must be an integer between 2 and 24" ) } return intValue @@ -1527,122 +1519,35 @@ extension SubscriptionsWorker { switch rawValue { case .null: return .null - case .int(let intValue) where Self.allowedRetentionWaitBetweenOffersMonths.contains(intValue): + case .int(let intValue) where isAllowedRetentionWaitBetweenOffers(intValue): return .value(intValue) default: - let allowedList = Self.allowedRetentionWaitBetweenOffersMonths.sorted().map(String.init).joined(separator: ", ") throw ASCError.parsing( - "Parameter '\(key)' must be one of [\(allowedList)] or null" + "Parameter '\(key)' must be an integer between 2 and 24 or null" ) } } - private func validateRetentionEligibilityRange( - durationType: String, - minimum: Int?, - maximum: Int? - ) throws -> RetentionIntegerRange { - switch durationType { - case "AT_LEAST": - guard let minimum, minimum >= 1 else { - throw ASCError.parsing( - "'eligibility_duration_min' (>= 1) is required when 'eligibility_duration_type' is 'AT_LEAST'" - ) - } - guard maximum == nil else { - throw ASCError.parsing( - "'eligibility_duration_max' must not be provided when 'eligibility_duration_type' is 'AT_LEAST'" - ) - } - return RetentionIntegerRange(minimum: minimum, maximum: nil) - - case "UP_TO": - guard let maximum, maximum >= 1 else { - throw ASCError.parsing( - "'eligibility_duration_max' (>= 1) is required when 'eligibility_duration_type' is 'UP_TO'" - ) - } - guard minimum == nil else { - throw ASCError.parsing( - "'eligibility_duration_min' must not be provided when 'eligibility_duration_type' is 'UP_TO'" - ) - } - return RetentionIntegerRange(minimum: nil, maximum: maximum) - - case "RANGE": - guard let minimum, minimum >= 1, let maximum, maximum >= 1 else { - throw ASCError.parsing( - "Both 'eligibility_duration_min' and 'eligibility_duration_max' (>= 1) are required when 'eligibility_duration_type' is 'RANGE'" - ) - } - guard minimum <= maximum else { - throw ASCError.parsing( - "'eligibility_duration_min' (\(minimum)) cannot be greater than 'eligibility_duration_max' (\(maximum))" - ) - } - return RetentionIntegerRange(minimum: minimum, maximum: maximum) - - default: - throw ASCError.parsing("Invalid 'eligibility_duration_type': \(durationType)") - } - } - - private func buildRetentionEligibilityRangePatch( - durationTypePatch: ASCNullable?, - minPatch: ASCNullable?, - maxPatch: ASCNullable? - ) throws -> ASCNullable? { - let minValue: Int? - if case .value(let minInt) = minPatch { - minValue = minInt - } else { - minValue = nil + private func parseRequiredCanonicalIDArray( + _ arguments: [String: Value]?, + key: String + ) throws -> [String] { + guard let rawValue = arguments?[key] else { + throw ASCError.parsing("Required parameter '\(key)' is missing") } - - let maxValue: Int? - if case .value(let maxInt) = maxPatch { - maxValue = maxInt - } else { - maxValue = nil + guard case .array(let arrayValues) = rawValue, !arrayValues.isEmpty else { + throw ASCError.parsing("Parameter '\(key)' must be a non-empty array of strings") } - switch durationTypePatch { - case .value(let durationType): - let range = try validateRetentionEligibilityRange( - durationType: durationType, - minimum: minValue, - maximum: maxValue - ) - return .value(range) - - case .null: - if minValue != nil || maxValue != nil { - throw ASCError.parsing( - "Cannot provide non-null 'eligibility_duration_min' or 'eligibility_duration_max' when clearing 'eligibility_duration_type'" - ) - } - if minPatch == .null || maxPatch == .null { - return .null - } - return nil - - case nil: - if minPatch == nil && maxPatch == nil { - return nil - } - if minPatch == .null && maxPatch == .null { - return .null - } - if (minPatch == .null && maxValue == nil) || (maxPatch == .null && minValue == nil) { - return .null - } - if let minValue, let maxValue, minValue > maxValue { - throw ASCError.parsing( - "'eligibility_duration_min' (\(minValue)) cannot be greater than 'eligibility_duration_max' (\(maxValue))" - ) + var result: [String] = [] + for (index, element) in arrayValues.enumerated() { + guard case .string(let rawId) = element else { + throw ASCError.parsing("Parameter '\(key)[\(index)]' must be a string") } - return .value(RetentionIntegerRange(minimum: minValue, maximum: maxValue)) + let validatedId = try validateCanonicalIDString(rawId, field: "\(key)[\(index)]") + result.append(validatedId) } + return result } private func parseRequiredUniqueCanonicalIDArray( @@ -1839,31 +1744,43 @@ extension SubscriptionsWorker { if let attributes = offer.attributes { if let referenceName = attributes.referenceName { result["referenceName"] = referenceName + result["reference_name"] = referenceName } - if let offerMode = attributes.offerMode { - result["offerMode"] = offerMode + if let offerId = attributes.offerId { + result["offerId"] = offerId + result["offer_id"] = offerId } if let duration = attributes.duration { result["duration"] = duration } - if let periods = attributes.periods { - result["periods"] = periods + if let offerMode = attributes.offerMode { + result["offerMode"] = offerMode + result["offer_mode"] = offerMode + } + if let periodCount = attributes.periodCount { + result["periodCount"] = periodCount + result["period_count"] = periodCount } - if let eligibilityType = attributes.eligibilitySubscriberDurationType { - result["eligibilitySubscriberDurationType"] = eligibilityType + if let eligibilityDuration = attributes.customerEligibilityPaidSubscriptionDurationInMonths { + result["customerEligibilityPaidSubscriptionDurationInMonths"] = eligibilityDuration + result["customer_eligibility_paid_subscription_duration_in_months"] = eligibilityDuration + result["eligibilityDurationMonths"] = eligibilityDuration + result["eligibility_duration_months"] = eligibilityDuration } - if let eligibilityRange = attributes.eligibilitySubscriberDurationInMonths { - var rangeDict: [String: Any] = [:] - if let min = eligibilityRange.minimum { rangeDict["minimum"] = min } - if let max = eligibilityRange.maximum { rangeDict["maximum"] = max } - result["eligibilitySubscriberDurationInMonths"] = rangeDict + if let waitMonths = attributes.customerEligibilityWaitBetweenOffersInMonths { + result["customerEligibilityWaitBetweenOffersInMonths"] = waitMonths + result["customer_eligibility_wait_between_offers_months"] = waitMonths + result["waitBetweenOffersMonths"] = waitMonths + result["wait_between_offers_months"] = waitMonths } - if let waitMonths = attributes.waitBetweenOffersInMonths { - result["waitBetweenOffersInMonths"] = waitMonths + if let targetPlanType = attributes.targetSubscriptionPlanType { + result["targetSubscriptionPlanType"] = targetPlanType + result["target_subscription_plan_type"] = targetPlanType } } if let subscriptionId = offer.relationships?.subscription?.data?.id { result["subscriptionId"] = subscriptionId + result["subscription_id"] = subscriptionId } return result } diff --git a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionToolDefinitions.swift b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionToolDefinitions.swift index 85613f6..ed71d98 100644 --- a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionToolDefinitions.swift +++ b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionToolDefinitions.swift @@ -411,14 +411,9 @@ extension SubscriptionsWorker { "description": .string("Internal reference name for the retention offer (max 64 characters)"), "maxLength": .int(64) ]), - "offer_mode": .object([ + "offer_id": .object([ "type": .string("string"), - "description": .string("Offer payment mode"), - "enum": .array([ - .string("PAY_AS_YOU_GO"), - .string("PAY_UP_FRONT"), - .string("FREE_TRIAL") - ]) + "description": .string("Unique offer identifier") ]), "duration": .object([ "type": .string("string"), @@ -434,55 +429,51 @@ extension SubscriptionsWorker { .string("ONE_YEAR") ]) ]), - "periods": .object([ - "type": .string("integer"), - "description": .string("Number of billing periods for the offer (minimum 1)"), - "minimum": .int(1) - ]), - "eligibility_duration_type": .object([ + "offer_mode": .object([ "type": .string("string"), - "description": .string("Subscriber paid duration eligibility rule type"), + "description": .string("Offer payment mode"), "enum": .array([ - .string("AT_LEAST"), - .string("UP_TO"), - .string("RANGE") + .string("PAY_AS_YOU_GO"), + .string("PAY_UP_FRONT"), + .string("FREE_TRIAL") ]) ]), - "eligibility_duration_min": .object([ + "period_count": .object([ "type": .string("integer"), - "description": .string("Minimum paid subscription duration in months (required for AT_LEAST and RANGE)"), + "description": .string("Number of billing periods for the offer (minimum 1)"), "minimum": .int(1) ]), - "eligibility_duration_max": .object([ + "eligibility_duration_months": .object([ "type": .string("integer"), - "description": .string("Maximum paid subscription duration in months (required for UP_TO and RANGE)"), + "description": .string("Paid subscription duration in months required for eligibility (1-24, 36, 48, or 60)"), "minimum": .int(1) ]), "wait_between_offers_months": .object([ "type": .string("integer"), - "description": .string("Months a subscriber must wait between retention offers"), + "description": .string("Optional months a subscriber must wait between retention offers (2-24)"), + "minimum": .int(2), + "maximum": .int(24) + ]), + "target_subscription_plan_type": .object([ + "type": .string("string"), + "description": .string("Optional target subscription plan type (MONTHLY or UPFRONT)"), "enum": .array([ - .int(0), - .int(1), - .int(2), - .int(3), - .int(6), - .int(9), - .int(12), - .int(24) + .string("MONTHLY"), + .string("UPFRONT") ]) ]), - "price_point_ids": .object([ + "territory_ids": .object([ "type": .string("array"), - "description": .string("Subscription price point IDs for the retention offer"), + "description": .string("Territory codes matching price_point_ids 1:1 (e.g. USA, GBR)"), "minItems": .int(1), "items": .object([ "type": .string("string") ]) ]), - "territory_ids": .object([ + "price_point_ids": .object([ "type": .string("array"), - "description": .string("Optional territory codes matching price_point_ids 1:1 (e.g. USA, GBR)"), + "description": .string("Subscription price point IDs for the retention offer"), + "minItems": .int(1), "items": .object([ "type": .string("string") ]) @@ -491,11 +482,12 @@ extension SubscriptionsWorker { "required": .array([ .string("subscription_id"), .string("reference_name"), - .string("offer_mode"), + .string("offer_id"), .string("duration"), - .string("periods"), - .string("eligibility_duration_type"), - .string("wait_between_offers_months"), + .string("offer_mode"), + .string("period_count"), + .string("eligibility_duration_months"), + .string("territory_ids"), .string("price_point_ids") ]) ]) @@ -513,40 +505,16 @@ extension SubscriptionsWorker { "type": .string("string"), "description": .string("Retention offer ID") ]), - "eligibility_duration_type": .object([ - "type": .array([.string("string"), .string("null")]), - "description": .string("Updated subscriber duration eligibility type (or null to clear)"), - "enum": .array([ - .string("AT_LEAST"), - .string("UP_TO"), - .string("RANGE"), - .null - ]) - ]), - "eligibility_duration_min": .object([ + "eligibility_duration_months": .object([ "type": .array([.string("integer"), .string("null")]), - "description": .string("Updated minimum paid duration in months (or null to clear)"), - "minimum": .int(1) - ]), - "eligibility_duration_max": .object([ - "type": .array([.string("integer"), .string("null")]), - "description": .string("Updated maximum paid duration in months (or null to clear)"), + "description": .string("Updated paid subscription duration in months (1-24, 36, 48, 60, or null to clear)"), "minimum": .int(1) ]), "wait_between_offers_months": .object([ "type": .array([.string("integer"), .string("null")]), - "description": .string("Updated wait between offers in months (or null to clear)"), - "enum": .array([ - .int(0), - .int(1), - .int(2), - .int(3), - .int(6), - .int(9), - .int(12), - .int(24), - .null - ]) + "description": .string("Updated wait between offers in months (2-24 or null to clear)"), + "minimum": .int(2), + "maximum": .int(24) ]) ]), "required": .array([.string("offer_id")]) diff --git a/Tests/ASCMCPTests/Tooling/BuildUploadsManifestContractTests.swift b/Tests/ASCMCPTests/Tooling/BuildUploadsManifestContractTests.swift index f09a400..244b622 100644 --- a/Tests/ASCMCPTests/Tooling/BuildUploadsManifestContractTests.swift +++ b/Tests/ASCMCPTests/Tooling/BuildUploadsManifestContractTests.swift @@ -77,11 +77,11 @@ struct BuildUploadsManifestContractTests { let pin = try #require(manifest.index.optionalInputCoveragePin) #expect(pin.total == 4_562) - #expect(pin.bound == 1_377) + #expect(pin.bound == 1_378) #expect(pin.internalControl == 40) - #expect(pin.intentionallyOmitted == 3_145) + #expect(pin.intentionallyOmitted == 3_144) #expect(pin.unclassified == 0) - #expect(pin.identitySHA256 == "1400d282aefe09f38931d0b51bd5edb7294657dbb0d8c54c3c9a0edc1c2a3ccd") + #expect(pin.identitySHA256 == "680a0bd2f5ef10a5ce67de42ede8efaf3364433171fed2bb972ab0927f821d80") } @Test("operation methods paths statuses and effects are exact") diff --git a/Tests/ASCMCPTests/Tooling/TestFlightManifestContractTests.swift b/Tests/ASCMCPTests/Tooling/TestFlightManifestContractTests.swift index ced7dc8..5308168 100644 --- a/Tests/ASCMCPTests/Tooling/TestFlightManifestContractTests.swift +++ b/Tests/ASCMCPTests/Tooling/TestFlightManifestContractTests.swift @@ -70,11 +70,11 @@ struct TestFlightManifestContractTests { let pin = try #require(manifest.index.optionalInputCoveragePin) #expect(pin.total == 4_562) - #expect(pin.bound == 1_377) + #expect(pin.bound == 1_378) #expect(pin.internalControl == 40) - #expect(pin.intentionallyOmitted == 3_145) + #expect(pin.intentionallyOmitted == 3_144) #expect(pin.unclassified == 0) - #expect(pin.identitySHA256 == "1400d282aefe09f38931d0b51bd5edb7294657dbb0d8c54c3c9a0edc1c2a3ccd") + #expect(pin.identitySHA256 == "680a0bd2f5ef10a5ce67de42ede8efaf3364433171fed2bb972ab0927f821d80") } @Test("TestFlight operation methods paths and success statuses are exact") diff --git a/Tests/ASCMCPTests/Tooling/XcodeCloudManifestContractTests.swift b/Tests/ASCMCPTests/Tooling/XcodeCloudManifestContractTests.swift index f9fdb52..1892134 100644 --- a/Tests/ASCMCPTests/Tooling/XcodeCloudManifestContractTests.swift +++ b/Tests/ASCMCPTests/Tooling/XcodeCloudManifestContractTests.swift @@ -316,11 +316,11 @@ struct XcodeCloudManifestContractTests { let pin = try #require(manifest.index.optionalInputCoveragePin) #expect(pin.total == 4_562) - #expect(pin.bound == 1_377) + #expect(pin.bound == 1_378) #expect(pin.internalControl == 40) - #expect(pin.intentionallyOmitted == 3_145) + #expect(pin.intentionallyOmitted == 3_144) #expect(pin.unclassified == 0) - #expect(pin.identitySHA256 == "1400d282aefe09f38931d0b51bd5edb7294657dbb0d8c54c3c9a0edc1c2a3ccd") + #expect(pin.identitySHA256 == "680a0bd2f5ef10a5ce67de42ede8efaf3364433171fed2bb972ab0927f821d80") } @Test("selected projections distinguish relationship self from related URLs") diff --git a/Tests/ASCMCPTests/Workers/CommerceCatalogOptionalInputTests.swift b/Tests/ASCMCPTests/Workers/CommerceCatalogOptionalInputTests.swift index bd6831f..2de70f9 100644 --- a/Tests/ASCMCPTests/Workers/CommerceCatalogOptionalInputTests.swift +++ b/Tests/ASCMCPTests/Workers/CommerceCatalogOptionalInputTests.swift @@ -380,9 +380,9 @@ struct CommerceCatalogOptionalInputTests { .filter { $0.tool != "subscriptions_pricing_summary" } .flatMap(\.operations) .flatMap { $0.optionalParameterClassifications ?? [] } - #expect(classifications.count == 215) + #expect(classifications.count == 214) #expect(classifications.filter { $0.disposition == .internalControl }.count == 31) - #expect(classifications.filter { $0.disposition == .intentionallyOmitted }.count == 184) + #expect(classifications.filter { $0.disposition == .intentionallyOmitted }.count == 183) #expect(classifications.allSatisfy { $0.reviewAtSpec == "4.6" && !$0.reason.isEmpty }) } } diff --git a/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift b/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift index a365e7d..b4688a7 100644 --- a/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift +++ b/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift @@ -245,23 +245,23 @@ struct RetentionMessagingContractTests { let transport = TestHTTPTransport(responses: [ .init( statusCode: 201, - body: #"{"data":{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"customerEligibilityPaidSubscriptionDurationInMonths":{"minimum":3,"maximum":12},"customerEligibilityWaitBetweenOffersInMonths":6,"startDate":"2026-11-01","endDate":"2027-11-01","targetSubscriptionPlanType":"MONTHLY"},"relationships":{"prices":{"data":[{"type":"retentionOfferPrices","id":"rop-1"}]}}}}"# + body: #"{"data":{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"customerEligibilityPaidSubscriptionDurationInMonths":6,"customerEligibilityWaitBetweenOffersInMonths":6,"targetSubscriptionPlanType":"MONTHLY"},"relationships":{"prices":{"data":[{"type":"retentionOfferPrices","id":"rop-1"}]}}}}"# ), .init( statusCode: 200, - body: #"{"data":[{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"customerEligibilityPaidSubscriptionDurationInMonths":{"minimum":3,"maximum":12},"customerEligibilityWaitBetweenOffersInMonths":6}}],"links":{"self":"https://api.example.test/v1/subscriptions/sub-1/retentionOffers"}}"# + body: #"{"data":[{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"customerEligibilityPaidSubscriptionDurationInMonths":6,"customerEligibilityWaitBetweenOffersInMonths":6,"targetSubscriptionPlanType":"MONTHLY"}}],"links":{"self":"https://api.example.test/v1/subscriptions/sub-1/retentionOffers"}}"# ), .init( statusCode: 200, - body: #"{"data":[{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3}}],"links":{"self":"https://api.example.test/v1/subscriptions/sub-1/retentionMessageOffers"}}"# + body: #"{"data":[{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"customerEligibilityPaidSubscriptionDurationInMonths":6}}],"links":{"self":"https://api.example.test/v1/subscriptions/sub-1/retentionMessageOffers"}}"# ), .init( statusCode: 200, - body: #"{"data":{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3}}}"# + body: #"{"data":{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"customerEligibilityPaidSubscriptionDurationInMonths":6,"customerEligibilityWaitBetweenOffersInMonths":6,"targetSubscriptionPlanType":"MONTHLY"}}}"# ), .init( statusCode: 200, - body: #"{"data":{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"endDate":null}}}"# + body: #"{"data":{"type":"retentionOffers","id":"ro-1","attributes":{"referenceName":"Loyal 6M Offer","offerId":"LOYAL6M","duration":"THREE_MONTHS","offerMode":"PAY_AS_YOU_GO","periodCount":3,"customerEligibilityPaidSubscriptionDurationInMonths":12,"customerEligibilityWaitBetweenOffersInMonths":null,"targetSubscriptionPlanType":"MONTHLY"}}}"# ), .init( statusCode: 200, @@ -271,23 +271,40 @@ struct RetentionMessagingContractTests { ]) let worker = try await makeSubscriptionsWorker(transport: transport) - // Invalid wait_between_offers_months rejected before network access + // Invalid wait_between_offers_months (< 2) rejected before network access let invalidWait = try await worker.handleTool(.init( name: "subscriptions_create_retention_offer", arguments: [ "subscription_id": .string("sub-1"), "reference_name": .string("Bad Wait"), + "offer_id": .string("BADWAIT"), "offer_mode": .string("PAY_AS_YOU_GO"), "duration": .string("ONE_MONTH"), - "periods": .int(1), - "eligibility_duration_type": .string("AT_LEAST"), - "eligibility_duration_min": .int(3), - "wait_between_offers_months": .int(5), + "period_count": .int(1), + "eligibility_duration_months": .int(6), + "wait_between_offers_months": .int(1), "price_point_ids": .array([.string("pp-usa-1")]), "territory_ids": .array([.string("USA")]) ] )) #expect(invalidWait.isError == true) + + // Invalid eligibility_duration_months (25 not in 1...24, 36, 48, 60) rejected before network access + let invalidEligibility = try await worker.handleTool(.init( + name: "subscriptions_create_retention_offer", + arguments: [ + "subscription_id": .string("sub-1"), + "reference_name": .string("Bad Eligibility"), + "offer_id": .string("BADELIG"), + "offer_mode": .string("PAY_AS_YOU_GO"), + "duration": .string("ONE_MONTH"), + "period_count": .int(1), + "eligibility_duration_months": .int(25), + "price_point_ids": .array([.string("pp-usa-1")]), + "territory_ids": .array([.string("USA")]) + ] + )) + #expect(invalidEligibility.isError == true) #expect(await transport.requestCount() == 0) let created = try await worker.handleTool(.init( @@ -295,21 +312,38 @@ struct RetentionMessagingContractTests { arguments: [ "subscription_id": .string("sub-1"), "reference_name": .string("Loyal 6M Offer"), + "offer_id": .string("LOYAL6M"), "offer_mode": .string("PAY_AS_YOU_GO"), "duration": .string("THREE_MONTHS"), - "periods": .int(3), - "eligibility_duration_type": .string("RANGE"), - "eligibility_duration_min": .int(3), - "eligibility_duration_max": .int(12), + "period_count": .int(3), + "eligibility_duration_months": .int(6), "wait_between_offers_months": .int(6), + "target_subscription_plan_type": .string("MONTHLY"), "price_point_ids": .array([.string("pp-usa-1")]), "territory_ids": .array([.string("USA")]) ] )) #expect(created.isError != true) + let createdOffer = try object(try object(created.structuredContent)["offer"]) + #expect(createdOffer["offerId"] == .string("LOYAL6M")) + #expect(createdOffer["periodCount"] == .int(3)) + #expect(createdOffer["customerEligibilityPaidSubscriptionDurationInMonths"] == .int(6)) + #expect(createdOffer["customerEligibilityWaitBetweenOffersInMonths"] == .int(6)) + #expect(createdOffer["targetSubscriptionPlanType"] == .string("MONTHLY")) let createRequest = try #require(await transport.recordedRequests().first) let createBody = try jsonObject(from: try #require(createRequest.httpBody)) + let createData = try #require(createBody["data"] as? [String: Any]) + let createAttributes = try #require(createData["attributes"] as? [String: Any]) + #expect(createAttributes["referenceName"] as? String == "Loyal 6M Offer") + #expect(createAttributes["offerId"] as? String == "LOYAL6M") + #expect(createAttributes["duration"] as? String == "THREE_MONTHS") + #expect(createAttributes["offerMode"] as? String == "PAY_AS_YOU_GO") + #expect(createAttributes["periodCount"] as? Int == 3) + #expect(createAttributes["customerEligibilityPaidSubscriptionDurationInMonths"] as? Int == 6) + #expect(createAttributes["customerEligibilityWaitBetweenOffersInMonths"] as? Int == 6) + #expect(createAttributes["targetSubscriptionPlanType"] as? String == "MONTHLY") + let included = try #require(createBody["included"] as? [[String: Any]]) #expect(included.count == 1) #expect(included[0]["type"] as? String == "retentionOfferPrices") @@ -342,7 +376,11 @@ struct RetentionMessagingContractTests { let updated = try await worker.handleTool(.init( name: "subscriptions_update_retention_offer", - arguments: ["offer_id": .string("ro-1"), "wait_between_offers_months": .int(12)] + arguments: [ + "offer_id": .string("ro-1"), + "eligibility_duration_months": .int(12), + "wait_between_offers_months": .null + ] )) #expect(updated.isError != true) @@ -362,6 +400,10 @@ struct RetentionMessagingContractTests { let requests = await transport.recordedRequests() #expect(requests[1].url?.path == "/v1/subscriptions/sub-1/retentionOffers") #expect(requests[2].url?.path == "/v1/subscriptions/sub-1/retentionMessageOffers") + let patchBody = try jsonObject(from: try #require(requests[4].httpBody)) + let patchAttributes = try #require((patchBody["data"] as? [String: Any])?["attributes"] as? [String: Any]) + #expect(patchAttributes["customerEligibilityPaidSubscriptionDurationInMonths"] as? Int == 12) + #expect(patchAttributes["customerEligibilityWaitBetweenOffersInMonths"] is NSNull) #expect(requests[5].url?.path == "/v1/retentionOffers/ro-1/prices") } @@ -447,7 +489,7 @@ struct RetentionMessagingContractTests { @Test("AssetsWorker reads to-one retentionMessageVersion placement and rejects video and reordering") func assetsWorkerRetentionMessageVersionSupport() async throws { let versionDoc = #"{"data":{"type":"retentionMessageVersions","id":"ver-1","attributes":{"version":1,"state":"PREPARE_FOR_SUBMISSION"},"relationships":{"retentionMessage":{"data":{"type":"retentionMessages","id":"msg-1"}}}}}"# - let appMessagesDoc = #"{"data":[{"type":"retentionMessages","id":"msg-1","attributes":{"referenceName":"Stay With Us"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}}]}"# + let appMessagesDoc = #"{"data":[{"type":"retentionMessages","id":"msg-other","attributes":{"referenceName":"Other Message"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}},{"type":"retentionMessages","id":"msg-1","attributes":{"referenceName":"Stay With Us"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}}]}"# let placementDoc = #"{"data":{"type":"appAssetLibraryPlacements","id":"pl-1","attributes":{"placementType":"retentionImage","placementGroup":"retentionGroup"},"relationships":{"image":{"data":{"type":"appAssetLibraryImages","id":"img-1"}},"retentionMessageVersion":{"data":{"type":"retentionMessageVersions","id":"ver-1"}}}}}"# let transport = TestHTTPTransport(responses: [ @@ -528,6 +570,10 @@ struct RetentionMessagingContractTests { )) #expect(reorderError.isError == true) #expect(await transport.requestCount() == beforeCount) + + let recorded = await transport.recordedRequests() + #expect(recorded[1].url?.path == "/v1/apps/app-1/retentionMessages") + #expect(recorded[1].url?.query?.contains("filter") != true) } // MARK: - 6. ReviewSubmissionsWorker Retention Message Version Support From 8bfb9e038fc88968f5f013f163adf9ada33b2f38 Mon Sep 17 00:00:00 2001 From: Aleksei Zelentsov Date: Sat, 7 Nov 2026 15:30:15 +0300 Subject: [PATCH 4/7] Harden retention messaging contract tests for multi-page ownership and wire schema --- .../RetentionMessagingContractTests.swift | 61 ++++++++++++++++--- 1 file changed, 54 insertions(+), 7 deletions(-) diff --git a/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift b/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift index b4688a7..4b1aac6 100644 --- a/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift +++ b/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift @@ -343,6 +343,10 @@ struct RetentionMessagingContractTests { #expect(createAttributes["customerEligibilityPaidSubscriptionDurationInMonths"] as? Int == 6) #expect(createAttributes["customerEligibilityWaitBetweenOffersInMonths"] as? Int == 6) #expect(createAttributes["targetSubscriptionPlanType"] as? String == "MONTHLY") + #expect(createAttributes["periods"] == nil) + #expect(createAttributes["eligibilitySubscriberDurationType"] == nil) + #expect(createAttributes["eligibilitySubscriberDurationInMonths"] == nil) + #expect(createAttributes["waitBetweenOffersInMonths"] == nil) let included = try #require(createBody["included"] as? [[String: Any]]) #expect(included.count == 1) @@ -373,6 +377,15 @@ struct RetentionMessagingContractTests { arguments: ["offer_id": .string("ro-1")] )) #expect(fetched.isError != true) + let fetchedOffer = try object(try object(fetched.structuredContent)["offer"]) + #expect(fetchedOffer["referenceName"] == .string("Loyal 6M Offer")) + #expect(fetchedOffer["offerId"] == .string("LOYAL6M")) + #expect(fetchedOffer["duration"] == .string("THREE_MONTHS")) + #expect(fetchedOffer["offerMode"] == .string("PAY_AS_YOU_GO")) + #expect(fetchedOffer["periodCount"] == .int(3)) + #expect(fetchedOffer["customerEligibilityPaidSubscriptionDurationInMonths"] == .int(6)) + #expect(fetchedOffer["customerEligibilityWaitBetweenOffersInMonths"] == .int(6)) + #expect(fetchedOffer["targetSubscriptionPlanType"] == .string("MONTHLY")) let updated = try await worker.handleTool(.init( name: "subscriptions_update_retention_offer", @@ -383,6 +396,8 @@ struct RetentionMessagingContractTests { ] )) #expect(updated.isError != true) + let updatedOffer = try object(try object(updated.structuredContent)["offer"]) + #expect(updatedOffer["customerEligibilityPaidSubscriptionDurationInMonths"] == .int(12)) let prices = try await worker.handleTool(.init( name: "subscriptions_list_retention_offer_prices", @@ -404,6 +419,9 @@ struct RetentionMessagingContractTests { let patchAttributes = try #require((patchBody["data"] as? [String: Any])?["attributes"] as? [String: Any]) #expect(patchAttributes["customerEligibilityPaidSubscriptionDurationInMonths"] as? Int == 12) #expect(patchAttributes["customerEligibilityWaitBetweenOffersInMonths"] is NSNull) + #expect(patchAttributes["eligibilitySubscriberDurationType"] == nil) + #expect(patchAttributes["eligibilitySubscriberDurationInMonths"] == nil) + #expect(patchAttributes["waitBetweenOffersInMonths"] == nil) #expect(requests[5].url?.path == "/v1/retentionOffers/ro-1/prices") } @@ -486,19 +504,30 @@ struct RetentionMessagingContractTests { // MARK: - 5. AssetsWorker Retention Message Version Placement Support - @Test("AssetsWorker reads to-one retentionMessageVersion placement and rejects video and reordering") + @Test("AssetsWorker reads to-one retentionMessageVersion placement across multiple pages and rejects foreign app, video, and reordering") func assetsWorkerRetentionMessageVersionSupport() async throws { let versionDoc = #"{"data":{"type":"retentionMessageVersions","id":"ver-1","attributes":{"version":1,"state":"PREPARE_FOR_SUBMISSION"},"relationships":{"retentionMessage":{"data":{"type":"retentionMessages","id":"msg-1"}}}}}"# - let appMessagesDoc = #"{"data":[{"type":"retentionMessages","id":"msg-other","attributes":{"referenceName":"Other Message"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}},{"type":"retentionMessages","id":"msg-1","attributes":{"referenceName":"Stay With Us"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}}]}"# + let appMessagesPage1Doc = #"{"data":[{"type":"retentionMessages","id":"msg-other-1","attributes":{"referenceName":"Other 1"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}},{"type":"retentionMessages","id":"msg-other-2","attributes":{"referenceName":"Other 2"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}}],"links":{"self":"https://api.appstoreconnect.apple.com/v1/apps/app-1/retentionMessages?limit=200","next":"https://api.appstoreconnect.apple.com/v1/apps/app-1/retentionMessages?cursor=page-2&limit=200"},"meta":{"paging":{"total":3,"limit":200}}}"# + let appMessagesPage2Doc = #"{"data":[{"type":"retentionMessages","id":"msg-1","attributes":{"referenceName":"Stay With Us"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}}],"links":{"self":"https://api.appstoreconnect.apple.com/v1/apps/app-1/retentionMessages?cursor=page-2&limit=200"},"meta":{"paging":{"total":3,"limit":200}}}"# + let foreignMessagesPage1Doc = #"{"data":[{"type":"retentionMessages","id":"msg-foreign-1","attributes":{"referenceName":"Foreign 1"},"relationships":{"app":{"data":{"type":"apps","id":"app-foreign"}}}}],"links":{"self":"https://api.appstoreconnect.apple.com/v1/apps/app-foreign/retentionMessages?limit=200","next":"https://api.appstoreconnect.apple.com/v1/apps/app-foreign/retentionMessages?cursor=page-2&limit=200"},"meta":{"paging":{"total":2,"limit":200}}}"# + let foreignMessagesPage2Doc = #"{"data":[{"type":"retentionMessages","id":"msg-foreign-2","attributes":{"referenceName":"Foreign 2"},"relationships":{"app":{"data":{"type":"apps","id":"app-foreign"}}}}],"links":{"self":"https://api.appstoreconnect.apple.com/v1/apps/app-foreign/retentionMessages?cursor=page-2&limit=200"},"meta":{"paging":{"total":2,"limit":200}}}"# let placementDoc = #"{"data":{"type":"appAssetLibraryPlacements","id":"pl-1","attributes":{"placementType":"retentionImage","placementGroup":"retentionGroup"},"relationships":{"image":{"data":{"type":"appAssetLibraryImages","id":"img-1"}},"retentionMessageVersion":{"data":{"type":"retentionMessageVersions","id":"ver-1"}}}}}"# let transport = TestHTTPTransport(responses: [ + // 1. Own app (app-1) with target message on page 2 -> empty to-one placement .init(statusCode: 200, body: versionDoc), - .init(statusCode: 200, body: appMessagesDoc), + .init(statusCode: 200, body: appMessagesPage1Doc), + .init(statusCode: 200, body: appMessagesPage2Doc), .init(statusCode: 200, body: #"{"data":null}"#), + // 2. Own app (app-1) with target message on page 2 -> populated to-one placement .init(statusCode: 200, body: versionDoc), - .init(statusCode: 200, body: appMessagesDoc), - .init(statusCode: 200, body: placementDoc) + .init(statusCode: 200, body: appMessagesPage1Doc), + .init(statusCode: 200, body: appMessagesPage2Doc), + .init(statusCode: 200, body: placementDoc), + // 3. Foreign app (app-foreign) -> rejected after scanning pages without msg-1 + .init(statusCode: 200, body: versionDoc), + .init(statusCode: 200, body: foreignMessagesPage1Doc), + .init(statusCode: 200, body: foreignMessagesPage2Doc) ]) let root = URL(fileURLWithPath: "\(FileManager.default.currentDirectoryPath)/.build/asset-retention-test-\(UUID().uuidString)") defer { try? FileManager.default.removeItem(at: root) } @@ -515,7 +544,7 @@ struct RetentionMessagingContractTests { store: AssetOperationStore(root: root) ) - // Empty to-one placement returns 0 items + // Empty to-one placement returns 0 items when target retention message is on page 2 let emptyList = try await worker.handleTool(.init( name: "assets_list_placements", arguments: [ @@ -527,7 +556,7 @@ struct RetentionMessagingContractTests { #expect(emptyList.isError != true) #expect(try object(emptyList.structuredContent)["count"] == .int(0)) - // Populated to-one placement returns 1 item + // Populated to-one placement returns 1 item when target retention message is on page 2 let populatedList = try await worker.handleTool(.init( name: "assets_list_placements", arguments: [ @@ -539,6 +568,17 @@ struct RetentionMessagingContractTests { #expect(populatedList.isError != true) #expect(try object(populatedList.structuredContent)["count"] == .int(1)) + // Foreign app is rejected when target retention message is not among its retention messages + let foreignRejected = try await worker.handleTool(.init( + name: "assets_list_placements", + arguments: [ + "app_id": .string("app-foreign"), + "target_type": .string("retentionMessageVersion"), + "target_id": .string("ver-1") + ] + )) + #expect(foreignRejected.isError == true) + // Rejects video placement on retentionMessageVersion before network access let beforeCount = await transport.requestCount() let videoError = try await worker.handleTool(.init( @@ -572,8 +612,15 @@ struct RetentionMessagingContractTests { #expect(await transport.requestCount() == beforeCount) let recorded = await transport.recordedRequests() + #expect(recorded.count == 11) #expect(recorded[1].url?.path == "/v1/apps/app-1/retentionMessages") #expect(recorded[1].url?.query?.contains("filter") != true) + #expect(recorded[2].url?.path == "/v1/apps/app-1/retentionMessages") + #expect(recorded[2].url?.query?.contains("cursor=page-2") == true) + #expect(recorded[2].url?.query?.contains("filter") != true) + #expect(recorded[9].url?.path == "/v1/apps/app-foreign/retentionMessages") + #expect(recorded[10].url?.path == "/v1/apps/app-foreign/retentionMessages") + #expect(recorded[10].url?.query?.contains("cursor=page-2") == true) } // MARK: - 6. ReviewSubmissionsWorker Retention Message Version Support From f836426503ab087764c7a34ceca3d2f59c06bf67 Mon Sep 17 00:00:00 2001 From: Aleksei Zelentsov Date: Sat, 7 Nov 2026 16:49:56 +0300 Subject: [PATCH 5/7] fix(subscriptions): use getPage for retention pagination, project offer price amounts, and allow Plane 2 CJK copy --- Sources/asc-mcp/Services/JWTService.swift | 8 +- ...ubscriptionsWorker+RetentionHandlers.swift | 188 +++++---- .../RetentionMessagingContractTests.swift | 376 +++++++++++++++++- 3 files changed, 486 insertions(+), 86 deletions(-) diff --git a/Sources/asc-mcp/Services/JWTService.swift b/Sources/asc-mcp/Services/JWTService.swift index 33dd440..99a2f14 100644 --- a/Sources/asc-mcp/Services/JWTService.swift +++ b/Sources/asc-mcp/Services/JWTService.swift @@ -105,7 +105,7 @@ public actor JWTService { return Date(timeIntervalSince1970: TimeInterval(payload.exp)) } catch { #if DEBUG - print("🔐 JWT: Failed to decode token payload: \(error)") + print("🔐 JWT: Failed to decode token payload: \(error)", to: &standardError) #endif return nil } @@ -123,12 +123,12 @@ public actor JWTService { if timeUntilExpiry > tokenRefreshLeeway { // Token is still valid #if DEBUG - print("🔐 JWT: Using cached token (expires in \(Int(timeUntilExpiry))s)") + print("🔐 JWT: Using cached token (expires in \(Int(timeUntilExpiry))s)", to: &standardError) #endif return token } else { #if DEBUG - print("🔐 JWT: Token expires in \(Int(timeUntilExpiry))s, refreshing...") + print("🔐 JWT: Token expires in \(Int(timeUntilExpiry))s, refreshing...", to: &standardError) #endif } } @@ -140,7 +140,7 @@ public actor JWTService { #if DEBUG if let exp = decodeTokenExpiration(token) { let duration = exp.timeIntervalSince(now) - print("🔐 JWT: Generated new token (valid for \(Int(duration))s)") + print("🔐 JWT: Generated new token (valid for \(Int(duration))s)", to: &standardError) } #endif diff --git a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift index a2d9812..c5f78f7 100644 --- a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift +++ b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift @@ -7,8 +7,16 @@ extension SubscriptionsWorker { private struct RetentionPaginationParams: Sendable { let limit: Int? let nextURL: String? + let scope: PaginationScope } + private static let retentionOfferPricesQueryParameters: [String: String] = [ + "include": "territory,subscriptionPricePoint", + "fields[retentionOfferPrices]": "territory,subscriptionPricePoint", + "fields[subscriptionPricePoints]": "customerPrice,proceeds,proceedsYear2,territory", + "fields[territories]": "currency" + ] + private static let allowedRetentionOfferModes: Set = [ "PAY_AS_YOU_GO", "PAY_UP_FRONT", @@ -49,16 +57,17 @@ extension SubscriptionsWorker { "app_id", "limit", "next_url" ]) let encodedAppId = try validateRetentionRequiredResourceID(params.arguments, key: "app_id") + let endpointPath = "/v1/apps/\(try ASCPathSegment.encode(encodedAppId, field: "app_id"))/retentionMessages" let pagination = try parseRetentionPagination( params.arguments, - allowedPaths: ["/v1/apps/\(try ASCPathSegment.encode(encodedAppId, field: "app_id"))/retentionMessages"] + endpointPath: endpointPath ) let response: ASCRetentionMessagesResponse if let nextURL = pagination.nextURL { - response = try await httpClient.get( + response = try await httpClient.getPage( nextURL, - parameters: [:], + scope: pagination.scope, as: ASCRetentionMessagesResponse.self ) } else { @@ -67,7 +76,7 @@ extension SubscriptionsWorker { queryParams["limit"] = String(limit) } response = try await httpClient.get( - "/v1/apps/\(try ASCPathSegment.encode(encodedAppId, field: "app_id"))/retentionMessages", + endpointPath, parameters: queryParams, as: ASCRetentionMessagesResponse.self ) @@ -192,19 +201,17 @@ extension SubscriptionsWorker { params.arguments, key: "retention_message_id" ) + let endpointPath = "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/versions" let pagination = try parseRetentionPagination( params.arguments, - allowedPaths: [ - "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/versions", - "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/retentionMessageVersions" - ] + endpointPath: endpointPath ) let response: ASCRetentionMessageVersionsResponse if let nextURL = pagination.nextURL { - response = try await httpClient.get( + response = try await httpClient.getPage( nextURL, - parameters: [:], + scope: pagination.scope, as: ASCRetentionMessageVersionsResponse.self ) } else { @@ -213,7 +220,7 @@ extension SubscriptionsWorker { queryParams["limit"] = String(limit) } response = try await httpClient.get( - "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/versions", + endpointPath, parameters: queryParams, as: ASCRetentionMessageVersionsResponse.self ) @@ -313,19 +320,17 @@ extension SubscriptionsWorker { params.arguments, key: "version_id" ) + let endpointPath = "/v1/retentionMessageVersions/\(try ASCPathSegment.encode(encodedVersionId, field: "version_id"))/localizations" let pagination = try parseRetentionPagination( params.arguments, - allowedPaths: [ - "/v1/retentionMessageVersions/\(try ASCPathSegment.encode(encodedVersionId, field: "version_id"))/localizations", - "/v1/retentionMessageVersions/\(try ASCPathSegment.encode(encodedVersionId, field: "version_id"))/retentionMessageLocalizations" - ] + endpointPath: endpointPath ) let response: ASCRetentionMessageLocalizationsResponse if let nextURL = pagination.nextURL { - response = try await httpClient.get( + response = try await httpClient.getPage( nextURL, - parameters: [:], + scope: pagination.scope, as: ASCRetentionMessageLocalizationsResponse.self ) } else { @@ -334,7 +339,7 @@ extension SubscriptionsWorker { queryParams["limit"] = String(limit) } response = try await httpClient.get( - "/v1/retentionMessageVersions/\(try ASCPathSegment.encode(encodedVersionId, field: "version_id"))/localizations", + endpointPath, parameters: queryParams, as: ASCRetentionMessageLocalizationsResponse.self ) @@ -538,19 +543,17 @@ extension SubscriptionsWorker { params.arguments, key: "retention_message_id" ) + let endpointPath = "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/subscriptions" let pagination = try parseRetentionPagination( params.arguments, - allowedPaths: [ - "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/subscriptions", - "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/relationships/subscriptions" - ] + endpointPath: endpointPath ) let response: ASCRetentionMessageSubscriptionsResponse if let nextURL = pagination.nextURL { - response = try await httpClient.get( + response = try await httpClient.getPage( nextURL, - parameters: [:], + scope: pagination.scope, as: ASCRetentionMessageSubscriptionsResponse.self ) } else { @@ -559,7 +562,7 @@ extension SubscriptionsWorker { queryParams["limit"] = String(limit) } response = try await httpClient.get( - "/v1/retentionMessages/\(try ASCPathSegment.encode(encodedMessageId, field: "retention_message_id"))/subscriptions", + endpointPath, parameters: queryParams, as: ASCRetentionMessageSubscriptionsResponse.self ) @@ -616,17 +619,14 @@ extension SubscriptionsWorker { let pagination = try parseRetentionPagination( params.arguments, - allowedPaths: [ - "/v1/subscriptions/\(try ASCPathSegment.encode(encodedSubId, field: "subscription_id"))/retentionOffers", - "/v1/subscriptions/\(try ASCPathSegment.encode(encodedSubId, field: "subscription_id"))/retentionMessageOffers" - ] + endpointPath: endpointPath ) let response: ASCRetentionOffersResponse if let nextURL = pagination.nextURL { - response = try await httpClient.get( + response = try await httpClient.getPage( nextURL, - parameters: [:], + scope: pagination.scope, as: ASCRetentionOffersResponse.self ) } else { @@ -924,30 +924,29 @@ extension SubscriptionsWorker { key: "offer_id" ) let territories = try parseOptionalTerritoryFilter(params.arguments, key: "territory") + let endpointPath = "/v1/retentionOffers/\(try ASCPathSegment.encode(encodedOfferId, field: "offer_id"))/prices" + + var requiredPaginationParams: [String: String] = [:] + if let territories, !territories.isEmpty { + requiredPaginationParams["filter[territory]"] = territories.joined(separator: ",") + } let pagination = try parseRetentionPagination( params.arguments, - allowedPaths: ["/v1/retentionOffers/\(try ASCPathSegment.encode(encodedOfferId, field: "offer_id"))/prices"], - allowedQueryKeys: [ - "limit", - "cursor", - "filter[territory]", - "include", - "fields[retentionOfferPrices]", - "fields[territories]", - "fields[subscriptionPricePoints]" - ] + endpointPath: endpointPath, + requiredParameters: requiredPaginationParams, + optionalFixedParameters: Self.retentionOfferPricesQueryParameters ) let response: ASCRetentionOfferPricesResponse if let nextURL = pagination.nextURL { - response = try await httpClient.get( + response = try await httpClient.getPage( nextURL, - parameters: [:], + scope: pagination.scope, as: ASCRetentionOfferPricesResponse.self ) } else { - var queryParams: [String: String] = [:] + var queryParams = Self.retentionOfferPricesQueryParameters if let limit = pagination.limit { queryParams["limit"] = String(limit) } @@ -955,13 +954,13 @@ extension SubscriptionsWorker { queryParams["filter[territory]"] = territories.joined(separator: ",") } response = try await httpClient.get( - "/v1/retentionOffers/\(try ASCPathSegment.encode(encodedOfferId, field: "offer_id"))/prices", + endpointPath, parameters: queryParams, as: ASCRetentionOfferPricesResponse.self ) } - let prices = response.data.map { formatRetentionOfferPrice($0) } + let prices = response.data.map { formatRetentionOfferPrice($0, included: response.included) } var result: [String: Any] = [ "success": true, "data": prices, @@ -1192,8 +1191,9 @@ extension SubscriptionsWorker { private func parseRetentionPagination( _ arguments: [String: Value]?, - allowedPaths: Set, - allowedQueryKeys: Set = ["limit", "cursor", "include"] + endpointPath: String, + requiredParameters: [String: String] = [:], + optionalFixedParameters: [String: String] = [:] ) throws -> RetentionPaginationParams { var parsedLimit: Int? if let rawLimit = arguments?["limit"], rawLimit != .null { @@ -1203,6 +1203,15 @@ extension SubscriptionsWorker { parsedLimit = intLimit } + var effectiveRequired = requiredParameters + if let parsedLimit { + effectiveRequired["limit"] = String(parsedLimit) + } + + var allowedKeys: Set = ["cursor", "limit"] + allowedKeys.formUnion(effectiveRequired.keys) + allowedKeys.formUnion(optionalFixedParameters.keys) + var parsedNextURL: String? if let rawNext = arguments?["next_url"], rawNext != .null { guard case .string(let nextString) = rawNext else { @@ -1219,46 +1228,39 @@ extension SubscriptionsWorker { throw ASCError.parsing("Invalid 'next_url' format") } - if let scheme = components.scheme { - guard scheme.lowercased() == "https", - components.host?.lowercased() == "api.appstoreconnect.apple.com", - components.port == nil else { - throw ASCError.parsing( - "Invalid 'next_url': must target https://api.appstoreconnect.apple.com" - ) - } - } else if components.host != nil { - throw ASCError.parsing("Invalid 'next_url' host") - } - - let path = components.percentEncodedPath - guard allowedPaths.contains(path) else { - throw ASCError.parsing( - "Invalid 'next_url' path '\(path)' for this endpoint" - ) - } - if let queryItems = components.queryItems { for item in queryItems { - guard allowedQueryKeys.contains(item.name) else { + guard allowedKeys.contains(item.name) else { throw ASCError.parsing( "Unsupported query parameter '\(item.name)' in 'next_url'" ) } - if item.name == "limit", let val = item.value { - guard let intLimit = Int(val), (1...200).contains(intLimit) else { + if item.name == "limit" { + guard let val = item.value, + let intLimit = Int(val), + (1...200).contains(intLimit) else { throw ASCError.parsing( "Invalid 'limit' in 'next_url': must be between 1 and 200" ) } } + if let expectedFixedValue = optionalFixedParameters[item.name] { + effectiveRequired[item.name] = expectedFixedValue + } } } parsedNextURL = nextString } - return RetentionPaginationParams(limit: parsedLimit, nextURL: parsedNextURL) + let scope = PaginationScope( + path: endpointPath, + requiredParameters: effectiveRequired, + allowedParameters: allowedKeys, + requiredNonEmptyParameters: ["cursor"] + ) + + return RetentionPaginationParams(limit: parsedLimit, nextURL: parsedNextURL, scope: scope) } private func validateRetentionReferenceName( @@ -1351,13 +1353,7 @@ extension SubscriptionsWorker { } private func validateNoEmoji(in text: String, field: String) throws { - let containsEmoji = text.unicodeScalars.contains { scalar in - scalar.properties.isEmojiPresentation - || scalar.value >= 0x1F000 - || (0x2600...0x27BF).contains(scalar.value) - || scalar.value == 0xFE0F - } - if containsEmoji { + if ASCMetadataValidator.containsEmoji(text) { throw ASCError.parsing("Parameter '\(field)' must not contain emoji characters") } } @@ -1785,16 +1781,46 @@ extension SubscriptionsWorker { return result } - private func formatRetentionOfferPrice(_ price: ASCRetentionOfferPrice) -> [String: Any] { + private func formatRetentionOfferPrice( + _ price: ASCRetentionOfferPrice, + included: [ASCWinBackOfferPriceIncludedResource]? = nil + ) -> [String: Any] { var result: [String: Any] = [ "id": price.id, "type": price.type ] - if let territoryId = price.relationships?.territory?.data?.id { + let pricePointId = price.relationships?.subscriptionPricePoint?.data?.id + let pricePoint = pricePointId.flatMap { id in + included?.first(where: { $0.type == "subscriptionPricePoints" && $0.id == id }) + } + let territoryId = price.relationships?.territory?.data?.id + ?? pricePoint?.relationships?["territory"]?.objectValue?["data"]?.objectValue?["id"]?.stringValue + let territory = territoryId.flatMap { id in + included?.first(where: { $0.type == "territories" && $0.id == id }) + } + + if let territoryId { result["territoryId"] = territoryId + result["territory_id"] = territoryId } - if let pricePointId = price.relationships?.subscriptionPricePoint?.data?.id { + if let pricePointId { result["subscriptionPricePointId"] = pricePointId + result["subscription_price_point_id"] = pricePointId + result["price_point_id"] = pricePointId + } + if let currency = territory?.attributes?["currency"]?.stringValue { + result["currency"] = currency + } + if let customerPrice = pricePoint?.attributes?["customerPrice"]?.stringValue { + result["customerPrice"] = customerPrice + result["customer_price"] = customerPrice + } + if let proceeds = pricePoint?.attributes?["proceeds"]?.stringValue { + result["proceeds"] = proceeds + } + if let proceedsYear2 = pricePoint?.attributes?["proceedsYear2"]?.stringValue { + result["proceedsYear2"] = proceedsYear2 + result["proceeds_year2"] = proceedsYear2 } return result } diff --git a/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift b/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift index 4b1aac6..9f3b1aa 100644 --- a/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift +++ b/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift @@ -404,7 +404,21 @@ struct RetentionMessagingContractTests { arguments: ["offer_id": .string("ro-1"), "territory": .string("USA,GBR")] )) #expect(prices.isError != true) - #expect(try object(prices.structuredContent)["count"] == .int(1)) + let pricesPayload = try object(prices.structuredContent) + #expect(pricesPayload["count"] == .int(1)) + let firstPrice = try object(try #require(pricesPayload["prices"]?.arrayValue?.first)) + #expect(firstPrice["id"] == .string("rop-1")) + #expect(firstPrice["territoryId"] == .string("USA")) + #expect(firstPrice["territory_id"] == .string("USA")) + #expect(firstPrice["subscriptionPricePointId"] == .string("pp-usa-1")) + #expect(firstPrice["subscription_price_point_id"] == .string("pp-usa-1")) + #expect(firstPrice["price_point_id"] == .string("pp-usa-1")) + #expect(firstPrice["currency"] == .string("USD")) + #expect(firstPrice["customerPrice"] == .string("4.99")) + #expect(firstPrice["customer_price"] == .string("4.99")) + #expect(firstPrice["proceeds"] == .string("3.49")) + #expect(firstPrice["proceedsYear2"] == .string("4.24")) + #expect(firstPrice["proceeds_year2"] == .string("4.24")) let deleted = try await worker.handleTool(.init( name: "subscriptions_delete_retention_offer", @@ -423,6 +437,14 @@ struct RetentionMessagingContractTests { #expect(patchAttributes["eligibilitySubscriberDurationInMonths"] == nil) #expect(patchAttributes["waitBetweenOffersInMonths"] == nil) #expect(requests[5].url?.path == "/v1/retentionOffers/ro-1/prices") + let pricesRequestURL = try #require(requests[5].url) + let pricesQueryItems = try #require(URLComponents(url: pricesRequestURL, resolvingAgainstBaseURL: false)?.queryItems) + let pricesQuery = Dictionary(uniqueKeysWithValues: pricesQueryItems.map { ($0.name, $0.value ?? "") }) + #expect(pricesQuery["filter[territory]"] == "USA,GBR") + #expect(pricesQuery["include"] == "territory,subscriptionPricePoint") + #expect(pricesQuery["fields[retentionOfferPrices]"] == "territory,subscriptionPricePoint") + #expect(pricesQuery["fields[subscriptionPricePoints]"] == "customerPrice,proceeds,proceedsYear2,territory") + #expect(pricesQuery["fields[territories]"] == "currency") } // MARK: - 4. Subscription Retention Relationships @@ -655,6 +677,358 @@ struct RetentionMessagingContractTests { #expect(item["resource_jsonapi_type"] == .string("retentionMessageVersions")) #expect(item["resource_id"] == .string("ver-1")) } + + // MARK: - 7. Retention List Pagination (All 14 Combinations + Scope Rejections) + + @Test("retention list handlers support absolute and root-relative next_url across all 7 endpoints and reject out-of-scope pagination links") + func retentionListPaginationAllCombinationsAndRejections() async throws { + let messagesDoc = #"{"data":[{"type":"retentionMessages","id":"msg-2","attributes":{"referenceName":"Page 2"}}],"links":{"self":"https://api.example.test/v1/apps/app-1/retentionMessages?cursor=page-2"}}"# + let versionsDoc = #"{"data":[{"type":"retentionMessageVersions","id":"ver-2","attributes":{"version":2,"state":"READY_FOR_REVIEW"}}],"links":{"self":"https://api.example.test/v1/retentionMessages/msg-1/versions?cursor=page-2"}}"# + let localizationsDoc = #"{"data":[{"type":"retentionMessageLocalizations","id":"loc-2","attributes":{"locale":"ja","header":"継続特典","body":"すべての機能を引き続きご利用いただけます。"}}],"links":{"self":"https://api.example.test/v1/retentionMessageVersions/ver-1/localizations?cursor=page-2"}}"# + let subscriptionsDoc = #"{"data":[{"type":"subscriptions","id":"sub-2","attributes":{"name":"Pro Annual","productId":"com.example.annual","state":"APPROVED","subscriptionPeriod":"ONE_YEAR"}}],"links":{"self":"https://api.example.test/v1/retentionMessages/msg-1/subscriptions?cursor=page-2"}}"# + let offersDoc = #"{"data":[{"type":"retentionOffers","id":"ro-2","attributes":{"referenceName":"Page 2 Offer","offerId":"OFFER2","duration":"ONE_MONTH","offerMode":"PAY_AS_YOU_GO","periodCount":1,"customerEligibilityPaidSubscriptionDurationInMonths":6}}],"links":{"self":"https://api.example.test/v1/subscriptions/sub-1/retentionOffers?cursor=page-2"}}"# + let messageOffersDoc = #"{"data":[{"type":"retentionOffers","id":"ro-3","attributes":{"referenceName":"Page 2 Message Offer","offerId":"MSGOFFER2","duration":"ONE_MONTH","offerMode":"PAY_AS_YOU_GO","periodCount":1,"customerEligibilityPaidSubscriptionDurationInMonths":6}}],"links":{"self":"https://api.example.test/v1/subscriptions/sub-1/retentionMessageOffers?cursor=page-2"}}"# + let pricesDoc = #"{"data":[{"type":"retentionOfferPrices","id":"rop-2","relationships":{"territory":{"data":{"type":"territories","id":"USA"}},"subscriptionPricePoint":{"data":{"type":"subscriptionPricePoints","id":"pp-usa-2"}}}}],"included":[{"type":"subscriptionPricePoints","id":"pp-usa-2","attributes":{"customerPrice":"2.99","proceeds":"2.10","proceedsYear2":"2.54"}},{"type":"territories","id":"USA","attributes":{"currency":"USD"}}],"links":{"self":"https://api.example.test/v1/retentionOffers/ro-1/prices?cursor=page-2"}}"# + + // 1. Negative checks before any HTTP I/O + let negativeTransport = TestHTTPTransport(responses: []) + let negativeWorker = try await makeSubscriptionsWorker(transport: negativeTransport) + + let negativeCases: [(String, [String: Value])] = [ + // Wrong parent ID + ( + "subscriptions_list_retention_messages", + ["app_id": .string("app-1"), "next_url": .string("https://api.example.test/v1/apps/app-other/retentionMessages?cursor=page-2")] + ), + // Wrong endpoint (retentionOffers when message_offers_only is true) + ( + "subscriptions_list_retention_offers", + [ + "subscription_id": .string("sub-1"), + "message_offers_only": .bool(true), + "next_url": .string("https://api.example.test/v1/subscriptions/sub-1/retentionOffers?cursor=page-2") + ] + ), + // Wrong endpoint (retentionMessageOffers when message_offers_only is false) + ( + "subscriptions_list_retention_offers", + [ + "subscription_id": .string("sub-1"), + "message_offers_only": .bool(false), + "next_url": .string("/v1/subscriptions/sub-1/retentionMessageOffers?cursor=page-2") + ] + ), + // Missing cursor + ( + "subscriptions_list_retention_message_versions", + ["retention_message_id": .string("msg-1"), "next_url": .string("https://api.example.test/v1/retentionMessages/msg-1/versions?limit=10")] + ), + // Empty cursor + ( + "subscriptions_list_retention_message_localizations", + ["version_id": .string("ver-1"), "next_url": .string("/v1/retentionMessageVersions/ver-1/localizations?cursor=")] + ), + // Unrequested filter[territory] when territory argument was omitted + ( + "subscriptions_list_retention_offer_prices", + ["offer_id": .string("ro-1"), "next_url": .string("https://api.example.test/v1/retentionOffers/ro-1/prices?cursor=page-2&filter%5Bterritory%5D=USA")] + ), + // Changed filter[territory] when territory argument was provided + ( + "subscriptions_list_retention_offer_prices", + [ + "offer_id": .string("ro-1"), + "territory": .string("USA"), + "next_url": .string("https://api.example.test/v1/retentionOffers/ro-1/prices?cursor=page-2&filter%5Bterritory%5D=GBR") + ] + ), + // Missing filter[territory] in next_url when territory argument was provided + ( + "subscriptions_list_retention_offer_prices", + [ + "offer_id": .string("ro-1"), + "territory": .string("USA"), + "next_url": .string("/v1/retentionOffers/ro-1/prices?cursor=page-2") + ] + ), + // Tampered include in next_url + ( + "subscriptions_list_retention_offer_prices", + [ + "offer_id": .string("ro-1"), + "next_url": .string("https://api.example.test/v1/retentionOffers/ro-1/prices?cursor=page-2&include=subscription") + ] + ) + ] + + for (toolName, arguments) in negativeCases { + let result = try await negativeWorker.handleTool(.init(name: toolName, arguments: arguments)) + #expect(result.isError == true, "Expected \(toolName) with \(arguments) to be rejected before HTTP I/O") + } + #expect(await negativeTransport.requestCount() == 0) + + // 2. Positive checks across all 14 combinations (7 endpoints x absolute + root-relative) plus filtered prices + let transport = TestHTTPTransport(responses: [ + .init(statusCode: 200, body: messagesDoc), + .init(statusCode: 200, body: messagesDoc), + .init(statusCode: 200, body: versionsDoc), + .init(statusCode: 200, body: versionsDoc), + .init(statusCode: 200, body: localizationsDoc), + .init(statusCode: 200, body: localizationsDoc), + .init(statusCode: 200, body: subscriptionsDoc), + .init(statusCode: 200, body: subscriptionsDoc), + .init(statusCode: 200, body: offersDoc), + .init(statusCode: 200, body: offersDoc), + .init(statusCode: 200, body: messageOffersDoc), + .init(statusCode: 200, body: messageOffersDoc), + .init(statusCode: 200, body: pricesDoc), + .init(statusCode: 200, body: pricesDoc), + .init(statusCode: 200, body: pricesDoc) + ]) + let worker = try await makeSubscriptionsWorker(transport: transport) + + let positiveCases: [(String, [String: Value], String)] = [ + // 1-2: subscriptions_list_retention_messages + ( + "subscriptions_list_retention_messages", + ["app_id": .string("app-1"), "next_url": .string("https://api.example.test/v1/apps/app-1/retentionMessages?cursor=page-2")], + "/v1/apps/app-1/retentionMessages" + ), + ( + "subscriptions_list_retention_messages", + ["app_id": .string("app-1"), "next_url": .string("/v1/apps/app-1/retentionMessages?cursor=page-2")], + "/v1/apps/app-1/retentionMessages" + ), + // 3-4: subscriptions_list_retention_message_versions + ( + "subscriptions_list_retention_message_versions", + ["retention_message_id": .string("msg-1"), "next_url": .string("https://api.example.test/v1/retentionMessages/msg-1/versions?cursor=page-2")], + "/v1/retentionMessages/msg-1/versions" + ), + ( + "subscriptions_list_retention_message_versions", + ["retention_message_id": .string("msg-1"), "next_url": .string("/v1/retentionMessages/msg-1/versions?cursor=page-2")], + "/v1/retentionMessages/msg-1/versions" + ), + // 5-6: subscriptions_list_retention_message_localizations + ( + "subscriptions_list_retention_message_localizations", + ["version_id": .string("ver-1"), "next_url": .string("https://api.example.test/v1/retentionMessageVersions/ver-1/localizations?cursor=page-2")], + "/v1/retentionMessageVersions/ver-1/localizations" + ), + ( + "subscriptions_list_retention_message_localizations", + ["version_id": .string("ver-1"), "next_url": .string("/v1/retentionMessageVersions/ver-1/localizations?cursor=page-2")], + "/v1/retentionMessageVersions/ver-1/localizations" + ), + // 7-8: subscriptions_list_retention_message_subscriptions + ( + "subscriptions_list_retention_message_subscriptions", + ["retention_message_id": .string("msg-1"), "next_url": .string("https://api.example.test/v1/retentionMessages/msg-1/subscriptions?cursor=page-2")], + "/v1/retentionMessages/msg-1/subscriptions" + ), + ( + "subscriptions_list_retention_message_subscriptions", + ["retention_message_id": .string("msg-1"), "next_url": .string("/v1/retentionMessages/msg-1/subscriptions?cursor=page-2")], + "/v1/retentionMessages/msg-1/subscriptions" + ), + // 9-10: subscriptions_list_retention_offers (message_offers_only: false) + ( + "subscriptions_list_retention_offers", + [ + "subscription_id": .string("sub-1"), + "message_offers_only": .bool(false), + "next_url": .string("https://api.example.test/v1/subscriptions/sub-1/retentionOffers?cursor=page-2") + ], + "/v1/subscriptions/sub-1/retentionOffers" + ), + ( + "subscriptions_list_retention_offers", + [ + "subscription_id": .string("sub-1"), + "message_offers_only": .bool(false), + "next_url": .string("/v1/subscriptions/sub-1/retentionOffers?cursor=page-2") + ], + "/v1/subscriptions/sub-1/retentionOffers" + ), + // 11-12: subscriptions_list_retention_offers (message_offers_only: true) + ( + "subscriptions_list_retention_offers", + [ + "subscription_id": .string("sub-1"), + "message_offers_only": .bool(true), + "next_url": .string("https://api.example.test/v1/subscriptions/sub-1/retentionMessageOffers?cursor=page-2") + ], + "/v1/subscriptions/sub-1/retentionMessageOffers" + ), + ( + "subscriptions_list_retention_offers", + [ + "subscription_id": .string("sub-1"), + "message_offers_only": .bool(true), + "next_url": .string("/v1/subscriptions/sub-1/retentionMessageOffers?cursor=page-2") + ], + "/v1/subscriptions/sub-1/retentionMessageOffers" + ), + // 13-14: subscriptions_list_retention_offer_prices (absolute with full query + root-relative minimal query) + ( + "subscriptions_list_retention_offer_prices", + [ + "offer_id": .string("ro-1"), + "next_url": .string("https://api.example.test/v1/retentionOffers/ro-1/prices?cursor=page-2&include=territory,subscriptionPricePoint&fields%5BretentionOfferPrices%5D=territory,subscriptionPricePoint&fields%5BsubscriptionPricePoints%5D=customerPrice,proceeds,proceedsYear2,territory&fields%5Bterritories%5D=currency") + ], + "/v1/retentionOffers/ro-1/prices" + ), + ( + "subscriptions_list_retention_offer_prices", + [ + "offer_id": .string("ro-1"), + "next_url": .string("/v1/retentionOffers/ro-1/prices?cursor=page-2") + ], + "/v1/retentionOffers/ro-1/prices" + ), + // 15: subscriptions_list_retention_offer_prices with territory filter preserved in next_url + ( + "subscriptions_list_retention_offer_prices", + [ + "offer_id": .string("ro-1"), + "territory": .string("USA,GBR"), + "next_url": .string("https://api.example.test/v1/retentionOffers/ro-1/prices?cursor=page-2&filter%5Bterritory%5D=GBR,USA") + ], + "/v1/retentionOffers/ro-1/prices" + ) + ] + + for (index, (toolName, arguments, _)) in positiveCases.enumerated() { + let result = try await worker.handleTool(.init(name: toolName, arguments: arguments)) + #expect(result.isError != true, "Case \(index) (\(toolName)) failed: \(result.content)") + let payload = try object(result.structuredContent) + #expect(payload["count"] == .int(1)) + } + + let requests = await transport.recordedRequests() + #expect(requests.count == 15) + for (index, (_, _, expectedPath)) in positiveCases.enumerated() { + #expect(requests[index].url?.path == expectedPath) + #expect(requests[index].url?.query?.contains("cursor=page-2") == true) + } + } + + // MARK: - 8. Plane 2 CJK Ideographs vs Emoji Validation + + @Test("retention copy and reference_name validation accepts Plane 2 CJK ideographs and rejects emojis") + func plane2CJKAcceptedAndEmojisRejected() async throws { + let transport = TestHTTPTransport(responses: [ + .init( + statusCode: 201, + body: #"{"data":{"type":"retentionMessageLocalizations","id":"loc-ja-1","attributes":{"locale":"ja","header":"𠮷野の便利な機能を継続","body":"𠮟咤激励の機能も引き続きご利用いただけます。"},"relationships":{"retentionMessageVersion":{"data":{"type":"retentionMessageVersions","id":"ver-1"}}}}}"# + ), + .init( + statusCode: 200, + body: #"{"data":{"type":"retentionMessageLocalizations","id":"loc-ja-1","attributes":{"locale":"ja","header":"𠮷野の便利な機能を継続","body":"𠮟咤激励の機能も引き続きご利用いただけます。"}}}"# + ), + .init( + statusCode: 201, + body: #"{"data":{"type":"retentionMessages","id":"msg-ja-1","attributes":{"referenceName":"𠮷野キャンペーン"},"relationships":{"app":{"data":{"type":"apps","id":"app-1"}}}}}"# + ), + .init( + statusCode: 201, + body: #"{"data":{"type":"retentionOffers","id":"ro-ja-1","attributes":{"referenceName":"𠮷野キャンペーン","offerId":"YOSHINO1","duration":"ONE_MONTH","offerMode":"PAY_AS_YOU_GO","periodCount":1,"customerEligibilityPaidSubscriptionDurationInMonths":6}}}"# + ) + ]) + let worker = try await makeSubscriptionsWorker(transport: transport) + + // Real emojis rejected before network access + for emojiHeader in ["キャンペーン🎉", "特典🔥", "継続✨", "限定❤️", "夏休み☀️"] { + let rejected = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message_localization", + arguments: [ + "version_id": .string("ver-1"), + "locale": .string("ja"), + "header": .string(emojiHeader), + "body": .string("引き続きご利用いただけます。") + ] + )) + #expect(rejected.isError == true, "Expected emoji header '\(emojiHeader)' to be rejected") + } + + let rejectedMessageRef = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message", + arguments: [ + "app_id": .string("app-1"), + "reference_name": .string("キャンペーン🔥") + ] + )) + #expect(rejectedMessageRef.isError == true) + + let rejectedOfferRef = try await worker.handleTool(.init( + name: "subscriptions_create_retention_offer", + arguments: [ + "subscription_id": .string("sub-1"), + "reference_name": .string("キャンペーン🔥"), + "offer_id": .string("YOSHINO1"), + "offer_mode": .string("PAY_AS_YOU_GO"), + "duration": .string("ONE_MONTH"), + "period_count": .int(1), + "eligibility_duration_months": .int(6), + "price_point_ids": .array([.string("pp-usa-1")]), + "territory_ids": .array([.string("USA")]) + ] + )) + #expect(rejectedOfferRef.isError == true) + #expect(await transport.requestCount() == 0) + + // Plane 2 CJK Unified Ideographs Extension B (𠮷 U+20BB7, 𠮟 U+20B9F) accepted + let createdLoc = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message_localization", + arguments: [ + "version_id": .string("ver-1"), + "locale": .string("ja"), + "header": .string("𠮷野の便利な機能を継続"), + "body": .string("𠮟咤激励の機能も引き続きご利用いただけます。") + ] + )) + #expect(createdLoc.isError != true) + let locPayload = try object(try object(createdLoc.structuredContent)["localization"]) + #expect(locPayload["header"] == .string("𠮷野の便利な機能を継続")) + #expect(locPayload["body"] == .string("𠮟咤激励の機能も引き続きご利用いただけます。")) + + let updatedLoc = try await worker.handleTool(.init( + name: "subscriptions_update_retention_message_localization", + arguments: [ + "localization_id": .string("loc-ja-1"), + "header": .string("𠮷野の便利な機能を継続"), + "body": .string("𠮟咤激励の機能も引き続きご利用いただけます。") + ] + )) + #expect(updatedLoc.isError != true) + + let createdMessage = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message", + arguments: [ + "app_id": .string("app-1"), + "reference_name": .string("𠮷野キャンペーン") + ] + )) + #expect(createdMessage.isError != true) + + let createdOffer = try await worker.handleTool(.init( + name: "subscriptions_create_retention_offer", + arguments: [ + "subscription_id": .string("sub-1"), + "reference_name": .string("𠮷野キャンペーン"), + "offer_id": .string("YOSHINO1"), + "offer_mode": .string("PAY_AS_YOU_GO"), + "duration": .string("ONE_MONTH"), + "period_count": .int(1), + "eligibility_duration_months": .int(6), + "price_point_ids": .array([.string("pp-usa-1")]), + "territory_ids": .array([.string("USA")]) + ] + )) + #expect(createdOffer.isError != true) + #expect(await transport.requestCount() == 4) + } } private func makeSubscriptionsWorker(transport: TestHTTPTransport) async throws -> SubscriptionsWorker { From 96abcfefc39eff00de55522edb499a2bd36dabd0 Mon Sep 17 00:00:00 2001 From: Aleksei Zelentsov Date: Sat, 7 Nov 2026 18:08:51 +0300 Subject: [PATCH 6/7] Fix retention offer prices continuation query and compound emoji validation --- .../Helpers/ASCMetadataValidator.swift | 4 +- ...ubscriptionsWorker+RetentionHandlers.swift | 10 +- .../Helpers/ASCMetadataValidatorTests.swift | 7 ++ .../RetentionMessagingContractTests.swift | 92 ++++++++++++++----- 4 files changed, 87 insertions(+), 26 deletions(-) diff --git a/Sources/asc-mcp/Helpers/ASCMetadataValidator.swift b/Sources/asc-mcp/Helpers/ASCMetadataValidator.swift index 6081a5a..de08375 100644 --- a/Sources/asc-mcp/Helpers/ASCMetadataValidator.swift +++ b/Sources/asc-mcp/Helpers/ASCMetadataValidator.swift @@ -53,7 +53,9 @@ enum ASCMetadataValidator { static func containsEmoji(_ value: String) -> Bool { value.unicodeScalars.contains { scalar in scalar.properties.isEmojiPresentation || - (scalar.properties.isEmoji && scalar.value > 0x238C) + (scalar.properties.isEmoji && scalar.value > 0x238C) || + scalar.value == 0xFE0F || + scalar.value == 0x20E3 } } diff --git a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift index c5f78f7..8537cab 100644 --- a/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift +++ b/Sources/asc-mcp/Workers/SubscriptionsWorker/SubscriptionsWorker+RetentionHandlers.swift @@ -940,9 +940,13 @@ extension SubscriptionsWorker { let response: ASCRetentionOfferPricesResponse if let nextURL = pagination.nextURL { - response = try await httpClient.getPage( - nextURL, - scope: pagination.scope, + let page = try httpClient.validatedScopedLink(nextURL, scope: pagination.scope) + let effectiveParameters = page.parameters.merging(Self.retentionOfferPricesQueryParameters) { _, canonical in + canonical + } + response = try await httpClient.get( + page.path, + parameters: effectiveParameters, as: ASCRetentionOfferPricesResponse.self ) } else { diff --git a/Tests/ASCMCPTests/Helpers/ASCMetadataValidatorTests.swift b/Tests/ASCMCPTests/Helpers/ASCMetadataValidatorTests.swift index 425144a..0cb37b7 100644 --- a/Tests/ASCMCPTests/Helpers/ASCMetadataValidatorTests.swift +++ b/Tests/ASCMCPTests/Helpers/ASCMetadataValidatorTests.swift @@ -7,6 +7,13 @@ struct ASCMetadataValidatorTests { func rejectsEmoji() { let errors = ASCMetadataValidator.validateTextFields(["description": "Hello 👋"]) #expect(errors.contains { $0.field == "description" }) + + for emoji in ["1️⃣", "#️⃣", "*️⃣", "1⃣", "©️", "®️", "™️", "ℹ️", "🎉", "🔥", "❤️", "☀️", "🇺🇸"] { + #expect(ASCMetadataValidator.containsEmoji(emoji), "Expected '\(emoji)' to be detected as emoji") + } + for plain in ["1", "#", "*", "©", "®", "™", "𠮷", "𠮟", "𠮷野の便利な機能を継続"] { + #expect(!ASCMetadataValidator.containsEmoji(plain), "Expected '\(plain)' not to be detected as emoji") + } } @Test("rejects over-limit text") diff --git a/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift b/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift index 9f3b1aa..60b3f54 100644 --- a/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift +++ b/Tests/ASCMCPTests/Workers/RetentionMessagingContractTests.swift @@ -688,7 +688,7 @@ struct RetentionMessagingContractTests { let subscriptionsDoc = #"{"data":[{"type":"subscriptions","id":"sub-2","attributes":{"name":"Pro Annual","productId":"com.example.annual","state":"APPROVED","subscriptionPeriod":"ONE_YEAR"}}],"links":{"self":"https://api.example.test/v1/retentionMessages/msg-1/subscriptions?cursor=page-2"}}"# let offersDoc = #"{"data":[{"type":"retentionOffers","id":"ro-2","attributes":{"referenceName":"Page 2 Offer","offerId":"OFFER2","duration":"ONE_MONTH","offerMode":"PAY_AS_YOU_GO","periodCount":1,"customerEligibilityPaidSubscriptionDurationInMonths":6}}],"links":{"self":"https://api.example.test/v1/subscriptions/sub-1/retentionOffers?cursor=page-2"}}"# let messageOffersDoc = #"{"data":[{"type":"retentionOffers","id":"ro-3","attributes":{"referenceName":"Page 2 Message Offer","offerId":"MSGOFFER2","duration":"ONE_MONTH","offerMode":"PAY_AS_YOU_GO","periodCount":1,"customerEligibilityPaidSubscriptionDurationInMonths":6}}],"links":{"self":"https://api.example.test/v1/subscriptions/sub-1/retentionMessageOffers?cursor=page-2"}}"# - let pricesDoc = #"{"data":[{"type":"retentionOfferPrices","id":"rop-2","relationships":{"territory":{"data":{"type":"territories","id":"USA"}},"subscriptionPricePoint":{"data":{"type":"subscriptionPricePoints","id":"pp-usa-2"}}}}],"included":[{"type":"subscriptionPricePoints","id":"pp-usa-2","attributes":{"customerPrice":"2.99","proceeds":"2.10","proceedsYear2":"2.54"}},{"type":"territories","id":"USA","attributes":{"currency":"USD"}}],"links":{"self":"https://api.example.test/v1/retentionOffers/ro-1/prices?cursor=page-2"}}"# + let pricesDoc = #"{"data":[{"type":"retentionOfferPrices","id":"rop-2","relationships":{"territory":{"data":{"type":"territories","id":"USA"}},"subscriptionPricePoint":{"data":{"type":"subscriptionPricePoints","id":"pp-usa-2"}}}}],"included":[{"type":"subscriptionPricePoints","id":"pp-usa-2","attributes":{"customerPrice":"4.99","proceeds":"3.49","proceedsYear2":"4.24"}},{"type":"territories","id":"USA","attributes":{"currency":"USD"}}],"links":{"self":"https://api.example.test/v1/retentionOffers/ro-1/prices?cursor=page-2"}}"# // 1. Negative checks before any HTTP I/O let negativeTransport = TestHTTPTransport(responses: []) @@ -904,13 +904,36 @@ struct RetentionMessagingContractTests { #expect(result.isError != true, "Case \(index) (\(toolName)) failed: \(result.content)") let payload = try object(result.structuredContent) #expect(payload["count"] == .int(1)) + if toolName == "subscriptions_list_retention_offer_prices" { + guard case .array(let prices) = payload["prices"], + let firstPriceValue = prices.first else { + Issue.record("Expected non-empty prices array for case \(index)") + continue + } + let priceItem = try object(firstPriceValue) + #expect(priceItem["customerPrice"] == .string("4.99")) + #expect(priceItem["customer_price"] == .string("4.99")) + #expect(priceItem["proceeds"] == .string("3.49")) + #expect(priceItem["proceedsYear2"] == .string("4.24")) + #expect(priceItem["proceeds_year2"] == .string("4.24")) + #expect(priceItem["currency"] == .string("USD")) + } } let requests = await transport.recordedRequests() #expect(requests.count == 15) - for (index, (_, _, expectedPath)) in positiveCases.enumerated() { - #expect(requests[index].url?.path == expectedPath) - #expect(requests[index].url?.query?.contains("cursor=page-2") == true) + for (index, (toolName, _, expectedPath)) in positiveCases.enumerated() { + let requestURL = try #require(requests[index].url) + #expect(requestURL.path == expectedPath) + let queryItems = URLComponents(url: requestURL, resolvingAgainstBaseURL: false)?.queryItems ?? [] + let queryDict = Dictionary(uniqueKeysWithValues: queryItems.map { ($0.name, $0.value ?? "") }) + #expect(queryDict["cursor"] == "page-2") + if toolName == "subscriptions_list_retention_offer_prices" { + #expect(queryDict["include"] == "territory,subscriptionPricePoint") + #expect(queryDict["fields[retentionOfferPrices]"] == "territory,subscriptionPricePoint") + #expect(queryDict["fields[subscriptionPricePoints]"] == "customerPrice,proceeds,proceedsYear2,territory") + #expect(queryDict["fields[territories]"] == "currency") + } } } @@ -925,7 +948,7 @@ struct RetentionMessagingContractTests { ), .init( statusCode: 200, - body: #"{"data":{"type":"retentionMessageLocalizations","id":"loc-ja-1","attributes":{"locale":"ja","header":"𠮷野の便利な機能を継続","body":"𠮟咤激励の機能も引き続きご利用いただけます。"}}}"# + body: #"{"data":{"type":"retentionMessageLocalizations","id":"loc-ja-1","attributes":{"locale":"ja","header":"𠮷野の便利な機能を継続 1 © ® ™","body":"𠮟咤激励の機能も引き続きご利用いただけます。"}}}"# ), .init( statusCode: 201, @@ -938,34 +961,59 @@ struct RetentionMessagingContractTests { ]) let worker = try await makeSubscriptionsWorker(transport: transport) - // Real emojis rejected before network access - for emojiHeader in ["キャンペーン🎉", "特典🔥", "継続✨", "限定❤️", "夏休み☀️"] { - let rejected = try await worker.handleTool(.init( + // Real and compound emojis (including keycaps and VS-16 sequences) rejected before network access + let emojiSamples = [ + "キャンペーン🎉", + "特典🔥", + "継続✨", + "限定❤️", + "夏休み☀️", + "ステップ1️⃣", + "番号#️⃣", + "記号*️⃣", + "キー1⃣", + "著作権©️", + "登録商標®️", + "商標™️", + "案内ℹ️", + "米国🇺🇸" + ] + for emojiSample in emojiSamples { + let rejectedHeader = try await worker.handleTool(.init( name: "subscriptions_create_retention_message_localization", arguments: [ "version_id": .string("ver-1"), "locale": .string("ja"), - "header": .string(emojiHeader), + "header": .string(emojiSample), "body": .string("引き続きご利用いただけます。") ] )) - #expect(rejected.isError == true, "Expected emoji header '\(emojiHeader)' to be rejected") - } + #expect(rejectedHeader.isError == true, "Expected emoji header '\(emojiSample)' to be rejected") - let rejectedMessageRef = try await worker.handleTool(.init( - name: "subscriptions_create_retention_message", - arguments: [ - "app_id": .string("app-1"), - "reference_name": .string("キャンペーン🔥") - ] - )) - #expect(rejectedMessageRef.isError == true) + let rejectedBody = try await worker.handleTool(.init( + name: "subscriptions_update_retention_message_localization", + arguments: [ + "localization_id": .string("loc-ja-1"), + "body": .string("引き続きご利用いただけます。\(emojiSample)") + ] + )) + #expect(rejectedBody.isError == true, "Expected emoji body '\(emojiSample)' to be rejected") + + let rejectedRef = try await worker.handleTool(.init( + name: "subscriptions_create_retention_message", + arguments: [ + "app_id": .string("app-1"), + "reference_name": .string(emojiSample) + ] + )) + #expect(rejectedRef.isError == true, "Expected emoji reference_name '\(emojiSample)' to be rejected") + } let rejectedOfferRef = try await worker.handleTool(.init( name: "subscriptions_create_retention_offer", arguments: [ "subscription_id": .string("sub-1"), - "reference_name": .string("キャンペーン🔥"), + "reference_name": .string("キャンペーン1️⃣"), "offer_id": .string("YOSHINO1"), "offer_mode": .string("PAY_AS_YOU_GO"), "duration": .string("ONE_MONTH"), @@ -978,7 +1026,7 @@ struct RetentionMessagingContractTests { #expect(rejectedOfferRef.isError == true) #expect(await transport.requestCount() == 0) - // Plane 2 CJK Unified Ideographs Extension B (𠮷 U+20BB7, 𠮟 U+20B9F) accepted + // Plane 2 CJK Unified Ideographs Extension B (𠮷 U+20BB7, 𠮟 U+20B9F) and plain ASCII/BMP text symbols accepted let createdLoc = try await worker.handleTool(.init( name: "subscriptions_create_retention_message_localization", arguments: [ @@ -997,7 +1045,7 @@ struct RetentionMessagingContractTests { name: "subscriptions_update_retention_message_localization", arguments: [ "localization_id": .string("loc-ja-1"), - "header": .string("𠮷野の便利な機能を継続"), + "header": .string("𠮷野の便利な機能を継続 1 © ® ™"), "body": .string("𠮟咤激励の機能も引き続きご利用いただけます。") ] )) From 9800016bb6eb00dea3466e25de905a84e7d0cdd5 Mon Sep 17 00:00:00 2001 From: Aleksei Zelentsov Date: Sat, 7 Nov 2026 20:43:55 +0300 Subject: [PATCH 7/7] chore: prepare release 4.3.0 --- .github/workflows/scripts/assets_mcp_smoke.py | 2 +- CHANGELOG.md | 14 +++++++++++++- README.md | 8 ++++---- Sources/asc-mcp/Core/ServerVersion.swift | 2 +- 4 files changed, 19 insertions(+), 7 deletions(-) diff --git a/.github/workflows/scripts/assets_mcp_smoke.py b/.github/workflows/scripts/assets_mcp_smoke.py index 40b894b..5bf0f29 100644 --- a/.github/workflows/scripts/assets_mcp_smoke.py +++ b/.github/workflows/scripts/assets_mcp_smoke.py @@ -642,7 +642,7 @@ def start(workers: str = "assets,review_submissions", read_only: bool = False) - def main() -> int: parser = argparse.ArgumentParser(description=__doc__) parser.add_argument("--binary", required=True, help="Previously built candidate asc-mcp executable") - parser.add_argument("--expected-version", default="4.2.0") + parser.add_argument("--expected-version", default="4.3.0") arguments = parser.parse_args() try: report = run(arguments) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c08477..0048515 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,13 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [4.3.0] - 2026-11-07 + ### Added - Add 23 subscription retention messaging tools in `SubscriptionsWorker` (`subscriptions_*`) covering App Store Connect API 4.6 retention messages (`list`, `get`, `create`, `delete`), versions (`list`, `get`, `create`), localizations (`list`, `get`, `create`, `update`, `delete`) with Apple header/body/emoji/price-mention preflight validation, retention offers (`list`, `get`, `create`, `update`, `delete`, `list_retention_offer_prices`), and subscription retention relationships (`list_retention_message_subscriptions`, `get_retention_message_for_subscription`, `set_retention_message`, `add_retention_message_offers`, `remove_retention_message_offers`). -- Extend `AssetsWorker` (`assets_*`) to support `retentionMessageVersion` (`feature = "RETENTION_MESSAGING"`) image placements via Apple's to-one `/v1/retentionMessageVersions/{id}/placement` endpoint, with app-scoped ownership verification and explicit rejection of video placements and multi-placement reordering. +- Extend `AssetsWorker` (`assets_*`) to support `retentionMessageVersion` (`feature = "RETENTION_MESSAGING"`) image placements via Apple's to-one `/v1/retentionMessageVersions/{id}/placement` endpoint, with multi-page app-scoped ownership verification and explicit rejection of video placements and multi-placement reordering. - Extend `ReviewSubmissionsWorker` (`review_submissions_*`) to support `retention_message_version_id` (`retentionMessageVersion` / `retentionMessageVersions`) in review submission item assembly and reads. - Pin the official Apple 4.6 OpenAPI specification (`1,027` paths, `1,337` operations) and update the operation manifest (`537` public tools, `528` mapped operations, `440` waived, `369` scope-rule out of scope, `4,562` classified optional inputs with `0` unclassified). +### Fixed + +- Preserve `include=territory,subscriptionPricePoint` and related `fields[...]` projections across initial and continuation requests in `subscriptions_list_retention_offer_prices`, and bind all 6 retention list handlers to `HTTPClient.getPage` with `PaginationScope` validation. +- Allow Plane 2 CJK Unified Ideographs Extension B+ characters (such as `𠮷` `U+20BB7`) in metadata and retention copy validation while rejecting single and compound emoji sequences (`U+FE0F`, `U+20E3`). +- Route `JWTService` debug token diagnostics to `stderr` so debug builds preserve a clean JSON-RPC `stdout` stream. + +### Compatibility + +- Preserve all 514 existing tool names and 36 `--workers` filter keys; the complete catalog now has 537 tools. + ## [4.2.0] - 2026-10-19 ### Added diff --git a/README.md b/README.md index 8feb906..da1df7b 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ New here? Follow the [Quick Start](#quick-start). The remaining sections are ref - **Safer automation** — read-only mode, confirmation safeguards, strict pagination, and mutation recovery guidance - **Auditable API coverage** — a versioned Apple OpenAPI contract and release-time drift checks -The source tree prepares **4.2.0**; the installation examples below remain pinned to the last stable release until candidate acceptance and owner publication. See the [migration guide](docs/migrations/4.2.0-asset-library.md) for the separate Asset Library workflow. +The source tree prepares **4.3.0**; the installation examples below remain pinned to the last stable release until candidate acceptance and owner publication. See the [migration guide](docs/migrations/4.2.0-asset-library.md) for the separate Asset Library workflow. ## Platform Support @@ -60,7 +60,7 @@ The recommended setup stores App Store Connect credentials once in a private loc ```bash brew install mint -mint install zelentsov-dev/asc-mcp@v4.2.0 +mint install zelentsov-dev/asc-mcp@v4.3.0 ~/.mint/bin/asc-mcp --version ``` @@ -151,13 +151,13 @@ If the connection or request fails, see [Troubleshooting](#troubleshooting). ```bash brew install mint -mint install zelentsov-dev/asc-mcp@v4.2.0 +mint install zelentsov-dev/asc-mcp@v4.3.0 ``` Update or reinstall the pinned release: ```bash -mint install zelentsov-dev/asc-mcp@v4.2.0 --force +mint install zelentsov-dev/asc-mcp@v4.3.0 --force ``` Stable users should install a version tag. Installing `main` or `develop` is intended only for maintainers and pre-release testing. diff --git a/Sources/asc-mcp/Core/ServerVersion.swift b/Sources/asc-mcp/Core/ServerVersion.swift index 83ff754..8e8c524 100644 --- a/Sources/asc-mcp/Core/ServerVersion.swift +++ b/Sources/asc-mcp/Core/ServerVersion.swift @@ -1,5 +1,5 @@ import Foundation enum ServerVersion { - static let current = "4.2.0" + static let current = "4.3.0" }