Class: UltracartClient::ConversationEngagementEquationFunction

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationEngagementEquationFunction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
117
118
119
120
121
122
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
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 116

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#any_page_url_logic ⇒ Object

Logic operation to perform on an any page url function type



18
19
20
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 18

def any_page_url_logic
  @any_page_url_logic
end

#any_page_url_value ⇒ Object

Returns the value of attribute any_page_url_value.



20
21
22
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 20

def any_page_url_value
  @any_page_url_value
end

#current_page_url_logic ⇒ Object

Logic operation to perform on a current page url function type



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

def current_page_url_logic
  @current_page_url_logic
end

#current_page_url_value ⇒ Object

Returns the value of attribute current_page_url_value.



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

def current_page_url_value
  @current_page_url_value
end

#customers_browsing_time_logic ⇒ Object

Logic operation to perform on a customer’s browsing time function type



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

def customers_browsing_time_logic
  @customers_browsing_time_logic
end

#customers_browsing_time_seconds ⇒ Object

Returns the value of attribute customers_browsing_time_seconds.



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

def customers_browsing_time_seconds
  @customers_browsing_time_seconds
end

#customers_location_country ⇒ Object

Returns the value of attribute customers_location_country.



32
33
34
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 32

def customers_location_country
  @customers_location_country
end

#customers_location_logic ⇒ Object

Logic operation to perform on a customer’s location function type



35
36
37
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 35

def customers_location_logic
  @customers_location_logic
end

#customers_location_state ⇒ Object

Returns the value of attribute customers_location_state.



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

def customers_location_state
  @customers_location_state
end

#number_of_viewed_pages_logic ⇒ Object

Logic operation to perform on a customer’s browsing time function type



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

def number_of_viewed_pages_logic
  @number_of_viewed_pages_logic
end

#number_of_viewed_pages_value ⇒ Object

Returns the value of attribute number_of_viewed_pages_value.



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

def number_of_viewed_pages_value
  @number_of_viewed_pages_value
end

#referring_website_logic ⇒ Object

Logic operation to perform on a referring website function type



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

def referring_website_logic
  @referring_website_logic
end

#referring_website_value ⇒ Object

Returns the value of attribute referring_website_value.



47
48
49
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 47

def referring_website_value
  @referring_website_value
end

#type ⇒ Object

Type of function



50
51
52
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 50

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 75

def self.attribute_map
  {
    :'any_page_url_logic' => :'any_page_url_logic',
    :'any_page_url_value' => :'any_page_url_value',
    :'current_page_url_logic' => :'current_page_url_logic',
    :'current_page_url_value' => :'current_page_url_value',
    :'customers_browsing_time_logic' => :'customers_browsing_time_logic',
    :'customers_browsing_time_seconds' => :'customers_browsing_time_seconds',
    :'customers_location_country' => :'customers_location_country',
    :'customers_location_logic' => :'customers_location_logic',
    :'customers_location_state' => :'customers_location_state',
    :'number_of_viewed_pages_logic' => :'number_of_viewed_pages_logic',
    :'number_of_viewed_pages_value' => :'number_of_viewed_pages_value',
    :'referring_website_logic' => :'referring_website_logic',
    :'referring_website_value' => :'referring_website_value',
    :'type' => :'type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'any_page_url_logic' => :'String',
    :'any_page_url_value' => :'String',
    :'current_page_url_logic' => :'String',
    :'current_page_url_value' => :'String',
    :'customers_browsing_time_logic' => :'String',
    :'customers_browsing_time_seconds' => :'Integer',
    :'customers_location_country' => :'String',
    :'customers_location_logic' => :'String',
    :'customers_location_state' => :'String',
    :'number_of_viewed_pages_logic' => :'String',
    :'number_of_viewed_pages_value' => :'Integer',
    :'referring_website_logic' => :'String',
    :'referring_website_value' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 278

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      any_page_url_logic == o.any_page_url_logic &&
      any_page_url_value == o.any_page_url_value &&
      current_page_url_logic == o.current_page_url_logic &&
      current_page_url_value == o.current_page_url_value &&
      customers_browsing_time_logic == o.customers_browsing_time_logic &&
      customers_browsing_time_seconds == o.customers_browsing_time_seconds &&
      customers_location_country == o.customers_location_country &&
      customers_location_logic == o.customers_location_logic &&
      customers_location_state == o.customers_location_state &&
      number_of_viewed_pages_logic == o.number_of_viewed_pages_logic &&
      number_of_viewed_pages_value == o.number_of_viewed_pages_value &&
      referring_website_logic == o.referring_website_logic &&
      referring_website_value == o.referring_website_value &&
      type == o.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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 333

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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 399

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



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

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


299
300
301
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 299

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



305
306
307
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 305

def hash
  [any_page_url_logic, any_page_url_value, current_page_url_logic, current_page_url_value, customers_browsing_time_logic, customers_browsing_time_seconds, customers_location_country, customers_location_logic, customers_location_state, number_of_viewed_pages_logic, number_of_viewed_pages_value, referring_website_logic, referring_website_value, 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



181
182
183
184
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 181

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



379
380
381
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 379

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



385
386
387
388
389
390
391
392
393
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 385

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



373
374
375
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 373

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 188

def valid?
  any_page_url_logic_validator = EnumAttributeValidator.new('String', ['contains', 'does not contain', 'is exactly', 'is not'])
  return false unless any_page_url_logic_validator.valid?(@any_page_url_logic)
  current_page_url_logic_validator = EnumAttributeValidator.new('String', ['contains', 'does not contain', 'is exactly', 'is not'])
  return false unless current_page_url_logic_validator.valid?(@current_page_url_logic)
  customers_browsing_time_logic_validator = EnumAttributeValidator.new('String', ['is at least', 'is more than', 'is less than', 'is at most'])
  return false unless customers_browsing_time_logic_validator.valid?(@customers_browsing_time_logic)
  customers_location_logic_validator = EnumAttributeValidator.new('String', ['is', 'is not'])
  return false unless customers_location_logic_validator.valid?(@customers_location_logic)
  number_of_viewed_pages_logic_validator = EnumAttributeValidator.new('String', ['is at least', 'is more than', 'is less than', 'is at most'])
  return false unless number_of_viewed_pages_logic_validator.valid?(@number_of_viewed_pages_logic)
  referring_website_logic_validator = EnumAttributeValidator.new('String', ['contains', 'does not contain', 'is exactly', 'is not'])
  return false unless referring_website_logic_validator.valid?(@referring_website_logic)
  type_validator = EnumAttributeValidator.new('String', ['current page url', 'customers location', 'customers browsing time', 'number of viewed pages', 'referring website address', 'any page from session'])
  return false unless type_validator.valid?(@type)
  true
end