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.configurations.html b/docs/dyn/androiddeviceprovisioning_v1.customers.configurations.html
index f34a999..0cce351 100644
--- a/docs/dyn/androiddeviceprovisioning_v1.customers.configurations.html
+++ b/docs/dyn/androiddeviceprovisioning_v1.customers.configurations.html
@@ -109,37 +109,37 @@
# * Metadata displayed on the device to help users during setup.
#
# Customers can add as many configurations as they need. However, zero-touch
- # enrollment works best when a customer sets a default configuration that's
+ # enrollment works best when a customer sets a default configuration that's
# applied to any new devices the organization purchases.
- "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
- "contactPhone": "A String", # Required. The telephone number that device users can call, using another
+ "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
+ # or give them more details about what’s happening to their device.
+ # Zero-touch enrollment shows this message before the device is provisioned.
+ "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
+ "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
+ # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
+ # portal displays this name to IT admins.
+ "contactEmail": "A String", # Required. The email address that device users can contact to get help.
+ # Zero-touch enrollment shows this email address to device users before
+ # device provisioning. The value is validated on input.
+ "contactPhone": "A String", # Required. The telephone number that device users can call, using another
# device, to get help. Zero-touch enrollment shows this number to device
# users before device provisioning. Accepts numerals, spaces, the plus sign,
# hyphens, and parentheses.
- "name": "A String", # Output only. The API resource name in the format
- # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
- # the server.
- "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
- # organization name to device users during device provisioning.
- "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
- "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
- # or give them more details about what’s happening to their device.
- # Zero-touch enrollment shows this message before the device is provisioned.
- "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
+ "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
# in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
# call
# `customers.dpcs.list`.
- "contactEmail": "A String", # Required. The email address that device users can contact to get help.
- # Zero-touch enrollment shows this email address to device users before
- # device provisioning. The value is validated on input.
- "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
- # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
- # portal displays this name to IT admins.
- "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
+ "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
+ # organization name to device users during device provisioning.
+ "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
# enrollment applies to any new devices the organization purchases in the
# future. Only one customer configuration can be the default. Setting this
- # value to `true`, changes the previous default configuration's `isDefault`
+ # value to `true`, changes the previous default configuration's `isDefault`
# value to `false`.
+ "name": "A String", # Output only. The API resource name in the format
+ # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
+ # the server.
+ "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
}
x__xgafv: string, V1 error format.
@@ -158,37 +158,37 @@
# * Metadata displayed on the device to help users during setup.
#
# Customers can add as many configurations as they need. However, zero-touch
- # enrollment works best when a customer sets a default configuration that's
+ # enrollment works best when a customer sets a default configuration that's
# applied to any new devices the organization purchases.
- "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
- "contactPhone": "A String", # Required. The telephone number that device users can call, using another
+ "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
+ # or give them more details about what’s happening to their device.
+ # Zero-touch enrollment shows this message before the device is provisioned.
+ "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
+ "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
+ # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
+ # portal displays this name to IT admins.
+ "contactEmail": "A String", # Required. The email address that device users can contact to get help.
+ # Zero-touch enrollment shows this email address to device users before
+ # device provisioning. The value is validated on input.
+ "contactPhone": "A String", # Required. The telephone number that device users can call, using another
# device, to get help. Zero-touch enrollment shows this number to device
# users before device provisioning. Accepts numerals, spaces, the plus sign,
# hyphens, and parentheses.
- "name": "A String", # Output only. The API resource name in the format
- # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
- # the server.
- "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
- # organization name to device users during device provisioning.
- "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
- "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
- # or give them more details about what’s happening to their device.
- # Zero-touch enrollment shows this message before the device is provisioned.
- "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
+ "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
# in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
# call
# `customers.dpcs.list`.
- "contactEmail": "A String", # Required. The email address that device users can contact to get help.
- # Zero-touch enrollment shows this email address to device users before
- # device provisioning. The value is validated on input.
- "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
- # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
- # portal displays this name to IT admins.
- "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
+ "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
+ # organization name to device users during device provisioning.
+ "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
# enrollment applies to any new devices the organization purchases in the
# future. Only one customer configuration can be the default. Setting this
- # value to `true`, changes the previous default configuration's `isDefault`
+ # value to `true`, changes the previous default configuration's `isDefault`
# value to `false`.
+ "name": "A String", # Output only. The API resource name in the format
+ # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
+ # the server.
+ "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
}</pre>
</div>
@@ -244,43 +244,43 @@
# * Metadata displayed on the device to help users during setup.
#
# Customers can add as many configurations as they need. However, zero-touch
- # enrollment works best when a customer sets a default configuration that's
+ # enrollment works best when a customer sets a default configuration that's
# applied to any new devices the organization purchases.
- "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
- "contactPhone": "A String", # Required. The telephone number that device users can call, using another
+ "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
+ # or give them more details about what’s happening to their device.
+ # Zero-touch enrollment shows this message before the device is provisioned.
+ "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
+ "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
+ # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
+ # portal displays this name to IT admins.
+ "contactEmail": "A String", # Required. The email address that device users can contact to get help.
+ # Zero-touch enrollment shows this email address to device users before
+ # device provisioning. The value is validated on input.
+ "contactPhone": "A String", # Required. The telephone number that device users can call, using another
# device, to get help. Zero-touch enrollment shows this number to device
# users before device provisioning. Accepts numerals, spaces, the plus sign,
# hyphens, and parentheses.
- "name": "A String", # Output only. The API resource name in the format
- # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
- # the server.
- "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
- # organization name to device users during device provisioning.
- "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
- "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
- # or give them more details about what’s happening to their device.
- # Zero-touch enrollment shows this message before the device is provisioned.
- "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
+ "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
# in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
# call
# `customers.dpcs.list`.
- "contactEmail": "A String", # Required. The email address that device users can contact to get help.
- # Zero-touch enrollment shows this email address to device users before
- # device provisioning. The value is validated on input.
- "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
- # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
- # portal displays this name to IT admins.
- "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
+ "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
+ # organization name to device users during device provisioning.
+ "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
# enrollment applies to any new devices the organization purchases in the
# future. Only one customer configuration can be the default. Setting this
- # value to `true`, changes the previous default configuration's `isDefault`
+ # value to `true`, changes the previous default configuration's `isDefault`
# value to `false`.
+ "name": "A String", # Output only. The API resource name in the format
+ # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
+ # the server.
+ "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, x__xgafv=None)</code>
- <pre>Lists a customer's configurations.
+ <pre>Lists a customer's configurations.
Args:
parent: string, Required. The customer that manages the listed configurations. An API
@@ -293,8 +293,8 @@
Returns:
An object of the form:
- { # Response message of customer's listing configuration.
- "configurations": [ # The configurations.
+ { # Response message of customer's listing configuration.
+ "configurations": [ # The configurations.
{ # A configuration collects the provisioning options for Android devices. Each
# configuration combines the following:
#
@@ -303,37 +303,37 @@
# * Metadata displayed on the device to help users during setup.
#
# Customers can add as many configurations as they need. However, zero-touch
- # enrollment works best when a customer sets a default configuration that's
+ # enrollment works best when a customer sets a default configuration that's
# applied to any new devices the organization purchases.
- "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
- "contactPhone": "A String", # Required. The telephone number that device users can call, using another
+ "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
+ # or give them more details about what’s happening to their device.
+ # Zero-touch enrollment shows this message before the device is provisioned.
+ "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
+ "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
+ # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
+ # portal displays this name to IT admins.
+ "contactEmail": "A String", # Required. The email address that device users can contact to get help.
+ # Zero-touch enrollment shows this email address to device users before
+ # device provisioning. The value is validated on input.
+ "contactPhone": "A String", # Required. The telephone number that device users can call, using another
# device, to get help. Zero-touch enrollment shows this number to device
# users before device provisioning. Accepts numerals, spaces, the plus sign,
# hyphens, and parentheses.
- "name": "A String", # Output only. The API resource name in the format
- # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
- # the server.
- "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
- # organization name to device users during device provisioning.
- "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
- "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
- # or give them more details about what’s happening to their device.
- # Zero-touch enrollment shows this message before the device is provisioned.
- "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
+ "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
# in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
# call
# `customers.dpcs.list`.
- "contactEmail": "A String", # Required. The email address that device users can contact to get help.
- # Zero-touch enrollment shows this email address to device users before
- # device provisioning. The value is validated on input.
- "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
- # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
- # portal displays this name to IT admins.
- "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
+ "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
+ # organization name to device users during device provisioning.
+ "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
# enrollment applies to any new devices the organization purchases in the
# future. Only one customer configuration can be the default. Setting this
- # value to `true`, changes the previous default configuration's `isDefault`
+ # value to `true`, changes the previous default configuration's `isDefault`
# value to `false`.
+ "name": "A String", # Output only. The API resource name in the format
+ # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
+ # the server.
+ "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
},
],
}</pre>
@@ -341,7 +341,7 @@
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
- <pre>Updates a configuration's field values.
+ <pre>Updates a configuration's field values.
Args:
name: string, Output only. The API resource name in the format
@@ -358,37 +358,37 @@
# * Metadata displayed on the device to help users during setup.
#
# Customers can add as many configurations as they need. However, zero-touch
- # enrollment works best when a customer sets a default configuration that's
+ # enrollment works best when a customer sets a default configuration that's
# applied to any new devices the organization purchases.
- "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
- "contactPhone": "A String", # Required. The telephone number that device users can call, using another
+ "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
+ # or give them more details about what’s happening to their device.
+ # Zero-touch enrollment shows this message before the device is provisioned.
+ "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
+ "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
+ # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
+ # portal displays this name to IT admins.
+ "contactEmail": "A String", # Required. The email address that device users can contact to get help.
+ # Zero-touch enrollment shows this email address to device users before
+ # device provisioning. The value is validated on input.
+ "contactPhone": "A String", # Required. The telephone number that device users can call, using another
# device, to get help. Zero-touch enrollment shows this number to device
# users before device provisioning. Accepts numerals, spaces, the plus sign,
# hyphens, and parentheses.
- "name": "A String", # Output only. The API resource name in the format
- # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
- # the server.
- "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
- # organization name to device users during device provisioning.
- "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
- "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
- # or give them more details about what’s happening to their device.
- # Zero-touch enrollment shows this message before the device is provisioned.
- "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
+ "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
# in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
# call
# `customers.dpcs.list`.
- "contactEmail": "A String", # Required. The email address that device users can contact to get help.
- # Zero-touch enrollment shows this email address to device users before
- # device provisioning. The value is validated on input.
- "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
- # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
- # portal displays this name to IT admins.
- "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
+ "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
+ # organization name to device users during device provisioning.
+ "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
# enrollment applies to any new devices the organization purchases in the
# future. Only one customer configuration can be the default. Setting this
- # value to `true`, changes the previous default configuration's `isDefault`
+ # value to `true`, changes the previous default configuration's `isDefault`
# value to `false`.
+ "name": "A String", # Output only. The API resource name in the format
+ # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
+ # the server.
+ "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
}
updateMask: string, Required. The field mask applied to the target `Configuration` before
@@ -411,37 +411,37 @@
# * Metadata displayed on the device to help users during setup.
#
# Customers can add as many configurations as they need. However, zero-touch
- # enrollment works best when a customer sets a default configuration that's
+ # enrollment works best when a customer sets a default configuration that's
# applied to any new devices the organization purchases.
- "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
- "contactPhone": "A String", # Required. The telephone number that device users can call, using another
+ "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
+ # or give them more details about what’s happening to their device.
+ # Zero-touch enrollment shows this message before the device is provisioned.
+ "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
+ "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
+ # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
+ # portal displays this name to IT admins.
+ "contactEmail": "A String", # Required. The email address that device users can contact to get help.
+ # Zero-touch enrollment shows this email address to device users before
+ # device provisioning. The value is validated on input.
+ "contactPhone": "A String", # Required. The telephone number that device users can call, using another
# device, to get help. Zero-touch enrollment shows this number to device
# users before device provisioning. Accepts numerals, spaces, the plus sign,
# hyphens, and parentheses.
- "name": "A String", # Output only. The API resource name in the format
- # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
- # the server.
- "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
- # organization name to device users during device provisioning.
- "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
- "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
- # or give them more details about what’s happening to their device.
- # Zero-touch enrollment shows this message before the device is provisioned.
- "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
+ "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
# in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
# call
# `customers.dpcs.list`.
- "contactEmail": "A String", # Required. The email address that device users can contact to get help.
- # Zero-touch enrollment shows this email address to device users before
- # device provisioning. The value is validated on input.
- "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
- # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
- # portal displays this name to IT admins.
- "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
+ "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
+ # organization name to device users during device provisioning.
+ "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
# enrollment applies to any new devices the organization purchases in the
# future. Only one customer configuration can be the default. Setting this
- # value to `true`, changes the previous default configuration's `isDefault`
+ # value to `true`, changes the previous default configuration's `isDefault`
# value to `false`.
+ "name": "A String", # Output only. The API resource name in the format
+ # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
+ # the server.
+ "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
}</pre>
</div>