class PhoneComClient::MenuFull

The Full Menu Object contains the same properties as the Menu Summary Object, along with the following:

Attributes

allow_extension_dial[RW]

Boolean. Determines whether a caller can enter an extension number to bypass the menu.

greeting[RW]

Greeting that is played when a caller enters a menu. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE.

id[RW]

Integer Menu ID. Read-only.

keypress_error[RW]

Message that is played when the caller makes a keypress error. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE.

keypress_wait_time[RW]

Number of seconds to wait for the caller to choose a menu option. Must be between 1 and 5 seconds.

name[RW]

Name. Required. Unique.

options[RW]

Array of menu option objects. See below for details.

timeout_handler[RW]

Route that will be entered when the caller fails to choose a menu option within the allotted time. Output is a Route Summary Object if the route is named, otherwise the Full Route Object will be shown. Input must be a Route Lookup Object pointing to a named route.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/phone_com_client/models/menu_full.rb, line 43
def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'allow_extension_dial' => :'allow_extension_dial',
    :'keypress_wait_time' => :'keypress_wait_time',
    :'greeting' => :'greeting',
    :'keypress_error' => :'keypress_error',
    :'timeout_handler' => :'timeout_handler',
    :'options' => :'options'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/phone_com_client/models/menu_full.rb, line 72
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'allow_extension_dial')
    self.allow_extension_dial = attributes[:'allow_extension_dial']
  end

  if attributes.has_key?(:'keypress_wait_time')
    self.keypress_wait_time = attributes[:'keypress_wait_time']
  end

  if attributes.has_key?(:'greeting')
    self.greeting = attributes[:'greeting']
  end

  if attributes.has_key?(:'keypress_error')
    self.keypress_error = attributes[:'keypress_error']
  end

  if attributes.has_key?(:'timeout_handler')
    self.timeout_handler = attributes[:'timeout_handler']
  end

  if attributes.has_key?(:'options')
    if (value = attributes[:'options']).is_a?(Array)
      self.options = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/phone_com_client/models/menu_full.rb, line 57
def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'allow_extension_dial' => :'BOOLEAN',
    :'keypress_wait_time' => :'Integer',
    :'greeting' => :'MediaSummary',
    :'keypress_error' => :'MediaSummary',
    :'timeout_handler' => :'RouteSummary',
    :'options' => :'Array<Option>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/phone_com_client/models/menu_full.rb, line 128
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      allow_extension_dial == o.allow_extension_dial &&
      keypress_wait_time == o.keypress_wait_time &&
      greeting == o.greeting &&
      keypress_error == o.keypress_error &&
      timeout_handler == o.timeout_handler &&
      options == o.options
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/phone_com_client/models/menu_full.rb, line 177
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
    temp_model = PhoneComClient.const_get(type).new
    temp_model.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/phone_com_client/models/menu_full.rb, line 243
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/phone_com_client/models/menu_full.rb, line 156
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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/phone_com_client/models/menu_full.rb, line 143
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/phone_com_client/models/menu_full.rb, line 149
def hash
  [id, name, allow_extension_dial, keypress_wait_time, greeting, keypress_error, timeout_handler, options].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/phone_com_client/models/menu_full.rb, line 115
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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/phone_com_client/models/menu_full.rb, line 223
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/phone_com_client/models/menu_full.rb, line 229
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/phone_com_client/models/menu_full.rb, line 217
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/phone_com_client/models/menu_full.rb, line 122
def valid?
  true
end