Class: UltracartClient::ConversationAgentProfile

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationAgentProfile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 154

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ai ⇒ Object

AI powered chat bot



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

def ai
  @ai
end

#ai_capabilities ⇒ Object

Returns the value of attribute ai_capabilities.



21
22
23
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 21

def ai_capabilities
  @ai_capabilities
end

#ai_chat_instructions ⇒ Object

Additional instructions for this AI when handle web chats



24
25
26
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 24

def ai_chat_instructions
  @ai_chat_instructions
end

#ai_persona ⇒ Object

Persona of this AI agent



27
28
29
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 27

def ai_persona
  @ai_persona
end

#ai_sms_instructions ⇒ Object

Additional instructions for this AI when handle SMS messages



30
31
32
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 30

def ai_sms_instructions
  @ai_sms_instructions
end

#ai_ticket_instructions ⇒ Object

Additional instructions for this AI when handling ticket draft replies



33
34
35
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 33

def ai_ticket_instructions
  @ai_ticket_instructions
end

#ai_voice_instructions ⇒ Object

Additional voice instructions for this AI when handling voice calls



36
37
38
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 36

def ai_voice_instructions
  @ai_voice_instructions
end

#ai_voice_personality ⇒ Object

Which AI voice personality to use when handling the call.



39
40
41
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 39

def ai_voice_personality
  @ai_voice_personality
end

#chat_limit ⇒ Object

The number of engagement chats that can be pushed on them at any given time.



42
43
44
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 42

def chat_limit
  @chat_limit
end

#default_language_iso_code ⇒ Object

The default language the agent is chatting in



45
46
47
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 45

def default_language_iso_code
  @default_language_iso_code
end

#default_status ⇒ Object

Default status when the agent loads conversations app.



48
49
50
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 48

def default_status
  @default_status
end

#display_name ⇒ Object

An alternate name that the agent wants to use in chat.



51
52
53
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 51

def display_name
  @display_name
end

#name ⇒ Object

Their actual user name for profile settings display as placeholder test



54
55
56
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 54

def name
  @name
end

#profile_image_upload_key ⇒ Object

An upload key used to update the profile image.



57
58
59
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 57

def profile_image_upload_key
  @profile_image_upload_key
end

#profile_image_url ⇒ Object

Their current profile image URL



60
61
62
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 60

def profile_image_url
  @profile_image_url
end

#user_id ⇒ Object

User ID associated with the agent. Populated by getAgentProfiles call only.



63
64
65
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 63

def user_id
  @user_id
end

#zohodesk_classifications ⇒ Object

Restrict this agent to drafting replies only to tickets with these classifications



66
67
68
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 66

def zohodesk_classifications
  @zohodesk_classifications
end

#zohodesk_departments ⇒ Object

Restrict this agent to drafting replies only to these department ids



69
70
71
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 69

def zohodesk_departments
  @zohodesk_departments
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'ai' => :'ai',
    :'ai_capabilities' => :'ai_capabilities',
    :'ai_chat_instructions' => :'ai_chat_instructions',
    :'ai_persona' => :'ai_persona',
    :'ai_sms_instructions' => :'ai_sms_instructions',
    :'ai_ticket_instructions' => :'ai_ticket_instructions',
    :'ai_voice_instructions' => :'ai_voice_instructions',
    :'ai_voice_personality' => :'ai_voice_personality',
    :'chat_limit' => :'chat_limit',
    :'default_language_iso_code' => :'default_language_iso_code',
    :'default_status' => :'default_status',
    :'display_name' => :'display_name',
    :'name' => :'name',
    :'profile_image_upload_key' => :'profile_image_upload_key',
    :'profile_image_url' => :'profile_image_url',
    :'user_id' => :'user_id',
    :'zohodesk_classifications' => :'zohodesk_classifications',
    :'zohodesk_departments' => :'zohodesk_departments'
  }
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



321
322
323
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 321

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



147
148
149
150
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 147

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

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 123

def self.openapi_types
  {
    :'ai' => :'Boolean',
    :'ai_capabilities' => :'ConversationVirtualAgentCapabilities',
    :'ai_chat_instructions' => :'String',
    :'ai_persona' => :'String',
    :'ai_sms_instructions' => :'String',
    :'ai_ticket_instructions' => :'String',
    :'ai_voice_instructions' => :'String',
    :'ai_voice_personality' => :'String',
    :'chat_limit' => :'Integer',
    :'default_language_iso_code' => :'String',
    :'default_status' => :'String',
    :'display_name' => :'String',
    :'name' => :'String',
    :'profile_image_upload_key' => :'String',
    :'profile_image_url' => :'String',
    :'user_id' => :'Integer',
    :'zohodesk_classifications' => :'Array<String>',
    :'zohodesk_departments' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 283

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ai == o.ai &&
      ai_capabilities == o.ai_capabilities &&
      ai_chat_instructions == o.ai_chat_instructions &&
      ai_persona == o.ai_persona &&
      ai_sms_instructions == o.ai_sms_instructions &&
      ai_ticket_instructions == o.ai_ticket_instructions &&
      ai_voice_instructions == o.ai_voice_instructions &&
      ai_voice_personality == o.ai_voice_personality &&
      chat_limit == o.chat_limit &&
      default_language_iso_code == o.default_language_iso_code &&
      default_status == o.default_status &&
      display_name == o.display_name &&
      name == o.name &&
      profile_image_upload_key == o.profile_image_upload_key &&
      profile_image_url == o.profile_image_url &&
      user_id == o.user_id &&
      zohodesk_classifications == o.zohodesk_classifications &&
      zohodesk_departments == o.zohodesk_departments
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



352
353
354
355
356
357
358
359
360
361
362
363
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
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 352

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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 423

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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 328

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


308
309
310
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 308

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



314
315
316
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 314

def hash
  [ai, ai_capabilities, ai_chat_instructions, ai_persona, ai_sms_instructions, ai_ticket_instructions, ai_voice_instructions, ai_voice_personality, chat_limit, default_language_iso_code, default_status, display_name, name, profile_image_upload_key, profile_image_url, user_id, zohodesk_classifications, zohodesk_departments].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



246
247
248
249
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 246

def list_invalid_properties
  invalid_properties = Array.new
  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



399
400
401
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 399

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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 405

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



393
394
395
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 393

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



253
254
255
256
257
258
259
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 253

def valid?
  ai_voice_personality_validator = EnumAttributeValidator.new('String', ["Ara", "Rex", "Sal", "Eve", "Leo"])
  return false unless ai_voice_personality_validator.valid?(@ai_voice_personality)
  default_status_validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
  return false unless default_status_validator.valid?(@default_status)
  true
end