chore: regens API reference docs (#889)
diff --git a/docs/dyn/licensing_v1.licenseAssignments.html b/docs/dyn/licensing_v1.licenseAssignments.html
index c939d4a..6f6c406 100644
--- a/docs/dyn/licensing_v1.licenseAssignments.html
+++ b/docs/dyn/licensing_v1.licenseAssignments.html
@@ -72,23 +72,23 @@
</style>
-<h1><a href="licensing_v1.html">Enterprise License Manager API</a> . <a href="licensing_v1.licenseAssignments.html">licenseAssignments</a></h1>
+<h1><a href="licensing_v1.html">Licensing API</a> . <a href="licensing_v1.licenseAssignments.html">licenseAssignments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(productId, skuId, userId)</a></code></p>
-<p class="firstline">Revoke License.</p>
+<p class="firstline">Revoke a license.</p>
<p class="toc_element">
<code><a href="#get">get(productId, skuId, userId)</a></code></p>
-<p class="firstline">Get license assignment of a particular product and sku for a user</p>
+<p class="firstline">Get a specific user's license by product SKU.</p>
<p class="toc_element">
- <code><a href="#insert">insert(productId, skuId, body)</a></code></p>
-<p class="firstline">Assign License.</p>
+ <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>
-<p class="firstline">List license assignments for given product of the customer.</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>
-<p class="firstline">List license assignments for given product and sku of the customer.</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>
<p class="firstline">Retrieves the next page of results.</p>
@@ -96,58 +96,62 @@
<code><a href="#listForProduct_next">listForProduct_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(productId, skuId, userId, body)</a></code></p>
-<p class="firstline">Assign License. This method supports patch semantics.</p>
+ <code><a href="#patch">patch(productId, skuId, userId, body=None)</a></code></p>
+<p class="firstline">Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.</p>
<p class="toc_element">
- <code><a href="#update">update(productId, skuId, userId, body)</a></code></p>
-<p class="firstline">Assign License.</p>
+ <code><a href="#update">update(productId, skuId, userId, body=None)</a></code></p>
+<p class="firstline">Reassign a user's product SKU with a different SKU in the same product.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(productId, skuId, userId)</code>
- <pre>Revoke License.
+ <pre>Revoke a license.
Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku (required)
- userId: string, email id or unique Id of the user (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)
+ 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 license assignment of a particular product and sku for a user
+ <pre>Get a specific user's license by product SKU.
Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku (required)
- userId: string, email id or unique Id of the user (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)
+ 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:
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Id of the sku of the product.
+ { # 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", # Email id of the user.
+ "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", # Id of the product.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
}</pre>
</div>
<div class="method">
- <code class="details" id="insert">insert(productId, skuId, body)</code>
- <pre>Assign License.
+ <code class="details" id="insert">insert(productId, skuId, body=None)</code>
+ <pre>Assign a license.
Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku (required)
- body: object, The request body. (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:
-{ # Template for LicenseAssignment Insert request
+{ # Representation of a license assignment.
"userId": "A String", # Email id of the user
}
@@ -155,43 +159,44 @@
Returns:
An object of the form:
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Id of the sku of the product.
+ { # 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", # Email id of the user.
+ "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", # Id of the product.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
}</pre>
</div>
<div class="method">
<code class="details" id="listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</code>
- <pre>List license assignments for given product of the customer.
+ <pre>List all users assigned licenses for a specific product SKU.
Args:
- productId: string, Name for product (required)
- customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
- pageToken: string, Token to fetch the next page.Optional. By default server will return first page
- maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
+ 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.
Returns:
An object of the form:
{ # LicesnseAssignment List for a given product/sku for a customer.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "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.
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Id of the sku of the product.
+ { # 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", # Email id of the user.
+ "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", # Id of the product.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
},
],
"kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
@@ -201,30 +206,31 @@
<div class="method">
<code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</code>
- <pre>List license assignments for given product and sku of the customer.
+ <pre>List all users assigned licenses for a specific product SKU.
Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku (required)
- customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
- pageToken: string, Token to fetch the next page.Optional. By default server will return first page
- maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
+ 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.
Returns:
An object of the form:
{ # LicesnseAssignment List for a given product/sku for a customer.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "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.
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Id of the sku of the product.
+ { # 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", # Email id of the user.
+ "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", # Id of the product.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
},
],
"kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
@@ -261,78 +267,82 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(productId, skuId, userId, body)</code>
- <pre>Assign License. This method supports patch semantics.
+ <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.
Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku for which license would be revoked (required)
- userId: string, email id or unique Id of the user (required)
- body: object, The request body. (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)
+ 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:
-{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Id of the sku of the product.
+{ # 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", # Email id of the user.
+ "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", # Id of the product.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
}
Returns:
An object of the form:
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Id of the sku of the product.
+ { # 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", # Email id of the user.
+ "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", # Id of the product.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(productId, skuId, userId, body)</code>
- <pre>Assign License.
+ <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.
Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku for which license would be revoked (required)
- userId: string, email id or unique Id of the user (required)
- body: object, The request body. (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)
+ 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:
-{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Id of the sku of the product.
+{ # 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", # Email id of the user.
+ "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", # Id of the product.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
}
Returns:
An object of the form:
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Id of the sku of the product.
+ { # 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", # Email id of the user.
+ "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", # Id of the product.
+ "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
}</pre>
</div>