Class: AliseeksApi::ProductDetail

Inherits:
Object
  • Object
show all
Defined in:
lib/aliseeks_api/models/product_detail.rb

Overview

AliExpress product details

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProductDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 115

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'categoryId')
    self.category_id = attributes[:'categoryId']
  end

  if attributes.has_key?(:'companyId')
    self.company_id = attributes[:'companyId']
  end

  if attributes.has_key?(:'sellerId')
    self.seller_id = attributes[:'sellerId']
  end

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

  if attributes.has_key?(:'productImages')
    if (value = attributes[:'productImages']).is_a?(Array)
      self.product_images = value
    end
  end

  if attributes.has_key?(:'statusId')
    self.status_id = attributes[:'statusId']
  end

  if attributes.has_key?(:'countPerLot')
    self.count_per_lot = attributes[:'countPerLot']
  end

  if attributes.has_key?(:'wishListCount')
    self.wish_list_count = attributes[:'wishListCount']
  end

  if attributes.has_key?(:'unit')
    self.unit = attributes[:'unit']
  end

  if attributes.has_key?(:'multiUnit')
    self.multi_unit = attributes[:'multiUnit']
  end

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

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

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

  if attributes.has_key?(:'reviews')
    self.reviews = attributes[:'reviews']
  end

  if attributes.has_key?(:'trade')
    self.trade = attributes[:'trade']
  end

  if attributes.has_key?(:'skuProperties')
    if (value = attributes[:'skuProperties']).is_a?(Array)
      self.sku_properties = value
    end
  end
end

Instance Attribute Details

#attributes ⇒ Object

The attributes of an item



55
56
57
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 55

def attributes
  @attributes
end

#category_id ⇒ Object

The item category



22
23
24
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 22

def category_id
  @category_id
end

#company_id ⇒ Object

The company ID



25
26
27
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 25

def company_id
  @company_id
end

#count_per_lot ⇒ Object

The number of items per lot



40
41
42
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 40

def count_per_lot
  @count_per_lot
end

#id ⇒ Object

The AliExpress item ID



19
20
21
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 19

def id
  @id
end

#multi_unit ⇒ Object

The unit for multiple items



49
50
51
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 49

def multi_unit
  @multi_unit
end

#prices ⇒ Object

List of price options for an item



58
59
60
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 58

def prices
  @prices
end

#product_images ⇒ Object

The item images



34
35
36
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 34

def product_images
  @product_images
end

#promotions ⇒ Object

The promotions present on an item



52
53
54
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 52

def promotions
  @promotions
end

#reviews ⇒ Object

Returns the value of attribute reviews.



60
61
62
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 60

def reviews
  @reviews
end

#seller_id ⇒ Object

The seller ID



28
29
30
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 28

def seller_id
  @seller_id
end

#sku_properties ⇒ Object

List of sku properties that correspond to an item



65
66
67
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 65

def sku_properties
  @sku_properties
end

#status_id ⇒ Object

The AliExpress status



37
38
39
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 37

def status_id
  @status_id
end

#title ⇒ Object

The subject / title of the item



31
32
33
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 31

def title
  @title
end

#trade ⇒ Object

Returns the value of attribute trade.



62
63
64
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 62

def trade
  @trade
end

#unit ⇒ Object

The unit of the item



46
47
48
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 46

def unit
  @unit
end

#wish_list_count ⇒ Object

Number of times the item has been added to a wishlist



43
44
45
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 43

def wish_list_count
  @wish_list_count
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 68

def self.attribute_map
  {
    :'id' => :'id',
    :'category_id' => :'categoryId',
    :'company_id' => :'companyId',
    :'seller_id' => :'sellerId',
    :'title' => :'title',
    :'product_images' => :'productImages',
    :'status_id' => :'statusId',
    :'count_per_lot' => :'countPerLot',
    :'wish_list_count' => :'wishListCount',
    :'unit' => :'unit',
    :'multi_unit' => :'multiUnit',
    :'promotions' => :'promotions',
    :'attributes' => :'attributes',
    :'prices' => :'prices',
    :'reviews' => :'reviews',
    :'trade' => :'trade',
    :'sku_properties' => :'skuProperties'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 91

def self.openapi_types
  {
    :'id' => :'String',
    :'category_id' => :'String',
    :'company_id' => :'String',
    :'seller_id' => :'String',
    :'title' => :'String',
    :'product_images' => :'Array<String>',
    :'status_id' => :'Integer',
    :'count_per_lot' => :'Integer',
    :'wish_list_count' => :'Integer',
    :'unit' => :'String',
    :'multi_unit' => :'String',
    :'promotions' => :'Array<PromotionOption>',
    :'attributes' => :'Array<ProductAttribute>',
    :'prices' => :'Array<ProductPriceOption>',
    :'reviews' => :'ProductReviews',
    :'trade' => :'TradeInformation',
    :'sku_properties' => :'Array<SkuProperty>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      category_id == o.category_id &&
      company_id == o.company_id &&
      seller_id == o.seller_id &&
      title == o.title &&
      product_images == o.product_images &&
      status_id == o.status_id &&
      count_per_lot == o.count_per_lot &&
      wish_list_count == o.wish_list_count &&
      unit == o.unit &&
      multi_unit == o.multi_unit &&
      promotions == o.promotions &&
      attributes == o.attributes &&
      prices == o.prices &&
      reviews == o.reviews &&
      trade == o.trade &&
      sku_properties == o.sku_properties
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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 273

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
    temp_model = AliseeksApi.const_get(type).new
    temp_model.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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 339

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 252

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


239
240
241
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



245
246
247
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 245

def hash
  [id, category_id, company_id, seller_id, title, product_images, status_id, count_per_lot, wish_list_count, unit, multi_unit, promotions, attributes, prices, reviews, trade, sku_properties].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



202
203
204
205
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 202

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



319
320
321
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 319

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



325
326
327
328
329
330
331
332
333
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 325

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



313
314
315
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 313

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



209
210
211
 
# File 'lib/aliseeks_api/models/product_detail.rb', line 209

def valid?
  true
end