google-apps-chat-v1 0.12.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/annotation_pb.rb +6 -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/annotation.rb +88 -7
- 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/message.rb +3 -1
- 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 +2 -2
@@ -356,10 +356,21 @@ module Google
|
|
356
356
|
# Creates a message in a Google Chat space. For an example, see [Send a
|
357
357
|
# message](https://developers.google.com/workspace/chat/create-messages).
|
358
358
|
#
|
359
|
-
#
|
359
|
+
# Supports the following types of
|
360
|
+
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
361
|
+
#
|
362
|
+
# - [App
|
363
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
364
|
+
# with the authorization scope:
|
365
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
366
|
+
# - [User
|
360
367
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
361
|
-
#
|
362
|
-
#
|
368
|
+
# with one of the following authorization scopes:
|
369
|
+
# - `https://www.googleapis.com/auth/chat.messages.create`
|
370
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
371
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
372
|
+
# only)
|
373
|
+
#
|
363
374
|
# Chat attributes the message sender differently depending on the type of
|
364
375
|
# authentication that you use in your request.
|
365
376
|
#
|
@@ -513,7 +524,13 @@ module Google
|
|
513
524
|
# messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
|
514
525
|
#
|
515
526
|
# Requires [user
|
516
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
527
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
528
|
+
# with one of the following [authorization
|
529
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
530
|
+
#
|
531
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
532
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
533
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
517
534
|
#
|
518
535
|
# @overload list_messages(request, options = nil)
|
519
536
|
# Pass arguments to `list_messages` via a request object, either of type
|
@@ -684,11 +701,23 @@ module Google
|
|
684
701
|
#
|
685
702
|
# - [App
|
686
703
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
704
|
+
# with one of the following authorization scopes:
|
705
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
706
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships` (requires
|
707
|
+
# [administrator approval](https://support.google.com/a?p=chat-app-auth))
|
687
708
|
#
|
688
709
|
# - [User
|
689
710
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
690
|
-
#
|
691
|
-
#
|
711
|
+
# with one of the following authorization scopes:
|
712
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
713
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
714
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
715
|
+
# only)
|
716
|
+
# - User authentication grants administrator privileges when an
|
717
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
718
|
+
# one of the following authorization scopes is used:
|
719
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships.readonly`
|
720
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
692
721
|
#
|
693
722
|
# @overload list_memberships(request, options = nil)
|
694
723
|
# Pass arguments to `list_memberships` via a request object, either of type
|
@@ -869,11 +898,21 @@ module Google
|
|
869
898
|
#
|
870
899
|
# - [App
|
871
900
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
901
|
+
# with one of the following authorization scopes:
|
902
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
903
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships` (requires
|
904
|
+
# [administrator approval](https://support.google.com/a?p=chat-app-auth))
|
872
905
|
#
|
873
906
|
# - [User
|
874
907
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
875
|
-
#
|
876
|
-
#
|
908
|
+
# with one of the following authorization scopes:
|
909
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
910
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
911
|
+
# - User authentication grants administrator privileges when an
|
912
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
913
|
+
# one of the following authorization scopes is used:
|
914
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships.readonly`
|
915
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
877
916
|
#
|
878
917
|
# @overload get_membership(request, options = nil)
|
879
918
|
# Pass arguments to `get_membership` via a request object, either of type
|
@@ -983,9 +1022,14 @@ module Google
|
|
983
1022
|
#
|
984
1023
|
# - [App
|
985
1024
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1025
|
+
# with the authorization scope:
|
1026
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
986
1027
|
#
|
987
1028
|
# - [User
|
988
1029
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1030
|
+
# with one of the following authorization scopes:
|
1031
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
1032
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
989
1033
|
#
|
990
1034
|
# Note: Might return a message from a blocked member or space.
|
991
1035
|
#
|
@@ -1084,9 +1128,15 @@ module Google
|
|
1084
1128
|
#
|
1085
1129
|
# - [App
|
1086
1130
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1131
|
+
# with the authorization scope:
|
1132
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1087
1133
|
#
|
1088
1134
|
# - [User
|
1089
1135
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1136
|
+
# with one of the following authorization scopes:
|
1137
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
1138
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
1139
|
+
# only)
|
1090
1140
|
#
|
1091
1141
|
# When using app authentication, requests can only update messages
|
1092
1142
|
# created by the calling Chat app.
|
@@ -1199,9 +1249,15 @@ module Google
|
|
1199
1249
|
#
|
1200
1250
|
# - [App
|
1201
1251
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1252
|
+
# with the authorization scope:
|
1253
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1202
1254
|
#
|
1203
1255
|
# - [User
|
1204
1256
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1257
|
+
# with one of the following authorization scopes:
|
1258
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
1259
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
1260
|
+
# only)
|
1205
1261
|
#
|
1206
1262
|
# When using app authentication, requests can only delete messages
|
1207
1263
|
# created by the calling Chat app.
|
@@ -1303,8 +1359,13 @@ module Google
|
|
1303
1359
|
# For an example, see
|
1304
1360
|
# [Get metadata about a message
|
1305
1361
|
# attachment](https://developers.google.com/workspace/chat/get-media-attachments).
|
1362
|
+
#
|
1306
1363
|
# Requires [app
|
1307
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1364
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1365
|
+
# with the [authorization
|
1366
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
1367
|
+
#
|
1368
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1308
1369
|
#
|
1309
1370
|
# @overload get_attachment(request, options = nil)
|
1310
1371
|
# Pass arguments to `get_attachment` via a request object, either of type
|
@@ -1388,7 +1449,13 @@ module Google
|
|
1388
1449
|
# attachment](https://developers.google.com/workspace/chat/upload-media-attachments).
|
1389
1450
|
#
|
1390
1451
|
# Requires user
|
1391
|
-
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1452
|
+
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1453
|
+
# with one of the following [authorization
|
1454
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
1455
|
+
#
|
1456
|
+
# - `https://www.googleapis.com/auth/chat.messages.create`
|
1457
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
1458
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
1392
1459
|
#
|
1393
1460
|
# You can upload attachments up to 200 MB. Certain file types aren't
|
1394
1461
|
# supported. For details, see [File types blocked by Google
|
@@ -1483,9 +1550,14 @@ module Google
|
|
1483
1550
|
#
|
1484
1551
|
# - [App
|
1485
1552
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1553
|
+
# with the authorization scope:
|
1554
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1486
1555
|
#
|
1487
1556
|
# - [User
|
1488
1557
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1558
|
+
# with one of the following authorization scopes:
|
1559
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
1560
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
1489
1561
|
#
|
1490
1562
|
# To list all named spaces by Google Workspace organization, use the
|
1491
1563
|
# [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
|
@@ -1612,7 +1684,13 @@ module Google
|
|
1612
1684
|
#
|
1613
1685
|
# Requires [user
|
1614
1686
|
# authentication with administrator
|
1615
|
-
# privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges)
|
1687
|
+
# privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges)
|
1688
|
+
# and one of the following [authorization
|
1689
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
1690
|
+
#
|
1691
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces.readonly`
|
1692
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces`
|
1693
|
+
#
|
1616
1694
|
# In the request, set `use_admin_access` to `true`.
|
1617
1695
|
#
|
1618
1696
|
# @overload search_spaces(request, options = nil)
|
@@ -1827,11 +1905,29 @@ module Google
|
|
1827
1905
|
#
|
1828
1906
|
# - [App
|
1829
1907
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1908
|
+
# with one of the following authorization scopes:
|
1909
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
1910
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator
|
1911
|
+
# approval](https://support.google.com/a?p=chat-app-auth)
|
1830
1912
|
#
|
1831
1913
|
# - [User
|
1832
1914
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
1833
|
-
#
|
1834
|
-
#
|
1915
|
+
# with one of the following authorization scopes:
|
1916
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
1917
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
1918
|
+
# - User authentication grants administrator privileges when an
|
1919
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
1920
|
+
# one of the following authorization scopes is used:
|
1921
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces.readonly`
|
1922
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces`
|
1923
|
+
#
|
1924
|
+
# App authentication has the following limitations:
|
1925
|
+
#
|
1926
|
+
# - `space.access_settings` is only populated when using the
|
1927
|
+
# `chat.app.spaces` scope.
|
1928
|
+
# - `space.predefind_permission_settings` and `space.permission_settings` are
|
1929
|
+
# only populated when using the `chat.app.spaces` scope, and only for
|
1930
|
+
# spaces the app created.
|
1835
1931
|
#
|
1836
1932
|
# @overload get_space(request, options = nil)
|
1837
1933
|
# Pass arguments to `get_space` via a request object, either of type
|
@@ -1921,28 +2017,49 @@ module Google
|
|
1921
2017
|
end
|
1922
2018
|
|
1923
2019
|
##
|
1924
|
-
# Creates a space
|
2020
|
+
# Creates a space. Can be used to create a named space, or a
|
1925
2021
|
# group chat in `Import mode`. For an example, see [Create a
|
1926
2022
|
# space](https://developers.google.com/workspace/chat/create-spaces).
|
1927
2023
|
#
|
1928
|
-
# If you receive the error message `ALREADY_EXISTS` when creating
|
1929
|
-
# a space, try a different `displayName`. An existing space within
|
1930
|
-
# the Google Workspace organization might already use this display name.
|
1931
|
-
#
|
1932
2024
|
# Supports the following types of
|
1933
2025
|
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
1934
2026
|
#
|
1935
2027
|
# - [App
|
1936
2028
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
1937
2029
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
1938
|
-
#
|
2030
|
+
# and one of the following authorization scopes:
|
2031
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces.create`
|
2032
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces`
|
1939
2033
|
#
|
1940
2034
|
# - [User
|
1941
2035
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2036
|
+
# with one of the following authorization scopes:
|
2037
|
+
# - `https://www.googleapis.com/auth/chat.spaces.create`
|
2038
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
2039
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
2040
|
+
# only)
|
1942
2041
|
#
|
1943
2042
|
# When authenticating as an app, the `space.customer` field must be set in
|
1944
2043
|
# the request.
|
1945
2044
|
#
|
2045
|
+
# When authenticating as an app, the Chat app is added as a member of the
|
2046
|
+
# space. However, unlike human authentication, the Chat app is not added as a
|
2047
|
+
# space manager. By default, the Chat app can be removed from the space by
|
2048
|
+
# all space members. To allow only space managers to remove the app from a
|
2049
|
+
# space, set `space.permission_settings.manage_apps` to `managers_allowed`.
|
2050
|
+
#
|
2051
|
+
# Space membership upon creation depends on whether the space is created in
|
2052
|
+
# `Import mode`:
|
2053
|
+
#
|
2054
|
+
# * **Import mode:** No members are created.
|
2055
|
+
# * **All other modes:** The calling user is added as a member. This is:
|
2056
|
+
# * The app itself when using app authentication.
|
2057
|
+
# * The human user when using user authentication.
|
2058
|
+
#
|
2059
|
+
# If you receive the error message `ALREADY_EXISTS` when creating
|
2060
|
+
# a space, try a different `displayName`. An existing space within
|
2061
|
+
# the Google Workspace organization might already use this display name.
|
2062
|
+
#
|
1946
2063
|
# @overload create_space(request, options = nil)
|
1947
2064
|
# Pass arguments to `create_space` via a request object, either of type
|
1948
2065
|
# {::Google::Apps::Chat::V1::CreateSpaceRequest} or an equivalent Hash.
|
@@ -2087,7 +2204,12 @@ module Google
|
|
2087
2204
|
# might already use this display name.
|
2088
2205
|
#
|
2089
2206
|
# Requires [user
|
2090
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2207
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2208
|
+
# with one of the following [authorization
|
2209
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
2210
|
+
#
|
2211
|
+
# - `https://www.googleapis.com/auth/chat.spaces.create`
|
2212
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
2091
2213
|
#
|
2092
2214
|
# @overload set_up_space(request, options = nil)
|
2093
2215
|
# Pass arguments to `set_up_space` via a request object, either of type
|
@@ -2139,7 +2261,7 @@ module Google
|
|
2139
2261
|
# Optional. The Google Chat users or groups to invite to join the space. Omit
|
2140
2262
|
# the calling user, as they are added automatically.
|
2141
2263
|
#
|
2142
|
-
# The set currently allows up to
|
2264
|
+
# The set currently allows up to 49 memberships (in addition to the caller).
|
2143
2265
|
#
|
2144
2266
|
# For human membership, the `Membership.member` field must contain a `user`
|
2145
2267
|
# with `name` populated (format: `users/{user}`) and `type` set to
|
@@ -2238,12 +2360,26 @@ module Google
|
|
2238
2360
|
# - [App
|
2239
2361
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2240
2362
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
2241
|
-
#
|
2363
|
+
# and one of the following authorization scopes:
|
2364
|
+
# - `https://www.googleapis.com/auth/chat.app.spaces`
|
2242
2365
|
#
|
2243
2366
|
# - [User
|
2244
2367
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2245
|
-
#
|
2246
|
-
#
|
2368
|
+
# with one of the following authorization scopes:
|
2369
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
2370
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
2371
|
+
# only)
|
2372
|
+
# - User authentication grants administrator privileges when an
|
2373
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
2374
|
+
# the following authorization scopes is used:
|
2375
|
+
# - `https://www.googleapis.com/auth/chat.admin.spaces`
|
2376
|
+
#
|
2377
|
+
# App authentication has the following limitations:
|
2378
|
+
#
|
2379
|
+
# - To update either `space.predefined_permission_settings` or
|
2380
|
+
# `space.permission_settings`, the app must be the space creator.
|
2381
|
+
# - Updating the `space.access_settings.audience` is not supported for app
|
2382
|
+
# authentication.
|
2247
2383
|
#
|
2248
2384
|
# @overload update_space(request, options = nil)
|
2249
2385
|
# Pass arguments to `update_space` via a request object, either of type
|
@@ -2409,13 +2545,22 @@ module Google
|
|
2409
2545
|
#
|
2410
2546
|
# - [App
|
2411
2547
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2412
|
-
# with [administrator
|
2413
|
-
#
|
2548
|
+
# with [administrator
|
2549
|
+
# approval](https://support.google.com/a?p=chat-app-auth) and the
|
2550
|
+
# authorization scope:
|
2551
|
+
# - `https://www.googleapis.com/auth/chat.app.delete` (only in
|
2552
|
+
# spaces the app created)
|
2414
2553
|
#
|
2415
2554
|
# - [User
|
2416
2555
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2417
|
-
#
|
2418
|
-
#
|
2556
|
+
# with one of the following authorization scopes:
|
2557
|
+
# - `https://www.googleapis.com/auth/chat.delete`
|
2558
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
2559
|
+
# only)
|
2560
|
+
# - User authentication grants administrator privileges when an
|
2561
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
2562
|
+
# the following authorization scope is used:
|
2563
|
+
# - `https://www.googleapis.com/auth/chat.admin.delete`
|
2419
2564
|
#
|
2420
2565
|
# @overload delete_space(request, options = nil)
|
2421
2566
|
# Pass arguments to `delete_space` via a request object, either of type
|
@@ -2509,9 +2654,14 @@ module Google
|
|
2509
2654
|
# [import process](https://developers.google.com/workspace/chat/import-data)
|
2510
2655
|
# for the specified space and makes it visible to users.
|
2511
2656
|
#
|
2512
|
-
# Requires [
|
2513
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-
|
2514
|
-
# and domain-wide delegation
|
2657
|
+
# Requires [user
|
2658
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2659
|
+
# and domain-wide delegation with the [authorization
|
2660
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
2661
|
+
#
|
2662
|
+
# - `https://www.googleapis.com/auth/chat.import`
|
2663
|
+
#
|
2664
|
+
# For more information, see [Authorize Google
|
2515
2665
|
# Chat apps to import
|
2516
2666
|
# data](https://developers.google.com/workspace/chat/authorize-import).
|
2517
2667
|
#
|
@@ -2608,14 +2758,19 @@ module Google
|
|
2608
2758
|
# returns the direct message space between the specified user and the
|
2609
2759
|
# authenticated user.
|
2610
2760
|
#
|
2611
|
-
#
|
2761
|
+
# Supports the following types of
|
2612
2762
|
# [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
|
2613
2763
|
#
|
2614
2764
|
# - [App
|
2615
2765
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2766
|
+
# with the authorization scope:
|
2767
|
+
# - `https://www.googleapis.com/auth/chat.bot`
|
2616
2768
|
#
|
2617
2769
|
# - [User
|
2618
2770
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2771
|
+
# with one of the following authorization scopes:
|
2772
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
2773
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
2619
2774
|
#
|
2620
2775
|
# @overload find_direct_message(request, options = nil)
|
2621
2776
|
# Pass arguments to `find_direct_message` via a request object, either of type
|
@@ -2718,21 +2873,35 @@ module Google
|
|
2718
2873
|
# - [App
|
2719
2874
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2720
2875
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
2721
|
-
#
|
2876
|
+
# and the authorization scope:
|
2877
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships`
|
2722
2878
|
#
|
2723
2879
|
# - [User
|
2724
2880
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2725
|
-
#
|
2726
|
-
#
|
2881
|
+
# with one of the following authorization scopes:
|
2882
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
2883
|
+
# - `https://www.googleapis.com/auth/chat.memberships.app` (to add the
|
2884
|
+
# calling app to the space)
|
2885
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
2886
|
+
# only)
|
2887
|
+
# - User authentication grants administrator privileges when an
|
2888
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
2889
|
+
# the following authorization scope is used:
|
2890
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
2891
|
+
#
|
2892
|
+
# App authentication is not supported for the following use cases:
|
2893
|
+
#
|
2894
|
+
# - Inviting users external to the Workspace organization that owns the
|
2895
|
+
# space.
|
2896
|
+
# - Adding a Google Group to a space.
|
2897
|
+
# - Adding a Chat app to a space.
|
2727
2898
|
#
|
2728
2899
|
# For example usage, see:
|
2729
2900
|
#
|
2730
2901
|
# - [Invite or add a user to a
|
2731
2902
|
# space](https://developers.google.com/workspace/chat/create-members#create-user-membership).
|
2732
|
-
#
|
2733
2903
|
# - [Invite or add a Google Group to a
|
2734
2904
|
# space](https://developers.google.com/workspace/chat/create-members#create-group-membership).
|
2735
|
-
#
|
2736
2905
|
# - [Add the Chat app to a
|
2737
2906
|
# space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
|
2738
2907
|
#
|
@@ -2773,8 +2942,6 @@ module Google
|
|
2773
2942
|
# - When [authenticating as an
|
2774
2943
|
# app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
|
2775
2944
|
# the `chat.app.memberships` authorization scope is required.
|
2776
|
-
# Authenticating as an app is available in [Developer
|
2777
|
-
# Preview](https://developers.google.com/workspace/preview).
|
2778
2945
|
#
|
2779
2946
|
# - Set `user.type` to `HUMAN`, and set `user.name` with format
|
2780
2947
|
# `users/{user}`, where `{user}` can be the email address for the user. For
|
@@ -2875,13 +3042,22 @@ module Google
|
|
2875
3042
|
#
|
2876
3043
|
# - [App
|
2877
3044
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2878
|
-
# with [administrator
|
2879
|
-
#
|
3045
|
+
# with [administrator
|
3046
|
+
# approval](https://support.google.com/a?p=chat-app-auth) and the
|
3047
|
+
# authorization scope:
|
3048
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships` (only in
|
3049
|
+
# spaces the app created)
|
2880
3050
|
#
|
2881
3051
|
# - [User
|
2882
3052
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2883
|
-
#
|
2884
|
-
#
|
3053
|
+
# with one of the following authorization scopes:
|
3054
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
3055
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
3056
|
+
# only)
|
3057
|
+
# - User authentication grants administrator privileges when an
|
3058
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
3059
|
+
# the following authorization scope is used:
|
3060
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
2885
3061
|
#
|
2886
3062
|
# @overload update_membership(request, options = nil)
|
2887
3063
|
# Pass arguments to `update_membership` via a request object, either of type
|
@@ -2987,12 +3163,31 @@ module Google
|
|
2987
3163
|
# - [App
|
2988
3164
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
2989
3165
|
# with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
2990
|
-
#
|
3166
|
+
# and the authorization scope:
|
3167
|
+
# - `https://www.googleapis.com/auth/chat.app.memberships`
|
2991
3168
|
#
|
2992
3169
|
# - [User
|
2993
3170
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
2994
|
-
#
|
2995
|
-
#
|
3171
|
+
# with one of the following authorization scopes:
|
3172
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
3173
|
+
# - `https://www.googleapis.com/auth/chat.memberships.app` (to remove
|
3174
|
+
# the calling app from the space)
|
3175
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces
|
3176
|
+
# only)
|
3177
|
+
# - User authentication grants administrator privileges when an
|
3178
|
+
# administrator account authenticates, `use_admin_access` is `true`, and
|
3179
|
+
# the following authorization scope is used:
|
3180
|
+
# - `https://www.googleapis.com/auth/chat.admin.memberships`
|
3181
|
+
#
|
3182
|
+
# App authentication is not supported for the following use cases:
|
3183
|
+
#
|
3184
|
+
# - Removing a Google Group from a space.
|
3185
|
+
# - Removing a Chat app from a space.
|
3186
|
+
#
|
3187
|
+
# To delete memberships for space managers, the requester
|
3188
|
+
# must be a space manager. If you're using [app
|
3189
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
3190
|
+
# the Chat app must be the space creator.
|
2996
3191
|
#
|
2997
3192
|
# @overload delete_membership(request, options = nil)
|
2998
3193
|
# Pass arguments to `delete_membership` via a request object, either of type
|
@@ -3014,9 +3209,13 @@ module Google
|
|
3014
3209
|
# human users' or their own memberships. Chat apps can't delete other apps'
|
3015
3210
|
# memberships.
|
3016
3211
|
#
|
3017
|
-
# When deleting a human membership, requires the `chat.memberships` scope
|
3018
|
-
#
|
3019
|
-
#
|
3212
|
+
# When deleting a human membership, requires the `chat.memberships` scope
|
3213
|
+
# with [user
|
3214
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3215
|
+
# or the `chat.memberships.app` scope with [app
|
3216
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
3217
|
+
# and the `spaces/{space}/members/{member}` format.
|
3218
|
+
# You can use the email as an alias for `{member}`. For example,
|
3020
3219
|
# `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the
|
3021
3220
|
# email of the Google Chat user.
|
3022
3221
|
#
|
@@ -3100,7 +3299,14 @@ module Google
|
|
3100
3299
|
# message](https://developers.google.com/workspace/chat/create-reactions).
|
3101
3300
|
#
|
3102
3301
|
# Requires [user
|
3103
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3302
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3303
|
+
# with one of the following [authorization
|
3304
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3305
|
+
#
|
3306
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.create`
|
3307
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
3308
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
3309
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
3104
3310
|
#
|
3105
3311
|
# @overload create_reaction(request, options = nil)
|
3106
3312
|
# Pass arguments to `create_reaction` via a request object, either of type
|
@@ -3187,7 +3393,14 @@ module Google
|
|
3187
3393
|
# message](https://developers.google.com/workspace/chat/list-reactions).
|
3188
3394
|
#
|
3189
3395
|
# Requires [user
|
3190
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3396
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3397
|
+
# with one of the following [authorization
|
3398
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3399
|
+
#
|
3400
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
|
3401
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
3402
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
3403
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
3191
3404
|
#
|
3192
3405
|
# @overload list_reactions(request, options = nil)
|
3193
3406
|
# Pass arguments to `list_reactions` via a request object, either of type
|
@@ -3334,7 +3547,13 @@ module Google
|
|
3334
3547
|
# reaction](https://developers.google.com/workspace/chat/delete-reactions).
|
3335
3548
|
#
|
3336
3549
|
# Requires [user
|
3337
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3550
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3551
|
+
# with one of the following [authorization
|
3552
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3553
|
+
#
|
3554
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
3555
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
3556
|
+
# - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
|
3338
3557
|
#
|
3339
3558
|
# @overload delete_reaction(request, options = nil)
|
3340
3559
|
# Pass arguments to `delete_reaction` via a request object, either of type
|
@@ -3424,7 +3643,11 @@ module Google
|
|
3424
3643
|
# permissions](https://support.google.com/a/answer/12850085).
|
3425
3644
|
#
|
3426
3645
|
# Requires [user
|
3427
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3646
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3647
|
+
# with the [authorization
|
3648
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3649
|
+
#
|
3650
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
3428
3651
|
#
|
3429
3652
|
# @overload create_custom_emoji(request, options = nil)
|
3430
3653
|
# Pass arguments to `create_custom_emoji` via a request object, either of type
|
@@ -3512,7 +3735,12 @@ module Google
|
|
3512
3735
|
# permissions](https://support.google.com/a/answer/12850085).
|
3513
3736
|
#
|
3514
3737
|
# Requires [user
|
3515
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3738
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3739
|
+
# with one of the following [authorization
|
3740
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3741
|
+
#
|
3742
|
+
# - `https://www.googleapis.com/auth/chat.customemojis.readonly`
|
3743
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
3516
3744
|
#
|
3517
3745
|
# @overload get_custom_emoji(request, options = nil)
|
3518
3746
|
# Pass arguments to `get_custom_emoji` via a request object, either of type
|
@@ -3606,7 +3834,12 @@ module Google
|
|
3606
3834
|
# permissions](https://support.google.com/a/answer/12850085).
|
3607
3835
|
#
|
3608
3836
|
# Requires [user
|
3609
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3837
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3838
|
+
# with one of the following [authorization
|
3839
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3840
|
+
#
|
3841
|
+
# - `https://www.googleapis.com/auth/chat.customemojis.readonly`
|
3842
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
3610
3843
|
#
|
3611
3844
|
# @overload list_custom_emojis(request, options = nil)
|
3612
3845
|
# Pass arguments to `list_custom_emojis` via a request object, either of type
|
@@ -3730,7 +3963,11 @@ module Google
|
|
3730
3963
|
# permissions](https://support.google.com/a/answer/12850085).
|
3731
3964
|
#
|
3732
3965
|
# Requires [user
|
3733
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3966
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
3967
|
+
# with the [authorization
|
3968
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
3969
|
+
#
|
3970
|
+
# - `https://www.googleapis.com/auth/chat.customemojis`
|
3734
3971
|
#
|
3735
3972
|
# @overload delete_custom_emoji(request, options = nil)
|
3736
3973
|
# Pass arguments to `delete_custom_emoji` via a request object, either of type
|
@@ -3820,7 +4057,12 @@ module Google
|
|
3820
4057
|
# state](https://developers.google.com/workspace/chat/get-space-read-state).
|
3821
4058
|
#
|
3822
4059
|
# Requires [user
|
3823
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4060
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4061
|
+
# with one of the following [authorization
|
4062
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4063
|
+
#
|
4064
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
|
4065
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate`
|
3824
4066
|
#
|
3825
4067
|
# @overload get_space_read_state(request, options = nil)
|
3826
4068
|
# Pass arguments to `get_space_read_state` via a request object, either of type
|
@@ -3917,7 +4159,11 @@ module Google
|
|
3917
4159
|
# state](https://developers.google.com/workspace/chat/update-space-read-state).
|
3918
4160
|
#
|
3919
4161
|
# Requires [user
|
3920
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4162
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4163
|
+
# with the [authorization
|
4164
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4165
|
+
#
|
4166
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate`
|
3921
4167
|
#
|
3922
4168
|
# @overload update_space_read_state(request, options = nil)
|
3923
4169
|
# Pass arguments to `update_space_read_state` via a request object, either of type
|
@@ -4029,7 +4275,12 @@ module Google
|
|
4029
4275
|
# state](https://developers.google.com/workspace/chat/get-thread-read-state).
|
4030
4276
|
#
|
4031
4277
|
# Requires [user
|
4032
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4278
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4279
|
+
# with one of the following [authorization
|
4280
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4281
|
+
#
|
4282
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
|
4283
|
+
# - `https://www.googleapis.com/auth/chat.users.readstate`
|
4033
4284
|
#
|
4034
4285
|
# @overload get_thread_read_state(request, options = nil)
|
4035
4286
|
# Pass arguments to `get_thread_read_state` via a request object, either of type
|
@@ -4133,7 +4384,20 @@ module Google
|
|
4133
4384
|
# object of the Space event data for this request.
|
4134
4385
|
#
|
4135
4386
|
# Requires [user
|
4136
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4387
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4388
|
+
# with an [authorization
|
4389
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes)
|
4390
|
+
# appropriate for reading the requested data:
|
4391
|
+
#
|
4392
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
4393
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
4394
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
4395
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
4396
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
|
4397
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
4398
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
4399
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
4400
|
+
#
|
4137
4401
|
# To get an event, the authenticated user must be a member of the space.
|
4138
4402
|
#
|
4139
4403
|
# For an example, see [Get details about an
|
@@ -4227,7 +4491,20 @@ module Google
|
|
4227
4491
|
# `Membership` resource.
|
4228
4492
|
#
|
4229
4493
|
# Requires [user
|
4230
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4494
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4495
|
+
# with an [authorization
|
4496
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes)
|
4497
|
+
# appropriate for reading the requested data:
|
4498
|
+
#
|
4499
|
+
# - `https://www.googleapis.com/auth/chat.spaces.readonly`
|
4500
|
+
# - `https://www.googleapis.com/auth/chat.spaces`
|
4501
|
+
# - `https://www.googleapis.com/auth/chat.messages.readonly`
|
4502
|
+
# - `https://www.googleapis.com/auth/chat.messages`
|
4503
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions.readonly`
|
4504
|
+
# - `https://www.googleapis.com/auth/chat.messages.reactions`
|
4505
|
+
# - `https://www.googleapis.com/auth/chat.memberships.readonly`
|
4506
|
+
# - `https://www.googleapis.com/auth/chat.memberships`
|
4507
|
+
#
|
4231
4508
|
# To list events, the authenticated user must be a member of the space.
|
4232
4509
|
#
|
4233
4510
|
# For an example, see [List events from a Google Chat
|
@@ -4389,7 +4666,11 @@ module Google
|
|
4389
4666
|
# setting](https://developers.google.com/workspace/chat/get-space-notification-setting).
|
4390
4667
|
#
|
4391
4668
|
# Requires [user
|
4392
|
-
# 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 the [authorization
|
4671
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4672
|
+
#
|
4673
|
+
# - `https://www.googleapis.com/auth/chat.users.spacesettings`
|
4393
4674
|
#
|
4394
4675
|
# @overload get_space_notification_setting(request, options = nil)
|
4395
4676
|
# Pass arguments to `get_space_notification_setting` via a request object, either of type
|
@@ -4477,7 +4758,11 @@ module Google
|
|
4477
4758
|
# setting](https://developers.google.com/workspace/chat/update-space-notification-setting).
|
4478
4759
|
#
|
4479
4760
|
# Requires [user
|
4480
|
-
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4761
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
|
4762
|
+
# with the [authorization
|
4763
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
|
4764
|
+
#
|
4765
|
+
# - `https://www.googleapis.com/auth/chat.users.spacesettings`
|
4481
4766
|
#
|
4482
4767
|
# @overload update_space_notification_setting(request, options = nil)
|
4483
4768
|
# Pass arguments to `update_space_notification_setting` via a request object, either of type
|