Class: KlaviyoAPI::DynamicReviewBlockProperties

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DynamicReviewBlockProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 152

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#author_placeholder ⇒ Object

Returns the value of attribute author_placeholder.



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

def author_placeholder
  @author_placeholder
end

#dynamic ⇒ Object

Returns the value of attribute dynamic.



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

def dynamic
  @dynamic
end

#fallback_content_type ⇒ Object

Review block fallback content type.



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

def fallback_content_type
  @fallback_content_type
end

#fallback_options ⇒ Object

Review block fallback options for dynamic selection.



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

def fallback_options
  @fallback_options
end

#fallback_review_id ⇒ Object

Returns the value of attribute fallback_review_id.



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

def fallback_review_id
  @fallback_review_id
end

#product_event_variable ⇒ Object

Returns the value of attribute product_event_variable.



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

def product_event_variable
  @product_event_variable
end

#product_id ⇒ Object

Returns the value of attribute product_id.



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

def product_id
  @product_id
end

#product_name_placeholder ⇒ Object

Returns the value of attribute product_name_placeholder.



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

def product_name_placeholder
  @product_name_placeholder
end

#product_selection_mode ⇒ Object

Review block product selection mode.



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

def product_selection_mode
  @product_selection_mode
end

#product_variant_name_placeholder ⇒ Object

Returns the value of attribute product_variant_name_placeholder.



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

def product_variant_name_placeholder
  @product_variant_name_placeholder
end

#quote_placeholder ⇒ Object

Returns the value of attribute quote_placeholder.



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

def quote_placeholder
  @quote_placeholder
end

#show_product_name ⇒ Object

Returns the value of attribute show_product_name.



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

def show_product_name
  @show_product_name
end

#show_rating ⇒ Object

Returns the value of attribute show_rating.



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

def show_rating
  @show_rating
end

#show_reviewer_name ⇒ Object

Returns the value of attribute show_reviewer_name.



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

def show_reviewer_name
  @show_reviewer_name
end

#show_variant_name ⇒ Object

Returns the value of attribute show_variant_name.



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

def show_variant_name
  @show_variant_name
end

#show_verified_badge ⇒ Object

Returns the value of attribute show_verified_badge.



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

def show_verified_badge
  @show_verified_badge
end

#verified_badge_language ⇒ Object

Review block verified badge language.



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

def verified_badge_language
  @verified_badge_language
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



101
102
103
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 101

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 78

def self.attribute_map
  {
    :'show_rating' => :'show_rating',
    :'show_reviewer_name' => :'show_reviewer_name',
    :'show_product_name' => :'show_product_name',
    :'show_variant_name' => :'show_variant_name',
    :'show_verified_badge' => :'show_verified_badge',
    :'author_placeholder' => :'author_placeholder',
    :'quote_placeholder' => :'quote_placeholder',
    :'product_name_placeholder' => :'product_name_placeholder',
    :'product_variant_name_placeholder' => :'product_variant_name_placeholder',
    :'verified_badge_language' => :'verified_badge_language',
    :'dynamic' => :'dynamic',
    :'fallback_options' => :'fallback_options',
    :'fallback_content_type' => :'fallback_content_type',
    :'fallback_review_id' => :'fallback_review_id',
    :'product_selection_mode' => :'product_selection_mode',
    :'product_id' => :'product_id',
    :'product_event_variable' => :'product_event_variable'
  }
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



351
352
353
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 351

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 129

def self.openapi_nullable
  Set.new([
    :'show_rating',
    :'show_reviewer_name',
    :'show_product_name',
    :'show_variant_name',
    :'show_verified_badge',
    :'author_placeholder',
    :'quote_placeholder',
    :'product_name_placeholder',
    :'product_variant_name_placeholder',
    :'verified_badge_language',
    :'fallback_options',
    :'fallback_content_type',
    :'fallback_review_id',
    :'product_selection_mode',
    :'product_id',
    :'product_event_variable'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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/dynamic_review_block_properties.rb', line 106

def self.openapi_types
  {
    :'show_rating' => :'Boolean',
    :'show_reviewer_name' => :'Boolean',
    :'show_product_name' => :'Boolean',
    :'show_variant_name' => :'Boolean',
    :'show_verified_badge' => :'Boolean',
    :'author_placeholder' => :'String',
    :'quote_placeholder' => :'String',
    :'product_name_placeholder' => :'String',
    :'product_variant_name_placeholder' => :'String',
    :'verified_badge_language' => :'String',
    :'dynamic' => :'Boolean',
    :'fallback_options' => :'String',
    :'fallback_content_type' => :'String',
    :'fallback_review_id' => :'String',
    :'product_selection_mode' => :'String',
    :'product_id' => :'String',
    :'product_event_variable' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 314

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      show_rating == o.show_rating &&
      show_reviewer_name == o.show_reviewer_name &&
      show_product_name == o.show_product_name &&
      show_variant_name == o.show_variant_name &&
      show_verified_badge == o.show_verified_badge &&
      author_placeholder == o.author_placeholder &&
      quote_placeholder == o.quote_placeholder &&
      product_name_placeholder == o.product_name_placeholder &&
      product_variant_name_placeholder == o.product_variant_name_placeholder &&
      verified_badge_language == o.verified_badge_language &&
      dynamic == o.dynamic &&
      fallback_options == o.fallback_options &&
      fallback_content_type == o.fallback_content_type &&
      fallback_review_id == o.fallback_review_id &&
      product_selection_mode == o.product_selection_mode &&
      product_id == o.product_id &&
      product_event_variable == o.product_event_variable
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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 382

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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 453

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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 358

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


338
339
340
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



344
345
346
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 344

def hash
  [show_rating, show_reviewer_name, show_product_name, show_variant_name, show_verified_badge, author_placeholder, quote_placeholder, product_name_placeholder, product_variant_name_placeholder, verified_badge_language, dynamic, fallback_options, fallback_content_type, fallback_review_id, product_selection_mode, product_id, product_event_variable].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



236
237
238
239
240
241
242
243
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 236

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



429
430
431
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 429

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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 435

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



423
424
425
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 423

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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb', line 247

def valid?
  verified_badge_language_validator = EnumAttributeValidator.new('String', ["dutch", "english", "french", "german", "hungarian", "italian", "japanese", "korean", "portuguese", "spanish"])
  return false unless verified_badge_language_validator.valid?(@verified_badge_language)
  return false if @dynamic.nil?
  dynamic_validator = EnumAttributeValidator.new('Boolean', ["true"])
  return false unless dynamic_validator.valid?(@dynamic)
  fallback_options_validator = EnumAttributeValidator.new('String', ["high-quality-review", "high-quality-review-or-static", "no-review", "recent", "static-only"])
  return false unless fallback_options_validator.valid?(@fallback_options)
  fallback_content_type_validator = EnumAttributeValidator.new('String', ["full", "quote"])
  return false unless fallback_content_type_validator.valid?(@fallback_content_type)
  product_selection_mode_validator = EnumAttributeValidator.new('String', ["automatic", "manual"])
  return false unless product_selection_mode_validator.valid?(@product_selection_mode)
  true
end