Skip to content

Latest commit

 

History

History
263 lines (183 loc) · 12.3 KB

AppEventsApi.md

File metadata and controls

263 lines (183 loc) · 12.3 KB

app_store_connect.api.AppEventsApi

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
appEventsCreateInstance POST /v1/appEvents
appEventsDeleteInstance DELETE /v1/appEvents/{id}
appEventsGetInstance GET /v1/appEvents/{id}
appEventsLocalizationsGetToManyRelated GET /v1/appEvents/{id}/localizations
appEventsUpdateInstance PATCH /v1/appEvents/{id}

appEventsCreateInstance

AppEventResponse appEventsCreateInstance(appEventCreateRequest)

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().getAppEventsApi();
final AppEventCreateRequest appEventCreateRequest = ; // AppEventCreateRequest | AppEvent representation

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

Parameters

Name Type Description Notes
appEventCreateRequest AppEventCreateRequest AppEvent representation

Return type

AppEventResponse

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]

appEventsDeleteInstance

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

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

appEventsGetInstance

AppEventResponse appEventsGetInstance(id, fieldsLeftSquareBracketAppEventsRightSquareBracket, include, fieldsLeftSquareBracketAppEventLocalizationsRightSquareBracket, limitLeftSquareBracketLocalizationsRightSquareBracket)

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().getAppEventsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketAppEventsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appEvents
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final BuiltList<String> fieldsLeftSquareBracketAppEventLocalizationsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appEventLocalizations
final int limitLeftSquareBracketLocalizationsRightSquareBracket = 56; // int | maximum number of related localizations returned (when they are included)

try {
    final response = api.appEventsGetInstance(id, fieldsLeftSquareBracketAppEventsRightSquareBracket, include, fieldsLeftSquareBracketAppEventLocalizationsRightSquareBracket, limitLeftSquareBracketLocalizationsRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AppEventsApi->appEventsGetInstance: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketAppEventsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appEvents [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]
fieldsLeftSquareBracketAppEventLocalizationsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appEventLocalizations [optional]
limitLeftSquareBracketLocalizationsRightSquareBracket int maximum number of related localizations returned (when they are included) [optional]

Return type

AppEventResponse

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]

appEventsLocalizationsGetToManyRelated

AppEventLocalizationsResponse appEventsLocalizationsGetToManyRelated(id, fieldsLeftSquareBracketAppEventScreenshotsRightSquareBracket, fieldsLeftSquareBracketAppEventVideoClipsRightSquareBracket, fieldsLeftSquareBracketAppEventLocalizationsRightSquareBracket, fieldsLeftSquareBracketAppEventsRightSquareBracket, limit, limitLeftSquareBracketAppEventScreenshotsRightSquareBracket, limitLeftSquareBracketAppEventVideoClipsRightSquareBracket, 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().getAppEventsApi();
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> fieldsLeftSquareBracketAppEventVideoClipsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appEventVideoClips
final BuiltList<String> fieldsLeftSquareBracketAppEventLocalizationsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appEventLocalizations
final BuiltList<String> fieldsLeftSquareBracketAppEventsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appEvents
final int limit = 56; // int | maximum resources per page
final int limitLeftSquareBracketAppEventScreenshotsRightSquareBracket = 56; // int | maximum number of related appEventScreenshots returned (when they are included)
final int limitLeftSquareBracketAppEventVideoClipsRightSquareBracket = 56; // int | maximum number of related appEventVideoClips returned (when they are included)
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.appEventsLocalizationsGetToManyRelated(id, fieldsLeftSquareBracketAppEventScreenshotsRightSquareBracket, fieldsLeftSquareBracketAppEventVideoClipsRightSquareBracket, fieldsLeftSquareBracketAppEventLocalizationsRightSquareBracket, fieldsLeftSquareBracketAppEventsRightSquareBracket, limit, limitLeftSquareBracketAppEventScreenshotsRightSquareBracket, limitLeftSquareBracketAppEventVideoClipsRightSquareBracket, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AppEventsApi->appEventsLocalizationsGetToManyRelated: $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]
fieldsLeftSquareBracketAppEventVideoClipsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appEventVideoClips [optional]
fieldsLeftSquareBracketAppEventLocalizationsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appEventLocalizations [optional]
fieldsLeftSquareBracketAppEventsRightSquareBracket BuiltList<String> the fields to include for returned resources of type appEvents [optional]
limit int maximum resources per page [optional]
limitLeftSquareBracketAppEventScreenshotsRightSquareBracket int maximum number of related appEventScreenshots returned (when they are included) [optional]
limitLeftSquareBracketAppEventVideoClipsRightSquareBracket int maximum number of related appEventVideoClips returned (when they are included) [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

AppEventLocalizationsResponse

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]

appEventsUpdateInstance

AppEventResponse appEventsUpdateInstance(id, appEventUpdateRequest)

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().getAppEventsApi();
final String id = id_example; // String | the id of the requested resource
final AppEventUpdateRequest appEventUpdateRequest = ; // AppEventUpdateRequest | AppEvent representation

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

Parameters

Name Type Description Notes
id String the id of the requested resource
appEventUpdateRequest AppEventUpdateRequest AppEvent representation

Return type

AppEventResponse

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]