Class: VoucherifySdk::Product

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/product.rb

Overview

This is an object representing a product. This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Product

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
201
202
203
204
 
# File 'lib/VoucherifySdk/models/product.rb', line 132

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

  if attributes.key?(:'source_id')
    self.source_id = attributes[:'source_id']
  else
    self.source_id = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

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

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

  if attributes.key?(:'metadata')
    self.metadata = attributes[:'metadata']
  else
    self.metadata = nil
  end

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

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

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

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'product'
  end

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

Instance Attribute Details

#attributes ⇒ Object

A list of product attributes whose values you can customize for given SKUs: ‘["color","size","ranking"]`. Each child SKU can have a unique value for a given attribute.



32
33
34
 
# File 'lib/VoucherifySdk/models/product.rb', line 32

def attributes
  @attributes
end

#created_at ⇒ Object

Timestamp representing the date and time when the product was created in ISO 8601 format.



41
42
43
 
# File 'lib/VoucherifySdk/models/product.rb', line 41

def created_at
  @created_at
end

#id ⇒ Object

Unique product ID assigned by Voucherify.



20
21
22
 
# File 'lib/VoucherifySdk/models/product.rb', line 20

def id
  @id
end

#image_url ⇒ Object

The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.



38
39
40
 
# File 'lib/VoucherifySdk/models/product.rb', line 38

def image_url
  @image_url
end

#metadata ⇒ Object

The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.



35
36
37
 
# File 'lib/VoucherifySdk/models/product.rb', line 35

def metadata
  @metadata
end

#name ⇒ Object

Unique user-defined product name.



26
27
28
 
# File 'lib/VoucherifySdk/models/product.rb', line 26

def name
  @name
end

#object ⇒ Object

The type of object represented by JSON. This object stores information about the product.



47
48
49
 
# File 'lib/VoucherifySdk/models/product.rb', line 47

def object
  @object
end

#price ⇒ Object

Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as ‘$100.00` being expressed as `10000`.



29
30
31
 
# File 'lib/VoucherifySdk/models/product.rb', line 29

def price
  @price
end

#skus ⇒ Object

Returns the value of attribute skus.



49
50
51
 
# File 'lib/VoucherifySdk/models/product.rb', line 49

def skus
  @skus
end

#source_id ⇒ Object

Unique product source ID.



23
24
25
 
# File 'lib/VoucherifySdk/models/product.rb', line 23

def source_id
  @source_id
end

#updated_at ⇒ Object

Timestamp representing the date and time when the product was updated in ISO 8601 format.



44
45
46
 
# File 'lib/VoucherifySdk/models/product.rb', line 44

def updated_at
  @updated_at
end

Class Method Details

._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



310
311
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
 
# File 'lib/VoucherifySdk/models/product.rb', line 310

def self._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 = VoucherifySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/VoucherifySdk/models/product.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/VoucherifySdk/models/product.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'source_id' => :'source_id',
    :'name' => :'name',
    :'price' => :'price',
    :'attributes' => :'attributes',
    :'metadata' => :'metadata',
    :'image_url' => :'image_url',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'object' => :'object',
    :'skus' => :'skus'
  }
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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/VoucherifySdk/models/product.rb', line 286

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



124
125
126
127
128
 
# File 'lib/VoucherifySdk/models/product.rb', line 124

def self.openapi_all_of
  [
  :'ProductWithoutSkus'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
118
119
120
121
 
# File 'lib/VoucherifySdk/models/product.rb', line 113

def self.openapi_nullable
  Set.new([
    :'source_id',
    :'name',
    :'price',
    :'image_url',
    :'updated_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/VoucherifySdk/models/product.rb', line 96

def self.openapi_types
  {
    :'id' => :'String',
    :'source_id' => :'String',
    :'name' => :'String',
    :'price' => :'Integer',
    :'attributes' => :'Array<String>',
    :'metadata' => :'Object',
    :'image_url' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'object' => :'String',
    :'skus' => :'SkusListForProduct'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/VoucherifySdk/models/product.rb', line 255

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      source_id == o.source_id &&
      name == o.name &&
      price == o.price &&
      attributes == o.attributes &&
      metadata == o.metadata &&
      image_url == o.image_url &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      object == o.object &&
      skus == o.skus
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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/VoucherifySdk/models/product.rb', line 381

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


273
274
275
 
# File 'lib/VoucherifySdk/models/product.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



279
280
281
 
# File 'lib/VoucherifySdk/models/product.rb', line 279

def hash
  [id, source_id, name, price, attributes, metadata, image_url, created_at, updated_at, object, skus].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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/VoucherifySdk/models/product.rb', line 208

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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



357
358
359
 
# File 'lib/VoucherifySdk/models/product.rb', line 357

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/VoucherifySdk/models/product.rb', line 363

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



351
352
353
 
# File 'lib/VoucherifySdk/models/product.rb', line 351

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



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/VoucherifySdk/models/product.rb', line 232

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @attributes.nil?
  return false if @metadata.nil?
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["product"])
  return false unless object_validator.valid?(@object)
  true
end