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.

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 = {}) ⇒ CreateConference

Initializes the object

Parameters:

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

    Model attributes in the form of hash



76
77
78
79
80
81
82
83
84
85
86
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
 
# File 'lib/freeclimb/models/create_conference.rb', line 76

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(attributes)

  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
end

Instance Attribute Details

#_alias ⇒ Object

Descriptive name for the Conference.



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

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.



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

def action_url
  @action_url
end

#play_beep ⇒ Object

Indicates whether to play a beep when a Participant enters or leaves the Conference. either ‘always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always`



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

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.



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

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.



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

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.



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

def wait_url
  @wait_url
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/freeclimb/models/create_conference.rb', line 37

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



163
164
165
 
# File 'lib/freeclimb/models/create_conference.rb', line 163

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



67
68
69
70
71
72
 
# File 'lib/freeclimb/models/create_conference.rb', line 67

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/freeclimb/models/create_conference.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/freeclimb/models/create_conference.rb', line 49

def self.openapi_types
  {
    :'action_url' => :'String',
    :'_alias' => :'Boolean',
    :'play_beep' => :'String',
    :'record' => :'Boolean',
    :'status_callback_url' => :'Boolean',
    :'wait_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/freeclimb/models/create_conference.rb', line 137

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



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

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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/freeclimb/models/create_conference.rb', line 261

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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/freeclimb/models/create_conference.rb', line 170

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


150
151
152
 
# File 'lib/freeclimb/models/create_conference.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



156
157
158
 
# File 'lib/freeclimb/models/create_conference.rb', line 156

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



119
120
121
122
123
124
125
126
 
# File 'lib/freeclimb/models/create_conference.rb', line 119

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



237
238
239
 
# File 'lib/freeclimb/models/create_conference.rb', line 237

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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/freeclimb/models/create_conference.rb', line 243

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



231
232
233
 
# File 'lib/freeclimb/models/create_conference.rb', line 231

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



130
131
132
133
 
# File 'lib/freeclimb/models/create_conference.rb', line 130

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