Skip to content

Latest commit

 

History

History
261 lines (181 loc) · 13.3 KB

AppCustomProductPagesApi.md

File metadata and controls

261 lines (181 loc) · 13.3 KB

app_store_connect.api.AppCustomProductPagesApi

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
appCustomProductPagesAppCustomProductPageVersionsGetToManyRelated GET /v1/appCustomProductPages/{id}/appCustomProductPageVersions
appCustomProductPagesCreateInstance POST /v1/appCustomProductPages
appCustomProductPagesDeleteInstance DELETE /v1/appCustomProductPages/{id}
appCustomProductPagesGetInstance GET /v1/appCustomProductPages/{id}
appCustomProductPagesUpdateInstance PATCH /v1/appCustomProductPages/{id}

appCustomProductPagesAppCustomProductPageVersionsGetToManyRelated

AppCustomProductPageVersionsResponse appCustomProductPagesAppCustomProductPageVersionsGetToManyRelated(id, filterLeftSquareBracketStateRightSquareBracket, fieldsLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket, fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket, fieldsLeftSquareBracketAppCustomProductPagesRightSquareBracket, limit, limitLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket, 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().getAppCustomProductPagesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> filterLeftSquareBracketStateRightSquareBracket = ; // BuiltList<String> | filter by attribute 'state'
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> fieldsLeftSquareBracketAppCustomProductPagesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appCustomProductPages
final int limit = 56; // int | maximum resources per page
final int limitLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket = 56; // int | maximum number of related appCustomProductPageLocalizations returned (when they are included)
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

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

Parameters

Name Type Description Notes
id String the id of the requested resource
filterLeftSquareBracketStateRightSquareBracket BuiltList<String> filter by attribute 'state' [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]
fieldsLeftSquareBracketAppCustomProductPagesRightSquareBracket BuiltList<String> the fields to include for returned resources of type appCustomProductPages [optional]
limit int maximum resources per page [optional]
limitLeftSquareBracketAppCustomProductPageLocalizationsRightSquareBracket int maximum number of related appCustomProductPageLocalizations returned (when they are included) [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

AppCustomProductPageVersionsResponse

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]

appCustomProductPagesCreateInstance

AppCustomProductPageResponse appCustomProductPagesCreateInstance(appCustomProductPageCreateRequest)

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().getAppCustomProductPagesApi();
final AppCustomProductPageCreateRequest appCustomProductPageCreateRequest = ; // AppCustomProductPageCreateRequest | AppCustomProductPage representation

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

Parameters

Name Type Description Notes
appCustomProductPageCreateRequest AppCustomProductPageCreateRequest AppCustomProductPage representation

Return type

AppCustomProductPageResponse

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]

appCustomProductPagesDeleteInstance

appCustomProductPagesDeleteInstance(id)

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().getAppCustomProductPagesApi();
final String id = id_example; // String | the id of the requested resource

try {
    api.appCustomProductPagesDeleteInstance(id);
} catch on DioError (e) {
    print('Exception when calling AppCustomProductPagesApi->appCustomProductPagesDeleteInstance: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource

Return type

void (empty response body)

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]

appCustomProductPagesGetInstance

AppCustomProductPageResponse appCustomProductPagesGetInstance(id, fieldsLeftSquareBracketAppCustomProductPagesRightSquareBracket, include, fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket, limitLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket)

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().getAppCustomProductPagesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketAppCustomProductPagesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appCustomProductPages
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final BuiltList<String> fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appCustomProductPageVersions
final int limitLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket = 56; // int | maximum number of related appCustomProductPageVersions returned (when they are included)

try {
    final response = api.appCustomProductPagesGetInstance(id, fieldsLeftSquareBracketAppCustomProductPagesRightSquareBracket, include, fieldsLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket, limitLeftSquareBracketAppCustomProductPageVersionsRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AppCustomProductPagesApi->appCustomProductPagesGetInstance: $e\n');
}

Parameters

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

Return type

AppCustomProductPageResponse

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]

appCustomProductPagesUpdateInstance

AppCustomProductPageResponse appCustomProductPagesUpdateInstance(id, appCustomProductPageUpdateRequest)

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().getAppCustomProductPagesApi();
final String id = id_example; // String | the id of the requested resource
final AppCustomProductPageUpdateRequest appCustomProductPageUpdateRequest = ; // AppCustomProductPageUpdateRequest | AppCustomProductPage representation

try {
    final response = api.appCustomProductPagesUpdateInstance(id, appCustomProductPageUpdateRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AppCustomProductPagesApi->appCustomProductPagesUpdateInstance: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
appCustomProductPageUpdateRequest AppCustomProductPageUpdateRequest AppCustomProductPage representation

Return type

AppCustomProductPageResponse

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]