class Freeclimb::CreateConferenceRequest

Attributes

_alias[RW]

A description for this Conference. Maximum 64 characters.

play_beep[RW]

Controls when a beep is played. Valid values: `always`, `never`, `entryOnly`, `exitOnly`.

record[RW]

Setting to `true` records the entire Conference.

status_callback_url[RW]

This URL is invoked when the status of the Conference changes. For more information, see statusCallbackUrl (below).

wait_url[RW]

If specified, a URL for the audio file that provides custom hold music for the Conference when it is in the populated state. Otherwise, FreeClimb uses a system default audio file. This is always fetched using HTTP GET and is fetched just once — when the Conference is created.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/freeclimb/models/create_conference_request.rb, line 55
def self.attribute_map
  {
    :'_alias' => :'alias',
    :'play_beep' => :'playBeep',
    :'record' => :'record',
    :'wait_url' => :'waitUrl',
    :'status_callback_url' => :'statusCallbackUrl'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/freeclimb/models/create_conference_request.rb, line 172
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/freeclimb/models/create_conference_request.rb, line 84
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::CreateConferenceRequest` 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::CreateConferenceRequest`. 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?(:'_alias')
    self._alias = attributes[:'_alias']
  end

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

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

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

  if attributes.key?(:'status_callback_url')
    self.status_callback_url = attributes[:'status_callback_url']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/freeclimb/models/create_conference_request.rb, line 77
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/freeclimb/models/create_conference_request.rb, line 66
def self.openapi_types
  {
    :'_alias' => :'String',
    :'play_beep' => :'String',
    :'record' => :'Boolean',
    :'wait_url' => :'String',
    :'status_callback_url' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/freeclimb/models/create_conference_request.rb, line 147
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _alias == o._alias &&
      play_beep == o.play_beep &&
      record == o.record &&
      wait_url == o.wait_url &&
      status_callback_url == o.status_callback_url
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/freeclimb/models/create_conference_request.rb, line 200
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/freeclimb/models/create_conference_request.rb, line 269
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/freeclimb/models/create_conference_request.rb, line 179
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/freeclimb/models/create_conference_request.rb, line 159
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/freeclimb/models/create_conference_request.rb, line 165
def hash
  [_alias, play_beep, record, wait_url, status_callback_url].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/freeclimb/models/create_conference_request.rb, line 122
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
play_beep=(play_beep) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] play_beep Object to be assigned

# File lib/freeclimb/models/create_conference_request.rb, line 137
def play_beep=(play_beep)
  validator = EnumAttributeValidator.new('String', ["always", "never", "entryOnly", "exitOnly"])
  unless validator.valid?(play_beep)
    fail ArgumentError, "invalid value for \"play_beep\", must be one of #{validator.allowable_values}."
  end
  @play_beep = play_beep
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/freeclimb/models/create_conference_request.rb, line 245
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/freeclimb/models/create_conference_request.rb, line 251
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/freeclimb/models/create_conference_request.rb, line 239
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/freeclimb/models/create_conference_request.rb, line 129
def valid?
  play_beep_validator = EnumAttributeValidator.new('String', ["always", "never", "entryOnly", "exitOnly"])
  return false unless play_beep_validator.valid?(@play_beep)
  true
end