chore: regens API reference docs (#889)
diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
index 75f7afa..aae89ca 100644
--- a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
+++ b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
@@ -75,19 +75,19 @@
<h1><a href="androiddeviceprovisioning_v1.html">Android Device Provisioning Partner API</a> . <a href="androiddeviceprovisioning_v1.partners.html">partners</a> . <a href="androiddeviceprovisioning_v1.partners.devices.html">devices</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#claim">claim(partnerId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#claim">claim(partnerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Claims a device for a customer and adds it to zero-touch enrollment. If the</p>
<p class="toc_element">
- <code><a href="#claimAsync">claimAsync(partnerId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#claimAsync">claimAsync(partnerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Claims a batch of devices for a customer asynchronously. Adds the devices</p>
<p class="toc_element">
- <code><a href="#findByIdentifier">findByIdentifier(partnerId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#findByIdentifier">findByIdentifier(partnerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Finds devices by hardware identifiers, such as IMEI.</p>
<p class="toc_element">
<code><a href="#findByIdentifier_next">findByIdentifier_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#findByOwner">findByOwner(partnerId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#findByOwner">findByOwner(partnerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Finds devices claimed for customers. The results only contain devices</p>
<p class="toc_element">
<code><a href="#findByOwner_next">findByOwner_next(previous_request, previous_response)</a></code></p>
@@ -96,29 +96,35 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a device.</p>
<p class="toc_element">
- <code><a href="#metadata">metadata(metadataOwnerId, deviceId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#metadata">metadata(metadataOwnerId, deviceId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates reseller metadata associated with the device.</p>
<p class="toc_element">
- <code><a href="#unclaim">unclaim(partnerId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#unclaim">unclaim(partnerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Unclaims a device from a customer and removes it from zero-touch</p>
<p class="toc_element">
- <code><a href="#unclaimAsync">unclaimAsync(partnerId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#unclaimAsync">unclaimAsync(partnerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Unclaims a batch of devices for a customer asynchronously. Removes the</p>
<p class="toc_element">
- <code><a href="#updateMetadataAsync">updateMetadataAsync(partnerId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#updateMetadataAsync">updateMetadataAsync(partnerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the reseller metadata attached to a batch of devices. This method</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="claim">claim(partnerId, body, x__xgafv=None)</code>
+ <code class="details" id="claim">claim(partnerId, body=None, x__xgafv=None)</code>
<pre>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.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message to claim a device on behalf of a customer.
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Optional. The metadata to attach to the device.
+ # [Device metadata](/zero-touch/guides/metadata).
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
+ },
+ },
"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. The device identifier of the device to claim.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
@@ -134,12 +140,6 @@
# listed in
# [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
},
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Optional. The metadata to attach to the device.
- # [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- },
"sectionType": "A String", # Required. The section type of the device's provisioning record.
"customerId": "A String", # Required. The ID of the customer for whom the device is being claimed.
}
@@ -160,14 +160,14 @@
</div>
<div class="method">
- <code class="details" id="claimAsync">claimAsync(partnerId, body, x__xgafv=None)</code>
+ <code class="details" id="claimAsync">claimAsync(partnerId, body=None, x__xgafv=None)</code>
<pre>Claims a batch of devices for a customer asynchronously. Adds the devices
to zero-touch enrollment. To learn more, read [Long‑running batch
operations](/zero-touch/guides/how-it-works#operations).
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request to claim devices asynchronously in batch. Claiming a device adds the
@@ -196,8 +196,8 @@
# listed in
# [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
},
- "customerId": "A String", # Required. The ID of the customer for whom the device is being claimed.
"sectionType": "A String", # Required. The section type of the device's provisioning record.
+ "customerId": "A String", # Required. The ID of the customer for whom the device is being claimed.
},
],
}
@@ -212,18 +212,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # 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.
- "name": "A String", # 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 be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # 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`.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -242,16 +233,25 @@
},
],
},
+ "done": True or False, # 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.
+ "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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 be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="findByIdentifier">findByIdentifier(partnerId, body, x__xgafv=None)</code>
+ <code class="details" id="findByIdentifier">findByIdentifier(partnerId, body=None, x__xgafv=None)</code>
<pre>Finds devices by hardware identifiers, such as IMEI.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request to find devices.
@@ -307,14 +307,8 @@
},
"name": "A String", # Output only. The API resource name in the format
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To
- # learn more, read [Device metadata](/zero-touch/guides/metadata).
- # [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- },
"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "configuration": "A String", # Not available to resellers.
"claims": [ # Output only. The provisioning claims for a device. Devices claimed for
# zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.
# Call
@@ -335,7 +329,13 @@
"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "configuration": "A String", # Not available to resellers.
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To
+ # learn more, read [Device metadata](/zero-touch/guides/metadata).
+ # [Device metadata](/zero-touch/guides/metadata).
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
+ },
+ },
},
],
}</pre>
@@ -356,7 +356,7 @@
</div>
<div class="method">
- <code class="details" id="findByOwner">findByOwner(partnerId, body, x__xgafv=None)</code>
+ <code class="details" id="findByOwner">findByOwner(partnerId, body=None, x__xgafv=None)</code>
<pre>Finds devices claimed for customers. The results only contain devices
registered to the reseller that's identified by the `partnerId` argument.
The customer's devices purchased from other resellers don't appear in the
@@ -364,7 +364,7 @@
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request to find devices by customers.
@@ -386,9 +386,9 @@
An object of the form:
{ # Response containing found devices.
- "totalSize": 42, # The total count of items in the list irrespective of pagination.
"nextPageToken": "A String", # A token used to access the next page of results.
# Omitted if no further results are available.
+ "totalSize": 42, # The total count of items in the list irrespective of pagination.
"devices": [ # The customer's devices.
{ # An Android device registered for zero-touch enrollment.
"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
@@ -409,14 +409,8 @@
},
"name": "A String", # Output only. The API resource name in the format
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To
- # learn more, read [Device metadata](/zero-touch/guides/metadata).
- # [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- },
"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "configuration": "A String", # Not available to resellers.
"claims": [ # Output only. The provisioning claims for a device. Devices claimed for
# zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.
# Call
@@ -437,7 +431,13 @@
"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "configuration": "A String", # Not available to resellers.
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To
+ # learn more, read [Device metadata](/zero-touch/guides/metadata).
+ # [Device metadata](/zero-touch/guides/metadata).
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
+ },
+ },
},
],
}</pre>
@@ -491,14 +491,8 @@
},
"name": "A String", # Output only. The API resource name in the format
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To
- # learn more, read [Device metadata](/zero-touch/guides/metadata).
- # [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- },
"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "configuration": "A String", # Not available to resellers.
"claims": [ # Output only. The provisioning claims for a device. Devices claimed for
# zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.
# Call
@@ -519,22 +513,28 @@
"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "configuration": "A String", # Not available to resellers.
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To
+ # learn more, read [Device metadata](/zero-touch/guides/metadata).
+ # [Device metadata](/zero-touch/guides/metadata).
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
+ },
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="metadata">metadata(metadataOwnerId, deviceId, body, x__xgafv=None)</code>
+ <code class="details" id="metadata">metadata(metadataOwnerId, deviceId, body=None, x__xgafv=None)</code>
<pre>Updates reseller metadata associated with the device.
Args:
metadataOwnerId: string, Required. The owner of the newly set metadata. Set this to the partner ID. (required)
deviceId: string, Required. The ID of the device. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request to set metadata for a device.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metdata to attach to the device.
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to attach to the device.
# [Device metadata](/zero-touch/guides/metadata).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
@@ -559,13 +559,13 @@
</div>
<div class="method">
- <code class="details" id="unclaim">unclaim(partnerId, body, x__xgafv=None)</code>
+ <code class="details" id="unclaim">unclaim(partnerId, body=None, x__xgafv=None)</code>
<pre>Unclaims a device from a customer and removes it from zero-touch
enrollment.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message to unclaim a device.
@@ -612,14 +612,14 @@
</div>
<div class="method">
- <code class="details" id="unclaimAsync">unclaimAsync(partnerId, body, x__xgafv=None)</code>
+ <code class="details" id="unclaimAsync">unclaimAsync(partnerId, body=None, x__xgafv=None)</code>
<pre>Unclaims a batch of devices for a customer asynchronously. Removes the
devices from zero-touch enrollment. To learn more, read [Long‑running batch
operations](/zero-touch/guides/how-it-works#operations).
Args:
partnerId: string, Required. The reseller partner ID. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request to unclaim devices asynchronously in batch.
@@ -659,18 +659,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # 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.
- "name": "A String", # 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 be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # 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`.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -689,11 +680,20 @@
},
],
},
+ "done": True or False, # 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.
+ "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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 be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="updateMetadataAsync">updateMetadataAsync(partnerId, body, x__xgafv=None)</code>
+ <code class="details" id="updateMetadataAsync">updateMetadataAsync(partnerId, body=None, x__xgafv=None)</code>
<pre>Updates the reseller metadata attached to a batch of devices. This method
updates devices asynchronously and returns an `Operation` that can be used
to track progress. Read [Long‑running batch
@@ -701,18 +701,12 @@
Args:
partnerId: string, Required. The reseller partner ID. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request to update device metadata in batch.
"updates": [ # Required. The list of metadata updates.
- { # Identifies metdata updates to one device.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to update.
- # [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- },
+ { # Identifies metadata updates to one device.
"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Device identifier.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
@@ -728,6 +722,12 @@
# listed in
# [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
},
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to update.
+ # [Device metadata](/zero-touch/guides/metadata).
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
+ },
+ },
"deviceId": "A String", # Device ID of the device.
},
],
@@ -743,18 +743,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # 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.
- "name": "A String", # 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 be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # 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`.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -773,6 +764,15 @@
},
],
},
+ "done": True or False, # 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.
+ "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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 be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>