chore: update docs/dyn (#1162)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/b5e48daa-1759-436b-9fe7-ffce1482b520/targets
- [ ] To automatically regenerate this PR, check this box.
diff --git a/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html b/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html
index 3daa941..3522c03 100644
--- a/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html
+++ b/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html
@@ -84,7 +84,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, pageSize=None, x__xgafv=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,18 +106,18 @@
The object takes the form of:
{ # Request message for customer to assign a configuration to device.
- "configuration": "A String", # Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
- "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured 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 identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device the configuration is applied to.
- "deviceId": "A String", # The ID of the device.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device.
- "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 value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
- "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).
- },
+ "configuration": "A String", # Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
+ "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured 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 identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device the configuration is applied to.
+ "deviceId": "A String", # The ID of the device.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
},
- }
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -128,7 +128,7 @@
An object of the form:
{ # 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 `{}`.
- }</pre>
+}</pre>
</div>
<div class="method">
@@ -151,41 +151,41 @@
An object of the form:
{ # An Android device registered for zero-touch enrollment.
- "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` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
- { # A record of a device claimed by a reseller for a customer. Devices claimed 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).
- "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'.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased 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'.
- },
- ],
- "configuration": "A String", # Not available to resellers.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
+ "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` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
+ { # A record of a device claimed by a reseller for a customer. Devices claimed 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).
+ "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.
+ "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
},
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "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 value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
- "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).
+ ],
+ "configuration": "A String", # Not available to resellers.
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
+ },
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/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.
- "name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- }</pre>
+ },
+ "name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
+}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <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)
- pageToken: string, A token specifying which result page to return.
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
@@ -195,36 +195,36 @@
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.
- { # An Android device registered for zero-touch enrollment.
- "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` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
- { # A record of a device claimed by a reseller for a customer. Devices claimed 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).
- "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'.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased 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'.
- },
- ],
- "configuration": "A String", # Not available to resellers.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
+ "devices": [ # The customer's devices.
+ { # An Android device registered for zero-touch enrollment.
+ "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` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
+ { # A record of a device claimed by a reseller for a customer. Devices claimed 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).
+ "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.
+ "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
},
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "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 value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
- "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).
- },
- "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
- "name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
+ ],
+ "configuration": "A String", # Not available to resellers.
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
},
- ],
- }</pre>
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/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.
+ },
+ ],
+ "nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further results are available.
+}</pre>
</div>
<div class="method">
@@ -251,17 +251,17 @@
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_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured 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 identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device to remove the configuration from.
- "deviceId": "A String", # The ID of the device.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device.
- "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 value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
- "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).
- },
+ "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured 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 identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device to remove the configuration from.
+ "deviceId": "A String", # The ID of the device.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
},
- }
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -272,7 +272,7 @@
An object of the form:
{ # 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 `{}`.
- }</pre>
+}</pre>
</div>
<div class="method">
@@ -285,17 +285,17 @@
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_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured 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 identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device to unclaim.
- "deviceId": "A String", # The ID of the device.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device.
- "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 value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
- "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).
- },
+ "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured 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 identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device to unclaim.
+ "deviceId": "A String", # The ID of the device.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
},
- }
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -306,7 +306,7 @@
An object of the form:
{ # 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 `{}`.
- }</pre>
+}</pre>
</div>
</body></html>
\ No newline at end of file