Class: KlaviyoAPI::VersionStyles

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VersionStyles

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 131

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

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

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

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

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

  if attributes.key?(:'minimum_height')
    self.minimum_height = attributes[:'minimum_height']
  else
    self.minimum_height = 250
  end

  if attributes.key?(:'width')
    self.width = attributes[:'width']
  else
    self.width = 'medium'
  end

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

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

  if attributes.key?(:'background_color')
    self.background_color = attributes[:'background_color']
  else
    self.background_color = '#FFFFFF'
  end

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

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

  if attributes.key?(:'overlay_color')
    self.overlay_color = attributes[:'overlay_color']
  else
    self.overlay_color = 'rgba(20,20,20,0.6)'
  end

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

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

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

Instance Attribute Details

#background_color ⇒ Object

Returns the value of attribute background_color.



36
37
38
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 36

def background_color
  @background_color
end

#background_image ⇒ Object

Returns the value of attribute background_image.



34
35
36
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 34

def background_image
  @background_image
end

Returns the value of attribute banner_styles.



48
49
50
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 48

def banner_styles
  @banner_styles
end

#border_styles ⇒ Object

Returns the value of attribute border_styles.



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

def border_styles
  @border_styles
end

#close_button ⇒ Object

Returns the value of attribute close_button.



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

def close_button
  @close_button
end

#custom_width ⇒ Object

Returns the value of attribute custom_width.



32
33
34
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 32

def custom_width
  @custom_width
end

#drop_shadow ⇒ Object

Returns the value of attribute drop_shadow.



40
41
42
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 40

def drop_shadow
  @drop_shadow
end

#input_styles ⇒ Object

Returns the value of attribute input_styles.



38
39
40
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 38

def input_styles
  @input_styles
end

#margin ⇒ Object

Returns the value of attribute margin.



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

def margin
  @margin
end

#minimum_height ⇒ Object

Returns the value of attribute minimum_height.



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

def minimum_height
  @minimum_height
end

#mobile_overlay ⇒ Object

Returns the value of attribute mobile_overlay.



46
47
48
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 46

def mobile_overlay
  @mobile_overlay
end

#overlay_color ⇒ Object

Returns the value of attribute overlay_color.



42
43
44
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 42

def overlay_color
  @overlay_color
end

#padding ⇒ Object

Returns the value of attribute padding.



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

def padding
  @padding
end

#rich_text_styles ⇒ Object

Returns the value of attribute rich_text_styles.



44
45
46
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 44

def rich_text_styles
  @rich_text_styles
end

#width ⇒ Object

Version width enumeration.



30
31
32
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 30

def width
  @width
end

#wrap_content ⇒ Object

Returns the value of attribute wrap_content.



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

def wrap_content
  @wrap_content
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 73

def self.attribute_map
  {
    :'wrap_content' => :'wrap_content',
    :'border_styles' => :'border_styles',
    :'close_button' => :'close_button',
    :'margin' => :'margin',
    :'padding' => :'padding',
    :'minimum_height' => :'minimum_height',
    :'width' => :'width',
    :'custom_width' => :'custom_width',
    :'background_image' => :'background_image',
    :'background_color' => :'background_color',
    :'input_styles' => :'input_styles',
    :'drop_shadow' => :'drop_shadow',
    :'overlay_color' => :'overlay_color',
    :'rich_text_styles' => :'rich_text_styles',
    :'mobile_overlay' => :'mobile_overlay',
    :'banner_styles' => :'banner_styles'
  }
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



294
295
296
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 294

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
126
127
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 122

def self.openapi_nullable
  Set.new([
    :'custom_width',
    :'background_color',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 100

def self.openapi_types
  {
    :'wrap_content' => :'Boolean',
    :'border_styles' => :'BorderStyle',
    :'close_button' => :'CloseButtonStyle',
    :'margin' => :'Margin',
    :'padding' => :'Padding',
    :'minimum_height' => :'Integer',
    :'width' => :'String',
    :'custom_width' => :'Integer',
    :'background_image' => :'BackgroundImage',
    :'background_color' => :'String',
    :'input_styles' => :'InputStyles',
    :'drop_shadow' => :'DropShadow',
    :'overlay_color' => :'String',
    :'rich_text_styles' => :'RichTextStyles',
    :'mobile_overlay' => :'MobileOverlay',
    :'banner_styles' => :'BannerStyles'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 258

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      wrap_content == o.wrap_content &&
      border_styles == o.border_styles &&
      close_button == o.close_button &&
      margin == o.margin &&
      padding == o.padding &&
      minimum_height == o.minimum_height &&
      width == o.width &&
      custom_width == o.custom_width &&
      background_image == o.background_image &&
      background_color == o.background_color &&
      input_styles == o.input_styles &&
      drop_shadow == o.drop_shadow &&
      overlay_color == o.overlay_color &&
      rich_text_styles == o.rich_text_styles &&
      mobile_overlay == o.mobile_overlay &&
      banner_styles == o.banner_styles
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



325
326
327
328
329
330
331
332
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
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 325

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



396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 396

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 301

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


281
282
283
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



287
288
289
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 287

def hash
  [wrap_content, border_styles, close_button, margin, padding, minimum_height, width, custom_width, background_image, background_color, input_styles, drop_shadow, overlay_color, rich_text_styles, mobile_overlay, banner_styles].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



221
222
223
224
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 221

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



372
373
374
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 372

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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 378

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



366
367
368
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 366

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



228
229
230
231
232
233
234
 
# File 'lib/klaviyo-api-sdk/models/version_styles.rb', line 228

def valid?
  wrap_content_validator = EnumAttributeValidator.new('Boolean', ["false"])
  return false unless wrap_content_validator.valid?(@wrap_content)
  width_validator = EnumAttributeValidator.new('String', ["custom", "large", "medium", "small"])
  return false unless width_validator.valid?(@width)
  true
end