Class: AmzSpApi::ProductPricingApiModel::Summary

Inherits:
Object
  • Object
show all
Defined in:
lib/product-pricing-api-model/models/summary.rb

Overview

Contains price information about the product, including the LowestPrices and BuyBoxPrices, the ListPrice, the SuggestedLowerPricePlusShipping, and NumberOfOffers and NumberOfBuyBoxEligibleOffers.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Summary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 79

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#buy_box_eligible_offers ⇒ Object

Returns the value of attribute buy_box_eligible_offers.



34
35
36
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 34

def buy_box_eligible_offers
  @buy_box_eligible_offers
end

#buy_box_prices ⇒ Object

Returns the value of attribute buy_box_prices.



24
25
26
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 24

def buy_box_prices
  @buy_box_prices
end

#competitive_price_threshold ⇒ Object

Returns the value of attribute competitive_price_threshold.



28
29
30
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 28

def competitive_price_threshold
  @competitive_price_threshold
end

#list_price ⇒ Object

Returns the value of attribute list_price.



26
27
28
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 26

def list_price
  @list_price
end

#lowest_prices ⇒ Object

Returns the value of attribute lowest_prices.



22
23
24
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 22

def lowest_prices
  @lowest_prices
end

#number_of_offers ⇒ Object

Returns the value of attribute number_of_offers.



20
21
22
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 20

def number_of_offers
  @number_of_offers
end

#offers_available_time ⇒ Object

When the status is ActiveButTooSoonForProcessing, this is the time when the offers will be available for processing.



37
38
39
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 37

def offers_available_time
  @offers_available_time
end

#sales_rankings ⇒ Object

Returns the value of attribute sales_rankings.



32
33
34
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 32

def sales_rankings
  @sales_rankings
end

#suggested_lower_price_plus_shipping ⇒ Object

Returns the value of attribute suggested_lower_price_plus_shipping.



30
31
32
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 30

def suggested_lower_price_plus_shipping
  @suggested_lower_price_plus_shipping
end

#total_offer_count ⇒ Object

The number of unique offers contained in NumberOfOffers.



18
19
20
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 18

def total_offer_count
  @total_offer_count
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 40

def self.attribute_map
  {
    :'total_offer_count' => :'TotalOfferCount',
    :'number_of_offers' => :'NumberOfOffers',
    :'lowest_prices' => :'LowestPrices',
    :'buy_box_prices' => :'BuyBoxPrices',
    :'list_price' => :'ListPrice',
    :'competitive_price_threshold' => :'CompetitivePriceThreshold',
    :'suggested_lower_price_plus_shipping' => :'SuggestedLowerPricePlusShipping',
    :'sales_rankings' => :'SalesRankings',
    :'buy_box_eligible_offers' => :'BuyBoxEligibleOffers',
    :'offers_available_time' => :'OffersAvailableTime'
  }
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



183
184
185
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 183

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 56

def self.openapi_types
  {
    :'total_offer_count' => :'Object',
    :'number_of_offers' => :'Object',
    :'lowest_prices' => :'Object',
    :'buy_box_prices' => :'Object',
    :'list_price' => :'Object',
    :'competitive_price_threshold' => :'Object',
    :'suggested_lower_price_plus_shipping' => :'Object',
    :'sales_rankings' => :'Object',
    :'buy_box_eligible_offers' => :'Object',
    :'offers_available_time' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total_offer_count == o.total_offer_count &&
      number_of_offers == o.number_of_offers &&
      lowest_prices == o.lowest_prices &&
      buy_box_prices == o.buy_box_prices &&
      list_price == o.list_price &&
      competitive_price_threshold == o.competitive_price_threshold &&
      suggested_lower_price_plus_shipping == o.suggested_lower_price_plus_shipping &&
      sales_rankings == o.sales_rankings &&
      buy_box_eligible_offers == o.buy_box_eligible_offers &&
      offers_available_time == o.offers_available_time
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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 213

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
    AmzSpApi::ProductPricingApiModel.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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 282

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 190

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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


170
171
172
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 170

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



176
177
178
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 176

def hash
  [total_offer_count, number_of_offers, lowest_prices, buy_box_prices, list_price, competitive_price_threshold, suggested_lower_price_plus_shipping, sales_rankings, buy_box_eligible_offers, offers_available_time].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



135
136
137
138
139
140
141
142
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 135

def list_invalid_properties
  invalid_properties = Array.new
  if @total_offer_count.nil?
    invalid_properties.push('invalid value for "total_offer_count", total_offer_count 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



258
259
260
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 258

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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 264

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



252
253
254
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 252

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



146
147
148
149
 
# File 'lib/product-pricing-api-model/models/summary.rb', line 146

def valid?
  return false if @total_offer_count.nil?
  true
end