Class: PhoneComClient::MenuFull
- Inherits:
-
Object
- Object
- PhoneComClient::MenuFull
- Defined in:
- lib/phone_com_client/models/menu_full.rb
Overview
The Full Menu Object contains the same properties as the Menu Summary Object, along with the following:
Instance Attribute Summary collapse
-
#allow_extension_dial ⇒ Object
Boolean.
-
#greeting ⇒ Object
Greeting that is played when a caller enters a menu.
-
#id ⇒ Object
Integer Menu ID.
-
#keypress_error ⇒ Object
Message that is played when the caller makes a keypress error.
-
#keypress_wait_time ⇒ Object
Number of seconds to wait for the caller to choose a menu option.
-
#name ⇒ Object
Name.
-
#options ⇒ Object
Array of menu option objects.
-
#timeout_handler ⇒ Object
Route that will be entered when the caller fails to choose a menu option within the allotted time.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ MenuFull
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ MenuFull
Initializes the object
72 73 74 75 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 |
# 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. = value end end end |
Instance Attribute Details
#allow_extension_dial ⇒ Object
Boolean. Determines whether a caller can enter an extension number to bypass the menu.
25 26 27 |
# File 'lib/phone_com_client/models/menu_full.rb', line 25 def allow_extension_dial @allow_extension_dial end |
#greeting ⇒ Object
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.
31 32 33 |
# File 'lib/phone_com_client/models/menu_full.rb', line 31 def greeting @greeting end |
#id ⇒ Object
Integer Menu ID. Read-only.
19 20 21 |
# File 'lib/phone_com_client/models/menu_full.rb', line 19 def id @id end |
#keypress_error ⇒ Object
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.
34 35 36 |
# File 'lib/phone_com_client/models/menu_full.rb', line 34 def keypress_error @keypress_error end |
#keypress_wait_time ⇒ Object
Number of seconds to wait for the caller to choose a menu option. Must be between 1 and 5 seconds.
28 29 30 |
# File 'lib/phone_com_client/models/menu_full.rb', line 28 def keypress_wait_time @keypress_wait_time end |
#name ⇒ Object
Name. Required. Unique.
22 23 24 |
# File 'lib/phone_com_client/models/menu_full.rb', line 22 def name @name end |
#options ⇒ Object
Array of menu option objects. See below for details.
40 41 42 |
# File 'lib/phone_com_client/models/menu_full.rb', line 40 def @options end |
#timeout_handler ⇒ Object
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.
37 38 39 |
# File 'lib/phone_com_client/models/menu_full.rb', line 37 def timeout_handler @timeout_handler end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
43 44 45 46 47 48 49 50 51 52 53 54 |
# 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 |
.swagger_types ⇒ Object
Attribute type mapping.
57 58 59 60 61 62 63 64 65 66 67 68 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
128 129 130 131 132 133 134 135 136 137 138 139 |
# 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 && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
243 244 245 246 247 248 249 250 251 252 253 254 255 |
# 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) ⇒ Object
Builds the object from hash
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# 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) ⇒ Boolean
143 144 145 |
# File 'lib/phone_com_client/models/menu_full.rb', line 143 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
149 150 151 |
# 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, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
115 116 117 118 |
# File 'lib/phone_com_client/models/menu_full.rb', line 115 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
223 224 225 |
# File 'lib/phone_com_client/models/menu_full.rb', line 223 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
229 230 231 232 233 234 235 236 237 |
# 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 ⇒ String
Returns the string representation of the object
217 218 219 |
# File 'lib/phone_com_client/models/menu_full.rb', line 217 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
122 123 124 |
# File 'lib/phone_com_client/models/menu_full.rb', line 122 def valid? true end |