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
@@ -363,10 +363,21 @@ module Google
|
|
363
363
|
# Creates a message in a Google Chat space. For an example, see [Send a
|
364
364
|
# message](https://developers.google.com/workspace/chat/create-messages).
|
365
365
|
#
|
366
|
-
#
|
366
|
+
# Supports the following types of
|
367
|
+
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
368
|
+
#
|
369
|
+
# - [App
|
370
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
371
|
+
# with the authorization scope:
|
372
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
373
|
+
# - [User
|
367
374
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
368
|
-
#
|
369
|
-
#
|
375
|
+
# with one of the following authorization scopes:
|
376
|
+
# - `https://www.googleapis.com/auth/chat.messages.create`
|
377
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
378
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
379
|
+
# only)
|
380
|
+
#
|
370
381
|
# Chat attributes the message sender differently depending on the type of
|
371
382
|
# authentication that you use in your request.
|
372
383
|
#
|
@@ -527,7 +538,13 @@ module Google
|
|
527
538
|
# messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
|
528
539
|
#
|
529
540
|
# Requires [user
|
530
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
541
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
542
|
+
# with one of the following [authorization
|
543
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
544
|
+
#
|
545
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
546
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
547
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
531
548
|
#
|
532
549
|
# @overload list_messages(request, options = nil)
|
533
550
|
# Pass arguments to `list_messages` via a request object, either of type
|
@@ -705,11 +722,23 @@ module Google
|
|
705
722
|
#
|
706
723
|
# - [App
|
707
724
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
725
|
+
# with one of the following authorization scopes:
|
726
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
727
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships` (requires
|
728
|
+
# [administrator approval](https://support.google.com/a?p=chat-app-auth))
|
708
729
|
#
|
709
730
|
# - [User
|
710
731
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
711
|
-
#
|
712
|
-
#
|
732
|
+
# with one of the following authorization scopes:
|
733
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
734
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
735
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
736
|
+
# only)
|
737
|
+
# - User authentication grants administrator privileges when an
|
738
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
739
|
+
# one of the following authorization scopes is used:
|
740
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships.readonly`
|
741
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
713
742
|
#
|
714
743
|
# @overload list_memberships(request, options = nil)
|
715
744
|
# Pass arguments to `list_memberships` via a request object, either of type
|
@@ -897,11 +926,21 @@ module Google
|
|
897
926
|
#
|
898
927
|
# - [App
|
899
928
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
929
|
+
# with one of the following authorization scopes:
|
930
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
931
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships` (requires
|
932
|
+
# [administrator approval](https://support.google.com/a?p=chat-app-auth))
|
900
933
|
#
|
901
934
|
# - [User
|
902
935
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
903
|
-
#
|
904
|
-
#
|
936
|
+
# with one of the following authorization scopes:
|
937
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
938
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
939
|
+
# - User authentication grants administrator privileges when an
|
940
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
941
|
+
# one of the following authorization scopes is used:
|
942
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships.readonly`
|
943
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
905
944
|
#
|
906
945
|
# @overload get_membership(request, options = nil)
|
907
946
|
# Pass arguments to `get_membership` via a request object, either of type
|
@@ -1018,9 +1057,14 @@ module Google
|
|
1018
1057
|
#
|
1019
1058
|
# - [App
|
1020
1059
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1060
|
+
# with the authorization scope:
|
1061
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1021
1062
|
#
|
1022
1063
|
# - [User
|
1023
1064
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1065
|
+
# with one of the following authorization scopes:
|
1066
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
1067
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
1024
1068
|
#
|
1025
1069
|
# Note: Might return a message from a blocked member or space.
|
1026
1070
|
#
|
@@ -1126,9 +1170,15 @@ module Google
|
|
1126
1170
|
#
|
1127
1171
|
# - [App
|
1128
1172
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1173
|
+
# with the authorization scope:
|
1174
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1129
1175
|
#
|
1130
1176
|
# - [User
|
1131
1177
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1178
|
+
# with one of the following authorization scopes:
|
1179
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
1180
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
1181
|
+
# only)
|
1132
1182
|
#
|
1133
1183
|
# When using app authentication, requests can only update messages
|
1134
1184
|
# created by the calling Chat app.
|
@@ -1248,9 +1298,15 @@ module Google
|
|
1248
1298
|
#
|
1249
1299
|
# - [App
|
1250
1300
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1301
|
+
# with the authorization scope:
|
1302
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1251
1303
|
#
|
1252
1304
|
# - [User
|
1253
1305
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1306
|
+
# with one of the following authorization scopes:
|
1307
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
1308
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
1309
|
+
# only)
|
1254
1310
|
#
|
1255
1311
|
# When using app authentication, requests can only delete messages
|
1256
1312
|
# created by the calling Chat app.
|
@@ -1359,8 +1415,13 @@ module Google
|
|
1359
1415
|
# For an example, see
|
1360
1416
|
# [Get metadata about a message
|
1361
1417
|
# attachment](https://developers.google.com/workspace/chat/get-media-attachments).
|
1418
|
+
#
|
1362
1419
|
# Requires [app
|
1363
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1420
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1421
|
+
# with the [authorization
|
1422
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
1423
|
+
#
|
1424
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1364
1425
|
#
|
1365
1426
|
# @overload get_attachment(request, options = nil)
|
1366
1427
|
# Pass arguments to `get_attachment` via a request object, either of type
|
@@ -1451,7 +1512,13 @@ module Google
|
|
1451
1512
|
# attachment](https://developers.google.com/workspace/chat/upload-media-attachments).
|
1452
1513
|
#
|
1453
1514
|
# Requires user
|
1454
|
-
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1515
|
+
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1516
|
+
# with one of the following [authorization
|
1517
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
1518
|
+
#
|
1519
|
+
# - `https://www.googleapis.com/auth/chat.messages.create`
|
1520
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
1521
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
1455
1522
|
#
|
1456
1523
|
# You can upload attachments up to 200 MB. Certain file types aren't
|
1457
1524
|
# supported. For details, see [File types blocked by Google
|
@@ -1553,9 +1620,14 @@ module Google
|
|
1553
1620
|
#
|
1554
1621
|
# - [App
|
1555
1622
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1623
|
+
# with the authorization scope:
|
1624
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1556
1625
|
#
|
1557
1626
|
# - [User
|
1558
1627
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1628
|
+
# with one of the following authorization scopes:
|
1629
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
1630
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
1559
1631
|
#
|
1560
1632
|
# To list all named spaces by Google Workspace organization, use the
|
1561
1633
|
# [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
|
@@ -1681,7 +1753,13 @@ module Google
|
|
1681
1753
|
#
|
1682
1754
|
# Requires [user
|
1683
1755
|
# authentication with administrator
|
1684
|
-
# privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges)
|
1756
|
+
# privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges)
|
1757
|
+
# and one of the following [authorization
|
1758
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
1759
|
+
#
|
1760
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces.readonly`
|
1761
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces`
|
1762
|
+
#
|
1685
1763
|
# In the request, set `use_admin_access` to `true`.
|
1686
1764
|
#
|
1687
1765
|
# @overload search_spaces(request, options = nil)
|
@@ -1895,11 +1973,29 @@ module Google
|
|
1895
1973
|
#
|
1896
1974
|
# - [App
|
1897
1975
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1976
|
+
# with one of the following authorization scopes:
|
1977
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1978
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator
|
1979
|
+
# approval](https://support.google.com/a?p=chat-app-auth)
|
1898
1980
|
#
|
1899
1981
|
# - [User
|
1900
1982
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1901
|
-
#
|
1902
|
-
#
|
1983
|
+
# with one of the following authorization scopes:
|
1984
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
1985
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
1986
|
+
# - User authentication grants administrator privileges when an
|
1987
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
1988
|
+
# one of the following authorization scopes is used:
|
1989
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces.readonly`
|
1990
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces`
|
1991
|
+
#
|
1992
|
+
# App authentication has the following limitations:
|
1993
|
+
#
|
1994
|
+
# - `space.access_settings` is only populated when using the
|
1995
|
+
# `chat.app.spaces` scope.
|
1996
|
+
# - `space.predefind_permission_settings` and `space.permission_settings` are
|
1997
|
+
# only populated when using the `chat.app.spaces` scope, and only for
|
1998
|
+
# spaces the app created.
|
1903
1999
|
#
|
1904
2000
|
# @overload get_space(request, options = nil)
|
1905
2001
|
# Pass arguments to `get_space` via a request object, either of type
|
@@ -1996,28 +2092,49 @@ module Google
|
|
1996
2092
|
end
|
1997
2093
|
|
1998
2094
|
##
|
1999
|
-
# Creates a space
|
2095
|
+
# Creates a space. Can be used to create a named space, or a
|
2000
2096
|
# group chat in `Import mode`. For an example, see [Create a
|
2001
2097
|
# space](https://developers.google.com/workspace/chat/create-spaces).
|
2002
2098
|
#
|
2003
|
-
# If you receive the error message `ALREADY_EXISTS` when creating
|
2004
|
-
# a space, try a different `displayName`. An existing space within
|
2005
|
-
# the Google Workspace organization might already use this display name.
|
2006
|
-
#
|
2007
2099
|
# Supports the following types of
|
2008
2100
|
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
2009
2101
|
#
|
2010
2102
|
# - [App
|
2011
2103
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2012
2104
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
2013
|
-
#
|
2105
|
+
# and one of the following authorization scopes:
|
2106
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces.create`
|
2107
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces`
|
2014
2108
|
#
|
2015
2109
|
# - [User
|
2016
2110
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2111
|
+
# with one of the following authorization scopes:
|
2112
|
+
# - `https://www.googleapis.com/auth/chat.spaces.create`
|
2113
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
2114
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
2115
|
+
# only)
|
2017
2116
|
#
|
2018
2117
|
# When authenticating as an app, the `space.customer` field must be set in
|
2019
2118
|
# the request.
|
2020
2119
|
#
|
2120
|
+
# When authenticating as an app, the Chat app is added as a member of the
|
2121
|
+
# space. However, unlike human authentication, the Chat app is not added as a
|
2122
|
+
# space manager. By default, the Chat app can be removed from the space by
|
2123
|
+
# all space members. To allow only space managers to remove the app from a
|
2124
|
+
# space, set `space.permission_settings.manage_apps` to `managers_allowed`.
|
2125
|
+
#
|
2126
|
+
# Space membership upon creation depends on whether the space is created in
|
2127
|
+
# `Import mode`:
|
2128
|
+
#
|
2129
|
+
# * **Import mode:** No members are created.
|
2130
|
+
# * **All other modes:** The calling user is added as a member. This is:
|
2131
|
+
# * The app itself when using app authentication.
|
2132
|
+
# * The human user when using user authentication.
|
2133
|
+
#
|
2134
|
+
# If you receive the error message `ALREADY_EXISTS` when creating
|
2135
|
+
# a space, try a different `displayName`. An existing space within
|
2136
|
+
# the Google Workspace organization might already use this display name.
|
2137
|
+
#
|
2021
2138
|
# @overload create_space(request, options = nil)
|
2022
2139
|
# Pass arguments to `create_space` via a request object, either of type
|
2023
2140
|
# {::Google::Apps::Chat::V1::CreateSpaceRequest} or an equivalent Hash.
|
@@ -2161,7 +2278,12 @@ module Google
|
|
2161
2278
|
# might already use this display name.
|
2162
2279
|
#
|
2163
2280
|
# Requires [user
|
2164
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2281
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2282
|
+
# with one of the following [authorization
|
2283
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
2284
|
+
#
|
2285
|
+
# - `https://www.googleapis.com/auth/chat.spaces.create`
|
2286
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
2165
2287
|
#
|
2166
2288
|
# @overload set_up_space(request, options = nil)
|
2167
2289
|
# Pass arguments to `set_up_space` via a request object, either of type
|
@@ -2213,7 +2335,7 @@ module Google
|
|
2213
2335
|
# Optional. The Google Chat users or groups to invite to join the space. Omit
|
2214
2336
|
# the calling user, as they are added automatically.
|
2215
2337
|
#
|
2216
|
-
# The set currently allows up to
|
2338
|
+
# The set currently allows up to 49 memberships (in addition to the caller).
|
2217
2339
|
#
|
2218
2340
|
# For human membership, the `Membership.member` field must contain a `user`
|
2219
2341
|
# with `name` populated (format: `users/{user}`) and `type` set to
|
@@ -2311,12 +2433,26 @@ module Google
|
|
2311
2433
|
# - [App
|
2312
2434
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2313
2435
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
2314
|
-
#
|
2436
|
+
# and one of the following authorization scopes:
|
2437
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces`
|
2315
2438
|
#
|
2316
2439
|
# - [User
|
2317
2440
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2318
|
-
#
|
2319
|
-
#
|
2441
|
+
# with one of the following authorization scopes:
|
2442
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
2443
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
2444
|
+
# only)
|
2445
|
+
# - User authentication grants administrator privileges when an
|
2446
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
2447
|
+
# the following authorization scopes is used:
|
2448
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces`
|
2449
|
+
#
|
2450
|
+
# App authentication has the following limitations:
|
2451
|
+
#
|
2452
|
+
# - To update either `space.predefined_permission_settings` or
|
2453
|
+
# `space.permission_settings`, the app must be the space creator.
|
2454
|
+
# - Updating the `space.access_settings.audience` is not supported for app
|
2455
|
+
# authentication.
|
2320
2456
|
#
|
2321
2457
|
# @overload update_space(request, options = nil)
|
2322
2458
|
# Pass arguments to `update_space` via a request object, either of type
|
@@ -2489,13 +2625,22 @@ module Google
|
|
2489
2625
|
#
|
2490
2626
|
# - [App
|
2491
2627
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2492
|
-
# with [administrator
|
2493
|
-
#
|
2628
|
+
# with [administrator
|
2629
|
+
# approval](https://support.google.com/a?p=chat-app-auth) and the
|
2630
|
+
# authorization scope:
|
2631
|
+
# - `https://www.googleapis.com/auth/chat.app.delete` (only in
|
2632
|
+
# spaces the app created)
|
2494
2633
|
#
|
2495
2634
|
# - [User
|
2496
2635
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2497
|
-
#
|
2498
|
-
#
|
2636
|
+
# with one of the following authorization scopes:
|
2637
|
+
# - `https://www.googleapis.com/auth/chat.delete`
|
2638
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
2639
|
+
# only)
|
2640
|
+
# - User authentication grants administrator privileges when an
|
2641
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
2642
|
+
# the following authorization scope is used:
|
2643
|
+
# - `https://www.googleapis.com/auth/chat.admin.delete`
|
2499
2644
|
#
|
2500
2645
|
# @overload delete_space(request, options = nil)
|
2501
2646
|
# Pass arguments to `delete_space` via a request object, either of type
|
@@ -2596,9 +2741,14 @@ module Google
|
|
2596
2741
|
# [import process](https://developers.google.com/workspace/chat/import-data)
|
2597
2742
|
# for the specified space and makes it visible to users.
|
2598
2743
|
#
|
2599
|
-
# Requires [
|
2600
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-
|
2601
|
-
# and domain-wide delegation
|
2744
|
+
# Requires [user
|
2745
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2746
|
+
# and domain-wide delegation with the [authorization
|
2747
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
2748
|
+
#
|
2749
|
+
# - `https://www.googleapis.com/auth/chat.import`
|
2750
|
+
#
|
2751
|
+
# For more information, see [Authorize Google
|
2602
2752
|
# Chat apps to import
|
2603
2753
|
# data](https://developers.google.com/workspace/chat/authorize-import).
|
2604
2754
|
#
|
@@ -2702,14 +2852,19 @@ module Google
|
|
2702
2852
|
# returns the direct message space between the specified user and the
|
2703
2853
|
# authenticated user.
|
2704
2854
|
#
|
2705
|
-
#
|
2855
|
+
# Supports the following types of
|
2706
2856
|
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
2707
2857
|
#
|
2708
2858
|
# - [App
|
2709
2859
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2860
|
+
# with the authorization scope:
|
2861
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
2710
2862
|
#
|
2711
2863
|
# - [User
|
2712
2864
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2865
|
+
# with one of the following authorization scopes:
|
2866
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
2867
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
2713
2868
|
#
|
2714
2869
|
# @overload find_direct_message(request, options = nil)
|
2715
2870
|
# Pass arguments to `find_direct_message` via a request object, either of type
|
@@ -2811,21 +2966,35 @@ module Google
|
|
2811
2966
|
# - [App
|
2812
2967
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2813
2968
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
2814
|
-
#
|
2969
|
+
# and the authorization scope:
|
2970
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships`
|
2815
2971
|
#
|
2816
2972
|
# - [User
|
2817
2973
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2818
|
-
#
|
2819
|
-
#
|
2974
|
+
# with one of the following authorization scopes:
|
2975
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
2976
|
+
# - `https://www.googleapis.com/auth/chat.memberships.app` (to add the
|
2977
|
+
# calling app to the space)
|
2978
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
2979
|
+
# only)
|
2980
|
+
# - User authentication grants administrator privileges when an
|
2981
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
2982
|
+
# the following authorization scope is used:
|
2983
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
2984
|
+
#
|
2985
|
+
# App authentication is not supported for the following use cases:
|
2986
|
+
#
|
2987
|
+
# - Inviting users external to the Workspace organization that owns the
|
2988
|
+
# space.
|
2989
|
+
# - Adding a Google Group to a space.
|
2990
|
+
# - Adding a Chat app to a space.
|
2820
2991
|
#
|
2821
2992
|
# For example usage, see:
|
2822
2993
|
#
|
2823
2994
|
# - [Invite or add a user to a
|
2824
2995
|
# space](https://developers.google.com/workspace/chat/create-members#create-user-membership).
|
2825
|
-
#
|
2826
2996
|
# - [Invite or add a Google Group to a
|
2827
2997
|
# space](https://developers.google.com/workspace/chat/create-members#create-group-membership).
|
2828
|
-
#
|
2829
2998
|
# - [Add the Chat app to a
|
2830
2999
|
# space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
|
2831
3000
|
#
|
@@ -2866,8 +3035,6 @@ module Google
|
|
2866
3035
|
# - When [authenticating as an
|
2867
3036
|
# app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
|
2868
3037
|
# the `chat.app.memberships` authorization scope is required.
|
2869
|
-
# Authenticating as an app is available in [Developer
|
2870
|
-
# Preview](https://developers.google.com/workspace/preview).
|
2871
3038
|
#
|
2872
3039
|
# - Set `user.type` to `HUMAN`, and set `user.name` with format
|
2873
3040
|
# `users/{user}`, where `{user}` can be the email address for the user. For
|
@@ -2975,13 +3142,22 @@ module Google
|
|
2975
3142
|
#
|
2976
3143
|
# - [App
|
2977
3144
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2978
|
-
# with [administrator
|
2979
|
-
#
|
3145
|
+
# with [administrator
|
3146
|
+
# approval](https://support.google.com/a?p=chat-app-auth) and the
|
3147
|
+
# authorization scope:
|
3148
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships` (only in
|
3149
|
+
# spaces the app created)
|
2980
3150
|
#
|
2981
3151
|
# - [User
|
2982
3152
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2983
|
-
#
|
2984
|
-
#
|
3153
|
+
# with one of the following authorization scopes:
|
3154
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
3155
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
3156
|
+
# only)
|
3157
|
+
# - User authentication grants administrator privileges when an
|
3158
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
3159
|
+
# the following authorization scope is used:
|
3160
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
2985
3161
|
#
|
2986
3162
|
# @overload update_membership(request, options = nil)
|
2987
3163
|
# Pass arguments to `update_membership` via a request object, either of type
|
@@ -3094,12 +3270,31 @@ module Google
|
|
3094
3270
|
# - [App
|
3095
3271
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
3096
3272
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
3097
|
-
#
|
3273
|
+
# and the authorization scope:
|
3274
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships`
|
3098
3275
|
#
|
3099
3276
|
# - [User
|
3100
3277
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3101
|
-
#
|
3102
|
-
#
|
3278
|
+
# with one of the following authorization scopes:
|
3279
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
3280
|
+
# - `https://www.googleapis.com/auth/chat.memberships.app` (to remove
|
3281
|
+
# the calling app from the space)
|
3282
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
3283
|
+
# only)
|
3284
|
+
# - User authentication grants administrator privileges when an
|
3285
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
3286
|
+
# the following authorization scope is used:
|
3287
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
3288
|
+
#
|
3289
|
+
# App authentication is not supported for the following use cases:
|
3290
|
+
#
|
3291
|
+
# - Removing a Google Group from a space.
|
3292
|
+
# - Removing a Chat app from a space.
|
3293
|
+
#
|
3294
|
+
# To delete memberships for space managers, the requester
|
3295
|
+
# must be a space manager. If you're using [app
|
3296
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
3297
|
+
# the Chat app must be the space creator.
|
3103
3298
|
#
|
3104
3299
|
# @overload delete_membership(request, options = nil)
|
3105
3300
|
# Pass arguments to `delete_membership` via a request object, either of type
|
@@ -3121,9 +3316,13 @@ module Google
|
|
3121
3316
|
# human users' or their own memberships. Chat apps can't delete other apps'
|
3122
3317
|
# memberships.
|
3123
3318
|
#
|
3124
|
-
# When deleting a human membership, requires the `chat.memberships` scope
|
3125
|
-
#
|
3126
|
-
#
|
3319
|
+
# When deleting a human membership, requires the `chat.memberships` scope
|
3320
|
+
# with [user
|
3321
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3322
|
+
# or the `chat.memberships.app` scope with [app
|
3323
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
3324
|
+
# and the `spaces/{space}/members/{member}` format.
|
3325
|
+
# You can use the email as an alias for `{member}`. For example,
|
3127
3326
|
# `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the
|
3128
3327
|
# email of the Google Chat user.
|
3129
3328
|
#
|
@@ -3214,7 +3413,14 @@ module Google
|
|
3214
3413
|
# message](https://developers.google.com/workspace/chat/create-reactions).
|
3215
3414
|
#
|
3216
3415
|
# Requires [user
|
3217
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3416
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3417
|
+
# with one of the following [authorization
|
3418
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3419
|
+
#
|
3420
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.create`
|
3421
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
3422
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
3423
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
3218
3424
|
#
|
3219
3425
|
# @overload create_reaction(request, options = nil)
|
3220
3426
|
# Pass arguments to `create_reaction` via a request object, either of type
|
@@ -3308,7 +3514,14 @@ module Google
|
|
3308
3514
|
# message](https://developers.google.com/workspace/chat/list-reactions).
|
3309
3515
|
#
|
3310
3516
|
# Requires [user
|
3311
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3517
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3518
|
+
# with one of the following [authorization
|
3519
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3520
|
+
#
|
3521
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
|
3522
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
3523
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
3524
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
3312
3525
|
#
|
3313
3526
|
# @overload list_reactions(request, options = nil)
|
3314
3527
|
# Pass arguments to `list_reactions` via a request object, either of type
|
@@ -3462,7 +3675,13 @@ module Google
|
|
3462
3675
|
# reaction](https://developers.google.com/workspace/chat/delete-reactions).
|
3463
3676
|
#
|
3464
3677
|
# Requires [user
|
3465
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3678
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3679
|
+
# with one of the following [authorization
|
3680
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3681
|
+
#
|
3682
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
3683
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
3684
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
3466
3685
|
#
|
3467
3686
|
# @overload delete_reaction(request, options = nil)
|
3468
3687
|
# Pass arguments to `delete_reaction` via a request object, either of type
|
@@ -3559,7 +3778,11 @@ module Google
|
|
3559
3778
|
# permissions](https://support.google.com/a/answer/12850085).
|
3560
3779
|
#
|
3561
3780
|
# Requires [user
|
3562
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3781
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3782
|
+
# with the [authorization
|
3783
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3784
|
+
#
|
3785
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
3563
3786
|
#
|
3564
3787
|
# @overload create_custom_emoji(request, options = nil)
|
3565
3788
|
# Pass arguments to `create_custom_emoji` via a request object, either of type
|
@@ -3646,7 +3869,12 @@ module Google
|
|
3646
3869
|
# permissions](https://support.google.com/a/answer/12850085).
|
3647
3870
|
#
|
3648
3871
|
# Requires [user
|
3649
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3872
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3873
|
+
# with one of the following [authorization
|
3874
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3875
|
+
#
|
3876
|
+
# - `https://www.googleapis.com/auth/chat.customemojis.readonly`
|
3877
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
3650
3878
|
#
|
3651
3879
|
# @overload get_custom_emoji(request, options = nil)
|
3652
3880
|
# Pass arguments to `get_custom_emoji` via a request object, either of type
|
@@ -3747,7 +3975,12 @@ module Google
|
|
3747
3975
|
# permissions](https://support.google.com/a/answer/12850085).
|
3748
3976
|
#
|
3749
3977
|
# Requires [user
|
3750
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3978
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3979
|
+
# with one of the following [authorization
|
3980
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3981
|
+
#
|
3982
|
+
# - `https://www.googleapis.com/auth/chat.customemojis.readonly`
|
3983
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
3751
3984
|
#
|
3752
3985
|
# @overload list_custom_emojis(request, options = nil)
|
3753
3986
|
# Pass arguments to `list_custom_emojis` via a request object, either of type
|
@@ -3870,7 +4103,11 @@ module Google
|
|
3870
4103
|
# permissions](https://support.google.com/a/answer/12850085).
|
3871
4104
|
#
|
3872
4105
|
# Requires [user
|
3873
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4106
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4107
|
+
# with the [authorization
|
4108
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4109
|
+
#
|
4110
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
3874
4111
|
#
|
3875
4112
|
# @overload delete_custom_emoji(request, options = nil)
|
3876
4113
|
# Pass arguments to `delete_custom_emoji` via a request object, either of type
|
@@ -3967,7 +4204,12 @@ module Google
|
|
3967
4204
|
# state](https://developers.google.com/workspace/chat/get-space-read-state).
|
3968
4205
|
#
|
3969
4206
|
# Requires [user
|
3970
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4207
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4208
|
+
# with one of the following [authorization
|
4209
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4210
|
+
#
|
4211
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
|
4212
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate`
|
3971
4213
|
#
|
3972
4214
|
# @overload get_space_read_state(request, options = nil)
|
3973
4215
|
# Pass arguments to `get_space_read_state` via a request object, either of type
|
@@ -4071,7 +4313,11 @@ module Google
|
|
4071
4313
|
# state](https://developers.google.com/workspace/chat/update-space-read-state).
|
4072
4314
|
#
|
4073
4315
|
# Requires [user
|
4074
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4316
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4317
|
+
# with the [authorization
|
4318
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4319
|
+
#
|
4320
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate`
|
4075
4321
|
#
|
4076
4322
|
# @overload update_space_read_state(request, options = nil)
|
4077
4323
|
# Pass arguments to `update_space_read_state` via a request object, either of type
|
@@ -4190,7 +4436,12 @@ module Google
|
|
4190
4436
|
# state](https://developers.google.com/workspace/chat/get-thread-read-state).
|
4191
4437
|
#
|
4192
4438
|
# Requires [user
|
4193
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4439
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4440
|
+
# with one of the following [authorization
|
4441
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4442
|
+
#
|
4443
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
|
4444
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate`
|
4194
4445
|
#
|
4195
4446
|
# @overload get_thread_read_state(request, options = nil)
|
4196
4447
|
# Pass arguments to `get_thread_read_state` via a request object, either of type
|
@@ -4301,7 +4552,20 @@ module Google
|
|
4301
4552
|
# object of the Space event data for this request.
|
4302
4553
|
#
|
4303
4554
|
# Requires [user
|
4304
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4555
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4556
|
+
# with an [authorization
|
4557
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes)
|
4558
|
+
# appropriate for reading the requested data:
|
4559
|
+
#
|
4560
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
4561
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
4562
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
4563
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
4564
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
|
4565
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
4566
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
4567
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
4568
|
+
#
|
4305
4569
|
# To get an event, the authenticated user must be a member of the space.
|
4306
4570
|
#
|
4307
4571
|
# For an example, see [Get details about an
|
@@ -4402,7 +4666,20 @@ module Google
|
|
4402
4666
|
# `Membership` resource.
|
4403
4667
|
#
|
4404
4668
|
# Requires [user
|
4405
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4669
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4670
|
+
# with an [authorization
|
4671
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes)
|
4672
|
+
# appropriate for reading the requested data:
|
4673
|
+
#
|
4674
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
4675
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
4676
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
4677
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
4678
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
|
4679
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
4680
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
4681
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
4682
|
+
#
|
4406
4683
|
# To list events, the authenticated user must be a member of the space.
|
4407
4684
|
#
|
4408
4685
|
# For an example, see [List events from a Google Chat
|
@@ -4571,7 +4848,11 @@ module Google
|
|
4571
4848
|
# setting](https://developers.google.com/workspace/chat/get-space-notification-setting).
|
4572
4849
|
#
|
4573
4850
|
# Requires [user
|
4574
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4851
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4852
|
+
# with the [authorization
|
4853
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4854
|
+
#
|
4855
|
+
# - `https://www.googleapis.com/auth/chat.users.spacesettings`
|
4575
4856
|
#
|
4576
4857
|
# @overload get_space_notification_setting(request, options = nil)
|
4577
4858
|
# Pass arguments to `get_space_notification_setting` via a request object, either of type
|
@@ -4666,7 +4947,11 @@ module Google
|
|
4666
4947
|
# setting](https://developers.google.com/workspace/chat/update-space-notification-setting).
|
4667
4948
|
#
|
4668
4949
|
# Requires [user
|
4669
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4950
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4951
|
+
# with the [authorization
|
4952
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4953
|
+
#
|
4954
|
+
# - `https://www.googleapis.com/auth/chat.users.spacesettings`
|
4670
4955
|
#
|
4671
4956
|
# @overload update_space_notification_setting(request, options = nil)
|
4672
4957
|
# Pass arguments to `update_space_notification_setting` via a request object, either of type
|