source: vendor/google/apiclient-services/src/Vault.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 7 days ago

Upload project files
  • Property mode set to 100644
File size: 18.6 KB
Line 
1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service;
19
20use Google\Client;
21
22/**
23 * Service definition for Vault (v1).
24 *
25 * <p>
26 * Retention and eDiscovery for Google Workspace. To work with Vault resources,
27 * the account must have the [required Vault
28 * privileges](https://support.google.com/vault/answer/2799699) and access to
29 * the matter. To access a matter, the account must have created the matter,
30 * have the matter shared with them, or have the **View All Matters** privilege.
31 * For example, to download an export, an account needs the **Manage Exports**
32 * privilege and the matter shared with them.</p>
33 *
34 * <p>
35 * For more information about this service, see the API
36 * <a href="https://developers.google.com/vault" target="_blank">Documentation</a>
37 * </p>
38 *
39 * @author Google, Inc.
40 */
41class Vault extends \Google\Service
42{
43 /** Manage your eDiscovery data. */
44 const EDISCOVERY =
45 "https://www.googleapis.com/auth/ediscovery";
46 /** View your eDiscovery data. */
47 const EDISCOVERY_READONLY =
48 "https://www.googleapis.com/auth/ediscovery.readonly";
49
50 public $matters;
51 public $matters_exports;
52 public $matters_holds;
53 public $matters_holds_accounts;
54 public $matters_savedQueries;
55 public $operations;
56 public $rootUrlTemplate;
57
58 /**
59 * Constructs the internal representation of the Vault service.
60 *
61 * @param Client|array $clientOrConfig The client used to deliver requests, or a
62 * config array to pass to a new Client instance.
63 * @param string $rootUrl The root URL used for requests to the service.
64 */
65 public function __construct($clientOrConfig = [], $rootUrl = null)
66 {
67 parent::__construct($clientOrConfig);
68 $this->rootUrl = $rootUrl ?: 'https://vault.googleapis.com/';
69 $this->rootUrlTemplate = $rootUrl ?: 'https://vault.UNIVERSE_DOMAIN/';
70 $this->servicePath = '';
71 $this->batchPath = 'batch';
72 $this->version = 'v1';
73 $this->serviceName = 'vault';
74
75 $this->matters = new Vault\Resource\Matters(
76 $this,
77 $this->serviceName,
78 'matters',
79 [
80 'methods' => [
81 'addPermissions' => [
82 'path' => 'v1/matters/{matterId}:addPermissions',
83 'httpMethod' => 'POST',
84 'parameters' => [
85 'matterId' => [
86 'location' => 'path',
87 'type' => 'string',
88 'required' => true,
89 ],
90 ],
91 ],'close' => [
92 'path' => 'v1/matters/{matterId}:close',
93 'httpMethod' => 'POST',
94 'parameters' => [
95 'matterId' => [
96 'location' => 'path',
97 'type' => 'string',
98 'required' => true,
99 ],
100 ],
101 ],'count' => [
102 'path' => 'v1/matters/{matterId}:count',
103 'httpMethod' => 'POST',
104 'parameters' => [
105 'matterId' => [
106 'location' => 'path',
107 'type' => 'string',
108 'required' => true,
109 ],
110 ],
111 ],'create' => [
112 'path' => 'v1/matters',
113 'httpMethod' => 'POST',
114 'parameters' => [],
115 ],'delete' => [
116 'path' => 'v1/matters/{matterId}',
117 'httpMethod' => 'DELETE',
118 'parameters' => [
119 'matterId' => [
120 'location' => 'path',
121 'type' => 'string',
122 'required' => true,
123 ],
124 ],
125 ],'get' => [
126 'path' => 'v1/matters/{matterId}',
127 'httpMethod' => 'GET',
128 'parameters' => [
129 'matterId' => [
130 'location' => 'path',
131 'type' => 'string',
132 'required' => true,
133 ],
134 'view' => [
135 'location' => 'query',
136 'type' => 'string',
137 ],
138 ],
139 ],'list' => [
140 'path' => 'v1/matters',
141 'httpMethod' => 'GET',
142 'parameters' => [
143 'pageSize' => [
144 'location' => 'query',
145 'type' => 'integer',
146 ],
147 'pageToken' => [
148 'location' => 'query',
149 'type' => 'string',
150 ],
151 'state' => [
152 'location' => 'query',
153 'type' => 'string',
154 ],
155 'view' => [
156 'location' => 'query',
157 'type' => 'string',
158 ],
159 ],
160 ],'removePermissions' => [
161 'path' => 'v1/matters/{matterId}:removePermissions',
162 'httpMethod' => 'POST',
163 'parameters' => [
164 'matterId' => [
165 'location' => 'path',
166 'type' => 'string',
167 'required' => true,
168 ],
169 ],
170 ],'reopen' => [
171 'path' => 'v1/matters/{matterId}:reopen',
172 'httpMethod' => 'POST',
173 'parameters' => [
174 'matterId' => [
175 'location' => 'path',
176 'type' => 'string',
177 'required' => true,
178 ],
179 ],
180 ],'undelete' => [
181 'path' => 'v1/matters/{matterId}:undelete',
182 'httpMethod' => 'POST',
183 'parameters' => [
184 'matterId' => [
185 'location' => 'path',
186 'type' => 'string',
187 'required' => true,
188 ],
189 ],
190 ],'update' => [
191 'path' => 'v1/matters/{matterId}',
192 'httpMethod' => 'PUT',
193 'parameters' => [
194 'matterId' => [
195 'location' => 'path',
196 'type' => 'string',
197 'required' => true,
198 ],
199 ],
200 ],
201 ]
202 ]
203 );
204 $this->matters_exports = new Vault\Resource\MattersExports(
205 $this,
206 $this->serviceName,
207 'exports',
208 [
209 'methods' => [
210 'create' => [
211 'path' => 'v1/matters/{matterId}/exports',
212 'httpMethod' => 'POST',
213 'parameters' => [
214 'matterId' => [
215 'location' => 'path',
216 'type' => 'string',
217 'required' => true,
218 ],
219 ],
220 ],'delete' => [
221 'path' => 'v1/matters/{matterId}/exports/{exportId}',
222 'httpMethod' => 'DELETE',
223 'parameters' => [
224 'matterId' => [
225 'location' => 'path',
226 'type' => 'string',
227 'required' => true,
228 ],
229 'exportId' => [
230 'location' => 'path',
231 'type' => 'string',
232 'required' => true,
233 ],
234 ],
235 ],'get' => [
236 'path' => 'v1/matters/{matterId}/exports/{exportId}',
237 'httpMethod' => 'GET',
238 'parameters' => [
239 'matterId' => [
240 'location' => 'path',
241 'type' => 'string',
242 'required' => true,
243 ],
244 'exportId' => [
245 'location' => 'path',
246 'type' => 'string',
247 'required' => true,
248 ],
249 ],
250 ],'list' => [
251 'path' => 'v1/matters/{matterId}/exports',
252 'httpMethod' => 'GET',
253 'parameters' => [
254 'matterId' => [
255 'location' => 'path',
256 'type' => 'string',
257 'required' => true,
258 ],
259 'pageSize' => [
260 'location' => 'query',
261 'type' => 'integer',
262 ],
263 'pageToken' => [
264 'location' => 'query',
265 'type' => 'string',
266 ],
267 ],
268 ],
269 ]
270 ]
271 );
272 $this->matters_holds = new Vault\Resource\MattersHolds(
273 $this,
274 $this->serviceName,
275 'holds',
276 [
277 'methods' => [
278 'addHeldAccounts' => [
279 'path' => 'v1/matters/{matterId}/holds/{holdId}:addHeldAccounts',
280 'httpMethod' => 'POST',
281 'parameters' => [
282 'matterId' => [
283 'location' => 'path',
284 'type' => 'string',
285 'required' => true,
286 ],
287 'holdId' => [
288 'location' => 'path',
289 'type' => 'string',
290 'required' => true,
291 ],
292 ],
293 ],'create' => [
294 'path' => 'v1/matters/{matterId}/holds',
295 'httpMethod' => 'POST',
296 'parameters' => [
297 'matterId' => [
298 'location' => 'path',
299 'type' => 'string',
300 'required' => true,
301 ],
302 ],
303 ],'delete' => [
304 'path' => 'v1/matters/{matterId}/holds/{holdId}',
305 'httpMethod' => 'DELETE',
306 'parameters' => [
307 'matterId' => [
308 'location' => 'path',
309 'type' => 'string',
310 'required' => true,
311 ],
312 'holdId' => [
313 'location' => 'path',
314 'type' => 'string',
315 'required' => true,
316 ],
317 ],
318 ],'get' => [
319 'path' => 'v1/matters/{matterId}/holds/{holdId}',
320 'httpMethod' => 'GET',
321 'parameters' => [
322 'matterId' => [
323 'location' => 'path',
324 'type' => 'string',
325 'required' => true,
326 ],
327 'holdId' => [
328 'location' => 'path',
329 'type' => 'string',
330 'required' => true,
331 ],
332 'view' => [
333 'location' => 'query',
334 'type' => 'string',
335 ],
336 ],
337 ],'list' => [
338 'path' => 'v1/matters/{matterId}/holds',
339 'httpMethod' => 'GET',
340 'parameters' => [
341 'matterId' => [
342 'location' => 'path',
343 'type' => 'string',
344 'required' => true,
345 ],
346 'pageSize' => [
347 'location' => 'query',
348 'type' => 'integer',
349 ],
350 'pageToken' => [
351 'location' => 'query',
352 'type' => 'string',
353 ],
354 'view' => [
355 'location' => 'query',
356 'type' => 'string',
357 ],
358 ],
359 ],'removeHeldAccounts' => [
360 'path' => 'v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts',
361 'httpMethod' => 'POST',
362 'parameters' => [
363 'matterId' => [
364 'location' => 'path',
365 'type' => 'string',
366 'required' => true,
367 ],
368 'holdId' => [
369 'location' => 'path',
370 'type' => 'string',
371 'required' => true,
372 ],
373 ],
374 ],'update' => [
375 'path' => 'v1/matters/{matterId}/holds/{holdId}',
376 'httpMethod' => 'PUT',
377 'parameters' => [
378 'matterId' => [
379 'location' => 'path',
380 'type' => 'string',
381 'required' => true,
382 ],
383 'holdId' => [
384 'location' => 'path',
385 'type' => 'string',
386 'required' => true,
387 ],
388 ],
389 ],
390 ]
391 ]
392 );
393 $this->matters_holds_accounts = new Vault\Resource\MattersHoldsAccounts(
394 $this,
395 $this->serviceName,
396 'accounts',
397 [
398 'methods' => [
399 'create' => [
400 'path' => 'v1/matters/{matterId}/holds/{holdId}/accounts',
401 'httpMethod' => 'POST',
402 'parameters' => [
403 'matterId' => [
404 'location' => 'path',
405 'type' => 'string',
406 'required' => true,
407 ],
408 'holdId' => [
409 'location' => 'path',
410 'type' => 'string',
411 'required' => true,
412 ],
413 ],
414 ],'delete' => [
415 'path' => 'v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}',
416 'httpMethod' => 'DELETE',
417 'parameters' => [
418 'matterId' => [
419 'location' => 'path',
420 'type' => 'string',
421 'required' => true,
422 ],
423 'holdId' => [
424 'location' => 'path',
425 'type' => 'string',
426 'required' => true,
427 ],
428 'accountId' => [
429 'location' => 'path',
430 'type' => 'string',
431 'required' => true,
432 ],
433 ],
434 ],'list' => [
435 'path' => 'v1/matters/{matterId}/holds/{holdId}/accounts',
436 'httpMethod' => 'GET',
437 'parameters' => [
438 'matterId' => [
439 'location' => 'path',
440 'type' => 'string',
441 'required' => true,
442 ],
443 'holdId' => [
444 'location' => 'path',
445 'type' => 'string',
446 'required' => true,
447 ],
448 ],
449 ],
450 ]
451 ]
452 );
453 $this->matters_savedQueries = new Vault\Resource\MattersSavedQueries(
454 $this,
455 $this->serviceName,
456 'savedQueries',
457 [
458 'methods' => [
459 'create' => [
460 'path' => 'v1/matters/{matterId}/savedQueries',
461 'httpMethod' => 'POST',
462 'parameters' => [
463 'matterId' => [
464 'location' => 'path',
465 'type' => 'string',
466 'required' => true,
467 ],
468 ],
469 ],'delete' => [
470 'path' => 'v1/matters/{matterId}/savedQueries/{savedQueryId}',
471 'httpMethod' => 'DELETE',
472 'parameters' => [
473 'matterId' => [
474 'location' => 'path',
475 'type' => 'string',
476 'required' => true,
477 ],
478 'savedQueryId' => [
479 'location' => 'path',
480 'type' => 'string',
481 'required' => true,
482 ],
483 ],
484 ],'get' => [
485 'path' => 'v1/matters/{matterId}/savedQueries/{savedQueryId}',
486 'httpMethod' => 'GET',
487 'parameters' => [
488 'matterId' => [
489 'location' => 'path',
490 'type' => 'string',
491 'required' => true,
492 ],
493 'savedQueryId' => [
494 'location' => 'path',
495 'type' => 'string',
496 'required' => true,
497 ],
498 ],
499 ],'list' => [
500 'path' => 'v1/matters/{matterId}/savedQueries',
501 'httpMethod' => 'GET',
502 'parameters' => [
503 'matterId' => [
504 'location' => 'path',
505 'type' => 'string',
506 'required' => true,
507 ],
508 'pageSize' => [
509 'location' => 'query',
510 'type' => 'integer',
511 ],
512 'pageToken' => [
513 'location' => 'query',
514 'type' => 'string',
515 ],
516 ],
517 ],
518 ]
519 ]
520 );
521 $this->operations = new Vault\Resource\Operations(
522 $this,
523 $this->serviceName,
524 'operations',
525 [
526 'methods' => [
527 'cancel' => [
528 'path' => 'v1/{+name}:cancel',
529 'httpMethod' => 'POST',
530 'parameters' => [
531 'name' => [
532 'location' => 'path',
533 'type' => 'string',
534 'required' => true,
535 ],
536 ],
537 ],'delete' => [
538 'path' => 'v1/{+name}',
539 'httpMethod' => 'DELETE',
540 'parameters' => [
541 'name' => [
542 'location' => 'path',
543 'type' => 'string',
544 'required' => true,
545 ],
546 ],
547 ],'get' => [
548 'path' => 'v1/{+name}',
549 'httpMethod' => 'GET',
550 'parameters' => [
551 'name' => [
552 'location' => 'path',
553 'type' => 'string',
554 'required' => true,
555 ],
556 ],
557 ],'list' => [
558 'path' => 'v1/{+name}',
559 'httpMethod' => 'GET',
560 'parameters' => [
561 'name' => [
562 'location' => 'path',
563 'type' => 'string',
564 'required' => true,
565 ],
566 'filter' => [
567 'location' => 'query',
568 'type' => 'string',
569 ],
570 'pageSize' => [
571 'location' => 'query',
572 'type' => 'integer',
573 ],
574 'pageToken' => [
575 'location' => 'query',
576 'type' => 'string',
577 ],
578 ],
579 ],
580 ]
581 ]
582 );
583 }
584}
585
586// Adding a class alias for backwards compatibility with the previous class name.
587class_alias(Vault::class, 'Google_Service_Vault');
Note: See TracBrowser for help on using the repository browser.