| 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"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 99 | <code><a href="#count">count(matterId, body=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics.</p> |
| 101 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <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] | 103 | <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] | 104 | <p class="toc_element"> |
| 105 | <code><a href="#delete">delete(matterId, x__xgafv=None)</a></code></p> |
| 106 | <p class="firstline">Deletes the specified matter. Returns matter with updated state.</p> |
| 107 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 108 | <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] | 109 | <p class="firstline">Gets the specified matter.</p> |
| 110 | <p class="toc_element"> |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 111 | <code><a href="#list">list(pageToken=None, view=None, pageSize=None, state=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 112 | <p class="firstline">Lists matters the user has access to.</p> |
| 113 | <p class="toc_element"> |
| 114 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 115 | <p class="firstline">Retrieves the next page of results.</p> |
| 116 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 117 | <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] | 118 | <p class="firstline">Removes an account as a matter collaborator.</p> |
| 119 | <p class="toc_element"> |
| 120 | <code><a href="#reopen">reopen(matterId, body=None, x__xgafv=None)</a></code></p> |
| 121 | <p class="firstline">Reopens the specified matter. Returns matter with updated state.</p> |
| 122 | <p class="toc_element"> |
| 123 | <code><a href="#undelete">undelete(matterId, body=None, x__xgafv=None)</a></code></p> |
| 124 | <p class="firstline">Undeletes the specified matter. Returns matter with updated state.</p> |
| 125 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 126 | <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] | 127 | <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] | 128 | <h3>Method Details</h3> |
| 129 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 130 | <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] | 131 | <pre>Adds an account as a matter collaborator. |
| 132 | |
| 133 | Args: |
| 134 | matterId: string, The matter ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 135 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 136 | The object takes the form of: |
| 137 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 138 | { # 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. |
| 139 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 140 | "role": "A String", # The user's role in this matter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 141 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 142 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 143 | "ccMe": True or False, # Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor. |
| 144 | "sendEmails": True or False, # True to send notification email to the added account. False to not send notification email. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 145 | } |
| 146 | |
| 147 | x__xgafv: string, V1 error format. |
| 148 | Allowed values |
| 149 | 1 - v1 error format |
| 150 | 2 - v2 error format |
| 151 | |
| 152 | Returns: |
| 153 | An object of the form: |
| 154 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 155 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 156 | "role": "A String", # The user's role in this matter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 157 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 158 | }</pre> |
| 159 | </div> |
| 160 | |
| 161 | <div class="method"> |
| 162 | <code class="details" id="close">close(matterId, body=None, x__xgafv=None)</code> |
| 163 | <pre>Closes the specified matter. Returns matter with updated state. |
| 164 | |
| 165 | Args: |
| 166 | matterId: string, The matter ID. (required) |
| 167 | body: object, The request body. |
| 168 | The object takes the form of: |
| 169 | |
| 170 | { # Close a matter by ID. |
| 171 | } |
| 172 | |
| 173 | x__xgafv: string, V1 error format. |
| 174 | Allowed values |
| 175 | 1 - v1 error format |
| 176 | 2 - v2 error format |
| 177 | |
| 178 | Returns: |
| 179 | An object of the form: |
| 180 | |
| 181 | { # Response to a CloseMatterRequest. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 182 | "matter": { # Represents a matter. # The updated matter, with state CLOSED. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 183 | "description": "A String", # The description of the matter. |
| 184 | "name": "A String", # The name of the matter. |
| 185 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 186 | "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. |
| 187 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 188 | "role": "A String", # The user's role in this matter. |
| 189 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 190 | }, |
| 191 | ], |
| 192 | "state": "A String", # The state of the matter. |
| 193 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 194 | }</pre> |
| 195 | </div> |
| 196 | |
| 197 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 198 | <code class="details" id="count">count(matterId, body=None, x__xgafv=None)</code> |
| 199 | <pre>Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics. |
| 200 | |
| 201 | Args: |
| 202 | matterId: string, The matter ID. (required) |
| 203 | body: object, The request body. |
| 204 | The object takes the form of: |
| 205 | |
| 206 | { # Count artifacts request. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 207 | "query": { # A query definition relevant for search & export. # The search query. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 208 | "method": "A String", # The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only. |
| 209 | "voiceOptions": { # Voice search options # For voice search, specify more options in this field. |
| 210 | "coveredData": [ # Datatypes to search |
| 211 | "A String", |
| 212 | ], |
| 213 | }, |
| 214 | "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified. |
| 215 | "teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API. |
| 216 | "A String", |
| 217 | ], |
| 218 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 219 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 220 | "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified. |
| 221 | "sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API. |
| 222 | "A String", |
| 223 | ], |
| 224 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 225 | "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field. |
| 226 | "versionDate": "A String", # Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date. |
| 227 | "includeTeamDrives": True or False, # Set to true to include Team Drive. |
| 228 | "includeSharedDrives": True or False, # Set to true to include shared drive. |
| 229 | }, |
| 230 | "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 231 | "terms": "A String", # The corpus-specific search operators used to generate search results. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 232 | "corpus": "A String", # The corpus to search. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 233 | "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only) |
| 234 | "roomId": [ # A set of rooms to search. |
| 235 | "A String", |
| 236 | ], |
| 237 | }, |
| 238 | "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified. |
| 239 | "emails": [ # A set of accounts to search. |
| 240 | "A String", |
| 241 | ], |
| 242 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 243 | "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified. |
| 244 | "orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 245 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 246 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. |
| 247 | "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field. |
| 248 | "excludeDrafts": True or False, # Set to true to exclude drafts. |
| 249 | }, |
| 250 | "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only) |
| 251 | "includeRooms": True or False, # Set to true to include rooms. |
| 252 | }, |
| 253 | "dataScope": "A String", # The data source to search from. |
| 254 | "searchMethod": "A String", # The search method to use. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 255 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 256 | "view": "A String", # Specifies the granularity of the count result returned in response. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 257 | } |
| 258 | |
| 259 | x__xgafv: string, V1 error format. |
| 260 | Allowed values |
| 261 | 1 - v1 error format |
| 262 | 2 - v2 error format |
| 263 | |
| 264 | Returns: |
| 265 | An object of the form: |
| 266 | |
| 267 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 268 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 269 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 270 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 271 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 272 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 273 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 274 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 275 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 276 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 277 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 278 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 279 | { |
| 280 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 281 | }, |
| 282 | ], |
| 283 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 284 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 285 | }</pre> |
| 286 | </div> |
| 287 | |
| 288 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 289 | <code class="details" id="create">create(body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 290 | <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] | 291 | |
| 292 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 293 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 294 | The object takes the form of: |
| 295 | |
| 296 | { # Represents a matter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 297 | "description": "A String", # The description of the matter. |
| 298 | "name": "A String", # The name of the matter. |
| 299 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 300 | "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. |
| 301 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 302 | "role": "A String", # The user's role in this matter. |
| 303 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 304 | }, |
| 305 | ], |
| 306 | "state": "A String", # The state of the matter. |
| 307 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 308 | |
| 309 | x__xgafv: string, V1 error format. |
| 310 | Allowed values |
| 311 | 1 - v1 error format |
| 312 | 2 - v2 error format |
| 313 | |
| 314 | Returns: |
| 315 | An object of the form: |
| 316 | |
| 317 | { # Represents a matter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 318 | "description": "A String", # The description of the matter. |
| 319 | "name": "A String", # The name of the matter. |
| 320 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 321 | "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. |
| 322 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 323 | "role": "A String", # The user's role in this matter. |
| 324 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 325 | }, |
| 326 | ], |
| 327 | "state": "A String", # The state of the matter. |
| 328 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 329 | </div> |
| 330 | |
| 331 | <div class="method"> |
| 332 | <code class="details" id="delete">delete(matterId, x__xgafv=None)</code> |
| 333 | <pre>Deletes the specified matter. Returns matter with updated state. |
| 334 | |
| 335 | Args: |
| 336 | matterId: string, The matter ID (required) |
| 337 | x__xgafv: string, V1 error format. |
| 338 | Allowed values |
| 339 | 1 - v1 error format |
| 340 | 2 - v2 error format |
| 341 | |
| 342 | Returns: |
| 343 | An object of the form: |
| 344 | |
| 345 | { # Represents a matter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 346 | "description": "A String", # The description of the matter. |
| 347 | "name": "A String", # The name of the matter. |
| 348 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 349 | "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. |
| 350 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 351 | "role": "A String", # The user's role in this matter. |
| 352 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 353 | }, |
| 354 | ], |
| 355 | "state": "A String", # The state of the matter. |
| 356 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 357 | </div> |
| 358 | |
| 359 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 360 | <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] | 361 | <pre>Gets the specified matter. |
| 362 | |
| 363 | Args: |
| 364 | matterId: string, The matter ID. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 365 | 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] | 366 | Allowed values |
| 367 | VIEW_UNSPECIFIED - There is no specified view. |
| 368 | BASIC - Response includes the matter_id, name, description, and state. Default choice. |
| 369 | 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] | 370 | x__xgafv: string, V1 error format. |
| 371 | Allowed values |
| 372 | 1 - v1 error format |
| 373 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 374 | |
| 375 | Returns: |
| 376 | An object of the form: |
| 377 | |
| 378 | { # Represents a matter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 379 | "description": "A String", # The description of the matter. |
| 380 | "name": "A String", # The name of the matter. |
| 381 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 382 | "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. |
| 383 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 384 | "role": "A String", # The user's role in this matter. |
| 385 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 386 | }, |
| 387 | ], |
| 388 | "state": "A String", # The state of the matter. |
| 389 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 390 | </div> |
| 391 | |
| 392 | <div class="method"> |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 393 | <code class="details" id="list">list(pageToken=None, view=None, pageSize=None, state=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 394 | <pre>Lists matters the user has access to. |
| 395 | |
| 396 | Args: |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 397 | pageToken: string, The pagination token as returned in the response. |
| 398 | view: string, Specifies which parts of the matter to return in response. |
| 399 | Allowed values |
| 400 | VIEW_UNSPECIFIED - There is no specified view. |
| 401 | BASIC - Response includes the matter_id, name, description, and state. Default choice. |
| 402 | FULL - Full representation of matter is returned. Everything above and including MatterPermissions list. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 403 | pageSize: integer, The number of matters to return in the response. Default and maximum are 100. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 404 | state: string, If set, list only matters with that specific state. The default is listing matters of all states. |
| 405 | Allowed values |
| 406 | STATE_UNSPECIFIED - The matter has no specified state. |
| 407 | OPEN - This matter is open. |
| 408 | CLOSED - This matter is closed. |
| 409 | DELETED - This matter is deleted. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 410 | x__xgafv: string, V1 error format. |
| 411 | Allowed values |
| 412 | 1 - v1 error format |
| 413 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 414 | |
| 415 | Returns: |
| 416 | An object of the form: |
| 417 | |
| 418 | { # Provides the list of matters. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 419 | "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] | 420 | "matters": [ # List of matters. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 421 | { # Represents a matter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 422 | "description": "A String", # The description of the matter. |
| 423 | "name": "A String", # The name of the matter. |
| 424 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 425 | "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. |
| 426 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 427 | "role": "A String", # The user's role in this matter. |
| 428 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 429 | }, |
| 430 | ], |
| 431 | "state": "A String", # The state of the matter. |
| 432 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 433 | ], |
| 434 | }</pre> |
| 435 | </div> |
| 436 | |
| 437 | <div class="method"> |
| 438 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 439 | <pre>Retrieves the next page of results. |
| 440 | |
| 441 | Args: |
| 442 | previous_request: The request for the previous page. (required) |
| 443 | previous_response: The response from the request for the previous page. (required) |
| 444 | |
| 445 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 446 | 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] | 447 | page. Returns None if there are no more items in the collection. |
| 448 | </pre> |
| 449 | </div> |
| 450 | |
| 451 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 452 | <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] | 453 | <pre>Removes an account as a matter collaborator. |
| 454 | |
| 455 | Args: |
| 456 | matterId: string, The matter ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 457 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 458 | The object takes the form of: |
| 459 | |
| 460 | { # Remove an account as a matter collaborator. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 461 | "accountId": "A String", # The account ID. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 462 | } |
| 463 | |
| 464 | x__xgafv: string, V1 error format. |
| 465 | Allowed values |
| 466 | 1 - v1 error format |
| 467 | 2 - v2 error format |
| 468 | |
| 469 | Returns: |
| 470 | An object of the form: |
| 471 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 472 | { # 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] | 473 | }</pre> |
| 474 | </div> |
| 475 | |
| 476 | <div class="method"> |
| 477 | <code class="details" id="reopen">reopen(matterId, body=None, x__xgafv=None)</code> |
| 478 | <pre>Reopens the specified matter. Returns matter with updated state. |
| 479 | |
| 480 | Args: |
| 481 | matterId: string, The matter ID. (required) |
| 482 | body: object, The request body. |
| 483 | The object takes the form of: |
| 484 | |
| 485 | { # Reopen a matter by ID. |
| 486 | } |
| 487 | |
| 488 | x__xgafv: string, V1 error format. |
| 489 | Allowed values |
| 490 | 1 - v1 error format |
| 491 | 2 - v2 error format |
| 492 | |
| 493 | Returns: |
| 494 | An object of the form: |
| 495 | |
| 496 | { # Response to a ReopenMatterRequest. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 497 | "matter": { # Represents a matter. # The updated matter, with state OPEN. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 498 | "description": "A String", # The description of the matter. |
| 499 | "name": "A String", # The name of the matter. |
| 500 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 501 | "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. |
| 502 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 503 | "role": "A String", # The user's role in this matter. |
| 504 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 505 | }, |
| 506 | ], |
| 507 | "state": "A String", # The state of the matter. |
| 508 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 509 | }</pre> |
| 510 | </div> |
| 511 | |
| 512 | <div class="method"> |
| 513 | <code class="details" id="undelete">undelete(matterId, body=None, x__xgafv=None)</code> |
| 514 | <pre>Undeletes the specified matter. Returns matter with updated state. |
| 515 | |
| 516 | Args: |
| 517 | matterId: string, The matter ID. (required) |
| 518 | body: object, The request body. |
| 519 | The object takes the form of: |
| 520 | |
| 521 | { # Undelete a matter by ID. |
| 522 | } |
| 523 | |
| 524 | x__xgafv: string, V1 error format. |
| 525 | Allowed values |
| 526 | 1 - v1 error format |
| 527 | 2 - v2 error format |
| 528 | |
| 529 | Returns: |
| 530 | An object of the form: |
| 531 | |
| 532 | { # Represents a matter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 533 | "description": "A String", # The description of the matter. |
| 534 | "name": "A String", # The name of the matter. |
| 535 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 536 | "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. |
| 537 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 538 | "role": "A String", # The user's role in this matter. |
| 539 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 540 | }, |
| 541 | ], |
| 542 | "state": "A String", # The state of the matter. |
| 543 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 544 | </div> |
| 545 | |
| 546 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 547 | <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] | 548 | <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] | 549 | |
| 550 | Args: |
| 551 | matterId: string, The matter ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 552 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 553 | The object takes the form of: |
| 554 | |
| 555 | { # Represents a matter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 556 | "description": "A String", # The description of the matter. |
| 557 | "name": "A String", # The name of the matter. |
| 558 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 559 | "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. |
| 560 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 561 | "role": "A String", # The user's role in this matter. |
| 562 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 563 | }, |
| 564 | ], |
| 565 | "state": "A String", # The state of the matter. |
| 566 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 567 | |
| 568 | x__xgafv: string, V1 error format. |
| 569 | Allowed values |
| 570 | 1 - v1 error format |
| 571 | 2 - v2 error format |
| 572 | |
| 573 | Returns: |
| 574 | An object of the form: |
| 575 | |
| 576 | { # Represents a matter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 577 | "description": "A String", # The description of the matter. |
| 578 | "name": "A String", # The name of the matter. |
| 579 | "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter. |
| 580 | "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. |
| 581 | { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. |
| 582 | "role": "A String", # The user's role in this matter. |
| 583 | "accountId": "A String", # The account ID, as provided by Admin SDK. |
| 584 | }, |
| 585 | ], |
| 586 | "state": "A String", # The state of the matter. |
| 587 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 588 | </div> |
| 589 | |
| 590 | </body></html> |