Skip to content

Latest commit

 

History

History
198 lines (133 loc) · 7.47 KB

AppEventScreenshotsApi.md

File metadata and controls

198 lines (133 loc) · 7.47 KB

app_store_connect.api.AppEventScreenshotsApi

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
appEventScreenshotsCreateInstance POST /v1/appEventScreenshots
appEventScreenshotsDeleteInstance DELETE /v1/appEventScreenshots/{id}
appEventScreenshotsGetInstance GET /v1/appEventScreenshots/{id}
appEventScreenshotsUpdateInstance PATCH /v1/appEventScreenshots/{id}

appEventScreenshotsCreateInstance

AppEventScreenshotResponse appEventScreenshotsCreateInstance(appEventScreenshotCreateRequest)

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().getAppEventScreenshotsApi();
final AppEventScreenshotCreateRequest appEventScreenshotCreateRequest = ; // AppEventScreenshotCreateRequest | AppEventScreenshot representation

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

Parameters

Name Type Description Notes
appEventScreenshotCreateRequest AppEventScreenshotCreateRequest AppEventScreenshot representation

Return type

AppEventScreenshotResponse

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]

appEventScreenshotsDeleteInstance

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

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

appEventScreenshotsGetInstance

AppEventScreenshotResponse appEventScreenshotsGetInstance(id, fieldsLeftSquareBracketAppEventScreenshotsRightSquareBracket, 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().getAppEventScreenshotsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketAppEventScreenshotsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appEventScreenshots
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

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

Parameters

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

Return type

AppEventScreenshotResponse

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]

appEventScreenshotsUpdateInstance

AppEventScreenshotResponse appEventScreenshotsUpdateInstance(id, appEventScreenshotUpdateRequest)

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().getAppEventScreenshotsApi();
final String id = id_example; // String | the id of the requested resource
final AppEventScreenshotUpdateRequest appEventScreenshotUpdateRequest = ; // AppEventScreenshotUpdateRequest | AppEventScreenshot representation

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

Parameters

Name Type Description Notes
id String the id of the requested resource
appEventScreenshotUpdateRequest AppEventScreenshotUpdateRequest AppEventScreenshot representation

Return type

AppEventScreenshotResponse

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]