Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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'Meara | dd49464 | 2020-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 Kim | 715bd7f | 2019-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 99 | <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 100 | <p class="firstline">Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.</p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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 Kim | 6502091 | 2020-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 Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | <p class="firstline">Gets the specified matter.</p> |
| 107 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 108 | <code><a href="#list">list(view=None, pageToken=None, pageSize=None, state=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-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'Meara | dd49464 | 2020-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 Kim | 715bd7f | 2019-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 123 | <code><a href="#update">update(matterId, body=None, x__xgafv=None)</a></code></p> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 124 | <p class="firstline">Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.</p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | <h3>Method Details</h3> |
| 126 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 127 | <code class="details" id="addPermissions">addPermissions(matterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 128 | <pre>Adds an account as a matter collaborator. |
| 129 | |
| 130 | Args: |
| 131 | matterId: string, The matter ID. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 132 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 133 | The object takes the form of: |
| 134 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 135 | { # 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. |
| 136 | "matterPermission": { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. # The MatterPermission to add. |
| 137 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 138 | "role": "A String", # The user's role in this matter. |
| 139 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 140 | "sendEmails": True or False, # True to send notification email to the added account. False to not send notification email. |
| 141 | "ccMe": True or False, # Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | x__xgafv: string, V1 error format. |
| 145 | Allowed values |
| 146 | 1 - v1 error format |
| 147 | 2 - v2 error format |
| 148 | |
| 149 | Returns: |
| 150 | An object of the form: |
| 151 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 152 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 153 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 154 | "role": "A String", # The user's role in this matter. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 155 | }</pre> |
| 156 | </div> |
| 157 | |
| 158 | <div class="method"> |
| 159 | <code class="details" id="close">close(matterId, body=None, x__xgafv=None)</code> |
| 160 | <pre>Closes the specified matter. Returns matter with updated state. |
| 161 | |
| 162 | Args: |
| 163 | matterId: string, The matter ID. (required) |
| 164 | body: object, The request body. |
| 165 | The object takes the form of: |
| 166 | |
| 167 | { # Close a matter by ID. |
| 168 | } |
| 169 | |
| 170 | x__xgafv: string, V1 error format. |
| 171 | Allowed values |
| 172 | 1 - v1 error format |
| 173 | 2 - v2 error format |
| 174 | |
| 175 | Returns: |
| 176 | An object of the form: |
| 177 | |
| 178 | { # Response to a CloseMatterRequest. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 179 | "matter": { # Represents a matter. # The updated matter, with state CLOSED. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 180 | "description": "A String", # The description of the matter. |
| 181 | "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. |
| 182 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 183 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 184 | "role": "A String", # The user's role in this matter. |
| 185 | }, |
| 186 | ], |
| 187 | "name": "A String", # The name of the matter. |
| 188 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 189 | "state": "A String", # The state of the matter. |
| 190 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 191 | }</pre> |
| 192 | </div> |
| 193 | |
| 194 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 195 | <code class="details" id="create">create(body=None, x__xgafv=None)</code> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 196 | <pre>Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 197 | |
| 198 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 199 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 200 | The object takes the form of: |
| 201 | |
| 202 | { # Represents a matter. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 203 | "description": "A String", # The description of the matter. |
| 204 | "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. |
| 205 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 206 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 207 | "role": "A String", # The user's role in this matter. |
| 208 | }, |
| 209 | ], |
| 210 | "name": "A String", # The name of the matter. |
| 211 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 212 | "state": "A String", # The state of the matter. |
| 213 | } |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 214 | |
| 215 | x__xgafv: string, V1 error format. |
| 216 | Allowed values |
| 217 | 1 - v1 error format |
| 218 | 2 - v2 error format |
| 219 | |
| 220 | Returns: |
| 221 | An object of the form: |
| 222 | |
| 223 | { # Represents a matter. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 224 | "description": "A String", # The description of the matter. |
| 225 | "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. |
| 226 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 227 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 228 | "role": "A String", # The user's role in this matter. |
| 229 | }, |
| 230 | ], |
| 231 | "name": "A String", # The name of the matter. |
| 232 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 233 | "state": "A String", # The state of the matter. |
| 234 | }</pre> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 235 | </div> |
| 236 | |
| 237 | <div class="method"> |
| 238 | <code class="details" id="delete">delete(matterId, x__xgafv=None)</code> |
| 239 | <pre>Deletes the specified matter. Returns matter with updated state. |
| 240 | |
| 241 | Args: |
| 242 | matterId: string, The matter ID (required) |
| 243 | x__xgafv: string, V1 error format. |
| 244 | Allowed values |
| 245 | 1 - v1 error format |
| 246 | 2 - v2 error format |
| 247 | |
| 248 | Returns: |
| 249 | An object of the form: |
| 250 | |
| 251 | { # Represents a matter. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 252 | "description": "A String", # The description of the matter. |
| 253 | "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. |
| 254 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 255 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 256 | "role": "A String", # The user's role in this matter. |
| 257 | }, |
| 258 | ], |
| 259 | "name": "A String", # The name of the matter. |
| 260 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 261 | "state": "A String", # The state of the matter. |
| 262 | }</pre> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 263 | </div> |
| 264 | |
| 265 | <div class="method"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 266 | <code class="details" id="get">get(matterId, view=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 267 | <pre>Gets the specified matter. |
| 268 | |
| 269 | Args: |
| 270 | matterId: string, The matter ID. (required) |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 271 | view: string, Specifies which parts of the Matter to return in the response. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 272 | Allowed values |
| 273 | VIEW_UNSPECIFIED - There is no specified view. |
| 274 | BASIC - Response includes the matter_id, name, description, and state. Default choice. |
| 275 | FULL - Full representation of matter is returned. Everything above and including MatterPermissions list. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 276 | x__xgafv: string, V1 error format. |
| 277 | Allowed values |
| 278 | 1 - v1 error format |
| 279 | 2 - v2 error format |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 280 | |
| 281 | Returns: |
| 282 | An object of the form: |
| 283 | |
| 284 | { # Represents a matter. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 285 | "description": "A String", # The description of the matter. |
| 286 | "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. |
| 287 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 288 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 289 | "role": "A String", # The user's role in this matter. |
| 290 | }, |
| 291 | ], |
| 292 | "name": "A String", # The name of the matter. |
| 293 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 294 | "state": "A String", # The state of the matter. |
| 295 | }</pre> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 296 | </div> |
| 297 | |
| 298 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 299 | <code class="details" id="list">list(view=None, pageToken=None, pageSize=None, state=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 300 | <pre>Lists matters the user has access to. |
| 301 | |
| 302 | Args: |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 303 | view: string, Specifies which parts of the matter to return in response. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 304 | Allowed values |
| 305 | VIEW_UNSPECIFIED - There is no specified view. |
| 306 | BASIC - Response includes the matter_id, name, description, and state. Default choice. |
| 307 | FULL - Full representation of matter is returned. Everything above and including MatterPermissions list. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 308 | pageToken: string, The pagination token as returned in the response. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 309 | pageSize: integer, The number of matters to return in the response. Default and maximum are 100. |
| 310 | state: string, If set, list only matters with that specific state. The default is listing matters of all states. |
| 311 | Allowed values |
| 312 | STATE_UNSPECIFIED - The matter has no specified state. |
| 313 | OPEN - This matter is open. |
| 314 | CLOSED - This matter is closed. |
| 315 | DELETED - This matter is deleted. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 316 | x__xgafv: string, V1 error format. |
| 317 | Allowed values |
| 318 | 1 - v1 error format |
| 319 | 2 - v2 error format |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 320 | |
| 321 | Returns: |
| 322 | An object of the form: |
| 323 | |
| 324 | { # Provides the list of matters. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 325 | "nextPageToken": "A String", # Page token to retrieve the next page of results in the list. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 326 | "matters": [ # List of matters. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 327 | { # Represents a matter. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 328 | "description": "A String", # The description of the matter. |
| 329 | "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. |
| 330 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 331 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 332 | "role": "A String", # The user's role in this matter. |
| 333 | }, |
| 334 | ], |
| 335 | "name": "A String", # The name of the matter. |
| 336 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 337 | "state": "A String", # The state of the matter. |
| 338 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 339 | ], |
| 340 | }</pre> |
| 341 | </div> |
| 342 | |
| 343 | <div class="method"> |
| 344 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 345 | <pre>Retrieves the next page of results. |
| 346 | |
| 347 | Args: |
| 348 | previous_request: The request for the previous page. (required) |
| 349 | previous_response: The response from the request for the previous page. (required) |
| 350 | |
| 351 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 352 | A request object that you can call 'execute()' on to request the next |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 353 | page. Returns None if there are no more items in the collection. |
| 354 | </pre> |
| 355 | </div> |
| 356 | |
| 357 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 358 | <code class="details" id="removePermissions">removePermissions(matterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 359 | <pre>Removes an account as a matter collaborator. |
| 360 | |
| 361 | Args: |
| 362 | matterId: string, The matter ID. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 363 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 364 | The object takes the form of: |
| 365 | |
| 366 | { # Remove an account as a matter collaborator. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 367 | "accountId": "A String", # The account ID. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 368 | } |
| 369 | |
| 370 | x__xgafv: string, V1 error format. |
| 371 | Allowed values |
| 372 | 1 - v1 error format |
| 373 | 2 - v2 error format |
| 374 | |
| 375 | Returns: |
| 376 | An object of the form: |
| 377 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 378 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 379 | }</pre> |
| 380 | </div> |
| 381 | |
| 382 | <div class="method"> |
| 383 | <code class="details" id="reopen">reopen(matterId, body=None, x__xgafv=None)</code> |
| 384 | <pre>Reopens the specified matter. Returns matter with updated state. |
| 385 | |
| 386 | Args: |
| 387 | matterId: string, The matter ID. (required) |
| 388 | body: object, The request body. |
| 389 | The object takes the form of: |
| 390 | |
| 391 | { # Reopen a matter by ID. |
| 392 | } |
| 393 | |
| 394 | x__xgafv: string, V1 error format. |
| 395 | Allowed values |
| 396 | 1 - v1 error format |
| 397 | 2 - v2 error format |
| 398 | |
| 399 | Returns: |
| 400 | An object of the form: |
| 401 | |
| 402 | { # Response to a ReopenMatterRequest. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 403 | "matter": { # Represents a matter. # The updated matter, with state OPEN. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 404 | "description": "A String", # The description of the matter. |
| 405 | "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. |
| 406 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 407 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 408 | "role": "A String", # The user's role in this matter. |
| 409 | }, |
| 410 | ], |
| 411 | "name": "A String", # The name of the matter. |
| 412 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 413 | "state": "A String", # The state of the matter. |
| 414 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 415 | }</pre> |
| 416 | </div> |
| 417 | |
| 418 | <div class="method"> |
| 419 | <code class="details" id="undelete">undelete(matterId, body=None, x__xgafv=None)</code> |
| 420 | <pre>Undeletes the specified matter. Returns matter with updated state. |
| 421 | |
| 422 | Args: |
| 423 | matterId: string, The matter ID. (required) |
| 424 | body: object, The request body. |
| 425 | The object takes the form of: |
| 426 | |
| 427 | { # Undelete a matter by ID. |
| 428 | } |
| 429 | |
| 430 | x__xgafv: string, V1 error format. |
| 431 | Allowed values |
| 432 | 1 - v1 error format |
| 433 | 2 - v2 error format |
| 434 | |
| 435 | Returns: |
| 436 | An object of the form: |
| 437 | |
| 438 | { # Represents a matter. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 439 | "description": "A String", # The description of the matter. |
| 440 | "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. |
| 441 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 442 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 443 | "role": "A String", # The user's role in this matter. |
| 444 | }, |
| 445 | ], |
| 446 | "name": "A String", # The name of the matter. |
| 447 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 448 | "state": "A String", # The state of the matter. |
| 449 | }</pre> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 450 | </div> |
| 451 | |
| 452 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 453 | <code class="details" id="update">update(matterId, body=None, x__xgafv=None)</code> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 454 | <pre>Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 455 | |
| 456 | Args: |
| 457 | matterId: string, The matter ID. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 458 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 459 | The object takes the form of: |
| 460 | |
| 461 | { # Represents a matter. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 462 | "description": "A String", # The description of the matter. |
| 463 | "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. |
| 464 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 465 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 466 | "role": "A String", # The user's role in this matter. |
| 467 | }, |
| 468 | ], |
| 469 | "name": "A String", # The name of the matter. |
| 470 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 471 | "state": "A String", # The state of the matter. |
| 472 | } |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 473 | |
| 474 | x__xgafv: string, V1 error format. |
| 475 | Allowed values |
| 476 | 1 - v1 error format |
| 477 | 2 - v2 error format |
| 478 | |
| 479 | Returns: |
| 480 | An object of the form: |
| 481 | |
| 482 | { # Represents a matter. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 483 | "description": "A String", # The description of the matter. |
| 484 | "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. |
| 485 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 486 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 487 | "role": "A String", # The user's role in this matter. |
| 488 | }, |
| 489 | ], |
| 490 | "name": "A String", # The name of the matter. |
| 491 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 492 | "state": "A String", # The state of the matter. |
| 493 | }</pre> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 494 | </div> |
| 495 | |
| 496 | </body></html> |