google-apis-calendar_v3 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1967 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module CalendarV3
23
+ # Calendar API
24
+ #
25
+ # Manipulates events and other calendar data.
26
+ #
27
+ # @example
28
+ # require 'google/apis/calendar_v3'
29
+ #
30
+ # Calendar = Google::Apis::CalendarV3 # Alias the module
31
+ # service = Calendar::CalendarService.new
32
+ #
33
+ # @see https://developers.google.com/google-apps/calendar/firstapp
34
+ class CalendarService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
42
+ # characters.
43
+ attr_accessor :quota_user
44
+
45
+ # @return [String]
46
+ # Deprecated. Please use quotaUser instead.
47
+ attr_accessor :user_ip
48
+
49
+ def initialize
50
+ super('https://www.googleapis.com/', 'calendar/v3/',
51
+ client_name: 'google-apis-calendar_v3',
52
+ client_version: Google::Apis::CalendarV3::GEM_VERSION)
53
+ @batch_path = 'batch/calendar/v3'
54
+ end
55
+
56
+ # Deletes an access control rule.
57
+ # @param [String] calendar_id
58
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
59
+ # method. If you want to access the primary calendar of the currently logged in
60
+ # user, use the "primary" keyword.
61
+ # @param [String] rule_id
62
+ # ACL rule identifier.
63
+ # @param [String] fields
64
+ # Selector specifying which fields to include in a partial response.
65
+ # @param [String] quota_user
66
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
67
+ # characters.
68
+ # @param [String] user_ip
69
+ # Deprecated. Please use quotaUser instead.
70
+ # @param [Google::Apis::RequestOptions] options
71
+ # Request-specific options
72
+ #
73
+ # @yield [result, err] Result & error if block supplied
74
+ # @yieldparam result [NilClass] No result returned for this method
75
+ # @yieldparam err [StandardError] error object if request failed
76
+ #
77
+ # @return [void]
78
+ #
79
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
80
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
81
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
82
+ def delete_acl(calendar_id, rule_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
83
+ command = make_simple_command(:delete, 'calendars/{calendarId}/acl/{ruleId}', options)
84
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
85
+ command.params['ruleId'] = rule_id unless rule_id.nil?
86
+ command.query['fields'] = fields unless fields.nil?
87
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
88
+ command.query['userIp'] = user_ip unless user_ip.nil?
89
+ execute_or_queue_command(command, &block)
90
+ end
91
+
92
+ # Returns an access control rule.
93
+ # @param [String] calendar_id
94
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
95
+ # method. If you want to access the primary calendar of the currently logged in
96
+ # user, use the "primary" keyword.
97
+ # @param [String] rule_id
98
+ # ACL rule identifier.
99
+ # @param [String] fields
100
+ # Selector specifying which fields to include in a partial response.
101
+ # @param [String] quota_user
102
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
103
+ # characters.
104
+ # @param [String] user_ip
105
+ # Deprecated. Please use quotaUser instead.
106
+ # @param [Google::Apis::RequestOptions] options
107
+ # Request-specific options
108
+ #
109
+ # @yield [result, err] Result & error if block supplied
110
+ # @yieldparam result [Google::Apis::CalendarV3::AclRule] parsed result object
111
+ # @yieldparam err [StandardError] error object if request failed
112
+ #
113
+ # @return [Google::Apis::CalendarV3::AclRule]
114
+ #
115
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
116
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
117
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
118
+ def get_acl(calendar_id, rule_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
119
+ command = make_simple_command(:get, 'calendars/{calendarId}/acl/{ruleId}', options)
120
+ command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
121
+ command.response_class = Google::Apis::CalendarV3::AclRule
122
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
123
+ command.params['ruleId'] = rule_id unless rule_id.nil?
124
+ command.query['fields'] = fields unless fields.nil?
125
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
126
+ command.query['userIp'] = user_ip unless user_ip.nil?
127
+ execute_or_queue_command(command, &block)
128
+ end
129
+
130
+ # Creates an access control rule.
131
+ # @param [String] calendar_id
132
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
133
+ # method. If you want to access the primary calendar of the currently logged in
134
+ # user, use the "primary" keyword.
135
+ # @param [Google::Apis::CalendarV3::AclRule] acl_rule_object
136
+ # @param [Boolean] send_notifications
137
+ # Whether to send notifications about the calendar sharing change. Optional. The
138
+ # default is True.
139
+ # @param [String] fields
140
+ # Selector specifying which fields to include in a partial response.
141
+ # @param [String] quota_user
142
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
143
+ # characters.
144
+ # @param [String] user_ip
145
+ # Deprecated. Please use quotaUser instead.
146
+ # @param [Google::Apis::RequestOptions] options
147
+ # Request-specific options
148
+ #
149
+ # @yield [result, err] Result & error if block supplied
150
+ # @yieldparam result [Google::Apis::CalendarV3::AclRule] parsed result object
151
+ # @yieldparam err [StandardError] error object if request failed
152
+ #
153
+ # @return [Google::Apis::CalendarV3::AclRule]
154
+ #
155
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
156
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
157
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
158
+ def insert_acl(calendar_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
159
+ command = make_simple_command(:post, 'calendars/{calendarId}/acl', options)
160
+ command.request_representation = Google::Apis::CalendarV3::AclRule::Representation
161
+ command.request_object = acl_rule_object
162
+ command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
163
+ command.response_class = Google::Apis::CalendarV3::AclRule
164
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
165
+ command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
166
+ command.query['fields'] = fields unless fields.nil?
167
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
168
+ command.query['userIp'] = user_ip unless user_ip.nil?
169
+ execute_or_queue_command(command, &block)
170
+ end
171
+
172
+ # Returns the rules in the access control list for the calendar.
173
+ # @param [String] calendar_id
174
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
175
+ # method. If you want to access the primary calendar of the currently logged in
176
+ # user, use the "primary" keyword.
177
+ # @param [Fixnum] max_results
178
+ # Maximum number of entries returned on one result page. By default the value is
179
+ # 100 entries. The page size can never be larger than 250 entries. Optional.
180
+ # @param [String] page_token
181
+ # Token specifying which result page to return. Optional.
182
+ # @param [Boolean] show_deleted
183
+ # Whether to include deleted ACLs in the result. Deleted ACLs are represented by
184
+ # role equal to "none". Deleted ACLs will always be included if syncToken is
185
+ # provided. Optional. The default is False.
186
+ # @param [String] sync_token
187
+ # Token obtained from the nextSyncToken field returned on the last page of
188
+ # results from the previous list request. It makes the result of this list
189
+ # request contain only entries that have changed since then. All entries deleted
190
+ # since the previous list request will always be in the result set and it is not
191
+ # allowed to set showDeleted to False.
192
+ # If the syncToken expires, the server will respond with a 410 GONE response
193
+ # code and the client should clear its storage and perform a full
194
+ # synchronization without any syncToken.
195
+ # Learn more about incremental synchronization.
196
+ # Optional. The default is to return all entries.
197
+ # @param [String] fields
198
+ # Selector specifying which fields to include in a partial response.
199
+ # @param [String] quota_user
200
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
201
+ # characters.
202
+ # @param [String] user_ip
203
+ # Deprecated. Please use quotaUser instead.
204
+ # @param [Google::Apis::RequestOptions] options
205
+ # Request-specific options
206
+ #
207
+ # @yield [result, err] Result & error if block supplied
208
+ # @yieldparam result [Google::Apis::CalendarV3::Acl] parsed result object
209
+ # @yieldparam err [StandardError] error object if request failed
210
+ #
211
+ # @return [Google::Apis::CalendarV3::Acl]
212
+ #
213
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
214
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
215
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
216
+ def list_acls(calendar_id, max_results: nil, page_token: nil, show_deleted: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
217
+ command = make_simple_command(:get, 'calendars/{calendarId}/acl', options)
218
+ command.response_representation = Google::Apis::CalendarV3::Acl::Representation
219
+ command.response_class = Google::Apis::CalendarV3::Acl
220
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
221
+ command.query['maxResults'] = max_results unless max_results.nil?
222
+ command.query['pageToken'] = page_token unless page_token.nil?
223
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
224
+ command.query['syncToken'] = sync_token unless sync_token.nil?
225
+ command.query['fields'] = fields unless fields.nil?
226
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
227
+ command.query['userIp'] = user_ip unless user_ip.nil?
228
+ execute_or_queue_command(command, &block)
229
+ end
230
+
231
+ # Updates an access control rule. This method supports patch semantics.
232
+ # @param [String] calendar_id
233
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
234
+ # method. If you want to access the primary calendar of the currently logged in
235
+ # user, use the "primary" keyword.
236
+ # @param [String] rule_id
237
+ # ACL rule identifier.
238
+ # @param [Google::Apis::CalendarV3::AclRule] acl_rule_object
239
+ # @param [Boolean] send_notifications
240
+ # Whether to send notifications about the calendar sharing change. Note that
241
+ # there are no notifications on access removal. Optional. The default is True.
242
+ # @param [String] fields
243
+ # Selector specifying which fields to include in a partial response.
244
+ # @param [String] quota_user
245
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
246
+ # characters.
247
+ # @param [String] user_ip
248
+ # Deprecated. Please use quotaUser instead.
249
+ # @param [Google::Apis::RequestOptions] options
250
+ # Request-specific options
251
+ #
252
+ # @yield [result, err] Result & error if block supplied
253
+ # @yieldparam result [Google::Apis::CalendarV3::AclRule] parsed result object
254
+ # @yieldparam err [StandardError] error object if request failed
255
+ #
256
+ # @return [Google::Apis::CalendarV3::AclRule]
257
+ #
258
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
259
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
260
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
261
+ def patch_acl(calendar_id, rule_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
262
+ command = make_simple_command(:patch, 'calendars/{calendarId}/acl/{ruleId}', options)
263
+ command.request_representation = Google::Apis::CalendarV3::AclRule::Representation
264
+ command.request_object = acl_rule_object
265
+ command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
266
+ command.response_class = Google::Apis::CalendarV3::AclRule
267
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
268
+ command.params['ruleId'] = rule_id unless rule_id.nil?
269
+ command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
270
+ command.query['fields'] = fields unless fields.nil?
271
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
272
+ command.query['userIp'] = user_ip unless user_ip.nil?
273
+ execute_or_queue_command(command, &block)
274
+ end
275
+
276
+ # Updates an access control rule.
277
+ # @param [String] calendar_id
278
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
279
+ # method. If you want to access the primary calendar of the currently logged in
280
+ # user, use the "primary" keyword.
281
+ # @param [String] rule_id
282
+ # ACL rule identifier.
283
+ # @param [Google::Apis::CalendarV3::AclRule] acl_rule_object
284
+ # @param [Boolean] send_notifications
285
+ # Whether to send notifications about the calendar sharing change. Note that
286
+ # there are no notifications on access removal. Optional. The default is True.
287
+ # @param [String] fields
288
+ # Selector specifying which fields to include in a partial response.
289
+ # @param [String] quota_user
290
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
291
+ # characters.
292
+ # @param [String] user_ip
293
+ # Deprecated. Please use quotaUser instead.
294
+ # @param [Google::Apis::RequestOptions] options
295
+ # Request-specific options
296
+ #
297
+ # @yield [result, err] Result & error if block supplied
298
+ # @yieldparam result [Google::Apis::CalendarV3::AclRule] parsed result object
299
+ # @yieldparam err [StandardError] error object if request failed
300
+ #
301
+ # @return [Google::Apis::CalendarV3::AclRule]
302
+ #
303
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
304
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
305
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
306
+ def update_acl(calendar_id, rule_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
307
+ command = make_simple_command(:put, 'calendars/{calendarId}/acl/{ruleId}', options)
308
+ command.request_representation = Google::Apis::CalendarV3::AclRule::Representation
309
+ command.request_object = acl_rule_object
310
+ command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
311
+ command.response_class = Google::Apis::CalendarV3::AclRule
312
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
313
+ command.params['ruleId'] = rule_id unless rule_id.nil?
314
+ command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
315
+ command.query['fields'] = fields unless fields.nil?
316
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
317
+ command.query['userIp'] = user_ip unless user_ip.nil?
318
+ execute_or_queue_command(command, &block)
319
+ end
320
+
321
+ # Watch for changes to ACL resources.
322
+ # @param [String] calendar_id
323
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
324
+ # method. If you want to access the primary calendar of the currently logged in
325
+ # user, use the "primary" keyword.
326
+ # @param [Google::Apis::CalendarV3::Channel] channel_object
327
+ # @param [Fixnum] max_results
328
+ # Maximum number of entries returned on one result page. By default the value is
329
+ # 100 entries. The page size can never be larger than 250 entries. Optional.
330
+ # @param [String] page_token
331
+ # Token specifying which result page to return. Optional.
332
+ # @param [Boolean] show_deleted
333
+ # Whether to include deleted ACLs in the result. Deleted ACLs are represented by
334
+ # role equal to "none". Deleted ACLs will always be included if syncToken is
335
+ # provided. Optional. The default is False.
336
+ # @param [String] sync_token
337
+ # Token obtained from the nextSyncToken field returned on the last page of
338
+ # results from the previous list request. It makes the result of this list
339
+ # request contain only entries that have changed since then. All entries deleted
340
+ # since the previous list request will always be in the result set and it is not
341
+ # allowed to set showDeleted to False.
342
+ # If the syncToken expires, the server will respond with a 410 GONE response
343
+ # code and the client should clear its storage and perform a full
344
+ # synchronization without any syncToken.
345
+ # Learn more about incremental synchronization.
346
+ # Optional. The default is to return all entries.
347
+ # @param [String] fields
348
+ # Selector specifying which fields to include in a partial response.
349
+ # @param [String] quota_user
350
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
351
+ # characters.
352
+ # @param [String] user_ip
353
+ # Deprecated. Please use quotaUser instead.
354
+ # @param [Google::Apis::RequestOptions] options
355
+ # Request-specific options
356
+ #
357
+ # @yield [result, err] Result & error if block supplied
358
+ # @yieldparam result [Google::Apis::CalendarV3::Channel] parsed result object
359
+ # @yieldparam err [StandardError] error object if request failed
360
+ #
361
+ # @return [Google::Apis::CalendarV3::Channel]
362
+ #
363
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
364
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
365
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
366
+ def watch_acl(calendar_id, channel_object = nil, max_results: nil, page_token: nil, show_deleted: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
367
+ command = make_simple_command(:post, 'calendars/{calendarId}/acl/watch', options)
368
+ command.request_representation = Google::Apis::CalendarV3::Channel::Representation
369
+ command.request_object = channel_object
370
+ command.response_representation = Google::Apis::CalendarV3::Channel::Representation
371
+ command.response_class = Google::Apis::CalendarV3::Channel
372
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
373
+ command.query['maxResults'] = max_results unless max_results.nil?
374
+ command.query['pageToken'] = page_token unless page_token.nil?
375
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
376
+ command.query['syncToken'] = sync_token unless sync_token.nil?
377
+ command.query['fields'] = fields unless fields.nil?
378
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
379
+ command.query['userIp'] = user_ip unless user_ip.nil?
380
+ execute_or_queue_command(command, &block)
381
+ end
382
+
383
+ # Removes a calendar from the user's calendar list.
384
+ # @param [String] calendar_id
385
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
386
+ # method. If you want to access the primary calendar of the currently logged in
387
+ # user, use the "primary" keyword.
388
+ # @param [String] fields
389
+ # Selector specifying which fields to include in a partial response.
390
+ # @param [String] quota_user
391
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
392
+ # characters.
393
+ # @param [String] user_ip
394
+ # Deprecated. Please use quotaUser instead.
395
+ # @param [Google::Apis::RequestOptions] options
396
+ # Request-specific options
397
+ #
398
+ # @yield [result, err] Result & error if block supplied
399
+ # @yieldparam result [NilClass] No result returned for this method
400
+ # @yieldparam err [StandardError] error object if request failed
401
+ #
402
+ # @return [void]
403
+ #
404
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
405
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
406
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
407
+ def delete_calendar_list(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
408
+ command = make_simple_command(:delete, 'users/me/calendarList/{calendarId}', options)
409
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
410
+ command.query['fields'] = fields unless fields.nil?
411
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
412
+ command.query['userIp'] = user_ip unless user_ip.nil?
413
+ execute_or_queue_command(command, &block)
414
+ end
415
+
416
+ # Returns a calendar from the user's calendar list.
417
+ # @param [String] calendar_id
418
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
419
+ # method. If you want to access the primary calendar of the currently logged in
420
+ # user, use the "primary" keyword.
421
+ # @param [String] fields
422
+ # Selector specifying which fields to include in a partial response.
423
+ # @param [String] quota_user
424
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
425
+ # characters.
426
+ # @param [String] user_ip
427
+ # Deprecated. Please use quotaUser instead.
428
+ # @param [Google::Apis::RequestOptions] options
429
+ # Request-specific options
430
+ #
431
+ # @yield [result, err] Result & error if block supplied
432
+ # @yieldparam result [Google::Apis::CalendarV3::CalendarListEntry] parsed result object
433
+ # @yieldparam err [StandardError] error object if request failed
434
+ #
435
+ # @return [Google::Apis::CalendarV3::CalendarListEntry]
436
+ #
437
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
438
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
439
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
440
+ def get_calendar_list(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
441
+ command = make_simple_command(:get, 'users/me/calendarList/{calendarId}', options)
442
+ command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
443
+ command.response_class = Google::Apis::CalendarV3::CalendarListEntry
444
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
445
+ command.query['fields'] = fields unless fields.nil?
446
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
447
+ command.query['userIp'] = user_ip unless user_ip.nil?
448
+ execute_or_queue_command(command, &block)
449
+ end
450
+
451
+ # Inserts an existing calendar into the user's calendar list.
452
+ # @param [Google::Apis::CalendarV3::CalendarListEntry] calendar_list_entry_object
453
+ # @param [Boolean] color_rgb_format
454
+ # Whether to use the foregroundColor and backgroundColor fields to write the
455
+ # calendar colors (RGB). If this feature is used, the index-based colorId field
456
+ # will be set to the best matching option automatically. Optional. The default
457
+ # is False.
458
+ # @param [String] fields
459
+ # Selector specifying which fields to include in a partial response.
460
+ # @param [String] quota_user
461
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
462
+ # characters.
463
+ # @param [String] user_ip
464
+ # Deprecated. Please use quotaUser instead.
465
+ # @param [Google::Apis::RequestOptions] options
466
+ # Request-specific options
467
+ #
468
+ # @yield [result, err] Result & error if block supplied
469
+ # @yieldparam result [Google::Apis::CalendarV3::CalendarListEntry] parsed result object
470
+ # @yieldparam err [StandardError] error object if request failed
471
+ #
472
+ # @return [Google::Apis::CalendarV3::CalendarListEntry]
473
+ #
474
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
475
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
476
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
477
+ def insert_calendar_list(calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
478
+ command = make_simple_command(:post, 'users/me/calendarList', options)
479
+ command.request_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
480
+ command.request_object = calendar_list_entry_object
481
+ command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
482
+ command.response_class = Google::Apis::CalendarV3::CalendarListEntry
483
+ command.query['colorRgbFormat'] = color_rgb_format unless color_rgb_format.nil?
484
+ command.query['fields'] = fields unless fields.nil?
485
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
486
+ command.query['userIp'] = user_ip unless user_ip.nil?
487
+ execute_or_queue_command(command, &block)
488
+ end
489
+
490
+ # Returns the calendars on the user's calendar list.
491
+ # @param [Fixnum] max_results
492
+ # Maximum number of entries returned on one result page. By default the value is
493
+ # 100 entries. The page size can never be larger than 250 entries. Optional.
494
+ # @param [String] min_access_role
495
+ # The minimum access role for the user in the returned entries. Optional. The
496
+ # default is no restriction.
497
+ # @param [String] page_token
498
+ # Token specifying which result page to return. Optional.
499
+ # @param [Boolean] show_deleted
500
+ # Whether to include deleted calendar list entries in the result. Optional. The
501
+ # default is False.
502
+ # @param [Boolean] show_hidden
503
+ # Whether to show hidden entries. Optional. The default is False.
504
+ # @param [String] sync_token
505
+ # Token obtained from the nextSyncToken field returned on the last page of
506
+ # results from the previous list request. It makes the result of this list
507
+ # request contain only entries that have changed since then. If only read-only
508
+ # fields such as calendar properties or ACLs have changed, the entry won't be
509
+ # returned. All entries deleted and hidden since the previous list request will
510
+ # always be in the result set and it is not allowed to set showDeleted neither
511
+ # showHidden to False.
512
+ # To ensure client state consistency minAccessRole query parameter cannot be
513
+ # specified together with nextSyncToken.
514
+ # If the syncToken expires, the server will respond with a 410 GONE response
515
+ # code and the client should clear its storage and perform a full
516
+ # synchronization without any syncToken.
517
+ # Learn more about incremental synchronization.
518
+ # Optional. The default is to return all entries.
519
+ # @param [String] fields
520
+ # Selector specifying which fields to include in a partial response.
521
+ # @param [String] quota_user
522
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
523
+ # characters.
524
+ # @param [String] user_ip
525
+ # Deprecated. Please use quotaUser instead.
526
+ # @param [Google::Apis::RequestOptions] options
527
+ # Request-specific options
528
+ #
529
+ # @yield [result, err] Result & error if block supplied
530
+ # @yieldparam result [Google::Apis::CalendarV3::CalendarList] parsed result object
531
+ # @yieldparam err [StandardError] error object if request failed
532
+ #
533
+ # @return [Google::Apis::CalendarV3::CalendarList]
534
+ #
535
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
536
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
537
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
538
+ def list_calendar_lists(max_results: nil, min_access_role: nil, page_token: nil, show_deleted: nil, show_hidden: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
539
+ command = make_simple_command(:get, 'users/me/calendarList', options)
540
+ command.response_representation = Google::Apis::CalendarV3::CalendarList::Representation
541
+ command.response_class = Google::Apis::CalendarV3::CalendarList
542
+ command.query['maxResults'] = max_results unless max_results.nil?
543
+ command.query['minAccessRole'] = min_access_role unless min_access_role.nil?
544
+ command.query['pageToken'] = page_token unless page_token.nil?
545
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
546
+ command.query['showHidden'] = show_hidden unless show_hidden.nil?
547
+ command.query['syncToken'] = sync_token unless sync_token.nil?
548
+ command.query['fields'] = fields unless fields.nil?
549
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
550
+ command.query['userIp'] = user_ip unless user_ip.nil?
551
+ execute_or_queue_command(command, &block)
552
+ end
553
+
554
+ # Updates an existing calendar on the user's calendar list. This method supports
555
+ # patch semantics.
556
+ # @param [String] calendar_id
557
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
558
+ # method. If you want to access the primary calendar of the currently logged in
559
+ # user, use the "primary" keyword.
560
+ # @param [Google::Apis::CalendarV3::CalendarListEntry] calendar_list_entry_object
561
+ # @param [Boolean] color_rgb_format
562
+ # Whether to use the foregroundColor and backgroundColor fields to write the
563
+ # calendar colors (RGB). If this feature is used, the index-based colorId field
564
+ # will be set to the best matching option automatically. Optional. The default
565
+ # is False.
566
+ # @param [String] fields
567
+ # Selector specifying which fields to include in a partial response.
568
+ # @param [String] quota_user
569
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
570
+ # characters.
571
+ # @param [String] user_ip
572
+ # Deprecated. Please use quotaUser instead.
573
+ # @param [Google::Apis::RequestOptions] options
574
+ # Request-specific options
575
+ #
576
+ # @yield [result, err] Result & error if block supplied
577
+ # @yieldparam result [Google::Apis::CalendarV3::CalendarListEntry] parsed result object
578
+ # @yieldparam err [StandardError] error object if request failed
579
+ #
580
+ # @return [Google::Apis::CalendarV3::CalendarListEntry]
581
+ #
582
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
583
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
584
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
585
+ def patch_calendar_list(calendar_id, calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
586
+ command = make_simple_command(:patch, 'users/me/calendarList/{calendarId}', options)
587
+ command.request_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
588
+ command.request_object = calendar_list_entry_object
589
+ command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
590
+ command.response_class = Google::Apis::CalendarV3::CalendarListEntry
591
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
592
+ command.query['colorRgbFormat'] = color_rgb_format unless color_rgb_format.nil?
593
+ command.query['fields'] = fields unless fields.nil?
594
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
595
+ command.query['userIp'] = user_ip unless user_ip.nil?
596
+ execute_or_queue_command(command, &block)
597
+ end
598
+
599
+ # Updates an existing calendar on the user's calendar list.
600
+ # @param [String] calendar_id
601
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
602
+ # method. If you want to access the primary calendar of the currently logged in
603
+ # user, use the "primary" keyword.
604
+ # @param [Google::Apis::CalendarV3::CalendarListEntry] calendar_list_entry_object
605
+ # @param [Boolean] color_rgb_format
606
+ # Whether to use the foregroundColor and backgroundColor fields to write the
607
+ # calendar colors (RGB). If this feature is used, the index-based colorId field
608
+ # will be set to the best matching option automatically. Optional. The default
609
+ # is False.
610
+ # @param [String] fields
611
+ # Selector specifying which fields to include in a partial response.
612
+ # @param [String] quota_user
613
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
614
+ # characters.
615
+ # @param [String] user_ip
616
+ # Deprecated. Please use quotaUser instead.
617
+ # @param [Google::Apis::RequestOptions] options
618
+ # Request-specific options
619
+ #
620
+ # @yield [result, err] Result & error if block supplied
621
+ # @yieldparam result [Google::Apis::CalendarV3::CalendarListEntry] parsed result object
622
+ # @yieldparam err [StandardError] error object if request failed
623
+ #
624
+ # @return [Google::Apis::CalendarV3::CalendarListEntry]
625
+ #
626
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
627
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
628
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
629
+ def update_calendar_list(calendar_id, calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
630
+ command = make_simple_command(:put, 'users/me/calendarList/{calendarId}', options)
631
+ command.request_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
632
+ command.request_object = calendar_list_entry_object
633
+ command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
634
+ command.response_class = Google::Apis::CalendarV3::CalendarListEntry
635
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
636
+ command.query['colorRgbFormat'] = color_rgb_format unless color_rgb_format.nil?
637
+ command.query['fields'] = fields unless fields.nil?
638
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
639
+ command.query['userIp'] = user_ip unless user_ip.nil?
640
+ execute_or_queue_command(command, &block)
641
+ end
642
+
643
+ # Watch for changes to CalendarList resources.
644
+ # @param [Google::Apis::CalendarV3::Channel] channel_object
645
+ # @param [Fixnum] max_results
646
+ # Maximum number of entries returned on one result page. By default the value is
647
+ # 100 entries. The page size can never be larger than 250 entries. Optional.
648
+ # @param [String] min_access_role
649
+ # The minimum access role for the user in the returned entries. Optional. The
650
+ # default is no restriction.
651
+ # @param [String] page_token
652
+ # Token specifying which result page to return. Optional.
653
+ # @param [Boolean] show_deleted
654
+ # Whether to include deleted calendar list entries in the result. Optional. The
655
+ # default is False.
656
+ # @param [Boolean] show_hidden
657
+ # Whether to show hidden entries. Optional. The default is False.
658
+ # @param [String] sync_token
659
+ # Token obtained from the nextSyncToken field returned on the last page of
660
+ # results from the previous list request. It makes the result of this list
661
+ # request contain only entries that have changed since then. If only read-only
662
+ # fields such as calendar properties or ACLs have changed, the entry won't be
663
+ # returned. All entries deleted and hidden since the previous list request will
664
+ # always be in the result set and it is not allowed to set showDeleted neither
665
+ # showHidden to False.
666
+ # To ensure client state consistency minAccessRole query parameter cannot be
667
+ # specified together with nextSyncToken.
668
+ # If the syncToken expires, the server will respond with a 410 GONE response
669
+ # code and the client should clear its storage and perform a full
670
+ # synchronization without any syncToken.
671
+ # Learn more about incremental synchronization.
672
+ # Optional. The default is to return all entries.
673
+ # @param [String] fields
674
+ # Selector specifying which fields to include in a partial response.
675
+ # @param [String] quota_user
676
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
677
+ # characters.
678
+ # @param [String] user_ip
679
+ # Deprecated. Please use quotaUser instead.
680
+ # @param [Google::Apis::RequestOptions] options
681
+ # Request-specific options
682
+ #
683
+ # @yield [result, err] Result & error if block supplied
684
+ # @yieldparam result [Google::Apis::CalendarV3::Channel] parsed result object
685
+ # @yieldparam err [StandardError] error object if request failed
686
+ #
687
+ # @return [Google::Apis::CalendarV3::Channel]
688
+ #
689
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
690
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
691
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
692
+ def watch_calendar_list(channel_object = nil, max_results: nil, min_access_role: nil, page_token: nil, show_deleted: nil, show_hidden: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
693
+ command = make_simple_command(:post, 'users/me/calendarList/watch', options)
694
+ command.request_representation = Google::Apis::CalendarV3::Channel::Representation
695
+ command.request_object = channel_object
696
+ command.response_representation = Google::Apis::CalendarV3::Channel::Representation
697
+ command.response_class = Google::Apis::CalendarV3::Channel
698
+ command.query['maxResults'] = max_results unless max_results.nil?
699
+ command.query['minAccessRole'] = min_access_role unless min_access_role.nil?
700
+ command.query['pageToken'] = page_token unless page_token.nil?
701
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
702
+ command.query['showHidden'] = show_hidden unless show_hidden.nil?
703
+ command.query['syncToken'] = sync_token unless sync_token.nil?
704
+ command.query['fields'] = fields unless fields.nil?
705
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
706
+ command.query['userIp'] = user_ip unless user_ip.nil?
707
+ execute_or_queue_command(command, &block)
708
+ end
709
+
710
+ # Clears a primary calendar. This operation deletes all events associated with
711
+ # the primary calendar of an account.
712
+ # @param [String] calendar_id
713
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
714
+ # method. If you want to access the primary calendar of the currently logged in
715
+ # user, use the "primary" keyword.
716
+ # @param [String] fields
717
+ # Selector specifying which fields to include in a partial response.
718
+ # @param [String] quota_user
719
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
720
+ # characters.
721
+ # @param [String] user_ip
722
+ # Deprecated. Please use quotaUser instead.
723
+ # @param [Google::Apis::RequestOptions] options
724
+ # Request-specific options
725
+ #
726
+ # @yield [result, err] Result & error if block supplied
727
+ # @yieldparam result [NilClass] No result returned for this method
728
+ # @yieldparam err [StandardError] error object if request failed
729
+ #
730
+ # @return [void]
731
+ #
732
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
733
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
734
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
735
+ def clear_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
736
+ command = make_simple_command(:post, 'calendars/{calendarId}/clear', options)
737
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
738
+ command.query['fields'] = fields unless fields.nil?
739
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
740
+ command.query['userIp'] = user_ip unless user_ip.nil?
741
+ execute_or_queue_command(command, &block)
742
+ end
743
+
744
+ # Deletes a secondary calendar. Use calendars.clear for clearing all events on
745
+ # primary calendars.
746
+ # @param [String] calendar_id
747
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
748
+ # method. If you want to access the primary calendar of the currently logged in
749
+ # user, use the "primary" keyword.
750
+ # @param [String] fields
751
+ # Selector specifying which fields to include in a partial response.
752
+ # @param [String] quota_user
753
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
754
+ # characters.
755
+ # @param [String] user_ip
756
+ # Deprecated. Please use quotaUser instead.
757
+ # @param [Google::Apis::RequestOptions] options
758
+ # Request-specific options
759
+ #
760
+ # @yield [result, err] Result & error if block supplied
761
+ # @yieldparam result [NilClass] No result returned for this method
762
+ # @yieldparam err [StandardError] error object if request failed
763
+ #
764
+ # @return [void]
765
+ #
766
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
767
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
768
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
769
+ def delete_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
770
+ command = make_simple_command(:delete, 'calendars/{calendarId}', options)
771
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
772
+ command.query['fields'] = fields unless fields.nil?
773
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
774
+ command.query['userIp'] = user_ip unless user_ip.nil?
775
+ execute_or_queue_command(command, &block)
776
+ end
777
+
778
+ # Returns metadata for a calendar.
779
+ # @param [String] calendar_id
780
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
781
+ # method. If you want to access the primary calendar of the currently logged in
782
+ # user, use the "primary" keyword.
783
+ # @param [String] fields
784
+ # Selector specifying which fields to include in a partial response.
785
+ # @param [String] quota_user
786
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
787
+ # characters.
788
+ # @param [String] user_ip
789
+ # Deprecated. Please use quotaUser instead.
790
+ # @param [Google::Apis::RequestOptions] options
791
+ # Request-specific options
792
+ #
793
+ # @yield [result, err] Result & error if block supplied
794
+ # @yieldparam result [Google::Apis::CalendarV3::Calendar] parsed result object
795
+ # @yieldparam err [StandardError] error object if request failed
796
+ #
797
+ # @return [Google::Apis::CalendarV3::Calendar]
798
+ #
799
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
800
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
801
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
802
+ def get_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
803
+ command = make_simple_command(:get, 'calendars/{calendarId}', options)
804
+ command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
805
+ command.response_class = Google::Apis::CalendarV3::Calendar
806
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
807
+ command.query['fields'] = fields unless fields.nil?
808
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
809
+ command.query['userIp'] = user_ip unless user_ip.nil?
810
+ execute_or_queue_command(command, &block)
811
+ end
812
+
813
+ # Creates a secondary calendar.
814
+ # @param [Google::Apis::CalendarV3::Calendar] calendar_object
815
+ # @param [String] fields
816
+ # Selector specifying which fields to include in a partial response.
817
+ # @param [String] quota_user
818
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
819
+ # characters.
820
+ # @param [String] user_ip
821
+ # Deprecated. Please use quotaUser instead.
822
+ # @param [Google::Apis::RequestOptions] options
823
+ # Request-specific options
824
+ #
825
+ # @yield [result, err] Result & error if block supplied
826
+ # @yieldparam result [Google::Apis::CalendarV3::Calendar] parsed result object
827
+ # @yieldparam err [StandardError] error object if request failed
828
+ #
829
+ # @return [Google::Apis::CalendarV3::Calendar]
830
+ #
831
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
832
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
833
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
834
+ def insert_calendar(calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
835
+ command = make_simple_command(:post, 'calendars', options)
836
+ command.request_representation = Google::Apis::CalendarV3::Calendar::Representation
837
+ command.request_object = calendar_object
838
+ command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
839
+ command.response_class = Google::Apis::CalendarV3::Calendar
840
+ command.query['fields'] = fields unless fields.nil?
841
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
842
+ command.query['userIp'] = user_ip unless user_ip.nil?
843
+ execute_or_queue_command(command, &block)
844
+ end
845
+
846
+ # Updates metadata for a calendar. This method supports patch semantics.
847
+ # @param [String] calendar_id
848
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
849
+ # method. If you want to access the primary calendar of the currently logged in
850
+ # user, use the "primary" keyword.
851
+ # @param [Google::Apis::CalendarV3::Calendar] calendar_object
852
+ # @param [String] fields
853
+ # Selector specifying which fields to include in a partial response.
854
+ # @param [String] quota_user
855
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
856
+ # characters.
857
+ # @param [String] user_ip
858
+ # Deprecated. Please use quotaUser instead.
859
+ # @param [Google::Apis::RequestOptions] options
860
+ # Request-specific options
861
+ #
862
+ # @yield [result, err] Result & error if block supplied
863
+ # @yieldparam result [Google::Apis::CalendarV3::Calendar] parsed result object
864
+ # @yieldparam err [StandardError] error object if request failed
865
+ #
866
+ # @return [Google::Apis::CalendarV3::Calendar]
867
+ #
868
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
869
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
870
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
871
+ def patch_calendar(calendar_id, calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
872
+ command = make_simple_command(:patch, 'calendars/{calendarId}', options)
873
+ command.request_representation = Google::Apis::CalendarV3::Calendar::Representation
874
+ command.request_object = calendar_object
875
+ command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
876
+ command.response_class = Google::Apis::CalendarV3::Calendar
877
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
878
+ command.query['fields'] = fields unless fields.nil?
879
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
880
+ command.query['userIp'] = user_ip unless user_ip.nil?
881
+ execute_or_queue_command(command, &block)
882
+ end
883
+
884
+ # Updates metadata for a calendar.
885
+ # @param [String] calendar_id
886
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
887
+ # method. If you want to access the primary calendar of the currently logged in
888
+ # user, use the "primary" keyword.
889
+ # @param [Google::Apis::CalendarV3::Calendar] calendar_object
890
+ # @param [String] fields
891
+ # Selector specifying which fields to include in a partial response.
892
+ # @param [String] quota_user
893
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
894
+ # characters.
895
+ # @param [String] user_ip
896
+ # Deprecated. Please use quotaUser instead.
897
+ # @param [Google::Apis::RequestOptions] options
898
+ # Request-specific options
899
+ #
900
+ # @yield [result, err] Result & error if block supplied
901
+ # @yieldparam result [Google::Apis::CalendarV3::Calendar] parsed result object
902
+ # @yieldparam err [StandardError] error object if request failed
903
+ #
904
+ # @return [Google::Apis::CalendarV3::Calendar]
905
+ #
906
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
907
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
908
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
909
+ def update_calendar(calendar_id, calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
910
+ command = make_simple_command(:put, 'calendars/{calendarId}', options)
911
+ command.request_representation = Google::Apis::CalendarV3::Calendar::Representation
912
+ command.request_object = calendar_object
913
+ command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
914
+ command.response_class = Google::Apis::CalendarV3::Calendar
915
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
916
+ command.query['fields'] = fields unless fields.nil?
917
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
918
+ command.query['userIp'] = user_ip unless user_ip.nil?
919
+ execute_or_queue_command(command, &block)
920
+ end
921
+
922
+ # Stop watching resources through this channel
923
+ # @param [Google::Apis::CalendarV3::Channel] channel_object
924
+ # @param [String] fields
925
+ # Selector specifying which fields to include in a partial response.
926
+ # @param [String] quota_user
927
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
928
+ # characters.
929
+ # @param [String] user_ip
930
+ # Deprecated. Please use quotaUser instead.
931
+ # @param [Google::Apis::RequestOptions] options
932
+ # Request-specific options
933
+ #
934
+ # @yield [result, err] Result & error if block supplied
935
+ # @yieldparam result [NilClass] No result returned for this method
936
+ # @yieldparam err [StandardError] error object if request failed
937
+ #
938
+ # @return [void]
939
+ #
940
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
941
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
942
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
943
+ def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
944
+ command = make_simple_command(:post, 'channels/stop', options)
945
+ command.request_representation = Google::Apis::CalendarV3::Channel::Representation
946
+ command.request_object = channel_object
947
+ command.query['fields'] = fields unless fields.nil?
948
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
949
+ command.query['userIp'] = user_ip unless user_ip.nil?
950
+ execute_or_queue_command(command, &block)
951
+ end
952
+
953
+ # Returns the color definitions for calendars and events.
954
+ # @param [String] fields
955
+ # Selector specifying which fields to include in a partial response.
956
+ # @param [String] quota_user
957
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
958
+ # characters.
959
+ # @param [String] user_ip
960
+ # Deprecated. Please use quotaUser instead.
961
+ # @param [Google::Apis::RequestOptions] options
962
+ # Request-specific options
963
+ #
964
+ # @yield [result, err] Result & error if block supplied
965
+ # @yieldparam result [Google::Apis::CalendarV3::Colors] parsed result object
966
+ # @yieldparam err [StandardError] error object if request failed
967
+ #
968
+ # @return [Google::Apis::CalendarV3::Colors]
969
+ #
970
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
971
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
972
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
973
+ def get_color(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
974
+ command = make_simple_command(:get, 'colors', options)
975
+ command.response_representation = Google::Apis::CalendarV3::Colors::Representation
976
+ command.response_class = Google::Apis::CalendarV3::Colors
977
+ command.query['fields'] = fields unless fields.nil?
978
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
979
+ command.query['userIp'] = user_ip unless user_ip.nil?
980
+ execute_or_queue_command(command, &block)
981
+ end
982
+
983
+ # Deletes an event.
984
+ # @param [String] calendar_id
985
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
986
+ # method. If you want to access the primary calendar of the currently logged in
987
+ # user, use the "primary" keyword.
988
+ # @param [String] event_id
989
+ # Event identifier.
990
+ # @param [Boolean] send_notifications
991
+ # Deprecated. Please use sendUpdates instead.
992
+ # Whether to send notifications about the deletion of the event. Note that some
993
+ # emails might still be sent even if you set the value to false. The default is
994
+ # false.
995
+ # @param [String] send_updates
996
+ # Guests who should receive notifications about the deletion of the event.
997
+ # @param [String] fields
998
+ # Selector specifying which fields to include in a partial response.
999
+ # @param [String] quota_user
1000
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1001
+ # characters.
1002
+ # @param [String] user_ip
1003
+ # Deprecated. Please use quotaUser instead.
1004
+ # @param [Google::Apis::RequestOptions] options
1005
+ # Request-specific options
1006
+ #
1007
+ # @yield [result, err] Result & error if block supplied
1008
+ # @yieldparam result [NilClass] No result returned for this method
1009
+ # @yieldparam err [StandardError] error object if request failed
1010
+ #
1011
+ # @return [void]
1012
+ #
1013
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1014
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1015
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1016
+ def delete_event(calendar_id, event_id, send_notifications: nil, send_updates: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1017
+ command = make_simple_command(:delete, 'calendars/{calendarId}/events/{eventId}', options)
1018
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1019
+ command.params['eventId'] = event_id unless event_id.nil?
1020
+ command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
1021
+ command.query['sendUpdates'] = send_updates unless send_updates.nil?
1022
+ command.query['fields'] = fields unless fields.nil?
1023
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1024
+ command.query['userIp'] = user_ip unless user_ip.nil?
1025
+ execute_or_queue_command(command, &block)
1026
+ end
1027
+
1028
+ # Returns an event.
1029
+ # @param [String] calendar_id
1030
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
1031
+ # method. If you want to access the primary calendar of the currently logged in
1032
+ # user, use the "primary" keyword.
1033
+ # @param [String] event_id
1034
+ # Event identifier.
1035
+ # @param [Boolean] always_include_email
1036
+ # Deprecated and ignored. A value will always be returned in the email field for
1037
+ # the organizer, creator and attendees, even if no real email address is
1038
+ # available (i.e. a generated, non-working value will be provided).
1039
+ # @param [Fixnum] max_attendees
1040
+ # The maximum number of attendees to include in the response. If there are more
1041
+ # than the specified number of attendees, only the participant is returned.
1042
+ # Optional.
1043
+ # @param [String] time_zone
1044
+ # Time zone used in the response. Optional. The default is the time zone of the
1045
+ # calendar.
1046
+ # @param [String] fields
1047
+ # Selector specifying which fields to include in a partial response.
1048
+ # @param [String] quota_user
1049
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1050
+ # characters.
1051
+ # @param [String] user_ip
1052
+ # Deprecated. Please use quotaUser instead.
1053
+ # @param [Google::Apis::RequestOptions] options
1054
+ # Request-specific options
1055
+ #
1056
+ # @yield [result, err] Result & error if block supplied
1057
+ # @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
1058
+ # @yieldparam err [StandardError] error object if request failed
1059
+ #
1060
+ # @return [Google::Apis::CalendarV3::Event]
1061
+ #
1062
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1063
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1064
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1065
+ def get_event(calendar_id, event_id, always_include_email: nil, max_attendees: nil, time_zone: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1066
+ command = make_simple_command(:get, 'calendars/{calendarId}/events/{eventId}', options)
1067
+ command.response_representation = Google::Apis::CalendarV3::Event::Representation
1068
+ command.response_class = Google::Apis::CalendarV3::Event
1069
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1070
+ command.params['eventId'] = event_id unless event_id.nil?
1071
+ command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
1072
+ command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
1073
+ command.query['timeZone'] = time_zone unless time_zone.nil?
1074
+ command.query['fields'] = fields unless fields.nil?
1075
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1076
+ command.query['userIp'] = user_ip unless user_ip.nil?
1077
+ execute_or_queue_command(command, &block)
1078
+ end
1079
+
1080
+ # Imports an event. This operation is used to add a private copy of an existing
1081
+ # event to a calendar.
1082
+ # @param [String] calendar_id
1083
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
1084
+ # method. If you want to access the primary calendar of the currently logged in
1085
+ # user, use the "primary" keyword.
1086
+ # @param [Google::Apis::CalendarV3::Event] event_object
1087
+ # @param [Fixnum] conference_data_version
1088
+ # Version number of conference data supported by the API client. Version 0
1089
+ # assumes no conference data support and ignores conference data in the event's
1090
+ # body. Version 1 enables support for copying of ConferenceData as well as for
1091
+ # creating new conferences using the createRequest field of conferenceData. The
1092
+ # default is 0.
1093
+ # @param [Boolean] supports_attachments
1094
+ # Whether API client performing operation supports event attachments. Optional.
1095
+ # The default is False.
1096
+ # @param [String] fields
1097
+ # Selector specifying which fields to include in a partial response.
1098
+ # @param [String] quota_user
1099
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1100
+ # characters.
1101
+ # @param [String] user_ip
1102
+ # Deprecated. Please use quotaUser instead.
1103
+ # @param [Google::Apis::RequestOptions] options
1104
+ # Request-specific options
1105
+ #
1106
+ # @yield [result, err] Result & error if block supplied
1107
+ # @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
1108
+ # @yieldparam err [StandardError] error object if request failed
1109
+ #
1110
+ # @return [Google::Apis::CalendarV3::Event]
1111
+ #
1112
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1113
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1114
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1115
+ def import_event(calendar_id, event_object = nil, conference_data_version: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1116
+ command = make_simple_command(:post, 'calendars/{calendarId}/events/import', options)
1117
+ command.request_representation = Google::Apis::CalendarV3::Event::Representation
1118
+ command.request_object = event_object
1119
+ command.response_representation = Google::Apis::CalendarV3::Event::Representation
1120
+ command.response_class = Google::Apis::CalendarV3::Event
1121
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1122
+ command.query['conferenceDataVersion'] = conference_data_version unless conference_data_version.nil?
1123
+ command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
1124
+ command.query['fields'] = fields unless fields.nil?
1125
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1126
+ command.query['userIp'] = user_ip unless user_ip.nil?
1127
+ execute_or_queue_command(command, &block)
1128
+ end
1129
+
1130
+ # Creates an event.
1131
+ # @param [String] calendar_id
1132
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
1133
+ # method. If you want to access the primary calendar of the currently logged in
1134
+ # user, use the "primary" keyword.
1135
+ # @param [Google::Apis::CalendarV3::Event] event_object
1136
+ # @param [Fixnum] conference_data_version
1137
+ # Version number of conference data supported by the API client. Version 0
1138
+ # assumes no conference data support and ignores conference data in the event's
1139
+ # body. Version 1 enables support for copying of ConferenceData as well as for
1140
+ # creating new conferences using the createRequest field of conferenceData. The
1141
+ # default is 0.
1142
+ # @param [Fixnum] max_attendees
1143
+ # The maximum number of attendees to include in the response. If there are more
1144
+ # than the specified number of attendees, only the participant is returned.
1145
+ # Optional.
1146
+ # @param [Boolean] send_notifications
1147
+ # Deprecated. Please use sendUpdates instead.
1148
+ # Whether to send notifications about the creation of the new event. Note that
1149
+ # some emails might still be sent even if you set the value to false. The
1150
+ # default is false.
1151
+ # @param [String] send_updates
1152
+ # Whether to send notifications about the creation of the new event. Note that
1153
+ # some emails might still be sent. The default is false.
1154
+ # @param [Boolean] supports_attachments
1155
+ # Whether API client performing operation supports event attachments. Optional.
1156
+ # The default is False.
1157
+ # @param [String] fields
1158
+ # Selector specifying which fields to include in a partial response.
1159
+ # @param [String] quota_user
1160
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1161
+ # characters.
1162
+ # @param [String] user_ip
1163
+ # Deprecated. Please use quotaUser instead.
1164
+ # @param [Google::Apis::RequestOptions] options
1165
+ # Request-specific options
1166
+ #
1167
+ # @yield [result, err] Result & error if block supplied
1168
+ # @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
1169
+ # @yieldparam err [StandardError] error object if request failed
1170
+ #
1171
+ # @return [Google::Apis::CalendarV3::Event]
1172
+ #
1173
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1174
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1175
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1176
+ def insert_event(calendar_id, event_object = nil, conference_data_version: nil, max_attendees: nil, send_notifications: nil, send_updates: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1177
+ command = make_simple_command(:post, 'calendars/{calendarId}/events', options)
1178
+ command.request_representation = Google::Apis::CalendarV3::Event::Representation
1179
+ command.request_object = event_object
1180
+ command.response_representation = Google::Apis::CalendarV3::Event::Representation
1181
+ command.response_class = Google::Apis::CalendarV3::Event
1182
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1183
+ command.query['conferenceDataVersion'] = conference_data_version unless conference_data_version.nil?
1184
+ command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
1185
+ command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
1186
+ command.query['sendUpdates'] = send_updates unless send_updates.nil?
1187
+ command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
1188
+ command.query['fields'] = fields unless fields.nil?
1189
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1190
+ command.query['userIp'] = user_ip unless user_ip.nil?
1191
+ execute_or_queue_command(command, &block)
1192
+ end
1193
+
1194
+ # Returns instances of the specified recurring event.
1195
+ # @param [String] calendar_id
1196
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
1197
+ # method. If you want to access the primary calendar of the currently logged in
1198
+ # user, use the "primary" keyword.
1199
+ # @param [String] event_id
1200
+ # Recurring event identifier.
1201
+ # @param [Boolean] always_include_email
1202
+ # Deprecated and ignored. A value will always be returned in the email field for
1203
+ # the organizer, creator and attendees, even if no real email address is
1204
+ # available (i.e. a generated, non-working value will be provided).
1205
+ # @param [Fixnum] max_attendees
1206
+ # The maximum number of attendees to include in the response. If there are more
1207
+ # than the specified number of attendees, only the participant is returned.
1208
+ # Optional.
1209
+ # @param [Fixnum] max_results
1210
+ # Maximum number of events returned on one result page. By default the value is
1211
+ # 250 events. The page size can never be larger than 2500 events. Optional.
1212
+ # @param [String] original_start
1213
+ # The original start time of the instance in the result. Optional.
1214
+ # @param [String] page_token
1215
+ # Token specifying which result page to return. Optional.
1216
+ # @param [Boolean] show_deleted
1217
+ # Whether to include deleted events (with status equals "cancelled") in the
1218
+ # result. Cancelled instances of recurring events will still be included if
1219
+ # singleEvents is False. Optional. The default is False.
1220
+ # @param [DateTime] time_max
1221
+ # Upper bound (exclusive) for an event's start time to filter by. Optional. The
1222
+ # default is not to filter by start time. Must be an RFC3339 timestamp with
1223
+ # mandatory time zone offset.
1224
+ # @param [DateTime] time_min
1225
+ # Lower bound (inclusive) for an event's end time to filter by. Optional. The
1226
+ # default is not to filter by end time. Must be an RFC3339 timestamp with
1227
+ # mandatory time zone offset.
1228
+ # @param [String] time_zone
1229
+ # Time zone used in the response. Optional. The default is the time zone of the
1230
+ # calendar.
1231
+ # @param [String] fields
1232
+ # Selector specifying which fields to include in a partial response.
1233
+ # @param [String] quota_user
1234
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1235
+ # characters.
1236
+ # @param [String] user_ip
1237
+ # Deprecated. Please use quotaUser instead.
1238
+ # @param [Google::Apis::RequestOptions] options
1239
+ # Request-specific options
1240
+ #
1241
+ # @yield [result, err] Result & error if block supplied
1242
+ # @yieldparam result [Google::Apis::CalendarV3::Events] parsed result object
1243
+ # @yieldparam err [StandardError] error object if request failed
1244
+ #
1245
+ # @return [Google::Apis::CalendarV3::Events]
1246
+ #
1247
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1248
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1249
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1250
+ def list_event_instances(calendar_id, event_id, always_include_email: nil, max_attendees: nil, max_results: nil, original_start: nil, page_token: nil, show_deleted: nil, time_max: nil, time_min: nil, time_zone: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1251
+ command = make_simple_command(:get, 'calendars/{calendarId}/events/{eventId}/instances', options)
1252
+ command.response_representation = Google::Apis::CalendarV3::Events::Representation
1253
+ command.response_class = Google::Apis::CalendarV3::Events
1254
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1255
+ command.params['eventId'] = event_id unless event_id.nil?
1256
+ command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
1257
+ command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
1258
+ command.query['maxResults'] = max_results unless max_results.nil?
1259
+ command.query['originalStart'] = original_start unless original_start.nil?
1260
+ command.query['pageToken'] = page_token unless page_token.nil?
1261
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
1262
+ command.query['timeMax'] = time_max unless time_max.nil?
1263
+ command.query['timeMin'] = time_min unless time_min.nil?
1264
+ command.query['timeZone'] = time_zone unless time_zone.nil?
1265
+ command.query['fields'] = fields unless fields.nil?
1266
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1267
+ command.query['userIp'] = user_ip unless user_ip.nil?
1268
+ execute_or_queue_command(command, &block)
1269
+ end
1270
+
1271
+ # Returns events on the specified calendar.
1272
+ # @param [String] calendar_id
1273
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
1274
+ # method. If you want to access the primary calendar of the currently logged in
1275
+ # user, use the "primary" keyword.
1276
+ # @param [Boolean] always_include_email
1277
+ # Deprecated and ignored. A value will always be returned in the email field for
1278
+ # the organizer, creator and attendees, even if no real email address is
1279
+ # available (i.e. a generated, non-working value will be provided).
1280
+ # @param [String] i_cal_uid
1281
+ # Specifies event ID in the iCalendar format to be included in the response.
1282
+ # Optional.
1283
+ # @param [Fixnum] max_attendees
1284
+ # The maximum number of attendees to include in the response. If there are more
1285
+ # than the specified number of attendees, only the participant is returned.
1286
+ # Optional.
1287
+ # @param [Fixnum] max_results
1288
+ # Maximum number of events returned on one result page. The number of events in
1289
+ # the resulting page may be less than this value, or none at all, even if there
1290
+ # are more events matching the query. Incomplete pages can be detected by a non-
1291
+ # empty nextPageToken field in the response. By default the value is 250 events.
1292
+ # The page size can never be larger than 2500 events. Optional.
1293
+ # @param [String] order_by
1294
+ # The order of the events returned in the result. Optional. The default is an
1295
+ # unspecified, stable order.
1296
+ # @param [String] page_token
1297
+ # Token specifying which result page to return. Optional.
1298
+ # @param [Array<String>, String] private_extended_property
1299
+ # Extended properties constraint specified as propertyName=value. Matches only
1300
+ # private properties. This parameter might be repeated multiple times to return
1301
+ # events that match all given constraints.
1302
+ # @param [String] q
1303
+ # Free text search terms to find events that match these terms in any field,
1304
+ # except for extended properties. Optional.
1305
+ # @param [Array<String>, String] shared_extended_property
1306
+ # Extended properties constraint specified as propertyName=value. Matches only
1307
+ # shared properties. This parameter might be repeated multiple times to return
1308
+ # events that match all given constraints.
1309
+ # @param [Boolean] show_deleted
1310
+ # Whether to include deleted events (with status equals "cancelled") in the
1311
+ # result. Cancelled instances of recurring events (but not the underlying
1312
+ # recurring event) will still be included if showDeleted and singleEvents are
1313
+ # both False. If showDeleted and singleEvents are both True, only single
1314
+ # instances of deleted events (but not the underlying recurring events) are
1315
+ # returned. Optional. The default is False.
1316
+ # @param [Boolean] show_hidden_invitations
1317
+ # Whether to include hidden invitations in the result. Optional. The default is
1318
+ # False.
1319
+ # @param [Boolean] single_events
1320
+ # Whether to expand recurring events into instances and only return single one-
1321
+ # off events and instances of recurring events, but not the underlying recurring
1322
+ # events themselves. Optional. The default is False.
1323
+ # @param [String] sync_token
1324
+ # Token obtained from the nextSyncToken field returned on the last page of
1325
+ # results from the previous list request. It makes the result of this list
1326
+ # request contain only entries that have changed since then. All events deleted
1327
+ # since the previous list request will always be in the result set and it is not
1328
+ # allowed to set showDeleted to False.
1329
+ # There are several query parameters that cannot be specified together with
1330
+ # nextSyncToken to ensure consistency of the client state.
1331
+ # These are:
1332
+ # - iCalUID
1333
+ # - orderBy
1334
+ # - privateExtendedProperty
1335
+ # - q
1336
+ # - sharedExtendedProperty
1337
+ # - timeMin
1338
+ # - timeMax
1339
+ # - updatedMin If the syncToken expires, the server will respond with a 410 GONE
1340
+ # response code and the client should clear its storage and perform a full
1341
+ # synchronization without any syncToken.
1342
+ # Learn more about incremental synchronization.
1343
+ # Optional. The default is to return all entries.
1344
+ # @param [DateTime] time_max
1345
+ # Upper bound (exclusive) for an event's start time to filter by. Optional. The
1346
+ # default is not to filter by start time. Must be an RFC3339 timestamp with
1347
+ # mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-
1348
+ # 03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set,
1349
+ # timeMax must be greater than timeMin.
1350
+ # @param [DateTime] time_min
1351
+ # Lower bound (exclusive) for an event's end time to filter by. Optional. The
1352
+ # default is not to filter by end time. Must be an RFC3339 timestamp with
1353
+ # mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-
1354
+ # 03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set,
1355
+ # timeMin must be smaller than timeMax.
1356
+ # @param [String] time_zone
1357
+ # Time zone used in the response. Optional. The default is the time zone of the
1358
+ # calendar.
1359
+ # @param [DateTime] updated_min
1360
+ # Lower bound for an event's last modification time (as a RFC3339 timestamp) to
1361
+ # filter by. When specified, entries deleted since this time will always be
1362
+ # included regardless of showDeleted. Optional. The default is not to filter by
1363
+ # last modification time.
1364
+ # @param [String] fields
1365
+ # Selector specifying which fields to include in a partial response.
1366
+ # @param [String] quota_user
1367
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1368
+ # characters.
1369
+ # @param [String] user_ip
1370
+ # Deprecated. Please use quotaUser instead.
1371
+ # @param [Google::Apis::RequestOptions] options
1372
+ # Request-specific options
1373
+ #
1374
+ # @yield [result, err] Result & error if block supplied
1375
+ # @yieldparam result [Google::Apis::CalendarV3::Events] parsed result object
1376
+ # @yieldparam err [StandardError] error object if request failed
1377
+ #
1378
+ # @return [Google::Apis::CalendarV3::Events]
1379
+ #
1380
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1381
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1382
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1383
+ def list_events(calendar_id, always_include_email: nil, i_cal_uid: nil, max_attendees: nil, max_results: nil, order_by: nil, page_token: nil, private_extended_property: nil, q: nil, shared_extended_property: nil, show_deleted: nil, show_hidden_invitations: nil, single_events: nil, sync_token: nil, time_max: nil, time_min: nil, time_zone: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1384
+ command = make_simple_command(:get, 'calendars/{calendarId}/events', options)
1385
+ command.response_representation = Google::Apis::CalendarV3::Events::Representation
1386
+ command.response_class = Google::Apis::CalendarV3::Events
1387
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1388
+ command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
1389
+ command.query['iCalUID'] = i_cal_uid unless i_cal_uid.nil?
1390
+ command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
1391
+ command.query['maxResults'] = max_results unless max_results.nil?
1392
+ command.query['orderBy'] = order_by unless order_by.nil?
1393
+ command.query['pageToken'] = page_token unless page_token.nil?
1394
+ command.query['privateExtendedProperty'] = private_extended_property unless private_extended_property.nil?
1395
+ command.query['q'] = q unless q.nil?
1396
+ command.query['sharedExtendedProperty'] = shared_extended_property unless shared_extended_property.nil?
1397
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
1398
+ command.query['showHiddenInvitations'] = show_hidden_invitations unless show_hidden_invitations.nil?
1399
+ command.query['singleEvents'] = single_events unless single_events.nil?
1400
+ command.query['syncToken'] = sync_token unless sync_token.nil?
1401
+ command.query['timeMax'] = time_max unless time_max.nil?
1402
+ command.query['timeMin'] = time_min unless time_min.nil?
1403
+ command.query['timeZone'] = time_zone unless time_zone.nil?
1404
+ command.query['updatedMin'] = updated_min unless updated_min.nil?
1405
+ command.query['fields'] = fields unless fields.nil?
1406
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1407
+ command.query['userIp'] = user_ip unless user_ip.nil?
1408
+ execute_or_queue_command(command, &block)
1409
+ end
1410
+
1411
+ # Moves an event to another calendar, i.e. changes an event's organizer.
1412
+ # @param [String] calendar_id
1413
+ # Calendar identifier of the source calendar where the event currently is on.
1414
+ # @param [String] event_id
1415
+ # Event identifier.
1416
+ # @param [String] destination
1417
+ # Calendar identifier of the target calendar where the event is to be moved to.
1418
+ # @param [Boolean] send_notifications
1419
+ # Deprecated. Please use sendUpdates instead.
1420
+ # Whether to send notifications about the change of the event's organizer. Note
1421
+ # that some emails might still be sent even if you set the value to false. The
1422
+ # default is false.
1423
+ # @param [String] send_updates
1424
+ # Guests who should receive notifications about the change of the event's
1425
+ # organizer.
1426
+ # @param [String] fields
1427
+ # Selector specifying which fields to include in a partial response.
1428
+ # @param [String] quota_user
1429
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1430
+ # characters.
1431
+ # @param [String] user_ip
1432
+ # Deprecated. Please use quotaUser instead.
1433
+ # @param [Google::Apis::RequestOptions] options
1434
+ # Request-specific options
1435
+ #
1436
+ # @yield [result, err] Result & error if block supplied
1437
+ # @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
1438
+ # @yieldparam err [StandardError] error object if request failed
1439
+ #
1440
+ # @return [Google::Apis::CalendarV3::Event]
1441
+ #
1442
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1443
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1444
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1445
+ def move_event(calendar_id, event_id, destination, send_notifications: nil, send_updates: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1446
+ command = make_simple_command(:post, 'calendars/{calendarId}/events/{eventId}/move', options)
1447
+ command.response_representation = Google::Apis::CalendarV3::Event::Representation
1448
+ command.response_class = Google::Apis::CalendarV3::Event
1449
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1450
+ command.params['eventId'] = event_id unless event_id.nil?
1451
+ command.query['destination'] = destination unless destination.nil?
1452
+ command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
1453
+ command.query['sendUpdates'] = send_updates unless send_updates.nil?
1454
+ command.query['fields'] = fields unless fields.nil?
1455
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1456
+ command.query['userIp'] = user_ip unless user_ip.nil?
1457
+ execute_or_queue_command(command, &block)
1458
+ end
1459
+
1460
+ # Updates an event. This method supports patch semantics.
1461
+ # @param [String] calendar_id
1462
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
1463
+ # method. If you want to access the primary calendar of the currently logged in
1464
+ # user, use the "primary" keyword.
1465
+ # @param [String] event_id
1466
+ # Event identifier.
1467
+ # @param [Google::Apis::CalendarV3::Event] event_object
1468
+ # @param [Boolean] always_include_email
1469
+ # Deprecated and ignored. A value will always be returned in the email field for
1470
+ # the organizer, creator and attendees, even if no real email address is
1471
+ # available (i.e. a generated, non-working value will be provided).
1472
+ # @param [Fixnum] conference_data_version
1473
+ # Version number of conference data supported by the API client. Version 0
1474
+ # assumes no conference data support and ignores conference data in the event's
1475
+ # body. Version 1 enables support for copying of ConferenceData as well as for
1476
+ # creating new conferences using the createRequest field of conferenceData. The
1477
+ # default is 0.
1478
+ # @param [Fixnum] max_attendees
1479
+ # The maximum number of attendees to include in the response. If there are more
1480
+ # than the specified number of attendees, only the participant is returned.
1481
+ # Optional.
1482
+ # @param [Boolean] send_notifications
1483
+ # Deprecated. Please use sendUpdates instead.
1484
+ # Whether to send notifications about the event update (for example, description
1485
+ # changes, etc.). Note that some emails might still be sent even if you set the
1486
+ # value to false. The default is false.
1487
+ # @param [String] send_updates
1488
+ # Guests who should receive notifications about the event update (for example,
1489
+ # title changes, etc.).
1490
+ # @param [Boolean] supports_attachments
1491
+ # Whether API client performing operation supports event attachments. Optional.
1492
+ # The default is False.
1493
+ # @param [String] fields
1494
+ # Selector specifying which fields to include in a partial response.
1495
+ # @param [String] quota_user
1496
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1497
+ # characters.
1498
+ # @param [String] user_ip
1499
+ # Deprecated. Please use quotaUser instead.
1500
+ # @param [Google::Apis::RequestOptions] options
1501
+ # Request-specific options
1502
+ #
1503
+ # @yield [result, err] Result & error if block supplied
1504
+ # @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
1505
+ # @yieldparam err [StandardError] error object if request failed
1506
+ #
1507
+ # @return [Google::Apis::CalendarV3::Event]
1508
+ #
1509
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1510
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1511
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1512
+ def patch_event(calendar_id, event_id, event_object = nil, always_include_email: nil, conference_data_version: nil, max_attendees: nil, send_notifications: nil, send_updates: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1513
+ command = make_simple_command(:patch, 'calendars/{calendarId}/events/{eventId}', options)
1514
+ command.request_representation = Google::Apis::CalendarV3::Event::Representation
1515
+ command.request_object = event_object
1516
+ command.response_representation = Google::Apis::CalendarV3::Event::Representation
1517
+ command.response_class = Google::Apis::CalendarV3::Event
1518
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1519
+ command.params['eventId'] = event_id unless event_id.nil?
1520
+ command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
1521
+ command.query['conferenceDataVersion'] = conference_data_version unless conference_data_version.nil?
1522
+ command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
1523
+ command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
1524
+ command.query['sendUpdates'] = send_updates unless send_updates.nil?
1525
+ command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
1526
+ command.query['fields'] = fields unless fields.nil?
1527
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1528
+ command.query['userIp'] = user_ip unless user_ip.nil?
1529
+ execute_or_queue_command(command, &block)
1530
+ end
1531
+
1532
+ # Creates an event based on a simple text string.
1533
+ # @param [String] calendar_id
1534
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
1535
+ # method. If you want to access the primary calendar of the currently logged in
1536
+ # user, use the "primary" keyword.
1537
+ # @param [String] text
1538
+ # The text describing the event to be created.
1539
+ # @param [Boolean] send_notifications
1540
+ # Deprecated. Please use sendUpdates instead.
1541
+ # Whether to send notifications about the creation of the event. Note that some
1542
+ # emails might still be sent even if you set the value to false. The default is
1543
+ # false.
1544
+ # @param [String] send_updates
1545
+ # Guests who should receive notifications about the creation of the new event.
1546
+ # @param [String] fields
1547
+ # Selector specifying which fields to include in a partial response.
1548
+ # @param [String] quota_user
1549
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1550
+ # characters.
1551
+ # @param [String] user_ip
1552
+ # Deprecated. Please use quotaUser instead.
1553
+ # @param [Google::Apis::RequestOptions] options
1554
+ # Request-specific options
1555
+ #
1556
+ # @yield [result, err] Result & error if block supplied
1557
+ # @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
1558
+ # @yieldparam err [StandardError] error object if request failed
1559
+ #
1560
+ # @return [Google::Apis::CalendarV3::Event]
1561
+ #
1562
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1563
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1564
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1565
+ def quick_add_event(calendar_id, text, send_notifications: nil, send_updates: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1566
+ command = make_simple_command(:post, 'calendars/{calendarId}/events/quickAdd', options)
1567
+ command.response_representation = Google::Apis::CalendarV3::Event::Representation
1568
+ command.response_class = Google::Apis::CalendarV3::Event
1569
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1570
+ command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
1571
+ command.query['sendUpdates'] = send_updates unless send_updates.nil?
1572
+ command.query['text'] = text unless text.nil?
1573
+ command.query['fields'] = fields unless fields.nil?
1574
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1575
+ command.query['userIp'] = user_ip unless user_ip.nil?
1576
+ execute_or_queue_command(command, &block)
1577
+ end
1578
+
1579
+ # Updates an event.
1580
+ # @param [String] calendar_id
1581
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
1582
+ # method. If you want to access the primary calendar of the currently logged in
1583
+ # user, use the "primary" keyword.
1584
+ # @param [String] event_id
1585
+ # Event identifier.
1586
+ # @param [Google::Apis::CalendarV3::Event] event_object
1587
+ # @param [Boolean] always_include_email
1588
+ # Deprecated and ignored. A value will always be returned in the email field for
1589
+ # the organizer, creator and attendees, even if no real email address is
1590
+ # available (i.e. a generated, non-working value will be provided).
1591
+ # @param [Fixnum] conference_data_version
1592
+ # Version number of conference data supported by the API client. Version 0
1593
+ # assumes no conference data support and ignores conference data in the event's
1594
+ # body. Version 1 enables support for copying of ConferenceData as well as for
1595
+ # creating new conferences using the createRequest field of conferenceData. The
1596
+ # default is 0.
1597
+ # @param [Fixnum] max_attendees
1598
+ # The maximum number of attendees to include in the response. If there are more
1599
+ # than the specified number of attendees, only the participant is returned.
1600
+ # Optional.
1601
+ # @param [Boolean] send_notifications
1602
+ # Deprecated. Please use sendUpdates instead.
1603
+ # Whether to send notifications about the event update (for example, description
1604
+ # changes, etc.). Note that some emails might still be sent even if you set the
1605
+ # value to false. The default is false.
1606
+ # @param [String] send_updates
1607
+ # Guests who should receive notifications about the event update (for example,
1608
+ # title changes, etc.).
1609
+ # @param [Boolean] supports_attachments
1610
+ # Whether API client performing operation supports event attachments. Optional.
1611
+ # The default is False.
1612
+ # @param [String] fields
1613
+ # Selector specifying which fields to include in a partial response.
1614
+ # @param [String] quota_user
1615
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1616
+ # characters.
1617
+ # @param [String] user_ip
1618
+ # Deprecated. Please use quotaUser instead.
1619
+ # @param [Google::Apis::RequestOptions] options
1620
+ # Request-specific options
1621
+ #
1622
+ # @yield [result, err] Result & error if block supplied
1623
+ # @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
1624
+ # @yieldparam err [StandardError] error object if request failed
1625
+ #
1626
+ # @return [Google::Apis::CalendarV3::Event]
1627
+ #
1628
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1629
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1630
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1631
+ def update_event(calendar_id, event_id, event_object = nil, always_include_email: nil, conference_data_version: nil, max_attendees: nil, send_notifications: nil, send_updates: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1632
+ command = make_simple_command(:put, 'calendars/{calendarId}/events/{eventId}', options)
1633
+ command.request_representation = Google::Apis::CalendarV3::Event::Representation
1634
+ command.request_object = event_object
1635
+ command.response_representation = Google::Apis::CalendarV3::Event::Representation
1636
+ command.response_class = Google::Apis::CalendarV3::Event
1637
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1638
+ command.params['eventId'] = event_id unless event_id.nil?
1639
+ command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
1640
+ command.query['conferenceDataVersion'] = conference_data_version unless conference_data_version.nil?
1641
+ command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
1642
+ command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
1643
+ command.query['sendUpdates'] = send_updates unless send_updates.nil?
1644
+ command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
1645
+ command.query['fields'] = fields unless fields.nil?
1646
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1647
+ command.query['userIp'] = user_ip unless user_ip.nil?
1648
+ execute_or_queue_command(command, &block)
1649
+ end
1650
+
1651
+ # Watch for changes to Events resources.
1652
+ # @param [String] calendar_id
1653
+ # Calendar identifier. To retrieve calendar IDs call the calendarList.list
1654
+ # method. If you want to access the primary calendar of the currently logged in
1655
+ # user, use the "primary" keyword.
1656
+ # @param [Google::Apis::CalendarV3::Channel] channel_object
1657
+ # @param [Boolean] always_include_email
1658
+ # Deprecated and ignored. A value will always be returned in the email field for
1659
+ # the organizer, creator and attendees, even if no real email address is
1660
+ # available (i.e. a generated, non-working value will be provided).
1661
+ # @param [String] i_cal_uid
1662
+ # Specifies event ID in the iCalendar format to be included in the response.
1663
+ # Optional.
1664
+ # @param [Fixnum] max_attendees
1665
+ # The maximum number of attendees to include in the response. If there are more
1666
+ # than the specified number of attendees, only the participant is returned.
1667
+ # Optional.
1668
+ # @param [Fixnum] max_results
1669
+ # Maximum number of events returned on one result page. The number of events in
1670
+ # the resulting page may be less than this value, or none at all, even if there
1671
+ # are more events matching the query. Incomplete pages can be detected by a non-
1672
+ # empty nextPageToken field in the response. By default the value is 250 events.
1673
+ # The page size can never be larger than 2500 events. Optional.
1674
+ # @param [String] order_by
1675
+ # The order of the events returned in the result. Optional. The default is an
1676
+ # unspecified, stable order.
1677
+ # @param [String] page_token
1678
+ # Token specifying which result page to return. Optional.
1679
+ # @param [Array<String>, String] private_extended_property
1680
+ # Extended properties constraint specified as propertyName=value. Matches only
1681
+ # private properties. This parameter might be repeated multiple times to return
1682
+ # events that match all given constraints.
1683
+ # @param [String] q
1684
+ # Free text search terms to find events that match these terms in any field,
1685
+ # except for extended properties. Optional.
1686
+ # @param [Array<String>, String] shared_extended_property
1687
+ # Extended properties constraint specified as propertyName=value. Matches only
1688
+ # shared properties. This parameter might be repeated multiple times to return
1689
+ # events that match all given constraints.
1690
+ # @param [Boolean] show_deleted
1691
+ # Whether to include deleted events (with status equals "cancelled") in the
1692
+ # result. Cancelled instances of recurring events (but not the underlying
1693
+ # recurring event) will still be included if showDeleted and singleEvents are
1694
+ # both False. If showDeleted and singleEvents are both True, only single
1695
+ # instances of deleted events (but not the underlying recurring events) are
1696
+ # returned. Optional. The default is False.
1697
+ # @param [Boolean] show_hidden_invitations
1698
+ # Whether to include hidden invitations in the result. Optional. The default is
1699
+ # False.
1700
+ # @param [Boolean] single_events
1701
+ # Whether to expand recurring events into instances and only return single one-
1702
+ # off events and instances of recurring events, but not the underlying recurring
1703
+ # events themselves. Optional. The default is False.
1704
+ # @param [String] sync_token
1705
+ # Token obtained from the nextSyncToken field returned on the last page of
1706
+ # results from the previous list request. It makes the result of this list
1707
+ # request contain only entries that have changed since then. All events deleted
1708
+ # since the previous list request will always be in the result set and it is not
1709
+ # allowed to set showDeleted to False.
1710
+ # There are several query parameters that cannot be specified together with
1711
+ # nextSyncToken to ensure consistency of the client state.
1712
+ # These are:
1713
+ # - iCalUID
1714
+ # - orderBy
1715
+ # - privateExtendedProperty
1716
+ # - q
1717
+ # - sharedExtendedProperty
1718
+ # - timeMin
1719
+ # - timeMax
1720
+ # - updatedMin If the syncToken expires, the server will respond with a 410 GONE
1721
+ # response code and the client should clear its storage and perform a full
1722
+ # synchronization without any syncToken.
1723
+ # Learn more about incremental synchronization.
1724
+ # Optional. The default is to return all entries.
1725
+ # @param [DateTime] time_max
1726
+ # Upper bound (exclusive) for an event's start time to filter by. Optional. The
1727
+ # default is not to filter by start time. Must be an RFC3339 timestamp with
1728
+ # mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-
1729
+ # 03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set,
1730
+ # timeMax must be greater than timeMin.
1731
+ # @param [DateTime] time_min
1732
+ # Lower bound (exclusive) for an event's end time to filter by. Optional. The
1733
+ # default is not to filter by end time. Must be an RFC3339 timestamp with
1734
+ # mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-
1735
+ # 03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set,
1736
+ # timeMin must be smaller than timeMax.
1737
+ # @param [String] time_zone
1738
+ # Time zone used in the response. Optional. The default is the time zone of the
1739
+ # calendar.
1740
+ # @param [DateTime] updated_min
1741
+ # Lower bound for an event's last modification time (as a RFC3339 timestamp) to
1742
+ # filter by. When specified, entries deleted since this time will always be
1743
+ # included regardless of showDeleted. Optional. The default is not to filter by
1744
+ # last modification time.
1745
+ # @param [String] fields
1746
+ # Selector specifying which fields to include in a partial response.
1747
+ # @param [String] quota_user
1748
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1749
+ # characters.
1750
+ # @param [String] user_ip
1751
+ # Deprecated. Please use quotaUser instead.
1752
+ # @param [Google::Apis::RequestOptions] options
1753
+ # Request-specific options
1754
+ #
1755
+ # @yield [result, err] Result & error if block supplied
1756
+ # @yieldparam result [Google::Apis::CalendarV3::Channel] parsed result object
1757
+ # @yieldparam err [StandardError] error object if request failed
1758
+ #
1759
+ # @return [Google::Apis::CalendarV3::Channel]
1760
+ #
1761
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1762
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1763
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1764
+ def watch_event(calendar_id, channel_object = nil, always_include_email: nil, i_cal_uid: nil, max_attendees: nil, max_results: nil, order_by: nil, page_token: nil, private_extended_property: nil, q: nil, shared_extended_property: nil, show_deleted: nil, show_hidden_invitations: nil, single_events: nil, sync_token: nil, time_max: nil, time_min: nil, time_zone: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1765
+ command = make_simple_command(:post, 'calendars/{calendarId}/events/watch', options)
1766
+ command.request_representation = Google::Apis::CalendarV3::Channel::Representation
1767
+ command.request_object = channel_object
1768
+ command.response_representation = Google::Apis::CalendarV3::Channel::Representation
1769
+ command.response_class = Google::Apis::CalendarV3::Channel
1770
+ command.params['calendarId'] = calendar_id unless calendar_id.nil?
1771
+ command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
1772
+ command.query['iCalUID'] = i_cal_uid unless i_cal_uid.nil?
1773
+ command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
1774
+ command.query['maxResults'] = max_results unless max_results.nil?
1775
+ command.query['orderBy'] = order_by unless order_by.nil?
1776
+ command.query['pageToken'] = page_token unless page_token.nil?
1777
+ command.query['privateExtendedProperty'] = private_extended_property unless private_extended_property.nil?
1778
+ command.query['q'] = q unless q.nil?
1779
+ command.query['sharedExtendedProperty'] = shared_extended_property unless shared_extended_property.nil?
1780
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
1781
+ command.query['showHiddenInvitations'] = show_hidden_invitations unless show_hidden_invitations.nil?
1782
+ command.query['singleEvents'] = single_events unless single_events.nil?
1783
+ command.query['syncToken'] = sync_token unless sync_token.nil?
1784
+ command.query['timeMax'] = time_max unless time_max.nil?
1785
+ command.query['timeMin'] = time_min unless time_min.nil?
1786
+ command.query['timeZone'] = time_zone unless time_zone.nil?
1787
+ command.query['updatedMin'] = updated_min unless updated_min.nil?
1788
+ command.query['fields'] = fields unless fields.nil?
1789
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1790
+ command.query['userIp'] = user_ip unless user_ip.nil?
1791
+ execute_or_queue_command(command, &block)
1792
+ end
1793
+
1794
+ # Returns free/busy information for a set of calendars.
1795
+ # @param [Google::Apis::CalendarV3::FreeBusyRequest] free_busy_request_object
1796
+ # @param [String] fields
1797
+ # Selector specifying which fields to include in a partial response.
1798
+ # @param [String] quota_user
1799
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1800
+ # characters.
1801
+ # @param [String] user_ip
1802
+ # Deprecated. Please use quotaUser instead.
1803
+ # @param [Google::Apis::RequestOptions] options
1804
+ # Request-specific options
1805
+ #
1806
+ # @yield [result, err] Result & error if block supplied
1807
+ # @yieldparam result [Google::Apis::CalendarV3::FreeBusyResponse] parsed result object
1808
+ # @yieldparam err [StandardError] error object if request failed
1809
+ #
1810
+ # @return [Google::Apis::CalendarV3::FreeBusyResponse]
1811
+ #
1812
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1813
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1814
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1815
+ def query_freebusy(free_busy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1816
+ command = make_simple_command(:post, 'freeBusy', options)
1817
+ command.request_representation = Google::Apis::CalendarV3::FreeBusyRequest::Representation
1818
+ command.request_object = free_busy_request_object
1819
+ command.response_representation = Google::Apis::CalendarV3::FreeBusyResponse::Representation
1820
+ command.response_class = Google::Apis::CalendarV3::FreeBusyResponse
1821
+ command.query['fields'] = fields unless fields.nil?
1822
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1823
+ command.query['userIp'] = user_ip unless user_ip.nil?
1824
+ execute_or_queue_command(command, &block)
1825
+ end
1826
+
1827
+ # Returns a single user setting.
1828
+ # @param [String] setting
1829
+ # The id of the user setting.
1830
+ # @param [String] fields
1831
+ # Selector specifying which fields to include in a partial response.
1832
+ # @param [String] quota_user
1833
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1834
+ # characters.
1835
+ # @param [String] user_ip
1836
+ # Deprecated. Please use quotaUser instead.
1837
+ # @param [Google::Apis::RequestOptions] options
1838
+ # Request-specific options
1839
+ #
1840
+ # @yield [result, err] Result & error if block supplied
1841
+ # @yieldparam result [Google::Apis::CalendarV3::Setting] parsed result object
1842
+ # @yieldparam err [StandardError] error object if request failed
1843
+ #
1844
+ # @return [Google::Apis::CalendarV3::Setting]
1845
+ #
1846
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1847
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1848
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1849
+ def get_setting(setting, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1850
+ command = make_simple_command(:get, 'users/me/settings/{setting}', options)
1851
+ command.response_representation = Google::Apis::CalendarV3::Setting::Representation
1852
+ command.response_class = Google::Apis::CalendarV3::Setting
1853
+ command.params['setting'] = setting unless setting.nil?
1854
+ command.query['fields'] = fields unless fields.nil?
1855
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1856
+ command.query['userIp'] = user_ip unless user_ip.nil?
1857
+ execute_or_queue_command(command, &block)
1858
+ end
1859
+
1860
+ # Returns all user settings for the authenticated user.
1861
+ # @param [Fixnum] max_results
1862
+ # Maximum number of entries returned on one result page. By default the value is
1863
+ # 100 entries. The page size can never be larger than 250 entries. Optional.
1864
+ # @param [String] page_token
1865
+ # Token specifying which result page to return. Optional.
1866
+ # @param [String] sync_token
1867
+ # Token obtained from the nextSyncToken field returned on the last page of
1868
+ # results from the previous list request. It makes the result of this list
1869
+ # request contain only entries that have changed since then.
1870
+ # If the syncToken expires, the server will respond with a 410 GONE response
1871
+ # code and the client should clear its storage and perform a full
1872
+ # synchronization without any syncToken.
1873
+ # Learn more about incremental synchronization.
1874
+ # Optional. The default is to return all entries.
1875
+ # @param [String] fields
1876
+ # Selector specifying which fields to include in a partial response.
1877
+ # @param [String] quota_user
1878
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1879
+ # characters.
1880
+ # @param [String] user_ip
1881
+ # Deprecated. Please use quotaUser instead.
1882
+ # @param [Google::Apis::RequestOptions] options
1883
+ # Request-specific options
1884
+ #
1885
+ # @yield [result, err] Result & error if block supplied
1886
+ # @yieldparam result [Google::Apis::CalendarV3::Settings] parsed result object
1887
+ # @yieldparam err [StandardError] error object if request failed
1888
+ #
1889
+ # @return [Google::Apis::CalendarV3::Settings]
1890
+ #
1891
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1892
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1893
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1894
+ def list_settings(max_results: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1895
+ command = make_simple_command(:get, 'users/me/settings', options)
1896
+ command.response_representation = Google::Apis::CalendarV3::Settings::Representation
1897
+ command.response_class = Google::Apis::CalendarV3::Settings
1898
+ command.query['maxResults'] = max_results unless max_results.nil?
1899
+ command.query['pageToken'] = page_token unless page_token.nil?
1900
+ command.query['syncToken'] = sync_token unless sync_token.nil?
1901
+ command.query['fields'] = fields unless fields.nil?
1902
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1903
+ command.query['userIp'] = user_ip unless user_ip.nil?
1904
+ execute_or_queue_command(command, &block)
1905
+ end
1906
+
1907
+ # Watch for changes to Settings resources.
1908
+ # @param [Google::Apis::CalendarV3::Channel] channel_object
1909
+ # @param [Fixnum] max_results
1910
+ # Maximum number of entries returned on one result page. By default the value is
1911
+ # 100 entries. The page size can never be larger than 250 entries. Optional.
1912
+ # @param [String] page_token
1913
+ # Token specifying which result page to return. Optional.
1914
+ # @param [String] sync_token
1915
+ # Token obtained from the nextSyncToken field returned on the last page of
1916
+ # results from the previous list request. It makes the result of this list
1917
+ # request contain only entries that have changed since then.
1918
+ # If the syncToken expires, the server will respond with a 410 GONE response
1919
+ # code and the client should clear its storage and perform a full
1920
+ # synchronization without any syncToken.
1921
+ # Learn more about incremental synchronization.
1922
+ # Optional. The default is to return all entries.
1923
+ # @param [String] fields
1924
+ # Selector specifying which fields to include in a partial response.
1925
+ # @param [String] quota_user
1926
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1927
+ # characters.
1928
+ # @param [String] user_ip
1929
+ # Deprecated. Please use quotaUser instead.
1930
+ # @param [Google::Apis::RequestOptions] options
1931
+ # Request-specific options
1932
+ #
1933
+ # @yield [result, err] Result & error if block supplied
1934
+ # @yieldparam result [Google::Apis::CalendarV3::Channel] parsed result object
1935
+ # @yieldparam err [StandardError] error object if request failed
1936
+ #
1937
+ # @return [Google::Apis::CalendarV3::Channel]
1938
+ #
1939
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1940
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1941
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1942
+ def watch_setting(channel_object = nil, max_results: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1943
+ command = make_simple_command(:post, 'users/me/settings/watch', options)
1944
+ command.request_representation = Google::Apis::CalendarV3::Channel::Representation
1945
+ command.request_object = channel_object
1946
+ command.response_representation = Google::Apis::CalendarV3::Channel::Representation
1947
+ command.response_class = Google::Apis::CalendarV3::Channel
1948
+ command.query['maxResults'] = max_results unless max_results.nil?
1949
+ command.query['pageToken'] = page_token unless page_token.nil?
1950
+ command.query['syncToken'] = sync_token unless sync_token.nil?
1951
+ command.query['fields'] = fields unless fields.nil?
1952
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1953
+ command.query['userIp'] = user_ip unless user_ip.nil?
1954
+ execute_or_queue_command(command, &block)
1955
+ end
1956
+
1957
+ protected
1958
+
1959
+ def apply_command_defaults(command)
1960
+ command.query['key'] = key unless key.nil?
1961
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1962
+ command.query['userIp'] = user_ip unless user_ip.nil?
1963
+ end
1964
+ end
1965
+ end
1966
+ end
1967
+ end