Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / vault_v1.matters.html
blob: 01469e45bc3d240949e86c54be5b12a4c93198fb [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="vault_v1.html">G Suite Vault API</a> . <a href="vault_v1.matters.html">matters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="vault_v1.matters.exports.html">exports()</a></code>
79</p>
80<p class="firstline">Returns the exports Resource.</p>
81
82<p class="toc_element">
83 <code><a href="vault_v1.matters.holds.html">holds()</a></code>
84</p>
85<p class="firstline">Returns the holds Resource.</p>
86
87<p class="toc_element">
88 <code><a href="vault_v1.matters.savedQueries.html">savedQueries()</a></code>
89</p>
90<p class="firstline">Returns the savedQueries Resource.</p>
91
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#addPermissions">addPermissions(matterId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Adds an account as a matter collaborator.</p>
95<p class="toc_element">
96 <code><a href="#close">close(matterId, body=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Closes the specified matter. Returns matter with updated state.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Creates a new matter with the given name and description. The initial state</p>
101<p class="toc_element">
102 <code><a href="#delete">delete(matterId, x__xgafv=None)</a></code></p>
103<p class="firstline">Deletes the specified matter. Returns matter with updated state.</p>
104<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 <code><a href="#get">get(matterId, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<p class="firstline">Gets the specified matter.</p>
107<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]108 <code><a href="#list">list(view=None, pageSize=None, pageToken=None, state=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<p class="firstline">Lists matters the user has access to.</p>
110<p class="toc_element">
111 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
112<p class="firstline">Retrieves the next page of results.</p>
113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]114 <code><a href="#removePermissions">removePermissions(matterId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115<p class="firstline">Removes an account as a matter collaborator.</p>
116<p class="toc_element">
117 <code><a href="#reopen">reopen(matterId, body=None, x__xgafv=None)</a></code></p>
118<p class="firstline">Reopens the specified matter. Returns matter with updated state.</p>
119<p class="toc_element">
120 <code><a href="#undelete">undelete(matterId, body=None, x__xgafv=None)</a></code></p>
121<p class="firstline">Undeletes the specified matter. Returns matter with updated state.</p>
122<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 <code><a href="#update">update(matterId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124<p class="firstline">Updates the specified matter.</p>
125<h3>Method Details</h3>
126<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]127 <code class="details" id="addPermissions">addPermissions(matterId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 <pre>Adds an account as a matter collaborator.
129
130Args:
131 matterId: string, The matter ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]132 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 The object takes the form of:
134
135{ # Add an account with the permission specified. The role cannot be owner.
136 # If an account already has a role in the matter, it will be
137 # overwritten.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 &quot;sendEmails&quot;: True or False, # True to send notification email to the added account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 # False to not send notification email.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &quot;ccMe&quot;: True or False, # Only relevant if send_emails is true.
141 # True to CC requestor in the email message.
142 # False to not CC requestor.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]143 &quot;matterPermission&quot;: { # Currently each matter only has one owner, and all others are collaborators. # The MatterPermission to add.
144 # When an account is purged, its corresponding MatterPermission resources
145 # cease to exist.
146 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
147 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
148 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
149 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 }
151
152 x__xgafv: string, V1 error format.
153 Allowed values
154 1 - v1 error format
155 2 - v2 error format
156
157Returns:
158 An object of the form:
159
160 { # Currently each matter only has one owner, and all others are collaborators.
161 # When an account is purged, its corresponding MatterPermission resources
162 # cease to exist.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
164 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]165 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 }</pre>
167</div>
168
169<div class="method">
170 <code class="details" id="close">close(matterId, body=None, x__xgafv=None)</code>
171 <pre>Closes the specified matter. Returns matter with updated state.
172
173Args:
174 matterId: string, The matter ID. (required)
175 body: object, The request body.
176 The object takes the form of:
177
178{ # Close a matter by ID.
179 }
180
181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186Returns:
187 An object of the form:
188
189 { # Response to a CloseMatterRequest.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]190 &quot;matter&quot;: { # Represents a matter. # The updated matter, with state CLOSED.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]191 &quot;name&quot;: &quot;A String&quot;, # The name of the matter.
192 &quot;description&quot;: &quot;A String&quot;, # The description of the matter.
193 &quot;matterId&quot;: &quot;A String&quot;, # The matter ID which is generated by the server.
194 # Should be blank when creating a new matter.
195 &quot;state&quot;: &quot;A String&quot;, # The state of the matter.
196 &quot;matterPermissions&quot;: [ # List of users and access to the matter. Currently there is no programmer
197 # defined limit on the number of permissions a matter can have.
198 { # Currently each matter only has one owner, and all others are collaborators.
199 # When an account is purged, its corresponding MatterPermission resources
200 # cease to exist.
201 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
202 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
203 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
204 },
205 ],
206 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 }</pre>
208</div>
209
210<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]211 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 <pre>Creates a new matter with the given name and description. The initial state
213is open, and the owner is the method caller. Returns the created matter
214with default view.
215
216Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]217 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 The object takes the form of:
219
220{ # Represents a matter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]221 &quot;name&quot;: &quot;A String&quot;, # The name of the matter.
222 &quot;description&quot;: &quot;A String&quot;, # The description of the matter.
223 &quot;matterId&quot;: &quot;A String&quot;, # The matter ID which is generated by the server.
224 # Should be blank when creating a new matter.
225 &quot;state&quot;: &quot;A String&quot;, # The state of the matter.
226 &quot;matterPermissions&quot;: [ # List of users and access to the matter. Currently there is no programmer
227 # defined limit on the number of permissions a matter can have.
228 { # Currently each matter only has one owner, and all others are collaborators.
229 # When an account is purged, its corresponding MatterPermission resources
230 # cease to exist.
231 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
232 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
233 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
234 },
235 ],
236 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237
238 x__xgafv: string, V1 error format.
239 Allowed values
240 1 - v1 error format
241 2 - v2 error format
242
243Returns:
244 An object of the form:
245
246 { # Represents a matter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]247 &quot;name&quot;: &quot;A String&quot;, # The name of the matter.
248 &quot;description&quot;: &quot;A String&quot;, # The description of the matter.
249 &quot;matterId&quot;: &quot;A String&quot;, # The matter ID which is generated by the server.
250 # Should be blank when creating a new matter.
251 &quot;state&quot;: &quot;A String&quot;, # The state of the matter.
252 &quot;matterPermissions&quot;: [ # List of users and access to the matter. Currently there is no programmer
253 # defined limit on the number of permissions a matter can have.
254 { # Currently each matter only has one owner, and all others are collaborators.
255 # When an account is purged, its corresponding MatterPermission resources
256 # cease to exist.
257 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
258 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
259 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
260 },
261 ],
262 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263</div>
264
265<div class="method">
266 <code class="details" id="delete">delete(matterId, x__xgafv=None)</code>
267 <pre>Deletes the specified matter. Returns matter with updated state.
268
269Args:
270 matterId: string, The matter ID (required)
271 x__xgafv: string, V1 error format.
272 Allowed values
273 1 - v1 error format
274 2 - v2 error format
275
276Returns:
277 An object of the form:
278
279 { # Represents a matter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]280 &quot;name&quot;: &quot;A String&quot;, # The name of the matter.
281 &quot;description&quot;: &quot;A String&quot;, # The description of the matter.
282 &quot;matterId&quot;: &quot;A String&quot;, # The matter ID which is generated by the server.
283 # Should be blank when creating a new matter.
284 &quot;state&quot;: &quot;A String&quot;, # The state of the matter.
285 &quot;matterPermissions&quot;: [ # List of users and access to the matter. Currently there is no programmer
286 # defined limit on the number of permissions a matter can have.
287 { # Currently each matter only has one owner, and all others are collaborators.
288 # When an account is purged, its corresponding MatterPermission resources
289 # cease to exist.
290 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
291 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
292 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
293 },
294 ],
295 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296</div>
297
298<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]299 <code class="details" id="get">get(matterId, view=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 <pre>Gets the specified matter.
301
302Args:
303 matterId: string, The matter ID. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]304 view: string, Specifies which parts of the Matter to return in the response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 x__xgafv: string, V1 error format.
306 Allowed values
307 1 - v1 error format
308 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]309
310Returns:
311 An object of the form:
312
313 { # Represents a matter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]314 &quot;name&quot;: &quot;A String&quot;, # The name of the matter.
315 &quot;description&quot;: &quot;A String&quot;, # The description of the matter.
316 &quot;matterId&quot;: &quot;A String&quot;, # The matter ID which is generated by the server.
317 # Should be blank when creating a new matter.
318 &quot;state&quot;: &quot;A String&quot;, # The state of the matter.
319 &quot;matterPermissions&quot;: [ # List of users and access to the matter. Currently there is no programmer
320 # defined limit on the number of permissions a matter can have.
321 { # Currently each matter only has one owner, and all others are collaborators.
322 # When an account is purged, its corresponding MatterPermission resources
323 # cease to exist.
324 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
325 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
326 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
327 },
328 ],
329 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330</div>
331
332<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]333 <code class="details" id="list">list(view=None, pageSize=None, pageToken=None, state=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 <pre>Lists matters the user has access to.
335
336Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]337 view: string, Specifies which parts of the matter to return in response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]338 pageSize: integer, The number of matters to return in the response.
339Default and maximum are 100.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]340 pageToken: string, The pagination token as returned in the response.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]341 state: string, If set, list only matters with that specific state. The default is listing
342matters of all states.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]343 x__xgafv: string, V1 error format.
344 Allowed values
345 1 - v1 error format
346 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]347
348Returns:
349 An object of the form:
350
351 { # Provides the list of matters.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]352 &quot;matters&quot;: [ # List of matters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 { # Represents a matter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]354 &quot;name&quot;: &quot;A String&quot;, # The name of the matter.
355 &quot;description&quot;: &quot;A String&quot;, # The description of the matter.
356 &quot;matterId&quot;: &quot;A String&quot;, # The matter ID which is generated by the server.
357 # Should be blank when creating a new matter.
358 &quot;state&quot;: &quot;A String&quot;, # The state of the matter.
359 &quot;matterPermissions&quot;: [ # List of users and access to the matter. Currently there is no programmer
360 # defined limit on the number of permissions a matter can have.
361 { # Currently each matter only has one owner, and all others are collaborators.
362 # When an account is purged, its corresponding MatterPermission resources
363 # cease to exist.
364 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
365 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
366 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
367 },
368 ],
369 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]371 &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token to retrieve the next page of results in the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]372 }</pre>
373</div>
374
375<div class="method">
376 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
377 <pre>Retrieves the next page of results.
378
379Args:
380 previous_request: The request for the previous page. (required)
381 previous_response: The response from the request for the previous page. (required)
382
383Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]384 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]385 page. Returns None if there are no more items in the collection.
386 </pre>
387</div>
388
389<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]390 <code class="details" id="removePermissions">removePermissions(matterId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]391 <pre>Removes an account as a matter collaborator.
392
393Args:
394 matterId: string, The matter ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]395 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]396 The object takes the form of:
397
398{ # Remove an account as a matter collaborator.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]399 &quot;accountId&quot;: &quot;A String&quot;, # The account ID.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]400 }
401
402 x__xgafv: string, V1 error format.
403 Allowed values
404 1 - v1 error format
405 2 - v2 error format
406
407Returns:
408 An object of the form:
409
410 { # A generic empty message that you can re-use to avoid defining duplicated
411 # empty messages in your APIs. A typical example is to use it as the request
412 # or the response type of an API method. For instance:
413 #
414 # service Foo {
415 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
416 # }
417 #
418 # The JSON representation for `Empty` is empty JSON object `{}`.
419 }</pre>
420</div>
421
422<div class="method">
423 <code class="details" id="reopen">reopen(matterId, body=None, x__xgafv=None)</code>
424 <pre>Reopens the specified matter. Returns matter with updated state.
425
426Args:
427 matterId: string, The matter ID. (required)
428 body: object, The request body.
429 The object takes the form of:
430
431{ # Reopen a matter by ID.
432 }
433
434 x__xgafv: string, V1 error format.
435 Allowed values
436 1 - v1 error format
437 2 - v2 error format
438
439Returns:
440 An object of the form:
441
442 { # Response to a ReopenMatterRequest.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]443 &quot;matter&quot;: { # Represents a matter. # The updated matter, with state OPEN.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]444 &quot;name&quot;: &quot;A String&quot;, # The name of the matter.
445 &quot;description&quot;: &quot;A String&quot;, # The description of the matter.
446 &quot;matterId&quot;: &quot;A String&quot;, # The matter ID which is generated by the server.
447 # Should be blank when creating a new matter.
448 &quot;state&quot;: &quot;A String&quot;, # The state of the matter.
449 &quot;matterPermissions&quot;: [ # List of users and access to the matter. Currently there is no programmer
450 # defined limit on the number of permissions a matter can have.
451 { # Currently each matter only has one owner, and all others are collaborators.
452 # When an account is purged, its corresponding MatterPermission resources
453 # cease to exist.
454 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
455 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
456 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
457 },
458 ],
459 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]460 }</pre>
461</div>
462
463<div class="method">
464 <code class="details" id="undelete">undelete(matterId, body=None, x__xgafv=None)</code>
465 <pre>Undeletes the specified matter. Returns matter with updated state.
466
467Args:
468 matterId: string, The matter ID. (required)
469 body: object, The request body.
470 The object takes the form of:
471
472{ # Undelete a matter by ID.
473 }
474
475 x__xgafv: string, V1 error format.
476 Allowed values
477 1 - v1 error format
478 2 - v2 error format
479
480Returns:
481 An object of the form:
482
483 { # Represents a matter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]484 &quot;name&quot;: &quot;A String&quot;, # The name of the matter.
485 &quot;description&quot;: &quot;A String&quot;, # The description of the matter.
486 &quot;matterId&quot;: &quot;A String&quot;, # The matter ID which is generated by the server.
487 # Should be blank when creating a new matter.
488 &quot;state&quot;: &quot;A String&quot;, # The state of the matter.
489 &quot;matterPermissions&quot;: [ # List of users and access to the matter. Currently there is no programmer
490 # defined limit on the number of permissions a matter can have.
491 { # Currently each matter only has one owner, and all others are collaborators.
492 # When an account is purged, its corresponding MatterPermission resources
493 # cease to exist.
494 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
495 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
496 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
497 },
498 ],
499 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]500</div>
501
502<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]503 <code class="details" id="update">update(matterId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]504 <pre>Updates the specified matter.
505This updates only the name and description of the matter, identified by
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]506matter ID. Changes to any other fields are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]507Returns the default view of the matter.
508
509Args:
510 matterId: string, The matter ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]511 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]512 The object takes the form of:
513
514{ # Represents a matter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]515 &quot;name&quot;: &quot;A String&quot;, # The name of the matter.
516 &quot;description&quot;: &quot;A String&quot;, # The description of the matter.
517 &quot;matterId&quot;: &quot;A String&quot;, # The matter ID which is generated by the server.
518 # Should be blank when creating a new matter.
519 &quot;state&quot;: &quot;A String&quot;, # The state of the matter.
520 &quot;matterPermissions&quot;: [ # List of users and access to the matter. Currently there is no programmer
521 # defined limit on the number of permissions a matter can have.
522 { # Currently each matter only has one owner, and all others are collaborators.
523 # When an account is purged, its corresponding MatterPermission resources
524 # cease to exist.
525 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
526 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
527 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
528 },
529 ],
530 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]531
532 x__xgafv: string, V1 error format.
533 Allowed values
534 1 - v1 error format
535 2 - v2 error format
536
537Returns:
538 An object of the form:
539
540 { # Represents a matter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]541 &quot;name&quot;: &quot;A String&quot;, # The name of the matter.
542 &quot;description&quot;: &quot;A String&quot;, # The description of the matter.
543 &quot;matterId&quot;: &quot;A String&quot;, # The matter ID which is generated by the server.
544 # Should be blank when creating a new matter.
545 &quot;state&quot;: &quot;A String&quot;, # The state of the matter.
546 &quot;matterPermissions&quot;: [ # List of users and access to the matter. Currently there is no programmer
547 # defined limit on the number of permissions a matter can have.
548 { # Currently each matter only has one owner, and all others are collaborators.
549 # When an account is purged, its corresponding MatterPermission resources
550 # cease to exist.
551 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by &lt;a
552 # href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
553 &quot;role&quot;: &quot;A String&quot;, # The user&#x27;s role in this matter.
554 },
555 ],
556 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]557</div>
558
559</body></html>