Class: ZoomUs::Models::InlineResponse20022

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/models/inline_response_200_22.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineResponse20022

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
192
193
194
195
196
197
198
199
200
201
202
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
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 157

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'agenda')
    self.agenda = attributes[:'agenda']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'duration')
    self.duration = attributes[:'duration']
  end

  if attributes.has_key?(:'encrypted_password')
    self.encrypted_password = attributes[:'encrypted_password']
  end

  if attributes.has_key?(:'h323_password')
    self.h323_password = attributes[:'h323_password']
  end

  if attributes.has_key?(:'host_id')
    self.host_id = attributes[:'host_id']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'join_url')
    self.join_url = attributes[:'join_url']
  end

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

  if attributes.has_key?(:'password')
    self.password = attributes[:'password']
  end

  if attributes.has_key?(:'pmi')
    self.pmi = attributes[:'pmi']
  end

  if attributes.has_key?(:'recurrence')
    self.recurrence = attributes[:'recurrence']
  end

  if attributes.has_key?(:'settings')
    self.settings = attributes[:'settings']
  end

  if attributes.has_key?(:'start_time')
    self.start_time = attributes[:'start_time']
  end

  if attributes.has_key?(:'start_url')
    self.start_url = attributes[:'start_url']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'timezone')
    self.timezone = attributes[:'timezone']
  end

  if attributes.has_key?(:'topic')
    self.topic = attributes[:'topic']
  end

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

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'uuid')
    self.uuid = attributes[:'uuid']
  end
end

Instance Attribute Details

#agendaObject

Agenda.



19
20
21
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 19

def agenda
  @agenda
end

#created_atObject

Time of creation.



22
23
24
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 22

def created_at
  @created_at
end

#durationObject

Meeting duration.



25
26
27
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 25

def duration
  @duration
end

#encrypted_passwordObject

Encrypted password for third party endpoints (H323/SIP).



28
29
30
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 28

def encrypted_password
  @encrypted_password
end

#h323_passwordObject

H.323/SIP room system password.



31
32
33
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 31

def h323_password
  @h323_password
end

#host_idObject

ID of the user who is set as host of meeting.



34
35
36
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 34

def host_id
  @host_id
end

#idObject

Meeting ID: also known as the meeting number.



37
38
39
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 37

def id
  @id
end

#join_urlObject

Join URL.



40
41
42
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 40

def join_url
  @join_url
end

#occurrencesObject

Array of occurrence objects.



43
44
45
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 43

def occurrences
  @occurrences
end

#passwordObject

Meeting password.



46
47
48
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 46

def password
  @password
end

#pmiObject

Personal Meeting Id. Only used for scheduled meetings and recurring meetings with no fixed time.



49
50
51
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 49

def pmi
  @pmi
end

#recurrenceObject

Returns the value of attribute recurrence.



51
52
53
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 51

def recurrence
  @recurrence
end

#settingsObject

Returns the value of attribute settings.



53
54
55
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 53

def settings
  @settings
end

#start_timeObject

Meeting start time.



56
57
58
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 56

def start_time
  @start_time
end

#start_urlObject


<aside>The start_url of a Meeting is a URL using which a host or an alternative host can start the Meeting. The expiration time for the start_url field listed in the response of [Create a Meeting API](marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate) is two hours for all regular users. For users created using the custCreate option via the [Create Users](marketplace.zoom.us/docs/api-reference/zoom-api/users/usercreate) API, the expiration time of the start_url field is 90 days. For security reasons, to retrieve the updated value for the start_url field programmatically (after the expiry time), you must call the [Retrieve a Meeting API](marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting) and refer to the value of the start_url field in the response.</aside>



59
60
61
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 59

def start_url
  @start_url
end

#statusObject

Meeting status



62
63
64
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 62

def status
  @status
end

#timezoneObject

Timezone to format the meeting start time.



65
66
67
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 65

def timezone
  @timezone
end

#topicObject

Meeting topic.



68
69
70
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 68

def topic
  @topic
end

#tracking_fieldsObject

Tracking fields



71
72
73
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 71

def tracking_fields
  @tracking_fields
end

#typeObject

Meeting Types:
‘1` - Instant meeting.
`2` - Scheduled meeting.
`3` - Recurring meeting with no fixed time.
`8` - Recurring meeting with a fixed time.



74
75
76
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 74

def type
  @type
end

#uuidObject

Unique meeting ID. Each meeting instance will generate its own Meeting UUID. Please double encode your UUID when using it for API calls if the UUID begins with a ‘/’or contains ‘//’ in it.



77
78
79
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 77

def uuid
  @uuid
end

Class Method Details

.attribute_mapObject

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
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 102

def self.attribute_map
  {
    :'agenda' => :'agenda',
    :'created_at' => :'created_at',
    :'duration' => :'duration',
    :'encrypted_password' => :'encrypted_password',
    :'h323_password' => :'h323_password',
    :'host_id' => :'host_id',
    :'id' => :'id',
    :'join_url' => :'join_url',
    :'occurrences' => :'occurrences',
    :'password' => :'password',
    :'pmi' => :'pmi',
    :'recurrence' => :'recurrence',
    :'settings' => :'settings',
    :'start_time' => :'start_time',
    :'start_url' => :'start_url',
    :'status' => :'status',
    :'timezone' => :'timezone',
    :'topic' => :'topic',
    :'tracking_fields' => :'tracking_fields',
    :'type' => :'type',
    :'uuid' => :'uuid'
  }
end

.swagger_typesObject

Attribute type mapping.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 129

def self.swagger_types
  {
    :'agenda' => :'String',
    :'created_at' => :'DateTime',
    :'duration' => :'Integer',
    :'encrypted_password' => :'String',
    :'h323_password' => :'String',
    :'host_id' => :'String',
    :'id' => :'Integer',
    :'join_url' => :'String',
    :'occurrences' => :'Array<InlineResponse20110Occurrences>',
    :'password' => :'String',
    :'pmi' => :'Integer',
    :'recurrence' => :'UsersuserIdmeetingsRecurrence',
    :'settings' => :'InlineResponse20110Settings',
    :'start_time' => :'DateTime',
    :'start_url' => :'String',
    :'status' => :'String',
    :'timezone' => :'String',
    :'topic' => :'String',
    :'tracking_fields' => :'Array<UsersuserIdmeetingsTrackingFields>',
    :'type' => :'Integer',
    :'uuid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    agenda == o.agenda &&
    created_at == o.created_at &&
    duration == o.duration &&
    encrypted_password == o.encrypted_password &&
    h323_password == o.h323_password &&
    host_id == o.host_id &&
    id == o.id &&
    join_url == o.join_url &&
    occurrences == o.occurrences &&
    password == o.password &&
    pmi == o.pmi &&
    recurrence == o.recurrence &&
    settings == o.settings &&
    start_time == o.start_time &&
    start_url == o.start_url &&
    status == o.status &&
    timezone == o.timezone &&
    topic == o.topic &&
    tracking_fields == o.tracking_fields &&
    type == o.type &&
    uuid == o.uuid
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



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
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 341

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    ::DateTime.parse(value)
  when :Date
    ::Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Models.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



407
408
409
410
411
412
413
414
415
416
417
418
419
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 407

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 320

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


307
308
309
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 307

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



313
314
315
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 313

def hash
  [agenda, created_at, duration, encrypted_password, h323_password, host_id, id, join_url, occurrences, password, pmi, recurrence, settings, start_time, start_url, status, timezone, topic, tracking_fields, type, uuid].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



254
255
256
257
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 254

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



387
388
389
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 387

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



393
394
395
396
397
398
399
400
401
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 393

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



381
382
383
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 381

def to_s
  to_hash.to_s
end

#valid?Boolean

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

Returns:

  • (Boolean)

    true if the model is valid



261
262
263
264
265
# File 'lib/zoom_us/models/inline_response_200_22.rb', line 261

def valid?
  status_validator = EnumAttributeValidator.new('String', ['waiting', 'started', 'finished'])
  return false unless status_validator.valid?(@status)
  true
end