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



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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 128

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.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



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

def any_page_url_logic
  @any_page_url_logic
end

#any_page_url_value ⇒ Object

Returns the value of attribute any_page_url_value.



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

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



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

def current_page_url_logic
  @current_page_url_logic
end

#current_page_url_value ⇒ Object

Returns the value of attribute current_page_url_value.



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

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



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

def customers_browsing_time_logic
  @customers_browsing_time_logic
end

#customers_browsing_time_seconds ⇒ Object

Returns the value of attribute customers_browsing_time_seconds.



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

def customers_browsing_time_seconds
  @customers_browsing_time_seconds
end

#customers_location_country ⇒ Object

Returns the value of attribute customers_location_country.



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

def customers_location_country
  @customers_location_country
end

#customers_location_logic ⇒ Object

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



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

def customers_location_logic
  @customers_location_logic
end

#customers_location_state ⇒ Object

Returns the value of attribute customers_location_state.



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

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



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

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.



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

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



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

def referring_website_logic
  @referring_website_logic
end

#referring_website_value ⇒ Object

Returns the value of attribute referring_website_value.



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

def referring_website_value
  @referring_website_value
end

#type ⇒ Object

Type of function



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.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



331
332
333
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 331

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
124
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 121

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 101

def self.openapi_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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 297

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



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
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 362

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



433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 433

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 338

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


318
319
320
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 318

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



324
325
326
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 324

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



200
201
202
203
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 200

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



409
410
411
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 409

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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 415

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



403
404
405
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 403

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/ultracart_api/models/conversation_engagement_equation_function.rb', line 207

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