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/vault_v1.matters.html b/docs/dyn/vault_v1.matters.html
index 9e2ba45..adbfde4 100644
--- a/docs/dyn/vault_v1.matters.html
+++ b/docs/dyn/vault_v1.matters.html
@@ -102,10 +102,10 @@
<code><a href="#delete">delete(matterId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified matter. Returns matter with updated state.</p>
<p class="toc_element">
- <code><a href="#get">get(matterId, x__xgafv=None, view=None)</a></code></p>
+ <code><a href="#get">get(matterId, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified matter.</p>
<p class="toc_element">
- <code><a href="#list">list(pageSize=None, state=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
+ <code><a href="#list">list(state=None, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matters the user has access to.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -135,18 +135,18 @@
{ # Add an account with the permission specified. The role cannot be owner.
# If an account already has a role in the matter, it will be
# overwritten.
- "ccMe": True or False, # Only relevant if send_emails is true.
- # True to CC requestor in the email message.
- # False to not CC requestor.
- "sendEmails": True or False, # True to send notification email to the added account.
+ "sendEmails": True or False, # True to send notification email to the added account.
# False to not send notification email.
- "matterPermission": { # Currently each matter only has one owner, and all others are collaborators. # The MatterPermission to add.
+ "matterPermission": { # Currently each matter only has one owner, and all others are collaborators. # The MatterPermission to add.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
+ "ccMe": True or False, # Only relevant if send_emails is true.
+ # True to CC requestor in the email message.
+ # False to not CC requestor.
}
x__xgafv: string, V1 error format.
@@ -160,9 +160,9 @@
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
}</pre>
</div>
@@ -187,22 +187,22 @@
An object of the form:
{ # Response to a CloseMatterRequest.
- "matter": { # Represents a matter. # The updated matter, with state CLOSED.
- "matterId": "A String", # The matter ID which is generated by the server.
- # Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
+ "matter": { # Represents a matter. # The updated matter, with state CLOSED.
+ "state": "A String", # The state of the matter.
+ "name": "A String", # The name of the matter.
+ "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
],
- "state": "A String", # The state of the matter.
- "name": "A String", # The name of the matter.
- "description": "A String", # The description of the matter.
+ "description": "A String", # The description of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server.
+ # Should be blank when creating a new matter.
},
}</pre>
</div>
@@ -218,21 +218,21 @@
The object takes the form of:
{ # Represents a matter.
- "matterId": "A String", # The matter ID which is generated by the server.
- # Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
+ "state": "A String", # The state of the matter.
+ "name": "A String", # The name of the matter.
+ "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
],
- "state": "A String", # The state of the matter.
- "name": "A String", # The name of the matter.
- "description": "A String", # The description of the matter.
+ "description": "A String", # The description of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server.
+ # Should be blank when creating a new matter.
}
x__xgafv: string, V1 error format.
@@ -244,21 +244,21 @@
An object of the form:
{ # Represents a matter.
- "matterId": "A String", # The matter ID which is generated by the server.
- # Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
+ "state": "A String", # The state of the matter.
+ "name": "A String", # The name of the matter.
+ "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
],
- "state": "A String", # The state of the matter.
- "name": "A String", # The name of the matter.
- "description": "A String", # The description of the matter.
+ "description": "A String", # The description of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server.
+ # Should be blank when creating a new matter.
}</pre>
</div>
@@ -277,96 +277,96 @@
An object of the form:
{ # Represents a matter.
- "matterId": "A String", # The matter ID which is generated by the server.
- # Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
+ "state": "A String", # The state of the matter.
+ "name": "A String", # The name of the matter.
+ "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
],
- "state": "A String", # The state of the matter.
- "name": "A String", # The name of the matter.
- "description": "A String", # The description of the matter.
+ "description": "A String", # The description of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server.
+ # Should be blank when creating a new matter.
}</pre>
</div>
<div class="method">
- <code class="details" id="get">get(matterId, x__xgafv=None, view=None)</code>
+ <code class="details" id="get">get(matterId, view=None, x__xgafv=None)</code>
<pre>Gets the specified matter.
Args:
matterId: string, The matter ID. (required)
+ view: string, Specifies which parts of the Matter to return in the response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- view: string, Specifies which parts of the Matter to return in the response.
Returns:
An object of the form:
{ # Represents a matter.
- "matterId": "A String", # The matter ID which is generated by the server.
- # Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
+ "state": "A String", # The state of the matter.
+ "name": "A String", # The name of the matter.
+ "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
],
- "state": "A String", # The state of the matter.
- "name": "A String", # The name of the matter.
- "description": "A String", # The description of the matter.
+ "description": "A String", # The description of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server.
+ # Should be blank when creating a new matter.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageSize=None, state=None, pageToken=None, x__xgafv=None, view=None)</code>
+ <code class="details" id="list">list(state=None, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>
<pre>Lists matters the user has access to.
Args:
- pageSize: integer, The number of matters to return in the response.
-Default and maximum are 100.
state: string, If set, list only matters with that specific state. The default is listing
matters of all states.
pageToken: string, The pagination token as returned in the response.
+ pageSize: integer, The number of matters to return in the response.
+Default and maximum are 100.
+ view: string, Specifies which parts of the matter to return in response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- view: string, Specifies which parts of the matter to return in response.
Returns:
An object of the form:
{ # Provides the list of matters.
- "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
- "matters": [ # List of matters.
+ "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
+ "matters": [ # List of matters.
{ # Represents a matter.
- "matterId": "A String", # The matter ID which is generated by the server.
- # Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
+ "state": "A String", # The state of the matter.
+ "name": "A String", # The name of the matter.
+ "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
],
- "state": "A String", # The state of the matter.
- "name": "A String", # The name of the matter.
- "description": "A String", # The description of the matter.
+ "description": "A String", # The description of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server.
+ # Should be blank when creating a new matter.
},
],
}</pre>
@@ -381,7 +381,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>
@@ -396,7 +396,7 @@
The object takes the form of:
{ # Remove an account as a matter collaborator.
- "accountId": "A String", # The account ID.
+ "accountId": "A String", # The account ID.
}
x__xgafv: string, V1 error format.
@@ -440,22 +440,22 @@
An object of the form:
{ # Response to a ReopenMatterRequest.
- "matter": { # Represents a matter. # The updated matter, with state OPEN.
- "matterId": "A String", # The matter ID which is generated by the server.
- # Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
+ "matter": { # Represents a matter. # The updated matter, with state OPEN.
+ "state": "A String", # The state of the matter.
+ "name": "A String", # The name of the matter.
+ "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
],
- "state": "A String", # The state of the matter.
- "name": "A String", # The name of the matter.
- "description": "A String", # The description of the matter.
+ "description": "A String", # The description of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server.
+ # Should be blank when creating a new matter.
},
}</pre>
</div>
@@ -481,21 +481,21 @@
An object of the form:
{ # Represents a matter.
- "matterId": "A String", # The matter ID which is generated by the server.
- # Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
+ "state": "A String", # The state of the matter.
+ "name": "A String", # The name of the matter.
+ "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
],
- "state": "A String", # The state of the matter.
- "name": "A String", # The name of the matter.
- "description": "A String", # The description of the matter.
+ "description": "A String", # The description of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server.
+ # Should be blank when creating a new matter.
}</pre>
</div>
@@ -512,21 +512,21 @@
The object takes the form of:
{ # Represents a matter.
- "matterId": "A String", # The matter ID which is generated by the server.
- # Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
+ "state": "A String", # The state of the matter.
+ "name": "A String", # The name of the matter.
+ "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
],
- "state": "A String", # The state of the matter.
- "name": "A String", # The name of the matter.
- "description": "A String", # The description of the matter.
+ "description": "A String", # The description of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server.
+ # Should be blank when creating a new matter.
}
x__xgafv: string, V1 error format.
@@ -538,21 +538,21 @@
An object of the form:
{ # Represents a matter.
- "matterId": "A String", # The matter ID which is generated by the server.
- # Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
+ "state": "A String", # The state of the matter.
+ "name": "A String", # The name of the matter.
+ "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
{ # Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
- "role": "A String", # The user's role in this matter.
- "accountId": "A String", # The account ID, as provided by <a
- # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "role": "A String", # The user's role in this matter.
+ "accountId": "A String", # The account ID, as provided by <a
+ # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
},
],
- "state": "A String", # The state of the matter.
- "name": "A String", # The name of the matter.
- "description": "A String", # The description of the matter.
+ "description": "A String", # The description of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server.
+ # Should be blank when creating a new matter.
}</pre>
</div>