Class: HelloextendApiClient::Product

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

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



131
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
205
 
# File 'lib/helloextend_api_client/models/product.rb', line 131

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#brand ⇒ Object

Product Brand, Manufacturer or Vendor



18
19
20
 
# File 'lib/helloextend_api_client/models/product.rb', line 18

def brand
  @brand
end

#category ⇒ Object

Product category. Can be any value and may be used by Extend to map the product to warranty plans.



21
22
23
 
# File 'lib/helloextend_api_client/models/product.rb', line 21

def category
  @category
end

#created_at ⇒ Object

The timestamp when the object was created (internal)



24
25
26
 
# File 'lib/helloextend_api_client/models/product.rb', line 24

def created_at
  @created_at
end

#description ⇒ Object

Product description



27
28
29
 
# File 'lib/helloextend_api_client/models/product.rb', line 27

def description
  @description
end

#enabled ⇒ Object

Enable/disable selling of warranties on this product



30
31
32
 
# File 'lib/helloextend_api_client/models/product.rb', line 30

def enabled
  @enabled
end

#identifiers ⇒ Object

Returns the value of attribute identifiers.



57
58
59
 
# File 'lib/helloextend_api_client/models/product.rb', line 57

def identifiers
  @identifiers
end

#image_url ⇒ Object

A url pointing to the primary image for the product



33
34
35
 
# File 'lib/helloextend_api_client/models/product.rb', line 33

def image_url
  @image_url
end

#mfr_warranty ⇒ Object

Returns the value of attribute mfr_warranty.



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

def mfr_warranty
  @mfr_warranty
end

#parent_reference_id ⇒ Object

This is the id of the parent product, if there is one. This allows nesting of a single parent product with multiple variants (such as multiple color options for the same product)



52
53
54
 
# File 'lib/helloextend_api_client/models/product.rb', line 52

def parent_reference_id
  @parent_reference_id
end

#plans ⇒ Object

A list of all extended warranty plans for which the product is eligible, listed by planId. The Offers SDK or Offers API will provide more detail about which plan options to display for a given product at a given time.



55
56
57
 
# File 'lib/helloextend_api_client/models/product.rb', line 55

def plans
  @plans
end

#price ⇒ Object

The base retail price of the product (in cents)



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

def price
  @price
end

#reference_id ⇒ Object

This is the unique identifier that identifies the product. This can be a product SKU, or variant id.



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

def reference_id
  @reference_id
end

#status ⇒ Object

Returns the value of attribute status.



46
47
48
 
# File 'lib/helloextend_api_client/models/product.rb', line 46

def status
  @status
end

#title ⇒ Object

Product name



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

def title
  @title
end

#updated_at ⇒ Object

The timestamp when the object was last updated (internal)



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

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/helloextend_api_client/models/product.rb', line 82

def self.attribute_map
  {
    :'brand' => :'brand',
    :'category' => :'category',
    :'created_at' => :'createdAt',
    :'description' => :'description',
    :'enabled' => :'enabled',
    :'image_url' => :'imageUrl',
    :'mfr_warranty' => :'mfrWarranty',
    :'price' => :'price',
    :'title' => :'title',
    :'updated_at' => :'updatedAt',
    :'status' => :'status',
    :'reference_id' => :'referenceId',
    :'parent_reference_id' => :'parentReferenceId',
    :'plans' => :'plans',
    :'identifiers' => :'identifiers'
  }
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



318
319
320
 
# File 'lib/helloextend_api_client/models/product.rb', line 318

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/helloextend_api_client/models/product.rb', line 103

def self.openapi_types
  {
    :'brand' => :'String',
    :'category' => :'String',
    :'created_at' => :'Float',
    :'description' => :'String',
    :'enabled' => :'Boolean',
    :'image_url' => :'String',
    :'mfr_warranty' => :'ProductMfrWarranty',
    :'price' => :'Float',
    :'title' => :'String',
    :'updated_at' => :'Float',
    :'status' => :'String',
    :'reference_id' => :'String',
    :'parent_reference_id' => :'String',
    :'plans' => :'Array<String>',
    :'identifiers' => :'ProductIdentifiers'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/helloextend_api_client/models/product.rb', line 283

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      brand == o.brand &&
      category == o.category &&
      created_at == o.created_at &&
      description == o.description &&
      enabled == o.enabled &&
      image_url == o.image_url &&
      mfr_warranty == o.mfr_warranty &&
      price == o.price &&
      title == o.title &&
      updated_at == o.updated_at &&
      status == o.status &&
      reference_id == o.reference_id &&
      parent_reference_id == o.parent_reference_id &&
      plans == o.plans &&
      identifiers == o.identifiers
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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/helloextend_api_client/models/product.rb', line 346

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    HelloextendApiClient.const_get(type).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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/helloextend_api_client/models/product.rb', line 415

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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/helloextend_api_client/models/product.rb', line 325

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


305
306
307
 
# File 'lib/helloextend_api_client/models/product.rb', line 305

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



311
312
313
 
# File 'lib/helloextend_api_client/models/product.rb', line 311

def hash
  [brand, category, created_at, description, enabled, image_url, mfr_warranty, price, title, updated_at, status, reference_id, parent_reference_id, plans, identifiers].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



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/helloextend_api_client/models/product.rb', line 209

def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 2000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.')
  end

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

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

  if @title.to_s.length > 255
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.')
  end

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



391
392
393
 
# File 'lib/helloextend_api_client/models/product.rb', line 391

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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/helloextend_api_client/models/product.rb', line 397

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



385
386
387
 
# File 'lib/helloextend_api_client/models/product.rb', line 385

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



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/helloextend_api_client/models/product.rb', line 236

def valid?
  return false if !@description.nil? && @description.to_s.length > 2000
  return false if @price.nil?
  return false if @title.nil?
  return false if @title.to_s.length > 255
  status_validator = EnumAttributeValidator.new('String', ["new", "updated", "active", "inactive"])
  return false unless status_validator.valid?(@status)
  return false if @reference_id.nil?
  true
end