Skip to content

Latest commit

 

History

History
174 lines (124 loc) · 11.2 KB

AppCustomProductPageVersionsApi.md

File metadata and controls

174 lines (124 loc) · 11.2 KB

app_store_connect.api.AppCustomProductPageVersionsApi

Load the API package

import 'package:app_store_connect/api.dart';

All URIs are relative to https://api.appstoreconnect.apple.com

Method HTTP request Description
appCustomProductPageVersionsAppCustomProductPageLocalizationsGetToManyRelated GET /v1/appCustomProductPageVersions/{id}/appCustomProductPageLocalizations
appCustomProductPageVersionsCreateInstance POST /v1/appCustomProductPageVersions
appCustomProductPageVersionsGetInstance GET /v1/appCustomProductPageVersions/{id}

appCustomProductPageVersionsAppCustomProductPageLocalizationsGetToManyRelated

AppCustomProductPageLocalizationsResponse appCustomProductPageVersionsAppCustomProductPageLocalizationsGetToManyRelated(id, filterLeftSquareBracketLocaleRightSquareBracket, fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket, fieldsLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket, fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket, fieldsLeftSquareBracketAppPreviewSetsRightSquareBracket, limit, limitLeftSquareBracketAppScreenshotSetsRightSquareBracket, limitLeftSquareBracketAppPreviewSetsRightSquareBracket, include)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getAppCustomProductPageVersionsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> filterLeftSquareBracketLocaleRightSquareBracket = ; // BuiltList<String> | filter by attribute 'locale'
final BuiltList<String> fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appScreenshotSets
final BuiltList<String> fieldsLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appCustomProductPageLocalizations
final BuiltList<String> fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appCustomProductPageVersions
final BuiltList<String> fieldsLeftSquareBracketAppPreviewSetsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appPreviewSets
final int limit = 56; // int | maximum resources per page
final int limitLeftSquareBracketAppScreenshotSetsRightSquareBracket = 56; // int | maximum number of related appScreenshotSets returned (when they are included)
final int limitLeftSquareBracketAppPreviewSetsRightSquareBracket = 56; // int | maximum number of related appPreviewSets returned (when they are included)
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.appCustomProductPageVersionsAppCustomProductPageLocalizationsGetToManyRelated(id, filterLeftSquareBracketLocaleRightSquareBracket, fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket, fieldsLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket, fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket, fieldsLeftSquareBracketAppPreviewSetsRightSquareBracket, limit, limitLeftSquareBracketAppScreenshotSetsRightSquareBracket, limitLeftSquareBracketAppPreviewSetsRightSquareBracket, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AppCustomProductPageVersionsApi->appCustomProductPageVersionsAppCustomProductPageLocalizationsGetToManyRelated: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
filterLeftSquareBracketLocaleRightSquareBracket BuiltList<String> filter by attribute 'locale' [optional]
fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appScreenshotSets [optional]
fieldsLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appCustomProductPageLocalizations [optional]
fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appCustomProductPageVersions [optional]
fieldsLeftSquareBracketAppPreviewSetsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appPreviewSets [optional]
limit int maximum resources per page [optional]
limitLeftSquareBracketAppScreenshotSetsRightSquareBracket int maximum number of related appScreenshotSets returned (when they are included) [optional]
limitLeftSquareBracketAppPreviewSetsRightSquareBracket int maximum number of related appPreviewSets returned (when they are included) [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

AppCustomProductPageLocalizationsResponse

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

appCustomProductPageVersionsCreateInstance

AppCustomProductPageVersionResponse appCustomProductPageVersionsCreateInstance(appCustomProductPageVersionCreateRequest)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getAppCustomProductPageVersionsApi();
final AppCustomProductPageVersionCreateRequest appCustomProductPageVersionCreateRequest = ; // AppCustomProductPageVersionCreateRequest | AppCustomProductPageVersion representation

try {
    final response = api.appCustomProductPageVersionsCreateInstance(appCustomProductPageVersionCreateRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AppCustomProductPageVersionsApi->appCustomProductPageVersionsCreateInstance: $e\n');
}

Parameters

Name Type Description Notes
appCustomProductPageVersionCreateRequest AppCustomProductPageVersionCreateRequest AppCustomProductPageVersion representation

Return type

AppCustomProductPageVersionResponse

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

appCustomProductPageVersionsGetInstance

AppCustomProductPageVersionResponse appCustomProductPageVersionsGetInstance(id, fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket, include, fieldsLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket, limitLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getAppCustomProductPageVersionsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appCustomProductPageVersions
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final BuiltList<String> fieldsLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appCustomProductPageLocalizations
final int limitLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket = 56; // int | maximum number of related appCustomProductPageLocalizations returned (when they are included)

try {
    final response = api.appCustomProductPageVersionsGetInstance(id, fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket, include, fieldsLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket, limitLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AppCustomProductPageVersionsApi->appCustomProductPageVersionsGetInstance: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appCustomProductPageVersions [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]
fieldsLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appCustomProductPageLocalizations [optional]
limitLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket int maximum number of related appCustomProductPageLocalizations returned (when they are included) [optional]

Return type

AppCustomProductPageVersionResponse

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]