Skip to content

Latest commit

 

History

History
215 lines (150 loc) · 10.1 KB

AppCategoriesApi.md

File metadata and controls

215 lines (150 loc) · 10.1 KB

app_store_connect.api.AppCategoriesApi

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
appCategoriesGetCollection GET /v1/appCategories
appCategoriesGetInstance GET /v1/appCategories/{id}
appCategoriesParentGetToOneRelated GET /v1/appCategories/{id}/parent
appCategoriesSubcategoriesGetToManyRelated GET /v1/appCategories/{id}/subcategories

appCategoriesGetCollection

AppCategoriesResponse appCategoriesGetCollection(filterLeftSquareBracketPlatformsRightSquareBracket, existsLeftSquareBracketParentRightSquareBracket, fieldsLeftSquareBracketAppCategoriesRightSquareBracket, limit, include, limitLeftSquareBracketSubcategoriesRightSquareBracket)

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().getAppCategoriesApi();
final BuiltList<String> filterLeftSquareBracketPlatformsRightSquareBracket = ; // BuiltList<String> | filter by attribute 'platforms'
final bool existsLeftSquareBracketParentRightSquareBracket = true; // bool | filter by existence or non-existence of related 'parent'
final BuiltList<String> fieldsLeftSquareBracketAppCategoriesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appCategories
final int limit = 56; // int | maximum resources per page
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final int limitLeftSquareBracketSubcategoriesRightSquareBracket = 56; // int | maximum number of related subcategories returned (when they are included)

try {
    final response = api.appCategoriesGetCollection(filterLeftSquareBracketPlatformsRightSquareBracket, existsLeftSquareBracketParentRightSquareBracket, fieldsLeftSquareBracketAppCategoriesRightSquareBracket, limit, include, limitLeftSquareBracketSubcategoriesRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AppCategoriesApi->appCategoriesGetCollection: $e\n');
}

Parameters

Name Type Description Notes
filterLeftSquareBracketPlatformsRightSquareBracket BuiltList<String> filter by attribute 'platforms' [optional]
existsLeftSquareBracketParentRightSquareBracket bool filter by existence or non-existence of related 'parent' [optional]
fieldsLeftSquareBracketAppCategoriesRightSquareBracket BuiltList<String> the fields to include for returned resources of type appCategories [optional]
limit int maximum resources per page [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]
limitLeftSquareBracketSubcategoriesRightSquareBracket int maximum number of related subcategories returned (when they are included) [optional]

Return type

AppCategoriesResponse

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]

appCategoriesGetInstance

AppCategoryResponse appCategoriesGetInstance(id, fieldsLeftSquareBracketAppCategoriesRightSquareBracket, include, limitLeftSquareBracketSubcategoriesRightSquareBracket)

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().getAppCategoriesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketAppCategoriesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appCategories
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final int limitLeftSquareBracketSubcategoriesRightSquareBracket = 56; // int | maximum number of related subcategories returned (when they are included)

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

Parameters

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

Return type

AppCategoryResponse

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]

appCategoriesParentGetToOneRelated

AppCategoryResponse appCategoriesParentGetToOneRelated(id, fieldsLeftSquareBracketAppCategoriesRightSquareBracket)

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

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

Parameters

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

Return type

AppCategoryResponse

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]

appCategoriesSubcategoriesGetToManyRelated

AppCategoriesResponse appCategoriesSubcategoriesGetToManyRelated(id, fieldsLeftSquareBracketAppCategoriesRightSquareBracket, 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().getAppCategoriesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketAppCategoriesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type appCategories
final int limit = 56; // int | maximum resources per page

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

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketAppCategoriesRightSquareBracket BuiltList<String> the fields to include for returned resources of type appCategories [optional]
limit int maximum resources per page [optional]

Return type

AppCategoriesResponse

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]