@google-apps/chat 0.17.0 → 0.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -49,6 +49,10 @@ service ChatService {
49
49
  "https://www.googleapis.com/auth/chat.admin.memberships.readonly,"
50
50
  "https://www.googleapis.com/auth/chat.admin.spaces,"
51
51
  "https://www.googleapis.com/auth/chat.admin.spaces.readonly,"
52
+ "https://www.googleapis.com/auth/chat.app.delete,"
53
+ "https://www.googleapis.com/auth/chat.app.memberships,"
54
+ "https://www.googleapis.com/auth/chat.app.spaces,"
55
+ "https://www.googleapis.com/auth/chat.app.spaces.create,"
52
56
  "https://www.googleapis.com/auth/chat.bot,"
53
57
  "https://www.googleapis.com/auth/chat.customemojis,"
54
58
  "https://www.googleapis.com/auth/chat.customemojis.readonly,"
@@ -73,10 +77,21 @@ service ChatService {
73
77
  // Creates a message in a Google Chat space. For an example, see [Send a
74
78
  // message](https://developers.google.com/workspace/chat/create-messages).
75
79
  //
76
- // The `create()` method requires either [user
80
+ // Supports the following types of
81
+ // [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
82
+ //
83
+ // - [App
84
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
85
+ // with the authorization scope:
86
+ // - `https://www.googleapis.com/auth/chat.bot`
87
+ // - [User
77
88
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
78
- // or [app
79
- // authentication](https://developers.google.com/workspace/chat/authorize-import).
89
+ // with one of the following authorization scopes:
90
+ // - `https://www.googleapis.com/auth/chat.messages.create`
91
+ // - `https://www.googleapis.com/auth/chat.messages`
92
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces
93
+ // only)
94
+ //
80
95
  // Chat attributes the message sender differently depending on the type of
81
96
  // authentication that you use in your request.
82
97
  //
@@ -120,7 +135,13 @@ service ChatService {
120
135
  // messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
121
136
  //
122
137
  // Requires [user
123
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
138
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
139
+ // with one of the following [authorization
140
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
141
+ //
142
+ // - `https://www.googleapis.com/auth/chat.messages.readonly`
143
+ // - `https://www.googleapis.com/auth/chat.messages`
144
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
124
145
  rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse) {
125
146
  option (google.api.http) = {
126
147
  get: "/v1/{parent=spaces/*}/messages"
@@ -145,11 +166,23 @@ service ChatService {
145
166
  //
146
167
  // - [App
147
168
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
169
+ // with one of the following authorization scopes:
170
+ // - `https://www.googleapis.com/auth/chat.bot`
171
+ // - `https://www.googleapis.com/auth/chat.app.memberships` (requires
172
+ // [administrator approval](https://support.google.com/a?p=chat-app-auth))
148
173
  //
149
174
  // - [User
150
175
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
151
- // You can authenticate and authorize this method with administrator
152
- // privileges by setting the `use_admin_access` field in the request.
176
+ // with one of the following authorization scopes:
177
+ // - `https://www.googleapis.com/auth/chat.memberships.readonly`
178
+ // - `https://www.googleapis.com/auth/chat.memberships`
179
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces
180
+ // only)
181
+ // - User authentication grants administrator privileges when an
182
+ // administrator account authenticates, `use_admin_access` is `true`, and
183
+ // one of the following authorization scopes is used:
184
+ // - `https://www.googleapis.com/auth/chat.admin.memberships.readonly`
185
+ // - `https://www.googleapis.com/auth/chat.admin.memberships`
153
186
  rpc ListMemberships(ListMembershipsRequest)
154
187
  returns (ListMembershipsResponse) {
155
188
  option (google.api.http) = {
@@ -167,11 +200,21 @@ service ChatService {
167
200
  //
168
201
  // - [App
169
202
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
203
+ // with one of the following authorization scopes:
204
+ // - `https://www.googleapis.com/auth/chat.bot`
205
+ // - `https://www.googleapis.com/auth/chat.app.memberships` (requires
206
+ // [administrator approval](https://support.google.com/a?p=chat-app-auth))
170
207
  //
171
208
  // - [User
172
209
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
173
- // You can authenticate and authorize this method with administrator
174
- // privileges by setting the `use_admin_access` field in the request.
210
+ // with one of the following authorization scopes:
211
+ // - `https://www.googleapis.com/auth/chat.memberships.readonly`
212
+ // - `https://www.googleapis.com/auth/chat.memberships`
213
+ // - User authentication grants administrator privileges when an
214
+ // administrator account authenticates, `use_admin_access` is `true`, and
215
+ // one of the following authorization scopes is used:
216
+ // - `https://www.googleapis.com/auth/chat.admin.memberships.readonly`
217
+ // - `https://www.googleapis.com/auth/chat.admin.memberships`
175
218
  rpc GetMembership(GetMembershipRequest) returns (Membership) {
176
219
  option (google.api.http) = {
177
220
  get: "/v1/{name=spaces/*/members/*}"
@@ -188,9 +231,14 @@ service ChatService {
188
231
  //
189
232
  // - [App
190
233
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
234
+ // with the authorization scope:
235
+ // - `https://www.googleapis.com/auth/chat.bot`
191
236
  //
192
237
  // - [User
193
238
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
239
+ // with one of the following authorization scopes:
240
+ // - `https://www.googleapis.com/auth/chat.messages.readonly`
241
+ // - `https://www.googleapis.com/auth/chat.messages`
194
242
  //
195
243
  // Note: Might return a message from a blocked member or space.
196
244
  rpc GetMessage(GetMessageRequest) returns (Message) {
@@ -212,9 +260,15 @@ service ChatService {
212
260
  //
213
261
  // - [App
214
262
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
263
+ // with the authorization scope:
264
+ // - `https://www.googleapis.com/auth/chat.bot`
215
265
  //
216
266
  // - [User
217
267
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
268
+ // with one of the following authorization scopes:
269
+ // - `https://www.googleapis.com/auth/chat.messages`
270
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces
271
+ // only)
218
272
  //
219
273
  // When using app authentication, requests can only update messages
220
274
  // created by the calling Chat app.
@@ -239,9 +293,15 @@ service ChatService {
239
293
  //
240
294
  // - [App
241
295
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
296
+ // with the authorization scope:
297
+ // - `https://www.googleapis.com/auth/chat.bot`
242
298
  //
243
299
  // - [User
244
300
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
301
+ // with one of the following authorization scopes:
302
+ // - `https://www.googleapis.com/auth/chat.messages`
303
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces
304
+ // only)
245
305
  //
246
306
  // When using app authentication, requests can only delete messages
247
307
  // created by the calling Chat app.
@@ -258,8 +318,13 @@ service ChatService {
258
318
  // For an example, see
259
319
  // [Get metadata about a message
260
320
  // attachment](https://developers.google.com/workspace/chat/get-media-attachments).
321
+ //
261
322
  // Requires [app
262
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
323
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
324
+ // with the [authorization
325
+ // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
326
+ //
327
+ // - `https://www.googleapis.com/auth/chat.bot`
263
328
  rpc GetAttachment(GetAttachmentRequest) returns (Attachment) {
264
329
  option (google.api.http) = {
265
330
  get: "/v1/{name=spaces/*/messages/*/attachments/*}"
@@ -272,7 +337,13 @@ service ChatService {
272
337
  // attachment](https://developers.google.com/workspace/chat/upload-media-attachments).
273
338
  //
274
339
  // Requires user
275
- // [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
340
+ // [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
341
+ // with one of the following [authorization
342
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
343
+ //
344
+ // - `https://www.googleapis.com/auth/chat.messages.create`
345
+ // - `https://www.googleapis.com/auth/chat.messages`
346
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
276
347
  //
277
348
  // You can upload attachments up to 200 MB. Certain file types aren't
278
349
  // supported. For details, see [File types blocked by Google
@@ -295,9 +366,14 @@ service ChatService {
295
366
  //
296
367
  // - [App
297
368
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
369
+ // with the authorization scope:
370
+ // - `https://www.googleapis.com/auth/chat.bot`
298
371
  //
299
372
  // - [User
300
373
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
374
+ // with one of the following authorization scopes:
375
+ // - `https://www.googleapis.com/auth/chat.spaces.readonly`
376
+ // - `https://www.googleapis.com/auth/chat.spaces`
301
377
  //
302
378
  // To list all named spaces by Google Workspace organization, use the
303
379
  // [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
@@ -314,7 +390,13 @@ service ChatService {
314
390
  //
315
391
  // Requires [user
316
392
  // authentication with administrator
317
- // privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges).
393
+ // privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges)
394
+ // and one of the following [authorization
395
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
396
+ //
397
+ // - `https://www.googleapis.com/auth/chat.admin.spaces.readonly`
398
+ // - `https://www.googleapis.com/auth/chat.admin.spaces`
399
+ //
318
400
  // In the request, set `use_admin_access` to `true`.
319
401
  rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse) {
320
402
  option (google.api.http) = {
@@ -332,11 +414,29 @@ service ChatService {
332
414
  //
333
415
  // - [App
334
416
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
417
+ // with one of the following authorization scopes:
418
+ // - `https://www.googleapis.com/auth/chat.bot`
419
+ // - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator
420
+ // approval](https://support.google.com/a?p=chat-app-auth)
335
421
  //
336
422
  // - [User
337
423
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
338
- // You can authenticate and authorize this method with administrator
339
- // privileges by setting the `use_admin_access` field in the request.
424
+ // with one of the following authorization scopes:
425
+ // - `https://www.googleapis.com/auth/chat.spaces.readonly`
426
+ // - `https://www.googleapis.com/auth/chat.spaces`
427
+ // - User authentication grants administrator privileges when an
428
+ // administrator account authenticates, `use_admin_access` is `true`, and
429
+ // one of the following authorization scopes is used:
430
+ // - `https://www.googleapis.com/auth/chat.admin.spaces.readonly`
431
+ // - `https://www.googleapis.com/auth/chat.admin.spaces`
432
+ //
433
+ // App authentication has the following limitations:
434
+ //
435
+ // - `space.access_settings` is only populated when using the
436
+ // `chat.app.spaces` scope.
437
+ // - `space.predefind_permission_settings` and `space.permission_settings` are
438
+ // only populated when using the `chat.app.spaces` scope, and only for
439
+ // spaces the app created.
340
440
  rpc GetSpace(GetSpaceRequest) returns (Space) {
341
441
  option (google.api.http) = {
342
442
  get: "/v1/{name=spaces/*}"
@@ -344,27 +444,48 @@ service ChatService {
344
444
  option (google.api.method_signature) = "name";
345
445
  }
346
446
 
347
- // Creates a space with no members. Can be used to create a named space, or a
447
+ // Creates a space. Can be used to create a named space, or a
348
448
  // group chat in `Import mode`. For an example, see [Create a
349
449
  // space](https://developers.google.com/workspace/chat/create-spaces).
350
450
  //
351
- // If you receive the error message `ALREADY_EXISTS` when creating
352
- // a space, try a different `displayName`. An existing space within
353
- // the Google Workspace organization might already use this display name.
354
- //
355
451
  // Supports the following types of
356
452
  // [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
357
453
  //
358
454
  // - [App
359
455
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
360
456
  // with [administrator approval](https://support.google.com/a?p=chat-app-auth)
361
- // in [Developer Preview](https://developers.google.com/workspace/preview)
457
+ // and one of the following authorization scopes:
458
+ // - `https://www.googleapis.com/auth/chat.app.spaces.create`
459
+ // - `https://www.googleapis.com/auth/chat.app.spaces`
362
460
  //
363
461
  // - [User
364
462
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
463
+ // with one of the following authorization scopes:
464
+ // - `https://www.googleapis.com/auth/chat.spaces.create`
465
+ // - `https://www.googleapis.com/auth/chat.spaces`
466
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces
467
+ // only)
365
468
  //
366
469
  // When authenticating as an app, the `space.customer` field must be set in
367
470
  // the request.
471
+ //
472
+ // When authenticating as an app, the Chat app is added as a member of the
473
+ // space. However, unlike human authentication, the Chat app is not added as a
474
+ // space manager. By default, the Chat app can be removed from the space by
475
+ // all space members. To allow only space managers to remove the app from a
476
+ // space, set `space.permission_settings.manage_apps` to `managers_allowed`.
477
+ //
478
+ // Space membership upon creation depends on whether the space is created in
479
+ // `Import mode`:
480
+ //
481
+ // * **Import mode:** No members are created.
482
+ // * **All other modes:** The calling user is added as a member. This is:
483
+ // * The app itself when using app authentication.
484
+ // * The human user when using user authentication.
485
+ //
486
+ // If you receive the error message `ALREADY_EXISTS` when creating
487
+ // a space, try a different `displayName`. An existing space within
488
+ // the Google Workspace organization might already use this display name.
368
489
  rpc CreateSpace(CreateSpaceRequest) returns (Space) {
369
490
  option (google.api.http) = {
370
491
  post: "/v1/spaces"
@@ -424,7 +545,12 @@ service ChatService {
424
545
  // might already use this display name.
425
546
  //
426
547
  // Requires [user
427
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
548
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
549
+ // with one of the following [authorization
550
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
551
+ //
552
+ // - `https://www.googleapis.com/auth/chat.spaces.create`
553
+ // - `https://www.googleapis.com/auth/chat.spaces`
428
554
  rpc SetUpSpace(SetUpSpaceRequest) returns (Space) {
429
555
  option (google.api.http) = {
430
556
  post: "/v1/spaces:setup"
@@ -446,12 +572,26 @@ service ChatService {
446
572
  // - [App
447
573
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
448
574
  // with [administrator approval](https://support.google.com/a?p=chat-app-auth)
449
- // in [Developer Preview](https://developers.google.com/workspace/preview)
575
+ // and one of the following authorization scopes:
576
+ // - `https://www.googleapis.com/auth/chat.app.spaces`
450
577
  //
451
578
  // - [User
452
579
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
453
- // You can authenticate and authorize this method with administrator
454
- // privileges by setting the `use_admin_access` field in the request.
580
+ // with one of the following authorization scopes:
581
+ // - `https://www.googleapis.com/auth/chat.spaces`
582
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces
583
+ // only)
584
+ // - User authentication grants administrator privileges when an
585
+ // administrator account authenticates, `use_admin_access` is `true`, and
586
+ // the following authorization scopes is used:
587
+ // - `https://www.googleapis.com/auth/chat.admin.spaces`
588
+ //
589
+ // App authentication has the following limitations:
590
+ //
591
+ // - To update either `space.predefined_permission_settings` or
592
+ // `space.permission_settings`, the app must be the space creator.
593
+ // - Updating the `space.access_settings.audience` is not supported for app
594
+ // authentication.
455
595
  rpc UpdateSpace(UpdateSpaceRequest) returns (Space) {
456
596
  option (google.api.http) = {
457
597
  patch: "/v1/{space.name=spaces/*}"
@@ -471,13 +611,22 @@ service ChatService {
471
611
  //
472
612
  // - [App
473
613
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
474
- // with [administrator approval](https://support.google.com/a?p=chat-app-auth)
475
- // in [Developer Preview](https://developers.google.com/workspace/preview)
614
+ // with [administrator
615
+ // approval](https://support.google.com/a?p=chat-app-auth) and the
616
+ // authorization scope:
617
+ // - `https://www.googleapis.com/auth/chat.app.delete` (only in
618
+ // spaces the app created)
476
619
  //
477
620
  // - [User
478
621
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
479
- // You can authenticate and authorize this method with administrator
480
- // privileges by setting the `use_admin_access` field in the request.
622
+ // with one of the following authorization scopes:
623
+ // - `https://www.googleapis.com/auth/chat.delete`
624
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces
625
+ // only)
626
+ // - User authentication grants administrator privileges when an
627
+ // administrator account authenticates, `use_admin_access` is `true`, and
628
+ // the following authorization scope is used:
629
+ // - `https://www.googleapis.com/auth/chat.admin.delete`
481
630
  rpc DeleteSpace(DeleteSpaceRequest) returns (google.protobuf.Empty) {
482
631
  option (google.api.http) = {
483
632
  delete: "/v1/{name=spaces/*}"
@@ -489,9 +638,14 @@ service ChatService {
489
638
  // [import process](https://developers.google.com/workspace/chat/import-data)
490
639
  // for the specified space and makes it visible to users.
491
640
  //
492
- // Requires [app
493
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
494
- // and domain-wide delegation. For more information, see [Authorize Google
641
+ // Requires [user
642
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
643
+ // and domain-wide delegation with the [authorization
644
+ // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
645
+ //
646
+ // - `https://www.googleapis.com/auth/chat.import`
647
+ //
648
+ // For more information, see [Authorize Google
495
649
  // Chat apps to import
496
650
  // data](https://developers.google.com/workspace/chat/authorize-import).
497
651
  rpc CompleteImportSpace(CompleteImportSpaceRequest)
@@ -517,14 +671,19 @@ service ChatService {
517
671
  // returns the direct message space between the specified user and the
518
672
  // authenticated user.
519
673
  //
520
- // // Supports the following types of
674
+ // Supports the following types of
521
675
  // [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
522
676
  //
523
677
  // - [App
524
678
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
679
+ // with the authorization scope:
680
+ // - `https://www.googleapis.com/auth/chat.bot`
525
681
  //
526
682
  // - [User
527
683
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
684
+ // with one of the following authorization scopes:
685
+ // - `https://www.googleapis.com/auth/chat.spaces.readonly`
686
+ // - `https://www.googleapis.com/auth/chat.spaces`
528
687
  rpc FindDirectMessage(FindDirectMessageRequest) returns (Space) {
529
688
  option (google.api.http) = {
530
689
  get: "/v1/spaces:findDirectMessage"
@@ -544,21 +703,35 @@ service ChatService {
544
703
  // - [App
545
704
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
546
705
  // with [administrator approval](https://support.google.com/a?p=chat-app-auth)
547
- // in [Developer Preview](https://developers.google.com/workspace/preview)
706
+ // and the authorization scope:
707
+ // - `https://www.googleapis.com/auth/chat.app.memberships`
548
708
  //
549
709
  // - [User
550
710
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
551
- // You can authenticate and authorize this method with administrator
552
- // privileges by setting the `use_admin_access` field in the request.
711
+ // with one of the following authorization scopes:
712
+ // - `https://www.googleapis.com/auth/chat.memberships`
713
+ // - `https://www.googleapis.com/auth/chat.memberships.app` (to add the
714
+ // calling app to the space)
715
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces
716
+ // only)
717
+ // - User authentication grants administrator privileges when an
718
+ // administrator account authenticates, `use_admin_access` is `true`, and
719
+ // the following authorization scope is used:
720
+ // - `https://www.googleapis.com/auth/chat.admin.memberships`
721
+ //
722
+ // App authentication is not supported for the following use cases:
723
+ //
724
+ // - Inviting users external to the Workspace organization that owns the
725
+ // space.
726
+ // - Adding a Google Group to a space.
727
+ // - Adding a Chat app to a space.
553
728
  //
554
729
  // For example usage, see:
555
730
  //
556
731
  // - [Invite or add a user to a
557
732
  // space](https://developers.google.com/workspace/chat/create-members#create-user-membership).
558
- //
559
733
  // - [Invite or add a Google Group to a
560
734
  // space](https://developers.google.com/workspace/chat/create-members#create-group-membership).
561
- //
562
735
  // - [Add the Chat app to a
563
736
  // space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
564
737
  rpc CreateMembership(CreateMembershipRequest) returns (Membership) {
@@ -577,13 +750,22 @@ service ChatService {
577
750
  //
578
751
  // - [App
579
752
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
580
- // with [administrator approval](https://support.google.com/a?p=chat-app-auth)
581
- // in [Developer Preview](https://developers.google.com/workspace/preview)
753
+ // with [administrator
754
+ // approval](https://support.google.com/a?p=chat-app-auth) and the
755
+ // authorization scope:
756
+ // - `https://www.googleapis.com/auth/chat.app.memberships` (only in
757
+ // spaces the app created)
582
758
  //
583
759
  // - [User
584
760
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
585
- // You can authenticate and authorize this method with administrator
586
- // privileges by setting the `use_admin_access` field in the request.
761
+ // with one of the following authorization scopes:
762
+ // - `https://www.googleapis.com/auth/chat.memberships`
763
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces
764
+ // only)
765
+ // - User authentication grants administrator privileges when an
766
+ // administrator account authenticates, `use_admin_access` is `true`, and
767
+ // the following authorization scope is used:
768
+ // - `https://www.googleapis.com/auth/chat.admin.memberships`
587
769
  rpc UpdateMembership(UpdateMembershipRequest) returns (Membership) {
588
770
  option (google.api.http) = {
589
771
  patch: "/v1/{membership.name=spaces/*/members/*}"
@@ -602,12 +784,31 @@ service ChatService {
602
784
  // - [App
603
785
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
604
786
  // with [administrator approval](https://support.google.com/a?p=chat-app-auth)
605
- // in [Developer Preview](https://developers.google.com/workspace/preview)
787
+ // and the authorization scope:
788
+ // - `https://www.googleapis.com/auth/chat.app.memberships`
606
789
  //
607
790
  // - [User
608
791
  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
609
- // You can authenticate and authorize this method with administrator
610
- // privileges by setting the `use_admin_access` field in the request.
792
+ // with one of the following authorization scopes:
793
+ // - `https://www.googleapis.com/auth/chat.memberships`
794
+ // - `https://www.googleapis.com/auth/chat.memberships.app` (to remove
795
+ // the calling app from the space)
796
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces
797
+ // only)
798
+ // - User authentication grants administrator privileges when an
799
+ // administrator account authenticates, `use_admin_access` is `true`, and
800
+ // the following authorization scope is used:
801
+ // - `https://www.googleapis.com/auth/chat.admin.memberships`
802
+ //
803
+ // App authentication is not supported for the following use cases:
804
+ //
805
+ // - Removing a Google Group from a space.
806
+ // - Removing a Chat app from a space.
807
+ //
808
+ // To delete memberships for space managers, the requester
809
+ // must be a space manager. If you're using [app
810
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
811
+ // the Chat app must be the space creator.
611
812
  rpc DeleteMembership(DeleteMembershipRequest) returns (Membership) {
612
813
  option (google.api.http) = {
613
814
  delete: "/v1/{name=spaces/*/members/*}"
@@ -620,7 +821,14 @@ service ChatService {
620
821
  // message](https://developers.google.com/workspace/chat/create-reactions).
621
822
  //
622
823
  // Requires [user
623
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
824
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
825
+ // with one of the following [authorization
826
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
827
+ //
828
+ // - `https://www.googleapis.com/auth/chat.messages.reactions.create`
829
+ // - `https://www.googleapis.com/auth/chat.messages.reactions`
830
+ // - `https://www.googleapis.com/auth/chat.messages`
831
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
624
832
  rpc CreateReaction(CreateReactionRequest) returns (Reaction) {
625
833
  option (google.api.http) = {
626
834
  post: "/v1/{parent=spaces/*/messages/*}/reactions"
@@ -634,7 +842,14 @@ service ChatService {
634
842
  // message](https://developers.google.com/workspace/chat/list-reactions).
635
843
  //
636
844
  // Requires [user
637
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
845
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
846
+ // with one of the following [authorization
847
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
848
+ //
849
+ // - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
850
+ // - `https://www.googleapis.com/auth/chat.messages.reactions`
851
+ // - `https://www.googleapis.com/auth/chat.messages.readonly`
852
+ // - `https://www.googleapis.com/auth/chat.messages`
638
853
  rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse) {
639
854
  option (google.api.http) = {
640
855
  get: "/v1/{parent=spaces/*/messages/*}/reactions"
@@ -647,7 +862,13 @@ service ChatService {
647
862
  // reaction](https://developers.google.com/workspace/chat/delete-reactions).
648
863
  //
649
864
  // Requires [user
650
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
865
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
866
+ // with one of the following [authorization
867
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
868
+ //
869
+ // - `https://www.googleapis.com/auth/chat.messages.reactions`
870
+ // - `https://www.googleapis.com/auth/chat.messages`
871
+ // - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
651
872
  rpc DeleteReaction(DeleteReactionRequest) returns (google.protobuf.Empty) {
652
873
  option (google.api.http) = {
653
874
  delete: "/v1/{name=spaces/*/messages/*/reactions/*}"
@@ -665,7 +886,11 @@ service ChatService {
665
886
  // permissions](https://support.google.com/a/answer/12850085).
666
887
  //
667
888
  // Requires [user
668
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
889
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
890
+ // with the [authorization
891
+ // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
892
+ //
893
+ // - `https://www.googleapis.com/auth/chat.customemojis`
669
894
  rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji) {
670
895
  option (google.api.http) = {
671
896
  post: "/v1/customEmojis"
@@ -684,7 +909,12 @@ service ChatService {
684
909
  // permissions](https://support.google.com/a/answer/12850085).
685
910
  //
686
911
  // Requires [user
687
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
912
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
913
+ // with one of the following [authorization
914
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
915
+ //
916
+ // - `https://www.googleapis.com/auth/chat.customemojis.readonly`
917
+ // - `https://www.googleapis.com/auth/chat.customemojis`
688
918
  rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji) {
689
919
  option (google.api.http) = {
690
920
  get: "/v1/{name=customEmojis/*}"
@@ -702,7 +932,12 @@ service ChatService {
702
932
  // permissions](https://support.google.com/a/answer/12850085).
703
933
  //
704
934
  // Requires [user
705
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
935
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
936
+ // with one of the following [authorization
937
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
938
+ //
939
+ // - `https://www.googleapis.com/auth/chat.customemojis.readonly`
940
+ // - `https://www.googleapis.com/auth/chat.customemojis`
706
941
  rpc ListCustomEmojis(ListCustomEmojisRequest)
707
942
  returns (ListCustomEmojisResponse) {
708
943
  option (google.api.http) = {
@@ -725,7 +960,11 @@ service ChatService {
725
960
  // permissions](https://support.google.com/a/answer/12850085).
726
961
  //
727
962
  // Requires [user
728
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
963
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
964
+ // with the [authorization
965
+ // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
966
+ //
967
+ // - `https://www.googleapis.com/auth/chat.customemojis`
729
968
  rpc DeleteCustomEmoji(DeleteCustomEmojiRequest)
730
969
  returns (google.protobuf.Empty) {
731
970
  option (google.api.http) = {
@@ -740,7 +979,12 @@ service ChatService {
740
979
  // state](https://developers.google.com/workspace/chat/get-space-read-state).
741
980
  //
742
981
  // Requires [user
743
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
982
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
983
+ // with one of the following [authorization
984
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
985
+ //
986
+ // - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
987
+ // - `https://www.googleapis.com/auth/chat.users.readstate`
744
988
  rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState) {
745
989
  option (google.api.http) = {
746
990
  get: "/v1/{name=users/*/spaces/*/spaceReadState}"
@@ -753,7 +997,11 @@ service ChatService {
753
997
  // state](https://developers.google.com/workspace/chat/update-space-read-state).
754
998
  //
755
999
  // Requires [user
756
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1000
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1001
+ // with the [authorization
1002
+ // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
1003
+ //
1004
+ // - `https://www.googleapis.com/auth/chat.users.readstate`
757
1005
  rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest)
758
1006
  returns (SpaceReadState) {
759
1007
  option (google.api.http) = {
@@ -769,7 +1017,12 @@ service ChatService {
769
1017
  // state](https://developers.google.com/workspace/chat/get-thread-read-state).
770
1018
  //
771
1019
  // Requires [user
772
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1020
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1021
+ // with one of the following [authorization
1022
+ // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
1023
+ //
1024
+ // - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
1025
+ // - `https://www.googleapis.com/auth/chat.users.readstate`
773
1026
  rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState) {
774
1027
  option (google.api.http) = {
775
1028
  get: "/v1/{name=users/*/spaces/*/threads/*/threadReadState}"
@@ -788,7 +1041,20 @@ service ChatService {
788
1041
  // object of the Space event data for this request.
789
1042
  //
790
1043
  // Requires [user
791
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1044
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1045
+ // with an [authorization
1046
+ // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes)
1047
+ // appropriate for reading the requested data:
1048
+ //
1049
+ // - `https://www.googleapis.com/auth/chat.spaces.readonly`
1050
+ // - `https://www.googleapis.com/auth/chat.spaces`
1051
+ // - `https://www.googleapis.com/auth/chat.messages.readonly`
1052
+ // - `https://www.googleapis.com/auth/chat.messages`
1053
+ // - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
1054
+ // - `https://www.googleapis.com/auth/chat.messages.reactions`
1055
+ // - `https://www.googleapis.com/auth/chat.memberships.readonly`
1056
+ // - `https://www.googleapis.com/auth/chat.memberships`
1057
+ //
792
1058
  // To get an event, the authenticated user must be a member of the space.
793
1059
  //
794
1060
  // For an example, see [Get details about an
@@ -810,7 +1076,20 @@ service ChatService {
810
1076
  // `Membership` resource.
811
1077
  //
812
1078
  // Requires [user
813
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1079
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1080
+ // with an [authorization
1081
+ // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes)
1082
+ // appropriate for reading the requested data:
1083
+ //
1084
+ // - `https://www.googleapis.com/auth/chat.spaces.readonly`
1085
+ // - `https://www.googleapis.com/auth/chat.spaces`
1086
+ // - `https://www.googleapis.com/auth/chat.messages.readonly`
1087
+ // - `https://www.googleapis.com/auth/chat.messages`
1088
+ // - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
1089
+ // - `https://www.googleapis.com/auth/chat.messages.reactions`
1090
+ // - `https://www.googleapis.com/auth/chat.memberships.readonly`
1091
+ // - `https://www.googleapis.com/auth/chat.memberships`
1092
+ //
814
1093
  // To list events, the authenticated user must be a member of the space.
815
1094
  //
816
1095
  // For an example, see [List events from a Google Chat
@@ -828,7 +1107,11 @@ service ChatService {
828
1107
  // setting](https://developers.google.com/workspace/chat/get-space-notification-setting).
829
1108
  //
830
1109
  // Requires [user
831
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1110
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1111
+ // with the [authorization
1112
+ // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
1113
+ //
1114
+ // - `https://www.googleapis.com/auth/chat.users.spacesettings`
832
1115
  rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest)
833
1116
  returns (SpaceNotificationSetting) {
834
1117
  option (google.api.http) = {
@@ -842,7 +1125,11 @@ service ChatService {
842
1125
  // setting](https://developers.google.com/workspace/chat/update-space-notification-setting).
843
1126
  //
844
1127
  // Requires [user
845
- // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1128
+ // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1129
+ // with the [authorization
1130
+ // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
1131
+ //
1132
+ // - `https://www.googleapis.com/auth/chat.users.spacesettings`
846
1133
  rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest)
847
1134
  returns (SpaceNotificationSetting) {
848
1135
  option (google.api.http) = {