Class: Freeclimb::AddToConferenceAllOf

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddToConferenceAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 87

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::AddToConferenceAllOf` 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::AddToConferenceAllOf`. 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?(:'allow_call_control')
    self.allow_call_control = attributes[:'allow_call_control']
  end

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

  if attributes.key?(:'call_control_url')
    self.call_control_url = attributes[:'call_control_url']
  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?(:'leave_conference_url')
    self.leave_conference_url = attributes[:'leave_conference_url']
  end

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

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

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

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

Instance Attribute Details

#allow_call_control ⇒ Object

If ‘true`, Call control will be enabled for this Participant’s Call leg.



18
19
20
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 18

def allow_call_control
  @allow_call_control
end

#call_control_sequence ⇒ Object

Defines a sequence of digits that, when entered by this caller, invokes the ‘callControlUrl`. Only digits plus ’*‘, and ’#‘ may be used.



21
22
23
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 21

def call_control_sequence
  @call_control_sequence
end

#call_control_url ⇒ Object

URL to be invoked when this Participant enters the digit sequence defined in the ‘callControlSequence` attribute.



24
25
26
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 24

def call_control_url
  @call_control_url
end

#call_id ⇒ Object

ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one.



30
31
32
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 30

def call_id
  @call_id
end

#conference_id ⇒ Object

ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result.



27
28
29
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 27

def conference_id
  @conference_id
end

#leave_conference_url ⇒ Object

URL to be invoked when the Participant leaves the Conference.



33
34
35
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 33

def leave_conference_url
  @leave_conference_url
end

#listen ⇒ Object

If ‘true`, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or `SetListen` PerCL command.



36
37
38
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 36

def listen
  @listen
end

#notification_url ⇒ Object

When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters.



39
40
41
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 39

def notification_url
  @notification_url
end

#start_conf_on_enter ⇒ Object

Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to ‘true` for moderators and `false` for all other Participants.



42
43
44
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 42

def start_conf_on_enter
  @start_conf_on_enter
end

#talk ⇒ Object

If ‘true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command.



45
46
47
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 45

def talk
  @talk
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 48

def self.attribute_map
  {
    :'allow_call_control' => :'allowCallControl',
    :'call_control_sequence' => :'callControlSequence',
    :'call_control_url' => :'callControlUrl',
    :'conference_id' => :'conferenceId',
    :'call_id' => :'callId',
    :'leave_conference_url' => :'leaveConferenceUrl',
    :'listen' => :'listen',
    :'notification_url' => :'notificationUrl',
    :'start_conf_on_enter' => :'startConfOnEnter',
    :'talk' => :'talk'
  }
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



196
197
198
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 196

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 80

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 64

def self.openapi_types
  {
    :'allow_call_control' => :'Boolean',
    :'call_control_sequence' => :'String',
    :'call_control_url' => :'String',
    :'conference_id' => :'String',
    :'call_id' => :'Boolean',
    :'leave_conference_url' => :'String',
    :'listen' => :'Boolean',
    :'notification_url' => :'String',
    :'start_conf_on_enter' => :'Boolean',
    :'talk' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_call_control == o.allow_call_control &&
      call_control_sequence == o.call_control_sequence &&
      call_control_url == o.call_control_url &&
      conference_id == o.conference_id &&
      call_id == o.call_id &&
      leave_conference_url == o.leave_conference_url &&
      listen == o.listen &&
      notification_url == o.notification_url &&
      start_conf_on_enter == o.start_conf_on_enter &&
      talk == o.talk
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



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

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
    Freeclimb.const_get(type).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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 293

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 203

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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)
        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


183
184
185
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



189
190
191
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 189

def hash
  [allow_call_control, call_control_sequence, call_control_url, conference_id, call_id, leave_conference_url, listen, notification_url, start_conf_on_enter, talk].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



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 143

def list_invalid_properties
  invalid_properties = Array.new
  if @conference_id.nil?
    invalid_properties.push('invalid value for "conference_id", conference_id cannot be nil.')
  end

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

  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



269
270
271
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 269

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 275

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



263
264
265
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 263

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



158
159
160
161
162
 
# File 'lib/freeclimb/models/add_to_conference_all_of.rb', line 158

def valid?
  return false if @conference_id.nil?
  return false if @call_id.nil?
  true
end