Class: UltracartClient::ConversationPbxMenu

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/conversation_pbx_menu.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationPbxMenu

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 120

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationPbxMenu` 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 `UltracartClient::ConversationPbxMenu`. 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?(:'allow_direct_extensions')
    self.allow_direct_extensions = attributes[:'allow_direct_extensions']
  end

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

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

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

  if attributes.key?(:'mappings')
    if (value = attributes[:'mappings']).is_a?(Array)
      self.mappings = value
    end
  end

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

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

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

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

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

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

Instance Attribute Details

#allow_direct_extensions ⇒ Object

If true, the customer is allowed to input direct extensions within this menu



19
20
21
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 19

def allow_direct_extensions
  @allow_direct_extensions
end

#conversation_pbx_menu_uuid ⇒ Object

Conversation Pbx Menu UUID



22
23
24
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 22

def conversation_pbx_menu_uuid
  @conversation_pbx_menu_uuid
end

#default_action ⇒ Object

The default action for this menu



25
26
27
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 25

def default_action
  @default_action
end

#default_action_target ⇒ Object

The default action target for this menu



28
29
30
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 28

def default_action_target
  @default_action_target
end

#mappings ⇒ Object

Action mappings for this menu



31
32
33
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 31

def mappings
  @mappings
end

#merchant_id ⇒ Object

Merchant Id



34
35
36
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 34

def merchant_id
  @merchant_id
end

#name ⇒ Object

Menu name



37
38
39
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 37

def name
  @name
end

#play_audio_uuid ⇒ Object

An optional audio clip that plays when a customer enters this menu



40
41
42
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 40

def play_audio_uuid
  @play_audio_uuid
end

#say ⇒ Object

An optional saying that plays when a customer enters this menu



43
44
45
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 43

def say
  @say
end

#say_voice ⇒ Object

say voice



46
47
48
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 46

def say_voice
  @say_voice
end

#timeout ⇒ Object

The idle seconds before this menu times out



49
50
51
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 49

def timeout
  @timeout
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 74

def self.attribute_map
  {
    :'allow_direct_extensions' => :'allow_direct_extensions',
    :'conversation_pbx_menu_uuid' => :'conversation_pbx_menu_uuid',
    :'default_action' => :'default_action',
    :'default_action_target' => :'default_action_target',
    :'mappings' => :'mappings',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'play_audio_uuid' => :'play_audio_uuid',
    :'say' => :'say',
    :'say_voice' => :'say_voice',
    :'timeout' => :'timeout'
  }
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



333
334
335
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 333

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 113

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 96

def self.openapi_types
  {
    :'allow_direct_extensions' => :'Boolean',
    :'conversation_pbx_menu_uuid' => :'String',
    :'default_action' => :'String',
    :'default_action_target' => :'String',
    :'mappings' => :'Array<ConversationPbxMenuMapping>',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'play_audio_uuid' => :'String',
    :'say' => :'String',
    :'say_voice' => :'String',
    :'timeout' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 302

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_direct_extensions == o.allow_direct_extensions &&
      conversation_pbx_menu_uuid == o.conversation_pbx_menu_uuid &&
      default_action == o.default_action &&
      default_action_target == o.default_action_target &&
      mappings == o.mappings &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      play_audio_uuid == o.play_audio_uuid &&
      say == o.say &&
      say_voice == o.say_voice &&
      timeout == o.timeout
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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 364

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 = UltracartClient.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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 435

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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 340

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.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)
        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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


320
321
322
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 320

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



326
327
328
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 326

def hash
  [allow_direct_extensions, conversation_pbx_menu_uuid, default_action, default_action_target, mappings, merchant_id, name, play_audio_uuid, say, say_voice, timeout].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



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/ultracart_api/models/conversation_pbx_menu.rb', line 182

def list_invalid_properties
  invalid_properties = Array.new
  if !@conversation_pbx_menu_uuid.nil? && @conversation_pbx_menu_uuid.to_s.length > 50
    invalid_properties.push('invalid value for "conversation_pbx_menu_uuid", the character length must be smaller than or equal to 50.')
  end

  if !@default_action.nil? && @default_action.to_s.length > 30
    invalid_properties.push('invalid value for "default_action", the character length must be smaller than or equal to 30.')
  end

  if !@default_action_target.nil? && @default_action_target.to_s.length > 50
    invalid_properties.push('invalid value for "default_action_target", the character length must be smaller than or equal to 50.')
  end

  if !@merchant_id.nil? && @merchant_id.to_s.length > 5
    invalid_properties.push('invalid value for "merchant_id", the character length must be smaller than or equal to 5.')
  end

  if !@name.nil? && @name.to_s.length > 50
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.')
  end

  if !@play_audio_uuid.nil? && @play_audio_uuid.to_s.length > 50
    invalid_properties.push('invalid value for "play_audio_uuid", the character length must be smaller than or equal to 50.')
  end

  if !@say_voice.nil? && @say_voice.to_s.length > 50
    invalid_properties.push('invalid value for "say_voice", the character length must be smaller than or equal to 50.')
  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



411
412
413
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 411

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 417

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



405
406
407
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 405

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



217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ultracart_api/models/conversation_pbx_menu.rb', line 217

def valid?
  return false if !@conversation_pbx_menu_uuid.nil? && @conversation_pbx_menu_uuid.to_s.length > 50
  return false if !@default_action.nil? && @default_action.to_s.length > 30
  return false if !@default_action_target.nil? && @default_action_target.to_s.length > 50
  return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
  return false if !@name.nil? && @name.to_s.length > 50
  return false if !@play_audio_uuid.nil? && @play_audio_uuid.to_s.length > 50
  say_voice_validator = EnumAttributeValidator.new('String', ["man", "woman"])
  return false unless say_voice_validator.valid?(@say_voice)
  return false if !@say_voice.nil? && @say_voice.to_s.length > 50
  true
end