Class: KlaviyoAPI::EmailProperties

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'show_label')
    self.show_label = attributes[:'show_label']
  else
    self.show_label = false
  end

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

  if attributes.key?(:'required')
    self.required = attributes[:'required']
  else
    self.required = false
  end

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

  if attributes.key?(:'property_name')
    self.property_name = attributes[:'property_name']
  else
    self.property_name = '$email'
  end
end

Instance Attribute Details

#classname ⇒ Object

Returns the value of attribute classname.



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

def classname
  @classname
end

#display_device ⇒ Object

Returns the value of attribute display_device.



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

def display_device
  @display_device
end

#error_messages ⇒ Object

Returns the value of attribute error_messages.



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

def error_messages
  @error_messages
end

#label ⇒ Object

Returns the value of attribute label.



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

def label
  @label
end

#placeholder ⇒ Object

Returns the value of attribute placeholder.



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

def placeholder
  @placeholder
end

#property_name ⇒ Object

Returns the value of attribute property_name.



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

def property_name
  @property_name
end

#required ⇒ Object

Returns the value of attribute required.



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

def required
  @required
end

#show_label ⇒ Object

Returns the value of attribute show_label.



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

def show_label
  @show_label
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 56

def self.attribute_map
  {
    :'display_device' => :'display_device',
    :'classname' => :'classname',
    :'label' => :'label',
    :'show_label' => :'show_label',
    :'placeholder' => :'placeholder',
    :'required' => :'required',
    :'error_messages' => :'error_messages',
    :'property_name' => :'property_name'
  }
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



209
210
211
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 209

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
93
94
95
96
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 89

def self.openapi_nullable
  Set.new([
    :'classname',
    :'label',
    :'placeholder',
    :'required',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 75

def self.openapi_types
  {
    :'display_device' => :'Array<String>',
    :'classname' => :'String',
    :'label' => :'String',
    :'show_label' => :'Boolean',
    :'placeholder' => :'String',
    :'required' => :'Boolean',
    :'error_messages' => :'ErrorMessages',
    :'property_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      display_device == o.display_device &&
      classname == o.classname &&
      label == o.label &&
      show_label == o.show_label &&
      placeholder == o.placeholder &&
      required == o.required &&
      error_messages == o.error_messages &&
      property_name == o.property_name
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



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

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 311

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 216

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



202
203
204
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 202

def hash
  [display_device, classname, label, show_label, placeholder, required, error_messages, property_name].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



156
157
158
159
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 156

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



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

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 293

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



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

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



163
164
165
166
167
 
# File 'lib/klaviyo-api-sdk/models/email_properties.rb', line 163

def valid?
  property_name_validator = EnumAttributeValidator.new('String', ["$email"])
  return false unless property_name_validator.valid?(@property_name)
  true
end