claim method

Future<ClaimDeviceResponse> claim(
  1. ClaimDeviceRequest request,
  2. String partnerId, {
  3. String? $fields,
})

Claims a device for a customer and adds it to zero-touch enrollment.

If the device is already claimed by another customer, the call returns an error.

request - The metadata request object.

Request parameters:

partnerId - Required. The ID of the reseller partner. Value must have pattern ^\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

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.

Implementation

async.Future<ClaimDeviceResponse> claim(
  ClaimDeviceRequest request,
  core.String partnerId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1/partners/' + core.Uri.encodeFull('$partnerId') + '/devices:claim';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return ClaimDeviceResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}