Skip to content

Latest commit

 

History

History
198 lines (133 loc) · 7.1 KB

AppScreenshotsApi.md

File metadata and controls

198 lines (133 loc) · 7.1 KB

app_store_connect.api.AppScreenshotsApi

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
appScreenshotsCreateInstance POST /v1/appScreenshots
appScreenshotsDeleteInstance DELETE /v1/appScreenshots/{id}
appScreenshotsGetInstance GET /v1/appScreenshots/{id}
appScreenshotsUpdateInstance PATCH /v1/appScreenshots/{id}

appScreenshotsCreateInstance

AppScreenshotResponse appScreenshotsCreateInstance(appScreenshotCreateRequest)

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().getAppScreenshotsApi();
final AppScreenshotCreateRequest appScreenshotCreateRequest = ; // AppScreenshotCreateRequest | AppScreenshot representation

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

Parameters

Name Type Description Notes
appScreenshotCreateRequest AppScreenshotCreateRequest AppScreenshot representation

Return type

AppScreenshotResponse

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]

appScreenshotsDeleteInstance

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

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

appScreenshotsGetInstance

AppScreenshotResponse appScreenshotsGetInstance(id, fieldsLeftSquareBracketAppScreenshotsRightSquareBracket, 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().getAppScreenshotsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketAppScreenshotsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appScreenshots
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

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

Parameters

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

Return type

AppScreenshotResponse

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]

appScreenshotsUpdateInstance

AppScreenshotResponse appScreenshotsUpdateInstance(id, appScreenshotUpdateRequest)

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().getAppScreenshotsApi();
final String id = id_example; // String | the id of the requested resource
final AppScreenshotUpdateRequest appScreenshotUpdateRequest = ; // AppScreenshotUpdateRequest | AppScreenshot representation

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

Parameters

Name Type Description Notes
id String the id of the requested resource
appScreenshotUpdateRequest AppScreenshotUpdateRequest AppScreenshot representation

Return type

AppScreenshotResponse

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]