Class: UltracartClient::ConversationEngagement

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationEngagement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 90

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'active')
    self.active = attributes[:'active']
  end

  if attributes.has_key?(:'conversation_engagement_oid')
    self.conversation_engagement_oid = attributes[:'conversation_engagement_oid']
  end

  if attributes.has_key?(:'customer_greeting')
    self.customer_greeting = attributes[:'customer_greeting']
  end

  if attributes.has_key?(:'customer_initiated')
    self.customer_initiated = attributes[:'customer_initiated']
  end

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

  if attributes.has_key?(:'engagement_name')
    self.engagement_name = attributes[:'engagement_name']
  end

  if attributes.has_key?(:'equation')
    self.equation = attributes[:'equation']
  end

  if attributes.has_key?(:'time_on_page')
    self.time_on_page = attributes[:'time_on_page']
  end

  if attributes.has_key?(:'visitor_type')
    self.visitor_type = attributes[:'visitor_type']
  end
end

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



17
18
19
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 17

def active
  @active
end

#conversation_engagement_oid ⇒ Object

Returns the value of attribute conversation_engagement_oid.



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

def conversation_engagement_oid
  @conversation_engagement_oid
end

#customer_greeting ⇒ Object

Returns the value of attribute customer_greeting.



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

def customer_greeting
  @customer_greeting
end

#customer_initiated ⇒ Object

Returns the value of attribute customer_initiated.



23
24
25
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 23

def customer_initiated
  @customer_initiated
end

#department_oids ⇒ Object

Returns the value of attribute department_oids.



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

def department_oids
  @department_oids
end

#engagement_name ⇒ Object

Returns the value of attribute engagement_name.



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

def engagement_name
  @engagement_name
end

#equation ⇒ Object

Returns the value of attribute equation.



29
30
31
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 29

def equation
  @equation
end

#time_on_page ⇒ Object

Returns the value of attribute time_on_page.



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

def time_on_page
  @time_on_page
end

#visitor_type ⇒ Object

The type of visitor



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

def visitor_type
  @visitor_type
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 59

def self.attribute_map
  {
    :'active' => :'active',
    :'conversation_engagement_oid' => :'conversation_engagement_oid',
    :'customer_greeting' => :'customer_greeting',
    :'customer_initiated' => :'customer_initiated',
    :'department_oids' => :'department_oids',
    :'engagement_name' => :'engagement_name',
    :'equation' => :'equation',
    :'time_on_page' => :'time_on_page',
    :'visitor_type' => :'visitor_type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 74

def self.swagger_types
  {
    :'active' => :'BOOLEAN',
    :'conversation_engagement_oid' => :'Integer',
    :'customer_greeting' => :'String',
    :'customer_initiated' => :'BOOLEAN',
    :'department_oids' => :'Array<Integer>',
    :'engagement_name' => :'String',
    :'equation' => :'ConversationEngagementEquation',
    :'time_on_page' => :'Integer',
    :'visitor_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      conversation_engagement_oid == o.conversation_engagement_oid &&
      customer_greeting == o.customer_greeting &&
      customer_initiated == o.customer_initiated &&
      department_oids == o.department_oids &&
      engagement_name == o.engagement_name &&
      equation == o.equation &&
      time_on_page == o.time_on_page &&
      visitor_type == o.visitor_type
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



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
243
244
245
246
247
248
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 212

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = UltracartClient.const_get(type).new
    temp_model.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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 278

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 191

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


178
179
180
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



184
185
186
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 184

def hash
  [active, conversation_engagement_oid, customer_greeting, customer_initiated, department_oids, engagement_name, equation, time_on_page, visitor_type].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



137
138
139
140
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 137

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



258
259
260
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 258

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



264
265
266
267
268
269
270
271
272
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 264

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



252
253
254
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 252

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



144
145
146
147
148
 
# File 'lib/ultracart_api/models/conversation_engagement.rb', line 144

def valid?
  visitor_type_validator = EnumAttributeValidator.new('String', ['all', 'first time', 'returning'])
  return false unless visitor_type_validator.valid?(@visitor_type)
  true
end