google-apis-workspaceevents_v1 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bd4a3a38c095e7e388fa7b9ecef76ec4c50ec8a34912355254f3860751217b2c
4
- data.tar.gz: eb5264b9731c62cf7aab4a03b53efdee8b04b61ba286cb2db729be51ecd0eb06
3
+ metadata.gz: bcdb0d8b768e3359f8705554439e5f8267881674e7e48e24abff9e9237d6839e
4
+ data.tar.gz: 4fd3ad2f35abaf8d74094f4588b41c721b6965e5bfefe45ee23cd56559ef0d17
5
5
  SHA512:
6
- metadata.gz: a83a31b079906803d69760c9dd597866932f5c41d82ba94b35f3c8a028362108f5c2ad3fa7b3b5291a613e657be905c3f028bec7ec3f12de92e698a900f32e67
7
- data.tar.gz: fce501df6597d31c0bf7472639c95a04c1560a4803da106241c5d4eedb57c21368e5c56da75f54c8dfeac3ab05d89f1161a07fe1dda5404d2b72eabe28adf241
6
+ metadata.gz: f50c8d066195cfa12e83159296c0192dc36594e4babdb169b2affba14040f03c9edbd50d3cf6f729cabbffbc038dd4e48f81f190b7e158073345ed744419e2a5
7
+ data.tar.gz: 15ffa4e6e92b1af33a647dc5d4051c3c07dea40e2302d88651d6e587312f282697a1ac738af5eac6ed9744aea70f71c9997fad4f6506d906e78b9b82e5c1fbdf
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-workspaceevents_v1
2
2
 
3
+ ### v0.2.0 (2024-02-24)
4
+
5
+ * Regenerated from discovery document revision 20240218
6
+ * Regenerated using generator version 0.14.0
7
+
3
8
  ### v0.1.0 (2024-01-28)
4
9
 
5
10
  * Regenerated from discovery document revision 20240123
data/OVERVIEW.md CHANGED
@@ -83,9 +83,9 @@ The [product documentation](https://developers.google.com/workspace/events) may
83
83
 
84
84
  ## Supported Ruby versions
85
85
 
86
- This library is supported on Ruby 2.5+.
86
+ This library is supported on Ruby 2.7+.
87
87
 
88
- Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
89
 
90
90
  ## License
91
91
 
@@ -21,6 +21,340 @@ require 'google/apis/errors'
21
21
  module Google
22
22
  module Apis
23
23
  module WorkspaceeventsV1
24
+
25
+ # The response message for SubscriptionsService.ListSubscriptions.
26
+ class ListSubscriptionsResponse
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
30
+ # field is omitted, there are no subsequent pages.
31
+ # Corresponds to the JSON property `nextPageToken`
32
+ # @return [String]
33
+ attr_accessor :next_page_token
34
+
35
+ # List of subscriptions.
36
+ # Corresponds to the JSON property `subscriptions`
37
+ # @return [Array<Google::Apis::WorkspaceeventsV1::Subscription>]
38
+ attr_accessor :subscriptions
39
+
40
+ def initialize(**args)
41
+ update!(**args)
42
+ end
43
+
44
+ # Update properties of this object
45
+ def update!(**args)
46
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
47
+ @subscriptions = args[:subscriptions] if args.key?(:subscriptions)
48
+ end
49
+ end
50
+
51
+ # The endpoint where the subscription delivers events.
52
+ class NotificationEndpoint
53
+ include Google::Apis::Core::Hashable
54
+
55
+ # Immutable. The Cloud Pub/Sub topic that receives events for the subscription.
56
+ # Format: `projects/`project`/topics/`topic`` You must create the topic in the
57
+ # same Google Cloud project where you create this subscription. When the topic
58
+ # receives events, the events are encoded as Cloud Pub/Sub messages. For details,
59
+ # see the [Google Cloud Pub/Sub Protocol Binding for CloudEvents](https://
60
+ # github.com/googleapis/google-cloudevents/blob/main/docs/spec/pubsub.md).
61
+ # Corresponds to the JSON property `pubsubTopic`
62
+ # @return [String]
63
+ attr_accessor :pubsub_topic
64
+
65
+ def initialize(**args)
66
+ update!(**args)
67
+ end
68
+
69
+ # Update properties of this object
70
+ def update!(**args)
71
+ @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
72
+ end
73
+ end
74
+
75
+ # This resource represents a long-running operation that is the result of a
76
+ # network API call.
77
+ class Operation
78
+ include Google::Apis::Core::Hashable
79
+
80
+ # If the value is `false`, it means the operation is still in progress. If `true`
81
+ # , the operation is completed, and either `error` or `response` is available.
82
+ # Corresponds to the JSON property `done`
83
+ # @return [Boolean]
84
+ attr_accessor :done
85
+ alias_method :done?, :done
86
+
87
+ # The `Status` type defines a logical error model that is suitable for different
88
+ # programming environments, including REST APIs and RPC APIs. It is used by [
89
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
90
+ # data: error code, error message, and error details. You can find out more
91
+ # about this error model and how to work with it in the [API Design Guide](https:
92
+ # //cloud.google.com/apis/design/errors).
93
+ # Corresponds to the JSON property `error`
94
+ # @return [Google::Apis::WorkspaceeventsV1::Status]
95
+ attr_accessor :error
96
+
97
+ # Service-specific metadata associated with the operation. It typically contains
98
+ # progress information and common metadata such as create time. Some services
99
+ # might not provide such metadata. Any method that returns a long-running
100
+ # operation should document the metadata type, if any.
101
+ # Corresponds to the JSON property `metadata`
102
+ # @return [Hash<String,Object>]
103
+ attr_accessor :metadata
104
+
105
+ # The server-assigned name, which is only unique within the same service that
106
+ # originally returns it. If you use the default HTTP mapping, the `name` should
107
+ # be a resource name ending with `operations/`unique_id``.
108
+ # Corresponds to the JSON property `name`
109
+ # @return [String]
110
+ attr_accessor :name
111
+
112
+ # The normal, successful response of the operation. If the original method
113
+ # returns no data on success, such as `Delete`, the response is `google.protobuf.
114
+ # Empty`. If the original method is standard `Get`/`Create`/`Update`, the
115
+ # response should be the resource. For other methods, the response should have
116
+ # the type `XxxResponse`, where `Xxx` is the original method name. For example,
117
+ # if the original method name is `TakeSnapshot()`, the inferred response type is
118
+ # `TakeSnapshotResponse`.
119
+ # Corresponds to the JSON property `response`
120
+ # @return [Hash<String,Object>]
121
+ attr_accessor :response
122
+
123
+ def initialize(**args)
124
+ update!(**args)
125
+ end
126
+
127
+ # Update properties of this object
128
+ def update!(**args)
129
+ @done = args[:done] if args.key?(:done)
130
+ @error = args[:error] if args.key?(:error)
131
+ @metadata = args[:metadata] if args.key?(:metadata)
132
+ @name = args[:name] if args.key?(:name)
133
+ @response = args[:response] if args.key?(:response)
134
+ end
135
+ end
136
+
137
+ # Options about what data to include in the event payload. Only supported for
138
+ # Google Chat events.
139
+ class PayloadOptions
140
+ include Google::Apis::Core::Hashable
141
+
142
+ # Optional. If `include_resource` is set to `true`, the list of fields to
143
+ # include in the event payload. Separate fields with a comma. For example, to
144
+ # include a Google Chat message's sender and create time, enter `message.sender,
145
+ # message.createTime`. If omitted, the payload includes all fields for the
146
+ # resource. If you specify a field that doesn't exist for the resource, the
147
+ # system ignores the field.
148
+ # Corresponds to the JSON property `fieldMask`
149
+ # @return [String]
150
+ attr_accessor :field_mask
151
+
152
+ # Optional. Whether the event payload includes data about the resource that
153
+ # changed. For example, for an event where a Google Chat message was created,
154
+ # whether the payload contains data about the [`Message`](https://developers.
155
+ # google.com/chat/api/reference/rest/v1/spaces.messages) resource. If false, the
156
+ # event payload only includes the name of the changed resource.
157
+ # Corresponds to the JSON property `includeResource`
158
+ # @return [Boolean]
159
+ attr_accessor :include_resource
160
+ alias_method :include_resource?, :include_resource
161
+
162
+ def initialize(**args)
163
+ update!(**args)
164
+ end
165
+
166
+ # Update properties of this object
167
+ def update!(**args)
168
+ @field_mask = args[:field_mask] if args.key?(:field_mask)
169
+ @include_resource = args[:include_resource] if args.key?(:include_resource)
170
+ end
171
+ end
172
+
173
+ # The request message for SubscriptionsService.ReactivateSubscription.
174
+ class ReactivateSubscriptionRequest
175
+ include Google::Apis::Core::Hashable
176
+
177
+ def initialize(**args)
178
+ update!(**args)
179
+ end
180
+
181
+ # Update properties of this object
182
+ def update!(**args)
183
+ end
184
+ end
185
+
186
+ # The `Status` type defines a logical error model that is suitable for different
187
+ # programming environments, including REST APIs and RPC APIs. It is used by [
188
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
189
+ # data: error code, error message, and error details. You can find out more
190
+ # about this error model and how to work with it in the [API Design Guide](https:
191
+ # //cloud.google.com/apis/design/errors).
192
+ class Status
193
+ include Google::Apis::Core::Hashable
194
+
195
+ # The status code, which should be an enum value of google.rpc.Code.
196
+ # Corresponds to the JSON property `code`
197
+ # @return [Fixnum]
198
+ attr_accessor :code
199
+
200
+ # A list of messages that carry the error details. There is a common set of
201
+ # message types for APIs to use.
202
+ # Corresponds to the JSON property `details`
203
+ # @return [Array<Hash<String,Object>>]
204
+ attr_accessor :details
205
+
206
+ # A developer-facing error message, which should be in English. Any user-facing
207
+ # error message should be localized and sent in the google.rpc.Status.details
208
+ # field, or localized by the client.
209
+ # Corresponds to the JSON property `message`
210
+ # @return [String]
211
+ attr_accessor :message
212
+
213
+ def initialize(**args)
214
+ update!(**args)
215
+ end
216
+
217
+ # Update properties of this object
218
+ def update!(**args)
219
+ @code = args[:code] if args.key?(:code)
220
+ @details = args[:details] if args.key?(:details)
221
+ @message = args[:message] if args.key?(:message)
222
+ end
223
+ end
224
+
225
+ # [Developer Preview](https://developers.google.com/workspace/preview). A
226
+ # subscription to receive events about a Google Workspace resource. To learn
227
+ # more about subscriptions, see the [Google Workspace Events API overview](https:
228
+ # //developers.google.com/workspace/events).
229
+ class Subscription
230
+ include Google::Apis::Core::Hashable
231
+
232
+ # Output only. The user who authorized the creation of the subscription. Format:
233
+ # `users/`user`` For Google Workspace users, the ``user`` value is the [`user.id`
234
+ # ](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#
235
+ # User.FIELDS.ids) field from the Directory API.
236
+ # Corresponds to the JSON property `authority`
237
+ # @return [String]
238
+ attr_accessor :authority
239
+
240
+ # Output only. The time when the subscription is created.
241
+ # Corresponds to the JSON property `createTime`
242
+ # @return [String]
243
+ attr_accessor :create_time
244
+
245
+ # Optional. This checksum is computed by the server based on the value of other
246
+ # fields, and might be sent on update requests to ensure the client has an up-to-
247
+ # date value before proceeding.
248
+ # Corresponds to the JSON property `etag`
249
+ # @return [String]
250
+ attr_accessor :etag
251
+
252
+ # Required. Immutable. Unordered list. Input for creating a subscription.
253
+ # Otherwise, output only. One or more types of events to receive about the
254
+ # target resource. Formatted according to the CloudEvents specification. The
255
+ # supported event types depend on the target resource of your subscription. For
256
+ # details, see [Supported Google Workspace events](https://developers.google.com/
257
+ # workspace/events/guides#supported-events). By default, you also receive events
258
+ # about the [lifecycle of your subscription](https://developers.google.com/
259
+ # workspace/events/guides/events-lifecycle). You don't need to specify lifecycle
260
+ # events for this field. If you specify an event type that doesn't exist for the
261
+ # target resource, the request returns an HTTP `400 Bad Request` status code.
262
+ # Corresponds to the JSON property `eventTypes`
263
+ # @return [Array<String>]
264
+ attr_accessor :event_types
265
+
266
+ # Non-empty default. The timestamp in UTC when the subscription expires. Always
267
+ # displayed on output, regardless of what was used on input.
268
+ # Corresponds to the JSON property `expireTime`
269
+ # @return [String]
270
+ attr_accessor :expire_time
271
+
272
+ # Optional. Immutable. Identifier. Resource name of the subscription. Format: `
273
+ # subscriptions/`subscription``
274
+ # Corresponds to the JSON property `name`
275
+ # @return [String]
276
+ attr_accessor :name
277
+
278
+ # The endpoint where the subscription delivers events.
279
+ # Corresponds to the JSON property `notificationEndpoint`
280
+ # @return [Google::Apis::WorkspaceeventsV1::NotificationEndpoint]
281
+ attr_accessor :notification_endpoint
282
+
283
+ # Options about what data to include in the event payload. Only supported for
284
+ # Google Chat events.
285
+ # Corresponds to the JSON property `payloadOptions`
286
+ # @return [Google::Apis::WorkspaceeventsV1::PayloadOptions]
287
+ attr_accessor :payload_options
288
+
289
+ # Output only. If `true`, the subscription is in the process of being updated.
290
+ # Corresponds to the JSON property `reconciling`
291
+ # @return [Boolean]
292
+ attr_accessor :reconciling
293
+ alias_method :reconciling?, :reconciling
294
+
295
+ # Output only. The state of the subscription. Determines whether the
296
+ # subscription can receive events and deliver them to the notification endpoint.
297
+ # Corresponds to the JSON property `state`
298
+ # @return [String]
299
+ attr_accessor :state
300
+
301
+ # Output only. The error that suspended the subscription. To reactivate the
302
+ # subscription, resolve the error and call the `ReactivateSubscription` method.
303
+ # Corresponds to the JSON property `suspensionReason`
304
+ # @return [String]
305
+ attr_accessor :suspension_reason
306
+
307
+ # Required. Immutable. The Google Workspace resource that's monitored for events,
308
+ # formatted as the [full resource name](https://google.aip.dev/122#full-
309
+ # resource-names). To learn about target resources and the events that they
310
+ # support, see [Supported Google Workspace events](https://developers.google.com/
311
+ # workspace/events#supported-events). A user can only authorize your app to
312
+ # create one subscription for a given target resource. If your app tries to
313
+ # create another subscription with the same user credentials, the request
314
+ # returns an `ALREADY_EXISTS` error.
315
+ # Corresponds to the JSON property `targetResource`
316
+ # @return [String]
317
+ attr_accessor :target_resource
318
+
319
+ # Input only. The time-to-live (TTL) or duration for the subscription. If
320
+ # unspecified or set to `0`, uses the maximum possible duration.
321
+ # Corresponds to the JSON property `ttl`
322
+ # @return [String]
323
+ attr_accessor :ttl
324
+
325
+ # Output only. System-assigned unique identifier for the subscription.
326
+ # Corresponds to the JSON property `uid`
327
+ # @return [String]
328
+ attr_accessor :uid
329
+
330
+ # Output only. The last time that the subscription is updated.
331
+ # Corresponds to the JSON property `updateTime`
332
+ # @return [String]
333
+ attr_accessor :update_time
334
+
335
+ def initialize(**args)
336
+ update!(**args)
337
+ end
338
+
339
+ # Update properties of this object
340
+ def update!(**args)
341
+ @authority = args[:authority] if args.key?(:authority)
342
+ @create_time = args[:create_time] if args.key?(:create_time)
343
+ @etag = args[:etag] if args.key?(:etag)
344
+ @event_types = args[:event_types] if args.key?(:event_types)
345
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
346
+ @name = args[:name] if args.key?(:name)
347
+ @notification_endpoint = args[:notification_endpoint] if args.key?(:notification_endpoint)
348
+ @payload_options = args[:payload_options] if args.key?(:payload_options)
349
+ @reconciling = args[:reconciling] if args.key?(:reconciling)
350
+ @state = args[:state] if args.key?(:state)
351
+ @suspension_reason = args[:suspension_reason] if args.key?(:suspension_reason)
352
+ @target_resource = args[:target_resource] if args.key?(:target_resource)
353
+ @ttl = args[:ttl] if args.key?(:ttl)
354
+ @uid = args[:uid] if args.key?(:uid)
355
+ @update_time = args[:update_time] if args.key?(:update_time)
356
+ end
357
+ end
24
358
  end
25
359
  end
26
360
  end
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module WorkspaceeventsV1
18
18
  # Version of the google-apis-workspaceevents_v1 gem
19
- GEM_VERSION = "0.1.0"
19
+ GEM_VERSION = "0.2.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.13.1"
22
+ GENERATOR_VERSION = "0.14.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240123"
25
+ REVISION = "20240218"
26
26
  end
27
27
  end
28
28
  end
@@ -21,6 +21,122 @@ require 'google/apis/errors'
21
21
  module Google
22
22
  module Apis
23
23
  module WorkspaceeventsV1
24
+
25
+ class ListSubscriptionsResponse
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class NotificationEndpoint
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class Operation
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class PayloadOptions
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class ReactivateSubscriptionRequest
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class Status
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
61
+ class Subscription
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
67
+ class ListSubscriptionsResponse
68
+ # @private
69
+ class Representation < Google::Apis::Core::JsonRepresentation
70
+ property :next_page_token, as: 'nextPageToken'
71
+ collection :subscriptions, as: 'subscriptions', class: Google::Apis::WorkspaceeventsV1::Subscription, decorator: Google::Apis::WorkspaceeventsV1::Subscription::Representation
72
+
73
+ end
74
+ end
75
+
76
+ class NotificationEndpoint
77
+ # @private
78
+ class Representation < Google::Apis::Core::JsonRepresentation
79
+ property :pubsub_topic, as: 'pubsubTopic'
80
+ end
81
+ end
82
+
83
+ class Operation
84
+ # @private
85
+ class Representation < Google::Apis::Core::JsonRepresentation
86
+ property :done, as: 'done'
87
+ property :error, as: 'error', class: Google::Apis::WorkspaceeventsV1::Status, decorator: Google::Apis::WorkspaceeventsV1::Status::Representation
88
+
89
+ hash :metadata, as: 'metadata'
90
+ property :name, as: 'name'
91
+ hash :response, as: 'response'
92
+ end
93
+ end
94
+
95
+ class PayloadOptions
96
+ # @private
97
+ class Representation < Google::Apis::Core::JsonRepresentation
98
+ property :field_mask, as: 'fieldMask'
99
+ property :include_resource, as: 'includeResource'
100
+ end
101
+ end
102
+
103
+ class ReactivateSubscriptionRequest
104
+ # @private
105
+ class Representation < Google::Apis::Core::JsonRepresentation
106
+ end
107
+ end
108
+
109
+ class Status
110
+ # @private
111
+ class Representation < Google::Apis::Core::JsonRepresentation
112
+ property :code, as: 'code'
113
+ collection :details, as: 'details'
114
+ property :message, as: 'message'
115
+ end
116
+ end
117
+
118
+ class Subscription
119
+ # @private
120
+ class Representation < Google::Apis::Core::JsonRepresentation
121
+ property :authority, as: 'authority'
122
+ property :create_time, as: 'createTime'
123
+ property :etag, as: 'etag'
124
+ collection :event_types, as: 'eventTypes'
125
+ property :expire_time, as: 'expireTime'
126
+ property :name, as: 'name'
127
+ property :notification_endpoint, as: 'notificationEndpoint', class: Google::Apis::WorkspaceeventsV1::NotificationEndpoint, decorator: Google::Apis::WorkspaceeventsV1::NotificationEndpoint::Representation
128
+
129
+ property :payload_options, as: 'payloadOptions', class: Google::Apis::WorkspaceeventsV1::PayloadOptions, decorator: Google::Apis::WorkspaceeventsV1::PayloadOptions::Representation
130
+
131
+ property :reconciling, as: 'reconciling'
132
+ property :state, as: 'state'
133
+ property :suspension_reason, as: 'suspensionReason'
134
+ property :target_resource, as: 'targetResource'
135
+ property :ttl, as: 'ttl'
136
+ property :uid, as: 'uid'
137
+ property :update_time, as: 'updateTime'
138
+ end
139
+ end
24
140
  end
25
141
  end
26
142
  end
@@ -51,6 +51,296 @@ module Google
51
51
  client_version: Google::Apis::WorkspaceeventsV1::GEM_VERSION)
52
52
  @batch_path = 'batch'
53
53
  end
54
+
55
+ # Gets the latest state of a long-running operation. Clients can use this method
56
+ # to poll the operation result at intervals as recommended by the API service.
57
+ # @param [String] name
58
+ # The name of the operation resource.
59
+ # @param [String] fields
60
+ # Selector specifying which fields to include in a partial response.
61
+ # @param [String] quota_user
62
+ # Available to use for quota purposes for server-side applications. Can be any
63
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
64
+ # @param [Google::Apis::RequestOptions] options
65
+ # Request-specific options
66
+ #
67
+ # @yield [result, err] Result & error if block supplied
68
+ # @yieldparam result [Google::Apis::WorkspaceeventsV1::Operation] parsed result object
69
+ # @yieldparam err [StandardError] error object if request failed
70
+ #
71
+ # @return [Google::Apis::WorkspaceeventsV1::Operation]
72
+ #
73
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
74
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
75
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
76
+ def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
77
+ command = make_simple_command(:get, 'v1/{+name}', options)
78
+ command.response_representation = Google::Apis::WorkspaceeventsV1::Operation::Representation
79
+ command.response_class = Google::Apis::WorkspaceeventsV1::Operation
80
+ command.params['name'] = name unless name.nil?
81
+ command.query['fields'] = fields unless fields.nil?
82
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
83
+ execute_or_queue_command(command, &block)
84
+ end
85
+
86
+ # [Developer Preview](https://developers.google.com/workspace/preview): Creates
87
+ # a Google Workspace subscription. To learn how to use this method, see [Create
88
+ # a Google Workspace subscription](https://developers.google.com/workspace/
89
+ # events/guides/create-subscription).
90
+ # @param [Google::Apis::WorkspaceeventsV1::Subscription] subscription_object
91
+ # @param [Boolean] validate_only
92
+ # Optional. If set to `true`, validates and previews the request, but doesn't
93
+ # create the subscription.
94
+ # @param [String] fields
95
+ # Selector specifying which fields to include in a partial response.
96
+ # @param [String] quota_user
97
+ # Available to use for quota purposes for server-side applications. Can be any
98
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
99
+ # @param [Google::Apis::RequestOptions] options
100
+ # Request-specific options
101
+ #
102
+ # @yield [result, err] Result & error if block supplied
103
+ # @yieldparam result [Google::Apis::WorkspaceeventsV1::Operation] parsed result object
104
+ # @yieldparam err [StandardError] error object if request failed
105
+ #
106
+ # @return [Google::Apis::WorkspaceeventsV1::Operation]
107
+ #
108
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
109
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
110
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
111
+ def create_subscription(subscription_object = nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
112
+ command = make_simple_command(:post, 'v1/subscriptions', options)
113
+ command.request_representation = Google::Apis::WorkspaceeventsV1::Subscription::Representation
114
+ command.request_object = subscription_object
115
+ command.response_representation = Google::Apis::WorkspaceeventsV1::Operation::Representation
116
+ command.response_class = Google::Apis::WorkspaceeventsV1::Operation
117
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
118
+ command.query['fields'] = fields unless fields.nil?
119
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
120
+ execute_or_queue_command(command, &block)
121
+ end
122
+
123
+ # [Developer Preview](https://developers.google.com/workspace/preview): Deletes
124
+ # a Google Workspace subscription. To learn how to use this method, see [Delete
125
+ # a Google Workspace subscription](https://developers.google.com/workspace/
126
+ # events/guides/delete-subscription).
127
+ # @param [String] name
128
+ # Required. Resource name of the subscription to delete. Format: `subscriptions/`
129
+ # subscription``
130
+ # @param [Boolean] allow_missing
131
+ # Optional. If set to `true` and the subscription isn't found, the request
132
+ # succeeds but doesn't delete the subscription.
133
+ # @param [String] etag
134
+ # Optional. Etag of the subscription. If present, it must match with the server'
135
+ # s etag. Otherwise, request fails with the status `ABORTED`.
136
+ # @param [Boolean] validate_only
137
+ # Optional. If set to `true`, validates and previews the request, but doesn't
138
+ # delete the subscription.
139
+ # @param [String] fields
140
+ # Selector specifying which fields to include in a partial response.
141
+ # @param [String] quota_user
142
+ # Available to use for quota purposes for server-side applications. Can be any
143
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
144
+ # @param [Google::Apis::RequestOptions] options
145
+ # Request-specific options
146
+ #
147
+ # @yield [result, err] Result & error if block supplied
148
+ # @yieldparam result [Google::Apis::WorkspaceeventsV1::Operation] parsed result object
149
+ # @yieldparam err [StandardError] error object if request failed
150
+ #
151
+ # @return [Google::Apis::WorkspaceeventsV1::Operation]
152
+ #
153
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
154
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
155
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
156
+ def delete_subscription(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
157
+ command = make_simple_command(:delete, 'v1/{+name}', options)
158
+ command.response_representation = Google::Apis::WorkspaceeventsV1::Operation::Representation
159
+ command.response_class = Google::Apis::WorkspaceeventsV1::Operation
160
+ command.params['name'] = name unless name.nil?
161
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
162
+ command.query['etag'] = etag unless etag.nil?
163
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
164
+ command.query['fields'] = fields unless fields.nil?
165
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
166
+ execute_or_queue_command(command, &block)
167
+ end
168
+
169
+ # [Developer Preview](https://developers.google.com/workspace/preview): Gets
170
+ # details about a Google Workspace subscription. To learn how to use this method,
171
+ # see [Get details about a Google Workspace subscription](https://developers.
172
+ # google.com/workspace/events/guides/get-subscription).
173
+ # @param [String] name
174
+ # Required. Resource name of the subscription. Format: `subscriptions/`
175
+ # subscription``
176
+ # @param [String] fields
177
+ # Selector specifying which fields to include in a partial response.
178
+ # @param [String] quota_user
179
+ # Available to use for quota purposes for server-side applications. Can be any
180
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
181
+ # @param [Google::Apis::RequestOptions] options
182
+ # Request-specific options
183
+ #
184
+ # @yield [result, err] Result & error if block supplied
185
+ # @yieldparam result [Google::Apis::WorkspaceeventsV1::Subscription] parsed result object
186
+ # @yieldparam err [StandardError] error object if request failed
187
+ #
188
+ # @return [Google::Apis::WorkspaceeventsV1::Subscription]
189
+ #
190
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
191
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
192
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
193
+ def get_subscription(name, fields: nil, quota_user: nil, options: nil, &block)
194
+ command = make_simple_command(:get, 'v1/{+name}', options)
195
+ command.response_representation = Google::Apis::WorkspaceeventsV1::Subscription::Representation
196
+ command.response_class = Google::Apis::WorkspaceeventsV1::Subscription
197
+ command.params['name'] = name unless name.nil?
198
+ command.query['fields'] = fields unless fields.nil?
199
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
200
+ execute_or_queue_command(command, &block)
201
+ end
202
+
203
+ # [Developer Preview](https://developers.google.com/workspace/preview): Lists
204
+ # Google Workspace subscriptions. To learn how to use this method, see [List
205
+ # Google Workspace subscriptions](https://developers.google.com/workspace/events/
206
+ # guides/list-subscriptions).
207
+ # @param [String] filter
208
+ # Required. A query filter. You can filter subscriptions by event type (`
209
+ # event_types`) and target resource (`target_resource`). You must specify at
210
+ # least one event type in your query. To filter for multiple event types, use
211
+ # the `OR` operator. To filter by both event type and target resource, use the `
212
+ # AND` operator and specify the full resource name, such as `//chat.googleapis.
213
+ # com/spaces/`space``. For example, the following queries are valid: ```
214
+ # event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"
215
+ # google.workspace.chat.message.v1.created" event_types:"google.workspace.chat.
216
+ # message.v1.created" AND target_resource="//chat.googleapis.com/spaces/`space`"
217
+ # ( event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"
218
+ # google.workspace.chat.message.v1.created" ) AND target_resource="//chat.
219
+ # googleapis.com/spaces/`space`" ``` The server rejects invalid queries with an `
220
+ # INVALID_ARGUMENT` error.
221
+ # @param [Fixnum] page_size
222
+ # Optional. The maximum number of subscriptions to return. The service might
223
+ # return fewer than this value. If unspecified or set to `0`, up to 50
224
+ # subscriptions are returned. The maximum value is 100. If you specify a value
225
+ # more than 100, the system only returns 100 subscriptions.
226
+ # @param [String] page_token
227
+ # Optional. A page token, received from a previous list subscriptions call.
228
+ # Provide this parameter to retrieve the subsequent page. When paginating, the
229
+ # filter value should match the call that provided the page token. Passing a
230
+ # different value might lead to unexpected results.
231
+ # @param [String] fields
232
+ # Selector specifying which fields to include in a partial response.
233
+ # @param [String] quota_user
234
+ # Available to use for quota purposes for server-side applications. Can be any
235
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
236
+ # @param [Google::Apis::RequestOptions] options
237
+ # Request-specific options
238
+ #
239
+ # @yield [result, err] Result & error if block supplied
240
+ # @yieldparam result [Google::Apis::WorkspaceeventsV1::ListSubscriptionsResponse] parsed result object
241
+ # @yieldparam err [StandardError] error object if request failed
242
+ #
243
+ # @return [Google::Apis::WorkspaceeventsV1::ListSubscriptionsResponse]
244
+ #
245
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
246
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
247
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
248
+ def list_subscriptions(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
249
+ command = make_simple_command(:get, 'v1/subscriptions', options)
250
+ command.response_representation = Google::Apis::WorkspaceeventsV1::ListSubscriptionsResponse::Representation
251
+ command.response_class = Google::Apis::WorkspaceeventsV1::ListSubscriptionsResponse
252
+ command.query['filter'] = filter unless filter.nil?
253
+ command.query['pageSize'] = page_size unless page_size.nil?
254
+ command.query['pageToken'] = page_token unless page_token.nil?
255
+ command.query['fields'] = fields unless fields.nil?
256
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
257
+ execute_or_queue_command(command, &block)
258
+ end
259
+
260
+ # [Developer Preview](https://developers.google.com/workspace/preview): Updates
261
+ # or renews a Google Workspace subscription. To learn how to use this method,
262
+ # see [Update or renew a Google Workspace subscription](https://developers.
263
+ # google.com/workspace/events/guides/update-subscription).
264
+ # @param [String] name
265
+ # Optional. Immutable. Identifier. Resource name of the subscription. Format: `
266
+ # subscriptions/`subscription``
267
+ # @param [Google::Apis::WorkspaceeventsV1::Subscription] subscription_object
268
+ # @param [String] update_mask
269
+ # Optional. Required. The field to update. You can update one of the following
270
+ # fields in a subscription: * `expire_time`: The timestamp when the subscription
271
+ # expires. * `ttl`: The time-to-live (TTL) or duration of the subscription.
272
+ # @param [Boolean] validate_only
273
+ # Optional. If set to `true`, validates and previews the request, but doesn't
274
+ # update the subscription.
275
+ # @param [String] fields
276
+ # Selector specifying which fields to include in a partial response.
277
+ # @param [String] quota_user
278
+ # Available to use for quota purposes for server-side applications. Can be any
279
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
280
+ # @param [Google::Apis::RequestOptions] options
281
+ # Request-specific options
282
+ #
283
+ # @yield [result, err] Result & error if block supplied
284
+ # @yieldparam result [Google::Apis::WorkspaceeventsV1::Operation] parsed result object
285
+ # @yieldparam err [StandardError] error object if request failed
286
+ #
287
+ # @return [Google::Apis::WorkspaceeventsV1::Operation]
288
+ #
289
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
290
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
291
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
292
+ def patch_subscription(name, subscription_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
293
+ command = make_simple_command(:patch, 'v1/{+name}', options)
294
+ command.request_representation = Google::Apis::WorkspaceeventsV1::Subscription::Representation
295
+ command.request_object = subscription_object
296
+ command.response_representation = Google::Apis::WorkspaceeventsV1::Operation::Representation
297
+ command.response_class = Google::Apis::WorkspaceeventsV1::Operation
298
+ command.params['name'] = name unless name.nil?
299
+ command.query['updateMask'] = update_mask unless update_mask.nil?
300
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
301
+ command.query['fields'] = fields unless fields.nil?
302
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
303
+ execute_or_queue_command(command, &block)
304
+ end
305
+
306
+ # [Developer Preview](https://developers.google.com/workspace/preview):
307
+ # Reactivates a suspended Google Workspace subscription. This method resets your
308
+ # subscription's `State` field to `ACTIVE`. Before you use this method, you must
309
+ # fix the error that suspended the subscription. To learn how to use this method,
310
+ # see [Reactivate a Google Workspace subscription](https://developers.google.
311
+ # com/workspace/events/guides/reactivate-subscription).
312
+ # @param [String] name
313
+ # Required. Resource name of the subscription. Format: `subscriptions/`
314
+ # subscription``
315
+ # @param [Google::Apis::WorkspaceeventsV1::ReactivateSubscriptionRequest] reactivate_subscription_request_object
316
+ # @param [String] fields
317
+ # Selector specifying which fields to include in a partial response.
318
+ # @param [String] quota_user
319
+ # Available to use for quota purposes for server-side applications. Can be any
320
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
321
+ # @param [Google::Apis::RequestOptions] options
322
+ # Request-specific options
323
+ #
324
+ # @yield [result, err] Result & error if block supplied
325
+ # @yieldparam result [Google::Apis::WorkspaceeventsV1::Operation] parsed result object
326
+ # @yieldparam err [StandardError] error object if request failed
327
+ #
328
+ # @return [Google::Apis::WorkspaceeventsV1::Operation]
329
+ #
330
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
331
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
332
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
333
+ def reactivate_subscription(name, reactivate_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
334
+ command = make_simple_command(:post, 'v1/{+name}:reactivate', options)
335
+ command.request_representation = Google::Apis::WorkspaceeventsV1::ReactivateSubscriptionRequest::Representation
336
+ command.request_object = reactivate_subscription_request_object
337
+ command.response_representation = Google::Apis::WorkspaceeventsV1::Operation::Representation
338
+ command.response_class = Google::Apis::WorkspaceeventsV1::Operation
339
+ command.params['name'] = name unless name.nil?
340
+ command.query['fields'] = fields unless fields.nil?
341
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
342
+ execute_or_queue_command(command, &block)
343
+ end
54
344
 
55
345
  protected
56
346
 
@@ -29,6 +29,33 @@ module Google
29
29
  # Version of the Google Workspace Events API this client connects to.
30
30
  # This is NOT the gem version.
31
31
  VERSION = 'V1'
32
+
33
+ # Private Service: https://www.googleapis.com/auth/chat.bot
34
+ AUTH_CHAT_BOT = 'https://www.googleapis.com/auth/chat.bot'
35
+
36
+ # View, add, and remove members from conversations in Google Chat
37
+ AUTH_CHAT_MEMBERSHIPS = 'https://www.googleapis.com/auth/chat.memberships'
38
+
39
+ # View members in Google Chat conversations.
40
+ AUTH_CHAT_MEMBERSHIPS_READONLY = 'https://www.googleapis.com/auth/chat.memberships.readonly'
41
+
42
+ # View, compose, send, update, and delete messages, and add, view, and delete reactions to messages.
43
+ AUTH_CHAT_MESSAGES = 'https://www.googleapis.com/auth/chat.messages'
44
+
45
+ # View, add, and delete reactions to messages in Google Chat
46
+ AUTH_CHAT_MESSAGES_REACTIONS = 'https://www.googleapis.com/auth/chat.messages.reactions'
47
+
48
+ # View reactions to messages in Google Chat
49
+ AUTH_CHAT_MESSAGES_REACTIONS_READONLY = 'https://www.googleapis.com/auth/chat.messages.reactions.readonly'
50
+
51
+ # View messages and reactions in Google Chat
52
+ AUTH_CHAT_MESSAGES_READONLY = 'https://www.googleapis.com/auth/chat.messages.readonly'
53
+
54
+ # Create conversations and spaces and see or edit metadata (including history settings and access settings) in Google Chat
55
+ AUTH_CHAT_SPACES = 'https://www.googleapis.com/auth/chat.spaces'
56
+
57
+ # View chat and spaces in Google Chat
58
+ AUTH_CHAT_SPACES_READONLY = 'https://www.googleapis.com/auth/chat.spaces.readonly'
32
59
  end
33
60
  end
34
61
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-workspaceevents_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.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-01-28 00:00:00.000000000 Z
11
+ date: 2024-02-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.12.0
19
+ version: 0.14.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.12.0
29
+ version: 0.14.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workspaceevents_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-workspaceevents_v1/v0.1.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-workspaceevents_v1/v0.2.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workspaceevents_v1
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -68,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
68
68
  requirements:
69
69
  - - ">="
70
70
  - !ruby/object:Gem::Version
71
- version: '2.5'
71
+ version: '2.7'
72
72
  required_rubygems_version: !ruby/object:Gem::Requirement
73
73
  requirements:
74
74
  - - ">="
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.5.3
78
+ rubygems_version: 3.5.6
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Google Workspace Events API V1