Skip to content

Latest commit

 

History

History
278 lines (198 loc) · 15.2 KB

CiBuildActionsApi.md

File metadata and controls

278 lines (198 loc) · 15.2 KB

app_store_connect.api.CiBuildActionsApi

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
ciBuildActionsArtifactsGetToManyRelated GET /v1/ciBuildActions/{id}/artifacts
ciBuildActionsBuildRunGetToOneRelated GET /v1/ciBuildActions/{id}/buildRun
ciBuildActionsGetInstance GET /v1/ciBuildActions/{id}
ciBuildActionsIssuesGetToManyRelated GET /v1/ciBuildActions/{id}/issues
ciBuildActionsTestResultsGetToManyRelated GET /v1/ciBuildActions/{id}/testResults

ciBuildActionsArtifactsGetToManyRelated

CiArtifactsResponse ciBuildActionsArtifactsGetToManyRelated(id, fieldsLeftSquareBracketCiArtifactsRightSquareBracket, 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().getCiBuildActionsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketCiArtifactsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciArtifacts
final int limit = 56; // int | maximum resources per page

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

Parameters

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

Return type

CiArtifactsResponse

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]

ciBuildActionsBuildRunGetToOneRelated

CiBuildRunResponse ciBuildActionsBuildRunGetToOneRelated(id, fieldsLeftSquareBracketScmGitReferencesRightSquareBracket, fieldsLeftSquareBracketCiBuildRunsRightSquareBracket, fieldsLeftSquareBracketCiWorkflowsRightSquareBracket, fieldsLeftSquareBracketScmPullRequestsRightSquareBracket, fieldsLeftSquareBracketCiProductsRightSquareBracket, fieldsLeftSquareBracketBuildsRightSquareBracket, limitLeftSquareBracketBuildsRightSquareBracket, 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().getCiBuildActionsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketScmGitReferencesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type scmGitReferences
final BuiltList<String> fieldsLeftSquareBracketCiBuildRunsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciBuildRuns
final BuiltList<String> fieldsLeftSquareBracketCiWorkflowsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciWorkflows
final BuiltList<String> fieldsLeftSquareBracketScmPullRequestsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type scmPullRequests
final BuiltList<String> fieldsLeftSquareBracketCiProductsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciProducts
final BuiltList<String> fieldsLeftSquareBracketBuildsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type builds
final int limitLeftSquareBracketBuildsRightSquareBracket = 56; // int | maximum number of related builds returned (when they are included)
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.ciBuildActionsBuildRunGetToOneRelated(id, fieldsLeftSquareBracketScmGitReferencesRightSquareBracket, fieldsLeftSquareBracketCiBuildRunsRightSquareBracket, fieldsLeftSquareBracketCiWorkflowsRightSquareBracket, fieldsLeftSquareBracketScmPullRequestsRightSquareBracket, fieldsLeftSquareBracketCiProductsRightSquareBracket, fieldsLeftSquareBracketBuildsRightSquareBracket, limitLeftSquareBracketBuildsRightSquareBracket, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CiBuildActionsApi->ciBuildActionsBuildRunGetToOneRelated: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketScmGitReferencesRightSquareBracket BuiltList<String> the fields to include for returned resources of type scmGitReferences [optional]
fieldsLeftSquareBracketCiBuildRunsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciBuildRuns [optional]
fieldsLeftSquareBracketCiWorkflowsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciWorkflows [optional]
fieldsLeftSquareBracketScmPullRequestsRightSquareBracket BuiltList<String> the fields to include for returned resources of type scmPullRequests [optional]
fieldsLeftSquareBracketCiProductsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciProducts [optional]
fieldsLeftSquareBracketBuildsRightSquareBracket BuiltList<String> the fields to include for returned resources of type builds [optional]
limitLeftSquareBracketBuildsRightSquareBracket int maximum number of related builds returned (when they are included) [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

CiBuildRunResponse

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]

ciBuildActionsGetInstance

CiBuildActionResponse ciBuildActionsGetInstance(id, fieldsLeftSquareBracketCiBuildActionsRightSquareBracket, include, fieldsLeftSquareBracketCiIssuesRightSquareBracket, fieldsLeftSquareBracketCiBuildRunsRightSquareBracket, fieldsLeftSquareBracketCiTestResultsRightSquareBracket, fieldsLeftSquareBracketCiArtifactsRightSquareBracket)

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().getCiBuildActionsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketCiBuildActionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciBuildActions
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final BuiltList<String> fieldsLeftSquareBracketCiIssuesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciIssues
final BuiltList<String> fieldsLeftSquareBracketCiBuildRunsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciBuildRuns
final BuiltList<String> fieldsLeftSquareBracketCiTestResultsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciTestResults
final BuiltList<String> fieldsLeftSquareBracketCiArtifactsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciArtifacts

try {
    final response = api.ciBuildActionsGetInstance(id, fieldsLeftSquareBracketCiBuildActionsRightSquareBracket, include, fieldsLeftSquareBracketCiIssuesRightSquareBracket, fieldsLeftSquareBracketCiBuildRunsRightSquareBracket, fieldsLeftSquareBracketCiTestResultsRightSquareBracket, fieldsLeftSquareBracketCiArtifactsRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CiBuildActionsApi->ciBuildActionsGetInstance: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketCiBuildActionsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciBuildActions [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]
fieldsLeftSquareBracketCiIssuesRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciIssues [optional]
fieldsLeftSquareBracketCiBuildRunsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciBuildRuns [optional]
fieldsLeftSquareBracketCiTestResultsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciTestResults [optional]
fieldsLeftSquareBracketCiArtifactsRightSquareBracket BuiltList<String> the fields to include for returned resources of type ciArtifacts [optional]

Return type

CiBuildActionResponse

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]

ciBuildActionsIssuesGetToManyRelated

CiIssuesResponse ciBuildActionsIssuesGetToManyRelated(id, fieldsLeftSquareBracketCiIssuesRightSquareBracket, 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().getCiBuildActionsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketCiIssuesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciIssues
final int limit = 56; // int | maximum resources per page

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

Parameters

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

Return type

CiIssuesResponse

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]

ciBuildActionsTestResultsGetToManyRelated

CiTestResultsResponse ciBuildActionsTestResultsGetToManyRelated(id, fieldsLeftSquareBracketCiTestResultsRightSquareBracket, 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().getCiBuildActionsApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketCiTestResultsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type ciTestResults
final int limit = 56; // int | maximum resources per page

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

Parameters

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

Return type

CiTestResultsResponse

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]