Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / vault_v1.matters.html
blob: f1d4c27cff6d1e91acb09bc367145bcf7d31520d [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">
93 <code><a href="#addPermissions">addPermissions(matterId, body, x__xgafv=None)</a></code></p>
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">
99 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
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">
105 <code><a href="#get">get(matterId, x__xgafv=None, view=None)</a></code></p>
106<p class="firstline">Gets the specified matter.</p>
107<p class="toc_element">
108 <code><a href="#list">list(pageSize=None, state=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
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">
114 <code><a href="#removePermissions">removePermissions(matterId, body, x__xgafv=None)</a></code></p>
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">
123 <code><a href="#update">update(matterId, body, x__xgafv=None)</a></code></p>
124<p class="firstline">Updates the specified matter.</p>
125<h3>Method Details</h3>
126<div class="method">
127 <code class="details" id="addPermissions">addPermissions(matterId, body, x__xgafv=None)</code>
128 <pre>Adds an account as a matter collaborator.
129
130Args:
131 matterId: string, The matter ID. (required)
132 body: object, The request body. (required)
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.
138 "ccMe": True or False, # Only relevant if send_emails is true.
139 # True to CC requestor in the email message.
140 # False to not CC requestor.
141 "sendEmails": True or False, # True to send notification email to the added account.
142 # False to not send notification email.
143 "matterPermission": { # 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 "role": "A String", # The user's role in this matter.
147 "accountId": "A String", # The account id, as provided by <a
148 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
149 },
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.
163 "role": "A String", # The user's role in this matter.
164 "accountId": "A String", # The account id, as provided by <a
165 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
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.
190 "matter": { # Represents a matter. # The updated matter, with state CLOSED.
191 "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
192 # defined limit on the number of permissions a matter can have.
193 { # Currently each matter only has one owner, and all others are collaborators.
194 # When an account is purged, its corresponding MatterPermission resources
195 # cease to exist.
196 "role": "A String", # The user's role in this matter.
197 "accountId": "A String", # The account id, as provided by <a
198 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
199 },
200 ],
201 "matterId": "A String", # The matter ID which is generated by the server.
202 # Should be blank when creating a new matter.
203 "state": "A String", # The state of the matter.
204 "name": "A String", # The name of the matter.
205 "description": "A String", # The description of the matter.
206 },
207 }</pre>
208</div>
209
210<div class="method">
211 <code class="details" id="create">create(body, x__xgafv=None)</code>
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:
217 body: object, The request body. (required)
218 The object takes the form of:
219
220{ # Represents a matter.
221 "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
222 # defined limit on the number of permissions a matter can have.
223 { # Currently each matter only has one owner, and all others are collaborators.
224 # When an account is purged, its corresponding MatterPermission resources
225 # cease to exist.
226 "role": "A String", # The user's role in this matter.
227 "accountId": "A String", # The account id, as provided by <a
228 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
229 },
230 ],
231 "matterId": "A String", # The matter ID which is generated by the server.
232 # Should be blank when creating a new matter.
233 "state": "A String", # The state of the matter.
234 "name": "A String", # The name of the matter.
235 "description": "A String", # The description of the matter.
236}
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.
247 "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
248 # defined limit on the number of permissions a matter can have.
249 { # Currently each matter only has one owner, and all others are collaborators.
250 # When an account is purged, its corresponding MatterPermission resources
251 # cease to exist.
252 "role": "A String", # The user's role in this matter.
253 "accountId": "A String", # The account id, as provided by <a
254 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
255 },
256 ],
257 "matterId": "A String", # The matter ID which is generated by the server.
258 # Should be blank when creating a new matter.
259 "state": "A String", # The state of the matter.
260 "name": "A String", # The name of the matter.
261 "description": "A String", # The description of the matter.
262 }</pre>
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.
280 "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
281 # defined limit on the number of permissions a matter can have.
282 { # Currently each matter only has one owner, and all others are collaborators.
283 # When an account is purged, its corresponding MatterPermission resources
284 # cease to exist.
285 "role": "A String", # The user's role in this matter.
286 "accountId": "A String", # The account id, as provided by <a
287 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
288 },
289 ],
290 "matterId": "A String", # The matter ID which is generated by the server.
291 # Should be blank when creating a new matter.
292 "state": "A String", # The state of the matter.
293 "name": "A String", # The name of the matter.
294 "description": "A String", # The description of the matter.
295 }</pre>
296</div>
297
298<div class="method">
299 <code class="details" id="get">get(matterId, x__xgafv=None, view=None)</code>
300 <pre>Gets the specified matter.
301
302Args:
303 matterId: string, The matter ID. (required)
304 x__xgafv: string, V1 error format.
305 Allowed values
306 1 - v1 error format
307 2 - v2 error format
308 view: string, Specifies which parts of the Matter to return in the response.
309
310Returns:
311 An object of the form:
312
313 { # Represents a matter.
314 "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
315 # defined limit on the number of permissions a matter can have.
316 { # Currently each matter only has one owner, and all others are collaborators.
317 # When an account is purged, its corresponding MatterPermission resources
318 # cease to exist.
319 "role": "A String", # The user's role in this matter.
320 "accountId": "A String", # The account id, as provided by <a
321 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
322 },
323 ],
324 "matterId": "A String", # The matter ID which is generated by the server.
325 # Should be blank when creating a new matter.
326 "state": "A String", # The state of the matter.
327 "name": "A String", # The name of the matter.
328 "description": "A String", # The description of the matter.
329 }</pre>
330</div>
331
332<div class="method">
333 <code class="details" id="list">list(pageSize=None, state=None, pageToken=None, x__xgafv=None, view=None)</code>
334 <pre>Lists matters the user has access to.
335
336Args:
337 pageSize: integer, The number of matters to return in the response.
338Default and maximum are 100.
339 state: string, If set, list only matters with that specific state. The default is listing
340matters of all states.
341 pageToken: string, The pagination token as returned in the response.
342 x__xgafv: string, V1 error format.
343 Allowed values
344 1 - v1 error format
345 2 - v2 error format
346 view: string, Specifies which parts of the matter to return in response.
347
348Returns:
349 An object of the form:
350
351 { # Provides the list of matters.
352 "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
353 "matters": [ # List of matters.
354 { # Represents a matter.
355 "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
356 # defined limit on the number of permissions a matter can have.
357 { # Currently each matter only has one owner, and all others are collaborators.
358 # When an account is purged, its corresponding MatterPermission resources
359 # cease to exist.
360 "role": "A String", # The user's role in this matter.
361 "accountId": "A String", # The account id, as provided by <a
362 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
363 },
364 ],
365 "matterId": "A String", # The matter ID which is generated by the server.
366 # Should be blank when creating a new matter.
367 "state": "A String", # The state of the matter.
368 "name": "A String", # The name of the matter.
369 "description": "A String", # The description of the matter.
370 },
371 ],
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:
384 A request object that you can call 'execute()' on to request the next
385 page. Returns None if there are no more items in the collection.
386 </pre>
387</div>
388
389<div class="method">
390 <code class="details" id="removePermissions">removePermissions(matterId, body, x__xgafv=None)</code>
391 <pre>Removes an account as a matter collaborator.
392
393Args:
394 matterId: string, The matter ID. (required)
395 body: object, The request body. (required)
396 The object takes the form of:
397
398{ # Remove an account as a matter collaborator.
399 "accountId": "A String", # The account ID.
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.
443 "matter": { # Represents a matter. # The updated matter, with state OPEN.
444 "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
445 # defined limit on the number of permissions a matter can have.
446 { # Currently each matter only has one owner, and all others are collaborators.
447 # When an account is purged, its corresponding MatterPermission resources
448 # cease to exist.
449 "role": "A String", # The user's role in this matter.
450 "accountId": "A String", # The account id, as provided by <a
451 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
452 },
453 ],
454 "matterId": "A String", # The matter ID which is generated by the server.
455 # Should be blank when creating a new matter.
456 "state": "A String", # The state of the matter.
457 "name": "A String", # The name of the matter.
458 "description": "A String", # The description of the matter.
459 },
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.
484 "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
485 # defined limit on the number of permissions a matter can have.
486 { # Currently each matter only has one owner, and all others are collaborators.
487 # When an account is purged, its corresponding MatterPermission resources
488 # cease to exist.
489 "role": "A String", # The user's role in this matter.
490 "accountId": "A String", # The account id, as provided by <a
491 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
492 },
493 ],
494 "matterId": "A String", # The matter ID which is generated by the server.
495 # Should be blank when creating a new matter.
496 "state": "A String", # The state of the matter.
497 "name": "A String", # The name of the matter.
498 "description": "A String", # The description of the matter.
499 }</pre>
500</div>
501
502<div class="method">
503 <code class="details" id="update">update(matterId, body, x__xgafv=None)</code>
504 <pre>Updates the specified matter.
505This updates only the name and description of the matter, identified by
506matter id. Changes to any other fields are ignored.
507Returns the default view of the matter.
508
509Args:
510 matterId: string, The matter ID. (required)
511 body: object, The request body. (required)
512 The object takes the form of:
513
514{ # Represents a matter.
515 "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
516 # defined limit on the number of permissions a matter can have.
517 { # Currently each matter only has one owner, and all others are collaborators.
518 # When an account is purged, its corresponding MatterPermission resources
519 # cease to exist.
520 "role": "A String", # The user's role in this matter.
521 "accountId": "A String", # The account id, as provided by <a
522 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
523 },
524 ],
525 "matterId": "A String", # The matter ID which is generated by the server.
526 # Should be blank when creating a new matter.
527 "state": "A String", # The state of the matter.
528 "name": "A String", # The name of the matter.
529 "description": "A String", # The description of the matter.
530}
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.
541 "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
542 # defined limit on the number of permissions a matter can have.
543 { # Currently each matter only has one owner, and all others are collaborators.
544 # When an account is purged, its corresponding MatterPermission resources
545 # cease to exist.
546 "role": "A String", # The user's role in this matter.
547 "accountId": "A String", # The account id, as provided by <a
548 # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
549 },
550 ],
551 "matterId": "A String", # The matter ID which is generated by the server.
552 # Should be blank when creating a new matter.
553 "state": "A String", # The state of the matter.
554 "name": "A String", # The name of the matter.
555 "description": "A String", # The description of the matter.
556 }</pre>
557</div>
558
559</body></html>