Skip to content

Latest commit

 

History

History
174 lines (124 loc) · 9.6 KB

CiMacOsVersionsApi.md

File metadata and controls

174 lines (124 loc) · 9.6 KB

app_store_connect.api.CiMacOsVersionsApi

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
ciMacOsVersionsGetCollection GET /v1/ciMacOsVersions
ciMacOsVersionsGetInstance GET /v1/ciMacOsVersions/{id}
ciMacOsVersionsXcodeVersionsGetToManyRelated GET /v1/ciMacOsVersions/{id}/xcodeVersions

ciMacOsVersionsGetCollection

CiMacOsVersionsResponse ciMacOsVersionsGetCollection(fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket, limit, include, fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket, limitLeftSquareBracketXcodeVersionsRightSquareBracket)

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().getCiMacOsVersionsApi();
final BuiltList<String> fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciMacOsVersions
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> fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciXcodeVersions
final int limitLeftSquareBracketXcodeVersionsRightSquareBracket = 56; // int | maximum number of related xcodeVersions returned (when they are included)

try {
    final response = api.ciMacOsVersionsGetCollection(fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket, limit, include, fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket, limitLeftSquareBracketXcodeVersionsRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CiMacOsVersionsApi->ciMacOsVersionsGetCollection: $e\n');
}

Parameters

Name Type Description Notes
fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciMacOsVersions [optional]
limit int maximum resources per page [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]
fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciXcodeVersions [optional]
limitLeftSquareBracketXcodeVersionsRightSquareBracket int maximum number of related xcodeVersions returned (when they are included) [optional]

Return type

CiMacOsVersionsResponse

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]

ciMacOsVersionsGetInstance

CiMacOsVersionResponse ciMacOsVersionsGetInstance(id, fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket, include, fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket, limitLeftSquareBracketXcodeVersionsRightSquareBracket)

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().getCiMacOsVersionsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciMacOsVersions
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final BuiltList<String> fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciXcodeVersions
final int limitLeftSquareBracketXcodeVersionsRightSquareBracket = 56; // int | maximum number of related xcodeVersions returned (when they are included)

try {
    final response = api.ciMacOsVersionsGetInstance(id, fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket, include, fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket, limitLeftSquareBracketXcodeVersionsRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CiMacOsVersionsApi->ciMacOsVersionsGetInstance: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciMacOsVersions [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]
fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciXcodeVersions [optional]
limitLeftSquareBracketXcodeVersionsRightSquareBracket int maximum number of related xcodeVersions returned (when they are included) [optional]

Return type

CiMacOsVersionResponse

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]

ciMacOsVersionsXcodeVersionsGetToManyRelated

CiXcodeVersionsResponse ciMacOsVersionsXcodeVersionsGetToManyRelated(id, fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket, fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket, limit, limitLeftSquareBracketMacOsVersionsRightSquareBracket, 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().getCiMacOsVersionsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciXcodeVersions
final BuiltList<String> fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciMacOsVersions
final int limit = 56; // int | maximum resources per page
final int limitLeftSquareBracketMacOsVersionsRightSquareBracket = 56; // int | maximum number of related macOsVersions returned (when they are included)
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.ciMacOsVersionsXcodeVersionsGetToManyRelated(id, fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket, fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket, limit, limitLeftSquareBracketMacOsVersionsRightSquareBracket, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CiMacOsVersionsApi->ciMacOsVersionsXcodeVersionsGetToManyRelated: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketCiXcodeVersionsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciXcodeVersions [optional]
fieldsLeftSquareBracketCiMacOsVersionsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciMacOsVersions [optional]
limit int maximum resources per page [optional]
limitLeftSquareBracketMacOsVersionsRightSquareBracket int maximum number of related macOsVersions returned (when they are included) [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

CiXcodeVersionsResponse

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]