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/content_v2.accounttax.html b/docs/dyn/content_v2.accounttax.html
index 98c9fef..b1cce2b 100644
--- a/docs/dyn/content_v2.accounttax.html
+++ b/docs/dyn/content_v2.accounttax.html
@@ -81,7 +81,7 @@
<code><a href="#get">get(merchantId, accountId)</a></code></p>
<p class="firstline">Retrieves the tax settings of the account.</p>
<p class="toc_element">
- <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
+ <code><a href="#list">list(merchantId, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline">Lists the tax settings of the sub-accounts in your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -99,29 +99,29 @@
The object takes the form of:
{
- "entries": [ # The request entries to be processed in the batch.
+ "entries": [ # The request entries to be processed in the batch.
{ # A batch entry encoding a single non-batch accounttax request.
- "batchId": 42, # An entry ID, unique within the batch request.
- "method": "A String", # The method of the batch entry.
- #
- # Acceptable values are:
- # - "`get`"
- # - "`update`"
- "accountTax": { # The tax settings of a merchant account. All methods require the admin role. # The account tax settings to update. Only defined if the method is `update`.
- "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
+ "accountId": "A String", # The ID of the account for which to get/update account tax settings.
+ "accountTax": { # The tax settings of a merchant account. All methods require the admin role. # The account tax settings to update. Only defined if the method is `update`.
+ "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
+ "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
+ "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
- "country": "A String", # Country code in which tax is applicable.
- "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
- "shippingTaxed": True or False, # If true, shipping charges are also taxed.
- "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
- "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
+ "country": "A String", # Country code in which tax is applicable.
+ "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
+ "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
+ "shippingTaxed": True or False, # If true, shipping charges are also taxed.
+ "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
- "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
- "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
},
- "merchantId": "A String", # The ID of the managing account.
- "accountId": "A String", # The ID of the account for which to get/update account tax settings.
+ "batchId": 42, # An entry ID, unique within the batch request.
+ "merchantId": "A String", # The ID of the managing account.
+ "method": "A String", # The method of the batch entry.
+ #
+ # Acceptable values are:
+ # - "`get`"
+ # - "`update`"
},
],
}
@@ -132,37 +132,37 @@
An object of the form:
{
- "kind": "content#accounttaxCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".
- "entries": [ # The result of the execution of the batch requests.
+ "entries": [ # The result of the execution of the batch requests.
{ # A batch entry encoding a single non-batch accounttax response.
- "batchId": 42, # The ID of the request entry this entry responds to.
- "accountTax": { # The tax settings of a merchant account. All methods require the admin role. # The retrieved or updated account tax settings.
- "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
+ "accountTax": { # The tax settings of a merchant account. All methods require the admin role. # The retrieved or updated account tax settings.
+ "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
+ "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
+ "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
- "country": "A String", # Country code in which tax is applicable.
- "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
- "shippingTaxed": True or False, # If true, shipping charges are also taxed.
- "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
- "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
+ "country": "A String", # Country code in which tax is applicable.
+ "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
+ "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
+ "shippingTaxed": True or False, # If true, shipping charges are also taxed.
+ "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
- "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
- "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
},
- "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
- "message": "A String", # The message of the first error in `errors`.
- "code": 42, # The HTTP status of the first error in `errors`.
- "errors": [ # A list of errors.
+ "batchId": 42, # The ID of the request entry this entry responds to.
+ "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
+ "code": 42, # The HTTP status of the first error in `errors`.
+ "errors": [ # A list of errors.
{ # An error returned by the API.
- "reason": "A String", # The error code.
- "domain": "A String", # The domain of the error.
- "message": "A String", # A description of the error.
+ "domain": "A String", # The domain of the error.
+ "message": "A String", # A description of the error.
+ "reason": "A String", # The error code.
},
],
+ "message": "A String", # The message of the first error in `errors`.
},
- "kind": "content#accounttaxCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "`content#accounttaxCustomBatchResponseEntry`"
+ "kind": "content#accounttaxCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "`content#accounttaxCustomBatchResponseEntry`"
},
],
+ "kind": "content#accounttaxCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".
}</pre>
</div>
@@ -178,48 +178,48 @@
An object of the form:
{ # The tax settings of a merchant account. All methods require the admin role.
- "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
+ "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
+ "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
+ "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
- "country": "A String", # Country code in which tax is applicable.
- "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
- "shippingTaxed": True or False, # If true, shipping charges are also taxed.
- "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
- "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
+ "country": "A String", # Country code in which tax is applicable.
+ "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
+ "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
+ "shippingTaxed": True or False, # If true, shipping charges are also taxed.
+ "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
- "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
- "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
+ <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None)</code>
<pre>Lists the tax settings of the sub-accounts in your Merchant Center account.
Args:
merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
- pageToken: string, The token returned by the previous request.
maxResults: integer, The maximum number of tax settings to return in the response, used for paging.
+ pageToken: string, The token returned by the previous request.
Returns:
An object of the form:
{
- "nextPageToken": "A String", # The token for the retrieval of the next page of account tax settings.
- "kind": "content#accounttaxListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".
- "resources": [
+ "kind": "content#accounttaxListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".
+ "nextPageToken": "A String", # The token for the retrieval of the next page of account tax settings.
+ "resources": [
{ # The tax settings of a merchant account. All methods require the admin role.
- "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
+ "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
+ "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
+ "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
- "country": "A String", # Country code in which tax is applicable.
- "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
- "shippingTaxed": True or False, # If true, shipping charges are also taxed.
- "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
- "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
+ "country": "A String", # Country code in which tax is applicable.
+ "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
+ "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
+ "shippingTaxed": True or False, # If true, shipping charges are also taxed.
+ "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
- "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
- "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
},
],
}</pre>
@@ -234,7 +234,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>
@@ -250,17 +250,17 @@
The object takes the form of:
{ # The tax settings of a merchant account. All methods require the admin role.
- "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
+ "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
+ "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
+ "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
- "country": "A String", # Country code in which tax is applicable.
- "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
- "shippingTaxed": True or False, # If true, shipping charges are also taxed.
- "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
- "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
+ "country": "A String", # Country code in which tax is applicable.
+ "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
+ "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
+ "shippingTaxed": True or False, # If true, shipping charges are also taxed.
+ "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
- "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
- "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
@@ -269,17 +269,17 @@
An object of the form:
{ # The tax settings of a merchant account. All methods require the admin role.
- "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
+ "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
+ "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
+ "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
- "country": "A String", # Country code in which tax is applicable.
- "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
- "shippingTaxed": True or False, # If true, shipping charges are also taxed.
- "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
- "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
+ "country": "A String", # Country code in which tax is applicable.
+ "locationId": "A String", # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
+ "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
+ "shippingTaxed": True or False, # If true, shipping charges are also taxed.
+ "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
- "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
- "accountId": "A String", # Required. The ID of the account to which these account tax settings belong.
}</pre>
</div>