google-apps-chat-v1 0.6.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -24,7 +24,7 @@ module Google
24
24
  # A message in a Google Chat space.
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
- # Resource name of the message.
27
+ # Identifier. Resource name of the message.
28
28
  #
29
29
  # Format: `spaces/{space}/messages/{message}`
30
30
  #
@@ -66,10 +66,10 @@ module Google
66
66
  # Google Chat. If the message is never deleted, this field is empty.
67
67
  # @!attribute [rw] text
68
68
  # @return [::String]
69
- # Plain-text body of the message. The first link to an image, video, or web
70
- # page generates a
71
- # [preview chip](https://developers.google.com/workspace/chat/preview-links).
72
- # You can also [@mention a Google Chat
69
+ # Optional. Plain-text body of the message. The first link to an image,
70
+ # video, or web page generates a [preview
71
+ # chip](https://developers.google.com/workspace/chat/preview-links). You can
72
+ # also [@mention a Google Chat
73
73
  # user](https://developers.google.com/workspace/chat/format-messages#messages-@mention),
74
74
  # or everyone in the space.
75
75
  #
@@ -111,7 +111,7 @@ module Google
111
111
  # `cards_v2` can have a maximum size of 32 KB.
112
112
  # @!attribute [rw] cards_v2
113
113
  # @return [::Array<::Google::Apps::Chat::V1::CardWithId>]
114
- # An array of
114
+ # Optional. An array of
115
115
  # [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards).
116
116
  #
117
117
  # Only Chat apps can create cards. If your Chat app [authenticates as a
@@ -130,17 +130,17 @@ module Google
130
130
  # The thread the message belongs to. For example usage, see
131
131
  # [Start or reply to a message
132
132
  # thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).
133
- # @!attribute [rw] space
133
+ # @!attribute [r] space
134
134
  # @return [::Google::Apps::Chat::V1::Space]
135
- # If your Chat app [authenticates as a
135
+ # Output only. If your Chat app [authenticates as a
136
136
  # user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
137
- # the output populates the
137
+ # the output only populates the
138
138
  # [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces)
139
139
  # `name`.
140
140
  # @!attribute [rw] fallback_text
141
141
  # @return [::String]
142
- # A plain-text description of the message's cards, used when the actual cards
143
- # can't be displayed—for example, mobile notifications.
142
+ # Optional. A plain-text description of the message's cards, used when the
143
+ # actual cards can't be displayed—for example, mobile notifications.
144
144
  # @!attribute [rw] action_response
145
145
  # @return [::Google::Apps::Chat::V1::ActionResponse]
146
146
  # Input only. Parameters that a Chat app can use to configure how its
@@ -154,7 +154,7 @@ module Google
154
154
  # Output only. Slash command information, if applicable.
155
155
  # @!attribute [rw] attachment
156
156
  # @return [::Array<::Google::Apps::Chat::V1::Attachment>]
157
- # User-uploaded attachment.
157
+ # Optional. User-uploaded attachment.
158
158
  # @!attribute [r] matched_url
159
159
  # @return [::Google::Apps::Chat::V1::MatchedUrl]
160
160
  # Output only. A URL in `spaces.messages.text` that matches a link preview
@@ -181,10 +181,10 @@ module Google
181
181
  # Output only. The list of emoji reaction summaries on the message.
182
182
  # @!attribute [rw] private_message_viewer
183
183
  # @return [::Google::Apps::Chat::V1::User]
184
- # Immutable. Input for creating a message, otherwise output only. The user
185
- # that can view the message. When set, the message is private and only
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
184
+ # Optional. Immutable. Input for creating a message, otherwise output only.
185
+ # The user that can view the message. When set, the message is private and
186
+ # only visible to the specified user and the Chat app. To include this field
187
+ # in your request, you must call the Chat API using [app
188
188
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
189
189
  # and omit the following:
190
190
  #
@@ -207,10 +207,10 @@ module Google
207
207
  # Output only. GIF images that are attached to the message.
208
208
  # @!attribute [rw] accessory_widgets
209
209
  # @return [::Array<::Google::Apps::Chat::V1::AccessoryWidget>]
210
- # One or more interactive widgets that appear at the bottom of a message.
211
- # You can add accessory widgets to messages that contain text, cards, or both
212
- # text and cards. Not supported for messages that contain dialogs. For
213
- # details, see [Add interactive widgets at the bottom of a
210
+ # Optional. One or more interactive widgets that appear at the bottom of a
211
+ # message. You can add accessory widgets to messages that contain text,
212
+ # cards, or both text and cards. Not supported for messages that contain
213
+ # dialogs. For details, see [Add interactive widgets at the bottom of a
214
214
  # message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).
215
215
  #
216
216
  # Creating a message with accessory widgets requires [app
@@ -254,7 +254,7 @@ module Google
254
254
  # field to determine what happens if no matching thread is found.
255
255
  # @!attribute [rw] name
256
256
  # @return [::String]
257
- # Resource name of the thread.
257
+ # Identifier. Resource name of the thread.
258
258
  #
259
259
  # Example: `spaces/{space}/threads/{thread}`
260
260
  # @!attribute [rw] thread_key
@@ -301,8 +301,8 @@ module Google
301
301
  extend ::Google::Protobuf::MessageExts::ClassMethods
302
302
  end
303
303
 
304
- # The response of the updated widget.
305
- # Used to provide autocomplete options for a widget.
304
+ # For `selectionInput` widgets, returns autocomplete suggestions for a
305
+ # multiselect menu.
306
306
  # @!attribute [rw] suggestions
307
307
  # @return [::Google::Apps::Chat::V1::ActionResponse::SelectionItems]
308
308
  # List of widget autocomplete results
@@ -384,8 +384,8 @@ module Google
384
384
  # (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
385
385
  # @!attribute [rw] force
386
386
  # @return [::Boolean]
387
- # When `true`, deleting a message also deletes its threaded replies. When
388
- # `false`, if a message has threaded replies, deletion fails.
387
+ # Optional. When `true`, deleting a message also deletes its threaded
388
+ # replies. When `false`, if a message has threaded replies, deletion fails.
389
389
  #
390
390
  # Only applies when [authenticating as a
391
391
  # user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -458,6 +458,12 @@ module Google
458
458
  # @return [::Google::Apps::Chat::V1::CreateMessageRequest::MessageReplyOption]
459
459
  # Optional. Specifies whether a message starts a thread or replies to one.
460
460
  # Only supported in named spaces.
461
+ #
462
+ # When [responding to user
463
+ # interactions](https://developers.google.com/workspace/chat/receive-respond-interactions),
464
+ # this field is ignored. For interactions within a thread, the reply is
465
+ # created in the same thread. Otherwise, the reply is created as a new
466
+ # thread.
461
467
  # @!attribute [rw] message_id
462
468
  # @return [::String]
463
469
  # Optional. A custom ID for a message. Lets Chat apps get, update, or delete
@@ -510,8 +516,8 @@ module Google
510
516
  # Format: `spaces/{space}`
511
517
  # @!attribute [rw] page_size
512
518
  # @return [::Integer]
513
- # The maximum number of messages returned. The service might return fewer
514
- # messages than this value.
519
+ # Optional. The maximum number of messages returned. The service might return
520
+ # fewer messages than this value.
515
521
  #
516
522
  # If unspecified, at most 25 are returned.
517
523
  #
@@ -521,17 +527,15 @@ module Google
521
527
  # Negative values return an `INVALID_ARGUMENT` error.
522
528
  # @!attribute [rw] page_token
523
529
  # @return [::String]
524
- # Optional, if resuming from a previous query.
525
- #
526
- # A page token received from a previous list messages call. Provide this
527
- # parameter to retrieve the subsequent page.
530
+ # Optional. A page token received from a previous list messages call. Provide
531
+ # this parameter to retrieve the subsequent page.
528
532
  #
529
533
  # When paginating, all other parameters provided should match the call that
530
534
  # provided the page token. Passing different values to the other parameters
531
535
  # might lead to unexpected results.
532
536
  # @!attribute [rw] filter
533
537
  # @return [::String]
534
- # A query filter.
538
+ # Optional. A query filter.
535
539
  #
536
540
  # You can filter messages by date (`create_time`) and thread (`thread.name`).
537
541
  #
@@ -570,10 +574,8 @@ module Google
570
574
  # error.
571
575
  # @!attribute [rw] order_by
572
576
  # @return [::String]
573
- # Optional, if resuming from a previous query.
574
- #
575
- # How the list of messages is ordered. Specify a value to order by an
576
- # ordering operation. Valid ordering operation values are as follows:
577
+ # Optional. How the list of messages is ordered. Specify a value to order by
578
+ # an ordering operation. Valid ordering operation values are as follows:
577
579
  #
578
580
  # - `ASC` for ascending.
579
581
  #
@@ -582,8 +584,9 @@ module Google
582
584
  # The default ordering is `create_time ASC`.
583
585
  # @!attribute [rw] show_deleted
584
586
  # @return [::Boolean]
585
- # Whether to include deleted messages. Deleted messages include deleted time
586
- # and metadata about their deletion, but message content is unavailable.
587
+ # Optional. Whether to include deleted messages. Deleted messages include
588
+ # deleted time and metadata about their deletion, but message content is
589
+ # unavailable.
587
590
  class ListMessagesRequest
588
591
  include ::Google::Protobuf::MessageExts
589
592
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -24,7 +24,7 @@ module Google
24
24
  # A reaction to a message.
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
- # The resource name of the reaction.
27
+ # Identifier. The resource name of the reaction.
28
28
  #
29
29
  # Format: `spaces/{space}/messages/{message}/reactions/{reaction}`
30
30
  # @!attribute [r] user
@@ -32,7 +32,7 @@ module Google
32
32
  # Output only. The user who created the reaction.
33
33
  # @!attribute [rw] emoji
34
34
  # @return [::Google::Apps::Chat::V1::Emoji]
35
- # The emoji used in the reaction.
35
+ # Required. The emoji used in the reaction.
36
36
  class Reaction
37
37
  include ::Google::Protobuf::MessageExts
38
38
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -41,10 +41,14 @@ module Google
41
41
  # An emoji that is used as a reaction to a message.
42
42
  # @!attribute [rw] unicode
43
43
  # @return [::String]
44
- # A basic emoji represented by a unicode string.
44
+ # Optional. A basic emoji represented by a unicode string.
45
+ #
46
+ # Note: The following fields are mutually exclusive: `unicode`, `custom_emoji`. If a field in that set is populated, all other fields in the set will automatically be cleared.
45
47
  # @!attribute [r] custom_emoji
46
48
  # @return [::Google::Apps::Chat::V1::CustomEmoji]
47
49
  # Output only. A custom emoji.
50
+ #
51
+ # Note: The following fields are mutually exclusive: `custom_emoji`, `unicode`. If a field in that set is populated, all other fields in the set will automatically be cleared.
48
52
  class Emoji
49
53
  include ::Google::Protobuf::MessageExts
50
54
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -60,12 +64,12 @@ module Google
60
64
  end
61
65
 
62
66
  # The number of people who reacted to a message with a specific emoji.
63
- # @!attribute [rw] emoji
67
+ # @!attribute [r] emoji
64
68
  # @return [::Google::Apps::Chat::V1::Emoji]
65
- # Emoji associated with the reactions.
66
- # @!attribute [rw] reaction_count
69
+ # Output only. Emoji associated with the reactions.
70
+ # @!attribute [r] reaction_count
67
71
  # @return [::Integer]
68
- # The total number of reactions using the associated emoji.
72
+ # Output only. The total number of reactions using the associated emoji.
69
73
  class EmojiReactionSummary
70
74
  include ::Google::Protobuf::MessageExts
71
75
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -25,7 +25,7 @@ module Google
25
25
  # or 1:1 messages between a user and a Chat app.
26
26
  # @!attribute [rw] name
27
27
  # @return [::String]
28
- # Resource name of the space.
28
+ # Identifier. Resource name of the space.
29
29
  #
30
30
  # Format: `spaces/{space}`
31
31
  #
@@ -42,8 +42,8 @@ module Google
42
42
  # The type of a space.
43
43
  # @!attribute [rw] space_type
44
44
  # @return [::Google::Apps::Chat::V1::Space::SpaceType]
45
- # The type of space. Required when creating a space or updating the space
46
- # type of a space. Output only for other usage.
45
+ # Optional. The type of space. Required when creating a space or updating the
46
+ # space type of a space. Output only for other usage.
47
47
  # @!attribute [rw] single_user_bot_dm
48
48
  # @return [::Boolean]
49
49
  # Optional. Whether the space is a DM between a Chat app and a single
@@ -55,7 +55,7 @@ module Google
55
55
  # Whether messages are threaded in this space.
56
56
  # @!attribute [rw] display_name
57
57
  # @return [::String]
58
- # The space's display name. Required when [creating a
58
+ # Optional. The space's display name. Required when [creating a
59
59
  # space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create)
60
60
  # with a `spaceType` of `SPACE`. If you receive the error message
61
61
  # `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a
@@ -67,9 +67,9 @@ module Google
67
67
  # Supports up to 128 characters.
68
68
  # @!attribute [rw] external_user_allowed
69
69
  # @return [::Boolean]
70
- # Immutable. Whether this space permits any Google Chat user as a member.
71
- # Input when creating a space in a Google Workspace organization. Omit this
72
- # field when creating spaces in the following conditions:
70
+ # Optional. Immutable. Whether this space permits any Google Chat user as a
71
+ # member. Input when creating a space in a Google Workspace organization.
72
+ # Omit this field when creating spaces in the following conditions:
73
73
  #
74
74
  # * The authenticated user uses a consumer account (unmanaged user
75
75
  # account). By default, a space created by a consumer account permits any
@@ -81,15 +81,18 @@ module Google
81
81
  # Output only. The threading state in the Chat space.
82
82
  # @!attribute [rw] space_details
83
83
  # @return [::Google::Apps::Chat::V1::Space::SpaceDetails]
84
- # Details about the space including description and rules.
84
+ # Optional. Details about the space including description and rules.
85
85
  # @!attribute [rw] space_history_state
86
86
  # @return [::Google::Apps::Chat::V1::HistoryState]
87
- # The message history state for messages and threads in this space.
87
+ # Optional. The message history state for messages and threads in this space.
88
88
  # @!attribute [rw] import_mode
89
89
  # @return [::Boolean]
90
90
  # Optional. Whether this space is created in `Import Mode` as part of a data
91
91
  # migration into Google Workspace. While spaces are being imported, they
92
92
  # aren't visible to users until the import is complete.
93
+ #
94
+ # Creating a space in `Import Mode`requires [user
95
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
93
96
  # @!attribute [rw] create_time
94
97
  # @return [::Google::Protobuf::Timestamp]
95
98
  # Optional. Immutable. For spaces created in Chat, the time the space was
@@ -130,11 +133,15 @@ module Google
130
133
  # when creating a space. If the field is not set, a collaboration space is
131
134
  # created. After you create the space, settings are populated in the
132
135
  # `PermissionSettings` field.
136
+ #
137
+ # Note: The following fields are mutually exclusive: `predefined_permission_settings`, `permission_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared.
133
138
  # @!attribute [rw] permission_settings
134
139
  # @return [::Google::Apps::Chat::V1::Space::PermissionSettings]
135
140
  # Optional. Space permission settings for existing spaces. Input for
136
141
  # updating exact space permission settings, where existing permission
137
142
  # settings are replaced. Output lists current permission settings.
143
+ #
144
+ # Note: The following fields are mutually exclusive: `permission_settings`, `predefined_permission_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared.
138
145
  # @!attribute [r] import_mode_expire_time
139
146
  # @return [::Google::Protobuf::Timestamp]
140
147
  # Output only. The time when the space will be automatically deleted by the
@@ -166,13 +173,13 @@ module Google
166
173
  end
167
174
 
168
175
  # Represents the count of memberships of a space, grouped into categories.
169
- # @!attribute [rw] joined_direct_human_user_count
176
+ # @!attribute [r] joined_direct_human_user_count
170
177
  # @return [::Integer]
171
- # Count of human users that have directly joined the space, not counting
172
- # users joined by having membership in a joined group.
173
- # @!attribute [rw] joined_group_count
178
+ # Output only. Count of human users that have directly joined the space,
179
+ # not counting users joined by having membership in a joined group.
180
+ # @!attribute [r] joined_group_count
174
181
  # @return [::Integer]
175
- # Count of all groups that have directly joined the space.
182
+ # Output only. Count of all groups that have directly joined the space.
176
183
  class MembershipCount
177
184
  include ::Google::Protobuf::MessageExts
178
185
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -198,8 +205,23 @@ module Google
198
205
  # To use the default target audience for the Google Workspace organization,
199
206
  # set to `audiences/default`.
200
207
  #
208
+ # Reading the target audience supports:
209
+ #
210
+ # - [User
211
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
212
+ #
213
+ # - [App
214
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
215
+ # with [administrator
216
+ # approval](https://support.google.com/a?p=chat-app-auth)
217
+ # with the `chat.app.spaces` scope in [Developer
218
+ # Preview](https://developers.google.com/workspace/preview).
219
+ #
201
220
  # This field is not populated when using the `chat.bot` scope with [app
202
221
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
222
+ #
223
+ # Setting the target audience requires [user
224
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
203
225
  class AccessSettings
204
226
  include ::Google::Protobuf::MessageExts
205
227
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -219,6 +241,9 @@ module Google
219
241
  # invited to the space can also discover and access the space. To learn
220
242
  # more, see [Make a space discoverable to specific
221
243
  # users](https://developers.google.com/workspace/chat/space-target-audience).
244
+ #
245
+ # Creating discoverable spaces requires [user
246
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
222
247
  DISCOVERABLE = 2
223
248
  end
224
249
  end
@@ -230,28 +255,29 @@ module Google
230
255
  # `PredefinedPermissionSettings` field in your request.
231
256
  # @!attribute [rw] manage_members_and_groups
232
257
  # @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
233
- # Setting for managing members and groups in a space.
258
+ # Optional. Setting for managing members and groups in a space.
234
259
  # @!attribute [rw] modify_space_details
235
260
  # @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
236
- # Setting for updating space name, avatar, description and guidelines.
261
+ # Optional. Setting for updating space name, avatar, description and
262
+ # guidelines.
237
263
  # @!attribute [rw] toggle_history
238
264
  # @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
239
- # Setting for toggling space history on and off.
265
+ # Optional. Setting for toggling space history on and off.
240
266
  # @!attribute [rw] use_at_mention_all
241
267
  # @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
242
- # Setting for using @all in a space.
268
+ # Optional. Setting for using @all in a space.
243
269
  # @!attribute [rw] manage_apps
244
270
  # @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
245
- # Setting for managing apps in a space.
271
+ # Optional. Setting for managing apps in a space.
246
272
  # @!attribute [rw] manage_webhooks
247
273
  # @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
248
- # Setting for managing webhooks in a space.
274
+ # Optional. Setting for managing webhooks in a space.
249
275
  # @!attribute [r] post_messages
250
276
  # @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
251
277
  # Output only. Setting for posting messages in a space.
252
278
  # @!attribute [rw] reply_messages
253
279
  # @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
254
- # Setting for replying to messages in a space.
280
+ # Optional. Setting for replying to messages in a space.
255
281
  class PermissionSettings
256
282
  include ::Google::Protobuf::MessageExts
257
283
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -260,10 +286,10 @@ module Google
260
286
  # Represents a space permission setting.
261
287
  # @!attribute [rw] managers_allowed
262
288
  # @return [::Boolean]
263
- # Whether spaces managers have this permission.
289
+ # Optional. Whether spaces managers have this permission.
264
290
  # @!attribute [rw] members_allowed
265
291
  # @return [::Boolean]
266
- # Whether non-manager members have this permission.
292
+ # Optional. Whether non-manager members have this permission.
267
293
  class PermissionSetting
268
294
  include ::Google::Protobuf::MessageExts
269
295
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -341,15 +367,13 @@ module Google
341
367
  # @!attribute [rw] space
342
368
  # @return [::Google::Apps::Chat::V1::Space]
343
369
  # Required. The `displayName` and `spaceType` fields must be populated. Only
344
- # `SpaceType.SPACE` is supported.
370
+ # `SpaceType.SPACE` and `SpaceType.GROUP_CHAT` are supported.
371
+ # `SpaceType.GROUP_CHAT` can only be used if `importMode` is set to true.
345
372
  #
346
373
  # If you receive the error message `ALREADY_EXISTS`,
347
374
  # try a different `displayName`. An existing space within the Google
348
375
  # Workspace organization might already use this display name.
349
376
  #
350
- # If you're a member of the [Developer Preview
351
- # program](https://developers.google.com/workspace/preview),
352
- # `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true.
353
377
  #
354
378
  # The space `name` is assigned on the server so anything specified in this
355
379
  # field will be ignored.
@@ -434,7 +458,7 @@ module Google
434
458
  # Format: `spaces/{space}`
435
459
  # @!attribute [rw] use_admin_access
436
460
  # @return [::Boolean]
437
- # When `true`, the method runs using the user's Google Workspace
461
+ # Optional. When `true`, the method runs using the user's Google Workspace
438
462
  # administrator privileges.
439
463
  #
440
464
  # The calling user must be a Google Workspace administrator with the
@@ -540,7 +564,7 @@ module Google
540
564
  # - `permission_settings.replyMessages`
541
565
  # @!attribute [rw] use_admin_access
542
566
  # @return [::Boolean]
543
- # When `true`, the method runs using the user's Google Workspace
567
+ # Optional. When `true`, the method runs using the user's Google Workspace
544
568
  # administrator privileges.
545
569
  #
546
570
  # The calling user must be a Google Workspace administrator with the
@@ -716,7 +740,7 @@ module Google
716
740
  # Format: `spaces/{space}`
717
741
  # @!attribute [rw] use_admin_access
718
742
  # @return [::Boolean]
719
- # When `true`, the method runs using the user's Google Workspace
743
+ # Optional. When `true`, the method runs using the user's Google Workspace
720
744
  # administrator privileges.
721
745
  #
722
746
  # The calling user must be a Google Workspace administrator with the
@@ -85,91 +85,127 @@ module Google
85
85
  # Event payload for a new message.
86
86
  #
87
87
  # Event type: `google.workspace.chat.message.v1.created`
88
+ #
89
+ # Note: The following fields are mutually exclusive: `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
88
90
  # @!attribute [rw] message_updated_event_data
89
91
  # @return [::Google::Apps::Chat::V1::MessageUpdatedEventData]
90
92
  # Event payload for an updated message.
91
93
  #
92
94
  # Event type: `google.workspace.chat.message.v1.updated`
95
+ #
96
+ # Note: The following fields are mutually exclusive: `message_updated_event_data`, `message_created_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
93
97
  # @!attribute [rw] message_deleted_event_data
94
98
  # @return [::Google::Apps::Chat::V1::MessageDeletedEventData]
95
99
  # Event payload for a deleted message.
96
100
  #
97
101
  # Event type: `google.workspace.chat.message.v1.deleted`
102
+ #
103
+ # Note: The following fields are mutually exclusive: `message_deleted_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
98
104
  # @!attribute [rw] message_batch_created_event_data
99
105
  # @return [::Google::Apps::Chat::V1::MessageBatchCreatedEventData]
100
106
  # Event payload for multiple new messages.
101
107
  #
102
108
  # Event type: `google.workspace.chat.message.v1.batchCreated`
109
+ #
110
+ # Note: The following fields are mutually exclusive: `message_batch_created_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
103
111
  # @!attribute [rw] message_batch_updated_event_data
104
112
  # @return [::Google::Apps::Chat::V1::MessageBatchUpdatedEventData]
105
113
  # Event payload for multiple updated messages.
106
114
  #
107
115
  # Event type: `google.workspace.chat.message.v1.batchUpdated`
116
+ #
117
+ # Note: The following fields are mutually exclusive: `message_batch_updated_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
108
118
  # @!attribute [rw] message_batch_deleted_event_data
109
119
  # @return [::Google::Apps::Chat::V1::MessageBatchDeletedEventData]
110
120
  # Event payload for multiple deleted messages.
111
121
  #
112
122
  # Event type: `google.workspace.chat.message.v1.batchDeleted`
123
+ #
124
+ # Note: The following fields are mutually exclusive: `message_batch_deleted_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
113
125
  # @!attribute [rw] space_updated_event_data
114
126
  # @return [::Google::Apps::Chat::V1::SpaceUpdatedEventData]
115
127
  # Event payload for a space update.
116
128
  #
117
129
  # Event type: `google.workspace.chat.space.v1.updated`
130
+ #
131
+ # Note: The following fields are mutually exclusive: `space_updated_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
118
132
  # @!attribute [rw] space_batch_updated_event_data
119
133
  # @return [::Google::Apps::Chat::V1::SpaceBatchUpdatedEventData]
120
134
  # Event payload for multiple updates to a space.
121
135
  #
122
136
  # Event type: `google.workspace.chat.space.v1.batchUpdated`
137
+ #
138
+ # Note: The following fields are mutually exclusive: `space_batch_updated_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
123
139
  # @!attribute [rw] membership_created_event_data
124
140
  # @return [::Google::Apps::Chat::V1::MembershipCreatedEventData]
125
141
  # Event payload for a new membership.
126
142
  #
127
143
  # Event type: `google.workspace.chat.membership.v1.created`
144
+ #
145
+ # Note: The following fields are mutually exclusive: `membership_created_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
128
146
  # @!attribute [rw] membership_updated_event_data
129
147
  # @return [::Google::Apps::Chat::V1::MembershipUpdatedEventData]
130
148
  # Event payload for an updated membership.
131
149
  #
132
150
  # Event type: `google.workspace.chat.membership.v1.updated`
151
+ #
152
+ # Note: The following fields are mutually exclusive: `membership_updated_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
133
153
  # @!attribute [rw] membership_deleted_event_data
134
154
  # @return [::Google::Apps::Chat::V1::MembershipDeletedEventData]
135
155
  # Event payload for a deleted membership.
136
156
  #
137
157
  # Event type: `google.workspace.chat.membership.v1.deleted`
158
+ #
159
+ # Note: The following fields are mutually exclusive: `membership_deleted_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
138
160
  # @!attribute [rw] membership_batch_created_event_data
139
161
  # @return [::Google::Apps::Chat::V1::MembershipBatchCreatedEventData]
140
162
  # Event payload for multiple new memberships.
141
163
  #
142
164
  # Event type: `google.workspace.chat.membership.v1.batchCreated`
165
+ #
166
+ # Note: The following fields are mutually exclusive: `membership_batch_created_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
143
167
  # @!attribute [rw] membership_batch_updated_event_data
144
168
  # @return [::Google::Apps::Chat::V1::MembershipBatchUpdatedEventData]
145
169
  # Event payload for multiple updated memberships.
146
170
  #
147
171
  # Event type: `google.workspace.chat.membership.v1.batchUpdated`
172
+ #
173
+ # Note: The following fields are mutually exclusive: `membership_batch_updated_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
148
174
  # @!attribute [rw] membership_batch_deleted_event_data
149
175
  # @return [::Google::Apps::Chat::V1::MembershipBatchDeletedEventData]
150
176
  # Event payload for multiple deleted memberships.
151
177
  #
152
178
  # Event type: `google.workspace.chat.membership.v1.batchDeleted`
179
+ #
180
+ # Note: The following fields are mutually exclusive: `membership_batch_deleted_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
153
181
  # @!attribute [rw] reaction_created_event_data
154
182
  # @return [::Google::Apps::Chat::V1::ReactionCreatedEventData]
155
183
  # Event payload for a new reaction.
156
184
  #
157
185
  # Event type: `google.workspace.chat.reaction.v1.created`
186
+ #
187
+ # Note: The following fields are mutually exclusive: `reaction_created_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
158
188
  # @!attribute [rw] reaction_deleted_event_data
159
189
  # @return [::Google::Apps::Chat::V1::ReactionDeletedEventData]
160
190
  # Event payload for a deleted reaction.
161
191
  #
162
192
  # Event type: `google.workspace.chat.reaction.v1.deleted`
193
+ #
194
+ # Note: The following fields are mutually exclusive: `reaction_deleted_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_batch_created_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
163
195
  # @!attribute [rw] reaction_batch_created_event_data
164
196
  # @return [::Google::Apps::Chat::V1::ReactionBatchCreatedEventData]
165
197
  # Event payload for multiple new reactions.
166
198
  #
167
199
  # Event type: `google.workspace.chat.reaction.v1.batchCreated`
200
+ #
201
+ # Note: The following fields are mutually exclusive: `reaction_batch_created_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_deleted_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
168
202
  # @!attribute [rw] reaction_batch_deleted_event_data
169
203
  # @return [::Google::Apps::Chat::V1::ReactionBatchDeletedEventData]
170
204
  # Event payload for multiple deleted reactions.
171
205
  #
172
206
  # Event type: `google.workspace.chat.reaction.v1.batchDeleted`
207
+ #
208
+ # Note: The following fields are mutually exclusive: `reaction_batch_deleted_event_data`, `message_created_event_data`, `message_updated_event_data`, `message_deleted_event_data`, `message_batch_created_event_data`, `message_batch_updated_event_data`, `message_batch_deleted_event_data`, `space_updated_event_data`, `space_batch_updated_event_data`, `membership_created_event_data`, `membership_updated_event_data`, `membership_deleted_event_data`, `membership_batch_created_event_data`, `membership_batch_updated_event_data`, `membership_batch_deleted_event_data`, `reaction_created_event_data`, `reaction_deleted_event_data`, `reaction_batch_created_event_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
173
209
  class SpaceEvent
174
210
  include ::Google::Protobuf::MessageExts
175
211
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -202,8 +238,8 @@ module Google
202
238
  # Negative values return an `INVALID_ARGUMENT` error.
203
239
  # @!attribute [rw] page_token
204
240
  # @return [::String]
205
- # A page token, received from a previous list space events call. Provide this
206
- # to retrieve the subsequent page.
241
+ # Optional. A page token, received from a previous list space events call.
242
+ # Provide this to retrieve the subsequent page.
207
243
  #
208
244
  # When paginating, all other parameters provided to list space events must
209
245
  # match the call that provided the page token. Passing different values to