google-apps-chat-v1 0.5.0 → 0.5.1
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 +103 -80
- data/lib/google/apps/chat/v1/chat_service/rest/client.rb +103 -80
- data/lib/google/apps/chat/v1/version.rb +1 -1
- data/lib/google/chat/v1/chat_service_services_pb.rb +51 -42
- data/lib/google/chat/v1/space_pb.rb +4 -1
- data/proto_docs/google/chat/v1/message.rb +14 -13
- data/proto_docs/google/chat/v1/space.rb +156 -59
- data/proto_docs/google/chat/v1/space_event.rb +2 -0
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e55e7f9ef3119031d36a132d4cc51f3a755e9c3ffed6a9e6028a66d787ea577d
|
4
|
+
data.tar.gz: 4c382b8cad8dc7c244c98c37d5b27b3838efd0cbedd5444f7375ea8757ee74f5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: adcb8ae3b895d75eb5e1fb74026691180acf40c81b1f79cb62167de903e8bee6a666c0a268f2d735d0e0dd32d732374fff86b5e240e7c9fadc8330d78efd6c27
|
7
|
+
data.tar.gz: 9a35245230e22760e0518d358b996cc770138603fccde5d34e416f716df989c92dee96e1acdd8abba141634f3d619cfd5898282ef0cef5f32668174447a142cd
|
@@ -310,18 +310,30 @@ module Google
|
|
310
310
|
# Service calls
|
311
311
|
|
312
312
|
##
|
313
|
-
# Creates a message in a Google Chat space.
|
314
|
-
# including text and cards, is 32,000 bytes. For an example, see [Send a
|
313
|
+
# Creates a message in a Google Chat space. For an example, see [Send a
|
315
314
|
# message](https://developers.google.com/workspace/chat/create-messages).
|
316
315
|
#
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
316
|
+
# The `create()` method requires either user or app authentication. Chat
|
317
|
+
# attributes the message sender differently depending on the type of
|
318
|
+
# authentication that you use in your request.
|
320
319
|
#
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
320
|
+
# The following image shows how Chat attributes a message when you use app
|
321
|
+
# authentication. Chat displays the Chat app as the message
|
322
|
+
# sender. The content of the message can contain text (`text`), cards
|
323
|
+
# (`cardsV2`), and accessory widgets (`accessoryWidgets`).
|
324
|
+
#
|
325
|
+
# 
|
327
|
+
#
|
328
|
+
# The following image shows how Chat attributes a message when you use user
|
329
|
+
# authentication. Chat displays the user as the message sender and attributes
|
330
|
+
# the Chat app to the message by displaying its name. The content of message
|
331
|
+
# can only contain text (`text`).
|
332
|
+
#
|
333
|
+
# 
|
335
|
+
#
|
336
|
+
# The maximum message size, including the message contents, is 32,000 bytes.
|
325
337
|
#
|
326
338
|
# @overload create_message(request, options = nil)
|
327
339
|
# Pass arguments to `create_message` via a request object, either of type
|
@@ -443,8 +455,12 @@ module Google
|
|
443
455
|
|
444
456
|
##
|
445
457
|
# Lists messages in a space that the caller is a member of, including
|
446
|
-
# messages from blocked members and spaces.
|
447
|
-
#
|
458
|
+
# messages from blocked members and spaces. If you list messages from a
|
459
|
+
# space with no messages, the response is an empty object. When using a
|
460
|
+
# REST/HTTP interface, the response contains an empty JSON object, `{}`.
|
461
|
+
# For an example, see
|
462
|
+
# [List
|
463
|
+
# messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
|
448
464
|
# Requires [user
|
449
465
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
450
466
|
#
|
@@ -1912,14 +1928,19 @@ module Google
|
|
1912
1928
|
end
|
1913
1929
|
|
1914
1930
|
##
|
1915
|
-
# Creates a
|
1916
|
-
# example, see
|
1931
|
+
# Creates a space with no members. Can be used to create a named space.
|
1932
|
+
# Spaces grouped by topics aren't supported. For an example, see
|
1933
|
+
# [Create a
|
1917
1934
|
# space](https://developers.google.com/workspace/chat/create-spaces).
|
1918
1935
|
#
|
1919
1936
|
# If you receive the error message `ALREADY_EXISTS` when creating
|
1920
1937
|
# a space, try a different `displayName`. An existing space within
|
1921
1938
|
# the Google Workspace organization might already use this display name.
|
1922
1939
|
#
|
1940
|
+
# If you're a member of the [Developer Preview
|
1941
|
+
# program](https://developers.google.com/workspace/preview), you can create a
|
1942
|
+
# group chat in import mode using `spaceType.GROUP_CHAT`.
|
1943
|
+
#
|
1923
1944
|
# Requires [user
|
1924
1945
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
1925
1946
|
#
|
@@ -1942,10 +1963,14 @@ module Google
|
|
1942
1963
|
# Required. The `displayName` and `spaceType` fields must be populated. Only
|
1943
1964
|
# `SpaceType.SPACE` is supported.
|
1944
1965
|
#
|
1945
|
-
# If you receive the error message `ALREADY_EXISTS
|
1966
|
+
# If you receive the error message `ALREADY_EXISTS`,
|
1946
1967
|
# try a different `displayName`. An existing space within the Google
|
1947
1968
|
# Workspace organization might already use this display name.
|
1948
1969
|
#
|
1970
|
+
# If you're a member of the [Developer Preview
|
1971
|
+
# program](https://developers.google.com/workspace/preview),
|
1972
|
+
# `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true.
|
1973
|
+
#
|
1949
1974
|
# The space `name` is assigned on the server so anything specified in this
|
1950
1975
|
# field will be ignored.
|
1951
1976
|
# @param request_id [::String]
|
@@ -2236,54 +2261,64 @@ module Google
|
|
2236
2261
|
# Required. The updated field paths, comma separated if there are
|
2237
2262
|
# multiple.
|
2238
2263
|
#
|
2239
|
-
#
|
2264
|
+
# You can update the following fields for a space:
|
2240
2265
|
#
|
2241
|
-
#
|
2242
|
-
#
|
2243
|
-
# `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a
|
2244
|
-
# `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument
|
2245
|
-
# error. If you receive the error message `ALREADY_EXISTS` when updating the
|
2246
|
-
# `displayName`, try a different `displayName`. An existing space within the
|
2247
|
-
# Google Workspace organization might already use this display name.)
|
2266
|
+
# `space_details`: Updates the space's description. Supports up to 150
|
2267
|
+
# characters.
|
2248
2268
|
#
|
2249
|
-
#
|
2269
|
+
# `display_name`: Only supports updating the display name for spaces where
|
2270
|
+
# `spaceType` field is `SPACE`.
|
2271
|
+
# If you receive the error message `ALREADY_EXISTS`, try a different
|
2272
|
+
# value. An existing space within the
|
2273
|
+
# Google Workspace organization might already use this display name.
|
2274
|
+
#
|
2275
|
+
# `space_type`: Only supports changing a `GROUP_CHAT` space type to
|
2250
2276
|
# `SPACE`. Include `display_name` together
|
2251
2277
|
# with `space_type` in the update mask and ensure that the specified space
|
2252
2278
|
# has a non-empty display name and the `SPACE` space type. Including the
|
2253
2279
|
# `space_type` mask and the `SPACE` type in the specified space when updating
|
2254
2280
|
# the display name is optional if the existing space already has the `SPACE`
|
2255
2281
|
# type. Trying to update the space type in other ways results in an invalid
|
2256
|
-
# argument error
|
2257
|
-
# `space_type` is not supported with
|
2258
|
-
#
|
2259
|
-
# - `space_details`
|
2282
|
+
# argument error.
|
2283
|
+
# `space_type` is not supported with `useAdminAccess`.
|
2260
2284
|
#
|
2261
|
-
#
|
2262
|
-
#
|
2263
|
-
#
|
2264
|
-
#
|
2265
|
-
#
|
2266
|
-
# `space_history_state` is not supported with
|
2285
|
+
# `space_history_state`: Updates [space history
|
2286
|
+
# settings](https://support.google.com/chat/answer/7664687) by turning
|
2287
|
+
# history on or off for the space. Only supported if history settings are
|
2288
|
+
# enabled for the Google Workspace organization. To update the
|
2289
|
+
# space history state, you must omit all other field masks in your request.
|
2290
|
+
# `space_history_state` is not supported with `useAdminAccess`.
|
2267
2291
|
#
|
2268
|
-
#
|
2292
|
+
# `access_settings.audience`: Updates the [access
|
2269
2293
|
# setting](https://support.google.com/chat/answer/11971020) of who can
|
2270
|
-
# discover the space, join the space, and preview the messages in space
|
2271
|
-
#
|
2272
|
-
#
|
2273
|
-
#
|
2274
|
-
#
|
2275
|
-
#
|
2276
|
-
#
|
2277
|
-
#
|
2278
|
-
#
|
2279
|
-
#
|
2280
|
-
# `
|
2281
|
-
#
|
2282
|
-
# `permission_settings
|
2283
|
-
#
|
2284
|
-
#
|
2285
|
-
#
|
2286
|
-
#
|
2294
|
+
# discover the space, join the space, and preview the messages in named space
|
2295
|
+
# where `spaceType` field is `SPACE`. If the existing space has a
|
2296
|
+
# target audience, you can remove the audience and restrict space access by
|
2297
|
+
# omitting a value for this field mask. To update access settings for a
|
2298
|
+
# space, the authenticating user must be a space manager and omit all other
|
2299
|
+
# field masks in your request. You can't update this field if the space is in
|
2300
|
+
# [import
|
2301
|
+
# mode](https://developers.google.com/workspace/chat/import-data-overview).
|
2302
|
+
# To learn more, see [Make a space discoverable to specific
|
2303
|
+
# users](https://developers.google.com/workspace/chat/space-target-audience).
|
2304
|
+
# `access_settings.audience` is not supported with `useAdminAccess`.
|
2305
|
+
#
|
2306
|
+
# `permission_settings`: Supports changing the
|
2307
|
+
# [permission settings](https://support.google.com/chat/answer/13340792)
|
2308
|
+
# of a space.
|
2309
|
+
# When updating permission settings, you can only specify
|
2310
|
+
# `permissionSettings` field masks; you cannot update other field masks
|
2311
|
+
# at the same time. `permissionSettings` is not supported with
|
2312
|
+
# `useAdminAccess`.
|
2313
|
+
# The supported field masks include:
|
2314
|
+
#
|
2315
|
+
# - `permission_settings.manageMembersAndGroups`
|
2316
|
+
# - `permission_settings.modifySpaceDetails`
|
2317
|
+
# - `permission_settings.toggleHistory`
|
2318
|
+
# - `permission_settings.useAtMentionAll`
|
2319
|
+
# - `permission_settings.manageApps`
|
2320
|
+
# - `permission_settings.manageWebhooks`
|
2321
|
+
# - `permission_settings.replyMessages`
|
2287
2322
|
# @param use_admin_access [::Boolean]
|
2288
2323
|
# When `true`, the method runs using the user's Google Workspace
|
2289
2324
|
# administrator privileges.
|
@@ -2670,40 +2705,25 @@ module Google
|
|
2670
2705
|
end
|
2671
2706
|
|
2672
2707
|
##
|
2673
|
-
# Creates a
|
2674
|
-
# memberships for other apps isn't supported.
|
2675
|
-
# [Invite or add a user or a Google Chat app to a
|
2676
|
-
# space](https://developers.google.com/workspace/chat/create-members).
|
2708
|
+
# Creates a membership for the calling Chat app, a user, or a Google Group.
|
2709
|
+
# Creating memberships for other Chat apps isn't supported.
|
2677
2710
|
# When creating a membership, if the specified member has their auto-accept
|
2678
2711
|
# policy turned off, then they're invited, and must accept the space
|
2679
2712
|
# invitation before joining. Otherwise, creating a membership adds the member
|
2680
|
-
# directly to the specified space.
|
2713
|
+
# directly to the specified space.
|
2714
|
+
# Requires [user
|
2681
2715
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
2682
2716
|
#
|
2683
|
-
#
|
2684
|
-
#
|
2685
|
-
#
|
2686
|
-
#
|
2687
|
-
#
|
2688
|
-
#
|
2689
|
-
#
|
2690
|
-
#
|
2691
|
-
# -
|
2692
|
-
#
|
2693
|
-
# can also be the `id` for the person from the People API, or the `id` for
|
2694
|
-
# the user in the Directory API. For example, if the People API Person
|
2695
|
-
# profile ID for `user@example.com` is `123456789`, you can add the user to
|
2696
|
-
# the space by setting the `membership.member.name` to
|
2697
|
-
# `users/user@example.com` or `users/123456789`.
|
2698
|
-
#
|
2699
|
-
# - To add or invite a Google group in a named space, use
|
2700
|
-
# `groups/{group}`, where `{group}` is the `id` for the group from the Cloud
|
2701
|
-
# Identity Groups API. For example, you can use [Cloud Identity Groups lookup
|
2702
|
-
# API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
|
2703
|
-
# to retrieve the ID `123456789` for group email `group@example.com`, then
|
2704
|
-
# you can add or invite the group to a named space by setting the
|
2705
|
-
# `membership.group_member.name` to `groups/123456789`. Group email is not
|
2706
|
-
# supported, and Google groups can only be added as members in named spaces.
|
2717
|
+
# For example usage, see:
|
2718
|
+
#
|
2719
|
+
# - [Invite or add a user to a
|
2720
|
+
# space](https://developers.google.com/workspace/chat/create-members#create-user-membership).
|
2721
|
+
#
|
2722
|
+
# - [Invite or add a Google Group to a
|
2723
|
+
# space](https://developers.google.com/workspace/chat/create-members#create-group-membership).
|
2724
|
+
#
|
2725
|
+
# - [Add the Chat app to a
|
2726
|
+
# space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
|
2707
2727
|
#
|
2708
2728
|
# @overload create_membership(request, options = nil)
|
2709
2729
|
# Pass arguments to `create_membership` via a request object, either of type
|
@@ -3728,6 +3748,9 @@ module Google
|
|
3728
3748
|
# updated, the server returns the updated `Message` resource in the event
|
3729
3749
|
# payload.
|
3730
3750
|
#
|
3751
|
+
# Note: The `permissionSettings` field is not returned in the Space
|
3752
|
+
# object of the Space event data for this request.
|
3753
|
+
#
|
3731
3754
|
# Requires [user
|
3732
3755
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
3733
3756
|
# To get an event, the authenticated user must be a member of the space.
|
@@ -303,18 +303,30 @@ module Google
|
|
303
303
|
# Service calls
|
304
304
|
|
305
305
|
##
|
306
|
-
# Creates a message in a Google Chat space.
|
307
|
-
# including text and cards, is 32,000 bytes. For an example, see [Send a
|
306
|
+
# Creates a message in a Google Chat space. For an example, see [Send a
|
308
307
|
# message](https://developers.google.com/workspace/chat/create-messages).
|
309
308
|
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
309
|
+
# The `create()` method requires either user or app authentication. Chat
|
310
|
+
# attributes the message sender differently depending on the type of
|
311
|
+
# authentication that you use in your request.
|
313
312
|
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
313
|
+
# The following image shows how Chat attributes a message when you use app
|
314
|
+
# authentication. Chat displays the Chat app as the message
|
315
|
+
# sender. The content of the message can contain text (`text`), cards
|
316
|
+
# (`cardsV2`), and accessory widgets (`accessoryWidgets`).
|
317
|
+
#
|
318
|
+
# 
|
320
|
+
#
|
321
|
+
# The following image shows how Chat attributes a message when you use user
|
322
|
+
# authentication. Chat displays the user as the message sender and attributes
|
323
|
+
# the Chat app to the message by displaying its name. The content of message
|
324
|
+
# can only contain text (`text`).
|
325
|
+
#
|
326
|
+
# 
|
328
|
+
#
|
329
|
+
# The maximum message size, including the message contents, is 32,000 bytes.
|
318
330
|
#
|
319
331
|
# @overload create_message(request, options = nil)
|
320
332
|
# Pass arguments to `create_message` via a request object, either of type
|
@@ -429,8 +441,12 @@ module Google
|
|
429
441
|
|
430
442
|
##
|
431
443
|
# Lists messages in a space that the caller is a member of, including
|
432
|
-
# messages from blocked members and spaces.
|
433
|
-
#
|
444
|
+
# messages from blocked members and spaces. If you list messages from a
|
445
|
+
# space with no messages, the response is an empty object. When using a
|
446
|
+
# REST/HTTP interface, the response contains an empty JSON object, `{}`.
|
447
|
+
# For an example, see
|
448
|
+
# [List
|
449
|
+
# messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
|
434
450
|
# Requires [user
|
435
451
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
436
452
|
#
|
@@ -1837,14 +1853,19 @@ module Google
|
|
1837
1853
|
end
|
1838
1854
|
|
1839
1855
|
##
|
1840
|
-
# Creates a
|
1841
|
-
# example, see
|
1856
|
+
# Creates a space with no members. Can be used to create a named space.
|
1857
|
+
# Spaces grouped by topics aren't supported. For an example, see
|
1858
|
+
# [Create a
|
1842
1859
|
# space](https://developers.google.com/workspace/chat/create-spaces).
|
1843
1860
|
#
|
1844
1861
|
# If you receive the error message `ALREADY_EXISTS` when creating
|
1845
1862
|
# a space, try a different `displayName`. An existing space within
|
1846
1863
|
# the Google Workspace organization might already use this display name.
|
1847
1864
|
#
|
1865
|
+
# If you're a member of the [Developer Preview
|
1866
|
+
# program](https://developers.google.com/workspace/preview), you can create a
|
1867
|
+
# group chat in import mode using `spaceType.GROUP_CHAT`.
|
1868
|
+
#
|
1848
1869
|
# Requires [user
|
1849
1870
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
1850
1871
|
#
|
@@ -1867,10 +1888,14 @@ module Google
|
|
1867
1888
|
# Required. The `displayName` and `spaceType` fields must be populated. Only
|
1868
1889
|
# `SpaceType.SPACE` is supported.
|
1869
1890
|
#
|
1870
|
-
# If you receive the error message `ALREADY_EXISTS
|
1891
|
+
# If you receive the error message `ALREADY_EXISTS`,
|
1871
1892
|
# try a different `displayName`. An existing space within the Google
|
1872
1893
|
# Workspace organization might already use this display name.
|
1873
1894
|
#
|
1895
|
+
# If you're a member of the [Developer Preview
|
1896
|
+
# program](https://developers.google.com/workspace/preview),
|
1897
|
+
# `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true.
|
1898
|
+
#
|
1874
1899
|
# The space `name` is assigned on the server so anything specified in this
|
1875
1900
|
# field will be ignored.
|
1876
1901
|
# @param request_id [::String]
|
@@ -2163,54 +2188,64 @@ module Google
|
|
2163
2188
|
# Required. The updated field paths, comma separated if there are
|
2164
2189
|
# multiple.
|
2165
2190
|
#
|
2166
|
-
#
|
2191
|
+
# You can update the following fields for a space:
|
2167
2192
|
#
|
2168
|
-
#
|
2169
|
-
#
|
2170
|
-
# `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a
|
2171
|
-
# `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument
|
2172
|
-
# error. If you receive the error message `ALREADY_EXISTS` when updating the
|
2173
|
-
# `displayName`, try a different `displayName`. An existing space within the
|
2174
|
-
# Google Workspace organization might already use this display name.)
|
2193
|
+
# `space_details`: Updates the space's description. Supports up to 150
|
2194
|
+
# characters.
|
2175
2195
|
#
|
2176
|
-
#
|
2196
|
+
# `display_name`: Only supports updating the display name for spaces where
|
2197
|
+
# `spaceType` field is `SPACE`.
|
2198
|
+
# If you receive the error message `ALREADY_EXISTS`, try a different
|
2199
|
+
# value. An existing space within the
|
2200
|
+
# Google Workspace organization might already use this display name.
|
2201
|
+
#
|
2202
|
+
# `space_type`: Only supports changing a `GROUP_CHAT` space type to
|
2177
2203
|
# `SPACE`. Include `display_name` together
|
2178
2204
|
# with `space_type` in the update mask and ensure that the specified space
|
2179
2205
|
# has a non-empty display name and the `SPACE` space type. Including the
|
2180
2206
|
# `space_type` mask and the `SPACE` type in the specified space when updating
|
2181
2207
|
# the display name is optional if the existing space already has the `SPACE`
|
2182
2208
|
# type. Trying to update the space type in other ways results in an invalid
|
2183
|
-
# argument error
|
2184
|
-
# `space_type` is not supported with
|
2185
|
-
#
|
2186
|
-
# - `space_details`
|
2209
|
+
# argument error.
|
2210
|
+
# `space_type` is not supported with `useAdminAccess`.
|
2187
2211
|
#
|
2188
|
-
#
|
2189
|
-
#
|
2190
|
-
#
|
2191
|
-
#
|
2192
|
-
#
|
2193
|
-
# `space_history_state` is not supported with
|
2212
|
+
# `space_history_state`: Updates [space history
|
2213
|
+
# settings](https://support.google.com/chat/answer/7664687) by turning
|
2214
|
+
# history on or off for the space. Only supported if history settings are
|
2215
|
+
# enabled for the Google Workspace organization. To update the
|
2216
|
+
# space history state, you must omit all other field masks in your request.
|
2217
|
+
# `space_history_state` is not supported with `useAdminAccess`.
|
2194
2218
|
#
|
2195
|
-
#
|
2219
|
+
# `access_settings.audience`: Updates the [access
|
2196
2220
|
# setting](https://support.google.com/chat/answer/11971020) of who can
|
2197
|
-
# discover the space, join the space, and preview the messages in space
|
2198
|
-
#
|
2199
|
-
#
|
2200
|
-
#
|
2201
|
-
#
|
2202
|
-
#
|
2203
|
-
#
|
2204
|
-
#
|
2205
|
-
#
|
2206
|
-
#
|
2207
|
-
# `
|
2208
|
-
#
|
2209
|
-
# `permission_settings
|
2210
|
-
#
|
2211
|
-
#
|
2212
|
-
#
|
2213
|
-
#
|
2221
|
+
# discover the space, join the space, and preview the messages in named space
|
2222
|
+
# where `spaceType` field is `SPACE`. If the existing space has a
|
2223
|
+
# target audience, you can remove the audience and restrict space access by
|
2224
|
+
# omitting a value for this field mask. To update access settings for a
|
2225
|
+
# space, the authenticating user must be a space manager and omit all other
|
2226
|
+
# field masks in your request. You can't update this field if the space is in
|
2227
|
+
# [import
|
2228
|
+
# mode](https://developers.google.com/workspace/chat/import-data-overview).
|
2229
|
+
# To learn more, see [Make a space discoverable to specific
|
2230
|
+
# users](https://developers.google.com/workspace/chat/space-target-audience).
|
2231
|
+
# `access_settings.audience` is not supported with `useAdminAccess`.
|
2232
|
+
#
|
2233
|
+
# `permission_settings`: Supports changing the
|
2234
|
+
# [permission settings](https://support.google.com/chat/answer/13340792)
|
2235
|
+
# of a space.
|
2236
|
+
# When updating permission settings, you can only specify
|
2237
|
+
# `permissionSettings` field masks; you cannot update other field masks
|
2238
|
+
# at the same time. `permissionSettings` is not supported with
|
2239
|
+
# `useAdminAccess`.
|
2240
|
+
# The supported field masks include:
|
2241
|
+
#
|
2242
|
+
# - `permission_settings.manageMembersAndGroups`
|
2243
|
+
# - `permission_settings.modifySpaceDetails`
|
2244
|
+
# - `permission_settings.toggleHistory`
|
2245
|
+
# - `permission_settings.useAtMentionAll`
|
2246
|
+
# - `permission_settings.manageApps`
|
2247
|
+
# - `permission_settings.manageWebhooks`
|
2248
|
+
# - `permission_settings.replyMessages`
|
2214
2249
|
# @param use_admin_access [::Boolean]
|
2215
2250
|
# When `true`, the method runs using the user's Google Workspace
|
2216
2251
|
# administrator privileges.
|
@@ -2577,40 +2612,25 @@ module Google
|
|
2577
2612
|
end
|
2578
2613
|
|
2579
2614
|
##
|
2580
|
-
# Creates a
|
2581
|
-
# memberships for other apps isn't supported.
|
2582
|
-
# [Invite or add a user or a Google Chat app to a
|
2583
|
-
# space](https://developers.google.com/workspace/chat/create-members).
|
2615
|
+
# Creates a membership for the calling Chat app, a user, or a Google Group.
|
2616
|
+
# Creating memberships for other Chat apps isn't supported.
|
2584
2617
|
# When creating a membership, if the specified member has their auto-accept
|
2585
2618
|
# policy turned off, then they're invited, and must accept the space
|
2586
2619
|
# invitation before joining. Otherwise, creating a membership adds the member
|
2587
|
-
# directly to the specified space.
|
2620
|
+
# directly to the specified space.
|
2621
|
+
# Requires [user
|
2588
2622
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
2589
2623
|
#
|
2590
|
-
#
|
2591
|
-
#
|
2592
|
-
#
|
2593
|
-
#
|
2594
|
-
#
|
2595
|
-
#
|
2596
|
-
#
|
2597
|
-
#
|
2598
|
-
# -
|
2599
|
-
#
|
2600
|
-
# can also be the `id` for the person from the People API, or the `id` for
|
2601
|
-
# the user in the Directory API. For example, if the People API Person
|
2602
|
-
# profile ID for `user@example.com` is `123456789`, you can add the user to
|
2603
|
-
# the space by setting the `membership.member.name` to
|
2604
|
-
# `users/user@example.com` or `users/123456789`.
|
2605
|
-
#
|
2606
|
-
# - To add or invite a Google group in a named space, use
|
2607
|
-
# `groups/{group}`, where `{group}` is the `id` for the group from the Cloud
|
2608
|
-
# Identity Groups API. For example, you can use [Cloud Identity Groups lookup
|
2609
|
-
# API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
|
2610
|
-
# to retrieve the ID `123456789` for group email `group@example.com`, then
|
2611
|
-
# you can add or invite the group to a named space by setting the
|
2612
|
-
# `membership.group_member.name` to `groups/123456789`. Group email is not
|
2613
|
-
# supported, and Google groups can only be added as members in named spaces.
|
2624
|
+
# For example usage, see:
|
2625
|
+
#
|
2626
|
+
# - [Invite or add a user to a
|
2627
|
+
# space](https://developers.google.com/workspace/chat/create-members#create-user-membership).
|
2628
|
+
#
|
2629
|
+
# - [Invite or add a Google Group to a
|
2630
|
+
# space](https://developers.google.com/workspace/chat/create-members#create-group-membership).
|
2631
|
+
#
|
2632
|
+
# - [Add the Chat app to a
|
2633
|
+
# space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
|
2614
2634
|
#
|
2615
2635
|
# @overload create_membership(request, options = nil)
|
2616
2636
|
# Pass arguments to `create_membership` via a request object, either of type
|
@@ -3572,6 +3592,9 @@ module Google
|
|
3572
3592
|
# updated, the server returns the updated `Message` resource in the event
|
3573
3593
|
# payload.
|
3574
3594
|
#
|
3595
|
+
# Note: The `permissionSettings` field is not returned in the Space
|
3596
|
+
# object of the Space event data for this request.
|
3597
|
+
#
|
3575
3598
|
# Requires [user
|
3576
3599
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
3577
3600
|
# To get an event, the authenticated user must be a member of the space.
|
@@ -34,22 +34,38 @@ module Google
|
|
34
34
|
self.unmarshal_class_method = :decode
|
35
35
|
self.service_name = 'google.chat.v1.ChatService'
|
36
36
|
|
37
|
-
# Creates a message in a Google Chat space.
|
38
|
-
# including text and cards, is 32,000 bytes. For an example, see [Send a
|
37
|
+
# Creates a message in a Google Chat space. For an example, see [Send a
|
39
38
|
# message](https://developers.google.com/workspace/chat/create-messages).
|
40
39
|
#
|
41
|
-
#
|
42
|
-
#
|
43
|
-
#
|
40
|
+
# The `create()` method requires either user or app authentication. Chat
|
41
|
+
# attributes the message sender differently depending on the type of
|
42
|
+
# authentication that you use in your request.
|
44
43
|
#
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
44
|
+
# The following image shows how Chat attributes a message when you use app
|
45
|
+
# authentication. Chat displays the Chat app as the message
|
46
|
+
# sender. The content of the message can contain text (`text`), cards
|
47
|
+
# (`cardsV2`), and accessory widgets (`accessoryWidgets`).
|
48
|
+
#
|
49
|
+
# 
|
51
|
+
#
|
52
|
+
# The following image shows how Chat attributes a message when you use user
|
53
|
+
# authentication. Chat displays the user as the message sender and attributes
|
54
|
+
# the Chat app to the message by displaying its name. The content of message
|
55
|
+
# can only contain text (`text`).
|
56
|
+
#
|
57
|
+
# 
|
59
|
+
#
|
60
|
+
# The maximum message size, including the message contents, is 32,000 bytes.
|
49
61
|
rpc :CreateMessage, ::Google::Apps::Chat::V1::CreateMessageRequest, ::Google::Apps::Chat::V1::Message
|
50
62
|
# Lists messages in a space that the caller is a member of, including
|
51
|
-
# messages from blocked members and spaces.
|
52
|
-
#
|
63
|
+
# messages from blocked members and spaces. If you list messages from a
|
64
|
+
# space with no messages, the response is an empty object. When using a
|
65
|
+
# REST/HTTP interface, the response contains an empty JSON object, `{}`.
|
66
|
+
# For an example, see
|
67
|
+
# [List
|
68
|
+
# messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
|
53
69
|
# Requires [user
|
54
70
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
55
71
|
rpc :ListMessages, ::Google::Apps::Chat::V1::ListMessagesRequest, ::Google::Apps::Chat::V1::ListMessagesResponse
|
@@ -187,14 +203,19 @@ module Google
|
|
187
203
|
# and [user
|
188
204
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
189
205
|
rpc :GetSpace, ::Google::Apps::Chat::V1::GetSpaceRequest, ::Google::Apps::Chat::V1::Space
|
190
|
-
# Creates a
|
191
|
-
# example, see
|
206
|
+
# Creates a space with no members. Can be used to create a named space.
|
207
|
+
# Spaces grouped by topics aren't supported. For an example, see
|
208
|
+
# [Create a
|
192
209
|
# space](https://developers.google.com/workspace/chat/create-spaces).
|
193
210
|
#
|
194
211
|
# If you receive the error message `ALREADY_EXISTS` when creating
|
195
212
|
# a space, try a different `displayName`. An existing space within
|
196
213
|
# the Google Workspace organization might already use this display name.
|
197
214
|
#
|
215
|
+
# If you're a member of the [Developer Preview
|
216
|
+
# program](https://developers.google.com/workspace/preview), you can create a
|
217
|
+
# group chat in import mode using `spaceType.GROUP_CHAT`.
|
218
|
+
#
|
198
219
|
# Requires [user
|
199
220
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
200
221
|
rpc :CreateSpace, ::Google::Apps::Chat::V1::CreateSpaceRequest, ::Google::Apps::Chat::V1::Space
|
@@ -298,40 +319,25 @@ module Google
|
|
298
319
|
# or [app
|
299
320
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
|
300
321
|
rpc :FindDirectMessage, ::Google::Apps::Chat::V1::FindDirectMessageRequest, ::Google::Apps::Chat::V1::Space
|
301
|
-
# Creates a
|
302
|
-
# memberships for other apps isn't supported.
|
303
|
-
# [Invite or add a user or a Google Chat app to a
|
304
|
-
# space](https://developers.google.com/workspace/chat/create-members).
|
322
|
+
# Creates a membership for the calling Chat app, a user, or a Google Group.
|
323
|
+
# Creating memberships for other Chat apps isn't supported.
|
305
324
|
# When creating a membership, if the specified member has their auto-accept
|
306
325
|
# policy turned off, then they're invited, and must accept the space
|
307
326
|
# invitation before joining. Otherwise, creating a membership adds the member
|
308
|
-
# directly to the specified space.
|
327
|
+
# directly to the specified space.
|
328
|
+
# Requires [user
|
309
329
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
310
330
|
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
#
|
319
|
-
# -
|
320
|
-
#
|
321
|
-
# can also be the `id` for the person from the People API, or the `id` for
|
322
|
-
# the user in the Directory API. For example, if the People API Person
|
323
|
-
# profile ID for `user@example.com` is `123456789`, you can add the user to
|
324
|
-
# the space by setting the `membership.member.name` to
|
325
|
-
# `users/user@example.com` or `users/123456789`.
|
326
|
-
#
|
327
|
-
# - To add or invite a Google group in a named space, use
|
328
|
-
# `groups/{group}`, where `{group}` is the `id` for the group from the Cloud
|
329
|
-
# Identity Groups API. For example, you can use [Cloud Identity Groups lookup
|
330
|
-
# API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
|
331
|
-
# to retrieve the ID `123456789` for group email `group@example.com`, then
|
332
|
-
# you can add or invite the group to a named space by setting the
|
333
|
-
# `membership.group_member.name` to `groups/123456789`. Group email is not
|
334
|
-
# supported, and Google groups can only be added as members in named spaces.
|
331
|
+
# For example usage, see:
|
332
|
+
#
|
333
|
+
# - [Invite or add a user to a
|
334
|
+
# space](https://developers.google.com/workspace/chat/create-members#create-user-membership).
|
335
|
+
#
|
336
|
+
# - [Invite or add a Google Group to a
|
337
|
+
# space](https://developers.google.com/workspace/chat/create-members#create-group-membership).
|
338
|
+
#
|
339
|
+
# - [Add the Chat app to a
|
340
|
+
# space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
|
335
341
|
rpc :CreateMembership, ::Google::Apps::Chat::V1::CreateMembershipRequest, ::Google::Apps::Chat::V1::Membership
|
336
342
|
# Updates a membership. For an example, see [Update a user's membership in
|
337
343
|
# a space](https://developers.google.com/workspace/chat/update-members).
|
@@ -396,6 +402,9 @@ module Google
|
|
396
402
|
# updated, the server returns the updated `Message` resource in the event
|
397
403
|
# payload.
|
398
404
|
#
|
405
|
+
# Note: The `permissionSettings` field is not returned in the Space
|
406
|
+
# object of the Space event data for this request.
|
407
|
+
#
|
399
408
|
# Requires [user
|
400
409
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
401
410
|
# To get an event, the authenticated user must be a member of the space.
|
@@ -11,7 +11,7 @@ require 'google/protobuf/field_mask_pb'
|
|
11
11
|
require 'google/protobuf/timestamp_pb'
|
12
12
|
|
13
13
|
|
14
|
-
descriptor_data = "\n\x1agoogle/chat/v1/space.proto\x12\x0egoogle.chat.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\"google/chat/v1/history_state.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\
|
14
|
+
descriptor_data = "\n\x1agoogle/chat/v1/space.proto\x12\x0egoogle.chat.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\"google/chat/v1/history_state.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xb4\x14\n\x05Space\x12\x0c\n\x04name\x18\x01 \x01(\t\x12/\n\x04type\x18\x02 \x01(\x0e\x32\x1a.google.chat.v1.Space.TypeB\x05\x18\x01\xe0\x41\x03\x12\x33\n\nspace_type\x18\n \x01(\x0e\x32\x1f.google.chat.v1.Space.SpaceType\x12\x1f\n\x12single_user_bot_dm\x18\x04 \x01(\x08\x42\x03\xe0\x41\x01\x12\x17\n\x08threaded\x18\x05 \x01(\x08\x42\x05\x18\x01\xe0\x41\x03\x12\x14\n\x0c\x64isplay_name\x18\x03 \x01(\t\x12\"\n\x15\x65xternal_user_allowed\x18\x08 \x01(\x08\x42\x03\xe0\x41\x05\x12M\n\x15space_threading_state\x18\t \x01(\x0e\x32).google.chat.v1.Space.SpaceThreadingStateB\x03\xe0\x41\x03\x12\x39\n\rspace_details\x18\x0b \x01(\x0b\x32\".google.chat.v1.Space.SpaceDetails\x12\x39\n\x13space_history_state\x18\r \x01(\x0e\x32\x1c.google.chat.v1.HistoryState\x12\x18\n\x0bimport_mode\x18\x10 \x01(\x08\x42\x03\xe0\x41\x01\x12\x37\n\x0b\x63reate_time\x18\x11 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x06\xe0\x41\x05\xe0\x41\x01\x12\x39\n\x10last_active_time\x18\x12 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x1c\n\x0f\x61\x64min_installed\x18\x13 \x01(\x08\x42\x03\xe0\x41\x03\x12\x44\n\x10membership_count\x18\x14 \x01(\x0b\x32%.google.chat.v1.Space.MembershipCountB\x03\xe0\x41\x03\x12\x42\n\x0f\x61\x63\x63\x65ss_settings\x18\x17 \x01(\x0b\x32$.google.chat.v1.Space.AccessSettingsB\x03\xe0\x41\x01\x12\x16\n\tspace_uri\x18\x19 \x01(\tB\x03\xe0\x41\x03\x12\x64\n\x1epredefined_permission_settings\x18\x1a \x01(\x0e\x32\x32.google.chat.v1.Space.PredefinedPermissionSettingsB\x06\xe0\x41\x04\xe0\x41\x01H\x00\x12L\n\x13permission_settings\x18\x1b \x01(\x0b\x32(.google.chat.v1.Space.PermissionSettingsB\x03\xe0\x41\x01H\x00\x1a\x37\n\x0cSpaceDetails\x12\x13\n\x0b\x64\x65scription\x18\x01 \x01(\t\x12\x12\n\nguidelines\x18\x02 \x01(\t\x1aU\n\x0fMembershipCount\x12&\n\x1ejoined_direct_human_user_count\x18\x04 \x01(\x05\x12\x1a\n\x12joined_group_count\x18\x05 \x01(\x05\x1a\xc0\x01\n\x0e\x41\x63\x63\x65ssSettings\x12K\n\x0c\x61\x63\x63\x65ss_state\x18\x01 \x01(\x0e\x32\x30.google.chat.v1.Space.AccessSettings.AccessStateB\x03\xe0\x41\x03\x12\x15\n\x08\x61udience\x18\x03 \x01(\tB\x03\xe0\x41\x01\"J\n\x0b\x41\x63\x63\x65ssState\x12\x1c\n\x18\x41\x43\x43\x45SS_STATE_UNSPECIFIED\x10\x00\x12\x0b\n\x07PRIVATE\x10\x01\x12\x10\n\x0c\x44ISCOVERABLE\x10\x02\x1a\x85\x06\n\x12PermissionSettings\x12O\n\x19manage_members_and_groups\x18\x01 \x01(\x0b\x32\'.google.chat.v1.Space.PermissionSettingH\x00\x88\x01\x01\x12J\n\x14modify_space_details\x18\x02 \x01(\x0b\x32\'.google.chat.v1.Space.PermissionSettingH\x01\x88\x01\x01\x12\x44\n\x0etoggle_history\x18\x03 \x01(\x0b\x32\'.google.chat.v1.Space.PermissionSettingH\x02\x88\x01\x01\x12H\n\x12use_at_mention_all\x18\x04 \x01(\x0b\x32\'.google.chat.v1.Space.PermissionSettingH\x03\x88\x01\x01\x12\x41\n\x0bmanage_apps\x18\x05 \x01(\x0b\x32\'.google.chat.v1.Space.PermissionSettingH\x04\x88\x01\x01\x12\x45\n\x0fmanage_webhooks\x18\x06 \x01(\x0b\x32\'.google.chat.v1.Space.PermissionSettingH\x05\x88\x01\x01\x12H\n\rpost_messages\x18\x07 \x01(\x0b\x32\'.google.chat.v1.Space.PermissionSettingB\x03\xe0\x41\x03H\x06\x88\x01\x01\x12\x44\n\x0ereply_messages\x18\x08 \x01(\x0b\x32\'.google.chat.v1.Space.PermissionSettingH\x07\x88\x01\x01\x42\x1c\n\x1a_manage_members_and_groupsB\x17\n\x15_modify_space_detailsB\x11\n\x0f_toggle_historyB\x15\n\x13_use_at_mention_allB\x0e\n\x0c_manage_appsB\x12\n\x10_manage_webhooksB\x10\n\x0e_post_messagesB\x11\n\x0f_reply_messages\x1a\x46\n\x11PermissionSetting\x12\x18\n\x10managers_allowed\x18\x01 \x01(\x08\x12\x17\n\x0fmembers_allowed\x18\x02 \x01(\x08\".\n\x04Type\x12\x14\n\x10TYPE_UNSPECIFIED\x10\x00\x12\x08\n\x04ROOM\x10\x01\x12\x06\n\x02\x44M\x10\x02\"V\n\tSpaceType\x12\x1a\n\x16SPACE_TYPE_UNSPECIFIED\x10\x00\x12\t\n\x05SPACE\x10\x01\x12\x0e\n\nGROUP_CHAT\x10\x02\x12\x12\n\x0e\x44IRECT_MESSAGE\x10\x03\"\x82\x01\n\x13SpaceThreadingState\x12%\n!SPACE_THREADING_STATE_UNSPECIFIED\x10\x00\x12\x15\n\x11THREADED_MESSAGES\x10\x02\x12\x14\n\x10GROUPED_MESSAGES\x10\x03\x12\x17\n\x13UNTHREADED_MESSAGES\x10\x04\"\x7f\n\x1cPredefinedPermissionSettings\x12.\n*PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED\x10\x00\x12\x17\n\x13\x43OLLABORATION_SPACE\x10\x01\x12\x16\n\x12\x41NNOUNCEMENT_SPACE\x10\x02:.\xea\x41+\n\x19\x63hat.googleapis.com/Space\x12\x0espaces/{space}B\x1b\n\x19space_permission_settings\"X\n\x12\x43reateSpaceRequest\x12)\n\x05space\x18\x01 \x01(\x0b\x32\x15.google.chat.v1.SpaceB\x03\xe0\x41\x02\x12\x17\n\nrequest_id\x18\x02 \x01(\tB\x03\xe0\x41\x01\"Y\n\x11ListSpacesRequest\x12\x16\n\tpage_size\x18\x01 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x02 \x01(\tB\x03\xe0\x41\x01\x12\x13\n\x06\x66ilter\x18\x03 \x01(\tB\x03\xe0\x41\x01\"T\n\x12ListSpacesResponse\x12%\n\x06spaces\x18\x01 \x03(\x0b\x32\x15.google.chat.v1.Space\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\\\n\x0fGetSpaceRequest\x12/\n\x04name\x18\x01 \x01(\tB!\xe0\x41\x02\xfa\x41\x1b\n\x19\x63hat.googleapis.com/Space\x12\x18\n\x10use_admin_access\x18\x02 \x01(\x08\"-\n\x18\x46indDirectMessageRequest\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x02\"\x8a\x01\n\x12UpdateSpaceRequest\x12)\n\x05space\x18\x01 \x01(\x0b\x32\x15.google.chat.v1.SpaceB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\x12\x18\n\x10use_admin_access\x18\x03 \x01(\x08\"\x81\x01\n\x13SearchSpacesRequest\x12\x18\n\x10use_admin_access\x18\x01 \x01(\x08\x12\x11\n\tpage_size\x18\x02 \x01(\x05\x12\x12\n\npage_token\x18\x03 \x01(\t\x12\x12\n\x05query\x18\x04 \x01(\tB\x03\xe0\x41\x02\x12\x15\n\x08order_by\x18\x05 \x01(\tB\x03\xe0\x41\x01\"j\n\x14SearchSpacesResponse\x12%\n\x06spaces\x18\x01 \x03(\x0b\x32\x15.google.chat.v1.Space\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12\x12\n\ntotal_size\x18\x03 \x01(\x05\"_\n\x12\x44\x65leteSpaceRequest\x12/\n\x04name\x18\x01 \x01(\tB!\xe0\x41\x02\xfa\x41\x1b\n\x19\x63hat.googleapis.com/Space\x12\x18\n\x10use_admin_access\x18\x02 \x01(\x08\"M\n\x1a\x43ompleteImportSpaceRequest\x12/\n\x04name\x18\x01 \x01(\tB!\xe0\x41\x02\xfa\x41\x1b\n\x19\x63hat.googleapis.com/Space\"C\n\x1b\x43ompleteImportSpaceResponse\x12$\n\x05space\x18\x01 \x01(\x0b\x32\x15.google.chat.v1.SpaceB\xa3\x01\n\x12\x63om.google.chat.v1B\nSpaceProtoP\x01Z,cloud.google.com/go/chat/apiv1/chatpb;chatpb\xa2\x02\x0b\x44YNAPIProto\xaa\x02\x13Google.Apps.Chat.V1\xca\x02\x13Google\\Apps\\Chat\\V1\xea\x02\x16Google::Apps::Chat::V1b\x06proto3"
|
15
15
|
|
16
16
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
17
17
|
|
@@ -48,9 +48,12 @@ module Google
|
|
48
48
|
Space::MembershipCount = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.MembershipCount").msgclass
|
49
49
|
Space::AccessSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.AccessSettings").msgclass
|
50
50
|
Space::AccessSettings::AccessState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.AccessSettings.AccessState").enummodule
|
51
|
+
Space::PermissionSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.PermissionSettings").msgclass
|
52
|
+
Space::PermissionSetting = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.PermissionSetting").msgclass
|
51
53
|
Space::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.Type").enummodule
|
52
54
|
Space::SpaceType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.SpaceType").enummodule
|
53
55
|
Space::SpaceThreadingState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.SpaceThreadingState").enummodule
|
56
|
+
Space::PredefinedPermissionSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.PredefinedPermissionSettings").enummodule
|
54
57
|
CreateSpaceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.CreateSpaceRequest").msgclass
|
55
58
|
ListSpacesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.ListSpacesRequest").msgclass
|
56
59
|
ListSpacesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.ListSpacesResponse").msgclass
|
@@ -73,8 +73,8 @@ module Google
|
|
73
73
|
# user](https://developers.google.com/workspace/chat/format-messages#messages-@mention),
|
74
74
|
# or everyone in the space.
|
75
75
|
#
|
76
|
-
# To learn about creating text messages, see [Send a
|
77
|
-
# message](https://developers.google.com/workspace/chat/create-messages
|
76
|
+
# To learn about creating text messages, see [Send a
|
77
|
+
# message](https://developers.google.com/workspace/chat/create-messages).
|
78
78
|
# @!attribute [r] formatted_text
|
79
79
|
# @return [::String]
|
80
80
|
# Output only. Contains the message `text` with markups added to communicate
|
@@ -118,8 +118,8 @@ module Google
|
|
118
118
|
# user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
|
119
119
|
# the messages can't contain cards.
|
120
120
|
#
|
121
|
-
# To learn
|
122
|
-
#
|
121
|
+
# To learn how to create a message that contains cards, see [Send a
|
122
|
+
# message](https://developers.google.com/workspace/chat/create-messages).
|
123
123
|
#
|
124
124
|
# [Card builder](https://addons.gsuite.google.com/uikit/builder)
|
125
125
|
# @!attribute [r] annotations
|
@@ -183,16 +183,17 @@ module Google
|
|
183
183
|
# @return [::Google::Apps::Chat::V1::User]
|
184
184
|
# Immutable. Input for creating a message, otherwise output only. The user
|
185
185
|
# that can view the message. When set, the message is private and only
|
186
|
-
# visible to the specified user and the Chat app.
|
187
|
-
#
|
186
|
+
# visible to the specified user and the Chat app. To include this field in
|
187
|
+
# your request, you must call the Chat API using [app
|
188
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
|
189
|
+
# and omit the following:
|
188
190
|
#
|
189
|
-
#
|
190
|
-
#
|
191
|
-
#
|
192
|
-
# to send a message, the message can't be private and must omit this field.
|
191
|
+
# * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments)
|
192
|
+
# * [Accessory
|
193
|
+
# widgets](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#Message.AccessoryWidget)
|
193
194
|
#
|
194
|
-
# For details, see [Send
|
195
|
-
#
|
195
|
+
# For details, see [Send a message
|
196
|
+
# privately](https://developers.google.com/workspace/chat/create-messages#private).
|
196
197
|
# @!attribute [r] deletion_metadata
|
197
198
|
# @return [::Google::Apps::Chat::V1::DeletionMetadata]
|
198
199
|
# Output only. Information about a deleted message. A message is deleted when
|
@@ -253,7 +254,7 @@ module Google
|
|
253
254
|
# field to determine what happens if no matching thread is found.
|
254
255
|
# @!attribute [rw] name
|
255
256
|
# @return [::String]
|
256
|
-
#
|
257
|
+
# Resource name of the thread.
|
257
258
|
#
|
258
259
|
# Example: `spaces/{space}/threads/{thread}`
|
259
260
|
# @!attribute [rw] thread_key
|
@@ -28,6 +28,13 @@ module Google
|
|
28
28
|
# Resource name of the space.
|
29
29
|
#
|
30
30
|
# Format: `spaces/{space}`
|
31
|
+
#
|
32
|
+
# Where `{space}` represents the system-assigned ID for the space. You can
|
33
|
+
# obtain the space ID by calling the
|
34
|
+
# [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list)
|
35
|
+
# method or from the space URL. For example, if the space URL
|
36
|
+
# is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID
|
37
|
+
# is `AAAAAAAAA`.
|
31
38
|
# @!attribute [r] type
|
32
39
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
33
40
|
# @return [::Google::Apps::Chat::V1::Space::Type]
|
@@ -49,11 +56,11 @@ module Google
|
|
49
56
|
# @!attribute [rw] display_name
|
50
57
|
# @return [::String]
|
51
58
|
# The space's display name. Required when [creating a
|
52
|
-
# space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create)
|
53
|
-
# If you receive the error message
|
54
|
-
# updating the `displayName`, try a
|
55
|
-
# existing space within the Google Workspace
|
56
|
-
# this display name.
|
59
|
+
# space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create)
|
60
|
+
# with a `spaceType` of `SPACE`. If you receive the error message
|
61
|
+
# `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a
|
62
|
+
# different `displayName`. An existing space within the Google Workspace
|
63
|
+
# organization might already use this display name.
|
57
64
|
#
|
58
65
|
# For direct messages, this field might be empty.
|
59
66
|
#
|
@@ -68,15 +75,6 @@ module Google
|
|
68
75
|
# account). By default, a space created by a consumer account permits any
|
69
76
|
# Google Chat user.
|
70
77
|
#
|
71
|
-
# * The space is used to [import data to Google Chat]
|
72
|
-
# (https://developers.google.com/chat/api/guides/import-data-overview)
|
73
|
-
# because import mode spaces must only permit members from the same
|
74
|
-
# Google Workspace organization. However, as part of the [Google
|
75
|
-
# Workspace Developer Preview
|
76
|
-
# Program](https://developers.google.com/workspace/preview), import mode
|
77
|
-
# spaces can permit any Google Chat user so this field can then be set
|
78
|
-
# for import mode spaces.
|
79
|
-
#
|
80
78
|
# For existing spaces, this field is output only.
|
81
79
|
# @!attribute [r] space_threading_state
|
82
80
|
# @return [::Google::Apps::Chat::V1::Space::SpaceThreadingState]
|
@@ -126,6 +124,17 @@ module Google
|
|
126
124
|
# @!attribute [r] space_uri
|
127
125
|
# @return [::String]
|
128
126
|
# Output only. The URI for a user to access the space.
|
127
|
+
# @!attribute [rw] predefined_permission_settings
|
128
|
+
# @return [::Google::Apps::Chat::V1::Space::PredefinedPermissionSettings]
|
129
|
+
# Optional. Input only. Predefined space permission settings, input only
|
130
|
+
# when creating a space. If the field is not set, a collaboration space is
|
131
|
+
# created. After you create the space, settings are populated in the
|
132
|
+
# `PermissionSettings` field.
|
133
|
+
# @!attribute [rw] permission_settings
|
134
|
+
# @return [::Google::Apps::Chat::V1::Space::PermissionSettings]
|
135
|
+
# Optional. Space permission settings for existing spaces. Input for
|
136
|
+
# updating exact space permission settings, where existing permission
|
137
|
+
# settings are replaced. Output lists current permission settings.
|
129
138
|
class Space
|
130
139
|
include ::Google::Protobuf::MessageExts
|
131
140
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -169,14 +178,19 @@ module Google
|
|
169
178
|
# @return [::String]
|
170
179
|
# Optional. The resource name of the [target
|
171
180
|
# audience](https://support.google.com/a/answer/9934697) who can discover
|
172
|
-
# the space, join the space, and preview the messages in the space.
|
173
|
-
#
|
181
|
+
# the space, join the space, and preview the messages in the space. If
|
182
|
+
# unset, only users or Google Groups who have been individually invited or
|
183
|
+
# added to the space can access it. For details, see [Make a space
|
184
|
+
# discoverable to a target
|
174
185
|
# audience](https://developers.google.com/workspace/chat/space-target-audience).
|
175
186
|
#
|
176
187
|
# Format: `audiences/{audience}`
|
177
188
|
#
|
178
189
|
# To use the default target audience for the Google Workspace organization,
|
179
190
|
# set to `audiences/default`.
|
191
|
+
#
|
192
|
+
# This field is not populated when using the `chat.bot` scope with [app
|
193
|
+
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
|
180
194
|
class AccessSettings
|
181
195
|
include ::Google::Protobuf::MessageExts
|
182
196
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -186,16 +200,66 @@ module Google
|
|
186
200
|
# Access state is unknown or not supported in this API.
|
187
201
|
ACCESS_STATE_UNSPECIFIED = 0
|
188
202
|
|
189
|
-
#
|
203
|
+
# Only users or Google Groups that have been individually added or
|
204
|
+
# invited by other users or Google Workspace administrators can discover
|
205
|
+
# and access the space.
|
190
206
|
PRIVATE = 1
|
191
207
|
|
192
|
-
#
|
193
|
-
#
|
194
|
-
#
|
208
|
+
# A space manager has granted a target audience access to
|
209
|
+
# the space. Users or Google Groups that have been individually added or
|
210
|
+
# invited to the space can also discover and access the space. To learn
|
211
|
+
# more, see [Make a space discoverable to specific
|
212
|
+
# users](https://developers.google.com/workspace/chat/space-target-audience).
|
195
213
|
DISCOVERABLE = 2
|
196
214
|
end
|
197
215
|
end
|
198
216
|
|
217
|
+
# [Permission settings](https://support.google.com/chat/answer/13340792)
|
218
|
+
# that you can specify when updating an existing named space.
|
219
|
+
#
|
220
|
+
# To set permission settings when creating a space, specify the
|
221
|
+
# `PredefinedPermissionSettings` field in your request.
|
222
|
+
# @!attribute [rw] manage_members_and_groups
|
223
|
+
# @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
|
224
|
+
# Setting for managing members and groups in a space.
|
225
|
+
# @!attribute [rw] modify_space_details
|
226
|
+
# @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
|
227
|
+
# Setting for updating space name, avatar, description and guidelines.
|
228
|
+
# @!attribute [rw] toggle_history
|
229
|
+
# @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
|
230
|
+
# Setting for toggling space history on and off.
|
231
|
+
# @!attribute [rw] use_at_mention_all
|
232
|
+
# @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
|
233
|
+
# Setting for using @all in a space.
|
234
|
+
# @!attribute [rw] manage_apps
|
235
|
+
# @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
|
236
|
+
# Setting for managing apps in a space.
|
237
|
+
# @!attribute [rw] manage_webhooks
|
238
|
+
# @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
|
239
|
+
# Setting for managing webhooks in a space.
|
240
|
+
# @!attribute [r] post_messages
|
241
|
+
# @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
|
242
|
+
# Output only. Setting for posting messages in a space.
|
243
|
+
# @!attribute [rw] reply_messages
|
244
|
+
# @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
|
245
|
+
# Setting for replying to messages in a space.
|
246
|
+
class PermissionSettings
|
247
|
+
include ::Google::Protobuf::MessageExts
|
248
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
249
|
+
end
|
250
|
+
|
251
|
+
# Represents a space permission setting.
|
252
|
+
# @!attribute [rw] managers_allowed
|
253
|
+
# @return [::Boolean]
|
254
|
+
# Whether spaces managers have this permission.
|
255
|
+
# @!attribute [rw] members_allowed
|
256
|
+
# @return [::Boolean]
|
257
|
+
# Whether non-manager members have this permission.
|
258
|
+
class PermissionSetting
|
259
|
+
include ::Google::Protobuf::MessageExts
|
260
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
261
|
+
end
|
262
|
+
|
199
263
|
# Deprecated: Use `SpaceType` instead.
|
200
264
|
module Type
|
201
265
|
# Reserved.
|
@@ -245,18 +309,39 @@ module Google
|
|
245
309
|
# 3 or more people.
|
246
310
|
UNTHREADED_MESSAGES = 4
|
247
311
|
end
|
312
|
+
|
313
|
+
# Predefined permission settings that you can only specify when creating a
|
314
|
+
# named space. More settings might be added in the future.
|
315
|
+
# For details about permission settings for named spaces, see [Learn about
|
316
|
+
# spaces](https://support.google.com/chat/answer/7659784).
|
317
|
+
module PredefinedPermissionSettings
|
318
|
+
# Unspecified. Don't use.
|
319
|
+
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED = 0
|
320
|
+
|
321
|
+
# Setting to make the space a collaboration space where all members can
|
322
|
+
# post messages.
|
323
|
+
COLLABORATION_SPACE = 1
|
324
|
+
|
325
|
+
# Setting to make the space an announcement space where only space managers
|
326
|
+
# can post messages.
|
327
|
+
ANNOUNCEMENT_SPACE = 2
|
328
|
+
end
|
248
329
|
end
|
249
330
|
|
250
|
-
# A request to create a named space.
|
331
|
+
# A request to create a named space with no members.
|
251
332
|
# @!attribute [rw] space
|
252
333
|
# @return [::Google::Apps::Chat::V1::Space]
|
253
334
|
# Required. The `displayName` and `spaceType` fields must be populated. Only
|
254
335
|
# `SpaceType.SPACE` is supported.
|
255
336
|
#
|
256
|
-
# If you receive the error message `ALREADY_EXISTS
|
337
|
+
# If you receive the error message `ALREADY_EXISTS`,
|
257
338
|
# try a different `displayName`. An existing space within the Google
|
258
339
|
# Workspace organization might already use this display name.
|
259
340
|
#
|
341
|
+
# If you're a member of the [Developer Preview
|
342
|
+
# program](https://developers.google.com/workspace/preview),
|
343
|
+
# `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true.
|
344
|
+
#
|
260
345
|
# The space `name` is assigned on the server so anything specified in this
|
261
346
|
# field will be ignored.
|
262
347
|
# @!attribute [rw] request_id
|
@@ -321,6 +406,8 @@ module Google
|
|
321
406
|
# @!attribute [rw] spaces
|
322
407
|
# @return [::Array<::Google::Apps::Chat::V1::Space>]
|
323
408
|
# List of spaces in the requested (or first) page.
|
409
|
+
# Note: The `permissionSettings` field is not returned in the Space
|
410
|
+
# object for list requests.
|
324
411
|
# @!attribute [rw] next_page_token
|
325
412
|
# @return [::String]
|
326
413
|
# You can send a token as `pageToken` to retrieve the next page of
|
@@ -384,54 +471,64 @@ module Google
|
|
384
471
|
# Required. The updated field paths, comma separated if there are
|
385
472
|
# multiple.
|
386
473
|
#
|
387
|
-
#
|
474
|
+
# You can update the following fields for a space:
|
388
475
|
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
# `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a
|
392
|
-
# `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument
|
393
|
-
# error. If you receive the error message `ALREADY_EXISTS` when updating the
|
394
|
-
# `displayName`, try a different `displayName`. An existing space within the
|
395
|
-
# Google Workspace organization might already use this display name.)
|
476
|
+
# `space_details`: Updates the space's description. Supports up to 150
|
477
|
+
# characters.
|
396
478
|
#
|
397
|
-
#
|
479
|
+
# `display_name`: Only supports updating the display name for spaces where
|
480
|
+
# `spaceType` field is `SPACE`.
|
481
|
+
# If you receive the error message `ALREADY_EXISTS`, try a different
|
482
|
+
# value. An existing space within the
|
483
|
+
# Google Workspace organization might already use this display name.
|
484
|
+
#
|
485
|
+
# `space_type`: Only supports changing a `GROUP_CHAT` space type to
|
398
486
|
# `SPACE`. Include `display_name` together
|
399
487
|
# with `space_type` in the update mask and ensure that the specified space
|
400
488
|
# has a non-empty display name and the `SPACE` space type. Including the
|
401
489
|
# `space_type` mask and the `SPACE` type in the specified space when updating
|
402
490
|
# the display name is optional if the existing space already has the `SPACE`
|
403
491
|
# type. Trying to update the space type in other ways results in an invalid
|
404
|
-
# argument error
|
405
|
-
# `space_type` is not supported with
|
406
|
-
#
|
407
|
-
# - `space_details`
|
492
|
+
# argument error.
|
493
|
+
# `space_type` is not supported with `useAdminAccess`.
|
408
494
|
#
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
#
|
413
|
-
#
|
414
|
-
# `space_history_state` is not supported with
|
495
|
+
# `space_history_state`: Updates [space history
|
496
|
+
# settings](https://support.google.com/chat/answer/7664687) by turning
|
497
|
+
# history on or off for the space. Only supported if history settings are
|
498
|
+
# enabled for the Google Workspace organization. To update the
|
499
|
+
# space history state, you must omit all other field masks in your request.
|
500
|
+
# `space_history_state` is not supported with `useAdminAccess`.
|
415
501
|
#
|
416
|
-
#
|
502
|
+
# `access_settings.audience`: Updates the [access
|
417
503
|
# setting](https://support.google.com/chat/answer/11971020) of who can
|
418
|
-
# discover the space, join the space, and preview the messages in space
|
419
|
-
#
|
420
|
-
#
|
421
|
-
#
|
422
|
-
#
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
428
|
-
# `
|
429
|
-
#
|
430
|
-
# `permission_settings
|
431
|
-
#
|
432
|
-
#
|
433
|
-
#
|
434
|
-
#
|
504
|
+
# discover the space, join the space, and preview the messages in named space
|
505
|
+
# where `spaceType` field is `SPACE`. If the existing space has a
|
506
|
+
# target audience, you can remove the audience and restrict space access by
|
507
|
+
# omitting a value for this field mask. To update access settings for a
|
508
|
+
# space, the authenticating user must be a space manager and omit all other
|
509
|
+
# field masks in your request. You can't update this field if the space is in
|
510
|
+
# [import
|
511
|
+
# mode](https://developers.google.com/workspace/chat/import-data-overview).
|
512
|
+
# To learn more, see [Make a space discoverable to specific
|
513
|
+
# users](https://developers.google.com/workspace/chat/space-target-audience).
|
514
|
+
# `access_settings.audience` is not supported with `useAdminAccess`.
|
515
|
+
#
|
516
|
+
# `permission_settings`: Supports changing the
|
517
|
+
# [permission settings](https://support.google.com/chat/answer/13340792)
|
518
|
+
# of a space.
|
519
|
+
# When updating permission settings, you can only specify
|
520
|
+
# `permissionSettings` field masks; you cannot update other field masks
|
521
|
+
# at the same time. `permissionSettings` is not supported with
|
522
|
+
# `useAdminAccess`.
|
523
|
+
# The supported field masks include:
|
524
|
+
#
|
525
|
+
# - `permission_settings.manageMembersAndGroups`
|
526
|
+
# - `permission_settings.modifySpaceDetails`
|
527
|
+
# - `permission_settings.toggleHistory`
|
528
|
+
# - `permission_settings.useAtMentionAll`
|
529
|
+
# - `permission_settings.manageApps`
|
530
|
+
# - `permission_settings.manageWebhooks`
|
531
|
+
# - `permission_settings.replyMessages`
|
435
532
|
# @!attribute [rw] use_admin_access
|
436
533
|
# @return [::Boolean]
|
437
534
|
# When `true`, the method runs using the user's Google Workspace
|
@@ -271,6 +271,8 @@ module Google
|
|
271
271
|
# @!attribute [rw] space_events
|
272
272
|
# @return [::Array<::Google::Apps::Chat::V1::SpaceEvent>]
|
273
273
|
# Results are returned in chronological order (oldest event first).
|
274
|
+
# Note: The `permissionSettings` field is not returned in the Space
|
275
|
+
# object for list requests.
|
274
276
|
# @!attribute [rw] next_page_token
|
275
277
|
# @return [::String]
|
276
278
|
# Continuation token used to fetch more events.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apps-chat-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.5.
|
4
|
+
version: 0.5.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-10-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
163
163
|
- !ruby/object:Gem::Version
|
164
164
|
version: '0'
|
165
165
|
requirements: []
|
166
|
-
rubygems_version: 3.5.
|
166
|
+
rubygems_version: 3.5.21
|
167
167
|
signing_key:
|
168
168
|
specification_version: 4
|
169
169
|
summary: The Google Chat API lets you build Chat apps to integrate your services with
|