google-apps-chat-v1 0.1.2 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,285 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Apps
22
+ module Chat
23
+ module V1
24
+ # An event that represents a change or activity in a Google Chat space. To
25
+ # learn more, see [Work with events from Google
26
+ # Chat](https://developers.google.com/workspace/chat/events-overview).
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # Resource name of the space event.
30
+ #
31
+ # Format: `spaces/{space}/spaceEvents/{spaceEvent}`
32
+ # @!attribute [rw] event_time
33
+ # @return [::Google::Protobuf::Timestamp]
34
+ # Time when the event occurred.
35
+ # @!attribute [rw] event_type
36
+ # @return [::String]
37
+ # Type of space event. Each event type has a batch version, which
38
+ # represents multiple instances of the event type that occur in a short
39
+ # period of time. For `spaceEvents.list()` requests, omit batch event types
40
+ # in your query filter. By default, the server returns both event type and
41
+ # its batch version.
42
+ #
43
+ # Supported event types for
44
+ # [messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages):
45
+ #
46
+ # * New message: `google.workspace.chat.message.v1.created`
47
+ # * Updated message: `google.workspace.chat.message.v1.updated`
48
+ # * Deleted message: `google.workspace.chat.message.v1.deleted`
49
+ # * Multiple new messages: `google.workspace.chat.message.v1.batchCreated`
50
+ # * Multiple updated messages:
51
+ # `google.workspace.chat.message.v1.batchUpdated`
52
+ # * Multiple deleted messages:
53
+ # `google.workspace.chat.message.v1.batchDeleted`
54
+ #
55
+ # Supported event types for
56
+ # [memberships](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members):
57
+ #
58
+ # * New membership: `google.workspace.chat.membership.v1.created`
59
+ # * Updated membership: `google.workspace.chat.membership.v1.updated`
60
+ # * Deleted membership: `google.workspace.chat.membership.v1.deleted`
61
+ # * Multiple new memberships:
62
+ # `google.workspace.chat.membership.v1.batchCreated`
63
+ # * Multiple updated memberships:
64
+ # `google.workspace.chat.membership.v1.batchUpdated`
65
+ # * Multiple deleted memberships:
66
+ # `google.workspace.chat.membership.v1.batchDeleted`
67
+ #
68
+ # Supported event types for
69
+ # [reactions](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions):
70
+ #
71
+ # * New reaction: `google.workspace.chat.reaction.v1.created`
72
+ # * Deleted reaction: `google.workspace.chat.reaction.v1.deleted`
73
+ # * Multiple new reactions:
74
+ # `google.workspace.chat.reaction.v1.batchCreated`
75
+ # * Multiple deleted reactions:
76
+ # `google.workspace.chat.reaction.v1.batchDeleted`
77
+ #
78
+ # Supported event types about the
79
+ # [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces):
80
+ #
81
+ # * Updated space: `google.workspace.chat.space.v1.updated`
82
+ # * Multiple space updates: `google.workspace.chat.space.v1.batchUpdated`
83
+ # @!attribute [rw] message_created_event_data
84
+ # @return [::Google::Apps::Chat::V1::MessageCreatedEventData]
85
+ # Event payload for a new message.
86
+ #
87
+ # Event type: `google.workspace.chat.message.v1.created`
88
+ # @!attribute [rw] message_updated_event_data
89
+ # @return [::Google::Apps::Chat::V1::MessageUpdatedEventData]
90
+ # Event payload for an updated message.
91
+ #
92
+ # Event type: `google.workspace.chat.message.v1.updated`
93
+ # @!attribute [rw] message_deleted_event_data
94
+ # @return [::Google::Apps::Chat::V1::MessageDeletedEventData]
95
+ # Event payload for a deleted message.
96
+ #
97
+ # Event type: `google.workspace.chat.message.v1.deleted`
98
+ # @!attribute [rw] message_batch_created_event_data
99
+ # @return [::Google::Apps::Chat::V1::MessageBatchCreatedEventData]
100
+ # Event payload for multiple new messages.
101
+ #
102
+ # Event type: `google.workspace.chat.message.v1.batchCreated`
103
+ # @!attribute [rw] message_batch_updated_event_data
104
+ # @return [::Google::Apps::Chat::V1::MessageBatchUpdatedEventData]
105
+ # Event payload for multiple updated messages.
106
+ #
107
+ # Event type: `google.workspace.chat.message.v1.batchUpdated`
108
+ # @!attribute [rw] message_batch_deleted_event_data
109
+ # @return [::Google::Apps::Chat::V1::MessageBatchDeletedEventData]
110
+ # Event payload for multiple deleted messages.
111
+ #
112
+ # Event type: `google.workspace.chat.message.v1.batchDeleted`
113
+ # @!attribute [rw] space_updated_event_data
114
+ # @return [::Google::Apps::Chat::V1::SpaceUpdatedEventData]
115
+ # Event payload for a space update.
116
+ #
117
+ # Event type: `google.workspace.chat.space.v1.updated`
118
+ # @!attribute [rw] space_batch_updated_event_data
119
+ # @return [::Google::Apps::Chat::V1::SpaceBatchUpdatedEventData]
120
+ # Event payload for multiple updates to a space.
121
+ #
122
+ # Event type: `google.workspace.chat.space.v1.batchUpdated`
123
+ # @!attribute [rw] membership_created_event_data
124
+ # @return [::Google::Apps::Chat::V1::MembershipCreatedEventData]
125
+ # Event payload for a new membership.
126
+ #
127
+ # Event type: `google.workspace.chat.membership.v1.created`
128
+ # @!attribute [rw] membership_updated_event_data
129
+ # @return [::Google::Apps::Chat::V1::MembershipUpdatedEventData]
130
+ # Event payload for an updated membership.
131
+ #
132
+ # Event type: `google.workspace.chat.membership.v1.updated`
133
+ # @!attribute [rw] membership_deleted_event_data
134
+ # @return [::Google::Apps::Chat::V1::MembershipDeletedEventData]
135
+ # Event payload for a deleted membership.
136
+ #
137
+ # Event type: `google.workspace.chat.membership.v1.deleted`
138
+ # @!attribute [rw] membership_batch_created_event_data
139
+ # @return [::Google::Apps::Chat::V1::MembershipBatchCreatedEventData]
140
+ # Event payload for multiple new memberships.
141
+ #
142
+ # Event type: `google.workspace.chat.membership.v1.batchCreated`
143
+ # @!attribute [rw] membership_batch_updated_event_data
144
+ # @return [::Google::Apps::Chat::V1::MembershipBatchUpdatedEventData]
145
+ # Event payload for multiple updated memberships.
146
+ #
147
+ # Event type: `google.workspace.chat.membership.v1.batchUpdated`
148
+ # @!attribute [rw] membership_batch_deleted_event_data
149
+ # @return [::Google::Apps::Chat::V1::MembershipBatchDeletedEventData]
150
+ # Event payload for multiple deleted memberships.
151
+ #
152
+ # Event type: `google.workspace.chat.membership.v1.batchDeleted`
153
+ # @!attribute [rw] reaction_created_event_data
154
+ # @return [::Google::Apps::Chat::V1::ReactionCreatedEventData]
155
+ # Event payload for a new reaction.
156
+ #
157
+ # Event type: `google.workspace.chat.reaction.v1.created`
158
+ # @!attribute [rw] reaction_deleted_event_data
159
+ # @return [::Google::Apps::Chat::V1::ReactionDeletedEventData]
160
+ # Event payload for a deleted reaction.
161
+ #
162
+ # Event type: `google.workspace.chat.reaction.v1.deleted`
163
+ # @!attribute [rw] reaction_batch_created_event_data
164
+ # @return [::Google::Apps::Chat::V1::ReactionBatchCreatedEventData]
165
+ # Event payload for multiple new reactions.
166
+ #
167
+ # Event type: `google.workspace.chat.reaction.v1.batchCreated`
168
+ # @!attribute [rw] reaction_batch_deleted_event_data
169
+ # @return [::Google::Apps::Chat::V1::ReactionBatchDeletedEventData]
170
+ # Event payload for multiple deleted reactions.
171
+ #
172
+ # Event type: `google.workspace.chat.reaction.v1.batchDeleted`
173
+ class SpaceEvent
174
+ include ::Google::Protobuf::MessageExts
175
+ extend ::Google::Protobuf::MessageExts::ClassMethods
176
+ end
177
+
178
+ # Request message for getting a space event.
179
+ # @!attribute [rw] name
180
+ # @return [::String]
181
+ # Required. The resource name of the space event.
182
+ #
183
+ # Format: `spaces/{space}/spaceEvents/{spaceEvent}`
184
+ class GetSpaceEventRequest
185
+ include ::Google::Protobuf::MessageExts
186
+ extend ::Google::Protobuf::MessageExts::ClassMethods
187
+ end
188
+
189
+ # Request message for listing space events.
190
+ # @!attribute [rw] parent
191
+ # @return [::String]
192
+ # Required. Resource name of the [Google Chat
193
+ # space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces)
194
+ # where the events occurred.
195
+ #
196
+ # Format: `spaces/{space}`.
197
+ # @!attribute [rw] page_size
198
+ # @return [::Integer]
199
+ # Optional. The maximum number of space events returned. The service might
200
+ # return fewer than this value.
201
+ #
202
+ # Negative values return an `INVALID_ARGUMENT` error.
203
+ # @!attribute [rw] page_token
204
+ # @return [::String]
205
+ # A page token, received from a previous list space events call. Provide this
206
+ # to retrieve the subsequent page.
207
+ #
208
+ # When paginating, all other parameters provided to list space events must
209
+ # match the call that provided the page token. Passing different values to
210
+ # the other parameters might lead to unexpected results.
211
+ # @!attribute [rw] filter
212
+ # @return [::String]
213
+ # Required. A query filter.
214
+ #
215
+ # You must specify at least one event type (`event_type`)
216
+ # using the has `:` operator. To filter by multiple event types, use the `OR`
217
+ # operator. Omit batch event types in your filter. The request automatically
218
+ # returns any related batch events. For example, if you filter by new
219
+ # reactions
220
+ # (`google.workspace.chat.reaction.v1.created`), the server also returns
221
+ # batch new reactions events
222
+ # (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported
223
+ # event types, see the [`SpaceEvents` reference
224
+ # documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type).
225
+ #
226
+ # Optionally, you can also filter by start time (`start_time`) and
227
+ # end time (`end_time`):
228
+ #
229
+ # * `start_time`: Exclusive timestamp from which to start listing space
230
+ # events.
231
+ # You can list events that occurred up to 28 days ago. If unspecified, lists
232
+ # space events from the past 28 days.
233
+ # * `end_time`: Inclusive timestamp until which space events are listed.
234
+ # If unspecified, lists events up to the time of the request.
235
+ #
236
+ # To specify a start or end time, use the equals `=` operator and format in
237
+ # [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both
238
+ # `start_time` and `end_time`, use the `AND` operator.
239
+ #
240
+ # For example, the following queries are valid:
241
+ #
242
+ # ```
243
+ # start_time="2023-08-23T19:20:33+00:00" AND
244
+ # end_time="2023-08-23T19:21:54+00:00"
245
+ # ```
246
+ # ```
247
+ # start_time="2023-08-23T19:20:33+00:00" AND
248
+ # (event_types:"google.workspace.chat.space.v1.updated" OR
249
+ # event_types:"google.workspace.chat.message.v1.created")
250
+ # ```
251
+ #
252
+ # The following queries are invalid:
253
+ #
254
+ # ```
255
+ # start_time="2023-08-23T19:20:33+00:00" OR
256
+ # end_time="2023-08-23T19:21:54+00:00"
257
+ # ```
258
+ # ```
259
+ # event_types:"google.workspace.chat.space.v1.updated" AND
260
+ # event_types:"google.workspace.chat.message.v1.created"
261
+ # ```
262
+ #
263
+ # Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
264
+ # error.
265
+ class ListSpaceEventsRequest
266
+ include ::Google::Protobuf::MessageExts
267
+ extend ::Google::Protobuf::MessageExts::ClassMethods
268
+ end
269
+
270
+ # Response message for listing space events.
271
+ # @!attribute [rw] space_events
272
+ # @return [::Array<::Google::Apps::Chat::V1::SpaceEvent>]
273
+ # Results are returned in chronological order (oldest event first).
274
+ # @!attribute [rw] next_page_token
275
+ # @return [::String]
276
+ # Continuation token used to fetch more events.
277
+ # If this field is omitted, there are no subsequent pages.
278
+ class ListSpaceEventsResponse
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+ end
283
+ end
284
+ end
285
+ end
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.1.2
4
+ version: 0.3.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-06-26 00:00:00.000000000 Z
11
+ date: 2024-07-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -96,6 +96,7 @@ files:
96
96
  - lib/google/chat/v1/chat_service_services_pb.rb
97
97
  - lib/google/chat/v1/contextual_addon_pb.rb
98
98
  - lib/google/chat/v1/deletion_metadata_pb.rb
99
+ - lib/google/chat/v1/event_payload_pb.rb
99
100
  - lib/google/chat/v1/group_pb.rb
100
101
  - lib/google/chat/v1/history_state_pb.rb
101
102
  - lib/google/chat/v1/matched_url_pb.rb
@@ -103,6 +104,7 @@ files:
103
104
  - lib/google/chat/v1/message_pb.rb
104
105
  - lib/google/chat/v1/reaction_pb.rb
105
106
  - lib/google/chat/v1/slash_command_pb.rb
107
+ - lib/google/chat/v1/space_event_pb.rb
106
108
  - lib/google/chat/v1/space_pb.rb
107
109
  - lib/google/chat/v1/space_read_state_pb.rb
108
110
  - lib/google/chat/v1/space_setup_pb.rb
@@ -120,6 +122,7 @@ files:
120
122
  - proto_docs/google/chat/v1/attachment.rb
121
123
  - proto_docs/google/chat/v1/contextual_addon.rb
122
124
  - proto_docs/google/chat/v1/deletion_metadata.rb
125
+ - proto_docs/google/chat/v1/event_payload.rb
123
126
  - proto_docs/google/chat/v1/group.rb
124
127
  - proto_docs/google/chat/v1/history_state.rb
125
128
  - proto_docs/google/chat/v1/matched_url.rb
@@ -128,6 +131,7 @@ files:
128
131
  - proto_docs/google/chat/v1/reaction.rb
129
132
  - proto_docs/google/chat/v1/slash_command.rb
130
133
  - proto_docs/google/chat/v1/space.rb
134
+ - proto_docs/google/chat/v1/space_event.rb
131
135
  - proto_docs/google/chat/v1/space_read_state.rb
132
136
  - proto_docs/google/chat/v1/space_setup.rb
133
137
  - proto_docs/google/chat/v1/thread_read_state.rb