Class: Freeclimb::CreateConference

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

Overview

The ‘CreateConference` command does exactly what its name implies — it creates an unpopulated Conference (one without any Participants). Once created, a Conference remains in FreeClimb until explicitly terminated by a customer. Once a Conference has been terminated, it can no longer be used.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PerclCommand

#command

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PerclCommand

openapi_discriminator_name, #to_percl_hash

Constructor Details

#initialize(attributes = {}) ⇒ CreateConference

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

  if attributes.key?(:parent_call_id)
    self.parent_call_id = attributes[:parent_call_id]
  end
  self.command = "CreateConference"
end

Instance Attribute Details

#_alias ⇒ Object

Descriptive name for the Conference.



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

def _alias
  @_alias
end

#action_url ⇒ Object

This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response.



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

def action_url
  @action_url
end

#parent_call_id ⇒ Object

ID of the Call that created this leg (child call).



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

def parent_call_id
  @parent_call_id
end

#play_beep ⇒ Object

Returns the value of attribute play_beep.



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

def play_beep
  @play_beep
end

#record ⇒ Object

When set to ‘true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state.



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

def record
  @record
end

#status_callback_url ⇒ Object

This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available.



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

def status_callback_url
  @status_callback_url
end

#wait_url ⇒ Object

If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb.



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

def wait_url
  @wait_url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



73
74
75
 
# File 'lib/freeclimb/models/create_conference.rb', line 73

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/freeclimb/models/create_conference.rb', line 60

def self.attribute_map
  {
    action_url: :actionUrl,
    _alias: :alias,
    play_beep: :playBeep,
    record: :record,
    status_callback_url: :statusCallbackUrl,
    wait_url: :waitUrl,
    parent_call_id: :parentCallId
  }
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



202
203
204
 
# File 'lib/freeclimb/models/create_conference.rb', line 202

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



98
99
100
101
102
 
# File 'lib/freeclimb/models/create_conference.rb', line 98

def self.openapi_all_of
  [
    :PerclCommand
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
95
 
# File 'lib/freeclimb/models/create_conference.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/freeclimb/models/create_conference.rb', line 78

def self.openapi_types
  {
    action_url: :String,
    _alias: :String,
    play_beep: :PlayBeep,
    record: :Boolean,
    status_callback_url: :String,
    wait_url: :String,
    parent_call_id: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/freeclimb/models/create_conference.rb', line 175

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    action_url == other.action_url &&
    _alias == other._alias &&
    play_beep == other.play_beep &&
    record == other.record &&
    status_callback_url == other.status_callback_url &&
    wait_url == other.wait_url &&
    parent_call_id == other.parent_call_id && super
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



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

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/freeclimb/models/create_conference.rb', line 304

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/freeclimb/models/create_conference.rb', line 209

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


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

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [action_url, _alias, play_beep, record, status_callback_url, wait_url, parent_call_id].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



154
155
156
157
158
159
160
161
 
# File 'lib/freeclimb/models/create_conference.rb', line 154

def list_invalid_properties
  invalid_properties = super
  if @action_url.nil?
    invalid_properties.push('invalid value for "action_url", action_url 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



280
281
282
 
# File 'lib/freeclimb/models/create_conference.rb', line 280

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



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/freeclimb/models/create_conference.rb', line 286

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



274
275
276
 
# File 'lib/freeclimb/models/create_conference.rb', line 274

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



165
166
167
168
169
170
171
 
# File 'lib/freeclimb/models/create_conference.rb', line 165

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