google-apps-chat-v1 0.13.0 → 0.14.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.
- checksums.yaml +4 -4
- data/lib/google/apps/chat/v1/chat_service/client.rb +348 -63
- data/lib/google/apps/chat/v1/chat_service/credentials.rb +4 -0
- data/lib/google/apps/chat/v1/chat_service/rest/client.rb +348 -63
- data/lib/google/apps/chat/v1/version.rb +1 -1
- data/lib/google/chat/v1/chat_service_pb.rb +1 -1
- data/lib/google/chat/v1/chat_service_services_pb.rb +340 -57
- data/lib/google/chat/v1/space_pb.rb +1 -1
- data/lib/google/chat/v1/user_pb.rb +1 -2
- data/proto_docs/google/chat/v1/deletion_metadata.rb +13 -7
- data/proto_docs/google/chat/v1/membership.rb +7 -5
- data/proto_docs/google/chat/v1/slash_command.rb +2 -2
- data/proto_docs/google/chat/v1/space.rb +38 -2
- data/proto_docs/google/chat/v1/space_setup.rb +1 -1
- metadata +1 -1
@@ -37,10 +37,21 @@ module Google
|
|
37
37
|
# Creates a message in a Google Chat space. For an example, see [Send a
|
38
38
|
# message](https://developers.google.com/workspace/chat/create-messages).
|
39
39
|
#
|
40
|
-
#
|
40
|
+
# Supports the following types of
|
41
|
+
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
42
|
+
#
|
43
|
+
# - [App
|
44
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
45
|
+
# with the authorization scope:
|
46
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
47
|
+
# - [User
|
41
48
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
42
|
-
#
|
43
|
-
#
|
49
|
+
# with one of the following authorization scopes:
|
50
|
+
# - `https://www.googleapis.com/auth/chat.messages.create`
|
51
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
52
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
53
|
+
# only)
|
54
|
+
#
|
44
55
|
# Chat attributes the message sender differently depending on the type of
|
45
56
|
# authentication that you use in your request.
|
46
57
|
#
|
@@ -77,7 +88,13 @@ module Google
|
|
77
88
|
# messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
|
78
89
|
#
|
79
90
|
# Requires [user
|
80
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
91
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
92
|
+
# with one of the following [authorization
|
93
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
94
|
+
#
|
95
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
96
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
97
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
81
98
|
rpc :ListMessages, ::Google::Apps::Chat::V1::ListMessagesRequest, ::Google::Apps::Chat::V1::ListMessagesResponse
|
82
99
|
# Lists memberships in a space. For an example, see [List users and Google
|
83
100
|
# Chat apps in a
|
@@ -96,11 +113,23 @@ module Google
|
|
96
113
|
#
|
97
114
|
# - [App
|
98
115
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
116
|
+
# with one of the following authorization scopes:
|
117
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
118
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships` (requires
|
119
|
+
# [administrator approval](https://support.google.com/a?p=chat-app-auth))
|
99
120
|
#
|
100
121
|
# - [User
|
101
122
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
102
|
-
#
|
103
|
-
#
|
123
|
+
# with one of the following authorization scopes:
|
124
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
125
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
126
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
127
|
+
# only)
|
128
|
+
# - User authentication grants administrator privileges when an
|
129
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
130
|
+
# one of the following authorization scopes is used:
|
131
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships.readonly`
|
132
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
104
133
|
rpc :ListMemberships, ::Google::Apps::Chat::V1::ListMembershipsRequest, ::Google::Apps::Chat::V1::ListMembershipsResponse
|
105
134
|
# Returns details about a membership. For an example, see
|
106
135
|
# [Get details about a user's or Google Chat app's
|
@@ -111,11 +140,21 @@ module Google
|
|
111
140
|
#
|
112
141
|
# - [App
|
113
142
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
143
|
+
# with one of the following authorization scopes:
|
144
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
145
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships` (requires
|
146
|
+
# [administrator approval](https://support.google.com/a?p=chat-app-auth))
|
114
147
|
#
|
115
148
|
# - [User
|
116
149
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
117
|
-
#
|
118
|
-
#
|
150
|
+
# with one of the following authorization scopes:
|
151
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
152
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
153
|
+
# - User authentication grants administrator privileges when an
|
154
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
155
|
+
# one of the following authorization scopes is used:
|
156
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships.readonly`
|
157
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
119
158
|
rpc :GetMembership, ::Google::Apps::Chat::V1::GetMembershipRequest, ::Google::Apps::Chat::V1::Membership
|
120
159
|
# Returns details about a message.
|
121
160
|
# For an example, see [Get details about a
|
@@ -126,9 +165,14 @@ module Google
|
|
126
165
|
#
|
127
166
|
# - [App
|
128
167
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
168
|
+
# with the authorization scope:
|
169
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
129
170
|
#
|
130
171
|
# - [User
|
131
172
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
173
|
+
# with one of the following authorization scopes:
|
174
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
175
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
132
176
|
#
|
133
177
|
# Note: Might return a message from a blocked member or space.
|
134
178
|
rpc :GetMessage, ::Google::Apps::Chat::V1::GetMessageRequest, ::Google::Apps::Chat::V1::Message
|
@@ -144,9 +188,15 @@ module Google
|
|
144
188
|
#
|
145
189
|
# - [App
|
146
190
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
191
|
+
# with the authorization scope:
|
192
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
147
193
|
#
|
148
194
|
# - [User
|
149
195
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
196
|
+
# with one of the following authorization scopes:
|
197
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
198
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
199
|
+
# only)
|
150
200
|
#
|
151
201
|
# When using app authentication, requests can only update messages
|
152
202
|
# created by the calling Chat app.
|
@@ -160,9 +210,15 @@ module Google
|
|
160
210
|
#
|
161
211
|
# - [App
|
162
212
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
213
|
+
# with the authorization scope:
|
214
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
163
215
|
#
|
164
216
|
# - [User
|
165
217
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
218
|
+
# with one of the following authorization scopes:
|
219
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
220
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
221
|
+
# only)
|
166
222
|
#
|
167
223
|
# When using app authentication, requests can only delete messages
|
168
224
|
# created by the calling Chat app.
|
@@ -173,15 +229,26 @@ module Google
|
|
173
229
|
# For an example, see
|
174
230
|
# [Get metadata about a message
|
175
231
|
# attachment](https://developers.google.com/workspace/chat/get-media-attachments).
|
232
|
+
#
|
176
233
|
# Requires [app
|
177
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
234
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
235
|
+
# with the [authorization
|
236
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
237
|
+
#
|
238
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
178
239
|
rpc :GetAttachment, ::Google::Apps::Chat::V1::GetAttachmentRequest, ::Google::Apps::Chat::V1::Attachment
|
179
240
|
# Uploads an attachment. For an example, see
|
180
241
|
# [Upload media as a file
|
181
242
|
# attachment](https://developers.google.com/workspace/chat/upload-media-attachments).
|
182
243
|
#
|
183
244
|
# Requires user
|
184
|
-
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
245
|
+
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
246
|
+
# with one of the following [authorization
|
247
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
248
|
+
#
|
249
|
+
# - `https://www.googleapis.com/auth/chat.messages.create`
|
250
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
251
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
185
252
|
#
|
186
253
|
# You can upload attachments up to 200 MB. Certain file types aren't
|
187
254
|
# supported. For details, see [File types blocked by Google
|
@@ -197,9 +264,14 @@ module Google
|
|
197
264
|
#
|
198
265
|
# - [App
|
199
266
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
267
|
+
# with the authorization scope:
|
268
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
200
269
|
#
|
201
270
|
# - [User
|
202
271
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
272
|
+
# with one of the following authorization scopes:
|
273
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
274
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
203
275
|
#
|
204
276
|
# To list all named spaces by Google Workspace organization, use the
|
205
277
|
# [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
|
@@ -210,7 +282,13 @@ module Google
|
|
210
282
|
#
|
211
283
|
# Requires [user
|
212
284
|
# authentication with administrator
|
213
|
-
# privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges)
|
285
|
+
# privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges)
|
286
|
+
# and one of the following [authorization
|
287
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
288
|
+
#
|
289
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces.readonly`
|
290
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces`
|
291
|
+
#
|
214
292
|
# In the request, set `use_admin_access` to `true`.
|
215
293
|
rpc :SearchSpaces, ::Google::Apps::Chat::V1::SearchSpacesRequest, ::Google::Apps::Chat::V1::SearchSpacesResponse
|
216
294
|
# Returns details about a space. For an example, see
|
@@ -222,33 +300,72 @@ module Google
|
|
222
300
|
#
|
223
301
|
# - [App
|
224
302
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
303
|
+
# with one of the following authorization scopes:
|
304
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
305
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator
|
306
|
+
# approval](https://support.google.com/a?p=chat-app-auth)
|
225
307
|
#
|
226
308
|
# - [User
|
227
309
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
228
|
-
#
|
229
|
-
#
|
310
|
+
# with one of the following authorization scopes:
|
311
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
312
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
313
|
+
# - User authentication grants administrator privileges when an
|
314
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
315
|
+
# one of the following authorization scopes is used:
|
316
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces.readonly`
|
317
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces`
|
318
|
+
#
|
319
|
+
# App authentication has the following limitations:
|
320
|
+
#
|
321
|
+
# - `space.access_settings` is only populated when using the
|
322
|
+
# `chat.app.spaces` scope.
|
323
|
+
# - `space.predefind_permission_settings` and `space.permission_settings` are
|
324
|
+
# only populated when using the `chat.app.spaces` scope, and only for
|
325
|
+
# spaces the app created.
|
230
326
|
rpc :GetSpace, ::Google::Apps::Chat::V1::GetSpaceRequest, ::Google::Apps::Chat::V1::Space
|
231
|
-
# Creates a space
|
327
|
+
# Creates a space. Can be used to create a named space, or a
|
232
328
|
# group chat in `Import mode`. For an example, see [Create a
|
233
329
|
# space](https://developers.google.com/workspace/chat/create-spaces).
|
234
330
|
#
|
235
|
-
# If you receive the error message `ALREADY_EXISTS` when creating
|
236
|
-
# a space, try a different `displayName`. An existing space within
|
237
|
-
# the Google Workspace organization might already use this display name.
|
238
|
-
#
|
239
331
|
# Supports the following types of
|
240
332
|
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
241
333
|
#
|
242
334
|
# - [App
|
243
335
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
244
336
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
245
|
-
#
|
337
|
+
# and one of the following authorization scopes:
|
338
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces.create`
|
339
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces`
|
246
340
|
#
|
247
341
|
# - [User
|
248
342
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
343
|
+
# with one of the following authorization scopes:
|
344
|
+
# - `https://www.googleapis.com/auth/chat.spaces.create`
|
345
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
346
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
347
|
+
# only)
|
249
348
|
#
|
250
349
|
# When authenticating as an app, the `space.customer` field must be set in
|
251
350
|
# the request.
|
351
|
+
#
|
352
|
+
# When authenticating as an app, the Chat app is added as a member of the
|
353
|
+
# space. However, unlike human authentication, the Chat app is not added as a
|
354
|
+
# space manager. By default, the Chat app can be removed from the space by
|
355
|
+
# all space members. To allow only space managers to remove the app from a
|
356
|
+
# space, set `space.permission_settings.manage_apps` to `managers_allowed`.
|
357
|
+
#
|
358
|
+
# Space membership upon creation depends on whether the space is created in
|
359
|
+
# `Import mode`:
|
360
|
+
#
|
361
|
+
# * **Import mode:** No members are created.
|
362
|
+
# * **All other modes:** The calling user is added as a member. This is:
|
363
|
+
# * The app itself when using app authentication.
|
364
|
+
# * The human user when using user authentication.
|
365
|
+
#
|
366
|
+
# If you receive the error message `ALREADY_EXISTS` when creating
|
367
|
+
# a space, try a different `displayName`. An existing space within
|
368
|
+
# the Google Workspace organization might already use this display name.
|
252
369
|
rpc :CreateSpace, ::Google::Apps::Chat::V1::CreateSpaceRequest, ::Google::Apps::Chat::V1::Space
|
253
370
|
# Creates a space and adds specified users to it. The calling user is
|
254
371
|
# automatically added to the space, and shouldn't be specified as a
|
@@ -301,7 +418,12 @@ module Google
|
|
301
418
|
# might already use this display name.
|
302
419
|
#
|
303
420
|
# Requires [user
|
304
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
421
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
422
|
+
# with one of the following [authorization
|
423
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
424
|
+
#
|
425
|
+
# - `https://www.googleapis.com/auth/chat.spaces.create`
|
426
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
305
427
|
rpc :SetUpSpace, ::Google::Apps::Chat::V1::SetUpSpaceRequest, ::Google::Apps::Chat::V1::Space
|
306
428
|
# Updates a space. For an example, see
|
307
429
|
# [Update a
|
@@ -317,12 +439,26 @@ module Google
|
|
317
439
|
# - [App
|
318
440
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
319
441
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
320
|
-
#
|
442
|
+
# and one of the following authorization scopes:
|
443
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces`
|
321
444
|
#
|
322
445
|
# - [User
|
323
446
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
324
|
-
#
|
325
|
-
#
|
447
|
+
# with one of the following authorization scopes:
|
448
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
449
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
450
|
+
# only)
|
451
|
+
# - User authentication grants administrator privileges when an
|
452
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
453
|
+
# the following authorization scopes is used:
|
454
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces`
|
455
|
+
#
|
456
|
+
# App authentication has the following limitations:
|
457
|
+
#
|
458
|
+
# - To update either `space.predefined_permission_settings` or
|
459
|
+
# `space.permission_settings`, the app must be the space creator.
|
460
|
+
# - Updating the `space.access_settings.audience` is not supported for app
|
461
|
+
# authentication.
|
326
462
|
rpc :UpdateSpace, ::Google::Apps::Chat::V1::UpdateSpaceRequest, ::Google::Apps::Chat::V1::Space
|
327
463
|
# Deletes a named space. Always performs a cascading delete, which means
|
328
464
|
# that the space's child resources—like messages posted in the space and
|
@@ -335,21 +471,35 @@ module Google
|
|
335
471
|
#
|
336
472
|
# - [App
|
337
473
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
338
|
-
# with [administrator
|
339
|
-
#
|
474
|
+
# with [administrator
|
475
|
+
# approval](https://support.google.com/a?p=chat-app-auth) and the
|
476
|
+
# authorization scope:
|
477
|
+
# - `https://www.googleapis.com/auth/chat.app.delete` (only in
|
478
|
+
# spaces the app created)
|
340
479
|
#
|
341
480
|
# - [User
|
342
481
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
343
|
-
#
|
344
|
-
#
|
482
|
+
# with one of the following authorization scopes:
|
483
|
+
# - `https://www.googleapis.com/auth/chat.delete`
|
484
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
485
|
+
# only)
|
486
|
+
# - User authentication grants administrator privileges when an
|
487
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
488
|
+
# the following authorization scope is used:
|
489
|
+
# - `https://www.googleapis.com/auth/chat.admin.delete`
|
345
490
|
rpc :DeleteSpace, ::Google::Apps::Chat::V1::DeleteSpaceRequest, ::Google::Protobuf::Empty
|
346
491
|
# Completes the
|
347
492
|
# [import process](https://developers.google.com/workspace/chat/import-data)
|
348
493
|
# for the specified space and makes it visible to users.
|
349
494
|
#
|
350
|
-
# Requires [
|
351
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-
|
352
|
-
# and domain-wide delegation
|
495
|
+
# Requires [user
|
496
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
497
|
+
# and domain-wide delegation with the [authorization
|
498
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
499
|
+
#
|
500
|
+
# - `https://www.googleapis.com/auth/chat.import`
|
501
|
+
#
|
502
|
+
# For more information, see [Authorize Google
|
353
503
|
# Chat apps to import
|
354
504
|
# data](https://developers.google.com/workspace/chat/authorize-import).
|
355
505
|
rpc :CompleteImportSpace, ::Google::Apps::Chat::V1::CompleteImportSpaceRequest, ::Google::Apps::Chat::V1::CompleteImportSpaceResponse
|
@@ -368,14 +518,19 @@ module Google
|
|
368
518
|
# returns the direct message space between the specified user and the
|
369
519
|
# authenticated user.
|
370
520
|
#
|
371
|
-
#
|
521
|
+
# Supports the following types of
|
372
522
|
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
373
523
|
#
|
374
524
|
# - [App
|
375
525
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
526
|
+
# with the authorization scope:
|
527
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
376
528
|
#
|
377
529
|
# - [User
|
378
530
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
531
|
+
# with one of the following authorization scopes:
|
532
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
533
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
379
534
|
rpc :FindDirectMessage, ::Google::Apps::Chat::V1::FindDirectMessageRequest, ::Google::Apps::Chat::V1::Space
|
380
535
|
# Creates a membership for the calling Chat app, a user, or a Google Group.
|
381
536
|
# Creating memberships for other Chat apps isn't supported.
|
@@ -390,21 +545,35 @@ module Google
|
|
390
545
|
# - [App
|
391
546
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
392
547
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
393
|
-
#
|
548
|
+
# and the authorization scope:
|
549
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships`
|
394
550
|
#
|
395
551
|
# - [User
|
396
552
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
397
|
-
#
|
398
|
-
#
|
553
|
+
# with one of the following authorization scopes:
|
554
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
555
|
+
# - `https://www.googleapis.com/auth/chat.memberships.app` (to add the
|
556
|
+
# calling app to the space)
|
557
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
558
|
+
# only)
|
559
|
+
# - User authentication grants administrator privileges when an
|
560
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
561
|
+
# the following authorization scope is used:
|
562
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
563
|
+
#
|
564
|
+
# App authentication is not supported for the following use cases:
|
565
|
+
#
|
566
|
+
# - Inviting users external to the Workspace organization that owns the
|
567
|
+
# space.
|
568
|
+
# - Adding a Google Group to a space.
|
569
|
+
# - Adding a Chat app to a space.
|
399
570
|
#
|
400
571
|
# For example usage, see:
|
401
572
|
#
|
402
573
|
# - [Invite or add a user to a
|
403
574
|
# space](https://developers.google.com/workspace/chat/create-members#create-user-membership).
|
404
|
-
#
|
405
575
|
# - [Invite or add a Google Group to a
|
406
576
|
# space](https://developers.google.com/workspace/chat/create-members#create-group-membership).
|
407
|
-
#
|
408
577
|
# - [Add the Chat app to a
|
409
578
|
# space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
|
410
579
|
rpc :CreateMembership, ::Google::Apps::Chat::V1::CreateMembershipRequest, ::Google::Apps::Chat::V1::Membership
|
@@ -416,13 +585,22 @@ module Google
|
|
416
585
|
#
|
417
586
|
# - [App
|
418
587
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
419
|
-
# with [administrator
|
420
|
-
#
|
588
|
+
# with [administrator
|
589
|
+
# approval](https://support.google.com/a?p=chat-app-auth) and the
|
590
|
+
# authorization scope:
|
591
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships` (only in
|
592
|
+
# spaces the app created)
|
421
593
|
#
|
422
594
|
# - [User
|
423
595
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
424
|
-
#
|
425
|
-
#
|
596
|
+
# with one of the following authorization scopes:
|
597
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
598
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
599
|
+
# only)
|
600
|
+
# - User authentication grants administrator privileges when an
|
601
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
602
|
+
# the following authorization scope is used:
|
603
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
426
604
|
rpc :UpdateMembership, ::Google::Apps::Chat::V1::UpdateMembershipRequest, ::Google::Apps::Chat::V1::Membership
|
427
605
|
# Deletes a membership. For an example, see
|
428
606
|
# [Remove a user or a Google Chat app from a
|
@@ -434,33 +612,72 @@ module Google
|
|
434
612
|
# - [App
|
435
613
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
436
614
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
437
|
-
#
|
615
|
+
# and the authorization scope:
|
616
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships`
|
438
617
|
#
|
439
618
|
# - [User
|
440
619
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
441
|
-
#
|
442
|
-
#
|
620
|
+
# with one of the following authorization scopes:
|
621
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
622
|
+
# - `https://www.googleapis.com/auth/chat.memberships.app` (to remove
|
623
|
+
# the calling app from the space)
|
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.memberships`
|
630
|
+
#
|
631
|
+
# App authentication is not supported for the following use cases:
|
632
|
+
#
|
633
|
+
# - Removing a Google Group from a space.
|
634
|
+
# - Removing a Chat app from a space.
|
635
|
+
#
|
636
|
+
# To delete memberships for space managers, the requester
|
637
|
+
# must be a space manager. If you're using [app
|
638
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
639
|
+
# the Chat app must be the space creator.
|
443
640
|
rpc :DeleteMembership, ::Google::Apps::Chat::V1::DeleteMembershipRequest, ::Google::Apps::Chat::V1::Membership
|
444
641
|
# Creates a reaction and adds it to a message. For an example, see
|
445
642
|
# [Add a reaction to a
|
446
643
|
# message](https://developers.google.com/workspace/chat/create-reactions).
|
447
644
|
#
|
448
645
|
# Requires [user
|
449
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
646
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
647
|
+
# with one of the following [authorization
|
648
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
649
|
+
#
|
650
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.create`
|
651
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
652
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
653
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
450
654
|
rpc :CreateReaction, ::Google::Apps::Chat::V1::CreateReactionRequest, ::Google::Apps::Chat::V1::Reaction
|
451
655
|
# Lists reactions to a message. For an example, see
|
452
656
|
# [List reactions for a
|
453
657
|
# message](https://developers.google.com/workspace/chat/list-reactions).
|
454
658
|
#
|
455
659
|
# Requires [user
|
456
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
660
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
661
|
+
# with one of the following [authorization
|
662
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
663
|
+
#
|
664
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
|
665
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
666
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
667
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
457
668
|
rpc :ListReactions, ::Google::Apps::Chat::V1::ListReactionsRequest, ::Google::Apps::Chat::V1::ListReactionsResponse
|
458
669
|
# Deletes a reaction to a message. For an example, see
|
459
670
|
# [Delete a
|
460
671
|
# reaction](https://developers.google.com/workspace/chat/delete-reactions).
|
461
672
|
#
|
462
673
|
# Requires [user
|
463
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
674
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
675
|
+
# with one of the following [authorization
|
676
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
677
|
+
#
|
678
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
679
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
680
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
464
681
|
rpc :DeleteReaction, ::Google::Apps::Chat::V1::DeleteReactionRequest, ::Google::Protobuf::Empty
|
465
682
|
# Creates a custom emoji.
|
466
683
|
#
|
@@ -472,7 +689,11 @@ module Google
|
|
472
689
|
# permissions](https://support.google.com/a/answer/12850085).
|
473
690
|
#
|
474
691
|
# Requires [user
|
475
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
692
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
693
|
+
# with the [authorization
|
694
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
695
|
+
#
|
696
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
476
697
|
rpc :CreateCustomEmoji, ::Google::Apps::Chat::V1::CreateCustomEmojiRequest, ::Google::Apps::Chat::V1::CustomEmoji
|
477
698
|
# Returns details about a custom emoji.
|
478
699
|
#
|
@@ -484,7 +705,12 @@ module Google
|
|
484
705
|
# permissions](https://support.google.com/a/answer/12850085).
|
485
706
|
#
|
486
707
|
# Requires [user
|
487
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
708
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
709
|
+
# with one of the following [authorization
|
710
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
711
|
+
#
|
712
|
+
# - `https://www.googleapis.com/auth/chat.customemojis.readonly`
|
713
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
488
714
|
rpc :GetCustomEmoji, ::Google::Apps::Chat::V1::GetCustomEmojiRequest, ::Google::Apps::Chat::V1::CustomEmoji
|
489
715
|
# Lists custom emojis visible to the authenticated user.
|
490
716
|
#
|
@@ -496,7 +722,12 @@ module Google
|
|
496
722
|
# permissions](https://support.google.com/a/answer/12850085).
|
497
723
|
#
|
498
724
|
# Requires [user
|
499
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
725
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
726
|
+
# with one of the following [authorization
|
727
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
728
|
+
#
|
729
|
+
# - `https://www.googleapis.com/auth/chat.customemojis.readonly`
|
730
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
500
731
|
rpc :ListCustomEmojis, ::Google::Apps::Chat::V1::ListCustomEmojisRequest, ::Google::Apps::Chat::V1::ListCustomEmojisResponse
|
501
732
|
# Deletes a custom emoji. By default, users can only delete custom emoji they
|
502
733
|
# created. [Emoji managers](https://support.google.com/a/answer/12850085)
|
@@ -512,7 +743,11 @@ module Google
|
|
512
743
|
# permissions](https://support.google.com/a/answer/12850085).
|
513
744
|
#
|
514
745
|
# Requires [user
|
515
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
746
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
747
|
+
# with the [authorization
|
748
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
749
|
+
#
|
750
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
516
751
|
rpc :DeleteCustomEmoji, ::Google::Apps::Chat::V1::DeleteCustomEmojiRequest, ::Google::Protobuf::Empty
|
517
752
|
# Returns details about a user's read state within a space, used to identify
|
518
753
|
# read and unread messages. For an example, see [Get details about a user's
|
@@ -520,14 +755,23 @@ module Google
|
|
520
755
|
# state](https://developers.google.com/workspace/chat/get-space-read-state).
|
521
756
|
#
|
522
757
|
# Requires [user
|
523
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
758
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
759
|
+
# with one of the following [authorization
|
760
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
761
|
+
#
|
762
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
|
763
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate`
|
524
764
|
rpc :GetSpaceReadState, ::Google::Apps::Chat::V1::GetSpaceReadStateRequest, ::Google::Apps::Chat::V1::SpaceReadState
|
525
765
|
# Updates a user's read state within a space, used to identify read and
|
526
766
|
# unread messages. For an example, see [Update a user's space read
|
527
767
|
# state](https://developers.google.com/workspace/chat/update-space-read-state).
|
528
768
|
#
|
529
769
|
# Requires [user
|
530
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
770
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
771
|
+
# with the [authorization
|
772
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
773
|
+
#
|
774
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate`
|
531
775
|
rpc :UpdateSpaceReadState, ::Google::Apps::Chat::V1::UpdateSpaceReadStateRequest, ::Google::Apps::Chat::V1::SpaceReadState
|
532
776
|
# Returns details about a user's read state within a thread, used to identify
|
533
777
|
# read and unread messages. For an example, see [Get details about a user's
|
@@ -535,7 +779,12 @@ module Google
|
|
535
779
|
# state](https://developers.google.com/workspace/chat/get-thread-read-state).
|
536
780
|
#
|
537
781
|
# Requires [user
|
538
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
782
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
783
|
+
# with one of the following [authorization
|
784
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
785
|
+
#
|
786
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
|
787
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate`
|
539
788
|
rpc :GetThreadReadState, ::Google::Apps::Chat::V1::GetThreadReadStateRequest, ::Google::Apps::Chat::V1::ThreadReadState
|
540
789
|
# Returns an event from a Google Chat space. The [event
|
541
790
|
# payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload)
|
@@ -548,7 +797,20 @@ module Google
|
|
548
797
|
# object of the Space event data for this request.
|
549
798
|
#
|
550
799
|
# Requires [user
|
551
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
800
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
801
|
+
# with an [authorization
|
802
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes)
|
803
|
+
# appropriate for reading the requested data:
|
804
|
+
#
|
805
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
806
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
807
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
808
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
809
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
|
810
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
811
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
812
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
813
|
+
#
|
552
814
|
# To get an event, the authenticated user must be a member of the space.
|
553
815
|
#
|
554
816
|
# For an example, see [Get details about an
|
@@ -564,7 +826,20 @@ module Google
|
|
564
826
|
# `Membership` resource.
|
565
827
|
#
|
566
828
|
# Requires [user
|
567
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
829
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
830
|
+
# with an [authorization
|
831
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes)
|
832
|
+
# appropriate for reading the requested data:
|
833
|
+
#
|
834
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
835
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
836
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
837
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
838
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
|
839
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
840
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
841
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
842
|
+
#
|
568
843
|
# To list events, the authenticated user must be a member of the space.
|
569
844
|
#
|
570
845
|
# For an example, see [List events from a Google Chat
|
@@ -575,14 +850,22 @@ module Google
|
|
575
850
|
# setting](https://developers.google.com/workspace/chat/get-space-notification-setting).
|
576
851
|
#
|
577
852
|
# Requires [user
|
578
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
853
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
854
|
+
# with the [authorization
|
855
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
856
|
+
#
|
857
|
+
# - `https://www.googleapis.com/auth/chat.users.spacesettings`
|
579
858
|
rpc :GetSpaceNotificationSetting, ::Google::Apps::Chat::V1::GetSpaceNotificationSettingRequest, ::Google::Apps::Chat::V1::SpaceNotificationSetting
|
580
859
|
# Updates the space notification setting. For an example, see [Update
|
581
860
|
# the caller's space notification
|
582
861
|
# setting](https://developers.google.com/workspace/chat/update-space-notification-setting).
|
583
862
|
#
|
584
863
|
# Requires [user
|
585
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
864
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
865
|
+
# with the [authorization
|
866
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
867
|
+
#
|
868
|
+
# - `https://www.googleapis.com/auth/chat.users.spacesettings`
|
586
869
|
rpc :UpdateSpaceNotificationSetting, ::Google::Apps::Chat::V1::UpdateSpaceNotificationSettingRequest, ::Google::Apps::Chat::V1::SpaceNotificationSetting
|
587
870
|
end
|
588
871
|
|