google-apps-chat-v1 0.1.1 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/apps/chat/v1/chat_service/client.rb +119 -39
- data/lib/google/apps/chat/v1/chat_service/credentials.rb +5 -0
- data/lib/google/apps/chat/v1/chat_service/rest/client.rb +119 -39
- data/lib/google/apps/chat/v1/version.rb +1 -1
- data/lib/google/chat/v1/chat_service_pb.rb +1 -1
- data/lib/google/chat/v1/chat_service_services_pb.rb +25 -1
- data/lib/google/chat/v1/space_pb.rb +3 -1
- data/proto_docs/google/chat/v1/attachment.rb +2 -2
- data/proto_docs/google/chat/v1/membership.rb +8 -4
- data/proto_docs/google/chat/v1/space.rb +66 -6
- data/proto_docs/google/chat/v1/space_setup.rb +6 -2
- metadata +2 -2
@@ -165,6 +165,9 @@ module Google
|
|
165
165
|
# Lists spaces visible to the caller or authenticated user. Group chats
|
166
166
|
# and DMs aren't listed until the first message is sent.
|
167
167
|
#
|
168
|
+
# To list all named spaces by Google Workspace organization, use the
|
169
|
+
# [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
|
170
|
+
# method using Workspace administrator privileges instead.
|
168
171
|
rpc :ListSpaces, ::Google::Apps::Chat::V1::ListSpacesRequest, ::Google::Apps::Chat::V1::ListSpacesResponse
|
169
172
|
# Returns details about a space. For an example, see
|
170
173
|
# [Get details about a
|
@@ -204,6 +207,17 @@ module Google
|
|
204
207
|
# you can add the user to the space by setting the `membership.member.name`
|
205
208
|
# to `users/user@example.com` or `users/123456789`.
|
206
209
|
#
|
210
|
+
# To specify the Google groups to add, add memberships with the
|
211
|
+
# appropriate `membership.group_member.name`. To add or invite a Google
|
212
|
+
# group, use `groups/{group}`, where `{group}` is the `id` for the group from
|
213
|
+
# the Cloud Identity Groups API. For example, you can use [Cloud Identity
|
214
|
+
# Groups lookup
|
215
|
+
# API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
|
216
|
+
# to retrieve the ID `123456789` for group email `group@example.com`, then
|
217
|
+
# you can add the group to the space by setting the
|
218
|
+
# `membership.group_member.name` to `groups/123456789`. Group email is not
|
219
|
+
# supported, and Google groups can only be added as members in named spaces.
|
220
|
+
#
|
207
221
|
# For a named space or group chat, if the caller blocks, or is blocked
|
208
222
|
# by some members, or doesn't have permission to add some members, then
|
209
223
|
# those members aren't added to the created space.
|
@@ -289,7 +303,8 @@ module Google
|
|
289
303
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
290
304
|
#
|
291
305
|
# To specify the member to add, set the `membership.member.name` for the
|
292
|
-
# human or app member.
|
306
|
+
# human or app member, or set the `membership.group_member.name` for the
|
307
|
+
# group member.
|
293
308
|
#
|
294
309
|
# - To add the calling app to a space or a direct message between two human
|
295
310
|
# users, use `users/app`. Unable to add other
|
@@ -302,6 +317,15 @@ module Google
|
|
302
317
|
# profile ID for `user@example.com` is `123456789`, you can add the user to
|
303
318
|
# the space by setting the `membership.member.name` to
|
304
319
|
# `users/user@example.com` or `users/123456789`.
|
320
|
+
#
|
321
|
+
# - To add or invite a Google group in a named space, use
|
322
|
+
# `groups/{group}`, where `{group}` is the `id` for the group from the Cloud
|
323
|
+
# Identity Groups API. For example, you can use [Cloud Identity Groups lookup
|
324
|
+
# API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
|
325
|
+
# to retrieve the ID `123456789` for group email `group@example.com`, then
|
326
|
+
# you can add or invite the group to a named space by setting the
|
327
|
+
# `membership.group_member.name` to `groups/123456789`. Group email is not
|
328
|
+
# supported, and Google groups can only be added as members in named spaces.
|
305
329
|
rpc :CreateMembership, ::Google::Apps::Chat::V1::CreateMembershipRequest, ::Google::Apps::Chat::V1::Membership
|
306
330
|
# Updates a membership. For an example, see [Update a user's membership in
|
307
331
|
# a space](https://developers.google.com/workspace/chat/update-members).
|
@@ -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\"\xba\t\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\x1c\n\x0f\x61\x64min_installed\x18\x13 \x01(\x08\x42\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\x1a\x37\n\x0cSpaceDetails\x12\x13\n\x0b\x64\x65scription\x18\x01 \x01(\t\x12\x12\n\nguidelines\x18\x02 \x01(\t\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\".\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:.\xea\x41+\n\x19\x63hat.googleapis.com/Space\x12\x0espaces/{space}\"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\"B\n\x0fGetSpaceRequest\x12/\n\x04name\x18\x01 \x01(\tB!\xe0\x41\x02\xfa\x41\x1b\n\x19\x63hat.googleapis.com/Space\"-\n\x18\x46indDirectMessageRequest\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x02\"p\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\"E\n\x12\x44\x65leteSpaceRequest\x12/\n\x04name\x18\x01 \x01(\tB!\xe0\x41\x02\xfa\x41\x1b\n\x19\x63hat.googleapis.com/Space\"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
|
|
@@ -45,6 +45,8 @@ module Google
|
|
45
45
|
module V1
|
46
46
|
Space = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space").msgclass
|
47
47
|
Space::SpaceDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.SpaceDetails").msgclass
|
48
|
+
Space::AccessSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.AccessSettings").msgclass
|
49
|
+
Space::AccessSettings::AccessState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.AccessSettings.AccessState").enummodule
|
48
50
|
Space::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.Type").enummodule
|
49
51
|
Space::SpaceType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.SpaceType").enummodule
|
50
52
|
Space::SpaceThreadingState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.SpaceThreadingState").enummodule
|
@@ -25,7 +25,7 @@ module Google
|
|
25
25
|
# @!attribute [rw] name
|
26
26
|
# @return [::String]
|
27
27
|
# Resource name of the attachment, in the form
|
28
|
-
# `spaces
|
28
|
+
# `spaces/{space}/messages/{message}/attachments/{attachment}`.
|
29
29
|
# @!attribute [r] content_name
|
30
30
|
# @return [::String]
|
31
31
|
# Output only. The original file name for the content, not the full path.
|
@@ -98,7 +98,7 @@ module Google
|
|
98
98
|
# @!attribute [rw] name
|
99
99
|
# @return [::String]
|
100
100
|
# Required. Resource name of the attachment, in the form
|
101
|
-
# `spaces
|
101
|
+
# `spaces/{space}/messages/{message}/attachments/{attachment}`.
|
102
102
|
class GetAttachmentRequest
|
103
103
|
include ::Google::Protobuf::MessageExts
|
104
104
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -48,8 +48,6 @@ module Google
|
|
48
48
|
# @!attribute [rw] group_member
|
49
49
|
# @return [::Google::Apps::Chat::V1::Group]
|
50
50
|
# The Google Group the membership corresponds to.
|
51
|
-
# Only supports read operations. Other operations, like
|
52
|
-
# creating or updating a membership, aren't currently supported.
|
53
51
|
# @!attribute [rw] create_time
|
54
52
|
# @return [::Google::Protobuf::Timestamp]
|
55
53
|
# Optional. Immutable. The creation time of the membership, such as when a
|
@@ -188,16 +186,23 @@ module Google
|
|
188
186
|
#
|
189
187
|
# To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
|
190
188
|
#
|
191
|
-
# To filter by type, set `member.type` to `HUMAN` or `BOT`.
|
189
|
+
# To filter by type, set `member.type` to `HUMAN` or `BOT`. Developer
|
190
|
+
# Preview: You can also filter for `member.type` using the `!=` operator.
|
192
191
|
#
|
193
192
|
# To filter by both role and type, use the `AND` operator. To filter by
|
194
193
|
# either role or type, use the `OR` operator.
|
195
194
|
#
|
195
|
+
# Either `member.type = "HUMAN"` or `member.type != "BOT"` is required
|
196
|
+
# when `use_admin_access` is set to true. Other member type filters will be
|
197
|
+
# rejected.
|
198
|
+
#
|
196
199
|
# For example, the following queries are valid:
|
197
200
|
#
|
198
201
|
# ```
|
199
202
|
# role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
|
200
203
|
# member.type = "HUMAN" AND role = "ROLE_MANAGER"
|
204
|
+
#
|
205
|
+
# member.type != "BOT"
|
201
206
|
# ```
|
202
207
|
#
|
203
208
|
# The following queries are invalid:
|
@@ -207,7 +212,6 @@ module Google
|
|
207
212
|
# role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
|
208
213
|
# ```
|
209
214
|
#
|
210
|
-
#
|
211
215
|
# Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
|
212
216
|
# error.
|
213
217
|
# @!attribute [rw] show_groups
|
@@ -110,6 +110,14 @@ module Google
|
|
110
110
|
# their organization.
|
111
111
|
#
|
112
112
|
# To support admin install, your Chat app must feature direct messaging.
|
113
|
+
# @!attribute [rw] access_settings
|
114
|
+
# @return [::Google::Apps::Chat::V1::Space::AccessSettings]
|
115
|
+
# Optional. Specifies the [access
|
116
|
+
# setting](https://support.google.com/chat/answer/11971020) of the space.
|
117
|
+
# Only populated when the `space_type` is `SPACE`.
|
118
|
+
# @!attribute [r] space_uri
|
119
|
+
# @return [::String]
|
120
|
+
# Output only. The URI for a user to access the space.
|
113
121
|
class Space
|
114
122
|
include ::Google::Protobuf::MessageExts
|
115
123
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -131,6 +139,42 @@ module Google
|
|
131
139
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
132
140
|
end
|
133
141
|
|
142
|
+
# Represents the [access
|
143
|
+
# setting](https://support.google.com/chat/answer/11971020) of the space.
|
144
|
+
# @!attribute [r] access_state
|
145
|
+
# @return [::Google::Apps::Chat::V1::Space::AccessSettings::AccessState]
|
146
|
+
# Output only. Indicates the access state of the space.
|
147
|
+
# @!attribute [rw] audience
|
148
|
+
# @return [::String]
|
149
|
+
# Optional. The resource name of the [target
|
150
|
+
# audience](https://support.google.com/a/answer/9934697) who can discover
|
151
|
+
# the space, join the space, and preview the messages in the space. For
|
152
|
+
# details, see [Make a space discoverable to a target
|
153
|
+
# audience](https://developers.google.com/workspace/chat/space-target-audience).
|
154
|
+
#
|
155
|
+
# Format: `audiences/{audience}`
|
156
|
+
#
|
157
|
+
# To use the default target audience for the Google Workspace organization,
|
158
|
+
# set to `audiences/default`.
|
159
|
+
class AccessSettings
|
160
|
+
include ::Google::Protobuf::MessageExts
|
161
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
162
|
+
|
163
|
+
# Represents the access state of the space.
|
164
|
+
module AccessState
|
165
|
+
# Access state is unknown or not supported in this API.
|
166
|
+
ACCESS_STATE_UNSPECIFIED = 0
|
167
|
+
|
168
|
+
# Space is discoverable by added or invited members or groups.
|
169
|
+
PRIVATE = 1
|
170
|
+
|
171
|
+
# Space is discoverable by the selected [target
|
172
|
+
# audience](https://support.google.com/a/answer/9934697), as well as
|
173
|
+
# added or invited members or groups.
|
174
|
+
DISCOVERABLE = 2
|
175
|
+
end
|
176
|
+
end
|
177
|
+
|
134
178
|
# Deprecated: Use `SpaceType` instead.
|
135
179
|
module Type
|
136
180
|
# Reserved.
|
@@ -268,7 +312,7 @@ module Google
|
|
268
312
|
# A request to return a single space.
|
269
313
|
# @!attribute [rw] name
|
270
314
|
# @return [::String]
|
271
|
-
# Required. Resource name of the space, in the form
|
315
|
+
# Required. Resource name of the space, in the form `spaces/{space}`.
|
272
316
|
#
|
273
317
|
# Format: `spaces/{space}`
|
274
318
|
class GetSpaceRequest
|
@@ -326,6 +370,7 @@ module Google
|
|
326
370
|
# the display name is optional if the existing space already has the `SPACE`
|
327
371
|
# type. Trying to update the space type in other ways results in an invalid
|
328
372
|
# argument error).
|
373
|
+
# `space_type` is not supported with admin access.
|
329
374
|
#
|
330
375
|
# - `space_details`
|
331
376
|
#
|
@@ -334,12 +379,27 @@ module Google
|
|
334
379
|
# allows users to change their history
|
335
380
|
# setting](https://support.google.com/a/answer/7664184).
|
336
381
|
# Warning: mutually exclusive with all other field paths.)
|
382
|
+
# `space_history_state` is not supported with admin access.
|
383
|
+
#
|
384
|
+
# - `access_settings.audience` (Supports changing the [access
|
385
|
+
# setting](https://support.google.com/chat/answer/11971020) of who can
|
386
|
+
# discover the space, join the space, and preview the messages in space. If
|
387
|
+
# no audience is specified in the access setting, the space's access setting
|
388
|
+
# is updated to private. Warning: mutually exclusive with all other field
|
389
|
+
# paths.)
|
390
|
+
# `access_settings.audience` is not supported with admin access.
|
337
391
|
#
|
338
|
-
# - Developer Preview:
|
339
|
-
#
|
340
|
-
#
|
341
|
-
#
|
342
|
-
#
|
392
|
+
# - Developer Preview: Supports changing the [permission
|
393
|
+
# settings](https://support.google.com/chat/answer/13340792) of a space,
|
394
|
+
# supported field paths
|
395
|
+
# include: `permission_settings.manage_members_and_groups`,
|
396
|
+
# `permission_settings.modify_space_details`,
|
397
|
+
# `permission_settings.toggle_history`,
|
398
|
+
# `permission_settings.use_at_mention_all`,
|
399
|
+
# `permission_settings.manage_apps`, `permission_settings.manage_webhooks`,
|
400
|
+
# `permission_settings.reply_messages`
|
401
|
+
# (Warning: mutually exclusive with all other non-permission settings field
|
402
|
+
# paths). `permission_settings` is not supported with admin access.
|
343
403
|
class UpdateSpaceRequest
|
344
404
|
include ::Google::Protobuf::MessageExts
|
345
405
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -57,8 +57,8 @@ module Google
|
|
57
57
|
# authenticated user returns an error.
|
58
58
|
# @!attribute [rw] memberships
|
59
59
|
# @return [::Array<::Google::Apps::Chat::V1::Membership>]
|
60
|
-
# Optional. The Google Chat users to invite to join the space. Omit
|
61
|
-
# calling user, as they are added automatically.
|
60
|
+
# Optional. The Google Chat users or groups to invite to join the space. Omit
|
61
|
+
# the calling user, as they are added automatically.
|
62
62
|
#
|
63
63
|
# The set currently allows up to 20 memberships (in addition to the caller).
|
64
64
|
#
|
@@ -71,6 +71,10 @@ module Google
|
|
71
71
|
# To invite Gmail users or users from external Google Workspace domains,
|
72
72
|
# user's email must be used for `{user}`.
|
73
73
|
#
|
74
|
+
# For Google group membership, the `Membership.group_member` field must
|
75
|
+
# contain a `group` with `name` populated (format `groups/{group}`). You
|
76
|
+
# can only add Google groups when setting `Space.spaceType` to `SPACE`.
|
77
|
+
#
|
74
78
|
# Optional when setting `Space.spaceType` to `SPACE`.
|
75
79
|
#
|
76
80
|
# Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at
|
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.
|
4
|
+
version: 0.2.0
|
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-07-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|