Class: Spatio::SpatioEvent

Inherits:
ApiModelBase show all
Defined in:
lib/spatio-sdk/models/spatio_event.rb

Overview

A calendar event. Calendar uses snake_case JSON keys (different from Notes/Sheets/Slides/Tasks/Mail which use camelCase) — the surface predates the cross-platform convention.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SpatioEvent

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 203

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Spatio::SpatioEvent` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Spatio::SpatioEvent`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  else
    self.title = nil
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'start_time')
    self.start_time = attributes[:'start_time']
  else
    self.start_time = nil
  end

  if attributes.key?(:'end_time')
    self.end_time = attributes[:'end_time']
  else
    self.end_time = nil
  end

  if attributes.key?(:'all_day')
    self.all_day = attributes[:'all_day']
  else
    self.all_day = nil
  end

  if attributes.key?(:'location')
    self.location = attributes[:'location']
  end

  if attributes.key?(:'location_details')
    if (value = attributes[:'location_details']).is_a?(Hash)
      self.location_details = value
    end
  end

  if attributes.key?(:'organizer')
    self.organizer = attributes[:'organizer']
  end

  if attributes.key?(:'attendees')
    if (value = attributes[:'attendees']).is_a?(Array)
      self.attendees = value
    end
  end

  if attributes.key?(:'recurrence_rule')
    self.recurrence_rule = attributes[:'recurrence_rule']
  end

  if attributes.key?(:'recurrence_id')
    self.recurrence_id = attributes[:'recurrence_id']
  end

  if attributes.key?(:'original_start')
    self.original_start = attributes[:'original_start']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

  if attributes.key?(:'visibility')
    self.visibility = attributes[:'visibility']
  else
    self.visibility = nil
  end

  if attributes.key?(:'busy')
    self.busy = attributes[:'busy']
  else
    self.busy = nil
  end

  if attributes.key?(:'reminders')
    if (value = attributes[:'reminders']).is_a?(Array)
      self.reminders = value
    end
  end

  if attributes.key?(:'travel_time_minutes')
    self.travel_time_minutes = attributes[:'travel_time_minutes']
  end

  if attributes.key?(:'categories')
    if (value = attributes[:'categories']).is_a?(Array)
      self.categories = value
    end
  end

  if attributes.key?(:'color')
    self.color = attributes[:'color']
  end

  if attributes.key?(:'user_id')
    self.user_id = attributes[:'user_id']
  end

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  else
    self. = nil
  end

  if attributes.key?(:'provider')
    self.provider = attributes[:'provider']
  end

  if attributes.key?(:'provider_id')
    self.provider_id = attributes[:'provider_id']
  else
    self.provider_id = nil
  end

  if attributes.key?(:'provider_data')
    if (value = attributes[:'provider_data']).is_a?(Hash)
      self.provider_data = value
    end
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  else
    self.updated_at = nil
  end

  if attributes.key?(:'deleted_at')
    self.deleted_at = attributes[:'deleted_at']
  end

  if attributes.key?(:'synced_at')
    self.synced_at = attributes[:'synced_at']
  end

  if attributes.key?(:'conference_data')
    self.conference_data = attributes[:'conference_data']
  end

  if attributes.key?(:'attachments')
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  end

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.key?(:'etag')
    self.etag = attributes[:'etag']
  end

  if attributes.key?(:'sequence')
    self.sequence = attributes[:'sequence']
  end

  if attributes.key?(:'custom_data')
    if (value = attributes[:'custom_data']).is_a?(Hash)
      self.custom_data = value
    end
  end
end

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



70
71
72
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 70

def 
  @account_id
end

#all_day ⇒ Object

Returns the value of attribute all_day.



29
30
31
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 29

def all_day
  @all_day
end

#attachments ⇒ Object

Returns the value of attribute attachments.



91
92
93
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 91

def attachments
  @attachments
end

#attendees ⇒ Object

Returns the value of attribute attendees.



39
40
41
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 39

def attendees
  @attendees
end

#busy ⇒ Object

Whether this event marks the time as busy or free.



57
58
59
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 57

def busy
  @busy
end

#categories ⇒ Object

Returns the value of attribute categories.



64
65
66
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 64

def categories
  @categories
end

#color ⇒ Object

Returns the value of attribute color.



66
67
68
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 66

def color
  @color
end

#conference_data ⇒ Object

Returns the value of attribute conference_data.



89
90
91
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 89

def conference_data
  @conference_data
end

#created_at ⇒ Object

Returns the value of attribute created_at.



81
82
83
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 81

def created_at
  @created_at
end

#custom_data ⇒ Object

Returns the value of attribute custom_data.



99
100
101
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 99

def custom_data
  @custom_data
end

#deleted_at ⇒ Object

Returns the value of attribute deleted_at.



85
86
87
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 85

def deleted_at
  @deleted_at
end

#description ⇒ Object

Returns the value of attribute description.



23
24
25
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 23

def description
  @description
end

#end_time ⇒ Object

Returns the value of attribute end_time.



27
28
29
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 27

def end_time
  @end_time
end

#etag ⇒ Object

Returns the value of attribute etag.



95
96
97
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 95

def etag
  @etag
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 19

def id
  @id
end

#location ⇒ Object

Returns the value of attribute location.



31
32
33
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 31

def location
  @location
end

#location_details ⇒ Object

Free-form key/value (lat, lng, room, etc.).



34
35
36
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 34

def location_details
  @location_details
end

#organizer ⇒ Object

Organizer email.



37
38
39
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 37

def organizer
  @organizer
end

#original_start ⇒ Object

Original start of a moved recurring instance.



48
49
50
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 48

def original_start
  @original_start
end

#provider ⇒ Object

Standardized provider id (e.g. ‘google-calendar`, `native-calendar`). Mirrors `provider_id` — both are populated on writes; clients should prefer `provider`.



73
74
75
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 73

def provider
  @provider
end

#provider_data ⇒ Object

Provider-specific extras.



79
80
81
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 79

def provider_data
  @provider_data
end

#provider_id ⇒ Object

Legacy alias of ‘provider`.



76
77
78
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 76

def provider_id
  @provider_id
end

#recurrence_id ⇒ Object

Set on instances of a recurring series.



45
46
47
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 45

def recurrence_id
  @recurrence_id
end

#recurrence_rule ⇒ Object

RFC 5545 RRULE.



42
43
44
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 42

def recurrence_rule
  @recurrence_rule
end

#reminders ⇒ Object

Returns the value of attribute reminders.



59
60
61
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 59

def reminders
  @reminders
end

#sequence ⇒ Object

Returns the value of attribute sequence.



97
98
99
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 97

def sequence
  @sequence
end

#start_time ⇒ Object

Returns the value of attribute start_time.



25
26
27
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 25

def start_time
  @start_time
end

#status ⇒ Object

Provider-mapped event status. Free-form string — common values are ‘confirmed`, `tentative`, `cancelled`, `needs_action`, and the empty string when the provider doesn’t populate it. Not enumerated strictly because providers add custom values and the platform passes them through verbatim.



51
52
53
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 51

def status
  @status
end

#synced_at ⇒ Object

Returns the value of attribute synced_at.



87
88
89
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 87

def synced_at
  @synced_at
end

#title ⇒ Object

Returns the value of attribute title.



21
22
23
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 21

def title
  @title
end

#travel_time_minutes ⇒ Object

Apple Calendar’s local-only travel buffer. Stored on the cached row but not synced to providers that don’t model it.



62
63
64
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 62

def travel_time_minutes
  @travel_time_minutes
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



83
84
85
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 83

def updated_at
  @updated_at
end

#url ⇒ Object

Returns the value of attribute url.



93
94
95
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 93

def url
  @url
end

#user_id ⇒ Object

Returns the value of attribute user_id.



68
69
70
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 68

def user_id
  @user_id
end

#visibility ⇒ Object

Free-form visibility string. Common values: ‘public`, `private`, `confidential`, plus empty when unset.



54
55
56
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 54

def visibility
  @visibility
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



143
144
145
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 143

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



148
149
150
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 148

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 102

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'description' => :'description',
    :'start_time' => :'start_time',
    :'end_time' => :'end_time',
    :'all_day' => :'all_day',
    :'location' => :'location',
    :'location_details' => :'location_details',
    :'organizer' => :'organizer',
    :'attendees' => :'attendees',
    :'recurrence_rule' => :'recurrence_rule',
    :'recurrence_id' => :'recurrence_id',
    :'original_start' => :'original_start',
    :'status' => :'status',
    :'visibility' => :'visibility',
    :'busy' => :'busy',
    :'reminders' => :'reminders',
    :'travel_time_minutes' => :'travel_time_minutes',
    :'categories' => :'categories',
    :'color' => :'color',
    :'user_id' => :'user_id',
    :'account_id' => :'account_id',
    :'provider' => :'provider',
    :'provider_id' => :'provider_id',
    :'provider_data' => :'provider_data',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'deleted_at' => :'deleted_at',
    :'synced_at' => :'synced_at',
    :'conference_data' => :'conference_data',
    :'attachments' => :'attachments',
    :'url' => :'url',
    :'etag' => :'etag',
    :'sequence' => :'sequence',
    :'custom_data' => :'custom_data'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 648

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



194
195
196
197
198
199
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 194

def self.openapi_nullable
  Set.new([
    :'travel_time_minutes',
    :'deleted_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 153

def self.openapi_types
  {
    :'id' => :'String',
    :'title' => :'String',
    :'description' => :'String',
    :'start_time' => :'Time',
    :'end_time' => :'Time',
    :'all_day' => :'Boolean',
    :'location' => :'String',
    :'location_details' => :'Hash<String, String>',
    :'organizer' => :'String',
    :'attendees' => :'Array<Attendee>',
    :'recurrence_rule' => :'String',
    :'recurrence_id' => :'String',
    :'original_start' => :'Time',
    :'status' => :'String',
    :'visibility' => :'String',
    :'busy' => :'Boolean',
    :'reminders' => :'Array<Reminder>',
    :'travel_time_minutes' => :'Integer',
    :'categories' => :'Array<String>',
    :'color' => :'String',
    :'user_id' => :'String',
    :'account_id' => :'String',
    :'provider' => :'String',
    :'provider_id' => :'String',
    :'provider_data' => :'Hash<String, Object>',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'deleted_at' => :'Time',
    :'synced_at' => :'Time',
    :'conference_data' => :'ConferenceData',
    :'attachments' => :'Array<Attachment>',
    :'url' => :'String',
    :'etag' => :'String',
    :'sequence' => :'Integer',
    :'custom_data' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 593

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      description == o.description &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      all_day == o.all_day &&
      location == o.location &&
      location_details == o.location_details &&
      organizer == o.organizer &&
      attendees == o.attendees &&
      recurrence_rule == o.recurrence_rule &&
      recurrence_id == o.recurrence_id &&
      original_start == o.original_start &&
      status == o.status &&
      visibility == o.visibility &&
      busy == o.busy &&
      reminders == o.reminders &&
      travel_time_minutes == o.travel_time_minutes &&
      categories == o.categories &&
      color == o.color &&
      user_id == o.user_id &&
       == o. &&
      provider == o.provider &&
      provider_id == o.provider_id &&
      provider_data == o.provider_data &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      deleted_at == o.deleted_at &&
      synced_at == o.synced_at &&
      conference_data == o.conference_data &&
      attachments == o.attachments &&
      url == o.url &&
      etag == o.etag &&
      sequence == o.sequence &&
      custom_data == o.custom_data
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


635
636
637
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 635

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



641
642
643
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 641

def hash
  [id, title, description, start_time, end_time, all_day, location, location_details, organizer, attendees, recurrence_rule, recurrence_id, original_start, status, visibility, busy, reminders, travel_time_minutes, categories, color, user_id, , provider, provider_id, provider_data, created_at, updated_at, deleted_at, synced_at, conference_data, attachments, url, etag, sequence, custom_data].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 398

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @title.nil?
    invalid_properties.push('invalid value for "title", title cannot be nil.')
  end

  if @start_time.nil?
    invalid_properties.push('invalid value for "start_time", start_time cannot be nil.')
  end

  if @end_time.nil?
    invalid_properties.push('invalid value for "end_time", end_time cannot be nil.')
  end

  if @all_day.nil?
    invalid_properties.push('invalid value for "all_day", all_day cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @visibility.nil?
    invalid_properties.push('invalid value for "visibility", visibility cannot be nil.')
  end

  if @busy.nil?
    invalid_properties.push('invalid value for "busy", busy cannot be nil.')
  end

  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if @provider_id.nil?
    invalid_properties.push('invalid value for "provider_id", provider_id cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 670

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/spatio-sdk/models/spatio_event.rb', line 454

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @title.nil?
  return false if @start_time.nil?
  return false if @end_time.nil?
  return false if @all_day.nil?
  return false if @status.nil?
  return false if @visibility.nil?
  return false if @busy.nil?
  return false if @account_id.nil?
  return false if @provider_id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end