Skip to content

Latest commit

 

History

History
211 lines (146 loc) · 8.84 KB

DevicesApi.md

File metadata and controls

211 lines (146 loc) · 8.84 KB

app_store_connect.api.DevicesApi

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
devicesCreateInstance POST /v1/devices
devicesGetCollection GET /v1/devices
devicesGetInstance GET /v1/devices/{id}
devicesUpdateInstance PATCH /v1/devices/{id}

devicesCreateInstance

DeviceResponse devicesCreateInstance(deviceCreateRequest)

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().getDevicesApi();
final DeviceCreateRequest deviceCreateRequest = ; // DeviceCreateRequest | Device representation

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

Parameters

Name Type Description Notes
deviceCreateRequest DeviceCreateRequest Device representation

Return type

DeviceResponse

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]

devicesGetCollection

DevicesResponse devicesGetCollection(filterLeftSquareBracketNameRightSquareBracket, filterLeftSquareBracketPlatformRightSquareBracket, filterLeftSquareBracketStatusRightSquareBracket, filterLeftSquareBracketUdidRightSquareBracket, filterLeftSquareBracketIdRightSquareBracket, sort, fieldsLeftSquareBracketDevicesRightSquareBracket, 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().getDevicesApi();
final BuiltList<String> filterLeftSquareBracketNameRightSquareBracket = ; // BuiltList<String> | filter by attribute 'name'
final BuiltList<String> filterLeftSquareBracketPlatformRightSquareBracket = ; // BuiltList<String> | filter by attribute 'platform'
final BuiltList<String> filterLeftSquareBracketStatusRightSquareBracket = ; // BuiltList<String> | filter by attribute 'status'
final BuiltList<String> filterLeftSquareBracketUdidRightSquareBracket = ; // BuiltList<String> | filter by attribute 'udid'
final BuiltList<String> filterLeftSquareBracketIdRightSquareBracket = ; // BuiltList<String> | filter by id(s)
final BuiltList<String> sort = ; // BuiltList<String> | comma-separated list of sort expressions; resources will be sorted as specified
final BuiltList<String> fieldsLeftSquareBracketDevicesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type devices
final int limit = 56; // int | maximum resources per page

try {
    final response = api.devicesGetCollection(filterLeftSquareBracketNameRightSquareBracket, filterLeftSquareBracketPlatformRightSquareBracket, filterLeftSquareBracketStatusRightSquareBracket, filterLeftSquareBracketUdidRightSquareBracket, filterLeftSquareBracketIdRightSquareBracket, sort, fieldsLeftSquareBracketDevicesRightSquareBracket, limit);
    print(response);
} catch on DioError (e) {
    print('Exception when calling DevicesApi->devicesGetCollection: $e\n');
}

Parameters

Name Type Description Notes
filterLeftSquareBracketNameRightSquareBracket BuiltList<String> filter by attribute 'name' [optional]
filterLeftSquareBracketPlatformRightSquareBracket BuiltList<String> filter by attribute 'platform' [optional]
filterLeftSquareBracketStatusRightSquareBracket BuiltList<String> filter by attribute 'status' [optional]
filterLeftSquareBracketUdidRightSquareBracket BuiltList<String> filter by attribute 'udid' [optional]
filterLeftSquareBracketIdRightSquareBracket BuiltList<String> filter by id(s) [optional]
sort BuiltList<String> comma-separated list of sort expressions; resources will be sorted as specified [optional]
fieldsLeftSquareBracketDevicesRightSquareBracket BuiltList<String> the fields to include for returned resources of type devices [optional]
limit int maximum resources per page [optional]

Return type

DevicesResponse

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]

devicesGetInstance

DeviceResponse devicesGetInstance(id, fieldsLeftSquareBracketDevicesRightSquareBracket)

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

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

Parameters

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

Return type

DeviceResponse

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]

devicesUpdateInstance

DeviceResponse devicesUpdateInstance(id, deviceUpdateRequest)

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().getDevicesApi();
final String id = id_example; // String | the id of the requested resource
final DeviceUpdateRequest deviceUpdateRequest = ; // DeviceUpdateRequest | Device representation

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

Parameters

Name Type Description Notes
id String the id of the requested resource
deviceUpdateRequest DeviceUpdateRequest Device representation

Return type

DeviceResponse

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]