Class: HelloextendApiClient::ContractProduct

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

Overview

Details about the product the warranty contract was purchased for.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContractProduct

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 68

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

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

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

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

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

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

Instance Attribute Details

#manufacturer_warranty_length ⇒ Object

The duration of the product’s manufacturer warranty as a numer of months.



25
26
27
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 25

def manufacturer_warranty_length
  @manufacturer_warranty_length
end

#manufacturer_warranty_length_labor ⇒ Object

The manufacturer warranty length labor.



31
32
33
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 31

def manufacturer_warranty_length_labor
  @manufacturer_warranty_length_labor
end

#manufacturer_warranty_length_parts ⇒ Object

The manufacturer warranty length parts.



28
29
30
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 28

def manufacturer_warranty_length_parts
  @manufacturer_warranty_length_parts
end

#purchase_price ⇒ Object

The price paid for the product, in the base unit (i.e. cents) with no currency code. If this amount was lower than the retail price, Extend will assume the price was discounted.



22
23
24
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 22

def purchase_price
  @purchase_price
end

#reference_id ⇒ Object

The store-specific unique reference identifier for the product that the warranty plan is connected to. In other words, if the customer is buying a TV and a warranty plan for the TV, this would be the ID for the TV. Example ID types: a product SKU, variant ID, GTIN, or any other unique identifier you use in your store. Please see the documentation for <a href=‘/#tag/Store’>‘Create a product’</a> for more information.



19
20
21
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 19

def reference_id
  @reference_id
end

#serial_number ⇒ Object

The serial number of the product.



34
35
36
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 34

def serial_number
  @serial_number
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 37

def self.attribute_map
  {
    :'reference_id' => :'referenceId',
    :'purchase_price' => :'purchasePrice',
    :'manufacturer_warranty_length' => :'manufacturerWarrantyLength',
    :'manufacturer_warranty_length_parts' => :'manufacturerWarrantyLengthParts',
    :'manufacturer_warranty_length_labor' => :'manufacturerWarrantyLengthLabor',
    :'serial_number' => :'serialNumber'
  }
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



157
158
159
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 157

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 49

def self.openapi_types
  {
    :'reference_id' => :'String',
    :'purchase_price' => :'Integer',
    :'manufacturer_warranty_length' => :'Integer',
    :'manufacturer_warranty_length_parts' => :'Integer',
    :'manufacturer_warranty_length_labor' => :'Integer',
    :'serial_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 131

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reference_id == o.reference_id &&
      purchase_price == o.purchase_price &&
      manufacturer_warranty_length == o.manufacturer_warranty_length &&
      manufacturer_warranty_length_parts == o.manufacturer_warranty_length_parts &&
      manufacturer_warranty_length_labor == o.manufacturer_warranty_length_labor &&
      serial_number == o.serial_number
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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 185

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 254

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 164

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


144
145
146
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 144

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



150
151
152
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 150

def hash
  [reference_id, purchase_price, manufacturer_warranty_length, manufacturer_warranty_length_parts, manufacturer_warranty_length_labor, serial_number].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



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 108

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

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



230
231
232
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 230

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



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

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



224
225
226
 
# File 'lib/helloextend_api_client/models/contract_product.rb', line 224

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



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

def valid?
  return false if @reference_id.nil?
  return false if @purchase_price.nil?
  true
end