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.partners.customers.html b/docs/dyn/androiddeviceprovisioning_v1.partners.customers.html
index e293582..b7a8873 100644
--- a/docs/dyn/androiddeviceprovisioning_v1.partners.customers.html
+++ b/docs/dyn/androiddeviceprovisioning_v1.partners.customers.html
@@ -78,7 +78,7 @@
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a customer for zero-touch enrollment. After the method returns</p>
<p class="toc_element">
- <code><a href="#list">list(partnerId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(partnerId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the customers that are enrolled to the reseller identified by the</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -99,10 +99,23 @@
The object takes the form of:
{ # Request message to create a customer.
- "customer": { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs. # Required. The company data to populate the new customer. Must contain a
- # value for `companyName` and at least one `owner_email` that's associated
+ "customer": { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs. # Required. The company data to populate the new customer. Must contain a
+ # value for `companyName` and at least one `owner_email` that's associated
# with a Google Account. The values for `companyId` and `name` must be empty.
- "name": "A String", # Output only. The API resource name of the company. The resource name is one
+ "companyId": "A String", # Output only. The ID of the company. Assigned by the server.
+ "ownerEmails": [ # Input only. Email address of customer's users in the owner role. At least
+ # one `owner_email` is required. Each email address must be associated with a
+ # Google Account. Owners share the same access as admins but can also add,
+ # delete, and edit your organization's portal users.
+ "A String",
+ ],
+ "adminEmails": [ # Optional. Input only. Email address of customer's users in the admin role.
+ # Each email address must be associated with a Google Account.
+ "A String",
+ ],
+ "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the
+ # company's employees in the zero-touch enrollment portal.
+ "name": "A String", # Output only. The API resource name of the company. The resource name is one
# of the following formats:
#
# * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`
@@ -110,22 +123,9 @@
# * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]`
#
# Assigned by the server.
- "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the
- # company's employees in the zero-touch enrollment portal.
- "companyId": "A String", # Output only. The ID of the company. Assigned by the server.
- "ownerEmails": [ # Input only. Email address of customer's users in the owner role. At least
- # one `owner_email` is required. Each email address must be associated with a
- # Google Account. Owners share the same access as admins but can also add,
- # delete, and edit your organization's portal users.
- "A String",
- ],
- "termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest
+ "termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest
# Terms of Service (ToS). See
# TermsStatus.
- "adminEmails": [ # Optional. Input only. Email address of customer's users in the admin role.
- # Each email address must be associated with a Google Account.
- "A String",
- ],
},
}
@@ -138,7 +138,20 @@
An object of the form:
{ # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
- "name": "A String", # Output only. The API resource name of the company. The resource name is one
+ "companyId": "A String", # Output only. The ID of the company. Assigned by the server.
+ "ownerEmails": [ # Input only. Email address of customer's users in the owner role. At least
+ # one `owner_email` is required. Each email address must be associated with a
+ # Google Account. Owners share the same access as admins but can also add,
+ # delete, and edit your organization's portal users.
+ "A String",
+ ],
+ "adminEmails": [ # Optional. Input only. Email address of customer's users in the admin role.
+ # Each email address must be associated with a Google Account.
+ "A String",
+ ],
+ "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the
+ # company's employees in the zero-touch enrollment portal.
+ "name": "A String", # Output only. The API resource name of the company. The resource name is one
# of the following formats:
#
# * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`
@@ -146,36 +159,23 @@
# * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]`
#
# Assigned by the server.
- "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the
- # company's employees in the zero-touch enrollment portal.
- "companyId": "A String", # Output only. The ID of the company. Assigned by the server.
- "ownerEmails": [ # Input only. Email address of customer's users in the owner role. At least
- # one `owner_email` is required. Each email address must be associated with a
- # Google Account. Owners share the same access as admins but can also add,
- # delete, and edit your organization's portal users.
- "A String",
- ],
- "termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest
+ "termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest
# Terms of Service (ToS). See
# TermsStatus.
- "adminEmails": [ # Optional. Input only. Email address of customer's users in the admin role.
- # Each email address must be associated with a Google Account.
- "A String",
- ],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(partnerId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(partnerId, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists the customers that are enrolled to the reseller identified by the
`partnerId` argument. This list includes customers that the reseller
created and customers that enrolled themselves using the portal.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
+ pageToken: string, A token identifying a page of results returned by the server.
pageSize: integer, The maximum number of results to be returned. If not specified or 0, all
the records are returned.
- pageToken: string, A token identifying a page of results returned by the server.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -185,12 +185,23 @@
An object of the form:
{ # Response message of all customers related to this partner.
- "totalSize": 42, # The total count of items in the list irrespective of pagination.
- "nextPageToken": "A String", # A token to retrieve the next page of results. Omitted if no further results
- # are available.
- "customers": [ # List of customers related to this reseller partner.
+ "totalSize": 42, # The total count of items in the list irrespective of pagination.
+ "customers": [ # List of customers related to this reseller partner.
{ # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
- "name": "A String", # Output only. The API resource name of the company. The resource name is one
+ "companyId": "A String", # Output only. The ID of the company. Assigned by the server.
+ "ownerEmails": [ # Input only. Email address of customer's users in the owner role. At least
+ # one `owner_email` is required. Each email address must be associated with a
+ # Google Account. Owners share the same access as admins but can also add,
+ # delete, and edit your organization's portal users.
+ "A String",
+ ],
+ "adminEmails": [ # Optional. Input only. Email address of customer's users in the admin role.
+ # Each email address must be associated with a Google Account.
+ "A String",
+ ],
+ "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the
+ # company's employees in the zero-touch enrollment portal.
+ "name": "A String", # Output only. The API resource name of the company. The resource name is one
# of the following formats:
#
# * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`
@@ -198,24 +209,13 @@
# * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]`
#
# Assigned by the server.
- "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the
- # company's employees in the zero-touch enrollment portal.
- "companyId": "A String", # Output only. The ID of the company. Assigned by the server.
- "ownerEmails": [ # Input only. Email address of customer's users in the owner role. At least
- # one `owner_email` is required. Each email address must be associated with a
- # Google Account. Owners share the same access as admins but can also add,
- # delete, and edit your organization's portal users.
- "A String",
- ],
- "termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest
+ "termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest
# Terms of Service (ToS). See
# TermsStatus.
- "adminEmails": [ # Optional. Input only. Email address of customer's users in the admin role.
- # Each email address must be associated with a Google Account.
- "A String",
- ],
},
],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Omitted if no further results
+ # are available.
}</pre>
</div>
@@ -228,7 +228,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>