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



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 140

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_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?(:'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_chat_instructions ⇒ Object

Additional instructions for this AI when handle web chats



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

def ai_chat_instructions
  @ai_chat_instructions
end

#ai_persona ⇒ Object

Persona of this AI agent



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

def ai_persona
  @ai_persona
end

#ai_sms_instructions ⇒ Object

Additional instructions for this AI when handle SMS messages



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

def ai_sms_instructions
  @ai_sms_instructions
end

#ai_ticket_instructions ⇒ Object

Additional instructions for this AI when handling ticket draft replies



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

def ai_ticket_instructions
  @ai_ticket_instructions
end

#chat_limit ⇒ Object

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



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

def chat_limit
  @chat_limit
end

#default_language_iso_code ⇒ Object

The default language the agent is chatting in



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

def default_language_iso_code
  @default_language_iso_code
end

#default_status ⇒ Object

Default status when the agent loads conversations app.



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

def default_status
  @default_status
end

#display_name ⇒ Object

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



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

def display_name
  @display_name
end

#name ⇒ Object

Their actual user name for profile settings display as placeholder test



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

def name
  @name
end

#profile_image_upload_key ⇒ Object

An upload key used to update the profile image.



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

def profile_image_upload_key
  @profile_image_upload_key
end

#profile_image_url ⇒ Object

Their current profile image URL



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

def profile_image_url
  @profile_image_url
end

#user_id ⇒ Object

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



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

def user_id
  @user_id
end

#zohodesk_classifications ⇒ Object

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



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

def zohodesk_classifications
  @zohodesk_classifications
end

#zohodesk_departments ⇒ Object

Restrict this agent to drafting replies only to these department ids



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

def zohodesk_departments
  @zohodesk_departments
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



107
108
109
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 86

def self.attribute_map
  {
    :'ai' => :'ai',
    :'ai_chat_instructions' => :'ai_chat_instructions',
    :'ai_persona' => :'ai_persona',
    :'ai_sms_instructions' => :'ai_sms_instructions',
    :'ai_ticket_instructions' => :'ai_ticket_instructions',
    :'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



280
281
282
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 280

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



133
134
135
136
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 133

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

.openapi_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 112

def self.openapi_types
  {
    :'ai' => :'Boolean',
    :'ai_chat_instructions' => :'String',
    :'ai_persona' => :'String',
    :'ai_sms_instructions' => :'String',
    :'ai_ticket_instructions' => :'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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 245

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ai == o.ai &&
      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 &&
      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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 311

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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 382

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



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

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


267
268
269
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



273
274
275
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 273

def hash
  [ai, ai_chat_instructions, ai_persona, ai_sms_instructions, ai_ticket_instructions, 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



220
221
222
223
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 220

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



358
359
360
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 358

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 364

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



352
353
354
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 352

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



227
228
229
230
231
 
# File 'lib/ultracart_api/models/conversation_agent_profile.rb', line 227

def valid?
  default_status_validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
  return false unless default_status_validator.valid?(@default_status)
  true
end