Skip to content

Latest commit

 

History

History
301 lines (206 loc) · 13.1 KB

AppScreenshotSetsApi.md

File metadata and controls

301 lines (206 loc) · 13.1 KB

app_store_connect.api.AppScreenshotSetsApi

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
appScreenshotSetsAppScreenshotsGetToManyRelated GET /v1/appScreenshotSets/{id}/appScreenshots
appScreenshotSetsAppScreenshotsGetToManyRelationship GET /v1/appScreenshotSets/{id}/relationships/appScreenshots
appScreenshotSetsAppScreenshotsReplaceToManyRelationship PATCH /v1/appScreenshotSets/{id}/relationships/appScreenshots
appScreenshotSetsCreateInstance POST /v1/appScreenshotSets
appScreenshotSetsDeleteInstance DELETE /v1/appScreenshotSets/{id}
appScreenshotSetsGetInstance GET /v1/appScreenshotSets/{id}

appScreenshotSetsAppScreenshotsGetToManyRelated

AppScreenshotsResponse appScreenshotSetsAppScreenshotsGetToManyRelated(id, fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket, fieldsLeftSquareBracketAppScreenshotsRightSquareBracket, limit, 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().getAppScreenshotSetsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appScreenshotSets
final BuiltList<String> fieldsLeftSquareBracketAppScreenshotsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appScreenshots
final int limit = 56; // int | maximum resources per page
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.appScreenshotSetsAppScreenshotsGetToManyRelated(id, fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket, fieldsLeftSquareBracketAppScreenshotsRightSquareBracket, limit, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AppScreenshotSetsApi->appScreenshotSetsAppScreenshotsGetToManyRelated: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appScreenshotSets [optional]
fieldsLeftSquareBracketAppScreenshotsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appScreenshots [optional]
limit int maximum resources per page [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

AppScreenshotsResponse

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]

appScreenshotSetsAppScreenshotsGetToManyRelationship

AppScreenshotSetAppScreenshotsLinkagesResponse appScreenshotSetsAppScreenshotsGetToManyRelationship(id, limit)

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().getAppScreenshotSetsApi();
final String id = id_example; // String | the id of the requested resource
final int limit = 56; // int | maximum resources per page

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

Parameters

Name Type Description Notes
id String the id of the requested resource
limit int maximum resources per page [optional]

Return type

AppScreenshotSetAppScreenshotsLinkagesResponse

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]

appScreenshotSetsAppScreenshotsReplaceToManyRelationship

appScreenshotSetsAppScreenshotsReplaceToManyRelationship(id, appScreenshotSetAppScreenshotsLinkagesRequest)

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().getAppScreenshotSetsApi();
final String id = id_example; // String | the id of the requested resource
final AppScreenshotSetAppScreenshotsLinkagesRequest appScreenshotSetAppScreenshotsLinkagesRequest = ; // AppScreenshotSetAppScreenshotsLinkagesRequest | List of related linkages

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

Parameters

Name Type Description Notes
id String the id of the requested resource
appScreenshotSetAppScreenshotsLinkagesRequest AppScreenshotSetAppScreenshotsLinkagesRequest List of related linkages

Return type

void (empty response body)

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]

appScreenshotSetsCreateInstance

AppScreenshotSetResponse appScreenshotSetsCreateInstance(appScreenshotSetCreateRequest)

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().getAppScreenshotSetsApi();
final AppScreenshotSetCreateRequest appScreenshotSetCreateRequest = ; // AppScreenshotSetCreateRequest | AppScreenshotSet representation

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

Parameters

Name Type Description Notes
appScreenshotSetCreateRequest AppScreenshotSetCreateRequest AppScreenshotSet representation

Return type

AppScreenshotSetResponse

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]

appScreenshotSetsDeleteInstance

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

try {
    api.appScreenshotSetsDeleteInstance(id);
} catch on DioError (e) {
    print('Exception when calling AppScreenshotSetsApi->appScreenshotSetsDeleteInstance: $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]

appScreenshotSetsGetInstance

AppScreenshotSetResponse appScreenshotSetsGetInstance(id, fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket, include, fieldsLeftSquareBracketAppScreenshotsRightSquareBracket, limitLeftSquareBracketAppScreenshotsRightSquareBracket)

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().getAppScreenshotSetsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appScreenshotSets
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final BuiltList<String> fieldsLeftSquareBracketAppScreenshotsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appScreenshots
final int limitLeftSquareBracketAppScreenshotsRightSquareBracket = 56; // int | maximum number of related appScreenshots returned (when they are included)

try {
    final response = api.appScreenshotSetsGetInstance(id, fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket, include, fieldsLeftSquareBracketAppScreenshotsRightSquareBracket, limitLeftSquareBracketAppScreenshotsRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AppScreenshotSetsApi->appScreenshotSetsGetInstance: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketAppScreenshotSetsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appScreenshotSets [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]
fieldsLeftSquareBracketAppScreenshotsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appScreenshots [optional]
limitLeftSquareBracketAppScreenshotsRightSquareBracket int maximum number of related appScreenshots returned (when they are included) [optional]

Return type

AppScreenshotSetResponse

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]