apple.appstore
Module apple.appstore
API
Definitions
ballerinax/apple.appstore Ballerina library
Overview
This is a generated connector for Apple appstore API v1.4.1 OpenAPI Specification.
The App Store Connect API is a REST API that enables the automation of actions you take in App Store Connect.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create App Store Connect account
- Obtain tokens
- Follow this link to obtain tokens
Clients![](/images/permalink.svg)
apple.appstore: Client![](/images/permalink.svg)
This is a generated connector for App Store Connect API v1.4.1 OpenAPI Specification. The App Store Connect API enables the automation of actions you take in App Store Connect.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a App Store Connect account and obtain tokens following this guide.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.appstoreconnect.apple.com/" - URL of the target service
ageratingdeclarationsUpdateInstance![](/images/permalink.svg)
function ageratingdeclarationsUpdateInstance(string id, AgeRatingDeclarationUpdateRequest payload) returns AgeRatingDeclarationResponse|error
Parameters
- id string - the id of the requested resource
- payload AgeRatingDeclarationUpdateRequest - AgeRatingDeclaration representation
Return Type
- AgeRatingDeclarationResponse|error - Single AgeRatingDeclaration
appcategoriesGetCollection![](/images/permalink.svg)
function appcategoriesGetCollection(string[]? filterPlatforms, string[]? existsParent, string[]? fieldsAppcategories, int? 'limit, string[]? include, int? limitSubcategories) returns AppCategoriesResponse|error
Parameters
- filterPlatforms string[]? (default ()) - filter by attribute 'platforms'
- existsParent string[]? (default ()) - filter by existence or non-existence of related 'parent'
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- limitSubcategories int? (default ()) - maximum number of related subcategories returned (when they are included)
Return Type
- AppCategoriesResponse|error - List of AppCategories
appcategoriesGetInstance![](/images/permalink.svg)
function appcategoriesGetInstance(string id, string[]? fieldsAppcategories, string[]? include, int? limitSubcategories) returns AppCategoryResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
- include string[]? (default ()) - comma-separated list of relationships to include
- limitSubcategories int? (default ()) - maximum number of related subcategories returned (when they are included)
Return Type
- AppCategoryResponse|error - Single AppCategory
appencryptiondeclarationsGetCollection![](/images/permalink.svg)
function appencryptiondeclarationsGetCollection(string[]? filterPlatform, string[]? filterApp, string[]? filterBuilds, string[]? fieldsAppencryptiondeclarations, int? 'limit, string[]? include, string[]? fieldsApps) returns AppEncryptionDeclarationsResponse|error
Parameters
- filterPlatform string[]? (default ()) - filter by attribute 'platform'
- filterApp string[]? (default ()) - filter by id(s) of related 'app'
- filterBuilds string[]? (default ()) - filter by id(s) of related 'builds'
- fieldsAppencryptiondeclarations string[]? (default ()) - the fields to include for returned resources of type appEncryptionDeclarations
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- AppEncryptionDeclarationsResponse|error - List of AppEncryptionDeclarations
appencryptiondeclarationsGetInstance![](/images/permalink.svg)
function appencryptiondeclarationsGetInstance(string id, string[]? fieldsAppencryptiondeclarations, string[]? include, string[]? fieldsApps) returns AppEncryptionDeclarationResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppencryptiondeclarations string[]? (default ()) - the fields to include for returned resources of type appEncryptionDeclarations
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- AppEncryptionDeclarationResponse|error - Single AppEncryptionDeclaration
appinfolocalizationsCreateInstance![](/images/permalink.svg)
function appinfolocalizationsCreateInstance(AppInfoLocalizationCreateRequest payload) returns AppInfoLocalizationResponse|error
Parameters
- payload AppInfoLocalizationCreateRequest - AppInfoLocalization representation
Return Type
- AppInfoLocalizationResponse|error - Single AppInfoLocalization
appinfolocalizationsGetInstance![](/images/permalink.svg)
function appinfolocalizationsGetInstance(string id, string[]? fieldsAppinfolocalizations, string[]? include) returns AppInfoLocalizationResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppinfolocalizations string[]? (default ()) - the fields to include for returned resources of type appInfoLocalizations
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppInfoLocalizationResponse|error - Single AppInfoLocalization
appinfolocalizationsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
appinfolocalizationsUpdateInstance![](/images/permalink.svg)
function appinfolocalizationsUpdateInstance(string id, AppInfoLocalizationUpdateRequest payload) returns AppInfoLocalizationResponse|error
Parameters
- id string - the id of the requested resource
- payload AppInfoLocalizationUpdateRequest - AppInfoLocalization representation
Return Type
- AppInfoLocalizationResponse|error - Single AppInfoLocalization
appinfosGetInstance![](/images/permalink.svg)
function appinfosGetInstance(string id, string[]? fieldsAppinfos, string[]? include, string[]? fieldsAgeratingdeclarations, string[]? fieldsAppcategories, string[]? fieldsAppinfolocalizations, int? limitAppinfolocalizations) returns AppInfoResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppinfos string[]? (default ()) - the fields to include for returned resources of type appInfos
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsAgeratingdeclarations string[]? (default ()) - the fields to include for returned resources of type ageRatingDeclarations
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
- fieldsAppinfolocalizations string[]? (default ()) - the fields to include for returned resources of type appInfoLocalizations
- limitAppinfolocalizations int? (default ()) - maximum number of related appInfoLocalizations returned (when they are included)
Return Type
- AppInfoResponse|error - Single AppInfo
appinfosUpdateInstance![](/images/permalink.svg)
function appinfosUpdateInstance(string id, AppInfoUpdateRequest payload) returns AppInfoResponse|error
Parameters
- id string - the id of the requested resource
- payload AppInfoUpdateRequest - AppInfo representation
Return Type
- AppInfoResponse|error - Single AppInfo
apppreordersCreateInstance![](/images/permalink.svg)
function apppreordersCreateInstance(AppPreOrderCreateRequest payload) returns AppPreOrderResponse|error
Parameters
- payload AppPreOrderCreateRequest - AppPreOrder representation
Return Type
- AppPreOrderResponse|error - Single AppPreOrder
apppreordersGetInstance![](/images/permalink.svg)
function apppreordersGetInstance(string id, string[]? fieldsApppreorders, string[]? include) returns AppPreOrderResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApppreorders string[]? (default ()) - the fields to include for returned resources of type appPreOrders
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppPreOrderResponse|error - Single AppPreOrder
apppreordersDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
apppreordersUpdateInstance![](/images/permalink.svg)
function apppreordersUpdateInstance(string id, AppPreOrderUpdateRequest payload) returns AppPreOrderResponse|error
Parameters
- id string - the id of the requested resource
- payload AppPreOrderUpdateRequest - AppPreOrder representation
Return Type
- AppPreOrderResponse|error - Single AppPreOrder
apppreviewsetsCreateInstance![](/images/permalink.svg)
function apppreviewsetsCreateInstance(AppPreviewSetCreateRequest payload) returns AppPreviewSetResponse|error
Parameters
- payload AppPreviewSetCreateRequest - AppPreviewSet representation
Return Type
- AppPreviewSetResponse|error - Single AppPreviewSet
apppreviewsetsGetInstance![](/images/permalink.svg)
function apppreviewsetsGetInstance(string id, string[]? fieldsApppreviewsets, string[]? include, string[]? fieldsApppreviews, int? limitApppreviews) returns AppPreviewSetResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApppreviewsets string[]? (default ()) - the fields to include for returned resources of type appPreviewSets
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApppreviews string[]? (default ()) - the fields to include for returned resources of type appPreviews
- limitApppreviews int? (default ()) - maximum number of related appPreviews returned (when they are included)
Return Type
- AppPreviewSetResponse|error - Single AppPreviewSet
apppreviewsetsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
apppreviewsCreateInstance![](/images/permalink.svg)
function apppreviewsCreateInstance(AppPreviewCreateRequest payload) returns AppPreviewResponse|error
Parameters
- payload AppPreviewCreateRequest - AppPreview representation
Return Type
- AppPreviewResponse|error - Single AppPreview
apppreviewsGetInstance![](/images/permalink.svg)
function apppreviewsGetInstance(string id, string[]? fieldsApppreviews, string[]? include) returns AppPreviewResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApppreviews string[]? (default ()) - the fields to include for returned resources of type appPreviews
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppPreviewResponse|error - Single AppPreview
apppreviewsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
apppreviewsUpdateInstance![](/images/permalink.svg)
function apppreviewsUpdateInstance(string id, AppPreviewUpdateRequest payload) returns AppPreviewResponse|error
Parameters
- id string - the id of the requested resource
- payload AppPreviewUpdateRequest - AppPreview representation
Return Type
- AppPreviewResponse|error - Single AppPreview
apppricepointsGetCollection![](/images/permalink.svg)
function apppricepointsGetCollection(string[]? filterPricetier, string[]? filterTerritory, string[]? fieldsApppricepoints, int? 'limit, string[]? include, string[]? fieldsTerritories) returns AppPricePointsResponse|error
Parameters
- filterPricetier string[]? (default ()) - filter by id(s) of related 'priceTier'
- filterTerritory string[]? (default ()) - filter by id(s) of related 'territory'
- fieldsApppricepoints string[]? (default ()) - the fields to include for returned resources of type appPricePoints
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsTerritories string[]? (default ()) - the fields to include for returned resources of type territories
Return Type
- AppPricePointsResponse|error - List of AppPricePoints
apppricepointsGetInstance![](/images/permalink.svg)
function apppricepointsGetInstance(string id, string[]? fieldsApppricepoints, string[]? include, string[]? fieldsTerritories) returns AppPricePointResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApppricepoints string[]? (default ()) - the fields to include for returned resources of type appPricePoints
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsTerritories string[]? (default ()) - the fields to include for returned resources of type territories
Return Type
- AppPricePointResponse|error - Single AppPricePoint
apppricetiersGetCollection![](/images/permalink.svg)
function apppricetiersGetCollection(string[]? filterId, string[]? fieldsApppricetiers, int? 'limit, string[]? include, string[]? fieldsApppricepoints, int? limitPricepoints) returns AppPriceTiersResponse|error
Parameters
- filterId string[]? (default ()) - filter by id(s)
- fieldsApppricetiers string[]? (default ()) - the fields to include for returned resources of type appPriceTiers
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApppricepoints string[]? (default ()) - the fields to include for returned resources of type appPricePoints
- limitPricepoints int? (default ()) - maximum number of related pricePoints returned (when they are included)
Return Type
- AppPriceTiersResponse|error - List of AppPriceTiers
apppricetiersGetInstance![](/images/permalink.svg)
function apppricetiersGetInstance(string id, string[]? fieldsApppricetiers, string[]? include, string[]? fieldsApppricepoints, int? limitPricepoints) returns AppPriceTierResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApppricetiers string[]? (default ()) - the fields to include for returned resources of type appPriceTiers
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApppricepoints string[]? (default ()) - the fields to include for returned resources of type appPricePoints
- limitPricepoints int? (default ()) - maximum number of related pricePoints returned (when they are included)
Return Type
- AppPriceTierResponse|error - Single AppPriceTier
apppricesGetInstance![](/images/permalink.svg)
function apppricesGetInstance(string id, string[]? fieldsAppprices, string[]? include) returns AppPriceResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppprices string[]? (default ()) - the fields to include for returned resources of type appPrices
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppPriceResponse|error - Single AppPrice
appscreenshotsetsCreateInstance![](/images/permalink.svg)
function appscreenshotsetsCreateInstance(AppScreenshotSetCreateRequest payload) returns AppScreenshotSetResponse|error
Parameters
- payload AppScreenshotSetCreateRequest - AppScreenshotSet representation
Return Type
- AppScreenshotSetResponse|error - Single AppScreenshotSet
appscreenshotsetsGetInstance![](/images/permalink.svg)
function appscreenshotsetsGetInstance(string id, string[]? fieldsAppscreenshotsets, string[]? include, string[]? fieldsAppscreenshots, int? limitAppscreenshots) returns AppScreenshotSetResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppscreenshotsets string[]? (default ()) - the fields to include for returned resources of type appScreenshotSets
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsAppscreenshots string[]? (default ()) - the fields to include for returned resources of type appScreenshots
- limitAppscreenshots int? (default ()) - maximum number of related appScreenshots returned (when they are included)
Return Type
- AppScreenshotSetResponse|error - Single AppScreenshotSet
appscreenshotsetsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
appscreenshotsCreateInstance![](/images/permalink.svg)
function appscreenshotsCreateInstance(AppScreenshotCreateRequest payload) returns AppScreenshotResponse|error
Parameters
- payload AppScreenshotCreateRequest - AppScreenshot representation
Return Type
- AppScreenshotResponse|error - Single AppScreenshot
appscreenshotsGetInstance![](/images/permalink.svg)
function appscreenshotsGetInstance(string id, string[]? fieldsAppscreenshots, string[]? include) returns AppScreenshotResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppscreenshots string[]? (default ()) - the fields to include for returned resources of type appScreenshots
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppScreenshotResponse|error - Single AppScreenshot
appscreenshotsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
appscreenshotsUpdateInstance![](/images/permalink.svg)
function appscreenshotsUpdateInstance(string id, AppScreenshotUpdateRequest payload) returns AppScreenshotResponse|error
Parameters
- id string - the id of the requested resource
- payload AppScreenshotUpdateRequest - AppScreenshot representation
Return Type
- AppScreenshotResponse|error - Single AppScreenshot
appstorereviewattachmentsCreateInstance![](/images/permalink.svg)
function appstorereviewattachmentsCreateInstance(AppStoreReviewAttachmentCreateRequest payload) returns AppStoreReviewAttachmentResponse|error
Parameters
- payload AppStoreReviewAttachmentCreateRequest - AppStoreReviewAttachment representation
Return Type
- AppStoreReviewAttachmentResponse|error - Single AppStoreReviewAttachment
appstorereviewattachmentsGetInstance![](/images/permalink.svg)
function appstorereviewattachmentsGetInstance(string id, string[]? fieldsAppstorereviewattachments, string[]? include) returns AppStoreReviewAttachmentResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppstorereviewattachments string[]? (default ()) - the fields to include for returned resources of type appStoreReviewAttachments
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppStoreReviewAttachmentResponse|error - Single AppStoreReviewAttachment
appstorereviewattachmentsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
appstorereviewattachmentsUpdateInstance![](/images/permalink.svg)
function appstorereviewattachmentsUpdateInstance(string id, AppStoreReviewAttachmentUpdateRequest payload) returns AppStoreReviewAttachmentResponse|error
Parameters
- id string - the id of the requested resource
- payload AppStoreReviewAttachmentUpdateRequest - AppStoreReviewAttachment representation
Return Type
- AppStoreReviewAttachmentResponse|error - Single AppStoreReviewAttachment
appstorereviewdetailsCreateInstance![](/images/permalink.svg)
function appstorereviewdetailsCreateInstance(AppStoreReviewDetailCreateRequest payload) returns AppStoreReviewDetailResponse|error
Parameters
- payload AppStoreReviewDetailCreateRequest - AppStoreReviewDetail representation
Return Type
- AppStoreReviewDetailResponse|error - Single AppStoreReviewDetail
appstorereviewdetailsGetInstance![](/images/permalink.svg)
function appstorereviewdetailsGetInstance(string id, string[]? fieldsAppstorereviewdetails, string[]? include, string[]? fieldsAppstorereviewattachments, int? limitAppstorereviewattachments) returns AppStoreReviewDetailResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppstorereviewdetails string[]? (default ()) - the fields to include for returned resources of type appStoreReviewDetails
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsAppstorereviewattachments string[]? (default ()) - the fields to include for returned resources of type appStoreReviewAttachments
- limitAppstorereviewattachments int? (default ()) - maximum number of related appStoreReviewAttachments returned (when they are included)
Return Type
- AppStoreReviewDetailResponse|error - Single AppStoreReviewDetail
appstorereviewdetailsUpdateInstance![](/images/permalink.svg)
function appstorereviewdetailsUpdateInstance(string id, AppStoreReviewDetailUpdateRequest payload) returns AppStoreReviewDetailResponse|error
Parameters
- id string - the id of the requested resource
- payload AppStoreReviewDetailUpdateRequest - AppStoreReviewDetail representation
Return Type
- AppStoreReviewDetailResponse|error - Single AppStoreReviewDetail
appstoreversionlocalizationsCreateInstance![](/images/permalink.svg)
function appstoreversionlocalizationsCreateInstance(AppStoreVersionLocalizationCreateRequest payload) returns AppStoreVersionLocalizationResponse|error
Parameters
- payload AppStoreVersionLocalizationCreateRequest - AppStoreVersionLocalization representation
Return Type
- AppStoreVersionLocalizationResponse|error - Single AppStoreVersionLocalization
appstoreversionlocalizationsGetInstance![](/images/permalink.svg)
function appstoreversionlocalizationsGetInstance(string id, string[]? fieldsAppstoreversionlocalizations, string[]? include, string[]? fieldsAppscreenshotsets, string[]? fieldsApppreviewsets, int? limitApppreviewsets, int? limitAppscreenshotsets) returns AppStoreVersionLocalizationResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppstoreversionlocalizations string[]? (default ()) - the fields to include for returned resources of type appStoreVersionLocalizations
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsAppscreenshotsets string[]? (default ()) - the fields to include for returned resources of type appScreenshotSets
- fieldsApppreviewsets string[]? (default ()) - the fields to include for returned resources of type appPreviewSets
- limitApppreviewsets int? (default ()) - maximum number of related appPreviewSets returned (when they are included)
- limitAppscreenshotsets int? (default ()) - maximum number of related appScreenshotSets returned (when they are included)
Return Type
- AppStoreVersionLocalizationResponse|error - Single AppStoreVersionLocalization
appstoreversionlocalizationsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
appstoreversionlocalizationsUpdateInstance![](/images/permalink.svg)
function appstoreversionlocalizationsUpdateInstance(string id, AppStoreVersionLocalizationUpdateRequest payload) returns AppStoreVersionLocalizationResponse|error
Parameters
- id string - the id of the requested resource
- payload AppStoreVersionLocalizationUpdateRequest - AppStoreVersionLocalization representation
Return Type
- AppStoreVersionLocalizationResponse|error - Single AppStoreVersionLocalization
appstoreversionphasedreleasesCreateInstance![](/images/permalink.svg)
function appstoreversionphasedreleasesCreateInstance(AppStoreVersionPhasedReleaseCreateRequest payload) returns AppStoreVersionPhasedReleaseResponse|error
Parameters
- payload AppStoreVersionPhasedReleaseCreateRequest - AppStoreVersionPhasedRelease representation
Return Type
- AppStoreVersionPhasedReleaseResponse|error - Single AppStoreVersionPhasedRelease
appstoreversionphasedreleasesDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
appstoreversionphasedreleasesUpdateInstance![](/images/permalink.svg)
function appstoreversionphasedreleasesUpdateInstance(string id, AppStoreVersionPhasedReleaseUpdateRequest payload) returns AppStoreVersionPhasedReleaseResponse|error
Parameters
- id string - the id of the requested resource
- payload AppStoreVersionPhasedReleaseUpdateRequest - AppStoreVersionPhasedRelease representation
Return Type
- AppStoreVersionPhasedReleaseResponse|error - Single AppStoreVersionPhasedRelease
appstoreversionsubmissionsCreateInstance![](/images/permalink.svg)
function appstoreversionsubmissionsCreateInstance(AppStoreVersionSubmissionCreateRequest payload) returns AppStoreVersionSubmissionResponse|error
Parameters
- payload AppStoreVersionSubmissionCreateRequest - AppStoreVersionSubmission representation
Return Type
- AppStoreVersionSubmissionResponse|error - Single AppStoreVersionSubmission
appstoreversionsubmissionsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
appstoreversionsCreateInstance![](/images/permalink.svg)
function appstoreversionsCreateInstance(AppStoreVersionCreateRequest payload) returns AppStoreVersionResponse|error
Parameters
- payload AppStoreVersionCreateRequest - AppStoreVersion representation
Return Type
- AppStoreVersionResponse|error - Single AppStoreVersion
appstoreversionsGetInstance![](/images/permalink.svg)
function appstoreversionsGetInstance(string id, string[]? fieldsAppstoreversions, string[]? include, string[]? fieldsAppstoreversionlocalizations, string[]? fieldsIdfadeclarations, string[]? fieldsRoutingappcoverages, string[]? fieldsAppstoreversionphasedreleases, string[]? fieldsAgeratingdeclarations, string[]? fieldsAppstorereviewdetails, string[]? fieldsBuilds, string[]? fieldsAppstoreversionsubmissions, int? limitAppstoreversionlocalizations) returns AppStoreVersionResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppstoreversions string[]? (default ()) - the fields to include for returned resources of type appStoreVersions
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsAppstoreversionlocalizations string[]? (default ()) - the fields to include for returned resources of type appStoreVersionLocalizations
- fieldsIdfadeclarations string[]? (default ()) - the fields to include for returned resources of type idfaDeclarations
- fieldsRoutingappcoverages string[]? (default ()) - the fields to include for returned resources of type routingAppCoverages
- fieldsAppstoreversionphasedreleases string[]? (default ()) - the fields to include for returned resources of type appStoreVersionPhasedReleases
- fieldsAgeratingdeclarations string[]? (default ()) - the fields to include for returned resources of type ageRatingDeclarations
- fieldsAppstorereviewdetails string[]? (default ()) - the fields to include for returned resources of type appStoreReviewDetails
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- fieldsAppstoreversionsubmissions string[]? (default ()) - the fields to include for returned resources of type appStoreVersionSubmissions
- limitAppstoreversionlocalizations int? (default ()) - maximum number of related appStoreVersionLocalizations returned (when they are included)
Deprecated parameters
Return Type
- AppStoreVersionResponse|error - Single AppStoreVersion
appstoreversionsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
appstoreversionsUpdateInstance![](/images/permalink.svg)
function appstoreversionsUpdateInstance(string id, AppStoreVersionUpdateRequest payload) returns AppStoreVersionResponse|error
Parameters
- id string - the id of the requested resource
- payload AppStoreVersionUpdateRequest - AppStoreVersion representation
Return Type
- AppStoreVersionResponse|error - Single AppStoreVersion
appsGetCollection![](/images/permalink.svg)
function appsGetCollection(string[]? filterAppstoreversionsAppstorestate, string[]? filterAppstoreversionsPlatform, string[]? filterBundleid, string[]? filterName, string[]? filterSku, string[]? filterAppstoreversions, string[]? filterId, string[]? existsGamecenterenabledversions, string[]? sort, string[]? fieldsApps, int? 'limit, string[]? include, string[]? fieldsBetagroups, string[]? fieldsPerfpowermetrics, string[]? fieldsAppinfos, string[]? fieldsApppreorders, string[]? fieldsPrereleaseversions, string[]? fieldsAppprices, string[]? fieldsInapppurchases, string[]? fieldsBetaappreviewdetails, string[]? fieldsTerritories, string[]? fieldsGamecenterenabledversions, string[]? fieldsAppstoreversions, string[]? fieldsBuilds, string[]? fieldsBetaapplocalizations, string[]? fieldsBetalicenseagreements, string[]? fieldsEnduserlicenseagreements, int? limitAppinfos, int? limitAppstoreversions, int? limitAvailableterritories, int? limitBetaapplocalizations, int? limitBetagroups, int? limitBuilds, int? limitGamecenterenabledversions, int? limitInapppurchases, int? limitPrereleaseversions, int? limitPrices) returns AppsResponse|error
Parameters
- filterAppstoreversionsAppstorestate string[]? (default ()) - filter by attribute 'appStoreVersions.appStoreState'
- filterAppstoreversionsPlatform string[]? (default ()) - filter by attribute 'appStoreVersions.platform'
- filterBundleid string[]? (default ()) - filter by attribute 'bundleId'
- filterName string[]? (default ()) - filter by attribute 'name'
- filterSku string[]? (default ()) - filter by attribute 'sku'
- filterAppstoreversions string[]? (default ()) - filter by id(s) of related 'appStoreVersions'
- filterId string[]? (default ()) - filter by id(s)
- existsGamecenterenabledversions string[]? (default ()) - filter by existence or non-existence of related 'gameCenterEnabledVersions'
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBetagroups string[]? (default ()) - the fields to include for returned resources of type betaGroups
- fieldsPerfpowermetrics string[]? (default ()) - the fields to include for returned resources of type perfPowerMetrics
- fieldsAppinfos string[]? (default ()) - the fields to include for returned resources of type appInfos
- fieldsApppreorders string[]? (default ()) - the fields to include for returned resources of type appPreOrders
- fieldsPrereleaseversions string[]? (default ()) - the fields to include for returned resources of type preReleaseVersions
- fieldsAppprices string[]? (default ()) - the fields to include for returned resources of type appPrices
- fieldsInapppurchases string[]? (default ()) - the fields to include for returned resources of type inAppPurchases
- fieldsBetaappreviewdetails string[]? (default ()) - the fields to include for returned resources of type betaAppReviewDetails
- fieldsTerritories string[]? (default ()) - the fields to include for returned resources of type territories
- fieldsGamecenterenabledversions string[]? (default ()) - the fields to include for returned resources of type gameCenterEnabledVersions
- fieldsAppstoreversions string[]? (default ()) - the fields to include for returned resources of type appStoreVersions
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- fieldsBetaapplocalizations string[]? (default ()) - the fields to include for returned resources of type betaAppLocalizations
- fieldsBetalicenseagreements string[]? (default ()) - the fields to include for returned resources of type betaLicenseAgreements
- fieldsEnduserlicenseagreements string[]? (default ()) - the fields to include for returned resources of type endUserLicenseAgreements
- limitAppinfos int? (default ()) - maximum number of related appInfos returned (when they are included)
- limitAppstoreversions int? (default ()) - maximum number of related appStoreVersions returned (when they are included)
- limitAvailableterritories int? (default ()) - maximum number of related availableTerritories returned (when they are included)
- limitBetaapplocalizations int? (default ()) - maximum number of related betaAppLocalizations returned (when they are included)
- limitBetagroups int? (default ()) - maximum number of related betaGroups returned (when they are included)
- limitBuilds int? (default ()) - maximum number of related builds returned (when they are included)
- limitGamecenterenabledversions int? (default ()) - maximum number of related gameCenterEnabledVersions returned (when they are included)
- limitInapppurchases int? (default ()) - maximum number of related inAppPurchases returned (when they are included)
- limitPrereleaseversions int? (default ()) - maximum number of related preReleaseVersions returned (when they are included)
- limitPrices int? (default ()) - maximum number of related prices returned (when they are included)
Return Type
- AppsResponse|error - List of Apps
appsGetInstance![](/images/permalink.svg)
function appsGetInstance(string id, string[]? fieldsApps, string[]? include, string[]? fieldsBetagroups, string[]? fieldsPerfpowermetrics, string[]? fieldsAppinfos, string[]? fieldsApppreorders, string[]? fieldsPrereleaseversions, string[]? fieldsAppprices, string[]? fieldsInapppurchases, string[]? fieldsBetaappreviewdetails, string[]? fieldsTerritories, string[]? fieldsGamecenterenabledversions, string[]? fieldsAppstoreversions, string[]? fieldsBuilds, string[]? fieldsBetaapplocalizations, string[]? fieldsBetalicenseagreements, string[]? fieldsEnduserlicenseagreements, int? limitAppinfos, int? limitAppstoreversions, int? limitAvailableterritories, int? limitBetaapplocalizations, int? limitBetagroups, int? limitBuilds, int? limitGamecenterenabledversions, int? limitInapppurchases, int? limitPrereleaseversions, int? limitPrices) returns AppResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBetagroups string[]? (default ()) - the fields to include for returned resources of type betaGroups
- fieldsPerfpowermetrics string[]? (default ()) - the fields to include for returned resources of type perfPowerMetrics
- fieldsAppinfos string[]? (default ()) - the fields to include for returned resources of type appInfos
- fieldsApppreorders string[]? (default ()) - the fields to include for returned resources of type appPreOrders
- fieldsPrereleaseversions string[]? (default ()) - the fields to include for returned resources of type preReleaseVersions
- fieldsAppprices string[]? (default ()) - the fields to include for returned resources of type appPrices
- fieldsInapppurchases string[]? (default ()) - the fields to include for returned resources of type inAppPurchases
- fieldsBetaappreviewdetails string[]? (default ()) - the fields to include for returned resources of type betaAppReviewDetails
- fieldsTerritories string[]? (default ()) - the fields to include for returned resources of type territories
- fieldsGamecenterenabledversions string[]? (default ()) - the fields to include for returned resources of type gameCenterEnabledVersions
- fieldsAppstoreversions string[]? (default ()) - the fields to include for returned resources of type appStoreVersions
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- fieldsBetaapplocalizations string[]? (default ()) - the fields to include for returned resources of type betaAppLocalizations
- fieldsBetalicenseagreements string[]? (default ()) - the fields to include for returned resources of type betaLicenseAgreements
- fieldsEnduserlicenseagreements string[]? (default ()) - the fields to include for returned resources of type endUserLicenseAgreements
- limitAppinfos int? (default ()) - maximum number of related appInfos returned (when they are included)
- limitAppstoreversions int? (default ()) - maximum number of related appStoreVersions returned (when they are included)
- limitAvailableterritories int? (default ()) - maximum number of related availableTerritories returned (when they are included)
- limitBetaapplocalizations int? (default ()) - maximum number of related betaAppLocalizations returned (when they are included)
- limitBetagroups int? (default ()) - maximum number of related betaGroups returned (when they are included)
- limitBuilds int? (default ()) - maximum number of related builds returned (when they are included)
- limitGamecenterenabledversions int? (default ()) - maximum number of related gameCenterEnabledVersions returned (when they are included)
- limitInapppurchases int? (default ()) - maximum number of related inAppPurchases returned (when they are included)
- limitPrereleaseversions int? (default ()) - maximum number of related preReleaseVersions returned (when they are included)
- limitPrices int? (default ()) - maximum number of related prices returned (when they are included)
Return Type
- AppResponse|error - Single App
appsUpdateInstance![](/images/permalink.svg)
function appsUpdateInstance(string id, AppUpdateRequest payload) returns AppResponse|error
Return Type
- AppResponse|error - Single App
betaapplocalizationsGetCollection![](/images/permalink.svg)
function betaapplocalizationsGetCollection(string[]? filterLocale, string[]? filterApp, string[]? fieldsBetaapplocalizations, int? 'limit, string[]? include, string[]? fieldsApps) returns BetaAppLocalizationsResponse|error
Parameters
- filterLocale string[]? (default ()) - filter by attribute 'locale'
- filterApp string[]? (default ()) - filter by id(s) of related 'app'
- fieldsBetaapplocalizations string[]? (default ()) - the fields to include for returned resources of type betaAppLocalizations
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- BetaAppLocalizationsResponse|error - List of BetaAppLocalizations
betaapplocalizationsCreateInstance![](/images/permalink.svg)
function betaapplocalizationsCreateInstance(BetaAppLocalizationCreateRequest payload) returns BetaAppLocalizationResponse|error
Parameters
- payload BetaAppLocalizationCreateRequest - BetaAppLocalization representation
Return Type
- BetaAppLocalizationResponse|error - Single BetaAppLocalization
betaapplocalizationsGetInstance![](/images/permalink.svg)
function betaapplocalizationsGetInstance(string id, string[]? fieldsBetaapplocalizations, string[]? include, string[]? fieldsApps) returns BetaAppLocalizationResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetaapplocalizations string[]? (default ()) - the fields to include for returned resources of type betaAppLocalizations
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- BetaAppLocalizationResponse|error - Single BetaAppLocalization
betaapplocalizationsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
betaapplocalizationsUpdateInstance![](/images/permalink.svg)
function betaapplocalizationsUpdateInstance(string id, BetaAppLocalizationUpdateRequest payload) returns BetaAppLocalizationResponse|error
Parameters
- id string - the id of the requested resource
- payload BetaAppLocalizationUpdateRequest - BetaAppLocalization representation
Return Type
- BetaAppLocalizationResponse|error - Single BetaAppLocalization
betaappreviewdetailsGetCollection![](/images/permalink.svg)
function betaappreviewdetailsGetCollection(string[] filterApp, string[]? fieldsBetaappreviewdetails, int? 'limit, string[]? include, string[]? fieldsApps) returns BetaAppReviewDetailsResponse|error
Parameters
- filterApp string[] - filter by id(s) of related 'app'
- fieldsBetaappreviewdetails string[]? (default ()) - the fields to include for returned resources of type betaAppReviewDetails
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- BetaAppReviewDetailsResponse|error - List of BetaAppReviewDetails
betaappreviewdetailsGetInstance![](/images/permalink.svg)
function betaappreviewdetailsGetInstance(string id, string[]? fieldsBetaappreviewdetails, string[]? include, string[]? fieldsApps) returns BetaAppReviewDetailResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetaappreviewdetails string[]? (default ()) - the fields to include for returned resources of type betaAppReviewDetails
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- BetaAppReviewDetailResponse|error - Single BetaAppReviewDetail
betaappreviewdetailsUpdateInstance![](/images/permalink.svg)
function betaappreviewdetailsUpdateInstance(string id, BetaAppReviewDetailUpdateRequest payload) returns BetaAppReviewDetailResponse|error
Parameters
- id string - the id of the requested resource
- payload BetaAppReviewDetailUpdateRequest - BetaAppReviewDetail representation
Return Type
- BetaAppReviewDetailResponse|error - Single BetaAppReviewDetail
betaappreviewsubmissionsGetCollection![](/images/permalink.svg)
function betaappreviewsubmissionsGetCollection(string[] filterBuild, string[]? filterBetareviewstate, string[]? fieldsBetaappreviewsubmissions, int? 'limit, string[]? include, string[]? fieldsBuilds) returns BetaAppReviewSubmissionsResponse|error
Parameters
- filterBuild string[] - filter by id(s) of related 'build'
- filterBetareviewstate string[]? (default ()) - filter by attribute 'betaReviewState'
- fieldsBetaappreviewsubmissions string[]? (default ()) - the fields to include for returned resources of type betaAppReviewSubmissions
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
Return Type
- BetaAppReviewSubmissionsResponse|error - List of BetaAppReviewSubmissions
betaappreviewsubmissionsCreateInstance![](/images/permalink.svg)
function betaappreviewsubmissionsCreateInstance(BetaAppReviewSubmissionCreateRequest payload) returns BetaAppReviewSubmissionResponse|error
Parameters
- payload BetaAppReviewSubmissionCreateRequest - BetaAppReviewSubmission representation
Return Type
- BetaAppReviewSubmissionResponse|error - Single BetaAppReviewSubmission
betaappreviewsubmissionsGetInstance![](/images/permalink.svg)
function betaappreviewsubmissionsGetInstance(string id, string[]? fieldsBetaappreviewsubmissions, string[]? include, string[]? fieldsBuilds) returns BetaAppReviewSubmissionResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetaappreviewsubmissions string[]? (default ()) - the fields to include for returned resources of type betaAppReviewSubmissions
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
Return Type
- BetaAppReviewSubmissionResponse|error - Single BetaAppReviewSubmission
betabuildlocalizationsGetCollection![](/images/permalink.svg)
function betabuildlocalizationsGetCollection(string[]? filterLocale, string[]? filterBuild, string[]? fieldsBetabuildlocalizations, int? 'limit, string[]? include, string[]? fieldsBuilds) returns BetaBuildLocalizationsResponse|error
Parameters
- filterLocale string[]? (default ()) - filter by attribute 'locale'
- filterBuild string[]? (default ()) - filter by id(s) of related 'build'
- fieldsBetabuildlocalizations string[]? (default ()) - the fields to include for returned resources of type betaBuildLocalizations
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
Return Type
- BetaBuildLocalizationsResponse|error - List of BetaBuildLocalizations
betabuildlocalizationsCreateInstance![](/images/permalink.svg)
function betabuildlocalizationsCreateInstance(BetaBuildLocalizationCreateRequest payload) returns BetaBuildLocalizationResponse|error
Parameters
- payload BetaBuildLocalizationCreateRequest - BetaBuildLocalization representation
Return Type
- BetaBuildLocalizationResponse|error - Single BetaBuildLocalization
betabuildlocalizationsGetInstance![](/images/permalink.svg)
function betabuildlocalizationsGetInstance(string id, string[]? fieldsBetabuildlocalizations, string[]? include, string[]? fieldsBuilds) returns BetaBuildLocalizationResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetabuildlocalizations string[]? (default ()) - the fields to include for returned resources of type betaBuildLocalizations
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
Return Type
- BetaBuildLocalizationResponse|error - Single BetaBuildLocalization
betabuildlocalizationsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
betabuildlocalizationsUpdateInstance![](/images/permalink.svg)
function betabuildlocalizationsUpdateInstance(string id, BetaBuildLocalizationUpdateRequest payload) returns BetaBuildLocalizationResponse|error
Parameters
- id string - the id of the requested resource
- payload BetaBuildLocalizationUpdateRequest - BetaBuildLocalization representation
Return Type
- BetaBuildLocalizationResponse|error - Single BetaBuildLocalization
betagroupsGetCollection![](/images/permalink.svg)
function betagroupsGetCollection(string[]? filterIsinternalgroup, string[]? filterName, string[]? filterPubliclink, string[]? filterPubliclinkenabled, string[]? filterPubliclinklimitenabled, string[]? filterApp, string[]? filterBuilds, string[]? filterId, string[]? sort, string[]? fieldsBetagroups, int? 'limit, string[]? include, string[]? fieldsBuilds, string[]? fieldsBetatesters, string[]? fieldsApps, int? limitBetatesters, int? limitBuilds) returns BetaGroupsResponse|error
Parameters
- filterIsinternalgroup string[]? (default ()) - filter by attribute 'isInternalGroup'
- filterName string[]? (default ()) - filter by attribute 'name'
- filterPubliclink string[]? (default ()) - filter by attribute 'publicLink'
- filterPubliclinkenabled string[]? (default ()) - filter by attribute 'publicLinkEnabled'
- filterPubliclinklimitenabled string[]? (default ()) - filter by attribute 'publicLinkLimitEnabled'
- filterApp string[]? (default ()) - filter by id(s) of related 'app'
- filterBuilds string[]? (default ()) - filter by id(s) of related 'builds'
- filterId string[]? (default ()) - filter by id(s)
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsBetagroups string[]? (default ()) - the fields to include for returned resources of type betaGroups
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- fieldsBetatesters string[]? (default ()) - the fields to include for returned resources of type betaTesters
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitBetatesters int? (default ()) - maximum number of related betaTesters returned (when they are included)
- limitBuilds int? (default ()) - maximum number of related builds returned (when they are included)
Return Type
- BetaGroupsResponse|error - List of BetaGroups
betagroupsCreateInstance![](/images/permalink.svg)
function betagroupsCreateInstance(BetaGroupCreateRequest payload) returns BetaGroupResponse|error
Parameters
- payload BetaGroupCreateRequest - BetaGroup representation
Return Type
- BetaGroupResponse|error - Single BetaGroup
betagroupsGetInstance![](/images/permalink.svg)
function betagroupsGetInstance(string id, string[]? fieldsBetagroups, string[]? include, string[]? fieldsBuilds, string[]? fieldsBetatesters, string[]? fieldsApps, int? limitBetatesters, int? limitBuilds) returns BetaGroupResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetagroups string[]? (default ()) - the fields to include for returned resources of type betaGroups
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- fieldsBetatesters string[]? (default ()) - the fields to include for returned resources of type betaTesters
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitBetatesters int? (default ()) - maximum number of related betaTesters returned (when they are included)
- limitBuilds int? (default ()) - maximum number of related builds returned (when they are included)
Return Type
- BetaGroupResponse|error - Single BetaGroup
betagroupsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
betagroupsUpdateInstance![](/images/permalink.svg)
function betagroupsUpdateInstance(string id, BetaGroupUpdateRequest payload) returns BetaGroupResponse|error
Parameters
- id string - the id of the requested resource
- payload BetaGroupUpdateRequest - BetaGroup representation
Return Type
- BetaGroupResponse|error - Single BetaGroup
betalicenseagreementsGetCollection![](/images/permalink.svg)
function betalicenseagreementsGetCollection(string[]? filterApp, string[]? fieldsBetalicenseagreements, int? 'limit, string[]? include, string[]? fieldsApps) returns BetaLicenseAgreementsResponse|error
Parameters
- filterApp string[]? (default ()) - filter by id(s) of related 'app'
- fieldsBetalicenseagreements string[]? (default ()) - the fields to include for returned resources of type betaLicenseAgreements
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- BetaLicenseAgreementsResponse|error - List of BetaLicenseAgreements
betalicenseagreementsGetInstance![](/images/permalink.svg)
function betalicenseagreementsGetInstance(string id, string[]? fieldsBetalicenseagreements, string[]? include, string[]? fieldsApps) returns BetaLicenseAgreementResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetalicenseagreements string[]? (default ()) - the fields to include for returned resources of type betaLicenseAgreements
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- BetaLicenseAgreementResponse|error - Single BetaLicenseAgreement
betalicenseagreementsUpdateInstance![](/images/permalink.svg)
function betalicenseagreementsUpdateInstance(string id, BetaLicenseAgreementUpdateRequest payload) returns BetaLicenseAgreementResponse|error
Parameters
- id string - the id of the requested resource
- payload BetaLicenseAgreementUpdateRequest - BetaLicenseAgreement representation
Return Type
- BetaLicenseAgreementResponse|error - Single BetaLicenseAgreement
betatesterinvitationsCreateInstance![](/images/permalink.svg)
function betatesterinvitationsCreateInstance(BetaTesterInvitationCreateRequest payload) returns BetaTesterInvitationResponse|error
Parameters
- payload BetaTesterInvitationCreateRequest - BetaTesterInvitation representation
Return Type
- BetaTesterInvitationResponse|error - Single BetaTesterInvitation
betatestersGetCollection![](/images/permalink.svg)
function betatestersGetCollection(string[]? filterEmail, string[]? filterFirstname, string[]? filterInvitetype, string[]? filterLastname, string[]? filterApps, string[]? filterBetagroups, string[]? filterBuilds, string[]? sort, string[]? fieldsBetatesters, int? 'limit, string[]? include, string[]? fieldsBetagroups, string[]? fieldsBuilds, string[]? fieldsApps, int? limitApps, int? limitBetagroups, int? limitBuilds) returns BetaTestersResponse|error
Parameters
- filterEmail string[]? (default ()) - filter by attribute 'email'
- filterFirstname string[]? (default ()) - filter by attribute 'firstName'
- filterInvitetype string[]? (default ()) - filter by attribute 'inviteType'
- filterLastname string[]? (default ()) - filter by attribute 'lastName'
- filterApps string[]? (default ()) - filter by id(s) of related 'apps'
- filterBetagroups string[]? (default ()) - filter by id(s) of related 'betaGroups'
- filterBuilds string[]? (default ()) - filter by id(s) of related 'builds'
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsBetatesters string[]? (default ()) - the fields to include for returned resources of type betaTesters
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBetagroups string[]? (default ()) - the fields to include for returned resources of type betaGroups
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitApps int? (default ()) - maximum number of related apps returned (when they are included)
- limitBetagroups int? (default ()) - maximum number of related betaGroups returned (when they are included)
- limitBuilds int? (default ()) - maximum number of related builds returned (when they are included)
Return Type
- BetaTestersResponse|error - List of BetaTesters
betatestersCreateInstance![](/images/permalink.svg)
function betatestersCreateInstance(BetaTesterCreateRequest payload) returns BetaTesterResponse|error
Parameters
- payload BetaTesterCreateRequest - BetaTester representation
Return Type
- BetaTesterResponse|error - Single BetaTester
betatestersGetInstance![](/images/permalink.svg)
function betatestersGetInstance(string id, string[]? fieldsBetatesters, string[]? include, string[]? fieldsBetagroups, string[]? fieldsBuilds, string[]? fieldsApps, int? limitApps, int? limitBetagroups, int? limitBuilds) returns BetaTesterResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetatesters string[]? (default ()) - the fields to include for returned resources of type betaTesters
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBetagroups string[]? (default ()) - the fields to include for returned resources of type betaGroups
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitApps int? (default ()) - maximum number of related apps returned (when they are included)
- limitBetagroups int? (default ()) - maximum number of related betaGroups returned (when they are included)
- limitBuilds int? (default ()) - maximum number of related builds returned (when they are included)
Return Type
- BetaTesterResponse|error - Single BetaTester
betatestersDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
buildbetadetailsGetCollection![](/images/permalink.svg)
function buildbetadetailsGetCollection(string[]? filterBuild, string[]? filterId, string[]? fieldsBuildbetadetails, int? 'limit, string[]? include, string[]? fieldsBuilds) returns BuildBetaDetailsResponse|error
Parameters
- filterBuild string[]? (default ()) - filter by id(s) of related 'build'
- filterId string[]? (default ()) - filter by id(s)
- fieldsBuildbetadetails string[]? (default ()) - the fields to include for returned resources of type buildBetaDetails
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
Return Type
- BuildBetaDetailsResponse|error - List of BuildBetaDetails
buildbetadetailsGetInstance![](/images/permalink.svg)
function buildbetadetailsGetInstance(string id, string[]? fieldsBuildbetadetails, string[]? include, string[]? fieldsBuilds) returns BuildBetaDetailResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuildbetadetails string[]? (default ()) - the fields to include for returned resources of type buildBetaDetails
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
Return Type
- BuildBetaDetailResponse|error - Single BuildBetaDetail
buildbetadetailsUpdateInstance![](/images/permalink.svg)
function buildbetadetailsUpdateInstance(string id, BuildBetaDetailUpdateRequest payload) returns BuildBetaDetailResponse|error
Parameters
- id string - the id of the requested resource
- payload BuildBetaDetailUpdateRequest - BuildBetaDetail representation
Return Type
- BuildBetaDetailResponse|error - Single BuildBetaDetail
buildbetanotificationsCreateInstance![](/images/permalink.svg)
function buildbetanotificationsCreateInstance(BuildBetaNotificationCreateRequest payload) returns BuildBetaNotificationResponse|error
Parameters
- payload BuildBetaNotificationCreateRequest - BuildBetaNotification representation
Return Type
- BuildBetaNotificationResponse|error - Single BuildBetaNotification
buildsGetCollection![](/images/permalink.svg)
function buildsGetCollection(string[]? filterBetaappreviewsubmissionBetareviewstate, string[]? filterExpired, string[]? filterPrereleaseversionPlatform, string[]? filterPrereleaseversionVersion, string[]? filterProcessingstate, string[]? filterUsesnonexemptencryption, string[]? filterVersion, string[]? filterApp, string[]? filterAppstoreversion, string[]? filterBetagroups, string[]? filterPrereleaseversion, string[]? filterId, string[]? sort, string[]? fieldsBuilds, int? 'limit, string[]? include, string[]? fieldsAppencryptiondeclarations, string[]? fieldsBetaappreviewsubmissions, string[]? fieldsBuildbetadetails, string[]? fieldsBuildicons, string[]? fieldsPerfpowermetrics, string[]? fieldsPrereleaseversions, string[]? fieldsAppstoreversions, string[]? fieldsDiagnosticsignatures, string[]? fieldsBetatesters, string[]? fieldsBetabuildlocalizations, string[]? fieldsApps, int? limitBetabuildlocalizations, int? limitIcons, int? limitIndividualtesters) returns BuildsResponse|error
Parameters
- filterBetaappreviewsubmissionBetareviewstate string[]? (default ()) - filter by attribute 'betaAppReviewSubmission.betaReviewState'
- filterExpired string[]? (default ()) - filter by attribute 'expired'
- filterPrereleaseversionPlatform string[]? (default ()) - filter by attribute 'preReleaseVersion.platform'
- filterPrereleaseversionVersion string[]? (default ()) - filter by attribute 'preReleaseVersion.version'
- filterProcessingstate string[]? (default ()) - filter by attribute 'processingState'
- filterUsesnonexemptencryption string[]? (default ()) - filter by attribute 'usesNonExemptEncryption'
- filterVersion string[]? (default ()) - filter by attribute 'version'
- filterApp string[]? (default ()) - filter by id(s) of related 'app'
- filterAppstoreversion string[]? (default ()) - filter by id(s) of related 'appStoreVersion'
- filterBetagroups string[]? (default ()) - filter by id(s) of related 'betaGroups'
- filterPrereleaseversion string[]? (default ()) - filter by id(s) of related 'preReleaseVersion'
- filterId string[]? (default ()) - filter by id(s)
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsAppencryptiondeclarations string[]? (default ()) - the fields to include for returned resources of type appEncryptionDeclarations
- fieldsBetaappreviewsubmissions string[]? (default ()) - the fields to include for returned resources of type betaAppReviewSubmissions
- fieldsBuildbetadetails string[]? (default ()) - the fields to include for returned resources of type buildBetaDetails
- fieldsBuildicons string[]? (default ()) - the fields to include for returned resources of type buildIcons
- fieldsPerfpowermetrics string[]? (default ()) - the fields to include for returned resources of type perfPowerMetrics
- fieldsPrereleaseversions string[]? (default ()) - the fields to include for returned resources of type preReleaseVersions
- fieldsAppstoreversions string[]? (default ()) - the fields to include for returned resources of type appStoreVersions
- fieldsDiagnosticsignatures string[]? (default ()) - the fields to include for returned resources of type diagnosticSignatures
- fieldsBetatesters string[]? (default ()) - the fields to include for returned resources of type betaTesters
- fieldsBetabuildlocalizations string[]? (default ()) - the fields to include for returned resources of type betaBuildLocalizations
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitBetabuildlocalizations int? (default ()) - maximum number of related betaBuildLocalizations returned (when they are included)
- limitIcons int? (default ()) - maximum number of related icons returned (when they are included)
- limitIndividualtesters int? (default ()) - maximum number of related individualTesters returned (when they are included)
Return Type
- BuildsResponse|error - List of Builds
buildsGetInstance![](/images/permalink.svg)
function buildsGetInstance(string id, string[]? fieldsBuilds, string[]? include, string[]? fieldsAppencryptiondeclarations, string[]? fieldsBetaappreviewsubmissions, string[]? fieldsBuildbetadetails, string[]? fieldsBuildicons, string[]? fieldsPerfpowermetrics, string[]? fieldsPrereleaseversions, string[]? fieldsAppstoreversions, string[]? fieldsDiagnosticsignatures, string[]? fieldsBetatesters, string[]? fieldsBetabuildlocalizations, string[]? fieldsApps, int? limitBetabuildlocalizations, int? limitIcons, int? limitIndividualtesters) returns BuildResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsAppencryptiondeclarations string[]? (default ()) - the fields to include for returned resources of type appEncryptionDeclarations
- fieldsBetaappreviewsubmissions string[]? (default ()) - the fields to include for returned resources of type betaAppReviewSubmissions
- fieldsBuildbetadetails string[]? (default ()) - the fields to include for returned resources of type buildBetaDetails
- fieldsBuildicons string[]? (default ()) - the fields to include for returned resources of type buildIcons
- fieldsPerfpowermetrics string[]? (default ()) - the fields to include for returned resources of type perfPowerMetrics
- fieldsPrereleaseversions string[]? (default ()) - the fields to include for returned resources of type preReleaseVersions
- fieldsAppstoreversions string[]? (default ()) - the fields to include for returned resources of type appStoreVersions
- fieldsDiagnosticsignatures string[]? (default ()) - the fields to include for returned resources of type diagnosticSignatures
- fieldsBetatesters string[]? (default ()) - the fields to include for returned resources of type betaTesters
- fieldsBetabuildlocalizations string[]? (default ()) - the fields to include for returned resources of type betaBuildLocalizations
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitBetabuildlocalizations int? (default ()) - maximum number of related betaBuildLocalizations returned (when they are included)
- limitIcons int? (default ()) - maximum number of related icons returned (when they are included)
- limitIndividualtesters int? (default ()) - maximum number of related individualTesters returned (when they are included)
Return Type
- BuildResponse|error - Single Build
buildsUpdateInstance![](/images/permalink.svg)
function buildsUpdateInstance(string id, BuildUpdateRequest payload) returns BuildResponse|error
Parameters
- id string - the id of the requested resource
- payload BuildUpdateRequest - Build representation
Return Type
- BuildResponse|error - Single Build
bundleidcapabilitiesCreateInstance![](/images/permalink.svg)
function bundleidcapabilitiesCreateInstance(BundleIdCapabilityCreateRequest payload) returns BundleIdCapabilityResponse|error
Parameters
- payload BundleIdCapabilityCreateRequest - BundleIdCapability representation
Return Type
- BundleIdCapabilityResponse|error - Single BundleIdCapability
bundleidcapabilitiesDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
bundleidcapabilitiesUpdateInstance![](/images/permalink.svg)
function bundleidcapabilitiesUpdateInstance(string id, BundleIdCapabilityUpdateRequest payload) returns BundleIdCapabilityResponse|error
Parameters
- id string - the id of the requested resource
- payload BundleIdCapabilityUpdateRequest - BundleIdCapability representation
Return Type
- BundleIdCapabilityResponse|error - Single BundleIdCapability
bundleidsGetCollection![](/images/permalink.svg)
function bundleidsGetCollection(string[]? filterIdentifier, string[]? filterName, string[]? filterPlatform, string[]? filterSeedid, string[]? filterId, string[]? sort, string[]? fieldsBundleids, int? 'limit, string[]? include, string[]? fieldsBundleidcapabilities, string[]? fieldsProfiles, string[]? fieldsApps, int? limitBundleidcapabilities, int? limitProfiles) returns BundleIdsResponse|error
Parameters
- filterIdentifier string[]? (default ()) - filter by attribute 'identifier'
- filterName string[]? (default ()) - filter by attribute 'name'
- filterPlatform string[]? (default ()) - filter by attribute 'platform'
- filterSeedid string[]? (default ()) - filter by attribute 'seedId'
- filterId string[]? (default ()) - filter by id(s)
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsBundleids string[]? (default ()) - the fields to include for returned resources of type bundleIds
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBundleidcapabilities string[]? (default ()) - the fields to include for returned resources of type bundleIdCapabilities
- fieldsProfiles string[]? (default ()) - the fields to include for returned resources of type profiles
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitBundleidcapabilities int? (default ()) - maximum number of related bundleIdCapabilities returned (when they are included)
- limitProfiles int? (default ()) - maximum number of related profiles returned (when they are included)
Return Type
- BundleIdsResponse|error - List of BundleIds
bundleidsCreateInstance![](/images/permalink.svg)
function bundleidsCreateInstance(BundleIdCreateRequest payload) returns BundleIdResponse|error
Parameters
- payload BundleIdCreateRequest - BundleId representation
Return Type
- BundleIdResponse|error - Single BundleId
bundleidsGetInstance![](/images/permalink.svg)
function bundleidsGetInstance(string id, string[]? fieldsBundleids, string[]? include, string[]? fieldsBundleidcapabilities, string[]? fieldsProfiles, string[]? fieldsApps, int? limitBundleidcapabilities, int? limitProfiles) returns BundleIdResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBundleids string[]? (default ()) - the fields to include for returned resources of type bundleIds
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBundleidcapabilities string[]? (default ()) - the fields to include for returned resources of type bundleIdCapabilities
- fieldsProfiles string[]? (default ()) - the fields to include for returned resources of type profiles
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitBundleidcapabilities int? (default ()) - maximum number of related bundleIdCapabilities returned (when they are included)
- limitProfiles int? (default ()) - maximum number of related profiles returned (when they are included)
Return Type
- BundleIdResponse|error - Single BundleId
bundleidsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
bundleidsUpdateInstance![](/images/permalink.svg)
function bundleidsUpdateInstance(string id, BundleIdUpdateRequest payload) returns BundleIdResponse|error
Parameters
- id string - the id of the requested resource
- payload BundleIdUpdateRequest - BundleId representation
Return Type
- BundleIdResponse|error - Single BundleId
certificatesGetCollection![](/images/permalink.svg)
function certificatesGetCollection(string[]? filterCertificatetype, string[]? filterDisplayname, string[]? filterSerialnumber, string[]? filterId, string[]? sort, string[]? fieldsCertificates, int? 'limit) returns CertificatesResponse|error
Parameters
- filterCertificatetype string[]? (default ()) - filter by attribute 'certificateType'
- filterDisplayname string[]? (default ()) - filter by attribute 'displayName'
- filterSerialnumber string[]? (default ()) - filter by attribute 'serialNumber'
- filterId string[]? (default ()) - filter by id(s)
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsCertificates string[]? (default ()) - the fields to include for returned resources of type certificates
- 'limit int? (default ()) - maximum resources per page
Return Type
- CertificatesResponse|error - List of Certificates
certificatesCreateInstance![](/images/permalink.svg)
function certificatesCreateInstance(CertificateCreateRequest payload) returns CertificateResponse|error
Parameters
- payload CertificateCreateRequest - Certificate representation
Return Type
- CertificateResponse|error - Single Certificate
certificatesGetInstance![](/images/permalink.svg)
function certificatesGetInstance(string id, string[]? fieldsCertificates) returns CertificateResponse|error
Parameters
- id string - the id of the requested resource
- fieldsCertificates string[]? (default ()) - the fields to include for returned resources of type certificates
Return Type
- CertificateResponse|error - Single Certificate
certificatesDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
devicesGetCollection![](/images/permalink.svg)
function devicesGetCollection(string[]? filterName, string[]? filterPlatform, string[]? filterStatus, string[]? filterUdid, string[]? filterId, string[]? sort, string[]? fieldsDevices, int? 'limit) returns DevicesResponse|error
Parameters
- filterName string[]? (default ()) - filter by attribute 'name'
- filterPlatform string[]? (default ()) - filter by attribute 'platform'
- filterStatus string[]? (default ()) - filter by attribute 'status'
- filterUdid string[]? (default ()) - filter by attribute 'udid'
- filterId string[]? (default ()) - filter by id(s)
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsDevices string[]? (default ()) - the fields to include for returned resources of type devices
- 'limit int? (default ()) - maximum resources per page
Return Type
- DevicesResponse|error - List of Devices
devicesCreateInstance![](/images/permalink.svg)
function devicesCreateInstance(DeviceCreateRequest payload) returns DeviceResponse|error
Parameters
- payload DeviceCreateRequest - Device representation
Return Type
- DeviceResponse|error - Single Device
devicesGetInstance![](/images/permalink.svg)
function devicesGetInstance(string id, string[]? fieldsDevices) returns DeviceResponse|error
Parameters
- id string - the id of the requested resource
- fieldsDevices string[]? (default ()) - the fields to include for returned resources of type devices
Return Type
- DeviceResponse|error - Single Device
devicesUpdateInstance![](/images/permalink.svg)
function devicesUpdateInstance(string id, DeviceUpdateRequest payload) returns DeviceResponse|error
Parameters
- id string - the id of the requested resource
- payload DeviceUpdateRequest - Device representation
Return Type
- DeviceResponse|error - Single Device
enduserlicenseagreementsCreateInstance![](/images/permalink.svg)
function enduserlicenseagreementsCreateInstance(EndUserLicenseAgreementCreateRequest payload) returns EndUserLicenseAgreementResponse|error
Parameters
- payload EndUserLicenseAgreementCreateRequest - EndUserLicenseAgreement representation
Return Type
- EndUserLicenseAgreementResponse|error - Single EndUserLicenseAgreement
enduserlicenseagreementsGetInstance![](/images/permalink.svg)
function enduserlicenseagreementsGetInstance(string id, string[]? fieldsEnduserlicenseagreements, string[]? include, string[]? fieldsTerritories, int? limitTerritories) returns EndUserLicenseAgreementResponse|error
Parameters
- id string - the id of the requested resource
- fieldsEnduserlicenseagreements string[]? (default ()) - the fields to include for returned resources of type endUserLicenseAgreements
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsTerritories string[]? (default ()) - the fields to include for returned resources of type territories
- limitTerritories int? (default ()) - maximum number of related territories returned (when they are included)
Return Type
- EndUserLicenseAgreementResponse|error - Single EndUserLicenseAgreement
enduserlicenseagreementsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
enduserlicenseagreementsUpdateInstance![](/images/permalink.svg)
function enduserlicenseagreementsUpdateInstance(string id, EndUserLicenseAgreementUpdateRequest payload) returns EndUserLicenseAgreementResponse|error
Parameters
- id string - the id of the requested resource
- payload EndUserLicenseAgreementUpdateRequest - EndUserLicenseAgreement representation
Return Type
- EndUserLicenseAgreementResponse|error - Single EndUserLicenseAgreement
financereportsGetCollection![](/images/permalink.svg)
function financereportsGetCollection(string[] filterRegioncode, string[] filterReportdate, string[] filterReporttype, string[] filterVendornumber) returns string|error
Parameters
- filterRegioncode string[] - filter by attribute 'regionCode'
- filterReportdate string[] - filter by attribute 'reportDate'
- filterReporttype string[] - filter by attribute 'reportType'
- filterVendornumber string[] - filter by attribute 'vendorNumber'
idfadeclarationsCreateInstance![](/images/permalink.svg)
function idfadeclarationsCreateInstance(IdfaDeclarationCreateRequest payload) returns IdfaDeclarationResponse|error
Parameters
- payload IdfaDeclarationCreateRequest - IdfaDeclaration representation
Return Type
- IdfaDeclarationResponse|error - Single IdfaDeclaration
idfadeclarationsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
idfadeclarationsUpdateInstance![](/images/permalink.svg)
function idfadeclarationsUpdateInstance(string id, IdfaDeclarationUpdateRequest payload) returns IdfaDeclarationResponse|error
Parameters
- id string - the id of the requested resource
- payload IdfaDeclarationUpdateRequest - IdfaDeclaration representation
Return Type
- IdfaDeclarationResponse|error - Single IdfaDeclaration
inapppurchasesGetInstance![](/images/permalink.svg)
function inapppurchasesGetInstance(string id, string[]? fieldsInapppurchases, string[]? include, int? limitApps) returns InAppPurchaseResponse|error
Parameters
- id string - the id of the requested resource
- fieldsInapppurchases string[]? (default ()) - the fields to include for returned resources of type inAppPurchases
- include string[]? (default ()) - comma-separated list of relationships to include
- limitApps int? (default ()) - maximum number of related apps returned (when they are included)
Return Type
- InAppPurchaseResponse|error - Single InAppPurchase
prereleaseversionsGetCollection![](/images/permalink.svg)
function prereleaseversionsGetCollection(string[]? filterBuildsExpired, string[]? filterBuildsProcessingstate, string[]? filterPlatform, string[]? filterVersion, string[]? filterApp, string[]? filterBuilds, string[]? sort, string[]? fieldsPrereleaseversions, int? 'limit, string[]? include, string[]? fieldsBuilds, string[]? fieldsApps, int? limitBuilds) returns PreReleaseVersionsResponse|error
Parameters
- filterBuildsExpired string[]? (default ()) - filter by attribute 'builds.expired'
- filterBuildsProcessingstate string[]? (default ()) - filter by attribute 'builds.processingState'
- filterPlatform string[]? (default ()) - filter by attribute 'platform'
- filterVersion string[]? (default ()) - filter by attribute 'version'
- filterApp string[]? (default ()) - filter by id(s) of related 'app'
- filterBuilds string[]? (default ()) - filter by id(s) of related 'builds'
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsPrereleaseversions string[]? (default ()) - the fields to include for returned resources of type preReleaseVersions
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitBuilds int? (default ()) - maximum number of related builds returned (when they are included)
Return Type
- PreReleaseVersionsResponse|error - List of PreReleaseVersions
prereleaseversionsGetInstance![](/images/permalink.svg)
function prereleaseversionsGetInstance(string id, string[]? fieldsPrereleaseversions, string[]? include, string[]? fieldsBuilds, string[]? fieldsApps, int? limitBuilds) returns PrereleaseVersionResponse|error
Parameters
- id string - the id of the requested resource
- fieldsPrereleaseversions string[]? (default ()) - the fields to include for returned resources of type preReleaseVersions
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitBuilds int? (default ()) - maximum number of related builds returned (when they are included)
Return Type
- PrereleaseVersionResponse|error - Single PrereleaseVersion
profilesGetCollection![](/images/permalink.svg)
function profilesGetCollection(string[]? filterName, string[]? filterProfilestate, string[]? filterProfiletype, string[]? filterId, string[]? sort, string[]? fieldsProfiles, int? 'limit, string[]? include, string[]? fieldsCertificates, string[]? fieldsDevices, string[]? fieldsBundleids, int? limitCertificates, int? limitDevices) returns ProfilesResponse|error
Parameters
- filterName string[]? (default ()) - filter by attribute 'name'
- filterProfilestate string[]? (default ()) - filter by attribute 'profileState'
- filterProfiletype string[]? (default ()) - filter by attribute 'profileType'
- filterId string[]? (default ()) - filter by id(s)
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsProfiles string[]? (default ()) - the fields to include for returned resources of type profiles
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsCertificates string[]? (default ()) - the fields to include for returned resources of type certificates
- fieldsDevices string[]? (default ()) - the fields to include for returned resources of type devices
- fieldsBundleids string[]? (default ()) - the fields to include for returned resources of type bundleIds
- limitCertificates int? (default ()) - maximum number of related certificates returned (when they are included)
- limitDevices int? (default ()) - maximum number of related devices returned (when they are included)
Return Type
- ProfilesResponse|error - List of Profiles
profilesCreateInstance![](/images/permalink.svg)
function profilesCreateInstance(ProfileCreateRequest payload) returns ProfileResponse|error
Parameters
- payload ProfileCreateRequest - Profile representation
Return Type
- ProfileResponse|error - Single Profile
profilesGetInstance![](/images/permalink.svg)
function profilesGetInstance(string id, string[]? fieldsProfiles, string[]? include, string[]? fieldsCertificates, string[]? fieldsDevices, string[]? fieldsBundleids, int? limitCertificates, int? limitDevices) returns ProfileResponse|error
Parameters
- id string - the id of the requested resource
- fieldsProfiles string[]? (default ()) - the fields to include for returned resources of type profiles
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsCertificates string[]? (default ()) - the fields to include for returned resources of type certificates
- fieldsDevices string[]? (default ()) - the fields to include for returned resources of type devices
- fieldsBundleids string[]? (default ()) - the fields to include for returned resources of type bundleIds
- limitCertificates int? (default ()) - maximum number of related certificates returned (when they are included)
- limitDevices int? (default ()) - maximum number of related devices returned (when they are included)
Return Type
- ProfileResponse|error - Single Profile
profilesDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
routingappcoveragesCreateInstance![](/images/permalink.svg)
function routingappcoveragesCreateInstance(RoutingAppCoverageCreateRequest payload) returns RoutingAppCoverageResponse|error
Parameters
- payload RoutingAppCoverageCreateRequest - RoutingAppCoverage representation
Return Type
- RoutingAppCoverageResponse|error - Single RoutingAppCoverage
routingappcoveragesGetInstance![](/images/permalink.svg)
function routingappcoveragesGetInstance(string id, string[]? fieldsRoutingappcoverages, string[]? include) returns RoutingAppCoverageResponse|error
Parameters
- id string - the id of the requested resource
- fieldsRoutingappcoverages string[]? (default ()) - the fields to include for returned resources of type routingAppCoverages
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- RoutingAppCoverageResponse|error - Single RoutingAppCoverage
routingappcoveragesDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
routingappcoveragesUpdateInstance![](/images/permalink.svg)
function routingappcoveragesUpdateInstance(string id, RoutingAppCoverageUpdateRequest payload) returns RoutingAppCoverageResponse|error
Parameters
- id string - the id of the requested resource
- payload RoutingAppCoverageUpdateRequest - RoutingAppCoverage representation
Return Type
- RoutingAppCoverageResponse|error - Single RoutingAppCoverage
salesreportsGetCollection![](/images/permalink.svg)
function salesreportsGetCollection(string[] filterFrequency, string[] filterReportsubtype, string[] filterReporttype, string[] filterVendornumber, string[]? filterReportdate, string[]? filterVersion) returns string|error
Parameters
- filterFrequency string[] - filter by attribute 'frequency'
- filterReportsubtype string[] - filter by attribute 'reportSubType'
- filterReporttype string[] - filter by attribute 'reportType'
- filterVendornumber string[] - filter by attribute 'vendorNumber'
- filterReportdate string[]? (default ()) - filter by attribute 'reportDate'
- filterVersion string[]? (default ()) - filter by attribute 'version'
territoriesGetCollection![](/images/permalink.svg)
function territoriesGetCollection(string[]? fieldsTerritories, int? 'limit) returns TerritoriesResponse|error
Parameters
- fieldsTerritories string[]? (default ()) - the fields to include for returned resources of type territories
- 'limit int? (default ()) - maximum resources per page
Return Type
- TerritoriesResponse|error - List of Territories
userinvitationsGetCollection![](/images/permalink.svg)
function userinvitationsGetCollection(string[]? filterEmail, string[]? filterRoles, string[]? filterVisibleapps, string[]? sort, string[]? fieldsUserinvitations, int? 'limit, string[]? include, string[]? fieldsApps, int? limitVisibleapps) returns UserInvitationsResponse|error
Parameters
- filterEmail string[]? (default ()) - filter by attribute 'email'
- filterRoles string[]? (default ()) - filter by attribute 'roles'
- filterVisibleapps string[]? (default ()) - filter by id(s) of related 'visibleApps'
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsUserinvitations string[]? (default ()) - the fields to include for returned resources of type userInvitations
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitVisibleapps int? (default ()) - maximum number of related visibleApps returned (when they are included)
Return Type
- UserInvitationsResponse|error - List of UserInvitations
userinvitationsCreateInstance![](/images/permalink.svg)
function userinvitationsCreateInstance(UserInvitationCreateRequest payload) returns UserInvitationResponse|error
Parameters
- payload UserInvitationCreateRequest - UserInvitation representation
Return Type
- UserInvitationResponse|error - Single UserInvitation
userinvitationsGetInstance![](/images/permalink.svg)
function userinvitationsGetInstance(string id, string[]? fieldsUserinvitations, string[]? include, string[]? fieldsApps, int? limitVisibleapps) returns UserInvitationResponse|error
Parameters
- id string - the id of the requested resource
- fieldsUserinvitations string[]? (default ()) - the fields to include for returned resources of type userInvitations
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitVisibleapps int? (default ()) - maximum number of related visibleApps returned (when they are included)
Return Type
- UserInvitationResponse|error - Single UserInvitation
userinvitationsDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
usersGetCollection![](/images/permalink.svg)
function usersGetCollection(string[]? filterRoles, string[]? filterUsername, string[]? filterVisibleapps, string[]? sort, string[]? fieldsUsers, int? 'limit, string[]? include, string[]? fieldsApps, int? limitVisibleapps) returns UsersResponse|error
Parameters
- filterRoles string[]? (default ()) - filter by attribute 'roles'
- filterUsername string[]? (default ()) - filter by attribute 'username'
- filterVisibleapps string[]? (default ()) - filter by id(s) of related 'visibleApps'
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsUsers string[]? (default ()) - the fields to include for returned resources of type users
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitVisibleapps int? (default ()) - maximum number of related visibleApps returned (when they are included)
Return Type
- UsersResponse|error - List of Users
usersGetInstance![](/images/permalink.svg)
function usersGetInstance(string id, string[]? fieldsUsers, string[]? include, string[]? fieldsApps, int? limitVisibleapps) returns UserResponse|error
Parameters
- id string - the id of the requested resource
- fieldsUsers string[]? (default ()) - the fields to include for returned resources of type users
- include string[]? (default ()) - comma-separated list of relationships to include
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- limitVisibleapps int? (default ()) - maximum number of related visibleApps returned (when they are included)
Return Type
- UserResponse|error - Single User
usersDeleteInstance![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
usersUpdateInstance![](/images/permalink.svg)
function usersUpdateInstance(string id, UserUpdateRequest payload) returns UserResponse|error
Parameters
- id string - the id of the requested resource
- payload UserUpdateRequest - User representation
Return Type
- UserResponse|error - Single User
appcategoriesParentGetToOneRelated![](/images/permalink.svg)
function appcategoriesParentGetToOneRelated(string id, string[]? fieldsAppcategories) returns AppCategoryResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
Return Type
- AppCategoryResponse|error - Related resource
appcategoriesSubcategoriesGetToManyRelated![](/images/permalink.svg)
function appcategoriesSubcategoriesGetToManyRelated(string id, string[]? fieldsAppcategories, int? 'limit) returns AppCategoriesResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
- 'limit int? (default ()) - maximum resources per page
Return Type
- AppCategoriesResponse|error - List of related resources
appencryptiondeclarationsAppGetToOneRelated![](/images/permalink.svg)
function appencryptiondeclarationsAppGetToOneRelated(string id, string[]? fieldsApps) returns AppResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- AppResponse|error - Related resource
appencryptiondeclarationsBuildsCreateToManyRelationship![](/images/permalink.svg)
function appencryptiondeclarationsBuildsCreateToManyRelationship(string id, AppEncryptionDeclarationBuildsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload AppEncryptionDeclarationBuildsLinkagesRequest - List of related linkages
appinfosAgeratingdeclarationGetToOneRelated![](/images/permalink.svg)
function appinfosAgeratingdeclarationGetToOneRelated(string id, string[]? fieldsAgeratingdeclarations) returns AgeRatingDeclarationResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAgeratingdeclarations string[]? (default ()) - the fields to include for returned resources of type ageRatingDeclarations
Return Type
- AgeRatingDeclarationResponse|error - Related resource
appinfosAppinfolocalizationsGetToManyRelated![](/images/permalink.svg)
function appinfosAppinfolocalizationsGetToManyRelated(string id, string[]? filterLocale, string[]? fieldsAppinfos, string[]? fieldsAppinfolocalizations, int? 'limit, string[]? include) returns AppInfoLocalizationsResponse|error
Parameters
- id string - the id of the requested resource
- filterLocale string[]? (default ()) - filter by attribute 'locale'
- fieldsAppinfos string[]? (default ()) - the fields to include for returned resources of type appInfos
- fieldsAppinfolocalizations string[]? (default ()) - the fields to include for returned resources of type appInfoLocalizations
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppInfoLocalizationsResponse|error - List of related resources
appinfosPrimarycategoryGetToOneRelated![](/images/permalink.svg)
function appinfosPrimarycategoryGetToOneRelated(string id, string[]? fieldsAppcategories) returns AppCategoryResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
Return Type
- AppCategoryResponse|error - Related resource
appinfosPrimarysubcategoryoneGetToOneRelated![](/images/permalink.svg)
function appinfosPrimarysubcategoryoneGetToOneRelated(string id, string[]? fieldsAppcategories) returns AppCategoryResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
Return Type
- AppCategoryResponse|error - Related resource
appinfosPrimarysubcategorytwoGetToOneRelated![](/images/permalink.svg)
function appinfosPrimarysubcategorytwoGetToOneRelated(string id, string[]? fieldsAppcategories) returns AppCategoryResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
Return Type
- AppCategoryResponse|error - Related resource
appinfosSecondarycategoryGetToOneRelated![](/images/permalink.svg)
function appinfosSecondarycategoryGetToOneRelated(string id, string[]? fieldsAppcategories) returns AppCategoryResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
Return Type
- AppCategoryResponse|error - Related resource
appinfosSecondarysubcategoryoneGetToOneRelated![](/images/permalink.svg)
function appinfosSecondarysubcategoryoneGetToOneRelated(string id, string[]? fieldsAppcategories) returns AppCategoryResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
Return Type
- AppCategoryResponse|error - Related resource
appinfosSecondarysubcategorytwoGetToOneRelated![](/images/permalink.svg)
function appinfosSecondarysubcategorytwoGetToOneRelated(string id, string[]? fieldsAppcategories) returns AppCategoryResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
Return Type
- AppCategoryResponse|error - Related resource
apppreviewsetsApppreviewsGetToManyRelationship![](/images/permalink.svg)
function apppreviewsetsApppreviewsGetToManyRelationship(string id, int? 'limit) returns AppPreviewSetAppPreviewsLinkagesResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- AppPreviewSetAppPreviewsLinkagesResponse|error - List of related linkages
apppreviewsetsApppreviewsReplaceToManyRelationship![](/images/permalink.svg)
function apppreviewsetsApppreviewsReplaceToManyRelationship(string id, AppPreviewSetAppPreviewsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload AppPreviewSetAppPreviewsLinkagesRequest - List of related linkages
apppreviewsetsApppreviewsGetToManyRelated![](/images/permalink.svg)
function apppreviewsetsApppreviewsGetToManyRelated(string id, string[]? fieldsApppreviews, string[]? fieldsApppreviewsets, int? 'limit, string[]? include) returns AppPreviewsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApppreviews string[]? (default ()) - the fields to include for returned resources of type appPreviews
- fieldsApppreviewsets string[]? (default ()) - the fields to include for returned resources of type appPreviewSets
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppPreviewsResponse|error - List of related resources
apppricepointsTerritoryGetToOneRelated![](/images/permalink.svg)
function apppricepointsTerritoryGetToOneRelated(string id, string[]? fieldsTerritories) returns TerritoryResponse|error
Parameters
- id string - the id of the requested resource
- fieldsTerritories string[]? (default ()) - the fields to include for returned resources of type territories
Return Type
- TerritoryResponse|error - Related resource
apppricetiersPricepointsGetToManyRelated![](/images/permalink.svg)
function apppricetiersPricepointsGetToManyRelated(string id, string[]? fieldsApppricepoints, int? 'limit) returns AppPricePointsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApppricepoints string[]? (default ()) - the fields to include for returned resources of type appPricePoints
- 'limit int? (default ()) - maximum resources per page
Return Type
- AppPricePointsResponse|error - List of related resources
appscreenshotsetsAppscreenshotsGetToManyRelationship![](/images/permalink.svg)
function appscreenshotsetsAppscreenshotsGetToManyRelationship(string id, int? 'limit) returns AppScreenshotSetAppScreenshotsLinkagesResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- AppScreenshotSetAppScreenshotsLinkagesResponse|error - List of related linkages
appscreenshotsetsAppscreenshotsReplaceToManyRelationship![](/images/permalink.svg)
function appscreenshotsetsAppscreenshotsReplaceToManyRelationship(string id, AppScreenshotSetAppScreenshotsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload AppScreenshotSetAppScreenshotsLinkagesRequest - List of related linkages
appscreenshotsetsAppscreenshotsGetToManyRelated![](/images/permalink.svg)
function appscreenshotsetsAppscreenshotsGetToManyRelated(string id, string[]? fieldsAppscreenshotsets, string[]? fieldsAppscreenshots, int? 'limit, string[]? include) returns AppScreenshotsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppscreenshotsets string[]? (default ()) - the fields to include for returned resources of type appScreenshotSets
- fieldsAppscreenshots string[]? (default ()) - the fields to include for returned resources of type appScreenshots
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppScreenshotsResponse|error - List of related resources
appstorereviewdetailsAppstorereviewattachmentsGetToManyRelated![](/images/permalink.svg)
function appstorereviewdetailsAppstorereviewattachmentsGetToManyRelated(string id, string[]? fieldsAppstorereviewdetails, string[]? fieldsAppstorereviewattachments, int? 'limit, string[]? include) returns AppStoreReviewAttachmentsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppstorereviewdetails string[]? (default ()) - the fields to include for returned resources of type appStoreReviewDetails
- fieldsAppstorereviewattachments string[]? (default ()) - the fields to include for returned resources of type appStoreReviewAttachments
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppStoreReviewAttachmentsResponse|error - List of related resources
appstoreversionlocalizationsApppreviewsetsGetToManyRelated![](/images/permalink.svg)
function appstoreversionlocalizationsApppreviewsetsGetToManyRelated(string id, string[]? filterPreviewtype, string[]? fieldsAppstoreversionlocalizations, string[]? fieldsApppreviews, string[]? fieldsApppreviewsets, int? 'limit, string[]? include) returns AppPreviewSetsResponse|error
Parameters
- id string - the id of the requested resource
- filterPreviewtype string[]? (default ()) - filter by attribute 'previewType'
- fieldsAppstoreversionlocalizations string[]? (default ()) - the fields to include for returned resources of type appStoreVersionLocalizations
- fieldsApppreviews string[]? (default ()) - the fields to include for returned resources of type appPreviews
- fieldsApppreviewsets string[]? (default ()) - the fields to include for returned resources of type appPreviewSets
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppPreviewSetsResponse|error - List of related resources
appstoreversionlocalizationsAppscreenshotsetsGetToManyRelated![](/images/permalink.svg)
function appstoreversionlocalizationsAppscreenshotsetsGetToManyRelated(string id, string[]? filterScreenshotdisplaytype, string[]? fieldsAppstoreversionlocalizations, string[]? fieldsAppscreenshotsets, string[]? fieldsAppscreenshots, int? 'limit, string[]? include) returns AppScreenshotSetsResponse|error
Parameters
- id string - the id of the requested resource
- filterScreenshotdisplaytype string[]? (default ()) - filter by attribute 'screenshotDisplayType'
- fieldsAppstoreversionlocalizations string[]? (default ()) - the fields to include for returned resources of type appStoreVersionLocalizations
- fieldsAppscreenshotsets string[]? (default ()) - the fields to include for returned resources of type appScreenshotSets
- fieldsAppscreenshots string[]? (default ()) - the fields to include for returned resources of type appScreenshots
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppScreenshotSetsResponse|error - List of related resources
appstoreversionsAgeratingdeclarationGetToOneRelated![](/images/permalink.svg)
function appstoreversionsAgeratingdeclarationGetToOneRelated(string id, string[]? fieldsAgeratingdeclarations) returns AgeRatingDeclarationResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAgeratingdeclarations string[]? (default ()) - the fields to include for returned resources of type ageRatingDeclarations
Deprecated parameters
Return Type
- AgeRatingDeclarationResponse|error - Related resource
Deprecated
appstoreversionsAppstorereviewdetailGetToOneRelated![](/images/permalink.svg)
function appstoreversionsAppstorereviewdetailGetToOneRelated(string id, string[]? fieldsAppstorereviewdetails, string[]? fieldsAppstoreversions, string[]? fieldsAppstorereviewattachments, string[]? include) returns AppStoreReviewDetailResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppstorereviewdetails string[]? (default ()) - the fields to include for returned resources of type appStoreReviewDetails
- fieldsAppstoreversions string[]? (default ()) - the fields to include for returned resources of type appStoreVersions
- fieldsAppstorereviewattachments string[]? (default ()) - the fields to include for returned resources of type appStoreReviewAttachments
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppStoreReviewDetailResponse|error - Related resource
appstoreversionsAppstoreversionlocalizationsGetToManyRelated![](/images/permalink.svg)
function appstoreversionsAppstoreversionlocalizationsGetToManyRelated(string id, string[]? fieldsAppstoreversionlocalizations, int? 'limit) returns AppStoreVersionLocalizationsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppstoreversionlocalizations string[]? (default ()) - the fields to include for returned resources of type appStoreVersionLocalizations
- 'limit int? (default ()) - maximum resources per page
Return Type
- AppStoreVersionLocalizationsResponse|error - List of related resources
appstoreversionsAppstoreversionphasedreleaseGetToOneRelated![](/images/permalink.svg)
function appstoreversionsAppstoreversionphasedreleaseGetToOneRelated(string id, string[]? fieldsAppstoreversionphasedreleases) returns AppStoreVersionPhasedReleaseResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppstoreversionphasedreleases string[]? (default ()) - the fields to include for returned resources of type appStoreVersionPhasedReleases
Return Type
- AppStoreVersionPhasedReleaseResponse|error - Related resource
appstoreversionsAppstoreversionsubmissionGetToOneRelated![](/images/permalink.svg)
function appstoreversionsAppstoreversionsubmissionGetToOneRelated(string id, string[]? fieldsAppstoreversions, string[]? fieldsAppstoreversionsubmissions, string[]? include) returns AppStoreVersionSubmissionResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppstoreversions string[]? (default ()) - the fields to include for returned resources of type appStoreVersions
- fieldsAppstoreversionsubmissions string[]? (default ()) - the fields to include for returned resources of type appStoreVersionSubmissions
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppStoreVersionSubmissionResponse|error - Related resource
appstoreversionsBuildGetToOneRelationship![](/images/permalink.svg)
function appstoreversionsBuildGetToOneRelationship(string id) returns AppStoreVersionBuildLinkageResponse|error
Parameters
- id string - the id of the requested resource
Return Type
- AppStoreVersionBuildLinkageResponse|error - Related linkage
appstoreversionsBuildUpdateToOneRelationship![](/images/permalink.svg)
function appstoreversionsBuildUpdateToOneRelationship(string id, AppStoreVersionBuildLinkageRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload AppStoreVersionBuildLinkageRequest - Related linkage
appstoreversionsBuildGetToOneRelated![](/images/permalink.svg)
function appstoreversionsBuildGetToOneRelated(string id, string[]? fieldsBuilds) returns BuildResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
Return Type
- BuildResponse|error - Related resource
appstoreversionsIdfadeclarationGetToOneRelated![](/images/permalink.svg)
function appstoreversionsIdfadeclarationGetToOneRelated(string id, string[]? fieldsIdfadeclarations) returns IdfaDeclarationResponse|error
Parameters
- id string - the id of the requested resource
- fieldsIdfadeclarations string[]? (default ()) - the fields to include for returned resources of type idfaDeclarations
Return Type
- IdfaDeclarationResponse|error - Related resource
appstoreversionsRoutingappcoverageGetToOneRelated![](/images/permalink.svg)
function appstoreversionsRoutingappcoverageGetToOneRelated(string id, string[]? fieldsRoutingappcoverages) returns RoutingAppCoverageResponse|error
Parameters
- id string - the id of the requested resource
- fieldsRoutingappcoverages string[]? (default ()) - the fields to include for returned resources of type routingAppCoverages
Return Type
- RoutingAppCoverageResponse|error - Related resource
appsAppinfosGetToManyRelated![](/images/permalink.svg)
function appsAppinfosGetToManyRelated(string id, string[]? fieldsAgeratingdeclarations, string[]? fieldsAppinfos, string[]? fieldsAppcategories, string[]? fieldsAppinfolocalizations, string[]? fieldsApps, int? 'limit, string[]? include) returns AppInfosResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAgeratingdeclarations string[]? (default ()) - the fields to include for returned resources of type ageRatingDeclarations
- fieldsAppinfos string[]? (default ()) - the fields to include for returned resources of type appInfos
- fieldsAppcategories string[]? (default ()) - the fields to include for returned resources of type appCategories
- fieldsAppinfolocalizations string[]? (default ()) - the fields to include for returned resources of type appInfoLocalizations
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppInfosResponse|error - List of related resources
appsAppstoreversionsGetToManyRelated![](/images/permalink.svg)
function appsAppstoreversionsGetToManyRelated(string id, string[]? filterAppstorestate, string[]? filterPlatform, string[]? filterVersionstring, string[]? filterId, string[]? fieldsIdfadeclarations, string[]? fieldsAppstoreversionlocalizations, string[]? fieldsRoutingappcoverages, string[]? fieldsAppstoreversionphasedreleases, string[]? fieldsAgeratingdeclarations, string[]? fieldsAppstorereviewdetails, string[]? fieldsAppstoreversions, string[]? fieldsBuilds, string[]? fieldsAppstoreversionsubmissions, string[]? fieldsApps, int? 'limit, string[]? include) returns AppStoreVersionsResponse|error
Parameters
- id string - the id of the requested resource
- filterAppstorestate string[]? (default ()) - filter by attribute 'appStoreState'
- filterPlatform string[]? (default ()) - filter by attribute 'platform'
- filterVersionstring string[]? (default ()) - filter by attribute 'versionString'
- filterId string[]? (default ()) - filter by id(s)
- fieldsIdfadeclarations string[]? (default ()) - the fields to include for returned resources of type idfaDeclarations
- fieldsAppstoreversionlocalizations string[]? (default ()) - the fields to include for returned resources of type appStoreVersionLocalizations
- fieldsRoutingappcoverages string[]? (default ()) - the fields to include for returned resources of type routingAppCoverages
- fieldsAppstoreversionphasedreleases string[]? (default ()) - the fields to include for returned resources of type appStoreVersionPhasedReleases
- fieldsAgeratingdeclarations string[]? (default ()) - the fields to include for returned resources of type ageRatingDeclarations
- fieldsAppstorereviewdetails string[]? (default ()) - the fields to include for returned resources of type appStoreReviewDetails
- fieldsAppstoreversions string[]? (default ()) - the fields to include for returned resources of type appStoreVersions
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- fieldsAppstoreversionsubmissions string[]? (default ()) - the fields to include for returned resources of type appStoreVersionSubmissions
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppStoreVersionsResponse|error - List of related resources
appsAvailableterritoriesGetToManyRelated![](/images/permalink.svg)
function appsAvailableterritoriesGetToManyRelated(string id, string[]? fieldsTerritories, int? 'limit) returns TerritoriesResponse|error
Parameters
- id string - the id of the requested resource
- fieldsTerritories string[]? (default ()) - the fields to include for returned resources of type territories
- 'limit int? (default ()) - maximum resources per page
Return Type
- TerritoriesResponse|error - List of related resources
appsBetaapplocalizationsGetToManyRelated![](/images/permalink.svg)
function appsBetaapplocalizationsGetToManyRelated(string id, string[]? fieldsBetaapplocalizations, int? 'limit) returns BetaAppLocalizationsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetaapplocalizations string[]? (default ()) - the fields to include for returned resources of type betaAppLocalizations
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaAppLocalizationsResponse|error - List of related resources
appsBetaappreviewdetailGetToOneRelated![](/images/permalink.svg)
function appsBetaappreviewdetailGetToOneRelated(string id, string[]? fieldsBetaappreviewdetails) returns BetaAppReviewDetailResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetaappreviewdetails string[]? (default ()) - the fields to include for returned resources of type betaAppReviewDetails
Return Type
- BetaAppReviewDetailResponse|error - Related resource
appsBetagroupsGetToManyRelated![](/images/permalink.svg)
function appsBetagroupsGetToManyRelated(string id, string[]? fieldsBetagroups, int? 'limit) returns BetaGroupsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetagroups string[]? (default ()) - the fields to include for returned resources of type betaGroups
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaGroupsResponse|error - List of related resources
appsBetalicenseagreementGetToOneRelated![](/images/permalink.svg)
function appsBetalicenseagreementGetToOneRelated(string id, string[]? fieldsBetalicenseagreements) returns BetaLicenseAgreementResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetalicenseagreements string[]? (default ()) - the fields to include for returned resources of type betaLicenseAgreements
Return Type
- BetaLicenseAgreementResponse|error - Related resource
appsBetatestersDeleteToManyRelationship![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
appsBuildsGetToManyRelated![](/images/permalink.svg)
function appsBuildsGetToManyRelated(string id, string[]? fieldsBuilds, int? 'limit) returns BuildsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- 'limit int? (default ()) - maximum resources per page
Return Type
- BuildsResponse|error - List of related resources
appsEnduserlicenseagreementGetToOneRelated![](/images/permalink.svg)
function appsEnduserlicenseagreementGetToOneRelated(string id, string[]? fieldsEnduserlicenseagreements) returns EndUserLicenseAgreementResponse|error
Parameters
- id string - the id of the requested resource
- fieldsEnduserlicenseagreements string[]? (default ()) - the fields to include for returned resources of type endUserLicenseAgreements
Return Type
- EndUserLicenseAgreementResponse|error - Related resource
appsGamecenterenabledversionsGetToManyRelated![](/images/permalink.svg)
function appsGamecenterenabledversionsGetToManyRelated(string id, string[]? filterPlatform, string[]? filterVersionstring, string[]? filterId, string[]? sort, string[]? fieldsGamecenterenabledversions, string[]? fieldsApps, int? 'limit, string[]? include) returns GameCenterEnabledVersionsResponse|error
Parameters
- id string - the id of the requested resource
- filterPlatform string[]? (default ()) - filter by attribute 'platform'
- filterVersionstring string[]? (default ()) - filter by attribute 'versionString'
- filterId string[]? (default ()) - filter by id(s)
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsGamecenterenabledversions string[]? (default ()) - the fields to include for returned resources of type gameCenterEnabledVersions
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- GameCenterEnabledVersionsResponse|error - List of related resources
appsInapppurchasesGetToManyRelated![](/images/permalink.svg)
function appsInapppurchasesGetToManyRelated(string id, string[]? filterInapppurchasetype, string[]? filterCanbesubmitted, string[]? sort, string[]? fieldsInapppurchases, string[]? fieldsApps, int? 'limit, string[]? include) returns InAppPurchasesResponse|error
Parameters
- id string - the id of the requested resource
- filterInapppurchasetype string[]? (default ()) - filter by attribute 'inAppPurchaseType'
- filterCanbesubmitted string[]? (default ()) - filter by canBeSubmitted
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsInapppurchases string[]? (default ()) - the fields to include for returned resources of type inAppPurchases
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- InAppPurchasesResponse|error - List of related resources
appsPerfpowermetricsGetToManyRelated![](/images/permalink.svg)
function appsPerfpowermetricsGetToManyRelated(string id, string[]? filterDevicetype, string[]? filterMetrictype, string[]? filterPlatform) returns PerfPowerMetricsResponse|error
Parameters
- id string - the id of the requested resource
- filterDevicetype string[]? (default ()) - filter by attribute 'deviceType'
- filterMetrictype string[]? (default ()) - filter by attribute 'metricType'
- filterPlatform string[]? (default ()) - filter by attribute 'platform'
Return Type
- PerfPowerMetricsResponse|error - List of related resources
appsPreorderGetToOneRelated![](/images/permalink.svg)
function appsPreorderGetToOneRelated(string id, string[]? fieldsApppreorders) returns AppPreOrderResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApppreorders string[]? (default ()) - the fields to include for returned resources of type appPreOrders
Return Type
- AppPreOrderResponse|error - Related resource
appsPrereleaseversionsGetToManyRelated![](/images/permalink.svg)
function appsPrereleaseversionsGetToManyRelated(string id, string[]? fieldsPrereleaseversions, int? 'limit) returns PreReleaseVersionsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsPrereleaseversions string[]? (default ()) - the fields to include for returned resources of type preReleaseVersions
- 'limit int? (default ()) - maximum resources per page
Return Type
- PreReleaseVersionsResponse|error - List of related resources
appsPricesGetToManyRelated![](/images/permalink.svg)
function appsPricesGetToManyRelated(string id, string[]? fieldsAppprices, string[]? fieldsApppricetiers, string[]? fieldsApps, int? 'limit, string[]? include) returns AppPricesResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppprices string[]? (default ()) - the fields to include for returned resources of type appPrices
- fieldsApppricetiers string[]? (default ()) - the fields to include for returned resources of type appPriceTiers
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- AppPricesResponse|error - List of related resources
betaapplocalizationsAppGetToOneRelated![](/images/permalink.svg)
function betaapplocalizationsAppGetToOneRelated(string id, string[]? fieldsApps) returns AppResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- AppResponse|error - Related resource
betaappreviewdetailsAppGetToOneRelated![](/images/permalink.svg)
function betaappreviewdetailsAppGetToOneRelated(string id, string[]? fieldsApps) returns AppResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- AppResponse|error - Related resource
betaappreviewsubmissionsBuildGetToOneRelated![](/images/permalink.svg)
function betaappreviewsubmissionsBuildGetToOneRelated(string id, string[]? fieldsBuilds) returns BuildResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
Return Type
- BuildResponse|error - Related resource
betabuildlocalizationsBuildGetToOneRelated![](/images/permalink.svg)
function betabuildlocalizationsBuildGetToOneRelated(string id, string[]? fieldsBuilds) returns BuildResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
Return Type
- BuildResponse|error - Related resource
betagroupsAppGetToOneRelated![](/images/permalink.svg)
function betagroupsAppGetToOneRelated(string id, string[]? fieldsApps) returns AppResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- AppResponse|error - Related resource
betagroupsBetatestersGetToManyRelationship![](/images/permalink.svg)
function betagroupsBetatestersGetToManyRelationship(string id, int? 'limit) returns BetaGroupBetaTestersLinkagesResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaGroupBetaTestersLinkagesResponse|error - List of related linkages
betagroupsBetatestersCreateToManyRelationship![](/images/permalink.svg)
function betagroupsBetatestersCreateToManyRelationship(string id, BetaGroupBetaTestersLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload BetaGroupBetaTestersLinkagesRequest - List of related linkages
betagroupsBetatestersDeleteToManyRelationship![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
betagroupsBetatestersGetToManyRelated![](/images/permalink.svg)
function betagroupsBetatestersGetToManyRelated(string id, string[]? fieldsBetatesters, int? 'limit) returns BetaTestersResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetatesters string[]? (default ()) - the fields to include for returned resources of type betaTesters
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaTestersResponse|error - List of related resources
betagroupsBuildsGetToManyRelationship![](/images/permalink.svg)
function betagroupsBuildsGetToManyRelationship(string id, int? 'limit) returns BetaGroupBuildsLinkagesResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaGroupBuildsLinkagesResponse|error - List of related linkages
betagroupsBuildsCreateToManyRelationship![](/images/permalink.svg)
function betagroupsBuildsCreateToManyRelationship(string id, BetaGroupBuildsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload BetaGroupBuildsLinkagesRequest - List of related linkages
betagroupsBuildsDeleteToManyRelationship![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
betagroupsBuildsGetToManyRelated![](/images/permalink.svg)
function betagroupsBuildsGetToManyRelated(string id, string[]? fieldsBuilds, int? 'limit) returns BuildsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- 'limit int? (default ()) - maximum resources per page
Return Type
- BuildsResponse|error - List of related resources
betalicenseagreementsAppGetToOneRelated![](/images/permalink.svg)
function betalicenseagreementsAppGetToOneRelated(string id, string[]? fieldsApps) returns AppResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- AppResponse|error - Related resource
betatestersAppsGetToManyRelationship![](/images/permalink.svg)
function betatestersAppsGetToManyRelationship(string id, int? 'limit) returns BetaTesterAppsLinkagesResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaTesterAppsLinkagesResponse|error - List of related linkages
betatestersAppsDeleteToManyRelationship![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
betatestersAppsGetToManyRelated![](/images/permalink.svg)
function betatestersAppsGetToManyRelated(string id, string[]? fieldsApps, int? 'limit) returns AppsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- 'limit int? (default ()) - maximum resources per page
Return Type
- AppsResponse|error - List of related resources
betatestersBetagroupsGetToManyRelationship![](/images/permalink.svg)
function betatestersBetagroupsGetToManyRelationship(string id, int? 'limit) returns BetaTesterBetaGroupsLinkagesResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaTesterBetaGroupsLinkagesResponse|error - List of related linkages
betatestersBetagroupsCreateToManyRelationship![](/images/permalink.svg)
function betatestersBetagroupsCreateToManyRelationship(string id, BetaTesterBetaGroupsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload BetaTesterBetaGroupsLinkagesRequest - List of related linkages
betatestersBetagroupsDeleteToManyRelationship![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
betatestersBetagroupsGetToManyRelated![](/images/permalink.svg)
function betatestersBetagroupsGetToManyRelated(string id, string[]? fieldsBetagroups, int? 'limit) returns BetaGroupsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetagroups string[]? (default ()) - the fields to include for returned resources of type betaGroups
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaGroupsResponse|error - List of related resources
betatestersBuildsGetToManyRelationship![](/images/permalink.svg)
function betatestersBuildsGetToManyRelationship(string id, int? 'limit) returns BetaTesterBuildsLinkagesResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaTesterBuildsLinkagesResponse|error - List of related linkages
betatestersBuildsCreateToManyRelationship![](/images/permalink.svg)
function betatestersBuildsCreateToManyRelationship(string id, BetaTesterBuildsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload BetaTesterBuildsLinkagesRequest - List of related linkages
betatestersBuildsDeleteToManyRelationship![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
betatestersBuildsGetToManyRelated![](/images/permalink.svg)
function betatestersBuildsGetToManyRelated(string id, string[]? fieldsBuilds, int? 'limit) returns BuildsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- 'limit int? (default ()) - maximum resources per page
Return Type
- BuildsResponse|error - List of related resources
buildbetadetailsBuildGetToOneRelated![](/images/permalink.svg)
function buildbetadetailsBuildGetToOneRelated(string id, string[]? fieldsBuilds) returns BuildResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
Return Type
- BuildResponse|error - Related resource
buildsAppGetToOneRelated![](/images/permalink.svg)
function buildsAppGetToOneRelated(string id, string[]? fieldsApps) returns AppResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- AppResponse|error - Related resource
buildsAppencryptiondeclarationGetToOneRelationship![](/images/permalink.svg)
function buildsAppencryptiondeclarationGetToOneRelationship(string id) returns BuildAppEncryptionDeclarationLinkageResponse|error
Parameters
- id string - the id of the requested resource
Return Type
- BuildAppEncryptionDeclarationLinkageResponse|error - Related linkage
buildsAppencryptiondeclarationUpdateToOneRelationship![](/images/permalink.svg)
function buildsAppencryptiondeclarationUpdateToOneRelationship(string id, BuildAppEncryptionDeclarationLinkageRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload BuildAppEncryptionDeclarationLinkageRequest - Related linkage
buildsAppencryptiondeclarationGetToOneRelated![](/images/permalink.svg)
function buildsAppencryptiondeclarationGetToOneRelated(string id, string[]? fieldsAppencryptiondeclarations) returns AppEncryptionDeclarationResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppencryptiondeclarations string[]? (default ()) - the fields to include for returned resources of type appEncryptionDeclarations
Return Type
- AppEncryptionDeclarationResponse|error - Related resource
buildsAppstoreversionGetToOneRelated![](/images/permalink.svg)
function buildsAppstoreversionGetToOneRelated(string id, string[]? fieldsAppstoreversions) returns AppStoreVersionResponse|error
Parameters
- id string - the id of the requested resource
- fieldsAppstoreversions string[]? (default ()) - the fields to include for returned resources of type appStoreVersions
Return Type
- AppStoreVersionResponse|error - Related resource
buildsBetaappreviewsubmissionGetToOneRelated![](/images/permalink.svg)
function buildsBetaappreviewsubmissionGetToOneRelated(string id, string[]? fieldsBetaappreviewsubmissions) returns BetaAppReviewSubmissionResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetaappreviewsubmissions string[]? (default ()) - the fields to include for returned resources of type betaAppReviewSubmissions
Return Type
- BetaAppReviewSubmissionResponse|error - Related resource
buildsBetabuildlocalizationsGetToManyRelated![](/images/permalink.svg)
function buildsBetabuildlocalizationsGetToManyRelated(string id, string[]? fieldsBetabuildlocalizations, int? 'limit) returns BetaBuildLocalizationsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetabuildlocalizations string[]? (default ()) - the fields to include for returned resources of type betaBuildLocalizations
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaBuildLocalizationsResponse|error - List of related resources
buildsBetagroupsCreateToManyRelationship![](/images/permalink.svg)
function buildsBetagroupsCreateToManyRelationship(string id, BuildBetaGroupsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload BuildBetaGroupsLinkagesRequest - List of related linkages
buildsBetagroupsDeleteToManyRelationship![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
buildsBuildbetadetailGetToOneRelated![](/images/permalink.svg)
function buildsBuildbetadetailGetToOneRelated(string id, string[]? fieldsBuildbetadetails) returns BuildBetaDetailResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuildbetadetails string[]? (default ()) - the fields to include for returned resources of type buildBetaDetails
Return Type
- BuildBetaDetailResponse|error - Related resource
buildsDiagnosticsignaturesGetToManyRelated![](/images/permalink.svg)
function buildsDiagnosticsignaturesGetToManyRelated(string id, string[]? filterDiagnostictype, string[]? fieldsDiagnosticsignatures, int? 'limit) returns DiagnosticSignaturesResponse|error
Parameters
- id string - the id of the requested resource
- filterDiagnostictype string[]? (default ()) - filter by attribute 'diagnosticType'
- fieldsDiagnosticsignatures string[]? (default ()) - the fields to include for returned resources of type diagnosticSignatures
- 'limit int? (default ()) - maximum resources per page
Return Type
- DiagnosticSignaturesResponse|error - List of related resources
buildsIconsGetToManyRelated![](/images/permalink.svg)
function buildsIconsGetToManyRelated(string id, string[]? fieldsBuildicons, int? 'limit) returns BuildIconsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuildicons string[]? (default ()) - the fields to include for returned resources of type buildIcons
- 'limit int? (default ()) - maximum resources per page
Return Type
- BuildIconsResponse|error - List of related resources
buildsIndividualtestersGetToManyRelationship![](/images/permalink.svg)
function buildsIndividualtestersGetToManyRelationship(string id, int? 'limit) returns BuildIndividualTestersLinkagesResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- BuildIndividualTestersLinkagesResponse|error - List of related linkages
buildsIndividualtestersCreateToManyRelationship![](/images/permalink.svg)
function buildsIndividualtestersCreateToManyRelationship(string id, BuildIndividualTestersLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload BuildIndividualTestersLinkagesRequest - List of related linkages
buildsIndividualtestersDeleteToManyRelationship![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
buildsIndividualtestersGetToManyRelated![](/images/permalink.svg)
function buildsIndividualtestersGetToManyRelated(string id, string[]? fieldsBetatesters, int? 'limit) returns BetaTestersResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBetatesters string[]? (default ()) - the fields to include for returned resources of type betaTesters
- 'limit int? (default ()) - maximum resources per page
Return Type
- BetaTestersResponse|error - List of related resources
buildsPerfpowermetricsGetToManyRelated![](/images/permalink.svg)
function buildsPerfpowermetricsGetToManyRelated(string id, string[]? filterDevicetype, string[]? filterMetrictype, string[]? filterPlatform) returns PerfPowerMetricsResponse|error
Parameters
- id string - the id of the requested resource
- filterDevicetype string[]? (default ()) - filter by attribute 'deviceType'
- filterMetrictype string[]? (default ()) - filter by attribute 'metricType'
- filterPlatform string[]? (default ()) - filter by attribute 'platform'
Return Type
- PerfPowerMetricsResponse|error - List of related resources
buildsPrereleaseversionGetToOneRelated![](/images/permalink.svg)
function buildsPrereleaseversionGetToOneRelated(string id, string[]? fieldsPrereleaseversions) returns PrereleaseVersionResponse|error
Parameters
- id string - the id of the requested resource
- fieldsPrereleaseversions string[]? (default ()) - the fields to include for returned resources of type preReleaseVersions
Return Type
- PrereleaseVersionResponse|error - Related resource
bundleidsAppGetToOneRelated![](/images/permalink.svg)
function bundleidsAppGetToOneRelated(string id, string[]? fieldsApps) returns AppResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- AppResponse|error - Related resource
bundleidsBundleidcapabilitiesGetToManyRelated![](/images/permalink.svg)
function bundleidsBundleidcapabilitiesGetToManyRelated(string id, string[]? fieldsBundleidcapabilities, int? 'limit) returns BundleIdCapabilitiesResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBundleidcapabilities string[]? (default ()) - the fields to include for returned resources of type bundleIdCapabilities
- 'limit int? (default ()) - maximum resources per page
Return Type
- BundleIdCapabilitiesResponse|error - List of related resources
bundleidsProfilesGetToManyRelated![](/images/permalink.svg)
function bundleidsProfilesGetToManyRelated(string id, string[]? fieldsProfiles, int? 'limit) returns ProfilesResponse|error
Parameters
- id string - the id of the requested resource
- fieldsProfiles string[]? (default ()) - the fields to include for returned resources of type profiles
- 'limit int? (default ()) - maximum resources per page
Return Type
- ProfilesResponse|error - List of related resources
diagnosticsignaturesLogsGetToManyRelated![](/images/permalink.svg)
function diagnosticsignaturesLogsGetToManyRelated(string id, int? 'limit) returns DiagnosticLogsResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- DiagnosticLogsResponse|error - List of related resources
enduserlicenseagreementsTerritoriesGetToManyRelated![](/images/permalink.svg)
function enduserlicenseagreementsTerritoriesGetToManyRelated(string id, string[]? fieldsTerritories, int? 'limit) returns TerritoriesResponse|error
Parameters
- id string - the id of the requested resource
- fieldsTerritories string[]? (default ()) - the fields to include for returned resources of type territories
- 'limit int? (default ()) - maximum resources per page
Return Type
- TerritoriesResponse|error - List of related resources
gamecenterenabledversionsCompatibleversionsGetToManyRelationship![](/images/permalink.svg)
function gamecenterenabledversionsCompatibleversionsGetToManyRelationship(string id, int? 'limit) returns GameCenterEnabledVersionCompatibleVersionsLinkagesResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- GameCenterEnabledVersionCompatibleVersionsLinkagesResponse|error - List of related linkages
gamecenterenabledversionsCompatibleversionsCreateToManyRelationship![](/images/permalink.svg)
function gamecenterenabledversionsCompatibleversionsCreateToManyRelationship(string id, GameCenterEnabledVersionCompatibleVersionsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload GameCenterEnabledVersionCompatibleVersionsLinkagesRequest - List of related linkages
gamecenterenabledversionsCompatibleversionsDeleteToManyRelationship![](/images/permalink.svg)
function gamecenterenabledversionsCompatibleversionsDeleteToManyRelationship(string id) returns Response|error
Parameters
- id string - the id of the requested resource
gamecenterenabledversionsCompatibleversionsReplaceToManyRelationship![](/images/permalink.svg)
function gamecenterenabledversionsCompatibleversionsReplaceToManyRelationship(string id, GameCenterEnabledVersionCompatibleVersionsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload GameCenterEnabledVersionCompatibleVersionsLinkagesRequest - List of related linkages
gamecenterenabledversionsCompatibleversionsGetToManyRelated![](/images/permalink.svg)
function gamecenterenabledversionsCompatibleversionsGetToManyRelated(string id, string[]? filterPlatform, string[]? filterVersionstring, string[]? filterApp, string[]? filterId, string[]? sort, string[]? fieldsGamecenterenabledversions, string[]? fieldsApps, int? 'limit, string[]? include) returns GameCenterEnabledVersionsResponse|error
Parameters
- id string - the id of the requested resource
- filterPlatform string[]? (default ()) - filter by attribute 'platform'
- filterVersionstring string[]? (default ()) - filter by attribute 'versionString'
- filterApp string[]? (default ()) - filter by id(s) of related 'app'
- filterId string[]? (default ()) - filter by id(s)
- sort string[]? (default ()) - comma-separated list of sort expressions; resources will be sorted as specified
- fieldsGamecenterenabledversions string[]? (default ()) - the fields to include for returned resources of type gameCenterEnabledVersions
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- 'limit int? (default ()) - maximum resources per page
- include string[]? (default ()) - comma-separated list of relationships to include
Return Type
- GameCenterEnabledVersionsResponse|error - List of related resources
prereleaseversionsAppGetToOneRelated![](/images/permalink.svg)
function prereleaseversionsAppGetToOneRelated(string id, string[]? fieldsApps) returns AppResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
Return Type
- AppResponse|error - Related resource
prereleaseversionsBuildsGetToManyRelated![](/images/permalink.svg)
function prereleaseversionsBuildsGetToManyRelated(string id, string[]? fieldsBuilds, int? 'limit) returns BuildsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBuilds string[]? (default ()) - the fields to include for returned resources of type builds
- 'limit int? (default ()) - maximum resources per page
Return Type
- BuildsResponse|error - List of related resources
profilesBundleidGetToOneRelated![](/images/permalink.svg)
function profilesBundleidGetToOneRelated(string id, string[]? fieldsBundleids) returns BundleIdResponse|error
Parameters
- id string - the id of the requested resource
- fieldsBundleids string[]? (default ()) - the fields to include for returned resources of type bundleIds
Return Type
- BundleIdResponse|error - Related resource
profilesCertificatesGetToManyRelated![](/images/permalink.svg)
function profilesCertificatesGetToManyRelated(string id, string[]? fieldsCertificates, int? 'limit) returns CertificatesResponse|error
Parameters
- id string - the id of the requested resource
- fieldsCertificates string[]? (default ()) - the fields to include for returned resources of type certificates
- 'limit int? (default ()) - maximum resources per page
Return Type
- CertificatesResponse|error - List of related resources
profilesDevicesGetToManyRelated![](/images/permalink.svg)
function profilesDevicesGetToManyRelated(string id, string[]? fieldsDevices, int? 'limit) returns DevicesResponse|error
Parameters
- id string - the id of the requested resource
- fieldsDevices string[]? (default ()) - the fields to include for returned resources of type devices
- 'limit int? (default ()) - maximum resources per page
Return Type
- DevicesResponse|error - List of related resources
userinvitationsVisibleappsGetToManyRelated![](/images/permalink.svg)
function userinvitationsVisibleappsGetToManyRelated(string id, string[]? fieldsApps, int? 'limit) returns AppsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- 'limit int? (default ()) - maximum resources per page
Return Type
- AppsResponse|error - List of related resources
usersVisibleappsGetToManyRelationship![](/images/permalink.svg)
function usersVisibleappsGetToManyRelationship(string id, int? 'limit) returns UserVisibleAppsLinkagesResponse|error
Parameters
- id string - the id of the requested resource
- 'limit int? (default ()) - maximum resources per page
Return Type
- UserVisibleAppsLinkagesResponse|error - List of related linkages
usersVisibleappsCreateToManyRelationship![](/images/permalink.svg)
function usersVisibleappsCreateToManyRelationship(string id, UserVisibleAppsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload UserVisibleAppsLinkagesRequest - List of related linkages
usersVisibleappsDeleteToManyRelationship![](/images/permalink.svg)
Parameters
- id string - the id of the requested resource
usersVisibleappsReplaceToManyRelationship![](/images/permalink.svg)
function usersVisibleappsReplaceToManyRelationship(string id, UserVisibleAppsLinkagesRequest payload) returns Response|error
Parameters
- id string - the id of the requested resource
- payload UserVisibleAppsLinkagesRequest - List of related linkages
usersVisibleappsGetToManyRelated![](/images/permalink.svg)
function usersVisibleappsGetToManyRelated(string id, string[]? fieldsApps, int? 'limit) returns AppsResponse|error
Parameters
- id string - the id of the requested resource
- fieldsApps string[]? (default ()) - the fields to include for returned resources of type apps
- 'limit int? (default ()) - maximum resources per page
Return Type
- AppsResponse|error - List of related resources
Records![](/images/permalink.svg)
apple.appstore: AgeRatingDeclaration![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AgeratingdeclarationAttributes? -
- links ResourceLinks -
apple.appstore: AgeratingdeclarationAttributes![](/images/permalink.svg)
Fields
- alcoholTobaccoOrDrugUseOrReferences string? -
- contests string? -
- gamblingAndContests boolean? -
- gambling boolean? -
- gamblingSimulated string? -
- kidsAgeBand KidsAgeBand? -
- medicalOrTreatmentInformation string? -
- profanityOrCrudeHumor string? -
- sexualContentGraphicAndNudity string? -
- sexualContentOrNudity string? -
- seventeenPlus boolean? -
- horrorOrFearThemes string? -
- matureOrSuggestiveThemes string? -
- unrestrictedWebAccess boolean? -
- violenceCartoonOrFantasy string? -
- violenceRealisticProlongedGraphicOrSadistic string? -
- violenceRealistic string? -
apple.appstore: AgeRatingDeclarationResponse![](/images/permalink.svg)
Fields
- data AgeRatingDeclaration -
- links DocumentLinks -
apple.appstore: AgeRatingDeclarationUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: AgeratingdeclarationupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AgeratingdeclarationAttributes? -
apple.appstore: App![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppAttributes? -
- relationships AppRelationships? -
- links ResourceLinks -
apple.appstore: AppAttributes![](/images/permalink.svg)
Fields
- name string? -
- bundleId string? -
- sku string? -
- primaryLocale string? -
- isOrEverWasMadeForKids boolean? -
- availableInNewTerritories boolean? -
- contentRightsDeclaration string? -
apple.appstore: AppBetaTestersLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: AppCategoriesResponse![](/images/permalink.svg)
Fields
- data AppCategory[] -
- included (AppCategory|AppCategory)[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppCategory![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppcategoryAttributes? -
- relationships AppcategoryRelationships? -
- links ResourceLinks -
apple.appstore: AppcategoryAttributes![](/images/permalink.svg)
Fields
- platforms Platform[]? -
apple.appstore: AppcategoryRelationships![](/images/permalink.svg)
Fields
- subcategories AppcategoryRelationshipsSubcategories? -
- parent AppcategoryRelationshipsParent? -
apple.appstore: AppcategoryRelationshipsParent![](/images/permalink.svg)
Fields
apple.appstore: AppcategoryRelationshipsSubcategories![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: AppcategoryRelationshipsSubcategoriesData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppcategoryRelationshipsSubcategoriesLinks![](/images/permalink.svg)
Fields
- self string? -
- related string? -
apple.appstore: AppCategoryResponse![](/images/permalink.svg)
Fields
- data AppCategory -
- included (AppCategory|AppCategory)[]? -
- links DocumentLinks -
apple.appstore: AppEncryptionDeclaration![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppencryptiondeclarationAttributes? -
- relationships AppencryptiondeclarationRelationships? -
- links ResourceLinks -
apple.appstore: AppencryptiondeclarationAttributes![](/images/permalink.svg)
Fields
- usesEncryption boolean? -
- exempt boolean? -
- containsProprietaryCryptography boolean? -
- containsThirdPartyCryptography boolean? -
- availableOnFrenchStore boolean? -
- platform Platform? -
- uploadedDate string? -
- documentUrl string? -
- documentName string? -
- documentType string? -
- appEncryptionDeclarationState AppEncryptionDeclarationState? -
- codeValue string? -
apple.appstore: AppEncryptionDeclarationBuildsLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: AppencryptiondeclarationRelationships![](/images/permalink.svg)
Fields
apple.appstore: AppencryptiondeclarationRelationshipsApp![](/images/permalink.svg)
Fields
apple.appstore: AppencryptiondeclarationRelationshipsAppData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppEncryptionDeclarationResponse![](/images/permalink.svg)
Fields
- data AppEncryptionDeclaration -
- included App[]? -
- links DocumentLinks -
apple.appstore: AppEncryptionDeclarationsResponse![](/images/permalink.svg)
Fields
- data AppEncryptionDeclaration[] -
- included App[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppInfo![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppinfoAttributes? -
- relationships AppinfoRelationships? -
- links ResourceLinks -
apple.appstore: AppinfoAttributes![](/images/permalink.svg)
Fields
- appStoreState AppStoreVersionState? -
- appStoreAgeRating AppStoreAgeRating? -
- brazilAgeRating BrazilAgeRating? -
- kidsAgeBand KidsAgeBand? -
apple.appstore: AppInfoLocalization![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppinfolocalizationAttributes? -
- relationships AppinfolocalizationRelationships? -
- links ResourceLinks -
apple.appstore: AppinfolocalizationAttributes![](/images/permalink.svg)
Fields
- locale string? -
- name string? -
- subtitle string? -
- privacyPolicyUrl string? -
- privacyPolicyText string? -
apple.appstore: AppInfoLocalizationCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppinfolocalizationcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes AppinfolocalizationcreaterequestDataAttributes -
- relationships AppinfolocalizationcreaterequestDataRelationships -
apple.appstore: AppinfolocalizationcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- locale string -
- name string? -
- subtitle string? -
- privacyPolicyUrl string? -
- privacyPolicyText string? -
apple.appstore: AppinfolocalizationcreaterequestDataRelationships![](/images/permalink.svg)
Fields
apple.appstore: AppinfolocalizationcreaterequestDataRelationshipsAppinfo![](/images/permalink.svg)
Fields
apple.appstore: AppinfolocalizationRelationships![](/images/permalink.svg)
Fields
- appInfo AppinfolocalizationRelationshipsAppinfo? -
apple.appstore: AppinfolocalizationRelationshipsAppinfo![](/images/permalink.svg)
Fields
apple.appstore: AppinfolocalizationRelationshipsAppinfoData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppInfoLocalizationResponse![](/images/permalink.svg)
Fields
- data AppInfoLocalization -
- links DocumentLinks -
apple.appstore: AppInfoLocalizationsResponse![](/images/permalink.svg)
Fields
- data AppInfoLocalization[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppInfoLocalizationUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppinfolocalizationupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppinfolocalizationupdaterequestDataAttributes? -
apple.appstore: AppinfolocalizationupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- name string? -
- subtitle string? -
- privacyPolicyUrl string? -
- privacyPolicyText string? -
apple.appstore: AppinfoRelationships![](/images/permalink.svg)
Fields
- ageRatingDeclaration AppinfoRelationshipsAgeratingdeclaration? -
- appInfoLocalizations AppinfoRelationshipsAppinfolocalizations? -
- primaryCategory AppcategoryRelationshipsParent? -
- primarySubcategoryOne AppcategoryRelationshipsParent? -
- primarySubcategoryTwo AppcategoryRelationshipsParent? -
- secondaryCategory AppcategoryRelationshipsParent? -
- secondarySubcategoryOne AppcategoryRelationshipsParent? -
- secondarySubcategoryTwo AppcategoryRelationshipsParent? -
apple.appstore: AppinfoRelationshipsAgeratingdeclaration![](/images/permalink.svg)
Fields
apple.appstore: AppinfoRelationshipsAgeratingdeclarationData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppinfoRelationshipsAppinfolocalizations![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: AppinfoRelationshipsAppinfolocalizationsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppInfoResponse![](/images/permalink.svg)
Fields
- data AppInfo -
- included (AppInfoLocalization|AppCategory|AppCategory|AppCategory|AppCategory|AppCategory|AppCategory)[]? -
- links DocumentLinks -
apple.appstore: AppInfosResponse![](/images/permalink.svg)
Fields
- data AppInfo[] -
- included (AppInfoLocalization|AppCategory|AppCategory|AppCategory|AppCategory|AppCategory|AppCategory)[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppInfoUpdateRequest![](/images/permalink.svg)
Fields
- data AppinfoupdaterequestData -
apple.appstore: AppinfoupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- relationships AppinfoupdaterequestDataRelationships? -
apple.appstore: AppinfoupdaterequestDataRelationships![](/images/permalink.svg)
Fields
- primaryCategory AppinfoupdaterequestDataRelationshipsPrimarycategory? -
- primarySubcategoryOne AppinfoupdaterequestDataRelationshipsPrimarycategory? -
- primarySubcategoryTwo AppinfoupdaterequestDataRelationshipsPrimarycategory? -
- secondaryCategory AppinfoupdaterequestDataRelationshipsPrimarycategory? -
- secondarySubcategoryOne AppinfoupdaterequestDataRelationshipsPrimarycategory? -
- secondarySubcategoryTwo AppinfoupdaterequestDataRelationshipsPrimarycategory? -
apple.appstore: AppinfoupdaterequestDataRelationshipsPrimarycategory![](/images/permalink.svg)
Fields
apple.appstore: AppMediaAssetState![](/images/permalink.svg)
Fields
- errors AppMediaStateError[]? -
- warnings AppMediaStateError[]? -
- state string? -
apple.appstore: AppMediaStateError![](/images/permalink.svg)
Fields
- code string? -
- description string? -
apple.appstore: AppPreOrder![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes ApppreorderAttributes? -
- relationships AppencryptiondeclarationRelationships? -
- links ResourceLinks -
apple.appstore: ApppreorderAttributes![](/images/permalink.svg)
Fields
- preOrderAvailableDate string? -
- appReleaseDate string? -
apple.appstore: AppPreOrderCreateRequest![](/images/permalink.svg)
Fields
- data ApppreordercreaterequestData -
apple.appstore: ApppreordercreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes ApppreordercreaterequestDataAttributes? -
- relationships ApppreordercreaterequestDataRelationships -
apple.appstore: ApppreordercreaterequestDataAttributes![](/images/permalink.svg)
Fields
- appReleaseDate string? -
apple.appstore: ApppreordercreaterequestDataRelationships![](/images/permalink.svg)
Fields
apple.appstore: ApppreordercreaterequestDataRelationshipsApp![](/images/permalink.svg)
Fields
apple.appstore: AppPreOrderResponse![](/images/permalink.svg)
Fields
- data AppPreOrder -
- links DocumentLinks -
apple.appstore: AppPreOrderUpdateRequest![](/images/permalink.svg)
Fields
- data ApppreorderupdaterequestData -
apple.appstore: ApppreorderupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes ApppreordercreaterequestDataAttributes? -
apple.appstore: AppPreview![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes ApppreviewAttributes? -
- relationships ApppreviewRelationships? -
- links ResourceLinks -
apple.appstore: ApppreviewAttributes![](/images/permalink.svg)
Fields
- fileSize int? -
- fileName string? -
- sourceFileChecksum string? -
- previewFrameTimeCode string? -
- mimeType string? -
- videoUrl string? -
- previewImage ImageAsset? -
- uploadOperations UploadOperation[]? -
- assetDeliveryState AppMediaAssetState? -
apple.appstore: AppPreviewCreateRequest![](/images/permalink.svg)
Fields
- data ApppreviewcreaterequestData -
apple.appstore: ApppreviewcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes ApppreviewcreaterequestDataAttributes -
- relationships ApppreviewcreaterequestDataRelationships -
apple.appstore: ApppreviewcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- fileSize int -
- fileName string -
- previewFrameTimeCode string? -
- mimeType string? -
apple.appstore: ApppreviewcreaterequestDataRelationships![](/images/permalink.svg)
Fields
- appPreviewSet ApppreviewcreaterequestDataRelationshipsApppreviewset -
apple.appstore: ApppreviewcreaterequestDataRelationshipsApppreviewset![](/images/permalink.svg)
Fields
apple.appstore: ApppreviewRelationships![](/images/permalink.svg)
Fields
- appPreviewSet ApppreviewRelationshipsApppreviewset? -
apple.appstore: ApppreviewRelationshipsApppreviewset![](/images/permalink.svg)
Fields
apple.appstore: ApppreviewRelationshipsApppreviewsetData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppPreviewResponse![](/images/permalink.svg)
Fields
- data AppPreview -
- links DocumentLinks -
apple.appstore: AppPreviewSet![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes ApppreviewsetAttributes? -
- relationships ApppreviewsetRelationships? -
- links ResourceLinks -
apple.appstore: AppPreviewSetAppPreviewsLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: AppPreviewSetAppPreviewsLinkagesResponse![](/images/permalink.svg)
Fields
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: ApppreviewsetAttributes![](/images/permalink.svg)
Fields
- previewType PreviewType? -
apple.appstore: AppPreviewSetCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: ApppreviewsetcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes ApppreviewsetcreaterequestDataAttributes -
- relationships ApppreviewsetcreaterequestDataRelationships -
apple.appstore: ApppreviewsetcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- previewType PreviewType -
apple.appstore: ApppreviewsetcreaterequestDataRelationships![](/images/permalink.svg)
Fields
- appStoreVersionLocalization ApppreviewsetcreaterequestDataRelationshipsAppstoreversionlocalization -
apple.appstore: ApppreviewsetcreaterequestDataRelationshipsAppstoreversionlocalization![](/images/permalink.svg)
Fields
apple.appstore: ApppreviewsetRelationships![](/images/permalink.svg)
Fields
- appStoreVersionLocalization ApppreviewsetRelationshipsAppstoreversionlocalization? -
- appPreviews ApppreviewsetRelationshipsApppreviews? -
apple.appstore: ApppreviewsetRelationshipsApppreviews![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: ApppreviewsetRelationshipsApppreviewsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: ApppreviewsetRelationshipsAppstoreversionlocalization![](/images/permalink.svg)
Fields
apple.appstore: ApppreviewsetRelationshipsAppstoreversionlocalizationData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppPreviewSetResponse![](/images/permalink.svg)
Fields
- data AppPreviewSet -
- included AppPreview[]? -
- links DocumentLinks -
apple.appstore: AppPreviewSetsResponse![](/images/permalink.svg)
Fields
- data AppPreviewSet[] -
- included AppPreview[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppPreviewsResponse![](/images/permalink.svg)
Fields
- data AppPreview[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppPreviewUpdateRequest![](/images/permalink.svg)
Fields
- data ApppreviewupdaterequestData -
apple.appstore: ApppreviewupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes ApppreviewupdaterequestDataAttributes? -
apple.appstore: ApppreviewupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- sourceFileChecksum string? -
- previewFrameTimeCode string? -
- uploaded boolean? -
apple.appstore: AppPrice![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- relationships ApppriceRelationships? -
- links ResourceLinks -
apple.appstore: AppPricePoint![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes ApppricepointAttributes? -
- relationships ApppricepointRelationships? -
- links ResourceLinks -
apple.appstore: ApppricepointAttributes![](/images/permalink.svg)
Fields
- customerPrice string? -
- proceeds string? -
apple.appstore: ApppricepointRelationships![](/images/permalink.svg)
Fields
- priceTier ApppricepointRelationshipsPricetier? -
- territory ApppricepointRelationshipsTerritory? -
apple.appstore: ApppricepointRelationshipsPricetier![](/images/permalink.svg)
Fields
apple.appstore: ApppricepointRelationshipsPricetierData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: ApppricepointRelationshipsTerritory![](/images/permalink.svg)
Fields
apple.appstore: ApppricepointRelationshipsTerritoryData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppPricePointResponse![](/images/permalink.svg)
Fields
- data AppPricePoint -
- included Territory[]? -
- links DocumentLinks -
apple.appstore: AppPricePointsResponse![](/images/permalink.svg)
Fields
- data AppPricePoint[] -
- included Territory[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: ApppriceRelationships![](/images/permalink.svg)
Fields
- priceTier ApppricepointRelationshipsPricetier? -
apple.appstore: AppPriceResponse![](/images/permalink.svg)
Fields
- data AppPrice -
- links DocumentLinks -
apple.appstore: AppPricesResponse![](/images/permalink.svg)
Fields
- data AppPrice[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppPriceTier![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- relationships ApppricetierRelationships? -
- links ResourceLinks -
apple.appstore: ApppricetierRelationships![](/images/permalink.svg)
Fields
- pricePoints ApppricetierRelationshipsPricepoints? -
apple.appstore: ApppricetierRelationshipsPricepoints![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data ApppricetierRelationshipsPricepointsData[]? -
apple.appstore: ApppricetierRelationshipsPricepointsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppPriceTierResponse![](/images/permalink.svg)
Fields
- data AppPriceTier -
- included AppPricePoint[]? -
- links DocumentLinks -
apple.appstore: AppPriceTiersResponse![](/images/permalink.svg)
Fields
- data AppPriceTier[] -
- included AppPricePoint[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppRelationships![](/images/permalink.svg)
Fields
- betaGroups AppRelationshipsBetagroups? -
- appStoreVersions AppRelationshipsAppstoreversions? -
- preReleaseVersions AppRelationshipsPrereleaseversions? -
- betaAppLocalizations AppRelationshipsBetaapplocalizations? -
- builds AppRelationshipsBuilds? -
- betaLicenseAgreement AppRelationshipsBetalicenseagreement? -
- betaAppReviewDetail AppRelationshipsBetaappreviewdetail? -
- appInfos AppRelationshipsAppinfos? -
- endUserLicenseAgreement AppRelationshipsEnduserlicenseagreement? -
- preOrder AppRelationshipsPreorder? -
- prices AppRelationshipsPrices? -
- availableTerritories AppRelationshipsAvailableterritories? -
- inAppPurchases AppRelationshipsInapppurchases? -
- gameCenterEnabledVersions AppRelationshipsGamecenterenabledversions? -
apple.appstore: AppRelationshipsAppinfos![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: AppRelationshipsAppstoreversions![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: AppRelationshipsAvailableterritories![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data ApppricepointRelationshipsTerritoryData[]? -
apple.appstore: AppRelationshipsBetaapplocalizations![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data AppRelationshipsBetaapplocalizationsData[]? -
apple.appstore: AppRelationshipsBetaapplocalizationsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppRelationshipsBetaappreviewdetail![](/images/permalink.svg)
Fields
apple.appstore: AppRelationshipsBetaappreviewdetailData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppRelationshipsBetagroups![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data AppRelationshipsBetagroupsData[]? -
apple.appstore: AppRelationshipsBetagroupsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppRelationshipsBetalicenseagreement![](/images/permalink.svg)
Fields
apple.appstore: AppRelationshipsBetalicenseagreementData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppRelationshipsBuilds![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data AppstoreversionRelationshipsBuildData[]? -
apple.appstore: AppRelationshipsEnduserlicenseagreement![](/images/permalink.svg)
Fields
apple.appstore: AppRelationshipsEnduserlicenseagreementData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppRelationshipsGamecenterenabledversions![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: AppRelationshipsGamecenterenabledversionsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppRelationshipsInapppurchases![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data AppRelationshipsInapppurchasesData[]? -
apple.appstore: AppRelationshipsInapppurchasesData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppRelationshipsPreorder![](/images/permalink.svg)
Fields
- data AppRelationshipsPreorderData? -
apple.appstore: AppRelationshipsPreorderData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppRelationshipsPrereleaseversions![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data AppRelationshipsPrereleaseversionsData[]? -
apple.appstore: AppRelationshipsPrereleaseversionsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppRelationshipsPrices![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data AppRelationshipsPricesData[]? -
apple.appstore: AppRelationshipsPricesData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppResponse![](/images/permalink.svg)
Fields
- data App -
- links DocumentLinks -
apple.appstore: AppScreenshot![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppscreenshotAttributes? -
- relationships AppscreenshotRelationships? -
- links ResourceLinks -
apple.appstore: AppscreenshotAttributes![](/images/permalink.svg)
Fields
- fileSize int? -
- fileName string? -
- sourceFileChecksum string? -
- imageAsset ImageAsset? -
- assetToken string? -
- assetType string? -
- uploadOperations UploadOperation[]? -
- assetDeliveryState AppMediaAssetState? -
apple.appstore: AppScreenshotCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppscreenshotcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes AppscreenshotcreaterequestDataAttributes -
- relationships AppscreenshotcreaterequestDataRelationships -
apple.appstore: AppscreenshotcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- fileSize int -
- fileName string -
apple.appstore: AppscreenshotcreaterequestDataRelationships![](/images/permalink.svg)
Fields
- appScreenshotSet AppscreenshotcreaterequestDataRelationshipsAppscreenshotset -
apple.appstore: AppscreenshotcreaterequestDataRelationshipsAppscreenshotset![](/images/permalink.svg)
Fields
apple.appstore: AppscreenshotRelationships![](/images/permalink.svg)
Fields
- appScreenshotSet AppscreenshotRelationshipsAppscreenshotset? -
apple.appstore: AppscreenshotRelationshipsAppscreenshotset![](/images/permalink.svg)
Fields
apple.appstore: AppscreenshotRelationshipsAppscreenshotsetData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppScreenshotResponse![](/images/permalink.svg)
Fields
- data AppScreenshot -
- links DocumentLinks -
apple.appstore: AppScreenshotSet![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppscreenshotsetAttributes? -
- relationships AppscreenshotsetRelationships? -
- links ResourceLinks -
apple.appstore: AppScreenshotSetAppScreenshotsLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: AppScreenshotSetAppScreenshotsLinkagesResponse![](/images/permalink.svg)
Fields
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppscreenshotsetAttributes![](/images/permalink.svg)
Fields
- screenshotDisplayType ScreenshotDisplayType? -
apple.appstore: AppScreenshotSetCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppscreenshotsetcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes AppscreenshotsetcreaterequestDataAttributes -
- relationships ApppreviewsetcreaterequestDataRelationships -
apple.appstore: AppscreenshotsetcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- screenshotDisplayType ScreenshotDisplayType -
apple.appstore: AppscreenshotsetRelationships![](/images/permalink.svg)
Fields
- appStoreVersionLocalization ApppreviewsetRelationshipsAppstoreversionlocalization? -
- appScreenshots AppscreenshotsetRelationshipsAppscreenshots? -
apple.appstore: AppscreenshotsetRelationshipsAppscreenshots![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: AppscreenshotsetRelationshipsAppscreenshotsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppScreenshotSetResponse![](/images/permalink.svg)
Fields
- data AppScreenshotSet -
- included AppScreenshot[]? -
- links DocumentLinks -
apple.appstore: AppScreenshotSetsResponse![](/images/permalink.svg)
Fields
- data AppScreenshotSet[] -
- included AppScreenshot[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppScreenshotsResponse![](/images/permalink.svg)
Fields
- data AppScreenshot[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppScreenshotUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppscreenshotupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppscreenshotupdaterequestDataAttributes? -
apple.appstore: AppscreenshotupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- sourceFileChecksum string? -
- uploaded boolean? -
apple.appstore: AppsResponse![](/images/permalink.svg)
Fields
- data App[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppStoreReviewAttachment![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstorereviewattachmentAttributes? -
- relationships AppstorereviewattachmentRelationships? -
- links ResourceLinks -
apple.appstore: AppstorereviewattachmentAttributes![](/images/permalink.svg)
Fields
- fileSize int? -
- fileName string? -
- sourceFileChecksum string? -
- uploadOperations UploadOperation[]? -
- assetDeliveryState AppMediaAssetState? -
apple.appstore: AppStoreReviewAttachmentCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstorereviewattachmentcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes AppscreenshotcreaterequestDataAttributes -
- relationships AppstorereviewattachmentcreaterequestDataRelationships -
apple.appstore: AppstorereviewattachmentcreaterequestDataRelationships![](/images/permalink.svg)
Fields
- appStoreReviewDetail AppstorereviewattachmentcreaterequestDataRelationshipsAppstorereviewdetail -
apple.appstore: AppstorereviewattachmentcreaterequestDataRelationshipsAppstorereviewdetail![](/images/permalink.svg)
Fields
apple.appstore: AppstorereviewattachmentRelationships![](/images/permalink.svg)
Fields
- appStoreReviewDetail AppstorereviewattachmentRelationshipsAppstorereviewdetail? -
apple.appstore: AppstorereviewattachmentRelationshipsAppstorereviewdetail![](/images/permalink.svg)
Fields
apple.appstore: AppstorereviewattachmentRelationshipsAppstorereviewdetailData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppStoreReviewAttachmentResponse![](/images/permalink.svg)
Fields
- data AppStoreReviewAttachment -
- links DocumentLinks -
apple.appstore: AppStoreReviewAttachmentsResponse![](/images/permalink.svg)
Fields
- data AppStoreReviewAttachment[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppStoreReviewAttachmentUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstorereviewattachmentupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppscreenshotupdaterequestDataAttributes? -
apple.appstore: AppStoreReviewDetail![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstorereviewdetailAttributes? -
- relationships AppstorereviewdetailRelationships? -
- links ResourceLinks -
apple.appstore: AppstorereviewdetailAttributes![](/images/permalink.svg)
Fields
- contactFirstName string? -
- contactLastName string? -
- contactPhone string? -
- contactEmail string? -
- demoAccountName string? -
- demoAccountPassword string? -
- demoAccountRequired boolean? -
- notes string? -
apple.appstore: AppStoreReviewDetailCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstorereviewdetailcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes AppstorereviewdetailAttributes? -
- relationships AppstorereviewdetailcreaterequestDataRelationships -
apple.appstore: AppstorereviewdetailcreaterequestDataRelationships![](/images/permalink.svg)
Fields
- appStoreVersion AppstorereviewdetailcreaterequestDataRelationshipsAppstoreversion -
apple.appstore: AppstorereviewdetailcreaterequestDataRelationshipsAppstoreversion![](/images/permalink.svg)
Fields
apple.appstore: AppstorereviewdetailRelationships![](/images/permalink.svg)
Fields
- appStoreVersion AppstorereviewdetailRelationshipsAppstoreversion? -
- appStoreReviewAttachments AppstorereviewdetailRelationshipsAppstorereviewattachments? -
apple.appstore: AppstorereviewdetailRelationshipsAppstorereviewattachments![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: AppstorereviewdetailRelationshipsAppstorereviewattachmentsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppstorereviewdetailRelationshipsAppstoreversion![](/images/permalink.svg)
Fields
apple.appstore: AppstorereviewdetailRelationshipsAppstoreversionData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppStoreReviewDetailResponse![](/images/permalink.svg)
Fields
- data AppStoreReviewDetail -
- included AppStoreReviewAttachment[]? -
- links DocumentLinks -
apple.appstore: AppStoreReviewDetailUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstorereviewdetailupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstorereviewdetailAttributes? -
apple.appstore: AppStoreVersion![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstoreversionAttributes? -
- relationships AppstoreversionRelationships? -
- links ResourceLinks -
apple.appstore: AppstoreversionAttributes![](/images/permalink.svg)
Fields
- platform Platform? -
- versionString string? -
- appStoreState AppStoreVersionState? -
- copyright string? -
- releaseType string? -
- earliestReleaseDate string? -
- usesIdfa boolean? -
- downloadable boolean? -
- createdDate string? -
apple.appstore: AppStoreVersionBuildLinkageRequest![](/images/permalink.svg)
Fields
apple.appstore: AppStoreVersionBuildLinkageResponse![](/images/permalink.svg)
Fields
- links DocumentLinks -
apple.appstore: AppStoreVersionCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversioncreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes AppstoreversioncreaterequestDataAttributes -
- relationships AppstoreversioncreaterequestDataRelationships -
apple.appstore: AppstoreversioncreaterequestDataAttributes![](/images/permalink.svg)
Fields
- platform Platform -
- versionString string -
- copyright string? -
- releaseType string? -
- earliestReleaseDate string? -
- usesIdfa boolean? -
apple.appstore: AppstoreversioncreaterequestDataRelationships![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversioncreaterequestDataRelationshipsBuild![](/images/permalink.svg)
Fields
apple.appstore: AppStoreVersionLocalization![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstoreversionlocalizationAttributes? -
- relationships AppstoreversionlocalizationRelationships? -
- links ResourceLinks -
apple.appstore: AppstoreversionlocalizationAttributes![](/images/permalink.svg)
Fields
- description string? -
- locale string? -
- keywords string? -
- marketingUrl string? -
- promotionalText string? -
- supportUrl string? -
- whatsNew string? -
apple.appstore: AppStoreVersionLocalizationCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionlocalizationcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- relationships AppstorereviewdetailcreaterequestDataRelationships -
apple.appstore: AppstoreversionlocalizationcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- description string? -
- locale string -
- keywords string? -
- marketingUrl string? -
- promotionalText string? -
- supportUrl string? -
- whatsNew string? -
apple.appstore: AppstoreversionlocalizationRelationships![](/images/permalink.svg)
Fields
- appStoreVersion AppstorereviewdetailRelationshipsAppstoreversion? -
- appScreenshotSets AppstoreversionlocalizationRelationshipsAppscreenshotsets? -
- appPreviewSets AppstoreversionlocalizationRelationshipsApppreviewsets? -
apple.appstore: AppstoreversionlocalizationRelationshipsApppreviewsets![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data ApppreviewRelationshipsApppreviewsetData[]? -
apple.appstore: AppstoreversionlocalizationRelationshipsAppscreenshotsets![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: AppStoreVersionLocalizationResponse![](/images/permalink.svg)
Fields
- data AppStoreVersionLocalization -
- included (AppScreenshotSet|AppPreviewSet)[]? -
- links DocumentLinks -
apple.appstore: AppStoreVersionLocalizationsResponse![](/images/permalink.svg)
Fields
- data AppStoreVersionLocalization[] -
- included (AppScreenshotSet|AppPreviewSet)[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppStoreVersionLocalizationUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionlocalizationupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstoreversionlocalizationupdaterequestDataAttributes? -
apple.appstore: AppstoreversionlocalizationupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- description string? -
- keywords string? -
- marketingUrl string? -
- promotionalText string? -
- supportUrl string? -
- whatsNew string? -
apple.appstore: AppStoreVersionPhasedRelease![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstoreversionphasedreleaseAttributes? -
- links ResourceLinks -
apple.appstore: AppstoreversionphasedreleaseAttributes![](/images/permalink.svg)
Fields
- phasedReleaseState PhasedReleaseState? -
- startDate string? -
- totalPauseDuration int? -
- currentDayNumber int? -
apple.appstore: AppStoreVersionPhasedReleaseCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionphasedreleasecreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes AppstoreversionphasedreleasecreaterequestDataAttributes? -
- relationships AppstorereviewdetailcreaterequestDataRelationships -
apple.appstore: AppstoreversionphasedreleasecreaterequestDataAttributes![](/images/permalink.svg)
Fields
- phasedReleaseState PhasedReleaseState? -
apple.appstore: AppStoreVersionPhasedReleaseResponse![](/images/permalink.svg)
Fields
- data AppStoreVersionPhasedRelease -
- links DocumentLinks -
apple.appstore: AppStoreVersionPhasedReleaseUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionphasedreleaseupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstoreversionphasedreleasecreaterequestDataAttributes? -
apple.appstore: AppstoreversionRelationships![](/images/permalink.svg)
Fields
- ageRatingDeclaration AppstoreversionRelationshipsAgeratingdeclaration? -
- appStoreVersionLocalizations AppstoreversionRelationshipsAppstoreversionlocalizations? -
- build AppstoreversionRelationshipsBuild? -
- appStoreVersionPhasedRelease AppstoreversionRelationshipsAppstoreversionphasedrelease? -
- routingAppCoverage AppstoreversionRelationshipsRoutingappcoverage? -
- appStoreReviewDetail AppstorereviewattachmentRelationshipsAppstorereviewdetail? -
- appStoreVersionSubmission AppstoreversionRelationshipsAppstoreversionsubmission? -
- idfaDeclaration AppstoreversionRelationshipsIdfadeclaration? -
apple.appstore: AppstoreversionRelationshipsAgeratingdeclaration![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionRelationshipsAppstoreversionlocalizations![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: AppstoreversionRelationshipsAppstoreversionphasedrelease![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionRelationshipsAppstoreversionphasedreleaseData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppstoreversionRelationshipsAppstoreversionsubmission![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionRelationshipsAppstoreversionsubmissionData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppstoreversionRelationshipsBuild![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionRelationshipsBuildData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppstoreversionRelationshipsIdfadeclaration![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionRelationshipsIdfadeclarationData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppstoreversionRelationshipsRoutingappcoverage![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionRelationshipsRoutingappcoverageData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: AppStoreVersionResponse![](/images/permalink.svg)
Fields
- data AppStoreVersion -
- links DocumentLinks -
apple.appstore: AppStoreVersionsResponse![](/images/permalink.svg)
Fields
- data AppStoreVersion[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: AppStoreVersionSubmission![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- relationships AppstoreversionsubmissionRelationships? -
- links ResourceLinks -
apple.appstore: AppStoreVersionSubmissionCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionsubmissioncreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- relationships AppstorereviewdetailcreaterequestDataRelationships -
apple.appstore: AppstoreversionsubmissionRelationships![](/images/permalink.svg)
Fields
- appStoreVersion AppstorereviewdetailRelationshipsAppstoreversion? -
apple.appstore: AppStoreVersionSubmissionResponse![](/images/permalink.svg)
Fields
- data AppStoreVersionSubmission -
- links DocumentLinks -
apple.appstore: AppStoreVersionUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: AppstoreversionupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstoreversionupdaterequestDataAttributes? -
- relationships AppstoreversionupdaterequestDataRelationships? -
apple.appstore: AppstoreversionupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- versionString string? -
- copyright string? -
- releaseType string? -
- earliestReleaseDate string? -
- usesIdfa boolean? -
- downloadable boolean? -
apple.appstore: AppstoreversionupdaterequestDataRelationships![](/images/permalink.svg)
Fields
apple.appstore: AppUpdateRequest![](/images/permalink.svg)
Fields
- data AppupdaterequestData -
apple.appstore: AppupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppupdaterequestDataAttributes? -
- relationships AppupdaterequestDataRelationships? -
apple.appstore: AppupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- bundleId string? -
- primaryLocale string? -
- availableInNewTerritories boolean? -
- contentRightsDeclaration string? -
apple.appstore: AppupdaterequestDataRelationships![](/images/permalink.svg)
Fields
- prices AppupdaterequestDataRelationshipsPrices? -
- availableTerritories AppupdaterequestDataRelationshipsAvailableterritories? -
apple.appstore: AppupdaterequestDataRelationshipsAvailableterritories![](/images/permalink.svg)
Fields
- data ApppricepointRelationshipsTerritoryData[]? -
apple.appstore: AppupdaterequestDataRelationshipsPrices![](/images/permalink.svg)
Fields
- data AppRelationshipsPricesData[]? -
apple.appstore: BetaAppLocalization![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetaapplocalizationAttributes? -
- relationships AppencryptiondeclarationRelationships? -
- links ResourceLinks -
apple.appstore: BetaapplocalizationAttributes![](/images/permalink.svg)
Fields
- feedbackEmail string? -
- marketingUrl string? -
- privacyPolicyUrl string? -
- tvOsPrivacyPolicy string? -
- description string? -
- locale string? -
apple.appstore: BetaAppLocalizationCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: BetaapplocalizationcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes BetaapplocalizationcreaterequestDataAttributes -
- relationships ApppreordercreaterequestDataRelationships -
apple.appstore: BetaapplocalizationcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- feedbackEmail string? -
- marketingUrl string? -
- privacyPolicyUrl string? -
- tvOsPrivacyPolicy string? -
- description string? -
- locale string -
apple.appstore: BetaAppLocalizationResponse![](/images/permalink.svg)
Fields
- data BetaAppLocalization -
- included App[]? -
- links DocumentLinks -
apple.appstore: BetaAppLocalizationsResponse![](/images/permalink.svg)
Fields
- data BetaAppLocalization[] -
- included App[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetaAppLocalizationUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: BetaapplocalizationupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetaapplocalizationupdaterequestDataAttributes? -
apple.appstore: BetaapplocalizationupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- feedbackEmail string? -
- marketingUrl string? -
- privacyPolicyUrl string? -
- tvOsPrivacyPolicy string? -
- description string? -
apple.appstore: BetaAppReviewDetail![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstorereviewdetailAttributes? -
- relationships AppencryptiondeclarationRelationships? -
- links ResourceLinks -
apple.appstore: BetaAppReviewDetailResponse![](/images/permalink.svg)
Fields
- data BetaAppReviewDetail -
- included App[]? -
- links DocumentLinks -
apple.appstore: BetaAppReviewDetailsResponse![](/images/permalink.svg)
Fields
- data BetaAppReviewDetail[] -
- included App[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetaAppReviewDetailUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: BetaappreviewdetailupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstorereviewdetailAttributes? -
apple.appstore: BetaAppReviewSubmission![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetaappreviewsubmissionAttributes? -
- relationships BetaappreviewsubmissionRelationships? -
- links ResourceLinks -
apple.appstore: BetaappreviewsubmissionAttributes![](/images/permalink.svg)
Fields
- betaReviewState BetaReviewState? -
apple.appstore: BetaAppReviewSubmissionCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: BetaappreviewsubmissioncreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- relationships BetaappreviewsubmissioncreaterequestDataRelationships -
apple.appstore: BetaappreviewsubmissioncreaterequestDataRelationships![](/images/permalink.svg)
Fields
apple.appstore: BetaappreviewsubmissioncreaterequestDataRelationshipsBuild![](/images/permalink.svg)
Fields
apple.appstore: BetaappreviewsubmissionRelationships![](/images/permalink.svg)
Fields
- build AppstoreversionRelationshipsBuild? -
apple.appstore: BetaAppReviewSubmissionResponse![](/images/permalink.svg)
Fields
- data BetaAppReviewSubmission -
- included Build[]? -
- links DocumentLinks -
apple.appstore: BetaAppReviewSubmissionsResponse![](/images/permalink.svg)
Fields
- data BetaAppReviewSubmission[] -
- included Build[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetaBuildLocalization![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetabuildlocalizationAttributes? -
- relationships BetaappreviewsubmissionRelationships? -
- links ResourceLinks -
apple.appstore: BetabuildlocalizationAttributes![](/images/permalink.svg)
Fields
- whatsNew string? -
- locale string? -
apple.appstore: BetaBuildLocalizationCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: BetabuildlocalizationcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes BetabuildlocalizationcreaterequestDataAttributes -
- relationships BetaappreviewsubmissioncreaterequestDataRelationships -
apple.appstore: BetabuildlocalizationcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- whatsNew string? -
- locale string -
apple.appstore: BetaBuildLocalizationResponse![](/images/permalink.svg)
Fields
- data BetaBuildLocalization -
- included Build[]? -
- links DocumentLinks -
apple.appstore: BetaBuildLocalizationsResponse![](/images/permalink.svg)
Fields
- data BetaBuildLocalization[] -
- included Build[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetaBuildLocalizationUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: BetabuildlocalizationupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetabuildlocalizationupdaterequestDataAttributes? -
apple.appstore: BetabuildlocalizationupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- whatsNew string? -
apple.appstore: BetaGroup![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetagroupAttributes? -
- relationships BetagroupRelationships? -
- links ResourceLinks -
apple.appstore: BetagroupAttributes![](/images/permalink.svg)
Fields
- name string? -
- createdDate string? -
- isInternalGroup boolean? -
- publicLinkEnabled boolean? -
- publicLinkId string? -
- publicLinkLimitEnabled boolean? -
- publicLinkLimit int? -
- publicLink string? -
- feedbackEnabled boolean? -
apple.appstore: BetaGroupBetaTestersLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: BetaGroupBetaTestersLinkagesResponse![](/images/permalink.svg)
Fields
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetaGroupBuildsLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: BetaGroupBuildsLinkagesResponse![](/images/permalink.svg)
Fields
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetaGroupCreateRequest![](/images/permalink.svg)
Fields
- data BetagroupcreaterequestData -
apple.appstore: BetagroupcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes BetagroupcreaterequestDataAttributes -
- relationships BetagroupcreaterequestDataRelationships -
apple.appstore: BetagroupcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- name string -
- publicLinkEnabled boolean? -
- publicLinkLimitEnabled boolean? -
- publicLinkLimit int? -
- feedbackEnabled boolean? -
apple.appstore: BetagroupcreaterequestDataRelationships![](/images/permalink.svg)
Fields
- betaTesters BetagroupcreaterequestDataRelationshipsBetatesters? -
apple.appstore: BetagroupcreaterequestDataRelationshipsBetatesters![](/images/permalink.svg)
Fields
- data BetagroupRelationshipsBetatestersData[]? -
apple.appstore: BetagroupcreaterequestDataRelationshipsBuilds![](/images/permalink.svg)
Fields
- data AppstoreversionRelationshipsBuildData[]? -
apple.appstore: BetagroupRelationships![](/images/permalink.svg)
Fields
- builds AppRelationshipsBuilds? -
- betaTesters BetagroupRelationshipsBetatesters? -
apple.appstore: BetagroupRelationshipsBetatesters![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data BetagroupRelationshipsBetatestersData[]? -
apple.appstore: BetagroupRelationshipsBetatestersData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: BetaGroupResponse![](/images/permalink.svg)
Fields
- data BetaGroup -
- included (App|Build|BetaTester)[]? -
- links DocumentLinks -
apple.appstore: BetaGroupsResponse![](/images/permalink.svg)
Fields
- data BetaGroup[] -
- included (App|Build|BetaTester)[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetaGroupUpdateRequest![](/images/permalink.svg)
Fields
- data BetagroupupdaterequestData -
apple.appstore: BetagroupupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetagroupupdaterequestDataAttributes? -
apple.appstore: BetagroupupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- name string? -
- publicLinkEnabled boolean? -
- publicLinkLimitEnabled boolean? -
- publicLinkLimit int? -
- feedbackEnabled boolean? -
apple.appstore: BetaLicenseAgreement![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetalicenseagreementAttributes? -
- relationships AppencryptiondeclarationRelationships? -
- links ResourceLinks -
apple.appstore: BetalicenseagreementAttributes![](/images/permalink.svg)
Fields
- agreementText string? -
apple.appstore: BetaLicenseAgreementResponse![](/images/permalink.svg)
Fields
- data BetaLicenseAgreement -
- included App[]? -
- links DocumentLinks -
apple.appstore: BetaLicenseAgreementsResponse![](/images/permalink.svg)
Fields
- data BetaLicenseAgreement[] -
- included App[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetaLicenseAgreementUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: BetalicenseagreementupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetalicenseagreementAttributes? -
apple.appstore: BetaTester![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetatesterAttributes? -
- relationships BetatesterRelationships? -
- links ResourceLinks -
apple.appstore: BetaTesterAppsLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: BetaTesterAppsLinkagesResponse![](/images/permalink.svg)
Fields
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetatesterAttributes![](/images/permalink.svg)
Fields
- firstName string? -
- lastName string? -
- email string? -
- inviteType BetaInviteType? -
apple.appstore: BetaTesterBetaGroupsLinkagesRequest![](/images/permalink.svg)
Fields
- data AppRelationshipsBetagroupsData[] -
apple.appstore: BetaTesterBetaGroupsLinkagesResponse![](/images/permalink.svg)
Fields
- data AppRelationshipsBetagroupsData[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetaTesterBuildsLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: BetaTesterBuildsLinkagesResponse![](/images/permalink.svg)
Fields
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BetaTesterCreateRequest![](/images/permalink.svg)
Fields
- data BetatestercreaterequestData -
apple.appstore: BetatestercreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes BetatestercreaterequestDataAttributes -
- relationships BetatestercreaterequestDataRelationships? -
apple.appstore: BetatestercreaterequestDataAttributes![](/images/permalink.svg)
Fields
- firstName string? -
- lastName string? -
- email string -
apple.appstore: BetatestercreaterequestDataRelationships![](/images/permalink.svg)
Fields
- betaGroups BetatestercreaterequestDataRelationshipsBetagroups? -
apple.appstore: BetatestercreaterequestDataRelationshipsBetagroups![](/images/permalink.svg)
Fields
- data AppRelationshipsBetagroupsData[]? -
apple.appstore: BetaTesterInvitation![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- links ResourceLinks -
apple.appstore: BetaTesterInvitationCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: BetatesterinvitationcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- relationships BetatesterinvitationcreaterequestDataRelationships -
apple.appstore: BetatesterinvitationcreaterequestDataRelationships![](/images/permalink.svg)
Fields
apple.appstore: BetatesterinvitationcreaterequestDataRelationshipsBetatester![](/images/permalink.svg)
Fields
apple.appstore: BetaTesterInvitationResponse![](/images/permalink.svg)
Fields
- data BetaTesterInvitation -
- links DocumentLinks -
apple.appstore: BetatesterRelationships![](/images/permalink.svg)
Fields
- apps BetatesterRelationshipsApps? -
- betaGroups AppRelationshipsBetagroups? -
- builds AppRelationshipsBuilds? -
apple.appstore: BetatesterRelationshipsApps![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: BetaTesterResponse![](/images/permalink.svg)
Fields
- data BetaTester -
- links DocumentLinks -
apple.appstore: BetaTestersResponse![](/images/permalink.svg)
Fields
- data BetaTester[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: Build![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BuildAttributes? -
- relationships BuildRelationships? -
- links ResourceLinks -
apple.appstore: BuildAppEncryptionDeclarationLinkageRequest![](/images/permalink.svg)
Fields
apple.appstore: BuildAppEncryptionDeclarationLinkageResponse![](/images/permalink.svg)
Fields
- links DocumentLinks -
apple.appstore: BuildAttributes![](/images/permalink.svg)
Fields
- 'version string? -
- uploadedDate string? -
- expirationDate string? -
- expired boolean? -
- minOsVersion string? -
- iconAssetToken ImageAsset? -
- processingState string? -
- usesNonExemptEncryption boolean? -
apple.appstore: BuildBetaDetail![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BuildbetadetailAttributes? -
- relationships BetaappreviewsubmissionRelationships? -
- links ResourceLinks -
apple.appstore: BuildbetadetailAttributes![](/images/permalink.svg)
Fields
- autoNotifyEnabled boolean? -
- internalBuildState InternalBetaState? -
- externalBuildState ExternalBetaState? -
apple.appstore: BuildBetaDetailResponse![](/images/permalink.svg)
Fields
- data BuildBetaDetail -
- included Build[]? -
- links DocumentLinks -
apple.appstore: BuildBetaDetailsResponse![](/images/permalink.svg)
Fields
- data BuildBetaDetail[] -
- included Build[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BuildBetaDetailUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: BuildbetadetailupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BuildbetadetailupdaterequestDataAttributes? -
apple.appstore: BuildbetadetailupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- autoNotifyEnabled boolean? -
apple.appstore: BuildBetaGroupsLinkagesRequest![](/images/permalink.svg)
Fields
- data AppRelationshipsBetagroupsData[] -
apple.appstore: BuildBetaNotification![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- links ResourceLinks -
apple.appstore: BuildBetaNotificationCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: BuildbetanotificationcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- relationships BetaappreviewsubmissioncreaterequestDataRelationships -
apple.appstore: BuildBetaNotificationResponse![](/images/permalink.svg)
Fields
- data BuildBetaNotification -
- links DocumentLinks -
apple.appstore: BuildIcon![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BuildiconAttributes? -
- links ResourceLinks -
apple.appstore: BuildiconAttributes![](/images/permalink.svg)
Fields
- iconAsset ImageAsset? -
- iconType IconAssetType? -
apple.appstore: BuildIconsResponse![](/images/permalink.svg)
Fields
- data BuildIcon[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BuildIndividualTestersLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: BuildIndividualTestersLinkagesResponse![](/images/permalink.svg)
Fields
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BuildRelationships![](/images/permalink.svg)
Fields
- preReleaseVersion BuildRelationshipsPrereleaseversion? -
- individualTesters BetagroupRelationshipsBetatesters? -
- betaBuildLocalizations BuildRelationshipsBetabuildlocalizations? -
- appEncryptionDeclaration BuildRelationshipsAppencryptiondeclaration? -
- betaAppReviewSubmission BuildRelationshipsBetaappreviewsubmission? -
- buildBetaDetail BuildRelationshipsBuildbetadetail? -
- appStoreVersion AppstorereviewdetailRelationshipsAppstoreversion? -
- icons BuildRelationshipsIcons? -
apple.appstore: BuildRelationshipsAppencryptiondeclaration![](/images/permalink.svg)
Fields
apple.appstore: BuildRelationshipsAppencryptiondeclarationData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: BuildRelationshipsBetaappreviewsubmission![](/images/permalink.svg)
Fields
apple.appstore: BuildRelationshipsBetaappreviewsubmissionData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: BuildRelationshipsBetabuildlocalizations![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: BuildRelationshipsBetabuildlocalizationsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: BuildRelationshipsBuildbetadetail![](/images/permalink.svg)
Fields
apple.appstore: BuildRelationshipsBuildbetadetailData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: BuildRelationshipsIcons![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data BuildRelationshipsIconsData[]? -
apple.appstore: BuildRelationshipsIconsData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: BuildRelationshipsPrereleaseversion![](/images/permalink.svg)
Fields
apple.appstore: BuildResponse![](/images/permalink.svg)
Fields
- data Build -
- links DocumentLinks -
apple.appstore: BuildsResponse![](/images/permalink.svg)
Fields
- data Build[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BuildUpdateRequest![](/images/permalink.svg)
Fields
- data BuildupdaterequestData -
apple.appstore: BuildupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BuildupdaterequestDataAttributes? -
- relationships BuildupdaterequestDataRelationships? -
apple.appstore: BuildupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- expired boolean? -
- usesNonExemptEncryption boolean? -
apple.appstore: BuildupdaterequestDataRelationships![](/images/permalink.svg)
Fields
- appEncryptionDeclaration BuildupdaterequestDataRelationshipsAppencryptiondeclaration? -
apple.appstore: BuildupdaterequestDataRelationshipsAppencryptiondeclaration![](/images/permalink.svg)
Fields
apple.appstore: BundleId![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BundleidAttributes? -
- relationships BundleidRelationships? -
- links ResourceLinks -
apple.appstore: BundleidAttributes![](/images/permalink.svg)
Fields
- name string? -
- platform BundleIdPlatform? -
- identifier string? -
- seedId string? -
apple.appstore: BundleIdCapabilitiesResponse![](/images/permalink.svg)
Fields
- data BundleIdCapability[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BundleIdCapability![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BundleidcapabilityAttributes? -
- links ResourceLinks -
apple.appstore: BundleidcapabilityAttributes![](/images/permalink.svg)
Fields
- capabilityType CapabilityType? -
- settings CapabilitySetting[]? -
apple.appstore: BundleIdCapabilityCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: BundleidcapabilitycreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes BundleidcapabilitycreaterequestDataAttributes -
- relationships BundleidcapabilitycreaterequestDataRelationships -
apple.appstore: BundleidcapabilitycreaterequestDataAttributes![](/images/permalink.svg)
Fields
- capabilityType CapabilityType -
- settings CapabilitySetting[]? -
apple.appstore: BundleidcapabilitycreaterequestDataRelationships![](/images/permalink.svg)
Fields
apple.appstore: BundleidcapabilitycreaterequestDataRelationshipsBundleid![](/images/permalink.svg)
Fields
apple.appstore: BundleidcapabilitycreaterequestDataRelationshipsBundleidData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: BundleIdCapabilityResponse![](/images/permalink.svg)
Fields
- data BundleIdCapability -
- links DocumentLinks -
apple.appstore: BundleIdCapabilityUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: BundleidcapabilityupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BundleidcapabilityAttributes? -
apple.appstore: BundleIdCreateRequest![](/images/permalink.svg)
Fields
- data BundleidcreaterequestData -
apple.appstore: BundleidcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes BundleidcreaterequestDataAttributes -
apple.appstore: BundleidcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- name string -
- platform BundleIdPlatform -
- identifier string -
- seedId string? -
apple.appstore: BundleidRelationships![](/images/permalink.svg)
Fields
- profiles BundleidRelationshipsProfiles? -
- bundleIdCapabilities BundleidRelationshipsBundleidcapabilities? -
apple.appstore: BundleidRelationshipsBundleidcapabilities![](/images/permalink.svg)
Fields
- meta PagingInformation? -
apple.appstore: BundleidRelationshipsBundleidcapabilitiesData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: BundleidRelationshipsProfiles![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data BundleidRelationshipsProfilesData[]? -
apple.appstore: BundleidRelationshipsProfilesData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: BundleIdResponse![](/images/permalink.svg)
Fields
- data BundleId -
- included (Profile|BundleIdCapability|App)[]? -
- links DocumentLinks -
apple.appstore: BundleIdsResponse![](/images/permalink.svg)
Fields
- data BundleId[] -
- included (Profile|BundleIdCapability|App)[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: BundleIdUpdateRequest![](/images/permalink.svg)
Fields
- data BundleidupdaterequestData -
apple.appstore: BundleidupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BundleidupdaterequestDataAttributes? -
apple.appstore: BundleidupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- name string? -
apple.appstore: CapabilityOption![](/images/permalink.svg)
Fields
- 'key string? -
- name string? -
- description string? -
- enabledByDefault boolean? -
- enabled boolean? -
- supportsWildcard boolean? -
apple.appstore: CapabilitySetting![](/images/permalink.svg)
Fields
- 'key string? -
- name string? -
- description string? -
- enabledByDefault boolean? -
- visible boolean? -
- allowedInstances string? -
- minInstances int? -
- options CapabilityOption[]? -
apple.appstore: Certificate![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes CertificateAttributes? -
- links ResourceLinks -
apple.appstore: CertificateAttributes![](/images/permalink.svg)
Fields
- name string? -
- certificateType CertificateType? -
- displayName string? -
- serialNumber string? -
- platform BundleIdPlatform? -
- expirationDate string? -
- certificateContent string? -
apple.appstore: CertificateCreateRequest![](/images/permalink.svg)
Fields
- data CertificatecreaterequestData -
apple.appstore: CertificatecreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes CertificatecreaterequestDataAttributes -
apple.appstore: CertificatecreaterequestDataAttributes![](/images/permalink.svg)
Fields
- csrContent string -
- certificateType CertificateType -
apple.appstore: CertificateResponse![](/images/permalink.svg)
Fields
- data Certificate -
- links DocumentLinks -
apple.appstore: CertificatesResponse![](/images/permalink.svg)
Fields
- data Certificate[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
apple.appstore: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
apple.appstore: Device![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes DeviceAttributes? -
- links ResourceLinks -
apple.appstore: DeviceAttributes![](/images/permalink.svg)
Fields
- name string? -
- platform BundleIdPlatform? -
- udid string? -
- deviceClass string? -
- status string? -
- model string? -
- addedDate string? -
apple.appstore: DeviceCreateRequest![](/images/permalink.svg)
Fields
- data DevicecreaterequestData -
apple.appstore: DevicecreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes DevicecreaterequestDataAttributes -
apple.appstore: DevicecreaterequestDataAttributes![](/images/permalink.svg)
Fields
- name string -
- platform BundleIdPlatform -
- udid string -
apple.appstore: DeviceResponse![](/images/permalink.svg)
Fields
- data Device -
- links DocumentLinks -
apple.appstore: DevicesResponse![](/images/permalink.svg)
Fields
- data Device[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: DeviceUpdateRequest![](/images/permalink.svg)
Fields
- data DeviceupdaterequestData -
apple.appstore: DeviceupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes DeviceupdaterequestDataAttributes? -
apple.appstore: DeviceupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- name string? -
- status string? -
apple.appstore: DiagnosticLog![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- links ResourceLinks -
apple.appstore: DiagnosticLogsResponse![](/images/permalink.svg)
Fields
- data DiagnosticLog[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: DiagnosticSignature![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes DiagnosticsignatureAttributes? -
- links ResourceLinks -
apple.appstore: DiagnosticsignatureAttributes![](/images/permalink.svg)
Fields
- diagnosticType string? -
- signature string? -
- weight decimal? -
apple.appstore: DiagnosticSignaturesResponse![](/images/permalink.svg)
Fields
- data DiagnosticSignature[] -
- included DiagnosticLog[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: DocumentLinks![](/images/permalink.svg)
Fields
- self string -
apple.appstore: EndUserLicenseAgreement![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetalicenseagreementAttributes? -
- relationships EnduserlicenseagreementRelationships? -
- links ResourceLinks -
apple.appstore: EndUserLicenseAgreementCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: EnduserlicenseagreementcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes EnduserlicenseagreementcreaterequestDataAttributes -
- relationships EnduserlicenseagreementcreaterequestDataRelationships -
apple.appstore: EnduserlicenseagreementcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- agreementText string -
apple.appstore: EnduserlicenseagreementcreaterequestDataRelationships![](/images/permalink.svg)
Fields
apple.appstore: EnduserlicenseagreementcreaterequestDataRelationshipsTerritories![](/images/permalink.svg)
Fields
apple.appstore: EnduserlicenseagreementRelationships![](/images/permalink.svg)
Fields
- territories AppRelationshipsAvailableterritories? -
apple.appstore: EndUserLicenseAgreementResponse![](/images/permalink.svg)
Fields
- data EndUserLicenseAgreement -
- included Territory[]? -
- links DocumentLinks -
apple.appstore: EndUserLicenseAgreementUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: EnduserlicenseagreementupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes BetalicenseagreementAttributes? -
- relationships EnduserlicenseagreementupdaterequestDataRelationships? -
apple.appstore: EnduserlicenseagreementupdaterequestDataRelationships![](/images/permalink.svg)
Fields
- territories AppupdaterequestDataRelationshipsAvailableterritories? -
apple.appstore: ErrorResponse![](/images/permalink.svg)
Fields
- errors ErrorresponseErrors[]? -
apple.appstore: ErrorresponseErrors![](/images/permalink.svg)
Fields
- id string? -
- status string -
- code string -
- title string -
- detail string -
apple.appstore: GameCenterEnabledVersion![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes GamecenterenabledversionAttributes? -
- relationships GamecenterenabledversionRelationships? -
- links ResourceLinks -
apple.appstore: GamecenterenabledversionAttributes![](/images/permalink.svg)
Fields
- platform Platform? -
- versionString string? -
- iconAsset ImageAsset? -
apple.appstore: GameCenterEnabledVersionCompatibleVersionsLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: GameCenterEnabledVersionCompatibleVersionsLinkagesResponse![](/images/permalink.svg)
Fields
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: GamecenterenabledversionRelationships![](/images/permalink.svg)
Fields
- compatibleVersions AppRelationshipsGamecenterenabledversions? -
apple.appstore: GameCenterEnabledVersionsResponse![](/images/permalink.svg)
Fields
- data GameCenterEnabledVersion[] -
- included GameCenterEnabledVersion[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: IdfaDeclaration![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes IdfadeclarationAttributes? -
- relationships AppstoreversionsubmissionRelationships? -
- links ResourceLinks -
apple.appstore: IdfadeclarationAttributes![](/images/permalink.svg)
Fields
- servesAds boolean? -
- attributesAppInstallationToPreviousAd boolean? -
- attributesActionWithPreviousAd boolean? -
- honorsLimitedAdTracking boolean? -
apple.appstore: IdfaDeclarationCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: IdfadeclarationcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes IdfadeclarationcreaterequestDataAttributes -
- relationships AppstorereviewdetailcreaterequestDataRelationships -
apple.appstore: IdfadeclarationcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- servesAds boolean -
- attributesAppInstallationToPreviousAd boolean -
- attributesActionWithPreviousAd boolean -
- honorsLimitedAdTracking boolean -
apple.appstore: IdfaDeclarationResponse![](/images/permalink.svg)
Fields
- data IdfaDeclaration -
- links DocumentLinks -
apple.appstore: IdfaDeclarationUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: IdfadeclarationupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes IdfadeclarationAttributes? -
apple.appstore: ImageAsset![](/images/permalink.svg)
Fields
- templateUrl string? -
- width int? -
- height int? -
apple.appstore: InAppPurchase![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes InapppurchaseAttributes? -
- relationships InapppurchaseRelationships? -
- links ResourceLinks -
apple.appstore: InapppurchaseAttributes![](/images/permalink.svg)
Fields
- referenceName string? -
- productId string? -
- inAppPurchaseType string? -
- state string? -
apple.appstore: InapppurchaseRelationships![](/images/permalink.svg)
Fields
- apps BetatesterRelationshipsApps? -
apple.appstore: InAppPurchaseResponse![](/images/permalink.svg)
Fields
- data InAppPurchase -
- links DocumentLinks -
apple.appstore: InAppPurchasesResponse![](/images/permalink.svg)
Fields
- data InAppPurchase[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: PagedDocumentLinks![](/images/permalink.svg)
Fields
- self string -
- first string? -
- next string? -
apple.appstore: PagingInformation![](/images/permalink.svg)
Fields
- paging PaginginformationPaging -
apple.appstore: PaginginformationPaging![](/images/permalink.svg)
Fields
- total int -
- 'limit int -
apple.appstore: PerfPowerMetric![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes PerfpowermetricAttributes? -
- links ResourceLinks -
apple.appstore: PerfpowermetricAttributes![](/images/permalink.svg)
Fields
- platform string? -
- metricType string? -
- deviceType string? -
apple.appstore: PerfPowerMetricsResponse![](/images/permalink.svg)
Fields
- data PerfPowerMetric[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: PrereleaseVersion![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes PrereleaseversionAttributes? -
- relationships PrereleaseversionRelationships? -
- links ResourceLinks -
apple.appstore: PrereleaseversionAttributes![](/images/permalink.svg)
Fields
- 'version string? -
- platform Platform? -
apple.appstore: PrereleaseversionRelationships![](/images/permalink.svg)
Fields
- builds AppRelationshipsBuilds? -
apple.appstore: PrereleaseVersionResponse![](/images/permalink.svg)
Fields
- data PrereleaseVersion -
- links DocumentLinks -
apple.appstore: PreReleaseVersionsResponse![](/images/permalink.svg)
Fields
- data PrereleaseVersion[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: Profile![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes ProfileAttributes? -
- relationships ProfileRelationships? -
- links ResourceLinks -
apple.appstore: ProfileAttributes![](/images/permalink.svg)
Fields
- name string? -
- platform BundleIdPlatform? -
- profileType string? -
- profileState string? -
- profileContent string? -
- uuid string? -
- createdDate string? -
- expirationDate string? -
apple.appstore: ProfileCreateRequest![](/images/permalink.svg)
Fields
- data ProfilecreaterequestData -
apple.appstore: ProfilecreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes ProfilecreaterequestDataAttributes -
- relationships ProfilecreaterequestDataRelationships -
apple.appstore: ProfilecreaterequestDataAttributes![](/images/permalink.svg)
Fields
- name string -
- profileType string -
apple.appstore: ProfilecreaterequestDataRelationships![](/images/permalink.svg)
Fields
- devices ProfilecreaterequestDataRelationshipsDevices? -
- certificates ProfilecreaterequestDataRelationshipsCertificates -
apple.appstore: ProfilecreaterequestDataRelationshipsCertificates![](/images/permalink.svg)
Fields
- data ProfileRelationshipsCertificatesData[] -
apple.appstore: ProfilecreaterequestDataRelationshipsDevices![](/images/permalink.svg)
Fields
- data ProfileRelationshipsDevicesData[]? -
apple.appstore: ProfileRelationships![](/images/permalink.svg)
Fields
- bundleId ProfileRelationshipsBundleid? -
- devices ProfileRelationshipsDevices? -
- certificates ProfileRelationshipsCertificates? -
apple.appstore: ProfileRelationshipsBundleid![](/images/permalink.svg)
Fields
apple.appstore: ProfileRelationshipsCertificates![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data ProfileRelationshipsCertificatesData[]? -
apple.appstore: ProfileRelationshipsCertificatesData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: ProfileRelationshipsDevices![](/images/permalink.svg)
Fields
- meta PagingInformation? -
- data ProfileRelationshipsDevicesData[]? -
apple.appstore: ProfileRelationshipsDevicesData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
apple.appstore: ProfileResponse![](/images/permalink.svg)
Fields
- data Profile -
- included (BundleId|Device|Certificate)[]? -
- links DocumentLinks -
apple.appstore: ProfilesResponse![](/images/permalink.svg)
Fields
- data Profile[] -
- included (BundleId|Device|Certificate)[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
apple.appstore: ResourceLinks![](/images/permalink.svg)
Fields
- self string -
apple.appstore: RoutingAppCoverage![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppstorereviewattachmentAttributes? -
- relationships AppstoreversionsubmissionRelationships? -
- links ResourceLinks -
apple.appstore: RoutingAppCoverageCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: RoutingappcoveragecreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes AppscreenshotcreaterequestDataAttributes -
- relationships AppstorereviewdetailcreaterequestDataRelationships -
apple.appstore: RoutingAppCoverageResponse![](/images/permalink.svg)
Fields
- data RoutingAppCoverage -
- links DocumentLinks -
apple.appstore: RoutingAppCoverageUpdateRequest![](/images/permalink.svg)
Fields
apple.appstore: RoutingappcoverageupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes AppscreenshotupdaterequestDataAttributes? -
apple.appstore: TerritoriesResponse![](/images/permalink.svg)
Fields
- data Territory[] -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: Territory![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes TerritoryAttributes? -
- links ResourceLinks -
apple.appstore: TerritoryAttributes![](/images/permalink.svg)
Fields
- currency string? -
apple.appstore: TerritoryResponse![](/images/permalink.svg)
Fields
- data Territory -
- links DocumentLinks -
apple.appstore: UploadOperation![](/images/permalink.svg)
Fields
- method string? -
- url string? -
- length int? -
- offset int? -
- requestHeaders UploadOperationHeader[]? -
apple.appstore: UploadOperationHeader![](/images/permalink.svg)
Fields
- name string? -
- value string? -
apple.appstore: User![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes UserAttributes? -
- relationships UserinvitationRelationships? -
- links ResourceLinks -
apple.appstore: UserAttributes![](/images/permalink.svg)
Fields
- username string? -
- firstName string? -
- lastName string? -
- roles UserRole[]? -
- allAppsVisible boolean? -
- provisioningAllowed boolean? -
apple.appstore: UserInvitation![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes UserinvitationAttributes? -
- relationships UserinvitationRelationships? -
- links ResourceLinks -
apple.appstore: UserinvitationAttributes![](/images/permalink.svg)
Fields
- email string? -
- firstName string? -
- lastName string? -
- expirationDate string? -
- roles UserRole[]? -
- allAppsVisible boolean? -
- provisioningAllowed boolean? -
apple.appstore: UserInvitationCreateRequest![](/images/permalink.svg)
Fields
apple.appstore: UserinvitationcreaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- attributes UserinvitationcreaterequestDataAttributes -
- relationships UserinvitationcreaterequestDataRelationships? -
apple.appstore: UserinvitationcreaterequestDataAttributes![](/images/permalink.svg)
Fields
- email string -
- firstName string -
- lastName string -
- roles UserRole[] -
- allAppsVisible boolean? -
- provisioningAllowed boolean? -
apple.appstore: UserinvitationcreaterequestDataRelationships![](/images/permalink.svg)
Fields
- visibleApps UserinvitationcreaterequestDataRelationshipsVisibleapps? -
apple.appstore: UserinvitationcreaterequestDataRelationshipsVisibleapps![](/images/permalink.svg)
Fields
apple.appstore: UserinvitationRelationships![](/images/permalink.svg)
Fields
- visibleApps BetatesterRelationshipsApps? -
apple.appstore: UserInvitationResponse![](/images/permalink.svg)
Fields
- data UserInvitation -
- included App[]? -
- links DocumentLinks -
apple.appstore: UserInvitationsResponse![](/images/permalink.svg)
Fields
- data UserInvitation[] -
- included App[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: UserResponse![](/images/permalink.svg)
Fields
- data User -
- included App[]? -
- links DocumentLinks -
apple.appstore: UsersResponse![](/images/permalink.svg)
Fields
- data User[] -
- included App[]? -
- links PagedDocumentLinks -
- meta PagingInformation? -
apple.appstore: UserUpdateRequest![](/images/permalink.svg)
Fields
- data UserupdaterequestData -
apple.appstore: UserupdaterequestData![](/images/permalink.svg)
Fields
- 'type string -
- id string -
- attributes UserupdaterequestDataAttributes? -
- relationships UserinvitationcreaterequestDataRelationships? -
apple.appstore: UserupdaterequestDataAttributes![](/images/permalink.svg)
Fields
- roles UserRole[]? -
- allAppsVisible boolean? -
- provisioningAllowed boolean? -
apple.appstore: UserVisibleAppsLinkagesRequest![](/images/permalink.svg)
Fields
apple.appstore: UserVisibleAppsLinkagesResponse![](/images/permalink.svg)
Fields
- links PagedDocumentLinks -
- meta PagingInformation? -
String types![](/images/permalink.svg)
apple.appstore: AppEncryptionDeclarationState![](/images/permalink.svg)
AppEncryptionDeclarationState
apple.appstore: AppStoreAgeRating![](/images/permalink.svg)
AppStoreAgeRating
apple.appstore: AppStoreVersionState![](/images/permalink.svg)
AppStoreVersionState
apple.appstore: BetaInviteType![](/images/permalink.svg)
BetaInviteType
apple.appstore: BetaReviewState![](/images/permalink.svg)
BetaReviewState
apple.appstore: BrazilAgeRating![](/images/permalink.svg)
BrazilAgeRating
apple.appstore: BundleIdPlatform![](/images/permalink.svg)
BundleIdPlatform
apple.appstore: CapabilityType![](/images/permalink.svg)
CapabilityType
apple.appstore: CertificateType![](/images/permalink.svg)
CertificateType
apple.appstore: ExternalBetaState![](/images/permalink.svg)
ExternalBetaState
apple.appstore: IconAssetType![](/images/permalink.svg)
IconAssetType
apple.appstore: InternalBetaState![](/images/permalink.svg)
InternalBetaState
apple.appstore: KidsAgeBand![](/images/permalink.svg)
KidsAgeBand
apple.appstore: PhasedReleaseState![](/images/permalink.svg)
PhasedReleaseState
apple.appstore: Platform![](/images/permalink.svg)
Platform
apple.appstore: PreviewType![](/images/permalink.svg)
PreviewType
apple.appstore: ScreenshotDisplayType![](/images/permalink.svg)
ScreenshotDisplayType
apple.appstore: UserRole![](/images/permalink.svg)
UserRole
Import
import ballerinax/apple.appstore;
Metadata
Released date: about 1 year ago
Version: 1.5.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Lifestyle & Entertainment/App Store
Cost/Paid
Contributors
Dependencies