source: vendor/google/apiclient-services/src/HangoutsChat.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: 23.6 KB
RevLine 
[e3d4e0a]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 HangoutsChat (v1).
24 *
25 * <p>
26 * The Google Chat API lets you build Chat apps to integrate your services with
27 * Google Chat and manage Chat resources such as spaces, members, and messages.</p>
28 *
29 * <p>
30 * For more information about this service, see the API
31 * <a href="https://developers.google.com/hangouts/chat" target="_blank">Documentation</a>
32 * </p>
33 *
34 * @author Google, Inc.
35 */
36class HangoutsChat extends \Google\Service
37{
38 /** Delete conversations and spaces owned by your organization and remove access to associated files in Google Chat. */
39 const CHAT_ADMIN_DELETE =
40 "https://www.googleapis.com/auth/chat.admin.delete";
41 /** View, add, update and remove members and managers in conversations owned by your organization. */
42 const CHAT_ADMIN_MEMBERSHIPS =
43 "https://www.googleapis.com/auth/chat.admin.memberships";
44 /** View members and managers in conversations owned by your organization. */
45 const CHAT_ADMIN_MEMBERSHIPS_READONLY =
46 "https://www.googleapis.com/auth/chat.admin.memberships.readonly";
47 /** View or edit display name, description, and other metadata for all Google Chat conversations owned by your organization. */
48 const CHAT_ADMIN_SPACES =
49 "https://www.googleapis.com/auth/chat.admin.spaces";
50 /** View display name, description, and other metadata for all Google Chat conversations owned by your organization. */
51 const CHAT_ADMIN_SPACES_READONLY =
52 "https://www.googleapis.com/auth/chat.admin.spaces.readonly";
53 /** On their own behalf, apps in Google Chat can delete conversations and spaces and remove access to associated files. */
54 const CHAT_APP_DELETE =
55 "https://www.googleapis.com/auth/chat.app.delete";
56 /** On their own behalf, apps in Google Chat can see, add, update, and remove members from conversations and spaces. */
57 const CHAT_APP_MEMBERSHIPS =
58 "https://www.googleapis.com/auth/chat.app.memberships";
59 /** On their own behalf, apps in Google Chat can create conversations and spaces and see or update their metadata (including history settings and access settings). */
60 const CHAT_APP_SPACES =
61 "https://www.googleapis.com/auth/chat.app.spaces";
62 /** On their own behalf, apps in Google Chat can create conversations and spaces. */
63 const CHAT_APP_SPACES_CREATE =
64 "https://www.googleapis.com/auth/chat.app.spaces.create";
65 /** Private Service: https://www.googleapis.com/auth/chat.bot. */
66 const CHAT_BOT =
67 "https://www.googleapis.com/auth/chat.bot";
68 /** Delete conversations and spaces and remove access to associated files in Google Chat. */
69 const CHAT_DELETE =
70 "https://www.googleapis.com/auth/chat.delete";
71 /** Import spaces, messages, and memberships into Google Chat.. */
72 const CHAT_IMPORT =
73 "https://www.googleapis.com/auth/chat.import";
74 /** See, add, update, and remove members from conversations and spaces in Google Chat. */
75 const CHAT_MEMBERSHIPS =
76 "https://www.googleapis.com/auth/chat.memberships";
77 /** Add and remove itself from conversations and spaces in Google Chat. */
78 const CHAT_MEMBERSHIPS_APP =
79 "https://www.googleapis.com/auth/chat.memberships.app";
80 /** View members in Google Chat conversations.. */
81 const CHAT_MEMBERSHIPS_READONLY =
82 "https://www.googleapis.com/auth/chat.memberships.readonly";
83 /** See, compose, send, update, and delete messages and their associated attachments, and add, see, and delete reactions to messages.. */
84 const CHAT_MESSAGES =
85 "https://www.googleapis.com/auth/chat.messages";
86 /** Compose and send messages in Google Chat. */
87 const CHAT_MESSAGES_CREATE =
88 "https://www.googleapis.com/auth/chat.messages.create";
89 /** See, add, and delete reactions to messages in Google Chat. */
90 const CHAT_MESSAGES_REACTIONS =
91 "https://www.googleapis.com/auth/chat.messages.reactions";
92 /** Add reactions to messages in Google Chat. */
93 const CHAT_MESSAGES_REACTIONS_CREATE =
94 "https://www.googleapis.com/auth/chat.messages.reactions.create";
95 /** View reactions to messages in Google Chat. */
96 const CHAT_MESSAGES_REACTIONS_READONLY =
97 "https://www.googleapis.com/auth/chat.messages.reactions.readonly";
98 /** See messages and their associated reactions and attachments in Google Chat. */
99 const CHAT_MESSAGES_READONLY =
100 "https://www.googleapis.com/auth/chat.messages.readonly";
101 /** Create conversations and spaces and see or update metadata (including history settings and access settings) in Google Chat. */
102 const CHAT_SPACES =
103 "https://www.googleapis.com/auth/chat.spaces";
104 /** Create new conversations and spaces in Google Chat. */
105 const CHAT_SPACES_CREATE =
106 "https://www.googleapis.com/auth/chat.spaces.create";
107 /** View chat and spaces in Google Chat. */
108 const CHAT_SPACES_READONLY =
109 "https://www.googleapis.com/auth/chat.spaces.readonly";
110 /** View and modify last read time for Google Chat conversations. */
111 const CHAT_USERS_READSTATE =
112 "https://www.googleapis.com/auth/chat.users.readstate";
113 /** View last read time for Google Chat conversations. */
114 const CHAT_USERS_READSTATE_READONLY =
115 "https://www.googleapis.com/auth/chat.users.readstate.readonly";
116
117 public $media;
118 public $spaces;
119 public $spaces_members;
120 public $spaces_messages;
121 public $spaces_messages_attachments;
122 public $spaces_messages_reactions;
123 public $spaces_spaceEvents;
124 public $users_spaces;
125 public $users_spaces_threads;
126 public $rootUrlTemplate;
127
128 /**
129 * Constructs the internal representation of the HangoutsChat service.
130 *
131 * @param Client|array $clientOrConfig The client used to deliver requests, or a
132 * config array to pass to a new Client instance.
133 * @param string $rootUrl The root URL used for requests to the service.
134 */
135 public function __construct($clientOrConfig = [], $rootUrl = null)
136 {
137 parent::__construct($clientOrConfig);
138 $this->rootUrl = $rootUrl ?: 'https://chat.googleapis.com/';
139 $this->rootUrlTemplate = $rootUrl ?: 'https://chat.UNIVERSE_DOMAIN/';
140 $this->servicePath = '';
141 $this->batchPath = 'batch';
142 $this->version = 'v1';
143 $this->serviceName = 'chat';
144
145 $this->media = new HangoutsChat\Resource\Media(
146 $this,
147 $this->serviceName,
148 'media',
149 [
150 'methods' => [
151 'download' => [
152 'path' => 'v1/media/{+resourceName}',
153 'httpMethod' => 'GET',
154 'parameters' => [
155 'resourceName' => [
156 'location' => 'path',
157 'type' => 'string',
158 'required' => true,
159 ],
160 ],
161 ],'upload' => [
162 'path' => 'v1/{+parent}/attachments:upload',
163 'httpMethod' => 'POST',
164 'parameters' => [
165 'parent' => [
166 'location' => 'path',
167 'type' => 'string',
168 'required' => true,
169 ],
170 ],
171 ],
172 ]
173 ]
174 );
175 $this->spaces = new HangoutsChat\Resource\Spaces(
176 $this,
177 $this->serviceName,
178 'spaces',
179 [
180 'methods' => [
181 'completeImport' => [
182 'path' => 'v1/{+name}:completeImport',
183 'httpMethod' => 'POST',
184 'parameters' => [
185 'name' => [
186 'location' => 'path',
187 'type' => 'string',
188 'required' => true,
189 ],
190 ],
191 ],'create' => [
192 'path' => 'v1/spaces',
193 'httpMethod' => 'POST',
194 'parameters' => [
195 'requestId' => [
196 'location' => 'query',
197 'type' => 'string',
198 ],
199 ],
200 ],'delete' => [
201 'path' => 'v1/{+name}',
202 'httpMethod' => 'DELETE',
203 'parameters' => [
204 'name' => [
205 'location' => 'path',
206 'type' => 'string',
207 'required' => true,
208 ],
209 'useAdminAccess' => [
210 'location' => 'query',
211 'type' => 'boolean',
212 ],
213 ],
214 ],'findDirectMessage' => [
215 'path' => 'v1/spaces:findDirectMessage',
216 'httpMethod' => 'GET',
217 'parameters' => [
218 'name' => [
219 'location' => 'query',
220 'type' => 'string',
221 ],
222 ],
223 ],'get' => [
224 'path' => 'v1/{+name}',
225 'httpMethod' => 'GET',
226 'parameters' => [
227 'name' => [
228 'location' => 'path',
229 'type' => 'string',
230 'required' => true,
231 ],
232 'useAdminAccess' => [
233 'location' => 'query',
234 'type' => 'boolean',
235 ],
236 ],
237 ],'list' => [
238 'path' => 'v1/spaces',
239 'httpMethod' => 'GET',
240 'parameters' => [
241 'filter' => [
242 'location' => 'query',
243 'type' => 'string',
244 ],
245 'pageSize' => [
246 'location' => 'query',
247 'type' => 'integer',
248 ],
249 'pageToken' => [
250 'location' => 'query',
251 'type' => 'string',
252 ],
253 ],
254 ],'patch' => [
255 'path' => 'v1/{+name}',
256 'httpMethod' => 'PATCH',
257 'parameters' => [
258 'name' => [
259 'location' => 'path',
260 'type' => 'string',
261 'required' => true,
262 ],
263 'updateMask' => [
264 'location' => 'query',
265 'type' => 'string',
266 ],
267 'useAdminAccess' => [
268 'location' => 'query',
269 'type' => 'boolean',
270 ],
271 ],
272 ],'search' => [
273 'path' => 'v1/spaces:search',
274 'httpMethod' => 'GET',
275 'parameters' => [
276 'orderBy' => [
277 'location' => 'query',
278 'type' => 'string',
279 ],
280 'pageSize' => [
281 'location' => 'query',
282 'type' => 'integer',
283 ],
284 'pageToken' => [
285 'location' => 'query',
286 'type' => 'string',
287 ],
288 'query' => [
289 'location' => 'query',
290 'type' => 'string',
291 ],
292 'useAdminAccess' => [
293 'location' => 'query',
294 'type' => 'boolean',
295 ],
296 ],
297 ],'setup' => [
298 'path' => 'v1/spaces:setup',
299 'httpMethod' => 'POST',
300 'parameters' => [],
301 ],
302 ]
303 ]
304 );
305 $this->spaces_members = new HangoutsChat\Resource\SpacesMembers(
306 $this,
307 $this->serviceName,
308 'members',
309 [
310 'methods' => [
311 'create' => [
312 'path' => 'v1/{+parent}/members',
313 'httpMethod' => 'POST',
314 'parameters' => [
315 'parent' => [
316 'location' => 'path',
317 'type' => 'string',
318 'required' => true,
319 ],
320 'useAdminAccess' => [
321 'location' => 'query',
322 'type' => 'boolean',
323 ],
324 ],
325 ],'delete' => [
326 'path' => 'v1/{+name}',
327 'httpMethod' => 'DELETE',
328 'parameters' => [
329 'name' => [
330 'location' => 'path',
331 'type' => 'string',
332 'required' => true,
333 ],
334 'useAdminAccess' => [
335 'location' => 'query',
336 'type' => 'boolean',
337 ],
338 ],
339 ],'get' => [
340 'path' => 'v1/{+name}',
341 'httpMethod' => 'GET',
342 'parameters' => [
343 'name' => [
344 'location' => 'path',
345 'type' => 'string',
346 'required' => true,
347 ],
348 'useAdminAccess' => [
349 'location' => 'query',
350 'type' => 'boolean',
351 ],
352 ],
353 ],'list' => [
354 'path' => 'v1/{+parent}/members',
355 'httpMethod' => 'GET',
356 'parameters' => [
357 'parent' => [
358 'location' => 'path',
359 'type' => 'string',
360 'required' => true,
361 ],
362 'filter' => [
363 'location' => 'query',
364 'type' => 'string',
365 ],
366 'pageSize' => [
367 'location' => 'query',
368 'type' => 'integer',
369 ],
370 'pageToken' => [
371 'location' => 'query',
372 'type' => 'string',
373 ],
374 'showGroups' => [
375 'location' => 'query',
376 'type' => 'boolean',
377 ],
378 'showInvited' => [
379 'location' => 'query',
380 'type' => 'boolean',
381 ],
382 'useAdminAccess' => [
383 'location' => 'query',
384 'type' => 'boolean',
385 ],
386 ],
387 ],'patch' => [
388 'path' => 'v1/{+name}',
389 'httpMethod' => 'PATCH',
390 'parameters' => [
391 'name' => [
392 'location' => 'path',
393 'type' => 'string',
394 'required' => true,
395 ],
396 'updateMask' => [
397 'location' => 'query',
398 'type' => 'string',
399 ],
400 'useAdminAccess' => [
401 'location' => 'query',
402 'type' => 'boolean',
403 ],
404 ],
405 ],
406 ]
407 ]
408 );
409 $this->spaces_messages = new HangoutsChat\Resource\SpacesMessages(
410 $this,
411 $this->serviceName,
412 'messages',
413 [
414 'methods' => [
415 'create' => [
416 'path' => 'v1/{+parent}/messages',
417 'httpMethod' => 'POST',
418 'parameters' => [
419 'parent' => [
420 'location' => 'path',
421 'type' => 'string',
422 'required' => true,
423 ],
424 'messageId' => [
425 'location' => 'query',
426 'type' => 'string',
427 ],
428 'messageReplyOption' => [
429 'location' => 'query',
430 'type' => 'string',
431 ],
432 'requestId' => [
433 'location' => 'query',
434 'type' => 'string',
435 ],
436 'threadKey' => [
437 'location' => 'query',
438 'type' => 'string',
439 ],
440 ],
441 ],'delete' => [
442 'path' => 'v1/{+name}',
443 'httpMethod' => 'DELETE',
444 'parameters' => [
445 'name' => [
446 'location' => 'path',
447 'type' => 'string',
448 'required' => true,
449 ],
450 'force' => [
451 'location' => 'query',
452 'type' => 'boolean',
453 ],
454 ],
455 ],'get' => [
456 'path' => 'v1/{+name}',
457 'httpMethod' => 'GET',
458 'parameters' => [
459 'name' => [
460 'location' => 'path',
461 'type' => 'string',
462 'required' => true,
463 ],
464 ],
465 ],'list' => [
466 'path' => 'v1/{+parent}/messages',
467 'httpMethod' => 'GET',
468 'parameters' => [
469 'parent' => [
470 'location' => 'path',
471 'type' => 'string',
472 'required' => true,
473 ],
474 'filter' => [
475 'location' => 'query',
476 'type' => 'string',
477 ],
478 'orderBy' => [
479 'location' => 'query',
480 'type' => 'string',
481 ],
482 'pageSize' => [
483 'location' => 'query',
484 'type' => 'integer',
485 ],
486 'pageToken' => [
487 'location' => 'query',
488 'type' => 'string',
489 ],
490 'showDeleted' => [
491 'location' => 'query',
492 'type' => 'boolean',
493 ],
494 ],
495 ],'patch' => [
496 'path' => 'v1/{+name}',
497 'httpMethod' => 'PATCH',
498 'parameters' => [
499 'name' => [
500 'location' => 'path',
501 'type' => 'string',
502 'required' => true,
503 ],
504 'allowMissing' => [
505 'location' => 'query',
506 'type' => 'boolean',
507 ],
508 'updateMask' => [
509 'location' => 'query',
510 'type' => 'string',
511 ],
512 ],
513 ],'update' => [
514 'path' => 'v1/{+name}',
515 'httpMethod' => 'PUT',
516 'parameters' => [
517 'name' => [
518 'location' => 'path',
519 'type' => 'string',
520 'required' => true,
521 ],
522 'allowMissing' => [
523 'location' => 'query',
524 'type' => 'boolean',
525 ],
526 'updateMask' => [
527 'location' => 'query',
528 'type' => 'string',
529 ],
530 ],
531 ],
532 ]
533 ]
534 );
535 $this->spaces_messages_attachments = new HangoutsChat\Resource\SpacesMessagesAttachments(
536 $this,
537 $this->serviceName,
538 'attachments',
539 [
540 'methods' => [
541 'get' => [
542 'path' => 'v1/{+name}',
543 'httpMethod' => 'GET',
544 'parameters' => [
545 'name' => [
546 'location' => 'path',
547 'type' => 'string',
548 'required' => true,
549 ],
550 ],
551 ],
552 ]
553 ]
554 );
555 $this->spaces_messages_reactions = new HangoutsChat\Resource\SpacesMessagesReactions(
556 $this,
557 $this->serviceName,
558 'reactions',
559 [
560 'methods' => [
561 'create' => [
562 'path' => 'v1/{+parent}/reactions',
563 'httpMethod' => 'POST',
564 'parameters' => [
565 'parent' => [
566 'location' => 'path',
567 'type' => 'string',
568 'required' => true,
569 ],
570 ],
571 ],'delete' => [
572 'path' => 'v1/{+name}',
573 'httpMethod' => 'DELETE',
574 'parameters' => [
575 'name' => [
576 'location' => 'path',
577 'type' => 'string',
578 'required' => true,
579 ],
580 ],
581 ],'list' => [
582 'path' => 'v1/{+parent}/reactions',
583 'httpMethod' => 'GET',
584 'parameters' => [
585 'parent' => [
586 'location' => 'path',
587 'type' => 'string',
588 'required' => true,
589 ],
590 'filter' => [
591 'location' => 'query',
592 'type' => 'string',
593 ],
594 'pageSize' => [
595 'location' => 'query',
596 'type' => 'integer',
597 ],
598 'pageToken' => [
599 'location' => 'query',
600 'type' => 'string',
601 ],
602 ],
603 ],
604 ]
605 ]
606 );
607 $this->spaces_spaceEvents = new HangoutsChat\Resource\SpacesSpaceEvents(
608 $this,
609 $this->serviceName,
610 'spaceEvents',
611 [
612 'methods' => [
613 'get' => [
614 'path' => 'v1/{+name}',
615 'httpMethod' => 'GET',
616 'parameters' => [
617 'name' => [
618 'location' => 'path',
619 'type' => 'string',
620 'required' => true,
621 ],
622 ],
623 ],'list' => [
624 'path' => 'v1/{+parent}/spaceEvents',
625 'httpMethod' => 'GET',
626 'parameters' => [
627 'parent' => [
628 'location' => 'path',
629 'type' => 'string',
630 'required' => true,
631 ],
632 'filter' => [
633 'location' => 'query',
634 'type' => 'string',
635 ],
636 'pageSize' => [
637 'location' => 'query',
638 'type' => 'integer',
639 ],
640 'pageToken' => [
641 'location' => 'query',
642 'type' => 'string',
643 ],
644 ],
645 ],
646 ]
647 ]
648 );
649 $this->users_spaces = new HangoutsChat\Resource\UsersSpaces(
650 $this,
651 $this->serviceName,
652 'spaces',
653 [
654 'methods' => [
655 'getSpaceReadState' => [
656 'path' => 'v1/{+name}',
657 'httpMethod' => 'GET',
658 'parameters' => [
659 'name' => [
660 'location' => 'path',
661 'type' => 'string',
662 'required' => true,
663 ],
664 ],
665 ],'updateSpaceReadState' => [
666 'path' => 'v1/{+name}',
667 'httpMethod' => 'PATCH',
668 'parameters' => [
669 'name' => [
670 'location' => 'path',
671 'type' => 'string',
672 'required' => true,
673 ],
674 'updateMask' => [
675 'location' => 'query',
676 'type' => 'string',
677 ],
678 ],
679 ],
680 ]
681 ]
682 );
683 $this->users_spaces_threads = new HangoutsChat\Resource\UsersSpacesThreads(
684 $this,
685 $this->serviceName,
686 'threads',
687 [
688 'methods' => [
689 'getThreadReadState' => [
690 'path' => 'v1/{+name}',
691 'httpMethod' => 'GET',
692 'parameters' => [
693 'name' => [
694 'location' => 'path',
695 'type' => 'string',
696 'required' => true,
697 ],
698 ],
699 ],
700 ]
701 ]
702 );
703 }
704}
705
706// Adding a class alias for backwards compatibility with the previous class name.
707class_alias(HangoutsChat::class, 'Google_Service_HangoutsChat');
Note: See TracBrowser for help on using the repository browser.