Class: KlaviyoAPI::CatalogItemCreateQueryResourceObjectAttributes

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/models/catalog_item_create_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 = {}) ⇒ CatalogItemCreateQueryResourceObjectAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

  if attributes.key?(:'catalog_type')
    self.catalog_type = attributes[:'catalog_type']
  else
    self.catalog_type = '$default'
  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']
  else
    self.published = true
  end
end

Instance Attribute Details

#catalog_type ⇒ Object

The type of catalog. Currently only "$default" is supported.



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

def catalog_type
  @catalog_type
end

#custom_metadata ⇒ Object

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



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

def custom_metadata
  @custom_metadata
end

#description ⇒ Object

A description of the catalog item.



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

def description
  @description
end

#external_id ⇒ Object

The ID of the catalog item in an external system.



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

def external_id
  @external_id
end

#image_full_url ⇒ Object

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



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

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



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

def image_thumbnail_url
  @image_thumbnail_url
end

#images ⇒ Object

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



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

def images
  @images
end

#integration_type ⇒ Object

The integration type. Currently only "$custom" is supported.



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

def integration_type
  @integration_type
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).



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

def price
  @price
end

#published ⇒ Object

Boolean value indicating whether the catalog item is published.



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

def published
  @published
end

#title ⇒ Object

The title of the catalog item.



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

def title
  @title
end

#url ⇒ Object

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



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 249

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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 312

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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 383

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



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/catalog_item_create_query_resource_object_attributes.rb', line 288

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


268
269
270
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



274
275
276
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 274

def hash
  [external_id, integration_type, title, price, catalog_type, 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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 204

def list_invalid_properties
  invalid_properties = Array.new
  if @external_id.nil?
    invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
  end

  if @title.nil?
    invalid_properties.push('invalid value for "title", title cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @url.nil?
    invalid_properties.push('invalid value for "url", url 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



359
360
361
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 359

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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 365

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



353
354
355
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 353

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



227
228
229
230
231
232
233
234
235
 
# File 'lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb', line 227

def valid?
  return false if @external_id.nil?
  integration_type_validator = EnumAttributeValidator.new('String', ["$custom"])
  return false unless integration_type_validator.valid?(@integration_type)
  return false if @title.nil?
  return false if @description.nil?
  return false if @url.nil?
  true
end