Class: KlaviyoAPI::CatalogItemUpdateQueryResourceObjectAttributes

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogItemUpdateQueryResourceObjectAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 96

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

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  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. May not exceed 100kb.



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

def custom_metadata
  @custom_metadata
end

#description ⇒ Object

A description of the catalog item.



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

def description
  @description
end

#image_full_url ⇒ Object

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



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

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



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

def image_thumbnail_url
  @image_thumbnail_url
end

#images ⇒ Object

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



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

def images
  @images
end

#price ⇒ Object

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



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

def price
  @price
end

#published ⇒ Object

Boolean value indicating whether the catalog item is published.



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

def published
  @published
end

#title ⇒ Object

The title of the catalog item.



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

def title
  @title
end

#url ⇒ Object

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



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 45

def self.attribute_map
  {
    :'title' => :'title',
    :'price' => :'price',
    :'description' => :'description',
    :'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



192
193
194
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 192

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 65

def self.openapi_types
  {
    :'title' => :'String',
    :'price' => :'Float',
    :'description' => :'String',
    :'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



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      price == o.price &&
      description == o.description &&
      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



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

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



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

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



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/catalog_item_update_query_resource_object_attributes.rb', line 199

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


179
180
181
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



185
186
187
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 185

def hash
  [title, price, description, 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



150
151
152
153
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 150

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



270
271
272
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 270

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 276

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



264
265
266
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb', line 264

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



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

def valid?
  true
end