Class: KlaviyoAPI::CatalogVariantUpdateQueryResourceObjectAttributes

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogVariantUpdateQueryResourceObjectAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'images')
    if (value = attributes[:'images']).is_a?(Array)
      self.images = value
    end
  end

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

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

Instance Attribute Details

#custom_metadata ⇒ Object

Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.



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

def custom_metadata
  @custom_metadata
end

#description ⇒ Object

A description of the catalog item variant.



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

def description
  @description
end

#image_full_url ⇒ Object

URL pointing to the location of a full image of the catalog item variant.



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

def image_full_url
  @image_full_url
end

#image_thumbnail_url ⇒ Object

URL pointing to the location of an image thumbnail of the catalog item variant.



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

def image_thumbnail_url
  @image_thumbnail_url
end

#images ⇒ Object

List of URLs pointing to the locations of images of the catalog item variant.



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

def images
  @images
end

#inventory_policy ⇒ Object

This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: ‘1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.



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

def inventory_policy
  @inventory_policy
end

#inventory_quantity ⇒ Object

The quantity of the catalog item variant currently in stock.



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

def inventory_quantity
  @inventory_quantity
end

#price ⇒ Object

This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the ‘price` on any parent items using the [Update Catalog Item Endpoint](developers.klaviyo.com/en/reference/update_catalog_item).



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

def price
  @price
end

#published ⇒ Object

Boolean value indicating whether the catalog item variant is published.



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

def published
  @published
end

#sku ⇒ Object

The SKU of the catalog item variant.



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

def sku
  @sku
end

#title ⇒ Object

The title of the catalog item variant.



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

def title
  @title
end

#url ⇒ Object

URL pointing to the location of the catalog item variant on your website.



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

def url
  @url
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/catalog_variant_update_query_resource_object_attributes.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'title' => :'title',
    :'description' => :'description',
    :'sku' => :'sku',
    :'inventory_policy' => :'inventory_policy',
    :'inventory_quantity' => :'inventory_quantity',
    :'price' => :'price',
    :'url' => :'url',
    :'image_full_url' => :'image_full_url',
    :'image_thumbnail_url' => :'image_thumbnail_url',
    :'images' => :'images',
    :'custom_metadata' => :'custom_metadata',
    :'published' => :'published'
  }
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



260
261
262
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 260

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 118

def self.openapi_nullable
  Set.new([
    :'title',
    :'description',
    :'sku',
    :'inventory_policy',
    :'inventory_quantity',
    :'price',
    :'url',
    :'image_full_url',
    :'image_thumbnail_url',
    :'images',
    :'custom_metadata',
    :'published'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'title' => :'String',
    :'description' => :'String',
    :'sku' => :'String',
    :'inventory_policy' => :'Integer',
    :'inventory_quantity' => :'Float',
    :'price' => :'Float',
    :'url' => :'String',
    :'image_full_url' => :'String',
    :'image_thumbnail_url' => :'String',
    :'images' => :'Array<String>',
    :'custom_metadata' => :'Object',
    :'published' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      description == o.description &&
      sku == o.sku &&
      inventory_policy == o.inventory_policy &&
      inventory_quantity == o.inventory_quantity &&
      price == o.price &&
      url == o.url &&
      image_full_url == o.image_full_url &&
      image_thumbnail_url == o.image_thumbnail_url &&
      images == o.images &&
      custom_metadata == o.custom_metadata &&
      published == o.published
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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 291

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 362

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 267

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


247
248
249
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 253

def hash
  [title, description, sku, inventory_policy, inventory_quantity, price, url, image_full_url, image_thumbnail_url, images, custom_metadata, published].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



203
204
205
206
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 203

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



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

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 344

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



332
333
334
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 332

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



210
211
212
213
214
 
# File 'lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb', line 210

def valid?
  inventory_policy_validator = EnumAttributeValidator.new('Integer', [0, 1, 2])
  return false unless inventory_policy_validator.valid?(@inventory_policy)
  true
end