Class: Freeclimb::ConferenceParticipantResult

Inherits:
Object
  • Object
show all
Defined in:
lib/freeclimb/models/conference_participant_result.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConferenceParticipantResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 110

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

ID of the account that created this participant.



29
30
31
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 29

def 
  @account_id
end

#call_id ⇒ Object

ID of the Call associated with this Participant.



35
36
37
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 35

def call_id
  @call_id
end

#conference_id ⇒ Object

ID of the conference this participant is in.



32
33
34
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 32

def conference_id
  @conference_id
end

#date_created ⇒ Object

The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).



20
21
22
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 20

def date_created
  @date_created
end

#date_updated ⇒ Object

The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).



23
24
25
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 23

def date_updated
  @date_updated
end

#dtmf_pass_through ⇒ Object

True if this Participant had dtmfPassThrough privileges in the Conference. False otherwise.



44
45
46
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 44

def dtmf_pass_through
  @dtmf_pass_through
end

#listen ⇒ Object

True if this Participant has listen privileges in the Conference. False otherwise.



41
42
43
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 41

def listen
  @listen
end

#revision ⇒ Object

Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated.



26
27
28
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 26

def revision
  @revision
end

#start_conf_on_enter ⇒ Object

True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise.



47
48
49
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 47

def start_conf_on_enter
  @start_conf_on_enter
end

#talk ⇒ Object

True if this Participant has talk privileges in the Conference. False otherwise.



38
39
40
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 38

def talk
  @talk
end

#uri ⇒ Object

The URI for this resource, relative to /apiserver.



17
18
19
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 17

def uri
  @uri
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 50

def self.attribute_map
  {
    uri: :uri,
    date_created: :dateCreated,
    date_updated: :dateUpdated,
    revision: :revision,
    account_id: :accountId,
    conference_id: :conferenceId,
    call_id: :callId,
    talk: :talk,
    listen: :listen,
    dtmf_pass_through: :dtmfPassThrough,
    start_conf_on_enter: :startConfOnEnter
  }
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



217
218
219
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 217

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



102
103
104
105
106
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 102

def self.openapi_all_of
  [
    :MutableResourceModel
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 89

def self.openapi_nullable
  Set.new([
    :account_id,
    :conference_id,
    :call_id,
    :talk,
    :listen,
    :dtmf_pass_through,
    :start_conf_on_enter
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 72

def self.openapi_types
  {
    uri: :String,
    date_created: :String,
    date_updated: :String,
    revision: :Integer,
    account_id: :String,
    conference_id: :String,
    call_id: :String,
    talk: :Boolean,
    listen: :Boolean,
    dtmf_pass_through: :Boolean,
    start_conf_on_enter: :Boolean
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 186

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    uri == other.uri &&
    date_created == other.date_created &&
    date_updated == other.date_updated &&
    revision == other.revision &&
     == other. &&
    conference_id == other.conference_id &&
    call_id == other.call_id &&
    talk == other.talk &&
    listen == other.listen &&
    dtmf_pass_through == other.dtmf_pass_through &&
    start_conf_on_enter == other.start_conf_on_enter
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



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
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 247

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Freeclimb.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 318

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 224

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send(:"#{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[self.class.attribute_map[key]].is_a?(Array)
        send(:"#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send(:"#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


204
205
206
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 204

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 210

def hash
  [uri, date_created, date_updated, revision, , conference_id, call_id, talk, listen, dtmf_pass_through, start_conf_on_enter].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



170
171
172
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 170

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



294
295
296
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 294

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 300

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



288
289
290
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 288

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



176
177
178
179
180
181
182
 
# File 'lib/freeclimb/models/conference_participant_result.rb', line 176

def valid?
  if @uri.nil?
    false
  else
    list_invalid_properties.length == 0
  end
end