Class: Freeclimb::AddToConference

Inherits:
PerclCommand show all
Defined in:
lib/freeclimb/models/add_to_conference.rb

Overview

The ‘AddToConference` command adds a Participant to a Conference. If this Participant currently is in another Conference, the Participant is first removed from that Conference. Two Call legs can be bridged together by creating a Conference and adding both Call legs to it via `AddToConference`.

Instance Attribute Summary collapse

Attributes inherited from PerclCommand

#command

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PerclCommand

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ AddToConference

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 96

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

  # call parent's initialize
  super(attributes)

  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.



19
20
21
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 19

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.



22
23
24
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 22

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.



25
26
27
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 25

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.



31
32
33
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 31

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.



28
29
30
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 28

def conference_id
  @conference_id
end

#leave_conference_url ⇒ Object

URL to be invoked when the Participant leaves the Conference.



34
35
36
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 34

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.



37
38
39
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 37

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.



40
41
42
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 40

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.



43
44
45
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 43

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.



46
47
48
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 46

def talk
  @talk
end

Class Method Details

.attribute_map ⇒ Object

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



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

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



208
209
210
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 208

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



87
88
89
90
91
92
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 87

def self.openapi_all_of
  [
  :'AddToConferenceAllOf',
  :'PerclCommand'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 178

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 && super(o)
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



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

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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 306

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 215

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  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


195
196
197
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



201
202
203
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 201

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



155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 155

def list_invalid_properties
  invalid_properties = super
  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



282
283
284
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 282

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 288

def to_hash
  hash = super
  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



276
277
278
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 276

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



170
171
172
173
174
 
# File 'lib/freeclimb/models/add_to_conference.rb', line 170

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