| Index: generated/googleapis/lib/androiddeviceprovisioning/v1.dart
|
| diff --git a/generated/googleapis/lib/androiddeviceprovisioning/v1.dart b/generated/googleapis/lib/androiddeviceprovisioning/v1.dart
|
| index fa36b1fe55bcc9c2ff9dacc7707a7d3151bfd482..ef50c68e8073b878721ea2f2df81c58de49ad9fa 100644
|
| --- a/generated/googleapis/lib/androiddeviceprovisioning/v1.dart
|
| +++ b/generated/googleapis/lib/androiddeviceprovisioning/v1.dart
|
| @@ -9,51 +9,48 @@ import 'dart:convert' as convert;
|
| import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
|
| import 'package:http/http.dart' as http;
|
|
|
| -export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
|
| - ApiRequestError, DetailedApiRequestError;
|
| +export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
|
| + show ApiRequestError, DetailedApiRequestError;
|
|
|
| const core.String USER_AGENT = 'dart-api-client androiddeviceprovisioning/v1';
|
|
|
| -/**
|
| - * Automates reseller integration into Zero Touch Provisioning by assigning
|
| - * devices to customers and creating device reports.
|
| - */
|
| +/// Automates reseller integration into Zero Touch Provisioning by assigning
|
| +/// devices to customers and creating device reports.
|
| class AndroiddeviceprovisioningApi {
|
| -
|
| final commons.ApiRequester _requester;
|
|
|
| OperationsResourceApi get operations => new OperationsResourceApi(_requester);
|
| PartnersResourceApi get partners => new PartnersResourceApi(_requester);
|
|
|
| - AndroiddeviceprovisioningApi(http.Client client, {core.String rootUrl: "https://androiddeviceprovisioning.googleapis.com/", core.String servicePath: ""}) :
|
| - _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
|
| + AndroiddeviceprovisioningApi(http.Client client,
|
| + {core.String rootUrl: "https://androiddeviceprovisioning.googleapis.com/",
|
| + core.String servicePath: ""})
|
| + : _requester =
|
| + new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
|
| }
|
|
|
| -
|
| class OperationsResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - OperationsResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Gets the latest state of a long-running operation. Clients can use this
|
| - * method to poll the operation result at intervals as recommended by the API
|
| - * service.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - The name of the operation resource.
|
| - * Value must have pattern "^operations/.+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| + OperationsResourceApi(commons.ApiRequester client) : _requester = client;
|
| +
|
| + /// Gets the latest state of a long-running operation. Clients can use this
|
| + /// method to poll the operation result at intervals as recommended by the
|
| + /// API
|
| + /// service.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - The name of the operation resource.
|
| + /// Value must have pattern "^operations/.+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| async.Future<Operation> get(core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -68,52 +65,96 @@ class OperationsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Operation.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| class PartnersResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - PartnersCustomersResourceApi get customers => new PartnersCustomersResourceApi(_requester);
|
| - PartnersDevicesResourceApi get devices => new PartnersDevicesResourceApi(_requester);
|
| + PartnersCustomersResourceApi get customers =>
|
| + new PartnersCustomersResourceApi(_requester);
|
| + PartnersDevicesResourceApi get devices =>
|
| + new PartnersDevicesResourceApi(_requester);
|
|
|
| - PartnersResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| + PartnersResourceApi(commons.ApiRequester client) : _requester = client;
|
| }
|
|
|
| -
|
| class PartnersCustomersResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - PartnersCustomersResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * List all the customers that has delegates some role to this customer.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [partnerId] - the id of the partner.
|
| - * Value must have pattern "^[^/]+$".
|
| - *
|
| - * Completes with a [ListCustomersResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| + PartnersCustomersResourceApi(commons.ApiRequester client)
|
| + : _requester = client;
|
| +
|
| + /// A customer for Zero Touch Provisioning will be created.
|
| + /// After a Customer is created, their admins and owners will be able to
|
| + /// manage
|
| + /// devices on partner.android.com/zerotouch or via their API.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [parent] - The parent resource in format `partners/[PARTNER_ID]'.
|
| + /// Value must have pattern "^partners/[^/]+$".
|
| + ///
|
| + /// Completes with a [Company].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<Company> create(
|
| + CreateCustomerRequest request, core.String parent) {
|
| + var _url = null;
|
| + var _queryParams = new core.Map();
|
| + var _uploadMedia = null;
|
| + var _uploadOptions = null;
|
| + var _downloadOptions = commons.DownloadOptions.Metadata;
|
| + var _body = null;
|
| +
|
| + if (request != null) {
|
| + _body = convert.JSON.encode((request).toJson());
|
| + }
|
| + if (parent == null) {
|
| + throw new core.ArgumentError("Parameter parent is required.");
|
| + }
|
| +
|
| + _url =
|
| + 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/customers';
|
| +
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new Company.fromJson(data));
|
| + }
|
| +
|
| + /// List the customers that are enrolled to the reseller identified by the
|
| + /// `partnerId` argument. This list includes customers that the reseller
|
| + /// created and customers that enrolled themselves using the portal.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [partnerId] - The ID of the partner.
|
| + /// Value must have pattern "^[^/]+$".
|
| + ///
|
| + /// Completes with a [ListCustomersResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| async.Future<ListCustomersResponse> list(core.String partnerId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -126,46 +167,43 @@ class PartnersCustomersResourceApi {
|
| throw new core.ArgumentError("Parameter partnerId is required.");
|
| }
|
|
|
| - _url = 'v1/partners/' + commons.Escaper.ecapeVariableReserved('$partnerId') + '/customers';
|
| + _url = 'v1/partners/' +
|
| + commons.Escaper.ecapeVariableReserved('$partnerId') +
|
| + '/customers';
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new ListCustomersResponse.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| class PartnersDevicesResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - PartnersDevicesResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Claim the device identified by device identifier.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [partnerId] - Id of the partner.
|
| - * Value must have pattern "^[^/]+$".
|
| - *
|
| - * Completes with a [ClaimDeviceResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<ClaimDeviceResponse> claim(ClaimDeviceRequest request, core.String partnerId) {
|
| + PartnersDevicesResourceApi(commons.ApiRequester client) : _requester = client;
|
| +
|
| + /// Claim the device identified by device identifier.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [partnerId] - ID of the partner.
|
| + /// Value must have pattern "^[^/]+$".
|
| + ///
|
| + /// Completes with a [ClaimDeviceResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<ClaimDeviceResponse> claim(
|
| + ClaimDeviceRequest request, core.String partnerId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -180,37 +218,37 @@ class PartnersDevicesResourceApi {
|
| throw new core.ArgumentError("Parameter partnerId is required.");
|
| }
|
|
|
| - _url = 'v1/partners/' + commons.Escaper.ecapeVariableReserved('$partnerId') + '/devices:claim';
|
| + _url = 'v1/partners/' +
|
| + commons.Escaper.ecapeVariableReserved('$partnerId') +
|
| + '/devices:claim';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new ClaimDeviceResponse.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Claim devices asynchronously
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [partnerId] - partner id.
|
| - * Value must have pattern "^[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<Operation> claimAsync(ClaimDevicesRequest request, core.String partnerId) {
|
| + /// Claim devices asynchronously.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [partnerId] - Partner ID.
|
| + /// Value must have pattern "^[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<Operation> claimAsync(
|
| + ClaimDevicesRequest request, core.String partnerId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -225,37 +263,37 @@ class PartnersDevicesResourceApi {
|
| throw new core.ArgumentError("Parameter partnerId is required.");
|
| }
|
|
|
| - _url = 'v1/partners/' + commons.Escaper.ecapeVariableReserved('$partnerId') + '/devices:claimAsync';
|
| + _url = 'v1/partners/' +
|
| + commons.Escaper.ecapeVariableReserved('$partnerId') +
|
| + '/devices:claimAsync';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Operation.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Find devices by device identifier.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [partnerId] - id of the partner.
|
| - * Value must have pattern "^[^/]+$".
|
| - *
|
| - * Completes with a [FindDevicesByDeviceIdentifierResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<FindDevicesByDeviceIdentifierResponse> findByIdentifier(FindDevicesByDeviceIdentifierRequest request, core.String partnerId) {
|
| + /// Find devices by device identifier.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [partnerId] - ID of the partner.
|
| + /// Value must have pattern "^[^/]+$".
|
| + ///
|
| + /// Completes with a [FindDevicesByDeviceIdentifierResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<FindDevicesByDeviceIdentifierResponse> findByIdentifier(
|
| + FindDevicesByDeviceIdentifierRequest request, core.String partnerId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -270,37 +308,38 @@ class PartnersDevicesResourceApi {
|
| throw new core.ArgumentError("Parameter partnerId is required.");
|
| }
|
|
|
| - _url = 'v1/partners/' + commons.Escaper.ecapeVariableReserved('$partnerId') + '/devices:findByIdentifier';
|
| -
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| - return _response.then((data) => new FindDevicesByDeviceIdentifierResponse.fromJson(data));
|
| - }
|
| -
|
| - /**
|
| - * Find devices by ownership.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [partnerId] - id of the partner.
|
| - * Value must have pattern "^[^/]+$".
|
| - *
|
| - * Completes with a [FindDevicesByOwnerResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<FindDevicesByOwnerResponse> findByOwner(FindDevicesByOwnerRequest request, core.String partnerId) {
|
| + _url = 'v1/partners/' +
|
| + commons.Escaper.ecapeVariableReserved('$partnerId') +
|
| + '/devices:findByIdentifier';
|
| +
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then(
|
| + (data) => new FindDevicesByDeviceIdentifierResponse.fromJson(data));
|
| + }
|
| +
|
| + /// Find devices by ownership.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [partnerId] - ID of the partner.
|
| + /// Value must have pattern "^[^/]+$".
|
| + ///
|
| + /// Completes with a [FindDevicesByOwnerResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<FindDevicesByOwnerResponse> findByOwner(
|
| + FindDevicesByOwnerRequest request, core.String partnerId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -315,34 +354,34 @@ class PartnersDevicesResourceApi {
|
| throw new core.ArgumentError("Parameter partnerId is required.");
|
| }
|
|
|
| - _url = 'v1/partners/' + commons.Escaper.ecapeVariableReserved('$partnerId') + '/devices:findByOwner';
|
| -
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| - return _response.then((data) => new FindDevicesByOwnerResponse.fromJson(data));
|
| - }
|
| -
|
| - /**
|
| - * Get a device
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - resource name in 'partners/[PARTNER_ID]/devices/[DEVICE_ID]'.
|
| - * Value must have pattern "^partners/[^/]+/devices/[^/]+$".
|
| - *
|
| - * Completes with a [Device].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| + _url = 'v1/partners/' +
|
| + commons.Escaper.ecapeVariableReserved('$partnerId') +
|
| + '/devices:findByOwner';
|
| +
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response
|
| + .then((data) => new FindDevicesByOwnerResponse.fromJson(data));
|
| + }
|
| +
|
| + /// Get a device.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
|
| + /// Value must have pattern "^partners/[^/]+/devices/[^/]+$".
|
| + ///
|
| + /// Completes with a [Device].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| async.Future<Device> get(core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -357,39 +396,37 @@ class PartnersDevicesResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Device.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Update the metadata
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [metadataOwnerId] - The owner of the newly set metadata. Should be partner
|
| - * id itself.
|
| - * Value must have pattern "^[^/]+$".
|
| - *
|
| - * [deviceId] - id of the partner.
|
| - * Value must have pattern "^[^/]+$".
|
| - *
|
| - * Completes with a [DeviceMetadata].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<DeviceMetadata> metadata(UpdateDeviceMetadataRequest request, core.String metadataOwnerId, core.String deviceId) {
|
| + /// Update the metadata.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [metadataOwnerId] - The owner of the newly set metadata. Set this to the
|
| + /// partner ID.
|
| + /// Value must have pattern "^[^/]+$".
|
| + ///
|
| + /// [deviceId] - ID of the partner.
|
| + /// Value must have pattern "^[^/]+$".
|
| + ///
|
| + /// Completes with a [DeviceMetadata].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<DeviceMetadata> metadata(UpdateDeviceMetadataRequest request,
|
| + core.String metadataOwnerId, core.String deviceId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -407,37 +444,40 @@ class PartnersDevicesResourceApi {
|
| throw new core.ArgumentError("Parameter deviceId is required.");
|
| }
|
|
|
| - _url = 'v1/partners/' + commons.Escaper.ecapeVariableReserved('$metadataOwnerId') + '/devices/' + commons.Escaper.ecapeVariableReserved('$deviceId') + '/metadata';
|
| + _url = 'v1/partners/' +
|
| + commons.Escaper.ecapeVariableReserved('$metadataOwnerId') +
|
| + '/devices/' +
|
| + commons.Escaper.ecapeVariableReserved('$deviceId') +
|
| + '/metadata';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new DeviceMetadata.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Unclaim the device identified by device_id or identifier.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [partnerId] - Id of the partner.
|
| - * Value must have pattern "^[^/]+$".
|
| - *
|
| - * Completes with a [Empty].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<Empty> unclaim(UnclaimDeviceRequest request, core.String partnerId) {
|
| + /// Unclaim the device identified by the `device_id` or the
|
| + /// `deviceIdentifier`.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [partnerId] - ID of the partner.
|
| + /// Value must have pattern "^[^/]+$".
|
| + ///
|
| + /// Completes with a [Empty].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<Empty> unclaim(
|
| + UnclaimDeviceRequest request, core.String partnerId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -452,37 +492,37 @@ class PartnersDevicesResourceApi {
|
| throw new core.ArgumentError("Parameter partnerId is required.");
|
| }
|
|
|
| - _url = 'v1/partners/' + commons.Escaper.ecapeVariableReserved('$partnerId') + '/devices:unclaim';
|
| + _url = 'v1/partners/' +
|
| + commons.Escaper.ecapeVariableReserved('$partnerId') +
|
| + '/devices:unclaim';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Empty.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Unclaim devices asynchronously
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [partnerId] - partner id.
|
| - * Value must have pattern "^[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<Operation> unclaimAsync(UnclaimDevicesRequest request, core.String partnerId) {
|
| + /// Unclaim devices asynchronously.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [partnerId] - Partner ID.
|
| + /// Value must have pattern "^[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<Operation> unclaimAsync(
|
| + UnclaimDevicesRequest request, core.String partnerId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -497,37 +537,37 @@ class PartnersDevicesResourceApi {
|
| throw new core.ArgumentError("Parameter partnerId is required.");
|
| }
|
|
|
| - _url = 'v1/partners/' + commons.Escaper.ecapeVariableReserved('$partnerId') + '/devices:unclaimAsync';
|
| + _url = 'v1/partners/' +
|
| + commons.Escaper.ecapeVariableReserved('$partnerId') +
|
| + '/devices:unclaimAsync';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Operation.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Set metadata in batch asynchronously.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [partnerId] - partner id.
|
| - * Value must have pattern "^[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<Operation> updateMetadataAsync(UpdateDeviceMetadataInBatchRequest request, core.String partnerId) {
|
| + /// Set metadata in batch asynchronously.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [partnerId] - Partner ID.
|
| + /// Value must have pattern "^[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<Operation> updateMetadataAsync(
|
| + UpdateDeviceMetadataInBatchRequest request, core.String partnerId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -542,34 +582,32 @@ class PartnersDevicesResourceApi {
|
| throw new core.ArgumentError("Parameter partnerId is required.");
|
| }
|
|
|
| - _url = 'v1/partners/' + commons.Escaper.ecapeVariableReserved('$partnerId') + '/devices:updateMetadataAsync';
|
| + _url = 'v1/partners/' +
|
| + commons.Escaper.ecapeVariableReserved('$partnerId') +
|
| + '/devices:updateMetadataAsync';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Operation.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| -
|
| -/** Request message to claim a device on behalf of a customer. */
|
| +/// Request message to claim a device on behalf of a customer.
|
| class ClaimDeviceRequest {
|
| - /** The customer to claim for. */
|
| + /// The customer to claim for.
|
| core.String customerId;
|
| - /** The device identifier of the device to claim. */
|
| +
|
| + /// The device identifier of the device to claim.
|
| DeviceIdentifier deviceIdentifier;
|
| - /**
|
| - * Section to claim
|
| - * Possible string values are:
|
| - * - "SECTION_TYPE_UNSPECIFIED" : Unspecified
|
| - * - "SECTION_TYPE_ZERO_TOUCH" : Zero touch
|
| - */
|
| +
|
| + /// The section to claim.
|
| + /// Possible string values are:
|
| + /// - "SECTION_TYPE_UNSPECIFIED" : Unspecified section type.
|
| + /// - "SECTION_TYPE_ZERO_TOUCH" : Zero touch section type.
|
| core.String sectionType;
|
|
|
| ClaimDeviceRequest();
|
| @@ -579,7 +617,8 @@ class ClaimDeviceRequest {
|
| customerId = _json["customerId"];
|
| }
|
| if (_json.containsKey("deviceIdentifier")) {
|
| - deviceIdentifier = new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| + deviceIdentifier =
|
| + new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| }
|
| if (_json.containsKey("sectionType")) {
|
| sectionType = _json["sectionType"];
|
| @@ -587,7 +626,8 @@ class ClaimDeviceRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (customerId != null) {
|
| _json["customerId"] = customerId;
|
| }
|
| @@ -601,14 +641,13 @@ class ClaimDeviceRequest {
|
| }
|
| }
|
|
|
| -/** Response message containing device id of the claim. */
|
| +/// Response message containing device id of the claim.
|
| class ClaimDeviceResponse {
|
| - /** the device id of the claimed device. */
|
| + /// The device ID of the claimed device.
|
| core.String deviceId;
|
| - /**
|
| - * the resource name of the device in
|
| - * 'partners/[PARTNER_ID]/devices/[DEVICE_ID]'.
|
| - */
|
| +
|
| + /// The resource name of the device in the format
|
| + /// `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
|
| core.String deviceName;
|
|
|
| ClaimDeviceResponse();
|
| @@ -623,7 +662,8 @@ class ClaimDeviceResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (deviceId != null) {
|
| _json["deviceId"] = deviceId;
|
| }
|
| @@ -634,21 +674,24 @@ class ClaimDeviceResponse {
|
| }
|
| }
|
|
|
| -/** Request to claim devices asynchronously in batch. */
|
| +/// Request to claim devices asynchronously in batch.
|
| class ClaimDevicesRequest {
|
| - /** list of claims. */
|
| + /// List of claims.
|
| core.List<PartnerClaim> claims;
|
|
|
| ClaimDevicesRequest();
|
|
|
| ClaimDevicesRequest.fromJson(core.Map _json) {
|
| if (_json.containsKey("claims")) {
|
| - claims = _json["claims"].map((value) => new PartnerClaim.fromJson(value)).toList();
|
| + claims = _json["claims"]
|
| + .map((value) => new PartnerClaim.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (claims != null) {
|
| _json["claims"] = claims.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -656,60 +699,131 @@ class ClaimDevicesRequest {
|
| }
|
| }
|
|
|
| -/** Company */
|
| +/// Company
|
| class Company {
|
| - /** company id */
|
| + /// Admin emails.
|
| + /// Admins are able to operate on the portal.
|
| + /// This field is a write-only field at creation time.
|
| + core.List<core.String> adminEmails;
|
| +
|
| + /// Company ID.
|
| core.String companyId;
|
| - /** company name */
|
| +
|
| + /// Company name.
|
| core.String companyName;
|
|
|
| + /// The API resource name of the company in the format
|
| + /// `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`.
|
| + core.String name;
|
| +
|
| + /// Owner emails.
|
| + /// Owners are able to operate on the portal, and modify admins or other
|
| + /// owners. This field is a write-only field at creation time.
|
| + core.List<core.String> ownerEmails;
|
| +
|
| Company();
|
|
|
| Company.fromJson(core.Map _json) {
|
| + if (_json.containsKey("adminEmails")) {
|
| + adminEmails = _json["adminEmails"];
|
| + }
|
| if (_json.containsKey("companyId")) {
|
| companyId = _json["companyId"];
|
| }
|
| if (_json.containsKey("companyName")) {
|
| companyName = _json["companyName"];
|
| }
|
| + if (_json.containsKey("name")) {
|
| + name = _json["name"];
|
| + }
|
| + if (_json.containsKey("ownerEmails")) {
|
| + ownerEmails = _json["ownerEmails"];
|
| + }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| + if (adminEmails != null) {
|
| + _json["adminEmails"] = adminEmails;
|
| + }
|
| if (companyId != null) {
|
| _json["companyId"] = companyId;
|
| }
|
| if (companyName != null) {
|
| _json["companyName"] = companyName;
|
| }
|
| + if (name != null) {
|
| + _json["name"] = name;
|
| + }
|
| + if (ownerEmails != null) {
|
| + _json["ownerEmails"] = ownerEmails;
|
| + }
|
| return _json;
|
| }
|
| }
|
|
|
| -/** Device */
|
| +/// Request message to create a customer.
|
| +class CreateCustomerRequest {
|
| + /// The customer to create.
|
| + Company customer;
|
| +
|
| + CreateCustomerRequest();
|
| +
|
| + CreateCustomerRequest.fromJson(core.Map _json) {
|
| + if (_json.containsKey("customer")) {
|
| + customer = new Company.fromJson(_json["customer"]);
|
| + }
|
| + }
|
| +
|
| + core.Map<core.String, core.Object> toJson() {
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| + if (customer != null) {
|
| + _json["customer"] = (customer).toJson();
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/// An Android device.
|
| class Device {
|
| - /** claims */
|
| + /// Claims.
|
| core.List<DeviceClaim> claims;
|
| - /** Device id */
|
| +
|
| + /// The resource name of the configuration.
|
| + /// Only set for customers.
|
| + core.String configuration;
|
| +
|
| + /// Device ID.
|
| core.String deviceId;
|
| - /** Device identifier */
|
| +
|
| + /// Device identifier.
|
| DeviceIdentifier deviceIdentifier;
|
| - /** Device metadata */
|
| +
|
| + /// Device metadata.
|
| DeviceMetadata deviceMetadata;
|
| - /** Resource name in 'partners/[PARTNER_ID]/devices/[DEVICE_ID]'. */
|
| +
|
| + /// Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
|
| core.String name;
|
|
|
| Device();
|
|
|
| Device.fromJson(core.Map _json) {
|
| if (_json.containsKey("claims")) {
|
| - claims = _json["claims"].map((value) => new DeviceClaim.fromJson(value)).toList();
|
| + claims = _json["claims"]
|
| + .map((value) => new DeviceClaim.fromJson(value))
|
| + .toList();
|
| + }
|
| + if (_json.containsKey("configuration")) {
|
| + configuration = _json["configuration"];
|
| }
|
| if (_json.containsKey("deviceId")) {
|
| deviceId = _json["deviceId"];
|
| }
|
| if (_json.containsKey("deviceIdentifier")) {
|
| - deviceIdentifier = new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| + deviceIdentifier =
|
| + new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| }
|
| if (_json.containsKey("deviceMetadata")) {
|
| deviceMetadata = new DeviceMetadata.fromJson(_json["deviceMetadata"]);
|
| @@ -720,10 +834,14 @@ class Device {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (claims != null) {
|
| _json["claims"] = claims.map((value) => (value).toJson()).toList();
|
| }
|
| + if (configuration != null) {
|
| + _json["configuration"] = configuration;
|
| + }
|
| if (deviceId != null) {
|
| _json["deviceId"] = deviceId;
|
| }
|
| @@ -740,16 +858,15 @@ class Device {
|
| }
|
| }
|
|
|
| -/** containing the necessary info about a claim for a partner. */
|
| +/// Information about a device claimed for a partner.
|
| class DeviceClaim {
|
| - /** owner id */
|
| + /// Owner ID.
|
| core.String ownerCompanyId;
|
| - /**
|
| - * section type.
|
| - * Possible string values are:
|
| - * - "SECTION_TYPE_UNSPECIFIED" : Unspecified
|
| - * - "SECTION_TYPE_ZERO_TOUCH" : Zero touch
|
| - */
|
| +
|
| + /// Section type of the device claim.
|
| + /// Possible string values are:
|
| + /// - "SECTION_TYPE_UNSPECIFIED" : Unspecified section type.
|
| + /// - "SECTION_TYPE_ZERO_TOUCH" : Zero touch section type.
|
| core.String sectionType;
|
|
|
| DeviceClaim();
|
| @@ -764,7 +881,8 @@ class DeviceClaim {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (ownerCompanyId != null) {
|
| _json["ownerCompanyId"] = ownerCompanyId;
|
| }
|
| @@ -775,19 +893,20 @@ class DeviceClaim {
|
| }
|
| }
|
|
|
| -/** DeviceIdentifiers identifies an unique device. */
|
| +/// Identifies a unique device.
|
| class DeviceIdentifier {
|
| - /** IMEI (either IMEI or MEID is required). */
|
| + /// IMEI number.
|
| core.String imei;
|
| - /**
|
| - * Manufacturer name to match `android.os.Build.MANUFACTURER` (required).
|
| - * Allowed values listed in
|
| - * [manufacturer names](/zero-touch/resources/manufacturer-names).
|
| - */
|
| +
|
| + /// Manufacturer name to match `android.os.Build.MANUFACTURER` (required).
|
| + /// Allowed values listed in
|
| + /// [manufacturer names](/zero-touch/resources/manufacturer-names).
|
| core.String manufacturer;
|
| - /** MEID */
|
| +
|
| + /// MEID number.
|
| core.String meid;
|
| - /** Serial number (optional) */
|
| +
|
| + /// Serial number (optional).
|
| core.String serialNumber;
|
|
|
| DeviceIdentifier();
|
| @@ -808,7 +927,8 @@ class DeviceIdentifier {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (imei != null) {
|
| _json["imei"] = imei;
|
| }
|
| @@ -825,9 +945,9 @@ class DeviceIdentifier {
|
| }
|
| }
|
|
|
| -/** metadata */
|
| +/// A key-value pair of the device metadata.
|
| class DeviceMetadata {
|
| - /** Metadata entries */
|
| + /// Metadata entries
|
| core.Map<core.String, core.String> entries;
|
|
|
| DeviceMetadata();
|
| @@ -839,7 +959,8 @@ class DeviceMetadata {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (entries != null) {
|
| _json["entries"] = entries;
|
| }
|
| @@ -847,22 +968,22 @@ class DeviceMetadata {
|
| }
|
| }
|
|
|
| -/** Long running operation metadata. */
|
| +/// Long running operation metadata.
|
| class DevicesLongRunningOperationMetadata {
|
| - /** Number of devices parsed in your requests. */
|
| + /// Number of devices parsed in your requests.
|
| core.int devicesCount;
|
| - /**
|
| - * The overall processing status.
|
| - * Possible string values are:
|
| - * - "BATCH_PROCESS_STATUS_UNSPECIFIED" : Invalid code. Shouldn't be used.
|
| - * - "BATCH_PROCESS_PENDING" : Pending
|
| - * - "BATCH_PROCESS_IN_PROGRESS" : In progress
|
| - * - "BATCH_PROCESS_PROCESSED" : Processed.
|
| - * This doesn't mean all items were processed sucessfully, you should
|
| - * check the `response` field for the result of every item.
|
| - */
|
| +
|
| + /// The overall processing status.
|
| + /// Possible string values are:
|
| + /// - "BATCH_PROCESS_STATUS_UNSPECIFIED" : Invalid code. Shouldn't be used.
|
| + /// - "BATCH_PROCESS_PENDING" : Pending.
|
| + /// - "BATCH_PROCESS_IN_PROGRESS" : In progress.
|
| + /// - "BATCH_PROCESS_PROCESSED" : Processed.
|
| + /// This doesn't mean all items were processed sucessfully, you should
|
| + /// check the `response` field for the result of every item.
|
| core.String processingStatus;
|
| - /** Processing progress from 0 to 100. */
|
| +
|
| + /// Processing progress from 0 to 100.
|
| core.int progress;
|
|
|
| DevicesLongRunningOperationMetadata();
|
| @@ -880,7 +1001,8 @@ class DevicesLongRunningOperationMetadata {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (devicesCount != null) {
|
| _json["devicesCount"] = devicesCount;
|
| }
|
| @@ -894,21 +1016,23 @@ class DevicesLongRunningOperationMetadata {
|
| }
|
| }
|
|
|
| -/** Long running operation response. */
|
| +/// Long running operation response.
|
| class DevicesLongRunningOperationResponse {
|
| - /**
|
| - * processing status for each device.
|
| - * One PerDeviceStatus per device. The order is the same as in your requests.
|
| - */
|
| + /// Processing status for each device.
|
| + /// One `PerDeviceStatus` per device. The order is the same as in your
|
| + /// requests.
|
| core.List<OperationPerDevice> perDeviceStatus;
|
| - /** Number of succeesfully processed ones. */
|
| +
|
| + /// Number of succeesfully processed ones.
|
| core.int successCount;
|
|
|
| DevicesLongRunningOperationResponse();
|
|
|
| DevicesLongRunningOperationResponse.fromJson(core.Map _json) {
|
| if (_json.containsKey("perDeviceStatus")) {
|
| - perDeviceStatus = _json["perDeviceStatus"].map((value) => new OperationPerDevice.fromJson(value)).toList();
|
| + perDeviceStatus = _json["perDeviceStatus"]
|
| + .map((value) => new OperationPerDevice.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("successCount")) {
|
| successCount = _json["successCount"];
|
| @@ -916,9 +1040,11 @@ class DevicesLongRunningOperationResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (perDeviceStatus != null) {
|
| - _json["perDeviceStatus"] = perDeviceStatus.map((value) => (value).toJson()).toList();
|
| + _json["perDeviceStatus"] =
|
| + perDeviceStatus.map((value) => (value).toJson()).toList();
|
| }
|
| if (successCount != null) {
|
| _json["successCount"] = successCount;
|
| @@ -927,44 +1053,44 @@ class DevicesLongRunningOperationResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * A generic empty message that you can re-use to avoid defining duplicated
|
| - * empty messages in your APIs. A typical example is to use it as the request
|
| - * or the response type of an API method. For instance:
|
| - *
|
| - * service Foo {
|
| - * rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
| - * }
|
| - *
|
| - * The JSON representation for `Empty` is empty JSON object `{}`.
|
| - */
|
| +/// A generic empty message that you can re-use to avoid defining duplicated
|
| +/// empty messages in your APIs. A typical example is to use it as the request
|
| +/// or the response type of an API method. For instance:
|
| +///
|
| +/// service Foo {
|
| +/// rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
| +/// }
|
| +///
|
| +/// The JSON representation for `Empty` is empty JSON object `{}`.
|
| class Empty {
|
| -
|
| Empty();
|
|
|
| - Empty.fromJson(core.Map _json) {
|
| - }
|
| + Empty.fromJson(core.Map _json) {}
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| return _json;
|
| }
|
| }
|
|
|
| -/** Request to find devices. */
|
| +/// Request to find devices.
|
| class FindDevicesByDeviceIdentifierRequest {
|
| - /** The device identifier to search */
|
| + /// The device identifier to search.
|
| DeviceIdentifier deviceIdentifier;
|
| - /** Number of devices to show. */
|
| +
|
| + /// Number of devices to show.
|
| core.String limit;
|
| - /** Page token */
|
| +
|
| + /// Page token.
|
| core.String pageToken;
|
|
|
| FindDevicesByDeviceIdentifierRequest();
|
|
|
| FindDevicesByDeviceIdentifierRequest.fromJson(core.Map _json) {
|
| if (_json.containsKey("deviceIdentifier")) {
|
| - deviceIdentifier = new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| + deviceIdentifier =
|
| + new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| }
|
| if (_json.containsKey("limit")) {
|
| limit = _json["limit"];
|
| @@ -975,7 +1101,8 @@ class FindDevicesByDeviceIdentifierRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (deviceIdentifier != null) {
|
| _json["deviceIdentifier"] = (deviceIdentifier).toJson();
|
| }
|
| @@ -989,18 +1116,20 @@ class FindDevicesByDeviceIdentifierRequest {
|
| }
|
| }
|
|
|
| -/** Response containing found devices. */
|
| +/// Response containing found devices.
|
| class FindDevicesByDeviceIdentifierResponse {
|
| - /** Found devices. */
|
| + /// Found devices.
|
| core.List<Device> devices;
|
| - /** Page token of next page */
|
| +
|
| + /// Page token of the next page.
|
| core.String nextPageToken;
|
|
|
| FindDevicesByDeviceIdentifierResponse();
|
|
|
| FindDevicesByDeviceIdentifierResponse.fromJson(core.Map _json) {
|
| if (_json.containsKey("devices")) {
|
| - devices = _json["devices"].map((value) => new Device.fromJson(value)).toList();
|
| + devices =
|
| + _json["devices"].map((value) => new Device.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("nextPageToken")) {
|
| nextPageToken = _json["nextPageToken"];
|
| @@ -1008,7 +1137,8 @@ class FindDevicesByDeviceIdentifierResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (devices != null) {
|
| _json["devices"] = devices.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -1019,20 +1149,21 @@ class FindDevicesByDeviceIdentifierResponse {
|
| }
|
| }
|
|
|
| -/** Request to find devices by customers. */
|
| +/// Request to find devices by customers.
|
| class FindDevicesByOwnerRequest {
|
| - /** List of customer ids to search for. */
|
| + /// List of customer IDs to search for.
|
| core.List<core.String> customerId;
|
| - /** The number of devices to show in the result. */
|
| +
|
| + /// The number of devices to show in the result.
|
| core.String limit;
|
| - /** Page token */
|
| +
|
| + /// Page token.
|
| core.String pageToken;
|
| - /**
|
| - * The section type.
|
| - * Possible string values are:
|
| - * - "SECTION_TYPE_UNSPECIFIED" : Unspecified
|
| - * - "SECTION_TYPE_ZERO_TOUCH" : Zero touch
|
| - */
|
| +
|
| + /// The section type.
|
| + /// Possible string values are:
|
| + /// - "SECTION_TYPE_UNSPECIFIED" : Unspecified section type.
|
| + /// - "SECTION_TYPE_ZERO_TOUCH" : Zero touch section type.
|
| core.String sectionType;
|
|
|
| FindDevicesByOwnerRequest();
|
| @@ -1053,7 +1184,8 @@ class FindDevicesByOwnerRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (customerId != null) {
|
| _json["customerId"] = customerId;
|
| }
|
| @@ -1070,18 +1202,20 @@ class FindDevicesByOwnerRequest {
|
| }
|
| }
|
|
|
| -/** Response containing found devices. */
|
| +/// Response containing found devices.
|
| class FindDevicesByOwnerResponse {
|
| - /** Devices found. */
|
| + /// Devices found.
|
| core.List<Device> devices;
|
| - /** Page token of next page */
|
| +
|
| + /// Page token of the next page.
|
| core.String nextPageToken;
|
|
|
| FindDevicesByOwnerResponse();
|
|
|
| FindDevicesByOwnerResponse.fromJson(core.Map _json) {
|
| if (_json.containsKey("devices")) {
|
| - devices = _json["devices"].map((value) => new Device.fromJson(value)).toList();
|
| + devices =
|
| + _json["devices"].map((value) => new Device.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("nextPageToken")) {
|
| nextPageToken = _json["nextPageToken"];
|
| @@ -1089,7 +1223,8 @@ class FindDevicesByOwnerResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (devices != null) {
|
| _json["devices"] = devices.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -1100,21 +1235,24 @@ class FindDevicesByOwnerResponse {
|
| }
|
| }
|
|
|
| -/** Response message of all customers related to this partner. */
|
| +/// Response message of all customers related to this partner.
|
| class ListCustomersResponse {
|
| - /** List of customers related to this partner. */
|
| + /// List of customers related to this partner.
|
| core.List<Company> customers;
|
|
|
| ListCustomersResponse();
|
|
|
| ListCustomersResponse.fromJson(core.Map _json) {
|
| if (_json.containsKey("customers")) {
|
| - customers = _json["customers"].map((value) => new Company.fromJson(value)).toList();
|
| + customers = _json["customers"]
|
| + .map((value) => new Company.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (customers != null) {
|
| _json["customers"] = customers.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -1122,47 +1260,41 @@ class ListCustomersResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * This resource represents a long-running operation that is the result of a
|
| - * network API call.
|
| - */
|
| +/// This resource represents a long-running operation that is the result of a
|
| +/// network API call.
|
| class Operation {
|
| - /**
|
| - * If the value is `false`, it means the operation is still in progress.
|
| - * If true, the operation is completed, and either `error` or `response` is
|
| - * available.
|
| - */
|
| + /// If the value is `false`, it means the operation is still in progress.
|
| + /// If `true`, the operation is completed, and either `error` or `response`
|
| + /// is
|
| + /// available.
|
| core.bool done;
|
| - /**
|
| - * This field will always be not set if the operation is created by
|
| - * `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error
|
| - * information for each device is set in
|
| - * `response.perDeviceStatus.result.status`.
|
| - */
|
| +
|
| + /// This field will always be not set if the operation is created by
|
| + /// `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case,
|
| + /// error information for each device is set in
|
| + /// `response.perDeviceStatus.result.status`.
|
| Status error;
|
| - /**
|
| - * This field will contain a `DevicesLongRunningOperationMetadata` object if
|
| - * the operation is created by `claimAsync`, `unclaimAsync`, or
|
| - * `updateMetadataAsync`.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// This field will contain a `DevicesLongRunningOperationMetadata` object if
|
| + /// the operation is created by `claimAsync`, `unclaimAsync`, or
|
| + /// `updateMetadataAsync`.
|
| + ///
|
| + /// The values for Object must be JSON objects. It can consist of `num`,
|
| + /// `String`, `bool` and `null` as well as `Map` and `List` values.
|
| core.Map<core.String, core.Object> metadata;
|
| - /**
|
| - * The server-assigned name, which is only unique within the same service that
|
| - * originally returns it. If you use the default HTTP mapping, the
|
| - * `name` should have the format of `operations/some/unique/name`.
|
| - */
|
| +
|
| + /// The server-assigned name, which is only unique within the same service
|
| + /// that
|
| + /// originally returns it. If you use the default HTTP mapping, the
|
| + /// `name` should have the format of `operations/some/unique/name`.
|
| core.String name;
|
| - /**
|
| - * This field will contain a `DevicesLongRunningOperationResponse` object if
|
| - * the operation is created by `claimAsync`, `unclaimAsync`, or
|
| - * `updateMetadataAsync`.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// This field will contain a `DevicesLongRunningOperationResponse` object if
|
| + /// the operation is created by `claimAsync`, `unclaimAsync`, or
|
| + /// `updateMetadataAsync`.
|
| + ///
|
| + /// The values for Object must be JSON objects. It can consist of `num`,
|
| + /// `String`, `bool` and `null` as well as `Map` and `List` values.
|
| core.Map<core.String, core.Object> response;
|
|
|
| Operation();
|
| @@ -1186,7 +1318,8 @@ class Operation {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (done != null) {
|
| _json["done"] = done;
|
| }
|
| @@ -1206,15 +1339,18 @@ class Operation {
|
| }
|
| }
|
|
|
| -/** Operation the server received for every device. */
|
| +/// Operation the server received for every device.
|
| class OperationPerDevice {
|
| - /** Request to claim a device. */
|
| + /// Request to claim a device.
|
| PartnerClaim claim;
|
| - /** Processing result for every device. */
|
| +
|
| + /// Processing result for every device.
|
| PerDeviceStatusInBatch result;
|
| - /** Request to unclaim a device. */
|
| +
|
| + /// Request to unclaim a device.
|
| PartnerUnclaim unclaim;
|
| - /** Request to set metadata for a device. */
|
| +
|
| + /// Request to set metadata for a device.
|
| UpdateMetadataArguments updateMetadata;
|
|
|
| OperationPerDevice();
|
| @@ -1230,12 +1366,14 @@ class OperationPerDevice {
|
| unclaim = new PartnerUnclaim.fromJson(_json["unclaim"]);
|
| }
|
| if (_json.containsKey("updateMetadata")) {
|
| - updateMetadata = new UpdateMetadataArguments.fromJson(_json["updateMetadata"]);
|
| + updateMetadata =
|
| + new UpdateMetadataArguments.fromJson(_json["updateMetadata"]);
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (claim != null) {
|
| _json["claim"] = (claim).toJson();
|
| }
|
| @@ -1252,20 +1390,21 @@ class OperationPerDevice {
|
| }
|
| }
|
|
|
| -/** Identifies one claim request. */
|
| +/// Identifies one claim request.
|
| class PartnerClaim {
|
| - /** customer id to claim for. */
|
| + /// Customer ID to claim for.
|
| core.String customerId;
|
| - /** Device identifier of the device. */
|
| +
|
| + /// Device identifier of the device.
|
| DeviceIdentifier deviceIdentifier;
|
| - /** metadata to set at claim. */
|
| +
|
| + /// Metadata to set at claim.
|
| DeviceMetadata deviceMetadata;
|
| - /**
|
| - * section type to claim.
|
| - * Possible string values are:
|
| - * - "SECTION_TYPE_UNSPECIFIED" : Unspecified
|
| - * - "SECTION_TYPE_ZERO_TOUCH" : Zero touch
|
| - */
|
| +
|
| + /// Section type to claim.
|
| + /// Possible string values are:
|
| + /// - "SECTION_TYPE_UNSPECIFIED" : Unspecified section type.
|
| + /// - "SECTION_TYPE_ZERO_TOUCH" : Zero touch section type.
|
| core.String sectionType;
|
|
|
| PartnerClaim();
|
| @@ -1275,7 +1414,8 @@ class PartnerClaim {
|
| customerId = _json["customerId"];
|
| }
|
| if (_json.containsKey("deviceIdentifier")) {
|
| - deviceIdentifier = new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| + deviceIdentifier =
|
| + new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| }
|
| if (_json.containsKey("deviceMetadata")) {
|
| deviceMetadata = new DeviceMetadata.fromJson(_json["deviceMetadata"]);
|
| @@ -1286,7 +1426,8 @@ class PartnerClaim {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (customerId != null) {
|
| _json["customerId"] = customerId;
|
| }
|
| @@ -1303,18 +1444,18 @@ class PartnerClaim {
|
| }
|
| }
|
|
|
| -/** Identifies one unclaim request. */
|
| +/// Identifies one unclaim request.
|
| class PartnerUnclaim {
|
| - /** device id of the device. */
|
| + /// Device ID of the device.
|
| core.String deviceId;
|
| - /** device identifier of the device. */
|
| +
|
| + /// Device identifier of the device.
|
| DeviceIdentifier deviceIdentifier;
|
| - /**
|
| - * section type to unclaim.
|
| - * Possible string values are:
|
| - * - "SECTION_TYPE_UNSPECIFIED" : Unspecified
|
| - * - "SECTION_TYPE_ZERO_TOUCH" : Zero touch
|
| - */
|
| +
|
| + /// Section type to unclaim.
|
| + /// Possible string values are:
|
| + /// - "SECTION_TYPE_UNSPECIFIED" : Unspecified section type.
|
| + /// - "SECTION_TYPE_ZERO_TOUCH" : Zero touch section type.
|
| core.String sectionType;
|
|
|
| PartnerUnclaim();
|
| @@ -1324,7 +1465,8 @@ class PartnerUnclaim {
|
| deviceId = _json["deviceId"];
|
| }
|
| if (_json.containsKey("deviceIdentifier")) {
|
| - deviceIdentifier = new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| + deviceIdentifier =
|
| + new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| }
|
| if (_json.containsKey("sectionType")) {
|
| sectionType = _json["sectionType"];
|
| @@ -1332,7 +1474,8 @@ class PartnerUnclaim {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (deviceId != null) {
|
| _json["deviceId"] = deviceId;
|
| }
|
| @@ -1346,31 +1489,32 @@ class PartnerUnclaim {
|
| }
|
| }
|
|
|
| -/** Stores the processing result for each device. */
|
| +/// Stores the processing result for each device.
|
| class PerDeviceStatusInBatch {
|
| - /** device id of the device if process succeeds. */
|
| + /// Device ID of the device if process succeeds.
|
| core.String deviceId;
|
| - /** Error identifier. */
|
| +
|
| + /// Error identifier.
|
| core.String errorIdentifier;
|
| - /** Error message */
|
| +
|
| + /// Error message.
|
| core.String errorMessage;
|
| - /**
|
| - * Process result.
|
| - * Possible string values are:
|
| - * - "SINGLE_DEVICE_STATUS_UNSPECIFIED" : Invalid code. Shouldn' be used.
|
| - * - "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR" : Unknown error.
|
| - * Unknown error is we don't expect it here.
|
| - * - "SINGLE_DEVICE_STATUS_OTHER_ERROR" : Other error.
|
| - * Other error is we know/expect this error, but not having proper error
|
| - * code yet.
|
| - * - "SINGLE_DEVICE_STATUS_SUCCESS" : Success.
|
| - * - "SINGLE_DEVICE_STATUS_PERMISSION_DENIED" : Permission denied
|
| - * - "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER" : Invalid device
|
| - * identifier.
|
| - * - "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE" : Invalid section type.
|
| - * - "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS" : This section is claimed by
|
| - * other company.
|
| - */
|
| +
|
| + /// Process result.
|
| + /// Possible string values are:
|
| + /// - "SINGLE_DEVICE_STATUS_UNSPECIFIED" : Invalid code. Shouldn't be used.
|
| + /// - "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR" : Unknown error.
|
| + /// We don't expect this error to occur here.
|
| + /// - "SINGLE_DEVICE_STATUS_OTHER_ERROR" : Other error.
|
| + /// We know/expect this error, but there's no defined error code for the
|
| + /// error.
|
| + /// - "SINGLE_DEVICE_STATUS_SUCCESS" : Success.
|
| + /// - "SINGLE_DEVICE_STATUS_PERMISSION_DENIED" : Permission denied.
|
| + /// - "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER" : Invalid device
|
| + /// identifier.
|
| + /// - "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE" : Invalid section type.
|
| + /// - "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS" : This section is claimed by
|
| + /// another company.
|
| core.String status;
|
|
|
| PerDeviceStatusInBatch();
|
| @@ -1391,7 +1535,8 @@ class PerDeviceStatusInBatch {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (deviceId != null) {
|
| _json["deviceId"] = deviceId;
|
| }
|
| @@ -1408,78 +1553,81 @@ class PerDeviceStatusInBatch {
|
| }
|
| }
|
|
|
| -/**
|
| - * The `Status` type defines a logical error model that is suitable for
|
| - * different
|
| - * programming environments, including REST APIs and RPC APIs. It is used by
|
| - * [gRPC](https://github.com/grpc). The error model is designed to be:
|
| - *
|
| - * - Simple to use and understand for most users
|
| - * - Flexible enough to meet unexpected needs
|
| - *
|
| - * # Overview
|
| - *
|
| - * The `Status` message contains three pieces of data: error code, error
|
| - * message,
|
| - * and error details. The error code should be an enum value of
|
| - * google.rpc.Code, but it may accept additional error codes if needed. The
|
| - * error message should be a developer-facing English message that helps
|
| - * developers *understand* and *resolve* the error. If a localized user-facing
|
| - * error message is needed, put the localized message in the error details or
|
| - * localize it in the client. The optional error details may contain arbitrary
|
| - * information about the error. There is a predefined set of error detail types
|
| - * in the package `google.rpc` that can be used for common error conditions.
|
| - *
|
| - * # Language mapping
|
| - *
|
| - * The `Status` message is the logical representation of the error model, but it
|
| - * is not necessarily the actual wire format. When the `Status` message is
|
| - * exposed in different client libraries and different wire protocols, it can be
|
| - * mapped differently. For example, it will likely be mapped to some exceptions
|
| - * in Java, but more likely mapped to some error codes in C.
|
| - *
|
| - * # Other uses
|
| - *
|
| - * The error model and the `Status` message can be used in a variety of
|
| - * environments, either with or without APIs, to provide a
|
| - * consistent developer experience across different environments.
|
| - *
|
| - * Example uses of this error model include:
|
| - *
|
| - * - Partial errors. If a service needs to return partial errors to the client,
|
| - * it may embed the `Status` in the normal response to indicate the partial
|
| - * errors.
|
| - *
|
| - * - Workflow errors. A typical workflow has multiple steps. Each step may
|
| - * have a `Status` message for error reporting.
|
| - *
|
| - * - Batch operations. If a client uses batch request and batch response, the
|
| - * `Status` message should be used directly inside batch response, one for
|
| - * each error sub-response.
|
| - *
|
| - * - Asynchronous operations. If an API call embeds asynchronous operation
|
| - * results in its response, the status of those operations should be
|
| - * represented directly using the `Status` message.
|
| - *
|
| - * - Logging. If some API errors are stored in logs, the message `Status` could
|
| - * be used directly after any stripping needed for security/privacy reasons.
|
| - */
|
| +/// The `Status` type defines a logical error model that is suitable for
|
| +/// different
|
| +/// programming environments, including REST APIs and RPC APIs. It is used by
|
| +/// [gRPC](https://github.com/grpc). The error model is designed to be:
|
| +///
|
| +/// - Simple to use and understand for most users
|
| +/// - Flexible enough to meet unexpected needs
|
| +///
|
| +/// # Overview
|
| +///
|
| +/// The `Status` message contains three pieces of data: error code, error
|
| +/// message,
|
| +/// and error details. The error code should be an enum value of
|
| +/// google.rpc.Code, but it may accept additional error codes if needed. The
|
| +/// error message should be a developer-facing English message that helps
|
| +/// developers *understand* and *resolve* the error. If a localized user-facing
|
| +/// error message is needed, put the localized message in the error details or
|
| +/// localize it in the client. The optional error details may contain arbitrary
|
| +/// information about the error. There is a predefined set of error detail
|
| +/// types
|
| +/// in the package `google.rpc` that can be used for common error conditions.
|
| +///
|
| +/// # Language mapping
|
| +///
|
| +/// The `Status` message is the logical representation of the error model, but
|
| +/// it
|
| +/// is not necessarily the actual wire format. When the `Status` message is
|
| +/// exposed in different client libraries and different wire protocols, it can
|
| +/// be
|
| +/// mapped differently. For example, it will likely be mapped to some
|
| +/// exceptions
|
| +/// in Java, but more likely mapped to some error codes in C.
|
| +///
|
| +/// # Other uses
|
| +///
|
| +/// The error model and the `Status` message can be used in a variety of
|
| +/// environments, either with or without APIs, to provide a
|
| +/// consistent developer experience across different environments.
|
| +///
|
| +/// Example uses of this error model include:
|
| +///
|
| +/// - Partial errors. If a service needs to return partial errors to the
|
| +/// client,
|
| +/// it may embed the `Status` in the normal response to indicate the partial
|
| +/// errors.
|
| +///
|
| +/// - Workflow errors. A typical workflow has multiple steps. Each step may
|
| +/// have a `Status` message for error reporting.
|
| +///
|
| +/// - Batch operations. If a client uses batch request and batch response, the
|
| +/// `Status` message should be used directly inside batch response, one for
|
| +/// each error sub-response.
|
| +///
|
| +/// - Asynchronous operations. If an API call embeds asynchronous operation
|
| +/// results in its response, the status of those operations should be
|
| +/// represented directly using the `Status` message.
|
| +///
|
| +/// - Logging. If some API errors are stored in logs, the message `Status`
|
| +/// could
|
| +/// be used directly after any stripping needed for security/privacy reasons.
|
| class Status {
|
| - /** The status code, which should be an enum value of google.rpc.Code. */
|
| + /// The status code, which should be an enum value of google.rpc.Code.
|
| core.int code;
|
| - /**
|
| - * A list of messages that carry the error details. There is a common set of
|
| - * message types for APIs to use.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// A list of messages that carry the error details. There is a common set
|
| + /// of
|
| + /// message types for APIs to use.
|
| + ///
|
| + /// The values for Object must be JSON objects. It can consist of `num`,
|
| + /// `String`, `bool` and `null` as well as `Map` and `List` values.
|
| core.List<core.Map<core.String, core.Object>> details;
|
| - /**
|
| - * A developer-facing error message, which should be in English. Any
|
| - * user-facing error message should be localized and sent in the
|
| - * google.rpc.Status.details field, or localized by the client.
|
| - */
|
| +
|
| + /// A developer-facing error message, which should be in English. Any
|
| + /// user-facing error message should be localized and sent in the
|
| + /// google.rpc.Status.details field, or localized by the client.
|
| core.String message;
|
|
|
| Status();
|
| @@ -1497,7 +1645,8 @@ class Status {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (code != null) {
|
| _json["code"] = code;
|
| }
|
| @@ -1511,18 +1660,18 @@ class Status {
|
| }
|
| }
|
|
|
| -/** Request message to unclaim a device. */
|
| +/// Request message to unclaim a device.
|
| class UnclaimDeviceRequest {
|
| - /** The device id returned by ClaimDevice. */
|
| + /// The device ID returned by `ClaimDevice`.
|
| core.String deviceId;
|
| - /** The device identifier you use when you claimed this device. */
|
| +
|
| + /// The device identifier you used when you claimed this device.
|
| DeviceIdentifier deviceIdentifier;
|
| - /**
|
| - * The section type to unclaim for.
|
| - * Possible string values are:
|
| - * - "SECTION_TYPE_UNSPECIFIED" : Unspecified
|
| - * - "SECTION_TYPE_ZERO_TOUCH" : Zero touch
|
| - */
|
| +
|
| + /// The section type to unclaim for.
|
| + /// Possible string values are:
|
| + /// - "SECTION_TYPE_UNSPECIFIED" : Unspecified section type.
|
| + /// - "SECTION_TYPE_ZERO_TOUCH" : Zero touch section type.
|
| core.String sectionType;
|
|
|
| UnclaimDeviceRequest();
|
| @@ -1532,7 +1681,8 @@ class UnclaimDeviceRequest {
|
| deviceId = _json["deviceId"];
|
| }
|
| if (_json.containsKey("deviceIdentifier")) {
|
| - deviceIdentifier = new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| + deviceIdentifier =
|
| + new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| }
|
| if (_json.containsKey("sectionType")) {
|
| sectionType = _json["sectionType"];
|
| @@ -1540,7 +1690,8 @@ class UnclaimDeviceRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (deviceId != null) {
|
| _json["deviceId"] = deviceId;
|
| }
|
| @@ -1554,21 +1705,24 @@ class UnclaimDeviceRequest {
|
| }
|
| }
|
|
|
| -/** Request to unclaim devices asynchronously in batch. */
|
| +/// Request to unclaim devices asynchronously in batch.
|
| class UnclaimDevicesRequest {
|
| - /** list of unclaims. */
|
| + /// List of devices to unclaim.
|
| core.List<PartnerUnclaim> unclaims;
|
|
|
| UnclaimDevicesRequest();
|
|
|
| UnclaimDevicesRequest.fromJson(core.Map _json) {
|
| if (_json.containsKey("unclaims")) {
|
| - unclaims = _json["unclaims"].map((value) => new PartnerUnclaim.fromJson(value)).toList();
|
| + unclaims = _json["unclaims"]
|
| + .map((value) => new PartnerUnclaim.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (unclaims != null) {
|
| _json["unclaims"] = unclaims.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -1576,21 +1730,24 @@ class UnclaimDevicesRequest {
|
| }
|
| }
|
|
|
| -/** Request to update device metadata in batch. */
|
| +/// Request to update device metadata in batch.
|
| class UpdateDeviceMetadataInBatchRequest {
|
| - /** list of metadata updates. */
|
| + /// List of metadata updates.
|
| core.List<UpdateMetadataArguments> updates;
|
|
|
| UpdateDeviceMetadataInBatchRequest();
|
|
|
| UpdateDeviceMetadataInBatchRequest.fromJson(core.Map _json) {
|
| if (_json.containsKey("updates")) {
|
| - updates = _json["updates"].map((value) => new UpdateMetadataArguments.fromJson(value)).toList();
|
| + updates = _json["updates"]
|
| + .map((value) => new UpdateMetadataArguments.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (updates != null) {
|
| _json["updates"] = updates.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -1598,9 +1755,9 @@ class UpdateDeviceMetadataInBatchRequest {
|
| }
|
| }
|
|
|
| -/** Request to set metadata for a device. */
|
| +/// Request to set metadata for a device.
|
| class UpdateDeviceMetadataRequest {
|
| - /** The metdata to set. */
|
| + /// The metdata to set.
|
| DeviceMetadata deviceMetadata;
|
|
|
| UpdateDeviceMetadataRequest();
|
| @@ -1612,7 +1769,8 @@ class UpdateDeviceMetadataRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (deviceMetadata != null) {
|
| _json["deviceMetadata"] = (deviceMetadata).toJson();
|
| }
|
| @@ -1620,13 +1778,15 @@ class UpdateDeviceMetadataRequest {
|
| }
|
| }
|
|
|
| -/** Identifies metdata updates to one device. */
|
| +/// Identifies metdata updates to one device.
|
| class UpdateMetadataArguments {
|
| - /** device id of the device. */
|
| + /// Device ID of the device.
|
| core.String deviceId;
|
| - /** device identifier. */
|
| +
|
| + /// Device identifier.
|
| DeviceIdentifier deviceIdentifier;
|
| - /** The metadata to update. */
|
| +
|
| + /// The metadata to update.
|
| DeviceMetadata deviceMetadata;
|
|
|
| UpdateMetadataArguments();
|
| @@ -1636,7 +1796,8 @@ class UpdateMetadataArguments {
|
| deviceId = _json["deviceId"];
|
| }
|
| if (_json.containsKey("deviceIdentifier")) {
|
| - deviceIdentifier = new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| + deviceIdentifier =
|
| + new DeviceIdentifier.fromJson(_json["deviceIdentifier"]);
|
| }
|
| if (_json.containsKey("deviceMetadata")) {
|
| deviceMetadata = new DeviceMetadata.fromJson(_json["deviceMetadata"]);
|
| @@ -1644,7 +1805,8 @@ class UpdateMetadataArguments {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (deviceId != null) {
|
| _json["deviceId"] = deviceId;
|
| }
|
|
|