Class: KlaviyoAPI::TextBlockStyles

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TextBlockStyles

Initializes the object

Parameters:

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

    Model attributes in the form of hash



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 194

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#background_color ⇒ Object

Returns the value of attribute background_color.



58
59
60
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 58

def background_color
  @background_color
end

#block_background_color ⇒ Object

Returns the value of attribute block_background_color.



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

def block_background_color
  @block_background_color
end

#block_border_color ⇒ Object

Returns the value of attribute block_border_color.



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

def block_border_color
  @block_border_color
end

#block_border_style ⇒ Object

Border style.



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

def block_border_style
  @block_border_style
end

#block_border_width ⇒ Object

Returns the value of attribute block_border_width.



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

def block_border_width
  @block_border_width
end

#block_padding_bottom ⇒ Object

Returns the value of attribute block_padding_bottom.



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

def block_padding_bottom
  @block_padding_bottom
end

#block_padding_left ⇒ Object

Returns the value of attribute block_padding_left.



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

def block_padding_left
  @block_padding_left
end

#block_padding_right ⇒ Object

Returns the value of attribute block_padding_right.



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

def block_padding_right
  @block_padding_right
end

#block_padding_top ⇒ Object

Returns the value of attribute block_padding_top.



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

def block_padding_top
  @block_padding_top
end

#color ⇒ Object

Returns the value of attribute color.



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

def color
  @color
end

#extra_css_class ⇒ Object

Returns the value of attribute extra_css_class.



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

def extra_css_class
  @extra_css_class
end

#font_family ⇒ Object

Returns the value of attribute font_family.



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

def font_family
  @font_family
end

#font_size ⇒ Object

Returns the value of attribute font_size.



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

def font_size
  @font_size
end

#font_style ⇒ Object

Font style.



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

def font_style
  @font_style
end

#font_weight ⇒ Object

Returns the value of attribute font_weight.



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

def font_weight
  @font_weight
end

#inner_padding_bottom ⇒ Object

Returns the value of attribute inner_padding_bottom.



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

def inner_padding_bottom
  @inner_padding_bottom
end

#inner_padding_left ⇒ Object

Returns the value of attribute inner_padding_left.



50
51
52
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 50

def inner_padding_left
  @inner_padding_left
end

#inner_padding_right ⇒ Object

Returns the value of attribute inner_padding_right.



52
53
54
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 52

def inner_padding_right
  @inner_padding_right
end

#inner_padding_top ⇒ Object

Returns the value of attribute inner_padding_top.



54
55
56
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 54

def inner_padding_top
  @inner_padding_top
end

#letter_spacing ⇒ Object

Returns the value of attribute letter_spacing.



60
61
62
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 60

def letter_spacing
  @letter_spacing
end

#line_height ⇒ Object

Returns the value of attribute line_height.



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

def line_height
  @line_height
end

#mobile_stretch_content ⇒ Object

Returns the value of attribute mobile_stretch_content.



56
57
58
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 56

def mobile_stretch_content
  @mobile_stretch_content
end

#text_align ⇒ Object

Text Alignment.



65
66
67
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 65

def text_align
  @text_align
end

#text_decoration ⇒ Object

Returns the value of attribute text_decoration.



67
68
69
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 67

def text_decoration
  @text_decoration
end

#text_table_layout ⇒ Object

Text table layout.



70
71
72
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 70

def text_table_layout
  @text_table_layout
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



126
127
128
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 126

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'block_background_color' => :'block_background_color',
    :'block_border_color' => :'block_border_color',
    :'block_border_style' => :'block_border_style',
    :'block_border_width' => :'block_border_width',
    :'block_padding_bottom' => :'block_padding_bottom',
    :'block_padding_left' => :'block_padding_left',
    :'block_padding_right' => :'block_padding_right',
    :'block_padding_top' => :'block_padding_top',
    :'color' => :'color',
    :'extra_css_class' => :'extra_css_class',
    :'font_family' => :'font_family',
    :'font_size' => :'font_size',
    :'font_style' => :'font_style',
    :'font_weight' => :'font_weight',
    :'inner_padding_bottom' => :'inner_padding_bottom',
    :'inner_padding_left' => :'inner_padding_left',
    :'inner_padding_right' => :'inner_padding_right',
    :'inner_padding_top' => :'inner_padding_top',
    :'mobile_stretch_content' => :'mobile_stretch_content',
    :'background_color' => :'background_color',
    :'letter_spacing' => :'letter_spacing',
    :'line_height' => :'line_height',
    :'text_align' => :'text_align',
    :'text_decoration' => :'text_decoration',
    :'text_table_layout' => :'text_table_layout'
  }
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



416
417
418
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 416

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'block_background_color',
    :'block_border_color',
    :'block_border_style',
    :'block_border_width',
    :'block_padding_bottom',
    :'block_padding_left',
    :'block_padding_right',
    :'block_padding_top',
    :'color',
    :'extra_css_class',
    :'font_family',
    :'font_size',
    :'font_style',
    :'font_weight',
    :'inner_padding_bottom',
    :'inner_padding_left',
    :'inner_padding_right',
    :'inner_padding_top',
    :'mobile_stretch_content',
    :'background_color',
    :'letter_spacing',
    :'line_height',
    :'text_align',
    :'text_decoration',
    :'text_table_layout'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'block_background_color' => :'String',
    :'block_border_color' => :'String',
    :'block_border_style' => :'String',
    :'block_border_width' => :'Integer',
    :'block_padding_bottom' => :'Integer',
    :'block_padding_left' => :'Integer',
    :'block_padding_right' => :'Integer',
    :'block_padding_top' => :'Integer',
    :'color' => :'String',
    :'extra_css_class' => :'String',
    :'font_family' => :'String',
    :'font_size' => :'Integer',
    :'font_style' => :'String',
    :'font_weight' => :'String',
    :'inner_padding_bottom' => :'Integer',
    :'inner_padding_left' => :'Integer',
    :'inner_padding_right' => :'Integer',
    :'inner_padding_top' => :'Integer',
    :'mobile_stretch_content' => :'Boolean',
    :'background_color' => :'String',
    :'letter_spacing' => :'Integer',
    :'line_height' => :'Float',
    :'text_align' => :'String',
    :'text_decoration' => :'String',
    :'text_table_layout' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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/klaviyo-api-sdk/models/text_block_styles.rb', line 371

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      block_background_color == o.block_background_color &&
      block_border_color == o.block_border_color &&
      block_border_style == o.block_border_style &&
      block_border_width == o.block_border_width &&
      block_padding_bottom == o.block_padding_bottom &&
      block_padding_left == o.block_padding_left &&
      block_padding_right == o.block_padding_right &&
      block_padding_top == o.block_padding_top &&
      color == o.color &&
      extra_css_class == o.extra_css_class &&
      font_family == o.font_family &&
      font_size == o.font_size &&
      font_style == o.font_style &&
      font_weight == o.font_weight &&
      inner_padding_bottom == o.inner_padding_bottom &&
      inner_padding_left == o.inner_padding_left &&
      inner_padding_right == o.inner_padding_right &&
      inner_padding_top == o.inner_padding_top &&
      mobile_stretch_content == o.mobile_stretch_content &&
      background_color == o.background_color &&
      letter_spacing == o.letter_spacing &&
      line_height == o.line_height &&
      text_align == o.text_align &&
      text_decoration == o.text_decoration &&
      text_table_layout == o.text_table_layout
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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 447

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



518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 518

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



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 423

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


403
404
405
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 403

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



409
410
411
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 409

def hash
  [block_background_color, block_border_color, block_border_style, block_border_width, block_padding_bottom, block_padding_left, block_padding_right, block_padding_top, color, extra_css_class, font_family, font_size, font_style, font_weight, inner_padding_bottom, inner_padding_left, inner_padding_right, inner_padding_top, mobile_stretch_content, background_color, letter_spacing, line_height, text_align, text_decoration, text_table_layout].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



310
311
312
313
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 310

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



494
495
496
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 494

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



500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 500

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



488
489
490
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 488

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



317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/klaviyo-api-sdk/models/text_block_styles.rb', line 317

def valid?
  block_border_style_validator = EnumAttributeValidator.new('String', ["dashed", "dotted", "groove", "inset", "none", "outset", "ridge", "solid"])
  return false unless block_border_style_validator.valid?(@block_border_style)
  font_style_validator = EnumAttributeValidator.new('String', ["italic", "normal"])
  return false unless font_style_validator.valid?(@font_style)
  text_align_validator = EnumAttributeValidator.new('String', ["center", "left", "right"])
  return false unless text_align_validator.valid?(@text_align)
  text_table_layout_validator = EnumAttributeValidator.new('String', ["auto", "fixed", "inherit", "initial"])
  return false unless text_table_layout_validator.valid?(@text_table_layout)
  true
end