Class: UltracartClient::ConversationPbxVoicemailMailbox

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationPbxVoicemailMailbox

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
179
180
181
182
183
184
185
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 125

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#conversation_pbx_voicemail_mailbox_uuid ⇒ Object

Conversation Pbx Voicemail Mailbox UUID



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

def conversation_pbx_voicemail_mailbox_uuid
  @conversation_pbx_voicemail_mailbox_uuid
end

#merchant_id ⇒ Object

Merchant Id



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

def merchant_id
  @merchant_id
end

#send_notices_to_email ⇒ Object

Send notices to email



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

def send_notices_to_email
  @send_notices_to_email
end

#user_id ⇒ Object

User Id



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

def user_id
  @user_id
end

#voicemail_followup_play_audio_uuid ⇒ Object

Voicemail follow play audio UUID



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

def voicemail_followup_play_audio_uuid
  @voicemail_followup_play_audio_uuid
end

#voicemail_followup_say ⇒ Object

Voicemail followup say



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

def voicemail_followup_say
  @voicemail_followup_say
end

#voicemail_followup_say_voice ⇒ Object

Voicemail followup say voice



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

def voicemail_followup_say_voice
  @voicemail_followup_say_voice
end

#voicemail_mailbox_id ⇒ Object

Voicemail mailbox id



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

def voicemail_mailbox_id
  @voicemail_mailbox_id
end

#voicemail_mailbox_type ⇒ Object

Voicemail mailbox type



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

def voicemail_mailbox_type
  @voicemail_mailbox_type
end

#voicemail_prompt_play_audio_uuid ⇒ Object

Voicemail prompt play audio UUID



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

def voicemail_prompt_play_audio_uuid
  @voicemail_prompt_play_audio_uuid
end

#voicemail_prompt_say ⇒ Object

Voicemail prompt say



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

def voicemail_prompt_say
  @voicemail_prompt_say
end

#voicemail_prompt_say_voice ⇒ Object

Voicemail prompt say voice



52
53
54
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 52

def voicemail_prompt_say_voice
  @voicemail_prompt_say_voice
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 77

def self.attribute_map
  {
    :'conversation_pbx_voicemail_mailbox_uuid' => :'conversation_pbx_voicemail_mailbox_uuid',
    :'merchant_id' => :'merchant_id',
    :'send_notices_to_email' => :'send_notices_to_email',
    :'user_id' => :'user_id',
    :'voicemail_followup_play_audio_uuid' => :'voicemail_followup_play_audio_uuid',
    :'voicemail_followup_say' => :'voicemail_followup_say',
    :'voicemail_followup_say_voice' => :'voicemail_followup_say_voice',
    :'voicemail_mailbox_id' => :'voicemail_mailbox_id',
    :'voicemail_mailbox_type' => :'voicemail_mailbox_type',
    :'voicemail_prompt_play_audio_uuid' => :'voicemail_prompt_play_audio_uuid',
    :'voicemail_prompt_say' => :'voicemail_prompt_say',
    :'voicemail_prompt_say_voice' => :'voicemail_prompt_say_voice'
  }
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



375
376
377
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 375

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 100

def self.openapi_types
  {
    :'conversation_pbx_voicemail_mailbox_uuid' => :'String',
    :'merchant_id' => :'String',
    :'send_notices_to_email' => :'String',
    :'user_id' => :'Integer',
    :'voicemail_followup_play_audio_uuid' => :'String',
    :'voicemail_followup_say' => :'String',
    :'voicemail_followup_say_voice' => :'String',
    :'voicemail_mailbox_id' => :'String',
    :'voicemail_mailbox_type' => :'String',
    :'voicemail_prompt_play_audio_uuid' => :'String',
    :'voicemail_prompt_say' => :'String',
    :'voicemail_prompt_say_voice' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      conversation_pbx_voicemail_mailbox_uuid == o.conversation_pbx_voicemail_mailbox_uuid &&
      merchant_id == o.merchant_id &&
      send_notices_to_email == o.send_notices_to_email &&
      user_id == o.user_id &&
      voicemail_followup_play_audio_uuid == o.voicemail_followup_play_audio_uuid &&
      voicemail_followup_say == o.voicemail_followup_say &&
      voicemail_followup_say_voice == o.voicemail_followup_say_voice &&
      voicemail_mailbox_id == o.voicemail_mailbox_id &&
      voicemail_mailbox_type == o.voicemail_mailbox_type &&
      voicemail_prompt_play_audio_uuid == o.voicemail_prompt_play_audio_uuid &&
      voicemail_prompt_say == o.voicemail_prompt_say &&
      voicemail_prompt_say_voice == o.voicemail_prompt_say_voice
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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 406

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



477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 477

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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 382

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


362
363
364
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 362

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



368
369
370
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 368

def hash
  [conversation_pbx_voicemail_mailbox_uuid, merchant_id, send_notices_to_email, user_id, voicemail_followup_play_audio_uuid, voicemail_followup_say, voicemail_followup_say_voice, voicemail_mailbox_id, voicemail_mailbox_type, voicemail_prompt_play_audio_uuid, voicemail_prompt_say, voicemail_prompt_say_voice].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



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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 189

def list_invalid_properties
  invalid_properties = Array.new
  if !@conversation_pbx_voicemail_mailbox_uuid.nil? && @conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
    invalid_properties.push('invalid value for "conversation_pbx_voicemail_mailbox_uuid", 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 !@send_notices_to_email.nil? && @send_notices_to_email.to_s.length > 250
    invalid_properties.push('invalid value for "send_notices_to_email", the character length must be smaller than or equal to 250.')
  end

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

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

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

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

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

  if !@voicemail_prompt_say_voice.nil? && @voicemail_prompt_say_voice.to_s.length > 50
    invalid_properties.push('invalid value for "voicemail_prompt_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



453
454
455
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 453

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



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 459

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



447
448
449
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 447

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb', line 232

def valid?
  return false if !@conversation_pbx_voicemail_mailbox_uuid.nil? && @conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
  return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
  return false if !@send_notices_to_email.nil? && @send_notices_to_email.to_s.length > 250
  return false if !@voicemail_followup_play_audio_uuid.nil? && @voicemail_followup_play_audio_uuid.to_s.length > 50
  voicemail_followup_say_voice_validator = EnumAttributeValidator.new('String', ["man", "woman"])
  return false unless voicemail_followup_say_voice_validator.valid?(@voicemail_followup_say_voice)
  return false if !@voicemail_followup_say_voice.nil? && @voicemail_followup_say_voice.to_s.length > 50
  return false if !@voicemail_mailbox_id.nil? && @voicemail_mailbox_id.to_s.length > 50
  voicemail_mailbox_type_validator = EnumAttributeValidator.new('String', ["agent", "shared"])
  return false unless voicemail_mailbox_type_validator.valid?(@voicemail_mailbox_type)
  return false if !@voicemail_mailbox_type.nil? && @voicemail_mailbox_type.to_s.length > 50
  return false if !@voicemail_prompt_play_audio_uuid.nil? && @voicemail_prompt_play_audio_uuid.to_s.length > 50
  voicemail_prompt_say_voice_validator = EnumAttributeValidator.new('String', ["man", "woman"])
  return false unless voicemail_prompt_say_voice_validator.valid?(@voicemail_prompt_say_voice)
  return false if !@voicemail_prompt_say_voice.nil? && @voicemail_prompt_say_voice.to_s.length > 50
  true
end