Skip to content

Latest commit

 

History

History
302 lines (207 loc) · 13.2 KB

BetaAppLocalizationsApi.md

File metadata and controls

302 lines (207 loc) · 13.2 KB

app_store_connect.api.BetaAppLocalizationsApi

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
betaAppLocalizationsAppGetToOneRelated GET /v1/betaAppLocalizations/{id}/app
betaAppLocalizationsCreateInstance POST /v1/betaAppLocalizations
betaAppLocalizationsDeleteInstance DELETE /v1/betaAppLocalizations/{id}
betaAppLocalizationsGetCollection GET /v1/betaAppLocalizations
betaAppLocalizationsGetInstance GET /v1/betaAppLocalizations/{id}
betaAppLocalizationsUpdateInstance PATCH /v1/betaAppLocalizations/{id}

betaAppLocalizationsAppGetToOneRelated

AppResponse betaAppLocalizationsAppGetToOneRelated(id, fieldsLeftSquareBracketAppsRightSquareBracket)

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().getBetaAppLocalizationsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketAppsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type apps

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

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketAppsRightSquareBracket BuiltList<String> the fields to include for returned resources of type apps [optional]

Return type

AppResponse

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]

betaAppLocalizationsCreateInstance

BetaAppLocalizationResponse betaAppLocalizationsCreateInstance(betaAppLocalizationCreateRequest)

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().getBetaAppLocalizationsApi();
final BetaAppLocalizationCreateRequest betaAppLocalizationCreateRequest = ; // BetaAppLocalizationCreateRequest | BetaAppLocalization representation

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

Parameters

Name Type Description Notes
betaAppLocalizationCreateRequest BetaAppLocalizationCreateRequest BetaAppLocalization representation

Return type

BetaAppLocalizationResponse

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]

betaAppLocalizationsDeleteInstance

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

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

betaAppLocalizationsGetCollection

BetaAppLocalizationsResponse betaAppLocalizationsGetCollection(filterLeftSquareBracketLocaleRightSquareBracket, filterLeftSquareBracketAppRightSquareBracket, fieldsLeftSquareBracketBetaAppLocalizationsRightSquareBracket, limit, include, fieldsLeftSquareBracketAppsRightSquareBracket)

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().getBetaAppLocalizationsApi();
final BuiltList<String> filterLeftSquareBracketLocaleRightSquareBracket = ; // BuiltList<String> | filter by attribute 'locale'
final BuiltList<String> filterLeftSquareBracketAppRightSquareBracket = ; // BuiltList<String> | filter by id(s) of related 'app'
final BuiltList<String> fieldsLeftSquareBracketBetaAppLocalizationsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type betaAppLocalizations
final int limit = 56; // int | maximum resources per page
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final BuiltList<String> fieldsLeftSquareBracketAppsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type apps

try {
    final response = api.betaAppLocalizationsGetCollection(filterLeftSquareBracketLocaleRightSquareBracket, filterLeftSquareBracketAppRightSquareBracket, fieldsLeftSquareBracketBetaAppLocalizationsRightSquareBracket, limit, include, fieldsLeftSquareBracketAppsRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling BetaAppLocalizationsApi->betaAppLocalizationsGetCollection: $e\n');
}

Parameters

Name Type Description Notes
filterLeftSquareBracketLocaleRightSquareBracket BuiltList<String> filter by attribute 'locale' [optional]
filterLeftSquareBracketAppRightSquareBracket BuiltList<String> filter by id(s) of related 'app' [optional]
fieldsLeftSquareBracketBetaAppLocalizationsRightSquareBracket BuiltList<String> the fields to include for returned resources of type betaAppLocalizations [optional]
limit int maximum resources per page [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]
fieldsLeftSquareBracketAppsRightSquareBracket BuiltList<String> the fields to include for returned resources of type apps [optional]

Return type

BetaAppLocalizationsResponse

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]

betaAppLocalizationsGetInstance

BetaAppLocalizationResponse betaAppLocalizationsGetInstance(id, fieldsLeftSquareBracketBetaAppLocalizationsRightSquareBracket, include, fieldsLeftSquareBracketAppsRightSquareBracket)

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().getBetaAppLocalizationsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketBetaAppLocalizationsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type betaAppLocalizations
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final BuiltList<String> fieldsLeftSquareBracketAppsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type apps

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

Parameters

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

Return type

BetaAppLocalizationResponse

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]

betaAppLocalizationsUpdateInstance

BetaAppLocalizationResponse betaAppLocalizationsUpdateInstance(id, betaAppLocalizationUpdateRequest)

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().getBetaAppLocalizationsApi();
final String id = id_example; // String | the id of the requested resource
final BetaAppLocalizationUpdateRequest betaAppLocalizationUpdateRequest = ; // BetaAppLocalizationUpdateRequest | BetaAppLocalization representation

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

Parameters

Name Type Description Notes
id String the id of the requested resource
betaAppLocalizationUpdateRequest BetaAppLocalizationUpdateRequest BetaAppLocalization representation

Return type

BetaAppLocalizationResponse

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]