Class: UltracartClient::ConversationAgentStatusConfig

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationAgentStatusConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 130

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

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

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

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

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

  if attributes.key?(:'icon')
    self.icon = attributes[:'icon']
  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?(:'parent_status')
    self.parent_status = attributes[:'parent_status']
  end

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Whether the status is active and selectable. DELETE soft-deactivates by setting this to false.



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

def active
  @active
end

#channel ⇒ Object

Channel this status applies to



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

def channel
  @channel
end

#color ⇒ Object

Hex color for UI (e.g. '#FF5733')



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

def color
  @color
end

#conversation_status_uuid ⇒ Object

Conversation agent status unique identifier



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

def conversation_status_uuid
  @conversation_status_uuid
end

#created_at ⇒ Object

Created at



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

def created_at
  @created_at
end

#icon ⇒ Object

Icon name



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

def icon
  @icon
end

#merchant_id ⇒ Object

Merchant Id



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

def merchant_id
  @merchant_id
end

#name ⇒ Object

Display name shown to agents



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

def name
  @name
end

#parent_status ⇒ Object

Channel-native parent status



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

def parent_status
  @parent_status
end

#routing_effect ⇒ Object

Canonical routing semantic. Derived server-side from (channel, parent_status).



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

def routing_effect
  @routing_effect
end

#sort_order ⇒ Object

Sort order in lists; lower = first



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

def sort_order
  @sort_order
end

#twilio_activity_sid ⇒ Object

Twilio TaskRouter Activity SID (PBX-only; null for chat-only statuses)



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

def twilio_activity_sid
  @twilio_activity_sid
end

#updated_at ⇒ Object

Updated at



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



99
100
101
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 99

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 80

def self.attribute_map
  {
    :'active' => :'active',
    :'channel' => :'channel',
    :'color' => :'color',
    :'conversation_status_uuid' => :'conversation_status_uuid',
    :'created_at' => :'created_at',
    :'icon' => :'icon',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'parent_status' => :'parent_status',
    :'routing_effect' => :'routing_effect',
    :'sort_order' => :'sort_order',
    :'twilio_activity_sid' => :'twilio_activity_sid',
    :'updated_at' => :'updated_at'
  }
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



343
344
345
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 343

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



123
124
125
126
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 123

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

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 104

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'channel' => :'String',
    :'color' => :'String',
    :'conversation_status_uuid' => :'String',
    :'created_at' => :'String',
    :'icon' => :'String',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'parent_status' => :'String',
    :'routing_effect' => :'String',
    :'sort_order' => :'Integer',
    :'twilio_activity_sid' => :'String',
    :'updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 310

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      channel == o.channel &&
      color == o.color &&
      conversation_status_uuid == o.conversation_status_uuid &&
      created_at == o.created_at &&
      icon == o.icon &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      parent_status == o.parent_status &&
      routing_effect == o.routing_effect &&
      sort_order == o.sort_order &&
      twilio_activity_sid == o.twilio_activity_sid &&
      updated_at == o.updated_at
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



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
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 374

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



445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 445

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



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 350

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


330
331
332
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 330

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



336
337
338
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 336

def hash
  [active, channel, color, conversation_status_uuid, created_at, icon, merchant_id, name, parent_status, routing_effect, sort_order, twilio_activity_sid, updated_at].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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 198

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

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

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



421
422
423
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 421

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



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 427

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



415
416
417
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 415

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



225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/ultracart_api/models/conversation_agent_status_config.rb', line 225

def valid?
  channel_validator = EnumAttributeValidator.new('String', ["pbx", "chat", "both"])
  return false unless channel_validator.valid?(@channel)
  return false if !@color.nil? && @color.to_s.length > 7
  return false if !@icon.nil? && @icon.to_s.length > 40
  return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
  return false if !@name.nil? && @name.to_s.length > 100
  routing_effect_validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
  return false unless routing_effect_validator.valid?(@routing_effect)
  return false if !@twilio_activity_sid.nil? && @twilio_activity_sid.to_s.length > 40
  true
end