Class: UltracartClient::ConversationPbxAgent

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationPbxAgent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cellphone ⇒ Object

Cellphone number of agent in E.164 format



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

def cellphone
  @cellphone
end

#conversation_pbx_agent_uuid ⇒ Object

Conversation Pbx Agent unique identifier



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

def conversation_pbx_agent_uuid
  @conversation_pbx_agent_uuid
end

#extension ⇒ Object

Extension



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

def extension
  @extension
end

#forward_calls_to_cellphone ⇒ Object

True if calls to this agent should be forwarded to their cellphone



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

def forward_calls_to_cellphone
  @forward_calls_to_cellphone
end

#full_name ⇒ Object

Full name



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

def full_name
  @full_name
end

#login ⇒ Object

Agent login



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

def 
  @login
end

#merchant_id ⇒ Object

Merchant Id



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

def merchant_id
  @merchant_id
end

#personal_conversation_pbx_voicemail_mailbox_uuid ⇒ Object

Personal Conversation Pbx Voicemail Mailbox UUID



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

def personal_conversation_pbx_voicemail_mailbox_uuid
  @personal_conversation_pbx_voicemail_mailbox_uuid
end

#record_outgoing_automatically ⇒ Object

True if outgoing calls should be automatically recorded



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

def record_outgoing_automatically
  @record_outgoing_automatically
end

#shared_conversation_pbx_voicemail_mailbox_uuid ⇒ Object

Shared Conversation Pbx Voicemail Mailbox UUID



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

def shared_conversation_pbx_voicemail_mailbox_uuid
  @shared_conversation_pbx_voicemail_mailbox_uuid
end

#twilio_taskrouter_worker_id ⇒ Object

Twilio taskrouter worker Id



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

def twilio_taskrouter_worker_id
  @twilio_taskrouter_worker_id
end

#unavailable_play_audio_uuid ⇒ Object

Unavailable play audio UUID



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

def unavailable_play_audio_uuid
  @unavailable_play_audio_uuid
end

#unavailable_say ⇒ Object

Unavailable say



55
56
57
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 55

def unavailable_say
  @unavailable_say
end

#unavailable_say_voice ⇒ Object

Unavailable say voice



58
59
60
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 58

def unavailable_say_voice
  @unavailable_say_voice
end

#user_id ⇒ Object

User Id



61
62
63
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 61

def user_id
  @user_id
end

#voicemail ⇒ Object

True if this agent has voicemail configured



64
65
66
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 64

def voicemail
  @voicemail
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 67

def self.attribute_map
  {
    :'cellphone' => :'cellphone',
    :'conversation_pbx_agent_uuid' => :'conversation_pbx_agent_uuid',
    :'extension' => :'extension',
    :'forward_calls_to_cellphone' => :'forward_calls_to_cellphone',
    :'full_name' => :'full_name',
    :'login' => :'login',
    :'merchant_id' => :'merchant_id',
    :'personal_conversation_pbx_voicemail_mailbox_uuid' => :'personal_conversation_pbx_voicemail_mailbox_uuid',
    :'record_outgoing_automatically' => :'record_outgoing_automatically',
    :'shared_conversation_pbx_voicemail_mailbox_uuid' => :'shared_conversation_pbx_voicemail_mailbox_uuid',
    :'twilio_taskrouter_worker_id' => :'twilio_taskrouter_worker_id',
    :'unavailable_play_audio_uuid' => :'unavailable_play_audio_uuid',
    :'unavailable_say' => :'unavailable_say',
    :'unavailable_say_voice' => :'unavailable_say_voice',
    :'user_id' => :'user_id',
    :'voicemail' => :'voicemail'
  }
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



357
358
359
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 357

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 94

def self.openapi_types
  {
    :'cellphone' => :'String',
    :'conversation_pbx_agent_uuid' => :'String',
    :'extension' => :'Integer',
    :'forward_calls_to_cellphone' => :'Boolean',
    :'full_name' => :'String',
    :'login' => :'String',
    :'merchant_id' => :'String',
    :'personal_conversation_pbx_voicemail_mailbox_uuid' => :'String',
    :'record_outgoing_automatically' => :'Boolean',
    :'shared_conversation_pbx_voicemail_mailbox_uuid' => :'String',
    :'twilio_taskrouter_worker_id' => :'String',
    :'unavailable_play_audio_uuid' => :'String',
    :'unavailable_say' => :'String',
    :'unavailable_say_voice' => :'String',
    :'user_id' => :'Integer',
    :'voicemail' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 321

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cellphone == o.cellphone &&
      conversation_pbx_agent_uuid == o.conversation_pbx_agent_uuid &&
      extension == o.extension &&
      forward_calls_to_cellphone == o.forward_calls_to_cellphone &&
      full_name == o.full_name &&
       == o. &&
      merchant_id == o.merchant_id &&
      personal_conversation_pbx_voicemail_mailbox_uuid == o.personal_conversation_pbx_voicemail_mailbox_uuid &&
      record_outgoing_automatically == o.record_outgoing_automatically &&
      shared_conversation_pbx_voicemail_mailbox_uuid == o.shared_conversation_pbx_voicemail_mailbox_uuid &&
      twilio_taskrouter_worker_id == o.twilio_taskrouter_worker_id &&
      unavailable_play_audio_uuid == o.unavailable_play_audio_uuid &&
      unavailable_say == o.unavailable_say &&
      unavailable_say_voice == o.unavailable_say_voice &&
      user_id == o.user_id &&
      voicemail == o.voicemail
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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 388

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



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

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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 364

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


344
345
346
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 344

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



350
351
352
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 350

def hash
  [cellphone, conversation_pbx_agent_uuid, extension, forward_calls_to_cellphone, full_name, , merchant_id, personal_conversation_pbx_voicemail_mailbox_uuid, record_outgoing_automatically, shared_conversation_pbx_voicemail_mailbox_uuid, twilio_taskrouter_worker_id, unavailable_play_audio_uuid, unavailable_say, unavailable_say_voice, user_id, voicemail].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



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
229
230
231
232
233
234
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 203

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

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

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

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

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



435
436
437
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 435

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 441

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



429
430
431
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 429

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



238
239
240
241
242
243
244
245
246
247
 
# File 'lib/ultracart_api/models/conversation_pbx_agent.rb', line 238

def valid?
  return false if !@cellphone.nil? && @cellphone.to_s.length > 50
  return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
  return false if !@personal_conversation_pbx_voicemail_mailbox_uuid.nil? && @personal_conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
  return false if !@shared_conversation_pbx_voicemail_mailbox_uuid.nil? && @shared_conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
  return false if !@twilio_taskrouter_worker_id.nil? && @twilio_taskrouter_worker_id.to_s.length > 100
  return false if !@unavailable_play_audio_uuid.nil? && @unavailable_play_audio_uuid.to_s.length > 50
  return false if !@unavailable_say_voice.nil? && @unavailable_say_voice.to_s.length > 50
  true
end