docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html b/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html
index ad6e610..af81f6d 100644
--- a/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html
+++ b/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html
@@ -81,7 +81,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a device.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a customer's devices.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -106,7 +106,7 @@
The object takes the form of:
{ # Request message for customer to assign a configuration to device.
- "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device the configuration is applied to.
+ "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device the configuration is applied to.
# argument to a method using one of the following identifier types:
#
# * A numeric API resource ID.
@@ -114,26 +114,26 @@
# device.
#
# Methods that operate on devices take a `DeviceReference` as a parameter type
- # because it's more flexible for the caller. To learn more about device
+ # because it's more flexible for the caller. To learn more about device
# identifiers, read [Identifiers](/zero-touch/guides/identifiers).
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
+ "deviceId": "A String", # The ID of the device.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "model": "A String", # The device model's name. Matches the device's built-in value returned from
- # `android.os.Build.MODEL`. Allowed values are listed in
- # [models](/zero-touch/resources/manufacturer-names#model-names).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
# value returned from `android.os.Build.MANUFACTURER`. Allowed values are
# listed in
# [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
+ "meid": "A String", # The device’s MEID number.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "model": "A String", # The device model's name. Matches the device's built-in value returned from
+ # `android.os.Build.MODEL`. Allowed values are listed in
+ # [models](/zero-touch/resources/manufacturer-names#model-names).
},
- "deviceId": "A String", # The ID of the device.
},
- "configuration": "A String", # Required. The configuration applied to the device in the format
+ "configuration": "A String", # Required. The configuration applied to the device in the format
# `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
}
@@ -173,27 +173,33 @@
An object of the form:
{ # 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
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
# [Identifiers](/zero-touch/guides/identifiers).
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "model": "A String", # The device model's name. Matches the device's built-in value returned from
- # `android.os.Build.MODEL`. Allowed values are listed in
- # [models](/zero-touch/resources/manufacturer-names#model-names).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
# value returned from `android.os.Build.MANUFACTURER`. Allowed values are
# listed in
# [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
+ "meid": "A String", # The device’s MEID number.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "model": "A String", # The device model's name. Matches the device's built-in value returned from
+ # `android.os.Build.MODEL`. Allowed values are listed in
+ # [models](/zero-touch/resources/manufacturer-names#model-names).
},
- "name": "A String", # Output only. The API resource name in the format
+ "deviceId": "A String", # Output only. The ID of the device. 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",
+ },
+ },
+ "name": "A String", # Output only. The API resource name in the format
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "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
+ "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
# `partners.devices.unclaim`
@@ -204,69 +210,67 @@
# for zero-touch enrollment have a claim with the type
# `SECTION_TYPE_ZERO_TOUCH`. To learn more, read
# [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
- "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "resellerId": "A String", # The ID of the reseller that claimed the device.
- "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "sectionType": "A String", # Output only. The type of claim made on the device.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
+ "resellerId": "A String", # The ID of the reseller that claimed the device.
+ "sectionType": "A String", # Output only. The type of claim made on the device.
+ "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is
+ # present iff the device is in 'vacation mode'.
+ "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
+ # present iff the device is in 'vacation mode'.
+ "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "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",
- },
- },
+ "configuration": "A String", # Not available to resellers.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
- <pre>Lists a customer's devices.
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists a customer's devices.
Args:
parent: string, Required. The customer managing the devices. An API resource name in the
format `customers/[CUSTOMER_ID]`. (required)
+ pageSize: string, The maximum number of devices to show in a page of results.
+Must be between 1 and 100 inclusive.
pageToken: string, A token specifying which result page to return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageSize: string, The maximum number of devices to show in a page of results.
-Must be between 1 and 100 inclusive.
Returns:
An object of the form:
- { # Response message of customer's liting devices.
- "nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further
- # results are available.
- "devices": [ # The customer's devices.
+ { # Response message of customer's liting devices.
+ "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
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
# [Identifiers](/zero-touch/guides/identifiers).
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "model": "A String", # The device model's name. Matches the device's built-in value returned from
- # `android.os.Build.MODEL`. Allowed values are listed in
- # [models](/zero-touch/resources/manufacturer-names#model-names).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
# value returned from `android.os.Build.MANUFACTURER`. Allowed values are
# listed in
# [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
+ "meid": "A String", # The device’s MEID number.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "model": "A String", # The device model's name. Matches the device's built-in value returned from
+ # `android.os.Build.MODEL`. Allowed values are listed in
+ # [models](/zero-touch/resources/manufacturer-names#model-names).
},
- "name": "A String", # Output only. The API resource name in the format
+ "deviceId": "A String", # Output only. The ID of the device. 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",
+ },
+ },
+ "name": "A String", # Output only. The API resource name in the format
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "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
+ "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
# `partners.devices.unclaim`
@@ -277,24 +281,20 @@
# for zero-touch enrollment have a claim with the type
# `SECTION_TYPE_ZERO_TOUCH`. To learn more, read
# [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
- "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "resellerId": "A String", # The ID of the reseller that claimed the device.
- "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "sectionType": "A String", # Output only. The type of claim made on the device.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
+ "resellerId": "A String", # The ID of the reseller that claimed the device.
+ "sectionType": "A String", # Output only. The type of claim made on the device.
+ "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is
+ # present iff the device is in 'vacation mode'.
+ "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
+ # present iff the device is in 'vacation mode'.
+ "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "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",
- },
- },
+ "configuration": "A String", # Not available to resellers.
},
],
+ "nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further
+ # results are available.
}</pre>
</div>
@@ -307,7 +307,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -323,7 +323,7 @@
The object takes the form of:
{ # Request message for customer to remove the configuration from device.
- "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device to remove the configuration from.
+ "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device to remove the configuration from.
# argument to a method using one of the following identifier types:
#
# * A numeric API resource ID.
@@ -331,24 +331,24 @@
# device.
#
# Methods that operate on devices take a `DeviceReference` as a parameter type
- # because it's more flexible for the caller. To learn more about device
+ # because it's more flexible for the caller. To learn more about device
# identifiers, read [Identifiers](/zero-touch/guides/identifiers).
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
+ "deviceId": "A String", # The ID of the device.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "model": "A String", # The device model's name. Matches the device's built-in value returned from
- # `android.os.Build.MODEL`. Allowed values are listed in
- # [models](/zero-touch/resources/manufacturer-names#model-names).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
# value returned from `android.os.Build.MANUFACTURER`. Allowed values are
# listed in
# [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
+ "meid": "A String", # The device’s MEID number.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "model": "A String", # The device model's name. Matches the device's built-in value returned from
+ # `android.os.Build.MODEL`. Allowed values are listed in
+ # [models](/zero-touch/resources/manufacturer-names#model-names).
},
- "deviceId": "A String", # The ID of the device.
},
}
@@ -387,7 +387,7 @@
The object takes the form of:
{ # Request message for customer to unclaim a device.
- "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device to unclaim.
+ "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device to unclaim.
# argument to a method using one of the following identifier types:
#
# * A numeric API resource ID.
@@ -395,24 +395,24 @@
# device.
#
# Methods that operate on devices take a `DeviceReference` as a parameter type
- # because it's more flexible for the caller. To learn more about device
+ # because it's more flexible for the caller. To learn more about device
# identifiers, read [Identifiers](/zero-touch/guides/identifiers).
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
+ "deviceId": "A String", # The ID of the device.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "model": "A String", # The device model's name. Matches the device's built-in value returned from
- # `android.os.Build.MODEL`. Allowed values are listed in
- # [models](/zero-touch/resources/manufacturer-names#model-names).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
# value returned from `android.os.Build.MANUFACTURER`. Allowed values are
# listed in
# [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
+ "meid": "A String", # The device’s MEID number.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "model": "A String", # The device model's name. Matches the device's built-in value returned from
+ # `android.os.Build.MODEL`. Allowed values are listed in
+ # [models](/zero-touch/resources/manufacturer-names#model-names).
},
- "deviceId": "A String", # The ID of the device.
},
}