Class: KlaviyoAPI::CountdownTimerProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/models/countdown_timer_properties.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CountdownTimerProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
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
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 88

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

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

  if attributes.key?(:'clock_face')
    self.clock_face = attributes[:'clock_face']
  else
    self.clock_face = 'simple'
  end

  if attributes.key?(:'animation')
    self.animation = attributes[:'animation']
  else
    self.animation = 'heartbeat'
  end

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

Instance Attribute Details

#animation ⇒ Object

Options for timer completion animations.



25
26
27
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 25

def animation
  @animation
end

#classname ⇒ Object

Returns the value of attribute classname.



19
20
21
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 19

def classname
  @classname
end

#clock_face ⇒ Object

Options for displaying a timer.



22
23
24
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 22

def clock_face
  @clock_face
end

#configuration ⇒ Object

Returns the value of attribute configuration.



27
28
29
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 27

def configuration
  @configuration
end

#display_device ⇒ Object

Returns the value of attribute display_device.



17
18
19
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 17

def display_device
  @display_device
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 63

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 52

def self.attribute_map
  {
    :'display_device' => :'display_device',
    :'classname' => :'classname',
    :'clock_face' => :'clock_face',
    :'animation' => :'animation',
    :'configuration' => :'configuration'
  }
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



197
198
199
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 197

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
83
84
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 79

def self.openapi_nullable
  Set.new([
    :'classname',
    :'animation',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 68

def self.openapi_types
  {
    :'display_device' => :'Array<String>',
    :'classname' => :'String',
    :'clock_face' => :'String',
    :'animation' => :'String',
    :'configuration' => :'CountdownTimerPropertiesConfiguration'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      display_device == o.display_device &&
      classname == o.classname &&
      clock_face == o.clock_face &&
      animation == o.animation &&
      configuration == o.configuration
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 228

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 = KlaviyoAPI.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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 299

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 204

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


184
185
186
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



190
191
192
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 190

def hash
  [display_device, classname, clock_face, animation, configuration].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



130
131
132
133
134
135
136
137
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 130

def list_invalid_properties
  invalid_properties = Array.new
  if @configuration.nil?
    invalid_properties.push('invalid value for "configuration", configuration cannot be nil.')
  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



275
276
277
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 275

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 281

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



269
270
271
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 269

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



141
142
143
144
145
146
147
148
 
# File 'lib/klaviyo-api-sdk/models/countdown_timer_properties.rb', line 141

def valid?
  clock_face_validator = EnumAttributeValidator.new('String', ["flip", "simple"])
  return false unless clock_face_validator.valid?(@clock_face)
  animation_validator = EnumAttributeValidator.new('String', ["flash", "heartbeat", "pulse"])
  return false unless animation_validator.valid?(@animation)
  return false if @configuration.nil?
  true
end