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/licensing_v1.licenseAssignments.html b/docs/dyn/licensing_v1.licenseAssignments.html
index 6f6c406..0e2bf7e 100644
--- a/docs/dyn/licensing_v1.licenseAssignments.html
+++ b/docs/dyn/licensing_v1.licenseAssignments.html
@@ -84,10 +84,10 @@
<code><a href="#insert">insert(productId, skuId, body=None)</a></code></p>
<p class="firstline">Assign a license.</p>
<p class="toc_element">
- <code><a href="#listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</a></code></p>
+ <code><a href="#listForProduct">listForProduct(productId, customerId, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline">List all users assigned licenses for a specific product SKU.</p>
<p class="toc_element">
- <code><a href="#listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</a></code></p>
+ <code><a href="#listForProductAndSku">listForProductAndSku(productId, skuId, customerId, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline">List all users assigned licenses for a specific product SKU.</p>
<p class="toc_element">
<code><a href="#listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</a></code></p>
@@ -107,37 +107,37 @@
<pre>Revoke a license.
Args:
- productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
- skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
- userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests.
-Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes.
+ productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
+ skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
+ userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests.
+Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes.
If the userId is suspended, the license status changes. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(productId, skuId, userId)</code>
- <pre>Get a specific user's license by product SKU.
+ <pre>Get a specific user's license by product SKU.
Args:
- productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
- skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
- userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests.
-Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes.
+ productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
+ skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
+ userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests.
+Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes.
If the userId is suspended, the license status changes. (required)
Returns:
An object of the form:
{ # Representation of a license assignment.
- "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
- "productName": "A String", # Display Name of the product.
- "skuName": "A String", # Display Name of the sku of the product.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "etags": "A String", # ETag of the resource.
+ "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "productName": "A String", # Display Name of the product.
+ "selfLink": "A String", # Link to this page.
+ "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
+ "skuName": "A String", # Display Name of the sku of the product.
+ "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
}</pre>
</div>
@@ -146,13 +146,13 @@
<pre>Assign a license.
Args:
- productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
- skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
+ productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
+ skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
body: object, The request body.
The object takes the form of:
{ # Representation of a license assignment.
- "userId": "A String", # Email id of the user
+ "userId": "A String", # Email id of the user
}
@@ -160,81 +160,81 @@
An object of the form:
{ # Representation of a license assignment.
- "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
- "productName": "A String", # Display Name of the product.
- "skuName": "A String", # Display Name of the sku of the product.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "etags": "A String", # ETag of the resource.
+ "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "productName": "A String", # Display Name of the product.
+ "selfLink": "A String", # Link to this page.
+ "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
+ "skuName": "A String", # Display Name of the sku of the product.
+ "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
}</pre>
</div>
<div class="method">
- <code class="details" id="listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</code>
+ <code class="details" id="listForProduct">listForProduct(productId, customerId, maxResults=None, pageToken=None)</code>
<pre>List all users assigned licenses for a specific product SKU.
Args:
- productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
- customerId: string, Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field.
+ productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
+ customerId: string, Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field.
If the customer is suspended, the server returns an error. (required)
- pageToken: string, Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.
maxResults: integer, The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.
+ pageToken: string, Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.
Returns:
An object of the form:
{ # LicesnseAssignment List for a given product/sku for a customer.
- "nextPageToken": "A String", # The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The maxResults query string is related to the nextPageToken since maxResults determines how many entries are returned on each next page.
- "items": [ # The LicenseAssignments in this page of results.
+ "etag": "A String", # ETag of the resource.
+ "items": [ # The LicenseAssignments in this page of results.
{ # Representation of a license assignment.
- "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
- "productName": "A String", # Display Name of the product.
- "skuName": "A String", # Display Name of the sku of the product.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "etags": "A String", # ETag of the resource.
+ "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "productName": "A String", # Display Name of the product.
+ "selfLink": "A String", # Link to this page.
+ "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
+ "skuName": "A String", # Display Name of the sku of the product.
+ "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
},
],
- "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
- "etag": "A String", # ETag of the resource.
+ "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
+ "nextPageToken": "A String", # The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The maxResults query string is related to the nextPageToken since maxResults determines how many entries are returned on each next page.
}</pre>
</div>
<div class="method">
- <code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</code>
+ <code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, maxResults=None, pageToken=None)</code>
<pre>List all users assigned licenses for a specific product SKU.
Args:
- productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
- skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
- customerId: string, Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field.
+ productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
+ skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
+ customerId: string, Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field.
If the customer is suspended, the server returns an error. (required)
- pageToken: string, Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.
maxResults: integer, The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.
+ pageToken: string, Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.
Returns:
An object of the form:
{ # LicesnseAssignment List for a given product/sku for a customer.
- "nextPageToken": "A String", # The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The maxResults query string is related to the nextPageToken since maxResults determines how many entries are returned on each next page.
- "items": [ # The LicenseAssignments in this page of results.
+ "etag": "A String", # ETag of the resource.
+ "items": [ # The LicenseAssignments in this page of results.
{ # Representation of a license assignment.
- "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
- "productName": "A String", # Display Name of the product.
- "skuName": "A String", # Display Name of the sku of the product.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "etags": "A String", # ETag of the resource.
+ "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "productName": "A String", # Display Name of the product.
+ "selfLink": "A String", # Link to this page.
+ "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
+ "skuName": "A String", # Display Name of the sku of the product.
+ "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
},
],
- "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
- "etag": "A String", # ETag of the resource.
+ "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
+ "nextPageToken": "A String", # The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The maxResults query string is related to the nextPageToken since maxResults determines how many entries are returned on each next page.
}</pre>
</div>
@@ -247,7 +247,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>
@@ -261,33 +261,33 @@
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>
<div class="method">
<code class="details" id="patch">patch(productId, skuId, userId, body=None)</code>
- <pre>Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.
+ <pre>Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.
Args:
- productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
- skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
- userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests.
-Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes.
+ productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
+ skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
+ userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests.
+Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes.
If the userId is suspended, the license status changes. (required)
body: object, The request body.
The object takes the form of:
{ # Representation of a license assignment.
- "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
- "productName": "A String", # Display Name of the product.
- "skuName": "A String", # Display Name of the sku of the product.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "etags": "A String", # ETag of the resource.
+ "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "productName": "A String", # Display Name of the product.
+ "selfLink": "A String", # Link to this page.
+ "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
+ "skuName": "A String", # Display Name of the sku of the product.
+ "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
}
@@ -295,39 +295,39 @@
An object of the form:
{ # Representation of a license assignment.
- "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
- "productName": "A String", # Display Name of the product.
- "skuName": "A String", # Display Name of the sku of the product.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "etags": "A String", # ETag of the resource.
+ "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "productName": "A String", # Display Name of the product.
+ "selfLink": "A String", # Link to this page.
+ "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
+ "skuName": "A String", # Display Name of the sku of the product.
+ "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(productId, skuId, userId, body=None)</code>
- <pre>Reassign a user's product SKU with a different SKU in the same product.
+ <pre>Reassign a user's product SKU with a different SKU in the same product.
Args:
- productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
- skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
- userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests.
-Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes.
+ productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
+ skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
+ userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests.
+Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes.
If the userId is suspended, the license status changes. (required)
body: object, The request body.
The object takes the form of:
{ # Representation of a license assignment.
- "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
- "productName": "A String", # Display Name of the product.
- "skuName": "A String", # Display Name of the sku of the product.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "etags": "A String", # ETag of the resource.
+ "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "productName": "A String", # Display Name of the product.
+ "selfLink": "A String", # Link to this page.
+ "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
+ "skuName": "A String", # Display Name of the sku of the product.
+ "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
}
@@ -335,14 +335,14 @@
An object of the form:
{ # Representation of a license assignment.
- "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
- "productName": "A String", # Display Name of the product.
- "skuName": "A String", # Display Name of the sku of the product.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "etags": "A String", # ETag of the resource.
+ "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
+ "productName": "A String", # Display Name of the product.
+ "selfLink": "A String", # Link to this page.
+ "skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
+ "skuName": "A String", # Display Name of the sku of the product.
+ "userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
}</pre>
</div>